editorOptions.ts 89.9 KB
Newer Older
1 2 3 4 5
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

6
import * as nls from 'vs/nls';
A
Alex Dima 已提交
7 8
import * as arrays from 'vs/base/common/arrays';
import * as objects from 'vs/base/common/objects';
9
import * as platform from 'vs/base/common/platform';
10 11
import { ScrollbarVisibility } from 'vs/base/common/scrollable';
import { FontInfo } from 'vs/editor/common/config/fontInfo';
12
import { Constants } from 'vs/editor/common/core/uint';
13
import { USUAL_WORD_SEPARATORS } from 'vs/editor/common/model/wordHelper';
14 15 16 17 18 19 20 21 22 23 24 25 26 27

/**
 * Configuration options for editor scrollbars
 */
export interface IEditorScrollbarOptions {
	/**
	 * The size of arrows (if displayed).
	 * Defaults to 11.
	 */
	arrowSize?: number;
	/**
	 * Render vertical scrollbar.
	 * Defaults to 'auto'.
	 */
A
Alex Dima 已提交
28
	vertical?: 'auto' | 'visible' | 'hidden';
29 30 31 32
	/**
	 * Render horizontal scrollbar.
	 * Defaults to 'auto'.
	 */
A
Alex Dima 已提交
33
	horizontal?: 'auto' | 'visible' | 'hidden';
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
	/**
	 * Cast horizontal and vertical shadows when the content is scrolled.
	 * Defaults to true.
	 */
	useShadows?: boolean;
	/**
	 * Render arrows at the top and bottom of the vertical scrollbar.
	 * Defaults to false.
	 */
	verticalHasArrows?: boolean;
	/**
	 * Render arrows at the left and right of the horizontal scrollbar.
	 * Defaults to false.
	 */
	horizontalHasArrows?: boolean;
	/**
	 * Listen to mouse wheel events and react to them by scrolling.
	 * Defaults to true.
	 */
	handleMouseWheel?: boolean;
	/**
	 * Height in pixels for the horizontal scrollbar.
	 * Defaults to 10 (px).
	 */
	horizontalScrollbarSize?: number;
	/**
	 * Width in pixels for the vertical scrollbar.
	 * Defaults to 10 (px).
	 */
	verticalScrollbarSize?: number;
	/**
	 * Width in pixels for the vertical slider.
	 * Defaults to `verticalScrollbarSize`.
	 */
	verticalSliderSize?: number;
	/**
	 * Height in pixels for the horizontal slider.
	 * Defaults to `horizontalScrollbarSize`.
	 */
	horizontalSliderSize?: number;
}

76 77 78 79
/**
 * Configuration options for editor find widget
 */
export interface IEditorFindOptions {
R
rebornix 已提交
80 81 82
	/**
	 * Controls if we seed search string in the Find Widget with editor selection.
	 */
83
	seedSearchStringFromSelection?: boolean;
R
rebornix 已提交
84 85 86 87
	/**
	 * Controls if Find in Selection flag is turned on when multiple lines of text are selected in the editor.
	 */
	autoFindInSelection: boolean;
88 89 90 91 92
	/**
	 * @internal
	 * Controls if the Find Widget should read or modify the shared find clipboard on macOS
	 */
	globalFindClipboard: boolean;
93 94
}

J
Jackson Kearl 已提交
95
/**
J
Jackson Kearl 已提交
96
 * Configuration options for auto closing quotes and brackets
J
Jackson Kearl 已提交
97
 */
J
Jackson Kearl 已提交
98 99 100 101 102
export type EditorAutoClosingStrategy = 'always' | 'languageDefined' | 'beforeWhitespace' | 'never';

/**
 * Configuration options for auto wrapping quotes and brackets
 */
103
export type EditorAutoSurroundStrategy = 'languageDefined' | 'quotes' | 'brackets' | 'never';
J
Jackson Kearl 已提交
104

105 106 107 108 109 110
/**
 * Configuration options for editor minimap
 */
export interface IEditorMinimapOptions {
	/**
	 * Enable the rendering of the minimap.
111
	 * Defaults to true.
112 113
	 */
	enabled?: boolean;
114 115 116 117 118
	/**
	 * Control the side of the minimap in editor.
	 * Defaults to 'right'.
	 */
	side?: 'right' | 'left';
119 120 121 122 123
	/**
	 * Control the rendering of the minimap slider.
	 * Defaults to 'mouseover'.
	 */
	showSlider?: 'always' | 'mouseover';
124 125 126 127 128 129 130 131 132 133 134 135
	/**
	 * Render the actual text on a line (as opposed to color blocks).
	 * Defaults to true.
	 */
	renderCharacters?: boolean;
	/**
	 * Limit the width of the minimap to render at most a certain number of columns.
	 * Defaults to 120.
	 */
	maxColumn?: number;
}

136 137 138 139 140 141 142 143 144 145 146
/**
 * Configuration options for editor minimap
 */
export interface IEditorLightbulbOptions {
	/**
	 * Enable the lightbulb code action.
	 * Defaults to true.
	 */
	enabled?: boolean;
}

A
Alex Dima 已提交
147 148 149 150 151 152 153 154 155
/**
 * Configuration options for editor hover
 */
export interface IEditorHoverOptions {
	/**
	 * Enable the hover.
	 * Defaults to true.
	 */
	enabled?: boolean;
156 157 158 159 160
	/**
	 * Delay for showing the hover.
	 * Defaults to 300.
	 */
	delay?: number;
161 162 163 164 165
	/**
	 * Is the hover sticky such that it can be clicked and its contents selected?
	 * Defaults to true.
	 */
	sticky?: boolean;
A
Alex Dima 已提交
166 167
}

168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
/**
 * Configuration options for parameter hints
 */
export interface IEditorParameterHintOptions {
	/**
	 * Enable parameter hints.
	 * Defaults to true.
	 */
	enabled?: boolean;
	/**
	 * Enable cycling of parameter hints.
	 * Defaults to false.
	 */
	cycle?: boolean;
}

184 185 186 187 188
export interface ISuggestOptions {
	/**
	 * Enable graceful matching. Defaults to true.
	 */
	filterGraceful?: boolean;
189 190 191 192
	/**
	 * Prevent quick suggestions when a snippet is active. Defaults to true.
	 */
	snippetsPreventQuickSuggestions?: boolean;
J
Johannes Rieken 已提交
193 194 195 196
	/**
	 * Favours words that appear close to the cursor.
	 */
	localityBonus?: boolean;
197 198 199 200

	/**
	 * Enable using global storage for remembering suggestions.
	 */
201
	shareSuggestSelections?: boolean;
202 203
}

204 205 206 207 208 209 210
/**
 * Configuration map for codeActionsOnSave
 */
export interface ICodeActionsOnSaveOptions {
	[kind: string]: boolean;
}

211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
/**
 * Configuration options for the editor.
 */
export interface IEditorOptions {
	/**
	 * This editor is used inside a diff editor.
	 * @internal
	 */
	inDiffEditor?: boolean;
	/**
	 * The aria label for the editor's textarea (when it is focused).
	 */
	ariaLabel?: string;
	/**
	 * Render vertical lines at the specified columns.
	 * Defaults to empty array.
	 */
	rulers?: number[];
	/**
	 * A string containing the word separators used when doing word navigation.
	 * Defaults to `~!@#$%^&*()-=+[{]}\\|;:\'",.<>/?
	 */
	wordSeparators?: string;
	/**
	 * Enable Linux primary clipboard.
	 * Defaults to true.
	 */
	selectionClipboard?: boolean;
	/**
	 * Control the rendering of line numbers.
	 * If it is a function, it will be invoked when rendering a line number and the return value will be rendered.
	 * Otherwise, if it is a truey, line numbers will be rendered normally (equivalent of using an identity function).
	 * Otherwise, line numbers will not be rendered.
	 * Defaults to true.
	 */
246
	lineNumbers?: 'on' | 'off' | 'relative' | 'interval' | ((lineNumber: number) => string);
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
	/**
	 * Should the corresponding line be selected when clicking on the line number?
	 * Defaults to true.
	 */
	selectOnLineNumbers?: boolean;
	/**
	 * Control the width of line numbers, by reserving horizontal space for rendering at least an amount of digits.
	 * Defaults to 5.
	 */
	lineNumbersMinChars?: number;
	/**
	 * Enable the rendering of the glyph margin.
	 * Defaults to true in vscode and to false in monaco-editor.
	 */
	glyphMargin?: boolean;
	/**
	 * The width reserved for line decorations (in px).
	 * Line decorations are placed between line numbers and the editor content.
	 * You can pass in a string in the format floating point followed by "ch". e.g. 1.3ch.
	 * Defaults to 10.
	 */
	lineDecorationsWidth?: number | string;
	/**
	 * When revealing the cursor, a virtual padding (px) is added to the cursor, turning it into a rectangle.
	 * This virtual padding ensures that the cursor gets revealed before hitting the edge of the viewport.
	 * Defaults to 30 (px).
	 */
	revealHorizontalRightPadding?: number;
	/**
	 * Render the editor selection with rounded borders.
	 * Defaults to true.
	 */
	roundedSelection?: boolean;
	/**
281
	 * Class name to be added to the editor.
282
	 */
283
	extraEditorClassName?: string;
284 285 286 287 288 289 290 291 292 293 294 295 296
	/**
	 * Should the editor be read only.
	 * Defaults to false.
	 */
	readOnly?: boolean;
	/**
	 * Control the behavior and rendering of the scrollbars.
	 */
	scrollbar?: IEditorScrollbarOptions;
	/**
	 * Control the behavior and rendering of the minimap.
	 */
	minimap?: IEditorMinimapOptions;
297 298 299 300
	/**
	 * Control the behavior of the find widget.
	 */
	find?: IEditorFindOptions;
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
	/**
	 * Display overflow widgets as `fixed`.
	 * Defaults to `false`.
	 */
	fixedOverflowWidgets?: boolean;
	/**
	 * The number of vertical lanes the overview ruler should render.
	 * Defaults to 2.
	 */
	overviewRulerLanes?: number;
	/**
	 * Controls if a border should be drawn around the overview ruler.
	 * Defaults to `true`.
	 */
	overviewRulerBorder?: boolean;
	/**
	 * Control the cursor animation style, possible values are 'blink', 'smooth', 'phase', 'expand' and 'solid'.
	 * Defaults to 'blink'.
	 */
	cursorBlinking?: string;
	/**
	 * Zoom the font in the editor when using the mouse wheel in combination with holding Ctrl.
	 * Defaults to false.
	 */
	mouseWheelZoom?: boolean;
	/**
	 * Control the mouse pointer style, either 'text' or 'default' or 'copy'
	 * Defaults to 'text'
	 * @internal
	 */
	mouseStyle?: 'text' | 'default' | 'copy';
332 333 334 335 336
	/**
	 * Enable smooth caret animation.
	 * Defaults to false.
	 */
	cursorSmoothCaretAnimation?: boolean;
337 338 339 340 341
	/**
	 * Control the cursor style, either 'block' or 'line'.
	 * Defaults to 'line'.
	 */
	cursorStyle?: string;
342 343 344
	/**
	 * Control the width of the cursor when cursorStyle is set to 'line'
	 */
345
	cursorWidth?: number;
346 347 348 349 350 351
	/**
	 * Enable font ligatures.
	 * Defaults to false.
	 */
	fontLigatures?: boolean;
	/**
352 353
	 * Disable the use of `will-change` for the editor margin and lines layers.
	 * The usage of `will-change` acts as a hint for browsers to create an extra layer.
354 355
	 * Defaults to false.
	 */
356
	disableLayerHinting?: boolean;
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
	/**
	 * Disable the optimizations for monospace fonts.
	 * Defaults to false.
	 */
	disableMonospaceOptimizations?: boolean;
	/**
	 * Should the cursor be hidden in the overview ruler.
	 * Defaults to false.
	 */
	hideCursorInOverviewRuler?: boolean;
	/**
	 * Enable that scrolling can go one screen size after the last line.
	 * Defaults to true.
	 */
	scrollBeyondLastLine?: boolean;
372 373 374 375 376
	/**
	 * Enable that scrolling can go beyond the last column by a number of columns.
	 * Defaults to 5.
	 */
	scrollBeyondLastColumn?: number;
377 378
	/**
	 * Enable that the editor animates scrolling to a position.
379
	 * Defaults to false.
380 381
	 */
	smoothScrolling?: boolean;
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
	/**
	 * Enable that the editor will install an interval to check if its container dom node size has changed.
	 * Enabling this might have a severe performance impact.
	 * Defaults to false.
	 */
	automaticLayout?: boolean;
	/**
	 * Control the wrapping of the editor.
	 * When `wordWrap` = "off", the lines will never wrap.
	 * When `wordWrap` = "on", the lines will wrap at the viewport width.
	 * When `wordWrap` = "wordWrapColumn", the lines will wrap at `wordWrapColumn`.
	 * When `wordWrap` = "bounded", the lines will wrap at min(viewport width, wordWrapColumn).
	 * Defaults to "off".
	 */
	wordWrap?: 'off' | 'on' | 'wordWrapColumn' | 'bounded';
	/**
	 * Control the wrapping of the editor.
	 * When `wordWrap` = "off", the lines will never wrap.
	 * When `wordWrap` = "on", the lines will wrap at the viewport width.
	 * When `wordWrap` = "wordWrapColumn", the lines will wrap at `wordWrapColumn`.
	 * When `wordWrap` = "bounded", the lines will wrap at min(viewport width, wordWrapColumn).
	 * Defaults to 80.
	 */
	wordWrapColumn?: number;
	/**
	 * Force word wrapping when the text appears to be of a minified/generated file.
	 * Defaults to true.
	 */
	wordWrapMinified?: boolean;
	/**
412
	 * Control indentation of wrapped lines. Can be: 'none', 'same', 'indent' or 'deepIndent'.
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
	 * Defaults to 'same' in vscode and to 'none' in monaco-editor.
	 */
	wrappingIndent?: string;
	/**
	 * Configure word wrapping characters. A break will be introduced before these characters.
	 * Defaults to '{([+'.
	 */
	wordWrapBreakBeforeCharacters?: string;
	/**
	 * Configure word wrapping characters. A break will be introduced after these characters.
	 * Defaults to ' \t})]?|&,;'.
	 */
	wordWrapBreakAfterCharacters?: string;
	/**
	 * Configure word wrapping characters. A break will be introduced after these characters only if no `wordWrapBreakBeforeCharacters` or `wordWrapBreakAfterCharacters` were found.
	 * Defaults to '.'.
	 */
	wordWrapBreakObtrusiveCharacters?: string;

	/**
	 * Performance guard: Stop rendering a line after x characters.
	 * Defaults to 10000.
	 * Use -1 to never stop rendering
	 */
	stopRenderingLineAfter?: number;
	/**
A
Alex Dima 已提交
439
	 * Configure the editor's hover.
440
	 */
A
Alex Dima 已提交
441
	hover?: IEditorHoverOptions;
442 443 444 445 446
	/**
	 * Enable detecting links and making them clickable.
	 * Defaults to true.
	 */
	links?: boolean;
447
	/**
448
	 * Enable inline color decorators and color picker rendering.
449
	 */
R
rebornix 已提交
450
	colorDecorators?: boolean;
451 452 453 454 455 456 457 458 459 460
	/**
	 * Enable custom contextmenu.
	 * Defaults to true.
	 */
	contextmenu?: boolean;
	/**
	 * A multiplier to be used on the `deltaX` and `deltaY` of mouse wheel scroll events.
	 * Defaults to 1.
	 */
	mouseWheelScrollSensitivity?: number;
T
Tiago Ribeiro 已提交
461
	/**
462 463
	 * FastScrolling mulitplier speed when pressing `Alt`
	 * Defaults to 5.
T
Tiago Ribeiro 已提交
464 465
	 */
	fastScrollSensitivity?: number;
466 467 468 469
	/**
	 * The modifier to be used to add multiple cursors with the mouse.
	 * Defaults to 'alt'
	 */
470
	multiCursorModifier?: 'ctrlCmd' | 'alt';
471
	/**
A
Alex Dima 已提交
472
	 * Merge overlapping selections.
473 474
	 * Defaults to true
	 */
A
Alex Dima 已提交
475
	multiCursorMergeOverlapping?: boolean;
476 477 478 479 480
	/**
	 * Configure the editor's accessibility support.
	 * Defaults to 'auto'. It is best to leave this to 'auto'.
	 */
	accessibilitySupport?: 'auto' | 'off' | 'on';
481 482 483 484
	/**
	 * Suggest options.
	 */
	suggest?: ISuggestOptions;
485 486 487 488 489 490 491 492 493 494 495
	/**
	 * Enable quick suggestions (shadow suggestions)
	 * Defaults to true.
	 */
	quickSuggestions?: boolean | { other: boolean, comments: boolean, strings: boolean };
	/**
	 * Quick suggestions show delay (in ms)
	 * Defaults to 500 (ms)
	 */
	quickSuggestionsDelay?: number;
	/**
496
	 * Parameter hint options.
497
	 */
498
	parameterHints?: IEditorParameterHintOptions;
499 500 501 502 503 504
	/**
	 * Render icons in suggestions box.
	 * Defaults to true.
	 */
	iconsInSuggestions?: boolean;
	/**
505
	 * Options for auto closing brackets.
506
	 * Defaults to language defined behavior.
507
	 */
J
Jackson Kearl 已提交
508
	autoClosingBrackets?: EditorAutoClosingStrategy;
509
	/**
510
	 * Options for auto closing quotes.
511
	 * Defaults to language defined behavior.
J
Jackson Kearl 已提交
512 513 514
	 */
	autoClosingQuotes?: EditorAutoClosingStrategy;
	/**
515 516
	 * Options for auto surrounding.
	 * Defaults to always allowing auto surrounding.
517
	 */
518
	autoSurround?: EditorAutoSurroundStrategy;
519 520 521 522 523
	/**
	 * Enable auto indentation adjustment.
	 * Defaults to false.
	 */
	autoIndent?: boolean;
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
	/**
	 * Enable format on type.
	 * Defaults to false.
	 */
	formatOnType?: boolean;
	/**
	 * Enable format on paste.
	 * Defaults to false.
	 */
	formatOnPaste?: boolean;
	/**
	 * Controls if the editor should allow to move selections via drag and drop.
	 * Defaults to false.
	 */
	dragAndDrop?: boolean;
	/**
	 * Enable the suggestion box to pop-up on trigger characters.
	 * Defaults to true.
	 */
	suggestOnTriggerCharacters?: boolean;
	/**
	 * Accept suggestions on ENTER.
546
	 * Defaults to 'on'.
547
	 */
J
Johannes Rieken 已提交
548
	acceptSuggestionOnEnter?: boolean | 'on' | 'smart' | 'off';
549 550 551 552 553 554 555 556 557 558 559 560 561
	/**
	 * Accept suggestions on provider defined characters.
	 * Defaults to true.
	 */
	acceptSuggestionOnCommitCharacter?: boolean;
	/**
	 * Enable snippet suggestions. Default to 'true'.
	 */
	snippetSuggestions?: 'top' | 'bottom' | 'inline' | 'none';
	/**
	 * Copying without a selection copies the current line.
	 */
	emptySelectionClipboard?: boolean;
562
	/**
563
	 * Syntax highlighting is copied.
564
	 */
565
	copyWithSyntaxHighlighting?: boolean;
566 567 568 569
	/**
	 * Enable word based suggestions. Defaults to 'true'
	 */
	wordBasedSuggestions?: boolean;
570 571 572
	/**
	 * The history mode for suggestions.
	 */
M
Martin Aeschlimann 已提交
573
	suggestSelection?: 'first' | 'recentlyUsed' | 'recentlyUsedByPrefix';
574 575 576 577 578 579 580 581 582 583
	/**
	 * The font size for the suggest widget.
	 * Defaults to the editor font size.
	 */
	suggestFontSize?: number;
	/**
	 * The line height for the suggest widget.
	 * Defaults to the editor line height.
	 */
	suggestLineHeight?: number;
584 585 586
	/**
	 * Enable tab completion.
	 */
587
	tabCompletion?: boolean | 'on' | 'off' | 'onlySnippets';
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
	/**
	 * Enable selection highlight.
	 * Defaults to true.
	 */
	selectionHighlight?: boolean;
	/**
	 * Enable semantic occurrences highlight.
	 * Defaults to true.
	 */
	occurrencesHighlight?: boolean;
	/**
	 * Show code lens
	 * Defaults to true.
	 */
	codeLens?: boolean;
603 604 605 606
	/**
	 * Control the behavior and rendering of the code action lightbulb.
	 */
	lightbulb?: IEditorLightbulbOptions;
607 608 609 610 611 612 613 614
	/**
	 * Code action kinds to be run on save.
	 */
	codeActionsOnSave?: ICodeActionsOnSaveOptions;
	/**
	 * Timeout for running code actions on save.
	 */
	codeActionsOnSaveTimeout?: number;
615 616
	/**
	 * Enable code folding
A
Alex Dima 已提交
617
	 * Defaults to true.
618 619
	 */
	folding?: boolean;
620 621 622 623 624
	/**
	 * Selects the folding strategy. 'auto' uses the strategies contributed for the current document, 'indentation' uses the indentation based folding strategy.
	 * Defaults to 'auto'.
	 */
	foldingStrategy?: 'auto' | 'indentation';
625
	/**
626 627
	 * Controls whether the fold actions in the gutter stay always visible or hide unless the mouse is over the gutter.
	 * Defaults to 'mouseover'.
628
	 */
629
	showFoldingControls?: 'always' | 'mouseover';
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
	/**
	 * Enable highlighting of matching brackets.
	 * Defaults to true.
	 */
	matchBrackets?: boolean;
	/**
	 * Enable rendering of whitespace.
	 * Defaults to none.
	 */
	renderWhitespace?: 'none' | 'boundary' | 'all';
	/**
	 * Enable rendering of control characters.
	 * Defaults to false.
	 */
	renderControlCharacters?: boolean;
	/**
	 * Enable rendering of indent guides.
647
	 * Defaults to true.
648 649
	 */
	renderIndentGuides?: boolean;
650
	/**
C
typo  
Coenraad Stijne 已提交
651
	 * Enable highlighting of the active indent guide.
652 653 654
	 * Defaults to true.
	 */
	highlightActiveIndentGuide?: boolean;
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
	/**
	 * Enable rendering of current line highlight.
	 * Defaults to all.
	 */
	renderLineHighlight?: 'none' | 'gutter' | 'line' | 'all';
	/**
	 * Inserting and deleting whitespace follows tab stops.
	 */
	useTabStops?: boolean;
	/**
	 * The font family
	 */
	fontFamily?: string;
	/**
	 * The font weight
	 */
	fontWeight?: 'normal' | 'bold' | 'bolder' | 'lighter' | 'initial' | 'inherit' | '100' | '200' | '300' | '400' | '500' | '600' | '700' | '800' | '900';
	/**
	 * The font size
	 */
	fontSize?: number;
	/**
	 * The line height
	 */
	lineHeight?: number;
680 681 682 683
	/**
	 * The letter spacing
	 */
	letterSpacing?: number;
684 685 686 687
	/**
	 * Controls fading out of unused variables.
	 */
	showUnused?: boolean;
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720
}

/**
 * Configuration options for the diff editor.
 */
export interface IDiffEditorOptions extends IEditorOptions {
	/**
	 * Allow the user to resize the diff editor split view.
	 * Defaults to true.
	 */
	enableSplitViewResizing?: boolean;
	/**
	 * Render the differences in two side-by-side editors.
	 * Defaults to true.
	 */
	renderSideBySide?: boolean;
	/**
	 * Compute the diff by ignoring leading/trailing whitespace
	 * Defaults to true.
	 */
	ignoreTrimWhitespace?: boolean;
	/**
	 * Render +/- indicators for added/deleted changes.
	 * Defaults to true.
	 */
	renderIndicators?: boolean;
	/**
	 * Original model should be editable?
	 * Defaults to false.
	 */
	originalEditable?: boolean;
}

721
export const enum RenderMinimap {
722 723 724 725 726 727 728 729 730 731
	None = 0,
	Small = 1,
	Large = 2,
	SmallBlocks = 3,
	LargeBlocks = 4,
}

/**
 * Describes how to indent wrapped lines.
 */
732
export const enum WrappingIndent {
733 734 735 736 737 738 739 740 741
	/**
	 * No indentation => wrapped lines begin at column 1.
	 */
	None = 0,
	/**
	 * Same => wrapped lines get the same indentation as the parent.
	 */
	Same = 1,
	/**
742
	 * Indent => wrapped lines get +1 indentation toward the parent.
743
	 */
744 745 746
	Indent = 2,
	/**
	 * DeepIndent => wrapped lines get +2 indentation toward the parent.
747
	 */
748
	DeepIndent = 3
749 750 751 752 753
}

/**
 * The kind of animation in which the editor's cursor should be rendered.
 */
754
export const enum TextEditorCursorBlinkingStyle {
755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779
	/**
	 * Hidden
	 */
	Hidden = 0,
	/**
	 * Blinking
	 */
	Blink = 1,
	/**
	 * Blinking with smooth fading
	 */
	Smooth = 2,
	/**
	 * Blinking with prolonged filled state and smooth fading
	 */
	Phase = 3,
	/**
	 * Expand collapse animation on the y axis
	 */
	Expand = 4,
	/**
	 * No-Blinking
	 */
	Solid = 5
}
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
/**
 * @internal
 */
export function blinkingStyleToString(blinkingStyle: TextEditorCursorBlinkingStyle): string {
	if (blinkingStyle === TextEditorCursorBlinkingStyle.Blink) {
		return 'blink';
	} else if (blinkingStyle === TextEditorCursorBlinkingStyle.Expand) {
		return 'expand';
	} else if (blinkingStyle === TextEditorCursorBlinkingStyle.Phase) {
		return 'phase';
	} else if (blinkingStyle === TextEditorCursorBlinkingStyle.Smooth) {
		return 'smooth';
	} else if (blinkingStyle === TextEditorCursorBlinkingStyle.Solid) {
		return 'solid';
	} else {
		throw new Error('blinkingStyleToString: Unknown blinkingStyle');
	}
}
798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849

/**
 * The style in which the editor's cursor should be rendered.
 */
export enum TextEditorCursorStyle {
	/**
	 * As a vertical line (sitting between two characters).
	 */
	Line = 1,
	/**
	 * As a block (sitting on top of a character).
	 */
	Block = 2,
	/**
	 * As a horizontal line (sitting under a character).
	 */
	Underline = 3,
	/**
	 * As a thin vertical line (sitting between two characters).
	 */
	LineThin = 4,
	/**
	 * As an outlined block (sitting on top of a character).
	 */
	BlockOutline = 5,
	/**
	 * As a thin horizontal line (sitting under a character).
	 */
	UnderlineThin = 6
}

/**
 * @internal
 */
export function cursorStyleToString(cursorStyle: TextEditorCursorStyle): string {
	if (cursorStyle === TextEditorCursorStyle.Line) {
		return 'line';
	} else if (cursorStyle === TextEditorCursorStyle.Block) {
		return 'block';
	} else if (cursorStyle === TextEditorCursorStyle.Underline) {
		return 'underline';
	} else if (cursorStyle === TextEditorCursorStyle.LineThin) {
		return 'line-thin';
	} else if (cursorStyle === TextEditorCursorStyle.BlockOutline) {
		return 'block-outline';
	} else if (cursorStyle === TextEditorCursorStyle.UnderlineThin) {
		return 'underline-thin';
	} else {
		throw new Error('cursorStyleToString: Unknown cursorStyle');
	}
}

A
Alex Dima 已提交
850
function _cursorStyleFromString(cursorStyle: string | undefined, defaultValue: TextEditorCursorStyle): TextEditorCursorStyle {
A
Alex Dima 已提交
851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
	if (typeof cursorStyle !== 'string') {
		return defaultValue;
	}
	if (cursorStyle === 'line') {
		return TextEditorCursorStyle.Line;
	} else if (cursorStyle === 'block') {
		return TextEditorCursorStyle.Block;
	} else if (cursorStyle === 'underline') {
		return TextEditorCursorStyle.Underline;
	} else if (cursorStyle === 'line-thin') {
		return TextEditorCursorStyle.LineThin;
	} else if (cursorStyle === 'block-outline') {
		return TextEditorCursorStyle.BlockOutline;
	} else if (cursorStyle === 'underline-thin') {
		return TextEditorCursorStyle.UnderlineThin;
	}
	return TextEditorCursorStyle.Line;
}

A
Alex Dima 已提交
870
export interface InternalEditorScrollbarOptions {
871 872 873 874 875 876 877 878 879 880 881 882
	readonly arrowSize: number;
	readonly vertical: ScrollbarVisibility;
	readonly horizontal: ScrollbarVisibility;
	readonly useShadows: boolean;
	readonly verticalHasArrows: boolean;
	readonly horizontalHasArrows: boolean;
	readonly handleMouseWheel: boolean;
	readonly horizontalScrollbarSize: number;
	readonly horizontalSliderSize: number;
	readonly verticalScrollbarSize: number;
	readonly verticalSliderSize: number;
	readonly mouseWheelScrollSensitivity: number;
T
Tiago Ribeiro 已提交
883
	readonly fastScrollSensitivity: number;
884 885
}

A
Alex Dima 已提交
886
export interface InternalEditorMinimapOptions {
887
	readonly enabled: boolean;
888
	readonly side: 'right' | 'left';
889
	readonly showSlider: 'always' | 'mouseover';
890 891 892 893
	readonly renderCharacters: boolean;
	readonly maxColumn: number;
}

894 895
export interface InternalEditorFindOptions {
	readonly seedSearchStringFromSelection: boolean;
R
rebornix 已提交
896
	readonly autoFindInSelection: boolean;
897 898 899 900
	/**
	 * @internal
	 */
	readonly globalFindClipboard: boolean;
901 902
}

A
Alex Dima 已提交
903 904
export interface InternalEditorHoverOptions {
	readonly enabled: boolean;
905
	readonly delay: number;
906
	readonly sticky: boolean;
A
Alex Dima 已提交
907 908
}

909 910
export interface InternalSuggestOptions {
	readonly filterGraceful: boolean;
911
	readonly snippets: 'top' | 'bottom' | 'inline' | 'none';
912
	readonly snippetsPreventQuickSuggestions: boolean;
J
Johannes Rieken 已提交
913
	readonly localityBonus: boolean;
J
Johannes Rieken 已提交
914
	readonly shareSuggestSelections: boolean;
915 916
}

917 918 919 920 921
export interface InternalParameterHintOptions {
	readonly enabled: boolean;
	readonly cycle: boolean;
}

A
Alex Dima 已提交
922
export interface EditorWrappingInfo {
923 924 925 926 927 928 929 930 931 932 933
	readonly inDiffEditor: boolean;
	readonly isDominatedByLongLines: boolean;
	readonly isWordWrapMinified: boolean;
	readonly isViewportWrapping: boolean;
	readonly wrappingColumn: number;
	readonly wrappingIndent: WrappingIndent;
	readonly wordWrapBreakBeforeCharacters: string;
	readonly wordWrapBreakAfterCharacters: string;
	readonly wordWrapBreakObtrusiveCharacters: string;
}

934 935 936 937
export const enum RenderLineNumbersType {
	Off = 0,
	On = 1,
	Relative = 2,
938 939
	Interval = 3,
	Custom = 4
940 941
}

A
Alex Dima 已提交
942
export interface InternalEditorViewOptions {
943
	readonly extraEditorClassName: string;
944 945 946
	readonly disableMonospaceOptimizations: boolean;
	readonly rulers: number[];
	readonly ariaLabel: string;
947
	readonly renderLineNumbers: RenderLineNumbersType;
A
Alex Dima 已提交
948
	readonly renderCustomLineNumbers: ((lineNumber: number) => string) | null;
949 950 951 952 953 954 955 956
	readonly selectOnLineNumbers: boolean;
	readonly glyphMargin: boolean;
	readonly revealHorizontalRightPadding: number;
	readonly roundedSelection: boolean;
	readonly overviewRulerLanes: number;
	readonly overviewRulerBorder: boolean;
	readonly cursorBlinking: TextEditorCursorBlinkingStyle;
	readonly mouseWheelZoom: boolean;
957
	readonly cursorSmoothCaretAnimation: boolean;
958
	readonly cursorStyle: TextEditorCursorStyle;
959
	readonly cursorWidth: number;
960 961
	readonly hideCursorInOverviewRuler: boolean;
	readonly scrollBeyondLastLine: boolean;
962
	readonly scrollBeyondLastColumn: number;
963
	readonly smoothScrolling: boolean;
964 965 966 967 968
	readonly stopRenderingLineAfter: number;
	readonly renderWhitespace: 'none' | 'boundary' | 'all';
	readonly renderControlCharacters: boolean;
	readonly fontLigatures: boolean;
	readonly renderIndentGuides: boolean;
969
	readonly highlightActiveIndentGuide: boolean;
970 971 972 973 974 975
	readonly renderLineHighlight: 'none' | 'gutter' | 'line' | 'all';
	readonly scrollbar: InternalEditorScrollbarOptions;
	readonly minimap: InternalEditorMinimapOptions;
	readonly fixedOverflowWidgets: boolean;
}

A
Alex Dima 已提交
976
export interface EditorContribOptions {
977
	readonly selectionClipboard: boolean;
A
Alex Dima 已提交
978
	readonly hover: InternalEditorHoverOptions;
979
	readonly links: boolean;
980 981 982
	readonly contextmenu: boolean;
	readonly quickSuggestions: boolean | { other: boolean, comments: boolean, strings: boolean };
	readonly quickSuggestionsDelay: number;
983
	readonly parameterHints: InternalParameterHintOptions;
984 985 986 987
	readonly iconsInSuggestions: boolean;
	readonly formatOnType: boolean;
	readonly formatOnPaste: boolean;
	readonly suggestOnTriggerCharacters: boolean;
988
	readonly acceptSuggestionOnEnter: 'on' | 'smart' | 'off';
989 990
	readonly acceptSuggestionOnCommitCharacter: boolean;
	readonly wordBasedSuggestions: boolean;
B
Benas Svipas 已提交
991
	readonly suggestSelection: 'first' | 'recentlyUsed' | 'recentlyUsedByPrefix';
992 993
	readonly suggestFontSize: number;
	readonly suggestLineHeight: number;
994
	readonly tabCompletion: 'on' | 'off' | 'onlySnippets';
995
	readonly suggest: InternalSuggestOptions;
996 997 998 999
	readonly selectionHighlight: boolean;
	readonly occurrencesHighlight: boolean;
	readonly codeLens: boolean;
	readonly folding: boolean;
1000
	readonly foldingStrategy: 'auto' | 'indentation';
1001
	readonly showFoldingControls: 'always' | 'mouseover';
1002
	readonly matchBrackets: boolean;
1003
	readonly find: InternalEditorFindOptions;
R
rebornix 已提交
1004
	readonly colorDecorators: boolean;
1005
	readonly lightbulbEnabled: boolean;
1006 1007
	readonly codeActionsOnSave: ICodeActionsOnSaveOptions;
	readonly codeActionsOnSaveTimeout: number;
1008 1009
}

1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
/**
 * Validated configuration options for the editor.
 * This is a 1 to 1 validated/parsed version of IEditorOptions merged on top of the defaults.
 * @internal
 */
export interface IValidatedEditorOptions {
	readonly inDiffEditor: boolean;
	readonly wordSeparators: string;
	readonly lineNumbersMinChars: number;
	readonly lineDecorationsWidth: number | string;
	readonly readOnly: boolean;
	readonly mouseStyle: 'text' | 'default' | 'copy';
1022
	readonly disableLayerHinting: boolean;
1023 1024 1025 1026 1027 1028 1029 1030
	readonly automaticLayout: boolean;
	readonly wordWrap: 'off' | 'on' | 'wordWrapColumn' | 'bounded';
	readonly wordWrapColumn: number;
	readonly wordWrapMinified: boolean;
	readonly wrappingIndent: WrappingIndent;
	readonly wordWrapBreakBeforeCharacters: string;
	readonly wordWrapBreakAfterCharacters: string;
	readonly wordWrapBreakObtrusiveCharacters: string;
J
Jackson Kearl 已提交
1031 1032
	readonly autoClosingBrackets: EditorAutoClosingStrategy;
	readonly autoClosingQuotes: EditorAutoClosingStrategy;
1033
	readonly autoSurround: EditorAutoSurroundStrategy;
1034
	readonly autoIndent: boolean;
1035 1036
	readonly dragAndDrop: boolean;
	readonly emptySelectionClipboard: boolean;
1037
	readonly copyWithSyntaxHighlighting: boolean;
1038
	readonly useTabStops: boolean;
1039
	readonly multiCursorModifier: 'altKey' | 'ctrlKey' | 'metaKey';
A
Alex Dima 已提交
1040
	readonly multiCursorMergeOverlapping: boolean;
1041
	readonly accessibilitySupport: 'auto' | 'off' | 'on';
1042
	readonly showUnused: boolean;
1043 1044 1045 1046 1047

	readonly viewInfo: InternalEditorViewOptions;
	readonly contribInfo: EditorContribOptions;
}

1048 1049 1050 1051 1052 1053
/**
 * Internal configuration options (transformed or computed) for the editor.
 */
export class InternalEditorOptions {
	readonly _internalEditorOptionsBrand: void;

1054
	readonly canUseLayerHinting: boolean;
1055
	readonly pixelRatio: number;
A
Alex Dima 已提交
1056
	readonly editorClassName: string;
A
Alex Dima 已提交
1057
	readonly lineHeight: number;
1058
	readonly readOnly: boolean;
1059 1060 1061 1062
	/**
	 * @internal
	 */
	readonly accessibilitySupport: platform.AccessibilitySupport;
1063
	readonly multiCursorModifier: 'altKey' | 'ctrlKey' | 'metaKey';
A
Alex Dima 已提交
1064
	readonly multiCursorMergeOverlapping: boolean;
1065
	readonly showUnused: boolean;
A
Alex Dima 已提交
1066

1067 1068
	// ---- cursor options
	readonly wordSeparators: string;
J
Jackson Kearl 已提交
1069 1070
	readonly autoClosingBrackets: EditorAutoClosingStrategy;
	readonly autoClosingQuotes: EditorAutoClosingStrategy;
1071
	readonly autoSurround: EditorAutoSurroundStrategy;
1072
	readonly autoIndent: boolean;
1073 1074 1075
	readonly useTabStops: boolean;
	readonly tabFocusMode: boolean;
	readonly dragAndDrop: boolean;
1076
	readonly emptySelectionClipboard: boolean;
1077
	readonly copyWithSyntaxHighlighting: boolean;
A
Alex Dima 已提交
1078

1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
	// ---- grouped options
	readonly layoutInfo: EditorLayoutInfo;
	readonly fontInfo: FontInfo;
	readonly viewInfo: InternalEditorViewOptions;
	readonly wrappingInfo: EditorWrappingInfo;
	readonly contribInfo: EditorContribOptions;

	/**
	 * @internal
	 */
	constructor(source: {
1090
		canUseLayerHinting: boolean;
1091
		pixelRatio: number;
A
Alex Dima 已提交
1092
		editorClassName: string;
1093 1094
		lineHeight: number;
		readOnly: boolean;
1095
		accessibilitySupport: platform.AccessibilitySupport;
1096
		multiCursorModifier: 'altKey' | 'ctrlKey' | 'metaKey';
A
Alex Dima 已提交
1097
		multiCursorMergeOverlapping: boolean;
1098
		wordSeparators: string;
J
Jackson Kearl 已提交
1099 1100
		autoClosingBrackets: EditorAutoClosingStrategy;
		autoClosingQuotes: EditorAutoClosingStrategy;
1101
		autoSurround: EditorAutoSurroundStrategy;
1102
		autoIndent: boolean;
1103 1104 1105
		useTabStops: boolean;
		tabFocusMode: boolean;
		dragAndDrop: boolean;
1106
		emptySelectionClipboard: boolean;
1107
		copyWithSyntaxHighlighting: boolean;
1108 1109 1110 1111 1112
		layoutInfo: EditorLayoutInfo;
		fontInfo: FontInfo;
		viewInfo: InternalEditorViewOptions;
		wrappingInfo: EditorWrappingInfo;
		contribInfo: EditorContribOptions;
1113
		showUnused: boolean;
1114
	}) {
1115
		this.canUseLayerHinting = source.canUseLayerHinting;
1116 1117
		this.pixelRatio = source.pixelRatio;
		this.editorClassName = source.editorClassName;
1118
		this.lineHeight = source.lineHeight | 0;
1119
		this.readOnly = source.readOnly;
1120
		this.accessibilitySupport = source.accessibilitySupport;
1121
		this.multiCursorModifier = source.multiCursorModifier;
A
Alex Dima 已提交
1122
		this.multiCursorMergeOverlapping = source.multiCursorMergeOverlapping;
1123 1124
		this.wordSeparators = source.wordSeparators;
		this.autoClosingBrackets = source.autoClosingBrackets;
J
Jackson Kearl 已提交
1125
		this.autoClosingQuotes = source.autoClosingQuotes;
1126
		this.autoSurround = source.autoSurround;
1127
		this.autoIndent = source.autoIndent;
1128 1129 1130
		this.useTabStops = source.useTabStops;
		this.tabFocusMode = source.tabFocusMode;
		this.dragAndDrop = source.dragAndDrop;
1131
		this.emptySelectionClipboard = source.emptySelectionClipboard;
1132
		this.copyWithSyntaxHighlighting = source.copyWithSyntaxHighlighting;
1133 1134 1135 1136 1137
		this.layoutInfo = source.layoutInfo;
		this.fontInfo = source.fontInfo;
		this.viewInfo = source.viewInfo;
		this.wrappingInfo = source.wrappingInfo;
		this.contribInfo = source.contribInfo;
1138
		this.showUnused = source.showUnused;
1139 1140 1141 1142 1143 1144 1145
	}

	/**
	 * @internal
	 */
	public equals(other: InternalEditorOptions): boolean {
		return (
1146
			this.canUseLayerHinting === other.canUseLayerHinting
1147
			&& this.pixelRatio === other.pixelRatio
A
Alex Dima 已提交
1148 1149
			&& this.editorClassName === other.editorClassName
			&& this.lineHeight === other.lineHeight
1150
			&& this.readOnly === other.readOnly
1151
			&& this.accessibilitySupport === other.accessibilitySupport
1152
			&& this.multiCursorModifier === other.multiCursorModifier
A
Alex Dima 已提交
1153
			&& this.multiCursorMergeOverlapping === other.multiCursorMergeOverlapping
1154 1155
			&& this.wordSeparators === other.wordSeparators
			&& this.autoClosingBrackets === other.autoClosingBrackets
J
Jackson Kearl 已提交
1156
			&& this.autoClosingQuotes === other.autoClosingQuotes
1157
			&& this.autoSurround === other.autoSurround
1158
			&& this.autoIndent === other.autoIndent
1159 1160 1161
			&& this.useTabStops === other.useTabStops
			&& this.tabFocusMode === other.tabFocusMode
			&& this.dragAndDrop === other.dragAndDrop
1162
			&& this.showUnused === other.showUnused
1163
			&& this.emptySelectionClipboard === other.emptySelectionClipboard
1164
			&& this.copyWithSyntaxHighlighting === other.copyWithSyntaxHighlighting
A
Alex Dima 已提交
1165
			&& InternalEditorOptions._equalsLayoutInfo(this.layoutInfo, other.layoutInfo)
1166
			&& this.fontInfo.equals(other.fontInfo)
A
Alex Dima 已提交
1167 1168 1169
			&& InternalEditorOptions._equalsViewOptions(this.viewInfo, other.viewInfo)
			&& InternalEditorOptions._equalsWrappingInfo(this.wrappingInfo, other.wrappingInfo)
			&& InternalEditorOptions._equalsContribOptions(this.contribInfo, other.contribInfo)
1170 1171 1172 1173 1174 1175 1176 1177
		);
	}

	/**
	 * @internal
	 */
	public createChangeEvent(newOpts: InternalEditorOptions): IConfigurationChangedEvent {
		return {
1178
			canUseLayerHinting: (this.canUseLayerHinting !== newOpts.canUseLayerHinting),
1179
			pixelRatio: (this.pixelRatio !== newOpts.pixelRatio),
A
Alex Dima 已提交
1180
			editorClassName: (this.editorClassName !== newOpts.editorClassName),
1181 1182
			lineHeight: (this.lineHeight !== newOpts.lineHeight),
			readOnly: (this.readOnly !== newOpts.readOnly),
1183
			accessibilitySupport: (this.accessibilitySupport !== newOpts.accessibilitySupport),
1184
			multiCursorModifier: (this.multiCursorModifier !== newOpts.multiCursorModifier),
A
Alex Dima 已提交
1185
			multiCursorMergeOverlapping: (this.multiCursorMergeOverlapping !== newOpts.multiCursorMergeOverlapping),
1186 1187
			wordSeparators: (this.wordSeparators !== newOpts.wordSeparators),
			autoClosingBrackets: (this.autoClosingBrackets !== newOpts.autoClosingBrackets),
J
Jackson Kearl 已提交
1188
			autoClosingQuotes: (this.autoClosingQuotes !== newOpts.autoClosingQuotes),
1189
			autoSurround: (this.autoSurround !== newOpts.autoSurround),
1190
			autoIndent: (this.autoIndent !== newOpts.autoIndent),
1191 1192 1193
			useTabStops: (this.useTabStops !== newOpts.useTabStops),
			tabFocusMode: (this.tabFocusMode !== newOpts.tabFocusMode),
			dragAndDrop: (this.dragAndDrop !== newOpts.dragAndDrop),
1194
			emptySelectionClipboard: (this.emptySelectionClipboard !== newOpts.emptySelectionClipboard),
1195
			copyWithSyntaxHighlighting: (this.copyWithSyntaxHighlighting !== newOpts.copyWithSyntaxHighlighting),
A
Alex Dima 已提交
1196
			layoutInfo: (!InternalEditorOptions._equalsLayoutInfo(this.layoutInfo, newOpts.layoutInfo)),
1197
			fontInfo: (!this.fontInfo.equals(newOpts.fontInfo)),
A
Alex Dima 已提交
1198 1199
			viewInfo: (!InternalEditorOptions._equalsViewOptions(this.viewInfo, newOpts.viewInfo)),
			wrappingInfo: (!InternalEditorOptions._equalsWrappingInfo(this.wrappingInfo, newOpts.wrappingInfo)),
1200
			contribInfo: (!InternalEditorOptions._equalsContribOptions(this.contribInfo, newOpts.contribInfo))
1201 1202 1203
		};
	}

A
Alex Dima 已提交
1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223
	/**
	 * @internal
	 */
	private static _equalsLayoutInfo(a: EditorLayoutInfo, b: EditorLayoutInfo): boolean {
		return (
			a.width === b.width
			&& a.height === b.height
			&& a.glyphMarginLeft === b.glyphMarginLeft
			&& a.glyphMarginWidth === b.glyphMarginWidth
			&& a.glyphMarginHeight === b.glyphMarginHeight
			&& a.lineNumbersLeft === b.lineNumbersLeft
			&& a.lineNumbersWidth === b.lineNumbersWidth
			&& a.lineNumbersHeight === b.lineNumbersHeight
			&& a.decorationsLeft === b.decorationsLeft
			&& a.decorationsWidth === b.decorationsWidth
			&& a.decorationsHeight === b.decorationsHeight
			&& a.contentLeft === b.contentLeft
			&& a.contentWidth === b.contentWidth
			&& a.contentHeight === b.contentHeight
			&& a.renderMinimap === b.renderMinimap
1224
			&& a.minimapLeft === b.minimapLeft
A
Alex Dima 已提交
1225 1226 1227 1228 1229 1230 1231
			&& a.minimapWidth === b.minimapWidth
			&& a.viewportColumn === b.viewportColumn
			&& a.verticalScrollbarWidth === b.verticalScrollbarWidth
			&& a.horizontalScrollbarHeight === b.horizontalScrollbarHeight
			&& this._equalsOverviewRuler(a.overviewRuler, b.overviewRuler)
		);
	}
1232 1233

	/**
A
Alex Dima 已提交
1234
	 * @internal
1235
	 */
A
Alex Dima 已提交
1236 1237 1238 1239 1240 1241 1242 1243 1244
	private static _equalsOverviewRuler(a: OverviewRulerPosition, b: OverviewRulerPosition): boolean {
		return (
			a.width === b.width
			&& a.height === b.height
			&& a.top === b.top
			&& a.right === b.right
		);
	}

1245
	/**
A
Alex Dima 已提交
1246
	 * @internal
1247
	 */
A
Alex Dima 已提交
1248 1249
	private static _equalsViewOptions(a: InternalEditorViewOptions, b: InternalEditorViewOptions): boolean {
		return (
1250
			a.extraEditorClassName === b.extraEditorClassName
A
Alex Dima 已提交
1251
			&& a.disableMonospaceOptimizations === b.disableMonospaceOptimizations
1252
			&& arrays.equals(a.rulers, b.rulers)
A
Alex Dima 已提交
1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263
			&& a.ariaLabel === b.ariaLabel
			&& a.renderLineNumbers === b.renderLineNumbers
			&& a.renderCustomLineNumbers === b.renderCustomLineNumbers
			&& a.selectOnLineNumbers === b.selectOnLineNumbers
			&& a.glyphMargin === b.glyphMargin
			&& a.revealHorizontalRightPadding === b.revealHorizontalRightPadding
			&& a.roundedSelection === b.roundedSelection
			&& a.overviewRulerLanes === b.overviewRulerLanes
			&& a.overviewRulerBorder === b.overviewRulerBorder
			&& a.cursorBlinking === b.cursorBlinking
			&& a.mouseWheelZoom === b.mouseWheelZoom
1264
			&& a.cursorSmoothCaretAnimation === b.cursorSmoothCaretAnimation
A
Alex Dima 已提交
1265
			&& a.cursorStyle === b.cursorStyle
1266
			&& a.cursorWidth === b.cursorWidth
A
Alex Dima 已提交
1267 1268
			&& a.hideCursorInOverviewRuler === b.hideCursorInOverviewRuler
			&& a.scrollBeyondLastLine === b.scrollBeyondLastLine
1269
			&& a.scrollBeyondLastColumn === b.scrollBeyondLastColumn
1270
			&& a.smoothScrolling === b.smoothScrolling
A
Alex Dima 已提交
1271 1272 1273 1274 1275
			&& a.stopRenderingLineAfter === b.stopRenderingLineAfter
			&& a.renderWhitespace === b.renderWhitespace
			&& a.renderControlCharacters === b.renderControlCharacters
			&& a.fontLigatures === b.fontLigatures
			&& a.renderIndentGuides === b.renderIndentGuides
A
Alex Dima 已提交
1276
			&& a.highlightActiveIndentGuide === b.highlightActiveIndentGuide
A
Alex Dima 已提交
1277 1278 1279 1280 1281 1282 1283
			&& a.renderLineHighlight === b.renderLineHighlight
			&& this._equalsScrollbarOptions(a.scrollbar, b.scrollbar)
			&& this._equalsMinimapOptions(a.minimap, b.minimap)
			&& a.fixedOverflowWidgets === b.fixedOverflowWidgets
		);
	}

1284
	/**
A
Alex Dima 已提交
1285
	 * @internal
1286
	 */
A
Alex Dima 已提交
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300
	private static _equalsScrollbarOptions(a: InternalEditorScrollbarOptions, b: InternalEditorScrollbarOptions): boolean {
		return (
			a.arrowSize === b.arrowSize
			&& a.vertical === b.vertical
			&& a.horizontal === b.horizontal
			&& a.useShadows === b.useShadows
			&& a.verticalHasArrows === b.verticalHasArrows
			&& a.horizontalHasArrows === b.horizontalHasArrows
			&& a.handleMouseWheel === b.handleMouseWheel
			&& a.horizontalScrollbarSize === b.horizontalScrollbarSize
			&& a.horizontalSliderSize === b.horizontalSliderSize
			&& a.verticalScrollbarSize === b.verticalScrollbarSize
			&& a.verticalSliderSize === b.verticalSliderSize
			&& a.mouseWheelScrollSensitivity === b.mouseWheelScrollSensitivity
T
Tiago Ribeiro 已提交
1301
			&& a.fastScrollSensitivity === b.fastScrollSensitivity
A
Alex Dima 已提交
1302 1303 1304
		);
	}

1305
	/**
A
Alex Dima 已提交
1306
	 * @internal
1307
	 */
A
Alex Dima 已提交
1308 1309 1310
	private static _equalsMinimapOptions(a: InternalEditorMinimapOptions, b: InternalEditorMinimapOptions): boolean {
		return (
			a.enabled === b.enabled
1311
			&& a.side === b.side
1312
			&& a.showSlider === b.showSlider
A
Alex Dima 已提交
1313 1314 1315 1316 1317
			&& a.renderCharacters === b.renderCharacters
			&& a.maxColumn === b.maxColumn
		);
	}

1318 1319 1320 1321 1322 1323
	/**
	 * @internal
	 */
	private static _equalFindOptions(a: InternalEditorFindOptions, b: InternalEditorFindOptions): boolean {
		return (
			a.seedSearchStringFromSelection === b.seedSearchStringFromSelection
R
rebornix 已提交
1324
			&& a.autoFindInSelection === b.autoFindInSelection
1325
			&& a.globalFindClipboard === b.globalFindClipboard
1326 1327 1328
		);
	}

1329 1330 1331 1332 1333 1334 1335 1336 1337 1338
	/**
	 * @internal
	 */
	private static _equalsParameterHintOptions(a: InternalParameterHintOptions, b: InternalParameterHintOptions): boolean {
		return (
			a.enabled === b.enabled
			&& a.cycle === b.cycle
		);
	}

A
Alex Dima 已提交
1339 1340 1341 1342 1343 1344
	/**
	 * @internal
	 */
	private static _equalsHoverOptions(a: InternalEditorHoverOptions, b: InternalEditorHoverOptions): boolean {
		return (
			a.enabled === b.enabled
1345
			&& a.delay === b.delay
1346
			&& a.sticky === b.sticky
A
Alex Dima 已提交
1347 1348 1349
		);
	}

1350 1351 1352
	/**
	 * @internal
	 */
1353
	private static _equalsSuggestOptions(a: InternalSuggestOptions, b: InternalSuggestOptions): any {
1354 1355 1356 1357 1358
		if (a === b) {
			return true;
		} else if (!a || !b) {
			return false;
		} else {
1359 1360
			return a.filterGraceful === b.filterGraceful
				&& a.snippets === b.snippets
J
Johannes Rieken 已提交
1361
				&& a.snippetsPreventQuickSuggestions === b.snippetsPreventQuickSuggestions
1362
				&& a.localityBonus === b.localityBonus
J
Johannes Rieken 已提交
1363
				&& a.shareSuggestSelections === b.shareSuggestSelections;
1364 1365 1366
		}
	}

1367 1368 1369
	/**
	 * @internal
	 */
A
Alex Dima 已提交
1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381
	private static _equalsWrappingInfo(a: EditorWrappingInfo, b: EditorWrappingInfo): boolean {
		return (
			a.inDiffEditor === b.inDiffEditor
			&& a.isDominatedByLongLines === b.isDominatedByLongLines
			&& a.isWordWrapMinified === b.isWordWrapMinified
			&& a.isViewportWrapping === b.isViewportWrapping
			&& a.wrappingColumn === b.wrappingColumn
			&& a.wrappingIndent === b.wrappingIndent
			&& a.wordWrapBreakBeforeCharacters === b.wordWrapBreakBeforeCharacters
			&& a.wordWrapBreakAfterCharacters === b.wordWrapBreakAfterCharacters
			&& a.wordWrapBreakObtrusiveCharacters === b.wordWrapBreakObtrusiveCharacters
		);
1382 1383 1384 1385 1386
	}

	/**
	 * @internal
	 */
A
Alex Dima 已提交
1387 1388 1389
	private static _equalsContribOptions(a: EditorContribOptions, b: EditorContribOptions): boolean {
		return (
			a.selectionClipboard === b.selectionClipboard
A
Alex Dima 已提交
1390
			&& this._equalsHoverOptions(a.hover, b.hover)
1391
			&& a.links === b.links
A
Alex Dima 已提交
1392 1393 1394
			&& a.contextmenu === b.contextmenu
			&& InternalEditorOptions._equalsQuickSuggestions(a.quickSuggestions, b.quickSuggestions)
			&& a.quickSuggestionsDelay === b.quickSuggestionsDelay
1395
			&& this._equalsParameterHintOptions(a.parameterHints, b.parameterHints)
A
Alex Dima 已提交
1396 1397 1398 1399 1400 1401 1402
			&& a.iconsInSuggestions === b.iconsInSuggestions
			&& a.formatOnType === b.formatOnType
			&& a.formatOnPaste === b.formatOnPaste
			&& a.suggestOnTriggerCharacters === b.suggestOnTriggerCharacters
			&& a.acceptSuggestionOnEnter === b.acceptSuggestionOnEnter
			&& a.acceptSuggestionOnCommitCharacter === b.acceptSuggestionOnCommitCharacter
			&& a.wordBasedSuggestions === b.wordBasedSuggestions
J
Johannes Rieken 已提交
1403
			&& a.suggestSelection === b.suggestSelection
A
Alex Dima 已提交
1404 1405
			&& a.suggestFontSize === b.suggestFontSize
			&& a.suggestLineHeight === b.suggestLineHeight
1406
			&& a.tabCompletion === b.tabCompletion
1407
			&& this._equalsSuggestOptions(a.suggest, b.suggest)
A
Alex Dima 已提交
1408 1409 1410 1411
			&& a.selectionHighlight === b.selectionHighlight
			&& a.occurrencesHighlight === b.occurrencesHighlight
			&& a.codeLens === b.codeLens
			&& a.folding === b.folding
1412
			&& a.foldingStrategy === b.foldingStrategy
1413
			&& a.showFoldingControls === b.showFoldingControls
A
Alex Dima 已提交
1414
			&& a.matchBrackets === b.matchBrackets
1415
			&& this._equalFindOptions(a.find, b.find)
R
rebornix 已提交
1416
			&& a.colorDecorators === b.colorDecorators
1417 1418
			&& objects.equals(a.codeActionsOnSave, b.codeActionsOnSave)
			&& a.codeActionsOnSaveTimeout === b.codeActionsOnSaveTimeout
1419
			&& a.lightbulbEnabled === b.lightbulbEnabled
A
Alex Dima 已提交
1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432
		);
	}

	private static _equalsQuickSuggestions(a: boolean | { other: boolean, comments: boolean, strings: boolean }, b: boolean | { other: boolean, comments: boolean, strings: boolean }): boolean {
		if (typeof a === 'boolean') {
			if (typeof b !== 'boolean') {
				return false;
			}
			return a === b;
		}
		if (typeof b === 'boolean') {
			return false;
		}
1433
		return (
A
Alex Dima 已提交
1434 1435 1436
			a.comments === b.comments
			&& a.other === b.other
			&& a.strings === b.strings
1437 1438 1439 1440
		);
	}
}

A
Alex Dima 已提交
1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462
/**
 * A description for the overview ruler position.
 */
export interface OverviewRulerPosition {
	/**
	 * Width of the overview ruler
	 */
	readonly width: number;
	/**
	 * Height of the overview ruler
	 */
	readonly height: number;
	/**
	 * Top position for the overview ruler
	 */
	readonly top: number;
	/**
	 * Right position for the overview ruler
	 */
	readonly right: number;
}

1463 1464 1465
/**
 * The internal layout details of the editor.
 */
A
Alex Dima 已提交
1466
export interface EditorLayoutInfo {
1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528

	/**
	 * Full editor width.
	 */
	readonly width: number;
	/**
	 * Full editor height.
	 */
	readonly height: number;

	/**
	 * Left position for the glyph margin.
	 */
	readonly glyphMarginLeft: number;
	/**
	 * The width of the glyph margin.
	 */
	readonly glyphMarginWidth: number;
	/**
	 * The height of the glyph margin.
	 */
	readonly glyphMarginHeight: number;

	/**
	 * Left position for the line numbers.
	 */
	readonly lineNumbersLeft: number;
	/**
	 * The width of the line numbers.
	 */
	readonly lineNumbersWidth: number;
	/**
	 * The height of the line numbers.
	 */
	readonly lineNumbersHeight: number;

	/**
	 * Left position for the line decorations.
	 */
	readonly decorationsLeft: number;
	/**
	 * The width of the line decorations.
	 */
	readonly decorationsWidth: number;
	/**
	 * The height of the line decorations.
	 */
	readonly decorationsHeight: number;

	/**
	 * Left position for the content (actual text)
	 */
	readonly contentLeft: number;
	/**
	 * The width of the content (actual text)
	 */
	readonly contentWidth: number;
	/**
	 * The height of the content (actual height)
	 */
	readonly contentHeight: number;

1529 1530 1531 1532
	/**
	 * The position for the minimap
	 */
	readonly minimapLeft: number;
1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566
	/**
	 * The width of the minimap
	 */
	readonly minimapWidth: number;

	/**
	 * Minimap render type
	 */
	readonly renderMinimap: RenderMinimap;

	/**
	 * The number of columns (of typical characters) fitting on a viewport line.
	 */
	readonly viewportColumn: number;

	/**
	 * The width of the vertical scrollbar.
	 */
	readonly verticalScrollbarWidth: number;
	/**
	 * The height of the horizontal scrollbar.
	 */
	readonly horizontalScrollbarHeight: number;

	/**
	 * The position of the overview ruler.
	 */
	readonly overviewRuler: OverviewRulerPosition;
}

/**
 * An event describing that the configuration of the editor has changed.
 */
export interface IConfigurationChangedEvent {
1567
	readonly canUseLayerHinting: boolean;
1568
	readonly pixelRatio: boolean;
A
Alex Dima 已提交
1569
	readonly editorClassName: boolean;
1570 1571
	readonly lineHeight: boolean;
	readonly readOnly: boolean;
1572
	readonly accessibilitySupport: boolean;
1573
	readonly multiCursorModifier: boolean;
A
Alex Dima 已提交
1574
	readonly multiCursorMergeOverlapping: boolean;
1575 1576
	readonly wordSeparators: boolean;
	readonly autoClosingBrackets: boolean;
J
Jackson Kearl 已提交
1577
	readonly autoClosingQuotes: boolean;
1578
	readonly autoSurround: boolean;
1579
	readonly autoIndent: boolean;
1580 1581 1582
	readonly useTabStops: boolean;
	readonly tabFocusMode: boolean;
	readonly dragAndDrop: boolean;
1583
	readonly emptySelectionClipboard: boolean;
1584
	readonly copyWithSyntaxHighlighting: boolean;
1585 1586
	readonly layoutInfo: boolean;
	readonly fontInfo: boolean;
A
Alex Dima 已提交
1587
	readonly viewInfo: boolean;
1588 1589 1590
	readonly wrappingInfo: boolean;
	readonly contribInfo: boolean;
}
1591 1592 1593 1594

/**
 * @internal
 */
A
Alex Dima 已提交
1595 1596 1597 1598
export interface IEnvironmentalOptions {
	readonly outerWidth: number;
	readonly outerHeight: number;
	readonly fontInfo: FontInfo;
1599
	readonly extraEditorClassName: string;
A
Alex Dima 已提交
1600 1601
	readonly isDominatedByLongLines: boolean;
	readonly lineNumbersDigitCount: number;
1602
	readonly emptySelectionClipboard: boolean;
A
Alex Dima 已提交
1603 1604
	readonly pixelRatio: number;
	readonly tabFocusMode: boolean;
1605
	readonly accessibilitySupport: platform.AccessibilitySupport;
1606
}
1607

1608 1609 1610 1611 1612 1613 1614 1615 1616 1617
function _boolean<T>(value: any, defaultValue: T): boolean | T {
	if (typeof value === 'undefined') {
		return defaultValue;
	}
	if (value === 'false') {
		// treat the string 'false' as false
		return false;
	}
	return Boolean(value);
}
1618

A
Alex Dima 已提交
1619
function _booleanMap(value: { [key: string]: boolean } | undefined, defaultValue: { [key: string]: boolean }): { [key: string]: boolean } {
1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633
	if (!value) {
		return defaultValue;
	}

	const out = Object.create(null);
	for (const k of Object.keys(value)) {
		const v = value[k];
		if (typeof v === 'boolean') {
			out[k] = v;
		}
	}
	return out;
}

1634 1635 1636 1637 1638 1639
function _string(value: any, defaultValue: string): string {
	if (typeof value !== 'string') {
		return defaultValue;
	}
	return value;
}
1640

A
Alex Dima 已提交
1641
function _stringSet<T>(value: T | undefined, defaultValue: T, allowedValues: T[]): T {
1642 1643 1644 1645 1646 1647
	if (typeof value !== 'string') {
		return defaultValue;
	}
	if (allowedValues.indexOf(value) === -1) {
		return defaultValue;
	}
M
Martin Aeschlimann 已提交
1648
	return value;
1649 1650 1651 1652 1653 1654 1655 1656 1657 1658
}

function _clampedInt(value: any, defaultValue: number, minimum: number, maximum: number): number {
	let r: number;
	if (typeof value === 'undefined') {
		r = defaultValue;
	} else {
		r = parseInt(value, 10);
		if (isNaN(r)) {
			r = defaultValue;
1659
		}
1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673
	}
	r = Math.max(minimum, r);
	r = Math.min(maximum, r);
	return r | 0;
}

function _float(value: any, defaultValue: number): number {
	let r = parseFloat(value);
	if (isNaN(r)) {
		r = defaultValue;
	}
	return r;
}

A
Alex Dima 已提交
1674
function _wrappingIndentFromString(wrappingIndent: string | undefined, defaultValue: WrappingIndent): WrappingIndent {
1675 1676 1677
	if (typeof wrappingIndent !== 'string') {
		return defaultValue;
	}
1678
	if (wrappingIndent === 'same') {
1679
		return WrappingIndent.Same;
1680 1681 1682 1683
	} else if (wrappingIndent === 'indent') {
		return WrappingIndent.Indent;
	} else if (wrappingIndent === 'deepIndent') {
		return WrappingIndent.DeepIndent;
1684 1685 1686 1687 1688
	} else {
		return WrappingIndent.None;
	}
}

A
Alex Dima 已提交
1689
function _cursorBlinkingStyleFromString(cursorBlinkingStyle: string | undefined, defaultValue: TextEditorCursorBlinkingStyle): TextEditorCursorBlinkingStyle {
1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708
	if (typeof cursorBlinkingStyle !== 'string') {
		return defaultValue;
	}
	switch (cursorBlinkingStyle) {
		case 'blink':
			return TextEditorCursorBlinkingStyle.Blink;
		case 'smooth':
			return TextEditorCursorBlinkingStyle.Smooth;
		case 'phase':
			return TextEditorCursorBlinkingStyle.Phase;
		case 'expand':
			return TextEditorCursorBlinkingStyle.Expand;
		case 'visible': // maintain compatibility
		case 'solid':
			return TextEditorCursorBlinkingStyle.Solid;
	}
	return TextEditorCursorBlinkingStyle.Blink;
}

A
Alex Dima 已提交
1709
function _scrollbarVisibilityFromString(visibility: string | undefined, defaultValue: ScrollbarVisibility): ScrollbarVisibility {
1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732
	if (typeof visibility !== 'string') {
		return defaultValue;
	}
	switch (visibility) {
		case 'hidden':
			return ScrollbarVisibility.Hidden;
		case 'visible':
			return ScrollbarVisibility.Visible;
		default:
			return ScrollbarVisibility.Auto;
	}
}

/**
 * @internal
 */
export class EditorOptionsValidator {

	/**
	 * Validate raw editor options.
	 * i.e. since they can be defined by the user, they might be invalid.
	 */
	public static validate(opts: IEditorOptions, defaults: IValidatedEditorOptions): IValidatedEditorOptions {
A
Alex Dima 已提交
1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745
		let wordWrap = opts.wordWrap;
		{
			// Compatibility with old true or false values
			if (<any>wordWrap === true) {
				wordWrap = 'on';
			} else if (<any>wordWrap === false) {
				wordWrap = 'off';
			}

			wordWrap = _stringSet<'off' | 'on' | 'wordWrapColumn' | 'bounded'>(wordWrap, defaults.wordWrap, ['off', 'on', 'wordWrapColumn', 'bounded']);
		}

		const viewInfo = this._sanitizeViewInfo(opts, defaults.viewInfo);
1746
		const contribInfo = this._sanitizeContribInfo(opts, defaults.contribInfo);
A
Alex Dima 已提交
1747

A
Alex Dima 已提交
1748
		let configuredMulticursorModifier: 'altKey' | 'metaKey' | 'ctrlKey' | undefined = undefined;
1749
		if (typeof opts.multiCursorModifier === 'string') {
1750 1751
			if (opts.multiCursorModifier === 'ctrlCmd') {
				configuredMulticursorModifier = platform.isMacintosh ? 'metaKey' : 'ctrlKey';
1752
			} else {
1753
				configuredMulticursorModifier = 'altKey';
1754 1755
			}
		}
1756
		const multiCursorModifier = _stringSet<'altKey' | 'metaKey' | 'ctrlKey'>(configuredMulticursorModifier, defaults.multiCursorModifier, ['altKey', 'metaKey', 'ctrlKey']);
1757

1758 1759
		let autoClosingBrackets: EditorAutoClosingStrategy;
		let autoClosingQuotes: EditorAutoClosingStrategy;
1760
		let autoSurround: EditorAutoSurroundStrategy;
A
Alex Dima 已提交
1761
		if (typeof opts.autoClosingBrackets === 'boolean' && opts.autoClosingBrackets === false) {
1762 1763 1764
			// backwards compatibility: disable all on boolean false
			autoClosingBrackets = 'never';
			autoClosingQuotes = 'never';
1765
			autoSurround = 'never';
1766 1767 1768
		} else {
			autoClosingBrackets = _stringSet<EditorAutoClosingStrategy>(opts.autoClosingBrackets, defaults.autoClosingBrackets, ['always', 'languageDefined', 'beforeWhitespace', 'never']);
			autoClosingQuotes = _stringSet<EditorAutoClosingStrategy>(opts.autoClosingQuotes, defaults.autoClosingQuotes, ['always', 'languageDefined', 'beforeWhitespace', 'never']);
M
Matt Bierner 已提交
1769
			autoSurround = _stringSet<EditorAutoSurroundStrategy>(opts.autoSurround, defaults.autoSurround, ['languageDefined', 'brackets', 'quotes', 'never']);
J
Jackson Kearl 已提交
1770 1771
		}

A
Alex Dima 已提交
1772 1773 1774 1775 1776 1777 1778
		return {
			inDiffEditor: _boolean(opts.inDiffEditor, defaults.inDiffEditor),
			wordSeparators: _string(opts.wordSeparators, defaults.wordSeparators),
			lineNumbersMinChars: _clampedInt(opts.lineNumbersMinChars, defaults.lineNumbersMinChars, 1, 10),
			lineDecorationsWidth: (typeof opts.lineDecorationsWidth === 'undefined' ? defaults.lineDecorationsWidth : opts.lineDecorationsWidth),
			readOnly: _boolean(opts.readOnly, defaults.readOnly),
			mouseStyle: _stringSet<'text' | 'default' | 'copy'>(opts.mouseStyle, defaults.mouseStyle, ['text', 'default', 'copy']),
1779
			disableLayerHinting: _boolean(opts.disableLayerHinting, defaults.disableLayerHinting),
A
Alex Dima 已提交
1780 1781 1782 1783 1784 1785 1786 1787
			automaticLayout: _boolean(opts.automaticLayout, defaults.automaticLayout),
			wordWrap: wordWrap,
			wordWrapColumn: _clampedInt(opts.wordWrapColumn, defaults.wordWrapColumn, 1, Constants.MAX_SAFE_SMALL_INTEGER),
			wordWrapMinified: _boolean(opts.wordWrapMinified, defaults.wordWrapMinified),
			wrappingIndent: _wrappingIndentFromString(opts.wrappingIndent, defaults.wrappingIndent),
			wordWrapBreakBeforeCharacters: _string(opts.wordWrapBreakBeforeCharacters, defaults.wordWrapBreakBeforeCharacters),
			wordWrapBreakAfterCharacters: _string(opts.wordWrapBreakAfterCharacters, defaults.wordWrapBreakAfterCharacters),
			wordWrapBreakObtrusiveCharacters: _string(opts.wordWrapBreakObtrusiveCharacters, defaults.wordWrapBreakObtrusiveCharacters),
1788 1789
			autoClosingBrackets,
			autoClosingQuotes,
1790
			autoSurround,
1791
			autoIndent: _boolean(opts.autoIndent, defaults.autoIndent),
A
Alex Dima 已提交
1792
			dragAndDrop: _boolean(opts.dragAndDrop, defaults.dragAndDrop),
1793
			emptySelectionClipboard: _boolean(opts.emptySelectionClipboard, defaults.emptySelectionClipboard),
1794
			copyWithSyntaxHighlighting: _boolean(opts.copyWithSyntaxHighlighting, defaults.copyWithSyntaxHighlighting),
A
Alex Dima 已提交
1795
			useTabStops: _boolean(opts.useTabStops, defaults.useTabStops),
1796
			multiCursorModifier: multiCursorModifier,
A
Alex Dima 已提交
1797
			multiCursorMergeOverlapping: _boolean(opts.multiCursorMergeOverlapping, defaults.multiCursorMergeOverlapping),
1798
			accessibilitySupport: _stringSet<'auto' | 'on' | 'off'>(opts.accessibilitySupport, defaults.accessibilitySupport, ['auto', 'on', 'off']),
1799
			showUnused: _boolean(opts.showUnused, defaults.showUnused),
A
Alex Dima 已提交
1800 1801 1802 1803 1804
			viewInfo: viewInfo,
			contribInfo: contribInfo,
		};
	}

T
Tiago Ribeiro 已提交
1805
	private static _sanitizeScrollbarOpts(opts: IEditorScrollbarOptions | undefined, defaults: InternalEditorScrollbarOptions, mouseWheelScrollSensitivity: number, fastScrollSensitivity: number): InternalEditorScrollbarOptions {
A
Alex Dima 已提交
1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827
		if (typeof opts !== 'object') {
			return defaults;
		}
		const horizontalScrollbarSize = _clampedInt(opts.horizontalScrollbarSize, defaults.horizontalScrollbarSize, 0, 1000);
		const verticalScrollbarSize = _clampedInt(opts.verticalScrollbarSize, defaults.verticalScrollbarSize, 0, 1000);
		return {
			vertical: _scrollbarVisibilityFromString(opts.vertical, defaults.vertical),
			horizontal: _scrollbarVisibilityFromString(opts.horizontal, defaults.horizontal),

			arrowSize: _clampedInt(opts.arrowSize, defaults.arrowSize, 0, 1000),
			useShadows: _boolean(opts.useShadows, defaults.useShadows),

			verticalHasArrows: _boolean(opts.verticalHasArrows, defaults.verticalHasArrows),
			horizontalHasArrows: _boolean(opts.horizontalHasArrows, defaults.horizontalHasArrows),

			horizontalScrollbarSize: horizontalScrollbarSize,
			horizontalSliderSize: _clampedInt(opts.horizontalSliderSize, horizontalScrollbarSize, 0, 1000),

			verticalScrollbarSize: verticalScrollbarSize,
			verticalSliderSize: _clampedInt(opts.verticalSliderSize, verticalScrollbarSize, 0, 1000),

			handleMouseWheel: _boolean(opts.handleMouseWheel, defaults.handleMouseWheel),
T
Tiago Ribeiro 已提交
1828 1829
			mouseWheelScrollSensitivity: mouseWheelScrollSensitivity,
			fastScrollSensitivity: fastScrollSensitivity,
A
Alex Dima 已提交
1830 1831 1832
		};
	}

A
Alex Dima 已提交
1833
	private static _sanitizeMinimapOpts(opts: IEditorMinimapOptions | undefined, defaults: InternalEditorMinimapOptions): InternalEditorMinimapOptions {
A
Alex Dima 已提交
1834 1835 1836 1837 1838
		if (typeof opts !== 'object') {
			return defaults;
		}
		return {
			enabled: _boolean(opts.enabled, defaults.enabled),
1839
			side: _stringSet<'right' | 'left'>(opts.side, defaults.side, ['right', 'left']),
1840
			showSlider: _stringSet<'always' | 'mouseover'>(opts.showSlider, defaults.showSlider, ['always', 'mouseover']),
A
Alex Dima 已提交
1841 1842 1843 1844 1845
			renderCharacters: _boolean(opts.renderCharacters, defaults.renderCharacters),
			maxColumn: _clampedInt(opts.maxColumn, defaults.maxColumn, 1, 10000),
		};
	}

A
Alex Dima 已提交
1846
	private static _santizeFindOpts(opts: IEditorFindOptions | undefined, defaults: InternalEditorFindOptions): InternalEditorFindOptions {
1847 1848 1849 1850 1851
		if (typeof opts !== 'object') {
			return defaults;
		}

		return {
R
rebornix 已提交
1852
			seedSearchStringFromSelection: _boolean(opts.seedSearchStringFromSelection, defaults.seedSearchStringFromSelection),
1853 1854
			autoFindInSelection: _boolean(opts.autoFindInSelection, defaults.autoFindInSelection),
			globalFindClipboard: _boolean(opts.globalFindClipboard, defaults.globalFindClipboard)
1855 1856 1857
		};
	}

A
Alex Dima 已提交
1858
	private static _sanitizeParameterHintOpts(opts: IEditorParameterHintOptions | undefined, defaults: InternalParameterHintOptions): InternalParameterHintOptions {
1859 1860 1861 1862 1863 1864 1865 1866 1867 1868
		if (typeof opts !== 'object') {
			return defaults;
		}

		return {
			enabled: _boolean(opts.enabled, defaults.enabled),
			cycle: _boolean(opts.cycle, defaults.cycle)
		};
	}

A
Alex Dima 已提交
1869
	private static _santizeHoverOpts(_opts: boolean | IEditorHoverOptions | undefined, defaults: InternalEditorHoverOptions): InternalEditorHoverOptions {
A
Alex Dima 已提交
1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881
		let opts: IEditorHoverOptions;
		if (typeof _opts === 'boolean') {
			opts = {
				enabled: _opts
			};
		} else if (typeof _opts === 'object') {
			opts = _opts;
		} else {
			return defaults;
		}

		return {
1882
			enabled: _boolean(opts.enabled, defaults.enabled),
1883 1884
			delay: _clampedInt(opts.delay, defaults.delay, 0, 10000),
			sticky: _boolean(opts.sticky, defaults.sticky)
A
Alex Dima 已提交
1885 1886 1887
		};
	}

1888
	private static _sanitizeSuggestOpts(opts: IEditorOptions, defaults: InternalSuggestOptions): InternalSuggestOptions {
1889
		const suggestOpts = opts.suggest || {};
1890
		return {
1891
			filterGraceful: _boolean(suggestOpts.filterGraceful, defaults.filterGraceful),
1892
			snippets: _stringSet<'top' | 'bottom' | 'inline' | 'none'>(opts.snippetSuggestions, defaults.snippets, ['top', 'bottom', 'inline', 'none']),
1893
			snippetsPreventQuickSuggestions: _boolean(suggestOpts.snippetsPreventQuickSuggestions, defaults.filterGraceful),
J
Johannes Rieken 已提交
1894
			localityBonus: _boolean(suggestOpts.localityBonus, defaults.localityBonus),
1895
			shareSuggestSelections: _boolean(suggestOpts.shareSuggestSelections, defaults.shareSuggestSelections)
1896 1897 1898
		};
	}

A
Alex Dima 已提交
1899
	private static _sanitizeTabCompletionOpts(opts: boolean | 'on' | 'off' | 'onlySnippets' | undefined, defaults: 'on' | 'off' | 'onlySnippets'): 'on' | 'off' | 'onlySnippets' {
1900 1901 1902 1903 1904 1905 1906 1907
		if (opts === false) {
			return 'off';
		} else if (opts === true) {
			return 'onlySnippets';
		} else {
			return _stringSet<'on' | 'off' | 'onlySnippets'>(opts, defaults, ['on', 'off', 'onlySnippets']);
		}
	}
1908

A
Alex Dima 已提交
1909
	private static _sanitizeViewInfo(opts: IEditorOptions, defaults: InternalEditorViewOptions): InternalEditorViewOptions {
1910 1911 1912 1913 1914 1915 1916

		let rulers: number[] = [];
		if (Array.isArray(opts.rulers)) {
			for (let i = 0, len = opts.rulers.length; i < len; i++) {
				rulers.push(_clampedInt(opts.rulers[i], 0, 0, 10000));
			}
			rulers.sort();
1917 1918
		}

1919
		let renderLineNumbers: RenderLineNumbersType = defaults.renderLineNumbers;
A
Alex Dima 已提交
1920
		let renderCustomLineNumbers: ((lineNumber: number) => string) | null = defaults.renderCustomLineNumbers;
1921 1922

		if (typeof opts.lineNumbers !== 'undefined') {
1923
			let lineNumbers = opts.lineNumbers;
1924

1925 1926 1927 1928 1929 1930 1931 1932
			// Compatibility with old true or false values
			if (<any>lineNumbers === true) {
				lineNumbers = 'on';
			} else if (<any>lineNumbers === false) {
				lineNumbers = 'off';
			}

			if (typeof lineNumbers === 'function') {
1933
				renderLineNumbers = RenderLineNumbersType.Custom;
1934
				renderCustomLineNumbers = lineNumbers;
1935 1936
			} else if (lineNumbers === 'interval') {
				renderLineNumbers = RenderLineNumbersType.Interval;
1937
			} else if (lineNumbers === 'relative') {
1938
				renderLineNumbers = RenderLineNumbersType.Relative;
1939
			} else if (lineNumbers === 'on') {
1940
				renderLineNumbers = RenderLineNumbersType.On;
1941
			} else {
1942
				renderLineNumbers = RenderLineNumbersType.Off;
1943 1944 1945
			}
		}

A
Alex Dima 已提交
1946 1947
		const fontLigatures = _boolean(opts.fontLigatures, defaults.fontLigatures);
		const disableMonospaceOptimizations = _boolean(opts.disableMonospaceOptimizations, defaults.disableMonospaceOptimizations) || fontLigatures;
1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970

		let renderWhitespace = opts.renderWhitespace;
		{
			// Compatibility with old true or false values
			if (<any>renderWhitespace === true) {
				renderWhitespace = 'boundary';
			} else if (<any>renderWhitespace === false) {
				renderWhitespace = 'none';
			}
			renderWhitespace = _stringSet<'none' | 'boundary' | 'all'>(opts.renderWhitespace, defaults.renderWhitespace, ['none', 'boundary', 'all']);
		}

		let renderLineHighlight = opts.renderLineHighlight;
		{
			// Compatibility with old true or false values
			if (<any>renderLineHighlight === true) {
				renderLineHighlight = 'line';
			} else if (<any>renderLineHighlight === false) {
				renderLineHighlight = 'none';
			}
			renderLineHighlight = _stringSet<'none' | 'gutter' | 'line' | 'all'>(opts.renderLineHighlight, defaults.renderLineHighlight, ['none', 'gutter', 'line', 'all']);
		}

A
Alex Dima 已提交
1971 1972 1973 1974 1975
		let mouseWheelScrollSensitivity = _float(opts.mouseWheelScrollSensitivity, defaults.scrollbar.mouseWheelScrollSensitivity);
		if (mouseWheelScrollSensitivity === 0) {
			// Disallow 0, as it would prevent/block scrolling
			mouseWheelScrollSensitivity = 1;
		}
T
Tiago Ribeiro 已提交
1976 1977 1978

		let fastScrollSensitivity = _float(opts.fastScrollSensitivity, defaults.scrollbar.fastScrollSensitivity);
		if (fastScrollSensitivity <= 0) {
1979
			fastScrollSensitivity = defaults.scrollbar.fastScrollSensitivity;
T
Tiago Ribeiro 已提交
1980 1981
		}
		const scrollbar = this._sanitizeScrollbarOpts(opts.scrollbar, defaults.scrollbar, mouseWheelScrollSensitivity, fastScrollSensitivity);
1982 1983 1984
		const minimap = this._sanitizeMinimapOpts(opts.minimap, defaults.minimap);

		return {
1985
			extraEditorClassName: _string(opts.extraEditorClassName, defaults.extraEditorClassName),
A
Alex Dima 已提交
1986
			disableMonospaceOptimizations: disableMonospaceOptimizations,
1987
			rulers: rulers,
A
Alex Dima 已提交
1988
			ariaLabel: _string(opts.ariaLabel, defaults.ariaLabel),
1989 1990 1991 1992 1993 1994 1995 1996 1997 1998
			renderLineNumbers: renderLineNumbers,
			renderCustomLineNumbers: renderCustomLineNumbers,
			selectOnLineNumbers: _boolean(opts.selectOnLineNumbers, defaults.selectOnLineNumbers),
			glyphMargin: _boolean(opts.glyphMargin, defaults.glyphMargin),
			revealHorizontalRightPadding: _clampedInt(opts.revealHorizontalRightPadding, defaults.revealHorizontalRightPadding, 0, 1000),
			roundedSelection: _boolean(opts.roundedSelection, defaults.roundedSelection),
			overviewRulerLanes: _clampedInt(opts.overviewRulerLanes, defaults.overviewRulerLanes, 0, 3),
			overviewRulerBorder: _boolean(opts.overviewRulerBorder, defaults.overviewRulerBorder),
			cursorBlinking: _cursorBlinkingStyleFromString(opts.cursorBlinking, defaults.cursorBlinking),
			mouseWheelZoom: _boolean(opts.mouseWheelZoom, defaults.mouseWheelZoom),
1999
			cursorSmoothCaretAnimation: _boolean(opts.cursorSmoothCaretAnimation, defaults.cursorSmoothCaretAnimation),
2000
			cursorStyle: _cursorStyleFromString(opts.cursorStyle, defaults.cursorStyle),
2001
			cursorWidth: _clampedInt(opts.cursorWidth, defaults.cursorWidth, 0, Number.MAX_VALUE),
2002 2003
			hideCursorInOverviewRuler: _boolean(opts.hideCursorInOverviewRuler, defaults.hideCursorInOverviewRuler),
			scrollBeyondLastLine: _boolean(opts.scrollBeyondLastLine, defaults.scrollBeyondLastLine),
2004
			scrollBeyondLastColumn: _clampedInt(opts.scrollBeyondLastColumn, defaults.scrollBeyondLastColumn, 0, Constants.MAX_SAFE_SMALL_INTEGER),
2005
			smoothScrolling: _boolean(opts.smoothScrolling, defaults.smoothScrolling),
2006
			stopRenderingLineAfter: _clampedInt(opts.stopRenderingLineAfter, defaults.stopRenderingLineAfter, -1, Constants.MAX_SAFE_SMALL_INTEGER),
A
Alex Dima 已提交
2007 2008 2009 2010
			renderWhitespace: renderWhitespace,
			renderControlCharacters: _boolean(opts.renderControlCharacters, defaults.renderControlCharacters),
			fontLigatures: fontLigatures,
			renderIndentGuides: _boolean(opts.renderIndentGuides, defaults.renderIndentGuides),
2011
			highlightActiveIndentGuide: _boolean(opts.highlightActiveIndentGuide, defaults.highlightActiveIndentGuide),
A
Alex Dima 已提交
2012 2013 2014 2015 2016 2017 2018
			renderLineHighlight: renderLineHighlight,
			scrollbar: scrollbar,
			minimap: minimap,
			fixedOverflowWidgets: _boolean(opts.fixedOverflowWidgets, defaults.fixedOverflowWidgets),
		};
	}

2019
	private static _sanitizeContribInfo(opts: IEditorOptions, defaults: EditorContribOptions): EditorContribOptions {
A
Alex Dima 已提交
2020 2021 2022 2023 2024 2025
		let quickSuggestions: boolean | { other: boolean, comments: boolean, strings: boolean };
		if (typeof opts.quickSuggestions === 'object') {
			quickSuggestions = { other: true, ...opts.quickSuggestions };
		} else {
			quickSuggestions = _boolean(opts.quickSuggestions, defaults.quickSuggestions);
		}
A
Alex Dima 已提交
2026 2027 2028 2029
		// Compatibility support for acceptSuggestionOnEnter
		if (typeof opts.acceptSuggestionOnEnter === 'boolean') {
			opts.acceptSuggestionOnEnter = opts.acceptSuggestionOnEnter ? 'on' : 'off';
		}
2030
		const find = this._santizeFindOpts(opts.find, defaults.find);
A
Alex Dima 已提交
2031 2032
		return {
			selectionClipboard: _boolean(opts.selectionClipboard, defaults.selectionClipboard),
A
Alex Dima 已提交
2033
			hover: this._santizeHoverOpts(opts.hover, defaults.hover),
2034
			links: _boolean(opts.links, defaults.links),
2035 2036 2037
			contextmenu: _boolean(opts.contextmenu, defaults.contextmenu),
			quickSuggestions: quickSuggestions,
			quickSuggestionsDelay: _clampedInt(opts.quickSuggestionsDelay, defaults.quickSuggestionsDelay, Constants.MIN_SAFE_SMALL_INTEGER, Constants.MAX_SAFE_SMALL_INTEGER),
2038
			parameterHints: this._sanitizeParameterHintOpts(opts.parameterHints, defaults.parameterHints),
2039 2040 2041 2042
			iconsInSuggestions: _boolean(opts.iconsInSuggestions, defaults.iconsInSuggestions),
			formatOnType: _boolean(opts.formatOnType, defaults.formatOnType),
			formatOnPaste: _boolean(opts.formatOnPaste, defaults.formatOnPaste),
			suggestOnTriggerCharacters: _boolean(opts.suggestOnTriggerCharacters, defaults.suggestOnTriggerCharacters),
A
Alex Dima 已提交
2043
			acceptSuggestionOnEnter: _stringSet<'on' | 'smart' | 'off'>(opts.acceptSuggestionOnEnter, defaults.acceptSuggestionOnEnter, ['on', 'smart', 'off']),
2044 2045
			acceptSuggestionOnCommitCharacter: _boolean(opts.acceptSuggestionOnCommitCharacter, defaults.acceptSuggestionOnCommitCharacter),
			wordBasedSuggestions: _boolean(opts.wordBasedSuggestions, defaults.wordBasedSuggestions),
B
Benas Svipas 已提交
2046
			suggestSelection: _stringSet<'first' | 'recentlyUsed' | 'recentlyUsedByPrefix'>(opts.suggestSelection, defaults.suggestSelection, ['first', 'recentlyUsed', 'recentlyUsedByPrefix']),
2047 2048
			suggestFontSize: _clampedInt(opts.suggestFontSize, defaults.suggestFontSize, 0, 1000),
			suggestLineHeight: _clampedInt(opts.suggestLineHeight, defaults.suggestLineHeight, 0, 1000),
2049
			tabCompletion: this._sanitizeTabCompletionOpts(opts.tabCompletion, defaults.tabCompletion),
2050
			suggest: this._sanitizeSuggestOpts(opts, defaults.suggest),
2051 2052
			selectionHighlight: _boolean(opts.selectionHighlight, defaults.selectionHighlight),
			occurrencesHighlight: _boolean(opts.occurrencesHighlight, defaults.occurrencesHighlight),
2053
			codeLens: _boolean(opts.codeLens, defaults.codeLens),
2054
			folding: _boolean(opts.folding, defaults.folding),
2055
			foldingStrategy: _stringSet<'auto' | 'indentation'>(opts.foldingStrategy, defaults.foldingStrategy, ['auto', 'indentation']),
2056
			showFoldingControls: _stringSet<'always' | 'mouseover'>(opts.showFoldingControls, defaults.showFoldingControls, ['always', 'mouseover']),
2057
			matchBrackets: _boolean(opts.matchBrackets, defaults.matchBrackets),
2058
			find: find,
R
rebornix 已提交
2059
			colorDecorators: _boolean(opts.colorDecorators, defaults.colorDecorators),
2060 2061 2062
			lightbulbEnabled: _boolean(opts.lightbulb ? opts.lightbulb.enabled : false, defaults.lightbulbEnabled),
			codeActionsOnSave: _booleanMap(opts.codeActionsOnSave, {}),
			codeActionsOnSaveTimeout: _clampedInt(opts.codeActionsOnSaveTimeout, defaults.codeActionsOnSaveTimeout, 1, 10000)
2063 2064 2065 2066 2067 2068 2069 2070 2071
		};
	}
}

/**
 * @internal
 */
export class InternalEditorOptionsFactory {

2072 2073 2074
	private static _tweakValidatedOptions(opts: IValidatedEditorOptions, accessibilitySupport: platform.AccessibilitySupport): IValidatedEditorOptions {
		const accessibilityIsOn = (accessibilitySupport === platform.AccessibilitySupport.Enabled);
		const accessibilityIsOff = (accessibilitySupport === platform.AccessibilitySupport.Disabled);
2075 2076 2077 2078 2079 2080 2081
		return {
			inDiffEditor: opts.inDiffEditor,
			wordSeparators: opts.wordSeparators,
			lineNumbersMinChars: opts.lineNumbersMinChars,
			lineDecorationsWidth: opts.lineDecorationsWidth,
			readOnly: opts.readOnly,
			mouseStyle: opts.mouseStyle,
2082
			disableLayerHinting: opts.disableLayerHinting,
2083 2084 2085 2086 2087 2088 2089 2090
			automaticLayout: opts.automaticLayout,
			wordWrap: opts.wordWrap,
			wordWrapColumn: opts.wordWrapColumn,
			wordWrapMinified: opts.wordWrapMinified,
			wrappingIndent: opts.wrappingIndent,
			wordWrapBreakBeforeCharacters: opts.wordWrapBreakBeforeCharacters,
			wordWrapBreakAfterCharacters: opts.wordWrapBreakAfterCharacters,
			wordWrapBreakObtrusiveCharacters: opts.wordWrapBreakObtrusiveCharacters,
2091
			autoClosingBrackets: opts.autoClosingBrackets,
J
Jackson Kearl 已提交
2092
			autoClosingQuotes: opts.autoClosingQuotes,
2093
			autoSurround: opts.autoSurround,
2094
			autoIndent: opts.autoIndent,
2095 2096
			dragAndDrop: opts.dragAndDrop,
			emptySelectionClipboard: opts.emptySelectionClipboard,
2097
			copyWithSyntaxHighlighting: opts.copyWithSyntaxHighlighting,
2098
			useTabStops: opts.useTabStops,
2099
			multiCursorModifier: opts.multiCursorModifier,
A
Alex Dima 已提交
2100
			multiCursorMergeOverlapping: opts.multiCursorMergeOverlapping,
2101
			accessibilitySupport: opts.accessibilitySupport,
2102
			showUnused: opts.showUnused,
2103 2104 2105 2106 2107

			viewInfo: {
				extraEditorClassName: opts.viewInfo.extraEditorClassName,
				disableMonospaceOptimizations: opts.viewInfo.disableMonospaceOptimizations,
				rulers: opts.viewInfo.rulers,
2108
				ariaLabel: (accessibilityIsOff ? nls.localize('accessibilityOffAriaLabel', "The editor is not accessible at this time. Press Alt+F1 for options.") : opts.viewInfo.ariaLabel),
2109 2110 2111 2112 2113
				renderLineNumbers: opts.viewInfo.renderLineNumbers,
				renderCustomLineNumbers: opts.viewInfo.renderCustomLineNumbers,
				selectOnLineNumbers: opts.viewInfo.selectOnLineNumbers,
				glyphMargin: opts.viewInfo.glyphMargin,
				revealHorizontalRightPadding: opts.viewInfo.revealHorizontalRightPadding,
2114
				roundedSelection: (accessibilityIsOn ? false : opts.viewInfo.roundedSelection), // DISABLED WHEN SCREEN READER IS ATTACHED
2115 2116 2117 2118
				overviewRulerLanes: opts.viewInfo.overviewRulerLanes,
				overviewRulerBorder: opts.viewInfo.overviewRulerBorder,
				cursorBlinking: opts.viewInfo.cursorBlinking,
				mouseWheelZoom: opts.viewInfo.mouseWheelZoom,
2119
				cursorSmoothCaretAnimation: opts.viewInfo.cursorSmoothCaretAnimation,
2120
				cursorStyle: opts.viewInfo.cursorStyle,
2121
				cursorWidth: opts.viewInfo.cursorWidth,
2122 2123
				hideCursorInOverviewRuler: opts.viewInfo.hideCursorInOverviewRuler,
				scrollBeyondLastLine: opts.viewInfo.scrollBeyondLastLine,
2124
				scrollBeyondLastColumn: opts.viewInfo.scrollBeyondLastColumn,
2125
				smoothScrolling: opts.viewInfo.smoothScrolling,
2126
				stopRenderingLineAfter: opts.viewInfo.stopRenderingLineAfter,
2127 2128 2129 2130
				renderWhitespace: (accessibilityIsOn ? 'none' : opts.viewInfo.renderWhitespace), // DISABLED WHEN SCREEN READER IS ATTACHED
				renderControlCharacters: (accessibilityIsOn ? false : opts.viewInfo.renderControlCharacters), // DISABLED WHEN SCREEN READER IS ATTACHED
				fontLigatures: (accessibilityIsOn ? false : opts.viewInfo.fontLigatures), // DISABLED WHEN SCREEN READER IS ATTACHED
				renderIndentGuides: (accessibilityIsOn ? false : opts.viewInfo.renderIndentGuides), // DISABLED WHEN SCREEN READER IS ATTACHED
2131
				highlightActiveIndentGuide: opts.viewInfo.highlightActiveIndentGuide,
A
Alex Dima 已提交
2132
				renderLineHighlight: opts.viewInfo.renderLineHighlight,
2133 2134
				scrollbar: opts.viewInfo.scrollbar,
				minimap: {
2135
					enabled: (accessibilityIsOn ? false : opts.viewInfo.minimap.enabled), // DISABLED WHEN SCREEN READER IS ATTACHED
2136
					side: opts.viewInfo.minimap.side,
2137
					renderCharacters: opts.viewInfo.minimap.renderCharacters,
2138
					showSlider: opts.viewInfo.minimap.showSlider,
2139 2140 2141 2142 2143 2144 2145 2146
					maxColumn: opts.viewInfo.minimap.maxColumn
				},
				fixedOverflowWidgets: opts.viewInfo.fixedOverflowWidgets
			},

			contribInfo: {
				selectionClipboard: opts.contribInfo.selectionClipboard,
				hover: opts.contribInfo.hover,
2147
				links: (accessibilityIsOn ? false : opts.contribInfo.links), // DISABLED WHEN SCREEN READER IS ATTACHED
2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158
				contextmenu: opts.contribInfo.contextmenu,
				quickSuggestions: opts.contribInfo.quickSuggestions,
				quickSuggestionsDelay: opts.contribInfo.quickSuggestionsDelay,
				parameterHints: opts.contribInfo.parameterHints,
				iconsInSuggestions: opts.contribInfo.iconsInSuggestions,
				formatOnType: opts.contribInfo.formatOnType,
				formatOnPaste: opts.contribInfo.formatOnPaste,
				suggestOnTriggerCharacters: opts.contribInfo.suggestOnTriggerCharacters,
				acceptSuggestionOnEnter: opts.contribInfo.acceptSuggestionOnEnter,
				acceptSuggestionOnCommitCharacter: opts.contribInfo.acceptSuggestionOnCommitCharacter,
				wordBasedSuggestions: opts.contribInfo.wordBasedSuggestions,
J
Johannes Rieken 已提交
2159
				suggestSelection: opts.contribInfo.suggestSelection,
2160 2161
				suggestFontSize: opts.contribInfo.suggestFontSize,
				suggestLineHeight: opts.contribInfo.suggestLineHeight,
2162
				tabCompletion: opts.contribInfo.tabCompletion,
2163
				suggest: opts.contribInfo.suggest,
2164 2165 2166 2167
				selectionHighlight: (accessibilityIsOn ? false : opts.contribInfo.selectionHighlight), // DISABLED WHEN SCREEN READER IS ATTACHED
				occurrencesHighlight: (accessibilityIsOn ? false : opts.contribInfo.occurrencesHighlight), // DISABLED WHEN SCREEN READER IS ATTACHED
				codeLens: (accessibilityIsOn ? false : opts.contribInfo.codeLens), // DISABLED WHEN SCREEN READER IS ATTACHED
				folding: (accessibilityIsOn ? false : opts.contribInfo.folding), // DISABLED WHEN SCREEN READER IS ATTACHED
2168
				foldingStrategy: opts.contribInfo.foldingStrategy,
2169
				showFoldingControls: opts.contribInfo.showFoldingControls,
2170
				matchBrackets: (accessibilityIsOn ? false : opts.contribInfo.matchBrackets), // DISABLED WHEN SCREEN READER IS ATTACHED
2171
				find: opts.contribInfo.find,
2172
				colorDecorators: opts.contribInfo.colorDecorators,
2173 2174 2175
				lightbulbEnabled: opts.contribInfo.lightbulbEnabled,
				codeActionsOnSave: opts.contribInfo.codeActionsOnSave,
				codeActionsOnSaveTimeout: opts.contribInfo.codeActionsOnSaveTimeout
2176 2177 2178 2179 2180 2181
			}
		};
	}

	public static createInternalEditorOptions(env: IEnvironmentalOptions, _opts: IValidatedEditorOptions) {

2182 2183 2184 2185 2186 2187 2188 2189 2190 2191
		let accessibilitySupport: platform.AccessibilitySupport;
		if (_opts.accessibilitySupport === 'auto') {
			// The editor reads the `accessibilitySupport` from the environment
			accessibilitySupport = env.accessibilitySupport;
		} else if (_opts.accessibilitySupport === 'on') {
			accessibilitySupport = platform.AccessibilitySupport.Enabled;
		} else {
			accessibilitySupport = platform.AccessibilitySupport.Disabled;
		}

2192 2193
		// Disable some non critical features to get as best performance as possible
		// See https://github.com/Microsoft/vscode/issues/26730
2194
		const opts = this._tweakValidatedOptions(_opts, accessibilitySupport);
2195 2196 2197 2198 2199 2200 2201 2202

		let lineDecorationsWidth: number;
		if (typeof opts.lineDecorationsWidth === 'string' && /^\d+(\.\d+)?ch$/.test(opts.lineDecorationsWidth)) {
			const multiple = parseFloat(opts.lineDecorationsWidth.substr(0, opts.lineDecorationsWidth.length - 2));
			lineDecorationsWidth = multiple * env.fontInfo.typicalHalfwidthCharacterWidth;
		} else {
			lineDecorationsWidth = _clampedInt(opts.lineDecorationsWidth, 0, 0, 1000);
		}
A
Alex Dima 已提交
2203
		if (opts.contribInfo.folding) {
2204 2205 2206
			lineDecorationsWidth += 16;
		}

2207 2208 2209
		const layoutInfo = EditorLayoutProvider.compute({
			outerWidth: env.outerWidth,
			outerHeight: env.outerHeight,
A
Alex Dima 已提交
2210
			showGlyphMargin: opts.viewInfo.glyphMargin,
2211
			lineHeight: env.fontInfo.lineHeight,
2212
			showLineNumbers: (opts.viewInfo.renderLineNumbers !== RenderLineNumbersType.Off),
2213
			lineNumbersMinChars: opts.lineNumbersMinChars,
2214 2215 2216 2217
			lineNumbersDigitCount: env.lineNumbersDigitCount,
			lineDecorationsWidth: lineDecorationsWidth,
			typicalHalfwidthCharacterWidth: env.fontInfo.typicalHalfwidthCharacterWidth,
			maxDigitWidth: env.fontInfo.maxDigitWidth,
A
Alex Dima 已提交
2218 2219 2220 2221 2222
			verticalScrollbarWidth: opts.viewInfo.scrollbar.verticalScrollbarSize,
			horizontalScrollbarHeight: opts.viewInfo.scrollbar.horizontalScrollbarSize,
			scrollbarArrowSize: opts.viewInfo.scrollbar.arrowSize,
			verticalScrollbarHasArrows: opts.viewInfo.scrollbar.verticalHasArrows,
			minimap: opts.viewInfo.minimap.enabled,
2223
			minimapSide: opts.viewInfo.minimap.side,
A
Alex Dima 已提交
2224 2225
			minimapRenderCharacters: opts.viewInfo.minimap.renderCharacters,
			minimapMaxColumn: opts.viewInfo.minimap.maxColumn,
2226 2227 2228
			pixelRatio: env.pixelRatio
		});

A
Alex Dima 已提交
2229
		let bareWrappingInfo: { isWordWrapMinified: boolean; isViewportWrapping: boolean; wrappingColumn: number; } | null = null;
2230
		{
A
Alex Dima 已提交
2231
			const wordWrap = opts.wordWrap;
2232 2233
			const wordWrapColumn = opts.wordWrapColumn;
			const wordWrapMinified = opts.wordWrapMinified;
2234

2235
			if (accessibilitySupport === platform.AccessibilitySupport.Enabled) {
2236 2237 2238 2239 2240 2241 2242 2243 2244 2245
				// See https://github.com/Microsoft/vscode/issues/27766
				// Never enable wrapping when a screen reader is attached
				// because arrow down etc. will not move the cursor in the way
				// a screen reader expects.
				bareWrappingInfo = {
					isWordWrapMinified: false,
					isViewportWrapping: false,
					wrappingColumn: -1
				};
			} else if (wordWrapMinified && env.isDominatedByLongLines) {
2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278
				// Force viewport width wrapping if model is dominated by long lines
				bareWrappingInfo = {
					isWordWrapMinified: true,
					isViewportWrapping: true,
					wrappingColumn: Math.max(1, layoutInfo.viewportColumn)
				};
			} else if (wordWrap === 'on') {
				bareWrappingInfo = {
					isWordWrapMinified: false,
					isViewportWrapping: true,
					wrappingColumn: Math.max(1, layoutInfo.viewportColumn)
				};
			} else if (wordWrap === 'bounded') {
				bareWrappingInfo = {
					isWordWrapMinified: false,
					isViewportWrapping: true,
					wrappingColumn: Math.min(Math.max(1, layoutInfo.viewportColumn), wordWrapColumn)
				};
			} else if (wordWrap === 'wordWrapColumn') {
				bareWrappingInfo = {
					isWordWrapMinified: false,
					isViewportWrapping: false,
					wrappingColumn: wordWrapColumn
				};
			} else {
				bareWrappingInfo = {
					isWordWrapMinified: false,
					isViewportWrapping: false,
					wrappingColumn: -1
				};
			}
		}

A
Alex Dima 已提交
2279
		const wrappingInfo: EditorWrappingInfo = {
2280
			inDiffEditor: opts.inDiffEditor,
2281 2282 2283 2284
			isDominatedByLongLines: env.isDominatedByLongLines,
			isWordWrapMinified: bareWrappingInfo.isWordWrapMinified,
			isViewportWrapping: bareWrappingInfo.isViewportWrapping,
			wrappingColumn: bareWrappingInfo.wrappingColumn,
2285 2286 2287 2288
			wrappingIndent: opts.wrappingIndent,
			wordWrapBreakBeforeCharacters: opts.wordWrapBreakBeforeCharacters,
			wordWrapBreakAfterCharacters: opts.wordWrapBreakAfterCharacters,
			wordWrapBreakObtrusiveCharacters: opts.wordWrapBreakObtrusiveCharacters,
A
Alex Dima 已提交
2289
		};
2290

2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306
		let className = 'monaco-editor';
		if (opts.viewInfo.extraEditorClassName) {
			className += ' ' + opts.viewInfo.extraEditorClassName;
		}
		if (env.extraEditorClassName) {
			className += ' ' + env.extraEditorClassName;
		}
		if (opts.viewInfo.fontLigatures) {
			className += ' enable-ligatures';
		}
		if (opts.mouseStyle === 'default') {
			className += ' mouse-default';
		} else if (opts.mouseStyle === 'copy') {
			className += ' mouse-copy';
		}

2307
		return new InternalEditorOptions({
2308
			canUseLayerHinting: opts.disableLayerHinting ? false : true,
2309
			pixelRatio: env.pixelRatio,
2310
			editorClassName: className,
A
Alex Dima 已提交
2311
			lineHeight: env.fontInfo.lineHeight,
2312
			readOnly: opts.readOnly,
2313
			accessibilitySupport: accessibilitySupport,
2314
			multiCursorModifier: opts.multiCursorModifier,
A
Alex Dima 已提交
2315
			multiCursorMergeOverlapping: opts.multiCursorMergeOverlapping,
2316 2317
			wordSeparators: opts.wordSeparators,
			autoClosingBrackets: opts.autoClosingBrackets,
J
Jackson Kearl 已提交
2318
			autoClosingQuotes: opts.autoClosingQuotes,
2319
			autoSurround: opts.autoSurround,
2320
			autoIndent: opts.autoIndent,
2321 2322 2323
			useTabStops: opts.useTabStops,
			tabFocusMode: opts.readOnly ? true : env.tabFocusMode,
			dragAndDrop: opts.dragAndDrop,
2324
			emptySelectionClipboard: opts.emptySelectionClipboard && env.emptySelectionClipboard,
2325
			copyWithSyntaxHighlighting: opts.copyWithSyntaxHighlighting,
2326 2327
			layoutInfo: layoutInfo,
			fontInfo: env.fontInfo,
A
Alex Dima 已提交
2328
			viewInfo: opts.viewInfo,
2329
			wrappingInfo: wrappingInfo,
2330 2331
			contribInfo: opts.contribInfo,
			showUnused: opts.showUnused,
2332 2333 2334 2335 2336 2337 2338 2339
		});
	}
}

/**
 * @internal
 */
export interface IEditorLayoutProviderOpts {
M
Matt Bierner 已提交
2340 2341
	readonly outerWidth: number;
	readonly outerHeight: number;
2342

M
Matt Bierner 已提交
2343 2344
	readonly showGlyphMargin: boolean;
	readonly lineHeight: number;
2345

M
Matt Bierner 已提交
2346 2347 2348
	readonly showLineNumbers: boolean;
	readonly lineNumbersMinChars: number;
	readonly lineNumbersDigitCount: number;
2349

M
Matt Bierner 已提交
2350
	readonly lineDecorationsWidth: number;
2351

M
Matt Bierner 已提交
2352 2353
	readonly typicalHalfwidthCharacterWidth: number;
	readonly maxDigitWidth: number;
2354

M
Matt Bierner 已提交
2355 2356 2357 2358
	readonly verticalScrollbarWidth: number;
	readonly verticalScrollbarHasArrows: boolean;
	readonly scrollbarArrowSize: number;
	readonly horizontalScrollbarHeight: number;
2359

M
Matt Bierner 已提交
2360 2361 2362 2363 2364
	readonly minimap: boolean;
	readonly minimapSide: string;
	readonly minimapRenderCharacters: boolean;
	readonly minimapMaxColumn: number;
	readonly pixelRatio: number;
2365 2366 2367 2368 2369 2370 2371 2372 2373
}

/**
 * @internal
 */
export class EditorLayoutProvider {
	public static compute(_opts: IEditorLayoutProviderOpts): EditorLayoutInfo {
		const outerWidth = _opts.outerWidth | 0;
		const outerHeight = _opts.outerHeight | 0;
A
Alex Dima 已提交
2374
		const showGlyphMargin = _opts.showGlyphMargin;
2375
		const lineHeight = _opts.lineHeight | 0;
A
Alex Dima 已提交
2376
		const showLineNumbers = _opts.showLineNumbers;
2377 2378 2379
		const lineNumbersMinChars = _opts.lineNumbersMinChars | 0;
		const lineNumbersDigitCount = _opts.lineNumbersDigitCount | 0;
		const lineDecorationsWidth = _opts.lineDecorationsWidth | 0;
A
Alex Dima 已提交
2380 2381
		const typicalHalfwidthCharacterWidth = _opts.typicalHalfwidthCharacterWidth;
		const maxDigitWidth = _opts.maxDigitWidth;
A
Alex Dima 已提交
2382
		const verticalScrollbarWidth = _opts.verticalScrollbarWidth | 0;
A
Alex Dima 已提交
2383
		const verticalScrollbarHasArrows = _opts.verticalScrollbarHasArrows;
2384 2385
		const scrollbarArrowSize = _opts.scrollbarArrowSize | 0;
		const horizontalScrollbarHeight = _opts.horizontalScrollbarHeight | 0;
A
Alex Dima 已提交
2386
		const minimap = _opts.minimap;
2387
		const minimapSide = _opts.minimapSide;
A
Alex Dima 已提交
2388
		const minimapRenderCharacters = _opts.minimapRenderCharacters;
2389
		const minimapMaxColumn = _opts.minimapMaxColumn | 0;
A
Alex Dima 已提交
2390
		const pixelRatio = _opts.pixelRatio;
2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402

		let lineNumbersWidth = 0;
		if (showLineNumbers) {
			const digitCount = Math.max(lineNumbersDigitCount, lineNumbersMinChars);
			lineNumbersWidth = Math.round(digitCount * maxDigitWidth);
		}

		let glyphMarginWidth = 0;
		if (showGlyphMargin) {
			glyphMarginWidth = lineHeight;
		}

A
Alex Dima 已提交
2403 2404 2405 2406 2407
		let glyphMarginLeft = 0;
		let lineNumbersLeft = glyphMarginLeft + glyphMarginWidth;
		let decorationsLeft = lineNumbersLeft + lineNumbersWidth;
		let contentLeft = decorationsLeft + lineDecorationsWidth;

2408 2409 2410
		const remainingWidth = outerWidth - glyphMarginWidth - lineNumbersWidth - lineDecorationsWidth;

		let renderMinimap: RenderMinimap;
2411
		let minimapLeft: number;
2412 2413 2414
		let minimapWidth: number;
		let contentWidth: number;
		if (!minimap) {
2415
			minimapLeft = 0;
2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429
			minimapWidth = 0;
			renderMinimap = RenderMinimap.None;
			contentWidth = remainingWidth;
		} else {
			let minimapCharWidth: number;
			if (pixelRatio >= 2) {
				renderMinimap = minimapRenderCharacters ? RenderMinimap.Large : RenderMinimap.LargeBlocks;
				minimapCharWidth = 2 / pixelRatio;
			} else {
				renderMinimap = minimapRenderCharacters ? RenderMinimap.Small : RenderMinimap.SmallBlocks;
				minimapCharWidth = 1 / pixelRatio;
			}

			// Given:
2430 2431
			// (leaving 2px for the cursor to have space after the last character)
			// viewportColumn = (contentWidth - verticalScrollbarWidth - 2) / typicalHalfwidthCharacterWidth
2432 2433 2434 2435
			// minimapWidth = viewportColumn * minimapCharWidth
			// contentWidth = remainingWidth - minimapWidth
			// What are good values for contentWidth and minimapWidth ?

2436 2437 2438 2439 2440
			// minimapWidth = ((contentWidth - verticalScrollbarWidth - 2) / typicalHalfwidthCharacterWidth) * minimapCharWidth
			// typicalHalfwidthCharacterWidth * minimapWidth = (contentWidth - verticalScrollbarWidth - 2) * minimapCharWidth
			// typicalHalfwidthCharacterWidth * minimapWidth = (remainingWidth - minimapWidth - verticalScrollbarWidth - 2) * minimapCharWidth
			// (typicalHalfwidthCharacterWidth + minimapCharWidth) * minimapWidth = (remainingWidth - verticalScrollbarWidth - 2) * minimapCharWidth
			// minimapWidth = ((remainingWidth - verticalScrollbarWidth - 2) * minimapCharWidth) / (typicalHalfwidthCharacterWidth + minimapCharWidth)
2441

2442
			minimapWidth = Math.max(0, Math.floor(((remainingWidth - verticalScrollbarWidth - 2) * minimapCharWidth) / (typicalHalfwidthCharacterWidth + minimapCharWidth)));
2443 2444 2445 2446 2447
			let minimapColumns = minimapWidth / minimapCharWidth;
			if (minimapColumns > minimapMaxColumn) {
				minimapWidth = Math.floor(minimapMaxColumn * minimapCharWidth);
			}
			contentWidth = remainingWidth - minimapWidth;
2448

A
Alex Dima 已提交
2449
			if (minimapSide === 'left') {
2450
				minimapLeft = 0;
A
Alex Dima 已提交
2451 2452 2453 2454
				glyphMarginLeft += minimapWidth;
				lineNumbersLeft += minimapWidth;
				decorationsLeft += minimapWidth;
				contentLeft += minimapWidth;
2455 2456
			} else {
				minimapLeft = outerWidth - minimapWidth - verticalScrollbarWidth;
2457
			}
2458 2459
		}

2460 2461
		// (leaving 2px for the cursor to have space after the last character)
		const viewportColumn = Math.max(1, Math.floor((contentWidth - verticalScrollbarWidth - 2) / typicalHalfwidthCharacterWidth));
2462 2463 2464

		const verticalArrowSize = (verticalScrollbarHasArrows ? scrollbarArrowSize : 0);

A
Alex Dima 已提交
2465
		return {
2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485
			width: outerWidth,
			height: outerHeight,

			glyphMarginLeft: glyphMarginLeft,
			glyphMarginWidth: glyphMarginWidth,
			glyphMarginHeight: outerHeight,

			lineNumbersLeft: lineNumbersLeft,
			lineNumbersWidth: lineNumbersWidth,
			lineNumbersHeight: outerHeight,

			decorationsLeft: decorationsLeft,
			decorationsWidth: lineDecorationsWidth,
			decorationsHeight: outerHeight,

			contentLeft: contentLeft,
			contentWidth: contentWidth,
			contentHeight: outerHeight,

			renderMinimap: renderMinimap,
2486
			minimapLeft: minimapLeft,
2487 2488 2489 2490 2491 2492 2493
			minimapWidth: minimapWidth,

			viewportColumn: viewportColumn,

			verticalScrollbarWidth: verticalScrollbarWidth,
			horizontalScrollbarHeight: horizontalScrollbarHeight,

A
Alex Dima 已提交
2494
			overviewRuler: {
2495 2496 2497 2498
				top: verticalArrowSize,
				width: verticalScrollbarWidth,
				height: (outerHeight - 2 * verticalArrowSize),
				right: 0
A
Alex Dima 已提交
2499 2500
			}
		};
2501 2502
	}
}
2503 2504 2505

const DEFAULT_WINDOWS_FONT_FAMILY = 'Consolas, \'Courier New\', monospace';
const DEFAULT_MAC_FONT_FAMILY = 'Menlo, Monaco, \'Courier New\', monospace';
2506
const DEFAULT_LINUX_FONT_FAMILY = '\'Droid Sans Mono\', \'monospace\', monospace, \'Droid Sans Fallback\'';
2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519

/**
 * @internal
 */
export const EDITOR_FONT_DEFAULTS = {
	fontFamily: (
		platform.isMacintosh ? DEFAULT_MAC_FONT_FAMILY : (platform.isLinux ? DEFAULT_LINUX_FONT_FAMILY : DEFAULT_WINDOWS_FONT_FAMILY)
	),
	fontWeight: 'normal',
	fontSize: (
		platform.isMacintosh ? 12 : 14
	),
	lineHeight: 0,
2520
	letterSpacing: 0,
2521 2522 2523 2524 2525 2526 2527 2528 2529
};

/**
 * @internal
 */
export const EDITOR_MODEL_DEFAULTS = {
	tabSize: 4,
	insertSpaces: true,
	detectIndentation: true,
2530
	trimAutoWhitespace: true,
2531
	largeFileOptimizations: true
2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543
};

/**
 * @internal
 */
export const EDITOR_DEFAULTS: IValidatedEditorOptions = {
	inDiffEditor: false,
	wordSeparators: USUAL_WORD_SEPARATORS,
	lineNumbersMinChars: 5,
	lineDecorationsWidth: 10,
	readOnly: false,
	mouseStyle: 'text',
2544
	disableLayerHinting: false,
2545 2546 2547 2548 2549 2550
	automaticLayout: false,
	wordWrap: 'off',
	wordWrapColumn: 80,
	wordWrapMinified: true,
	wrappingIndent: WrappingIndent.Same,
	wordWrapBreakBeforeCharacters: '([{‘“〈《「『【〔([{「£¥$£¥++',
2551
	wordWrapBreakAfterCharacters: ' \t})]?|&,;¢°′″‰℃、。。、¢,.:;?!%・・ゝゞヽヾーァィゥェォッャュョヮヵヶぁぃぅぇぉっゃゅょゎゕゖㇰㇱㇲㇳㇴㇵㇶㇷㇸㇹㇺㇻㇼㇽㇾㇿ々〻ァィゥェォャュョッー”〉》」』】〕)]}」',
2552
	wordWrapBreakObtrusiveCharacters: '.',
J
Jackson Kearl 已提交
2553 2554
	autoClosingBrackets: 'languageDefined',
	autoClosingQuotes: 'languageDefined',
2555
	autoSurround: 'languageDefined',
R
rebornix 已提交
2556
	autoIndent: true,
2557
	dragAndDrop: true,
2558
	emptySelectionClipboard: true,
2559
	copyWithSyntaxHighlighting: true,
2560
	useTabStops: true,
2561
	multiCursorModifier: 'altKey',
A
Alex Dima 已提交
2562
	multiCursorMergeOverlapping: true,
2563
	accessibilitySupport: 'auto',
2564
	showUnused: true,
A
Alex Dima 已提交
2565 2566

	viewInfo: {
2567
		extraEditorClassName: '',
A
Alex Dima 已提交
2568 2569 2570
		disableMonospaceOptimizations: false,
		rulers: [],
		ariaLabel: nls.localize('editorViewAccessibleLabel', "Editor content"),
2571
		renderLineNumbers: RenderLineNumbersType.On,
A
Alex Dima 已提交
2572 2573 2574 2575 2576 2577 2578 2579 2580
		renderCustomLineNumbers: null,
		selectOnLineNumbers: true,
		glyphMargin: true,
		revealHorizontalRightPadding: 30,
		roundedSelection: true,
		overviewRulerLanes: 2,
		overviewRulerBorder: true,
		cursorBlinking: TextEditorCursorBlinkingStyle.Blink,
		mouseWheelZoom: false,
2581
		cursorSmoothCaretAnimation: false,
A
Alex Dima 已提交
2582
		cursorStyle: TextEditorCursorStyle.Line,
2583
		cursorWidth: 0,
A
Alex Dima 已提交
2584 2585
		hideCursorInOverviewRuler: false,
		scrollBeyondLastLine: true,
2586
		scrollBeyondLastColumn: 5,
2587
		smoothScrolling: false,
A
Alex Dima 已提交
2588 2589 2590 2591
		stopRenderingLineAfter: 10000,
		renderWhitespace: 'none',
		renderControlCharacters: false,
		fontLigatures: false,
2592
		renderIndentGuides: true,
2593
		highlightActiveIndentGuide: true,
A
Alex Dima 已提交
2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607
		renderLineHighlight: 'line',
		scrollbar: {
			vertical: ScrollbarVisibility.Auto,
			horizontal: ScrollbarVisibility.Auto,
			arrowSize: 11,
			useShadows: true,
			verticalHasArrows: false,
			horizontalHasArrows: false,
			horizontalScrollbarSize: 10,
			horizontalSliderSize: 10,
			verticalScrollbarSize: 14,
			verticalSliderSize: 14,
			handleMouseWheel: true,
			mouseWheelScrollSensitivity: 1,
T
Tiago Ribeiro 已提交
2608
			fastScrollSensitivity: 5,
A
Alex Dima 已提交
2609 2610
		},
		minimap: {
2611
			enabled: true,
2612
			side: 'right',
2613
			showSlider: 'mouseover',
A
Alex Dima 已提交
2614 2615 2616 2617 2618 2619 2620 2621
			renderCharacters: true,
			maxColumn: 120
		},
		fixedOverflowWidgets: false,
	},

	contribInfo: {
		selectionClipboard: true,
A
Alex Dima 已提交
2622
		hover: {
2623
			enabled: true,
2624 2625
			delay: 300,
			sticky: true
A
Alex Dima 已提交
2626
		},
2627
		links: true,
A
Alex Dima 已提交
2628 2629 2630
		contextmenu: true,
		quickSuggestions: { other: true, comments: false, strings: false },
		quickSuggestionsDelay: 10,
2631 2632 2633 2634
		parameterHints: {
			enabled: true,
			cycle: false
		},
A
Alex Dima 已提交
2635 2636
		iconsInSuggestions: true,
		formatOnType: false,
2637
		formatOnPaste: false,
A
Alex Dima 已提交
2638
		suggestOnTriggerCharacters: true,
2639
		acceptSuggestionOnEnter: 'on',
A
Alex Dima 已提交
2640 2641
		acceptSuggestionOnCommitCharacter: true,
		wordBasedSuggestions: true,
B
Benas Svipas 已提交
2642
		suggestSelection: 'recentlyUsed',
A
Alex Dima 已提交
2643 2644
		suggestFontSize: 0,
		suggestLineHeight: 0,
2645
		tabCompletion: 'off',
2646 2647
		suggest: {
			filterGraceful: true,
2648
			snippets: 'inline',
J
Johannes Rieken 已提交
2649
			snippetsPreventQuickSuggestions: true,
2650
			localityBonus: false,
J
Johannes Rieken 已提交
2651
			shareSuggestSelections: false
2652
		},
A
Alex Dima 已提交
2653 2654 2655 2656
		selectionHighlight: true,
		occurrencesHighlight: true,
		codeLens: true,
		folding: true,
2657
		foldingStrategy: 'auto',
2658
		showFoldingControls: 'mouseover',
A
Alex Dima 已提交
2659
		matchBrackets: true,
2660
		find: {
R
rebornix 已提交
2661
			seedSearchStringFromSelection: true,
2662
			autoFindInSelection: false,
2663
			globalFindClipboard: false
2664
		},
2665
		colorDecorators: true,
2666 2667 2668
		lightbulbEnabled: true,
		codeActionsOnSave: {},
		codeActionsOnSaveTimeout: 750
A
Alex Dima 已提交
2669
	},
2670
};