editorOptions.ts 90.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
import { AccessibilitySupport } from 'vs/platform/accessibility/common/accessibility';
15 16 17 18 19 20 21 22 23 24 25 26 27 28

/**
 * 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 已提交
29
	vertical?: 'auto' | 'visible' | 'hidden';
30 31 32 33
	/**
	 * Render horizontal scrollbar.
	 * Defaults to 'auto'.
	 */
A
Alex Dima 已提交
34
	horizontal?: 'auto' | 'visible' | 'hidden';
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 76
	/**
	 * 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;
}

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

J
Jackson Kearl 已提交
100
/**
J
Jackson Kearl 已提交
101
 * Configuration options for auto closing quotes and brackets
J
Jackson Kearl 已提交
102
 */
J
Jackson Kearl 已提交
103 104 105 106 107
export type EditorAutoClosingStrategy = 'always' | 'languageDefined' | 'beforeWhitespace' | 'never';

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

110 111 112 113 114 115
/**
 * Configuration options for editor minimap
 */
export interface IEditorMinimapOptions {
	/**
	 * Enable the rendering of the minimap.
116
	 * Defaults to true.
117 118
	 */
	enabled?: boolean;
119 120 121 122 123
	/**
	 * Control the side of the minimap in editor.
	 * Defaults to 'right'.
	 */
	side?: 'right' | 'left';
124 125 126 127 128
	/**
	 * Control the rendering of the minimap slider.
	 * Defaults to 'mouseover'.
	 */
	showSlider?: 'always' | 'mouseover';
129 130 131 132 133 134 135 136 137 138 139 140
	/**
	 * 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;
}

141 142 143 144 145 146 147 148 149 150 151
/**
 * Configuration options for editor minimap
 */
export interface IEditorLightbulbOptions {
	/**
	 * Enable the lightbulb code action.
	 * Defaults to true.
	 */
	enabled?: boolean;
}

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

173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
/**
 * 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;
}

189 190 191 192 193
export interface ISuggestOptions {
	/**
	 * Enable graceful matching. Defaults to true.
	 */
	filterGraceful?: boolean;
194 195 196 197
	/**
	 * Prevent quick suggestions when a snippet is active. Defaults to true.
	 */
	snippetsPreventQuickSuggestions?: boolean;
J
Johannes Rieken 已提交
198 199 200 201
	/**
	 * Favours words that appear close to the cursor.
	 */
	localityBonus?: boolean;
202 203 204
	/**
	 * Enable using global storage for remembering suggestions.
	 */
205
	shareSuggestSelections?: boolean;
206 207 208 209 210 211 212 213
	/**
	 * Enable or disable icons in suggestions. Defaults to true.
	 */
	showIcons?: boolean;
	/**
	 * Max suggestions to show in suggestions. Defaults to 12.
	 */
	maxSuggestionsToShow?: boolean;
214 215
}

216 217 218 219 220 221 222
/**
 * Configuration map for codeActionsOnSave
 */
export interface ICodeActionsOnSaveOptions {
	[kind: string]: boolean;
}

223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
/**
 * 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.
	 */
258
	lineNumbers?: 'on' | 'off' | 'relative' | 'interval' | ((lineNumber: number) => string);
A
Alex Dima 已提交
259 260 261
	/**
	 * Render last line number when the file ends with a newline.
	 * Defaults to true on Windows/Mac and to false on Linux.
262
	*/
A
Alex Dima 已提交
263
	renderFinalNewline?: boolean;
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
	/**
	 * 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;
	/**
298
	 * Class name to be added to the editor.
299
	 */
300
	extraEditorClassName?: string;
301 302 303 304 305 306 307 308 309 310 311 312 313
	/**
	 * 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;
314 315 316 317
	/**
	 * Control the behavior of the find widget.
	 */
	find?: IEditorFindOptions;
318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
	/**
	 * 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';
349 350 351 352 353
	/**
	 * Enable smooth caret animation.
	 * Defaults to false.
	 */
	cursorSmoothCaretAnimation?: boolean;
354 355 356 357 358
	/**
	 * Control the cursor style, either 'block' or 'line'.
	 * Defaults to 'line'.
	 */
	cursorStyle?: string;
359 360 361
	/**
	 * Control the width of the cursor when cursorStyle is set to 'line'
	 */
362
	cursorWidth?: number;
363 364 365 366 367 368
	/**
	 * Enable font ligatures.
	 * Defaults to false.
	 */
	fontLigatures?: boolean;
	/**
369 370
	 * 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.
371 372
	 * Defaults to false.
	 */
373
	disableLayerHinting?: boolean;
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
	/**
	 * 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;
389 390 391 392 393
	/**
	 * Enable that scrolling can go beyond the last column by a number of columns.
	 * Defaults to 5.
	 */
	scrollBeyondLastColumn?: number;
394 395
	/**
	 * Enable that the editor animates scrolling to a position.
396
	 * Defaults to false.
397 398
	 */
	smoothScrolling?: boolean;
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
	/**
	 * 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;
	/**
429
	 * Control indentation of wrapped lines. Can be: 'none', 'same', 'indent' or 'deepIndent'.
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
	 * 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 已提交
456
	 * Configure the editor's hover.
457
	 */
A
Alex Dima 已提交
458
	hover?: IEditorHoverOptions;
459 460 461 462 463
	/**
	 * Enable detecting links and making them clickable.
	 * Defaults to true.
	 */
	links?: boolean;
464
	/**
465
	 * Enable inline color decorators and color picker rendering.
466
	 */
R
rebornix 已提交
467
	colorDecorators?: boolean;
468 469 470 471 472 473 474 475 476 477
	/**
	 * 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 已提交
478
	/**
479 480
	 * FastScrolling mulitplier speed when pressing `Alt`
	 * Defaults to 5.
T
Tiago Ribeiro 已提交
481 482
	 */
	fastScrollSensitivity?: number;
483 484 485 486
	/**
	 * The modifier to be used to add multiple cursors with the mouse.
	 * Defaults to 'alt'
	 */
487
	multiCursorModifier?: 'ctrlCmd' | 'alt';
488
	/**
A
Alex Dima 已提交
489
	 * Merge overlapping selections.
490 491
	 * Defaults to true
	 */
A
Alex Dima 已提交
492
	multiCursorMergeOverlapping?: boolean;
493 494 495 496 497
	/**
	 * Configure the editor's accessibility support.
	 * Defaults to 'auto'. It is best to leave this to 'auto'.
	 */
	accessibilitySupport?: 'auto' | 'off' | 'on';
498 499 500 501
	/**
	 * Suggest options.
	 */
	suggest?: ISuggestOptions;
502 503 504 505 506 507 508 509 510 511 512
	/**
	 * 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;
	/**
513
	 * Parameter hint options.
514
	 */
515
	parameterHints?: IEditorParameterHintOptions;
516
	/**
517
	 * Options for auto closing brackets.
518
	 * Defaults to language defined behavior.
519
	 */
J
Jackson Kearl 已提交
520
	autoClosingBrackets?: EditorAutoClosingStrategy;
521
	/**
522
	 * Options for auto closing quotes.
523
	 * Defaults to language defined behavior.
J
Jackson Kearl 已提交
524 525 526
	 */
	autoClosingQuotes?: EditorAutoClosingStrategy;
	/**
527 528
	 * Options for auto surrounding.
	 * Defaults to always allowing auto surrounding.
529
	 */
530
	autoSurround?: EditorAutoSurroundStrategy;
531 532 533 534 535
	/**
	 * Enable auto indentation adjustment.
	 * Defaults to false.
	 */
	autoIndent?: boolean;
536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
	/**
	 * 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.
558
	 * Defaults to 'on'.
559
	 */
J
Johannes Rieken 已提交
560
	acceptSuggestionOnEnter?: boolean | 'on' | 'smart' | 'off';
561 562 563 564 565 566 567 568 569 570 571 572 573
	/**
	 * 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;
574
	/**
575
	 * Syntax highlighting is copied.
576
	 */
577
	copyWithSyntaxHighlighting?: boolean;
578 579 580 581
	/**
	 * Enable word based suggestions. Defaults to 'true'
	 */
	wordBasedSuggestions?: boolean;
582 583 584
	/**
	 * The history mode for suggestions.
	 */
M
Martin Aeschlimann 已提交
585
	suggestSelection?: 'first' | 'recentlyUsed' | 'recentlyUsedByPrefix';
586 587 588 589 590 591 592 593 594 595
	/**
	 * 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;
596 597 598
	/**
	 * Enable tab completion.
	 */
599
	tabCompletion?: boolean | 'on' | 'off' | 'onlySnippets';
600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
	/**
	 * 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;
615 616 617 618
	/**
	 * Control the behavior and rendering of the code action lightbulb.
	 */
	lightbulb?: IEditorLightbulbOptions;
619 620 621 622 623 624 625 626
	/**
	 * Code action kinds to be run on save.
	 */
	codeActionsOnSave?: ICodeActionsOnSaveOptions;
	/**
	 * Timeout for running code actions on save.
	 */
	codeActionsOnSaveTimeout?: number;
627 628
	/**
	 * Enable code folding
A
Alex Dima 已提交
629
	 * Defaults to true.
630 631
	 */
	folding?: boolean;
632 633 634 635 636
	/**
	 * 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';
637
	/**
638 639
	 * Controls whether the fold actions in the gutter stay always visible or hide unless the mouse is over the gutter.
	 * Defaults to 'mouseover'.
640
	 */
641
	showFoldingControls?: 'always' | 'mouseover';
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
	/**
	 * 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.
659
	 * Defaults to true.
660 661
	 */
	renderIndentGuides?: boolean;
662
	/**
C
typo  
Coenraad Stijne 已提交
663
	 * Enable highlighting of the active indent guide.
664 665 666
	 * Defaults to true.
	 */
	highlightActiveIndentGuide?: boolean;
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
	/**
	 * 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;
692 693 694 695
	/**
	 * The letter spacing
	 */
	letterSpacing?: number;
696 697 698 699
	/**
	 * Controls fading out of unused variables.
	 */
	showUnused?: boolean;
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
}

/**
 * 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;
}

733
export const enum RenderMinimap {
734 735 736 737 738 739 740 741 742 743
	None = 0,
	Small = 1,
	Large = 2,
	SmallBlocks = 3,
	LargeBlocks = 4,
}

/**
 * Describes how to indent wrapped lines.
 */
744
export const enum WrappingIndent {
745 746 747 748 749 750 751 752 753
	/**
	 * No indentation => wrapped lines begin at column 1.
	 */
	None = 0,
	/**
	 * Same => wrapped lines get the same indentation as the parent.
	 */
	Same = 1,
	/**
754
	 * Indent => wrapped lines get +1 indentation toward the parent.
755
	 */
756 757 758
	Indent = 2,
	/**
	 * DeepIndent => wrapped lines get +2 indentation toward the parent.
759
	 */
760
	DeepIndent = 3
761 762 763 764 765
}

/**
 * The kind of animation in which the editor's cursor should be rendered.
 */
766
export const enum TextEditorCursorBlinkingStyle {
767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
	/**
	 * 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
}
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
/**
 * @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');
	}
}
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 850 851 852 853 854 855 856 857 858 859 860 861

/**
 * 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 已提交
862
function _cursorStyleFromString(cursorStyle: string | undefined, defaultValue: TextEditorCursorStyle): TextEditorCursorStyle {
A
Alex Dima 已提交
863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881
	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 已提交
882
export interface InternalEditorScrollbarOptions {
883 884 885 886 887 888 889 890 891 892 893 894
	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 已提交
895
	readonly fastScrollSensitivity: number;
896 897
}

A
Alex Dima 已提交
898
export interface InternalEditorMinimapOptions {
899
	readonly enabled: boolean;
900
	readonly side: 'right' | 'left';
901
	readonly showSlider: 'always' | 'mouseover';
902 903 904 905
	readonly renderCharacters: boolean;
	readonly maxColumn: number;
}

906 907
export interface InternalEditorFindOptions {
	readonly seedSearchStringFromSelection: boolean;
R
rebornix 已提交
908
	readonly autoFindInSelection: boolean;
909
	readonly addExtraSpaceOnTop: boolean;
910 911 912 913
	/**
	 * @internal
	 */
	readonly globalFindClipboard: boolean;
914 915
}

A
Alex Dima 已提交
916 917
export interface InternalEditorHoverOptions {
	readonly enabled: boolean;
918
	readonly delay: number;
919
	readonly sticky: boolean;
A
Alex Dima 已提交
920 921
}

922 923
export interface InternalSuggestOptions {
	readonly filterGraceful: boolean;
924
	readonly snippets: 'top' | 'bottom' | 'inline' | 'none';
925
	readonly snippetsPreventQuickSuggestions: boolean;
J
Johannes Rieken 已提交
926
	readonly localityBonus: boolean;
J
Johannes Rieken 已提交
927
	readonly shareSuggestSelections: boolean;
928
	readonly showIcons: boolean;
929
	readonly maxVisibileSuggestions: number;
930 931
}

932 933 934 935 936
export interface InternalParameterHintOptions {
	readonly enabled: boolean;
	readonly cycle: boolean;
}

A
Alex Dima 已提交
937
export interface EditorWrappingInfo {
938 939 940 941 942 943 944 945 946 947 948
	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;
}

949 950 951 952
export const enum RenderLineNumbersType {
	Off = 0,
	On = 1,
	Relative = 2,
953 954
	Interval = 3,
	Custom = 4
955 956
}

A
Alex Dima 已提交
957
export interface InternalEditorViewOptions {
958
	readonly extraEditorClassName: string;
959 960 961
	readonly disableMonospaceOptimizations: boolean;
	readonly rulers: number[];
	readonly ariaLabel: string;
962
	readonly renderLineNumbers: RenderLineNumbersType;
A
Alex Dima 已提交
963
	readonly renderCustomLineNumbers: ((lineNumber: number) => string) | null;
A
Alex Dima 已提交
964
	readonly renderFinalNewline: boolean;
965 966 967 968 969 970 971 972
	readonly selectOnLineNumbers: boolean;
	readonly glyphMargin: boolean;
	readonly revealHorizontalRightPadding: number;
	readonly roundedSelection: boolean;
	readonly overviewRulerLanes: number;
	readonly overviewRulerBorder: boolean;
	readonly cursorBlinking: TextEditorCursorBlinkingStyle;
	readonly mouseWheelZoom: boolean;
973
	readonly cursorSmoothCaretAnimation: boolean;
974
	readonly cursorStyle: TextEditorCursorStyle;
975
	readonly cursorWidth: number;
976 977
	readonly hideCursorInOverviewRuler: boolean;
	readonly scrollBeyondLastLine: boolean;
978
	readonly scrollBeyondLastColumn: number;
979
	readonly smoothScrolling: boolean;
980 981 982 983 984
	readonly stopRenderingLineAfter: number;
	readonly renderWhitespace: 'none' | 'boundary' | 'all';
	readonly renderControlCharacters: boolean;
	readonly fontLigatures: boolean;
	readonly renderIndentGuides: boolean;
985
	readonly highlightActiveIndentGuide: boolean;
986 987 988 989 990 991
	readonly renderLineHighlight: 'none' | 'gutter' | 'line' | 'all';
	readonly scrollbar: InternalEditorScrollbarOptions;
	readonly minimap: InternalEditorMinimapOptions;
	readonly fixedOverflowWidgets: boolean;
}

A
Alex Dima 已提交
992
export interface EditorContribOptions {
993
	readonly selectionClipboard: boolean;
A
Alex Dima 已提交
994
	readonly hover: InternalEditorHoverOptions;
995
	readonly links: boolean;
996 997 998
	readonly contextmenu: boolean;
	readonly quickSuggestions: boolean | { other: boolean, comments: boolean, strings: boolean };
	readonly quickSuggestionsDelay: number;
999
	readonly parameterHints: InternalParameterHintOptions;
1000 1001 1002
	readonly formatOnType: boolean;
	readonly formatOnPaste: boolean;
	readonly suggestOnTriggerCharacters: boolean;
1003
	readonly acceptSuggestionOnEnter: 'on' | 'smart' | 'off';
1004 1005
	readonly acceptSuggestionOnCommitCharacter: boolean;
	readonly wordBasedSuggestions: boolean;
B
Benas Svipas 已提交
1006
	readonly suggestSelection: 'first' | 'recentlyUsed' | 'recentlyUsedByPrefix';
1007 1008
	readonly suggestFontSize: number;
	readonly suggestLineHeight: number;
1009
	readonly tabCompletion: 'on' | 'off' | 'onlySnippets';
1010
	readonly suggest: InternalSuggestOptions;
1011 1012 1013 1014
	readonly selectionHighlight: boolean;
	readonly occurrencesHighlight: boolean;
	readonly codeLens: boolean;
	readonly folding: boolean;
1015
	readonly foldingStrategy: 'auto' | 'indentation';
1016
	readonly showFoldingControls: 'always' | 'mouseover';
1017
	readonly matchBrackets: boolean;
1018
	readonly find: InternalEditorFindOptions;
R
rebornix 已提交
1019
	readonly colorDecorators: boolean;
1020
	readonly lightbulbEnabled: boolean;
1021 1022
	readonly codeActionsOnSave: ICodeActionsOnSaveOptions;
	readonly codeActionsOnSaveTimeout: number;
1023 1024
}

1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
/**
 * 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';
1037
	readonly disableLayerHinting: boolean;
1038 1039 1040 1041 1042 1043 1044 1045
	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 已提交
1046 1047
	readonly autoClosingBrackets: EditorAutoClosingStrategy;
	readonly autoClosingQuotes: EditorAutoClosingStrategy;
1048
	readonly autoSurround: EditorAutoSurroundStrategy;
1049
	readonly autoIndent: boolean;
1050 1051
	readonly dragAndDrop: boolean;
	readonly emptySelectionClipboard: boolean;
1052
	readonly copyWithSyntaxHighlighting: boolean;
1053
	readonly useTabStops: boolean;
1054
	readonly multiCursorModifier: 'altKey' | 'ctrlKey' | 'metaKey';
A
Alex Dima 已提交
1055
	readonly multiCursorMergeOverlapping: boolean;
1056
	readonly accessibilitySupport: 'auto' | 'off' | 'on';
1057
	readonly showUnused: boolean;
1058 1059 1060 1061 1062

	readonly viewInfo: InternalEditorViewOptions;
	readonly contribInfo: EditorContribOptions;
}

1063 1064 1065 1066 1067 1068
/**
 * Internal configuration options (transformed or computed) for the editor.
 */
export class InternalEditorOptions {
	readonly _internalEditorOptionsBrand: void;

1069
	readonly canUseLayerHinting: boolean;
1070
	readonly pixelRatio: number;
A
Alex Dima 已提交
1071
	readonly editorClassName: string;
A
Alex Dima 已提交
1072
	readonly lineHeight: number;
1073
	readonly readOnly: boolean;
1074 1075 1076
	/**
	 * @internal
	 */
1077
	readonly accessibilitySupport: AccessibilitySupport;
1078
	readonly multiCursorModifier: 'altKey' | 'ctrlKey' | 'metaKey';
A
Alex Dima 已提交
1079
	readonly multiCursorMergeOverlapping: boolean;
1080
	readonly showUnused: boolean;
A
Alex Dima 已提交
1081

1082 1083
	// ---- cursor options
	readonly wordSeparators: string;
J
Jackson Kearl 已提交
1084 1085
	readonly autoClosingBrackets: EditorAutoClosingStrategy;
	readonly autoClosingQuotes: EditorAutoClosingStrategy;
1086
	readonly autoSurround: EditorAutoSurroundStrategy;
1087
	readonly autoIndent: boolean;
1088 1089 1090
	readonly useTabStops: boolean;
	readonly tabFocusMode: boolean;
	readonly dragAndDrop: boolean;
1091
	readonly emptySelectionClipboard: boolean;
1092
	readonly copyWithSyntaxHighlighting: boolean;
A
Alex Dima 已提交
1093

1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104
	// ---- grouped options
	readonly layoutInfo: EditorLayoutInfo;
	readonly fontInfo: FontInfo;
	readonly viewInfo: InternalEditorViewOptions;
	readonly wrappingInfo: EditorWrappingInfo;
	readonly contribInfo: EditorContribOptions;

	/**
	 * @internal
	 */
	constructor(source: {
1105
		canUseLayerHinting: boolean;
1106
		pixelRatio: number;
A
Alex Dima 已提交
1107
		editorClassName: string;
1108 1109
		lineHeight: number;
		readOnly: boolean;
1110
		accessibilitySupport: AccessibilitySupport;
1111
		multiCursorModifier: 'altKey' | 'ctrlKey' | 'metaKey';
A
Alex Dima 已提交
1112
		multiCursorMergeOverlapping: boolean;
1113
		wordSeparators: string;
J
Jackson Kearl 已提交
1114 1115
		autoClosingBrackets: EditorAutoClosingStrategy;
		autoClosingQuotes: EditorAutoClosingStrategy;
1116
		autoSurround: EditorAutoSurroundStrategy;
1117
		autoIndent: boolean;
1118 1119 1120
		useTabStops: boolean;
		tabFocusMode: boolean;
		dragAndDrop: boolean;
1121
		emptySelectionClipboard: boolean;
1122
		copyWithSyntaxHighlighting: boolean;
1123 1124 1125 1126 1127
		layoutInfo: EditorLayoutInfo;
		fontInfo: FontInfo;
		viewInfo: InternalEditorViewOptions;
		wrappingInfo: EditorWrappingInfo;
		contribInfo: EditorContribOptions;
1128
		showUnused: boolean;
1129
	}) {
1130
		this.canUseLayerHinting = source.canUseLayerHinting;
1131 1132
		this.pixelRatio = source.pixelRatio;
		this.editorClassName = source.editorClassName;
1133
		this.lineHeight = source.lineHeight | 0;
1134
		this.readOnly = source.readOnly;
1135
		this.accessibilitySupport = source.accessibilitySupport;
1136
		this.multiCursorModifier = source.multiCursorModifier;
A
Alex Dima 已提交
1137
		this.multiCursorMergeOverlapping = source.multiCursorMergeOverlapping;
1138 1139
		this.wordSeparators = source.wordSeparators;
		this.autoClosingBrackets = source.autoClosingBrackets;
J
Jackson Kearl 已提交
1140
		this.autoClosingQuotes = source.autoClosingQuotes;
1141
		this.autoSurround = source.autoSurround;
1142
		this.autoIndent = source.autoIndent;
1143 1144 1145
		this.useTabStops = source.useTabStops;
		this.tabFocusMode = source.tabFocusMode;
		this.dragAndDrop = source.dragAndDrop;
1146
		this.emptySelectionClipboard = source.emptySelectionClipboard;
1147
		this.copyWithSyntaxHighlighting = source.copyWithSyntaxHighlighting;
1148 1149 1150 1151 1152
		this.layoutInfo = source.layoutInfo;
		this.fontInfo = source.fontInfo;
		this.viewInfo = source.viewInfo;
		this.wrappingInfo = source.wrappingInfo;
		this.contribInfo = source.contribInfo;
1153
		this.showUnused = source.showUnused;
1154 1155 1156 1157 1158 1159 1160
	}

	/**
	 * @internal
	 */
	public equals(other: InternalEditorOptions): boolean {
		return (
1161
			this.canUseLayerHinting === other.canUseLayerHinting
1162
			&& this.pixelRatio === other.pixelRatio
A
Alex Dima 已提交
1163 1164
			&& this.editorClassName === other.editorClassName
			&& this.lineHeight === other.lineHeight
1165
			&& this.readOnly === other.readOnly
1166
			&& this.accessibilitySupport === other.accessibilitySupport
1167
			&& this.multiCursorModifier === other.multiCursorModifier
A
Alex Dima 已提交
1168
			&& this.multiCursorMergeOverlapping === other.multiCursorMergeOverlapping
1169 1170
			&& this.wordSeparators === other.wordSeparators
			&& this.autoClosingBrackets === other.autoClosingBrackets
J
Jackson Kearl 已提交
1171
			&& this.autoClosingQuotes === other.autoClosingQuotes
1172
			&& this.autoSurround === other.autoSurround
1173
			&& this.autoIndent === other.autoIndent
1174 1175 1176
			&& this.useTabStops === other.useTabStops
			&& this.tabFocusMode === other.tabFocusMode
			&& this.dragAndDrop === other.dragAndDrop
1177
			&& this.showUnused === other.showUnused
1178
			&& this.emptySelectionClipboard === other.emptySelectionClipboard
1179
			&& this.copyWithSyntaxHighlighting === other.copyWithSyntaxHighlighting
A
Alex Dima 已提交
1180
			&& InternalEditorOptions._equalsLayoutInfo(this.layoutInfo, other.layoutInfo)
1181
			&& this.fontInfo.equals(other.fontInfo)
A
Alex Dima 已提交
1182 1183 1184
			&& InternalEditorOptions._equalsViewOptions(this.viewInfo, other.viewInfo)
			&& InternalEditorOptions._equalsWrappingInfo(this.wrappingInfo, other.wrappingInfo)
			&& InternalEditorOptions._equalsContribOptions(this.contribInfo, other.contribInfo)
1185 1186 1187 1188 1189 1190 1191 1192
		);
	}

	/**
	 * @internal
	 */
	public createChangeEvent(newOpts: InternalEditorOptions): IConfigurationChangedEvent {
		return {
1193
			canUseLayerHinting: (this.canUseLayerHinting !== newOpts.canUseLayerHinting),
1194
			pixelRatio: (this.pixelRatio !== newOpts.pixelRatio),
A
Alex Dima 已提交
1195
			editorClassName: (this.editorClassName !== newOpts.editorClassName),
1196 1197
			lineHeight: (this.lineHeight !== newOpts.lineHeight),
			readOnly: (this.readOnly !== newOpts.readOnly),
1198
			accessibilitySupport: (this.accessibilitySupport !== newOpts.accessibilitySupport),
1199
			multiCursorModifier: (this.multiCursorModifier !== newOpts.multiCursorModifier),
A
Alex Dima 已提交
1200
			multiCursorMergeOverlapping: (this.multiCursorMergeOverlapping !== newOpts.multiCursorMergeOverlapping),
1201 1202
			wordSeparators: (this.wordSeparators !== newOpts.wordSeparators),
			autoClosingBrackets: (this.autoClosingBrackets !== newOpts.autoClosingBrackets),
J
Jackson Kearl 已提交
1203
			autoClosingQuotes: (this.autoClosingQuotes !== newOpts.autoClosingQuotes),
1204
			autoSurround: (this.autoSurround !== newOpts.autoSurround),
1205
			autoIndent: (this.autoIndent !== newOpts.autoIndent),
1206 1207 1208
			useTabStops: (this.useTabStops !== newOpts.useTabStops),
			tabFocusMode: (this.tabFocusMode !== newOpts.tabFocusMode),
			dragAndDrop: (this.dragAndDrop !== newOpts.dragAndDrop),
1209
			emptySelectionClipboard: (this.emptySelectionClipboard !== newOpts.emptySelectionClipboard),
1210
			copyWithSyntaxHighlighting: (this.copyWithSyntaxHighlighting !== newOpts.copyWithSyntaxHighlighting),
A
Alex Dima 已提交
1211
			layoutInfo: (!InternalEditorOptions._equalsLayoutInfo(this.layoutInfo, newOpts.layoutInfo)),
1212
			fontInfo: (!this.fontInfo.equals(newOpts.fontInfo)),
A
Alex Dima 已提交
1213 1214
			viewInfo: (!InternalEditorOptions._equalsViewOptions(this.viewInfo, newOpts.viewInfo)),
			wrappingInfo: (!InternalEditorOptions._equalsWrappingInfo(this.wrappingInfo, newOpts.wrappingInfo)),
1215
			contribInfo: (!InternalEditorOptions._equalsContribOptions(this.contribInfo, newOpts.contribInfo))
1216 1217 1218
		};
	}

A
Alex Dima 已提交
1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238
	/**
	 * @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
1239
			&& a.minimapLeft === b.minimapLeft
A
Alex Dima 已提交
1240 1241 1242 1243 1244 1245 1246
			&& a.minimapWidth === b.minimapWidth
			&& a.viewportColumn === b.viewportColumn
			&& a.verticalScrollbarWidth === b.verticalScrollbarWidth
			&& a.horizontalScrollbarHeight === b.horizontalScrollbarHeight
			&& this._equalsOverviewRuler(a.overviewRuler, b.overviewRuler)
		);
	}
1247 1248

	/**
A
Alex Dima 已提交
1249
	 * @internal
1250
	 */
A
Alex Dima 已提交
1251 1252 1253 1254 1255 1256 1257 1258 1259
	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
		);
	}

1260
	/**
A
Alex Dima 已提交
1261
	 * @internal
1262
	 */
A
Alex Dima 已提交
1263 1264
	private static _equalsViewOptions(a: InternalEditorViewOptions, b: InternalEditorViewOptions): boolean {
		return (
1265
			a.extraEditorClassName === b.extraEditorClassName
A
Alex Dima 已提交
1266
			&& a.disableMonospaceOptimizations === b.disableMonospaceOptimizations
1267
			&& arrays.equals(a.rulers, b.rulers)
A
Alex Dima 已提交
1268 1269 1270
			&& a.ariaLabel === b.ariaLabel
			&& a.renderLineNumbers === b.renderLineNumbers
			&& a.renderCustomLineNumbers === b.renderCustomLineNumbers
A
Alex Dima 已提交
1271
			&& a.renderFinalNewline === b.renderFinalNewline
A
Alex Dima 已提交
1272 1273 1274 1275 1276 1277 1278 1279
			&& 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
1280
			&& a.cursorSmoothCaretAnimation === b.cursorSmoothCaretAnimation
A
Alex Dima 已提交
1281
			&& a.cursorStyle === b.cursorStyle
1282
			&& a.cursorWidth === b.cursorWidth
A
Alex Dima 已提交
1283 1284
			&& a.hideCursorInOverviewRuler === b.hideCursorInOverviewRuler
			&& a.scrollBeyondLastLine === b.scrollBeyondLastLine
1285
			&& a.scrollBeyondLastColumn === b.scrollBeyondLastColumn
1286
			&& a.smoothScrolling === b.smoothScrolling
A
Alex Dima 已提交
1287 1288 1289 1290 1291
			&& a.stopRenderingLineAfter === b.stopRenderingLineAfter
			&& a.renderWhitespace === b.renderWhitespace
			&& a.renderControlCharacters === b.renderControlCharacters
			&& a.fontLigatures === b.fontLigatures
			&& a.renderIndentGuides === b.renderIndentGuides
A
Alex Dima 已提交
1292
			&& a.highlightActiveIndentGuide === b.highlightActiveIndentGuide
A
Alex Dima 已提交
1293 1294 1295 1296 1297 1298 1299
			&& a.renderLineHighlight === b.renderLineHighlight
			&& this._equalsScrollbarOptions(a.scrollbar, b.scrollbar)
			&& this._equalsMinimapOptions(a.minimap, b.minimap)
			&& a.fixedOverflowWidgets === b.fixedOverflowWidgets
		);
	}

1300
	/**
A
Alex Dima 已提交
1301
	 * @internal
1302
	 */
A
Alex Dima 已提交
1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316
	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 已提交
1317
			&& a.fastScrollSensitivity === b.fastScrollSensitivity
A
Alex Dima 已提交
1318 1319 1320
		);
	}

1321
	/**
A
Alex Dima 已提交
1322
	 * @internal
1323
	 */
A
Alex Dima 已提交
1324 1325 1326
	private static _equalsMinimapOptions(a: InternalEditorMinimapOptions, b: InternalEditorMinimapOptions): boolean {
		return (
			a.enabled === b.enabled
1327
			&& a.side === b.side
1328
			&& a.showSlider === b.showSlider
A
Alex Dima 已提交
1329 1330 1331 1332 1333
			&& a.renderCharacters === b.renderCharacters
			&& a.maxColumn === b.maxColumn
		);
	}

1334 1335 1336 1337 1338 1339
	/**
	 * @internal
	 */
	private static _equalFindOptions(a: InternalEditorFindOptions, b: InternalEditorFindOptions): boolean {
		return (
			a.seedSearchStringFromSelection === b.seedSearchStringFromSelection
R
rebornix 已提交
1340
			&& a.autoFindInSelection === b.autoFindInSelection
1341
			&& a.globalFindClipboard === b.globalFindClipboard
1342
			&& a.addExtraSpaceOnTop === b.addExtraSpaceOnTop
1343 1344 1345
		);
	}

1346 1347 1348 1349 1350 1351 1352 1353 1354 1355
	/**
	 * @internal
	 */
	private static _equalsParameterHintOptions(a: InternalParameterHintOptions, b: InternalParameterHintOptions): boolean {
		return (
			a.enabled === b.enabled
			&& a.cycle === b.cycle
		);
	}

A
Alex Dima 已提交
1356 1357 1358 1359 1360 1361
	/**
	 * @internal
	 */
	private static _equalsHoverOptions(a: InternalEditorHoverOptions, b: InternalEditorHoverOptions): boolean {
		return (
			a.enabled === b.enabled
1362
			&& a.delay === b.delay
1363
			&& a.sticky === b.sticky
A
Alex Dima 已提交
1364 1365 1366
		);
	}

1367 1368 1369
	/**
	 * @internal
	 */
1370
	private static _equalsSuggestOptions(a: InternalSuggestOptions, b: InternalSuggestOptions): any {
1371 1372 1373 1374 1375
		if (a === b) {
			return true;
		} else if (!a || !b) {
			return false;
		} else {
1376 1377
			return a.filterGraceful === b.filterGraceful
				&& a.snippets === b.snippets
J
Johannes Rieken 已提交
1378
				&& a.snippetsPreventQuickSuggestions === b.snippetsPreventQuickSuggestions
1379
				&& a.localityBonus === b.localityBonus
1380 1381
				&& a.shareSuggestSelections === b.shareSuggestSelections
				&& a.showIcons === b.showIcons
1382
				&& a.maxVisibileSuggestions === b.maxVisibileSuggestions;
1383 1384 1385
		}
	}

1386 1387 1388
	/**
	 * @internal
	 */
A
Alex Dima 已提交
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400
	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
		);
1401 1402 1403 1404 1405
	}

	/**
	 * @internal
	 */
A
Alex Dima 已提交
1406 1407 1408
	private static _equalsContribOptions(a: EditorContribOptions, b: EditorContribOptions): boolean {
		return (
			a.selectionClipboard === b.selectionClipboard
A
Alex Dima 已提交
1409
			&& this._equalsHoverOptions(a.hover, b.hover)
1410
			&& a.links === b.links
A
Alex Dima 已提交
1411 1412 1413
			&& a.contextmenu === b.contextmenu
			&& InternalEditorOptions._equalsQuickSuggestions(a.quickSuggestions, b.quickSuggestions)
			&& a.quickSuggestionsDelay === b.quickSuggestionsDelay
1414
			&& this._equalsParameterHintOptions(a.parameterHints, b.parameterHints)
A
Alex Dima 已提交
1415 1416 1417 1418 1419 1420
			&& 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 已提交
1421
			&& a.suggestSelection === b.suggestSelection
A
Alex Dima 已提交
1422 1423
			&& a.suggestFontSize === b.suggestFontSize
			&& a.suggestLineHeight === b.suggestLineHeight
1424
			&& a.tabCompletion === b.tabCompletion
1425
			&& this._equalsSuggestOptions(a.suggest, b.suggest)
A
Alex Dima 已提交
1426 1427 1428 1429
			&& a.selectionHighlight === b.selectionHighlight
			&& a.occurrencesHighlight === b.occurrencesHighlight
			&& a.codeLens === b.codeLens
			&& a.folding === b.folding
1430
			&& a.foldingStrategy === b.foldingStrategy
1431
			&& a.showFoldingControls === b.showFoldingControls
A
Alex Dima 已提交
1432
			&& a.matchBrackets === b.matchBrackets
1433
			&& this._equalFindOptions(a.find, b.find)
R
rebornix 已提交
1434
			&& a.colorDecorators === b.colorDecorators
1435 1436
			&& objects.equals(a.codeActionsOnSave, b.codeActionsOnSave)
			&& a.codeActionsOnSaveTimeout === b.codeActionsOnSaveTimeout
1437
			&& a.lightbulbEnabled === b.lightbulbEnabled
A
Alex Dima 已提交
1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450
		);
	}

	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;
		}
1451
		return (
A
Alex Dima 已提交
1452 1453 1454
			a.comments === b.comments
			&& a.other === b.other
			&& a.strings === b.strings
1455 1456 1457 1458
		);
	}
}

A
Alex Dima 已提交
1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480
/**
 * 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;
}

1481 1482 1483
/**
 * The internal layout details of the editor.
 */
A
Alex Dima 已提交
1484
export interface EditorLayoutInfo {
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 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546

	/**
	 * 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;

1547 1548 1549 1550
	/**
	 * The position for the minimap
	 */
	readonly minimapLeft: number;
1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584
	/**
	 * 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 {
1585
	readonly canUseLayerHinting: boolean;
1586
	readonly pixelRatio: boolean;
A
Alex Dima 已提交
1587
	readonly editorClassName: boolean;
1588 1589
	readonly lineHeight: boolean;
	readonly readOnly: boolean;
1590
	readonly accessibilitySupport: boolean;
1591
	readonly multiCursorModifier: boolean;
A
Alex Dima 已提交
1592
	readonly multiCursorMergeOverlapping: boolean;
1593 1594
	readonly wordSeparators: boolean;
	readonly autoClosingBrackets: boolean;
J
Jackson Kearl 已提交
1595
	readonly autoClosingQuotes: boolean;
1596
	readonly autoSurround: boolean;
1597
	readonly autoIndent: boolean;
1598 1599 1600
	readonly useTabStops: boolean;
	readonly tabFocusMode: boolean;
	readonly dragAndDrop: boolean;
1601
	readonly emptySelectionClipboard: boolean;
1602
	readonly copyWithSyntaxHighlighting: boolean;
1603 1604
	readonly layoutInfo: boolean;
	readonly fontInfo: boolean;
A
Alex Dima 已提交
1605
	readonly viewInfo: boolean;
1606 1607 1608
	readonly wrappingInfo: boolean;
	readonly contribInfo: boolean;
}
1609 1610 1611 1612

/**
 * @internal
 */
A
Alex Dima 已提交
1613 1614 1615 1616
export interface IEnvironmentalOptions {
	readonly outerWidth: number;
	readonly outerHeight: number;
	readonly fontInfo: FontInfo;
1617
	readonly extraEditorClassName: string;
A
Alex Dima 已提交
1618 1619
	readonly isDominatedByLongLines: boolean;
	readonly lineNumbersDigitCount: number;
1620
	readonly emptySelectionClipboard: boolean;
A
Alex Dima 已提交
1621 1622
	readonly pixelRatio: number;
	readonly tabFocusMode: boolean;
1623
	readonly accessibilitySupport: AccessibilitySupport;
1624
}
1625

1626 1627 1628 1629 1630 1631 1632 1633 1634 1635
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);
}
1636

A
Alex Dima 已提交
1637
function _booleanMap(value: { [key: string]: boolean } | undefined, defaultValue: { [key: string]: boolean }): { [key: string]: boolean } {
1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651
	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;
}

1652 1653 1654 1655 1656 1657
function _string(value: any, defaultValue: string): string {
	if (typeof value !== 'string') {
		return defaultValue;
	}
	return value;
}
1658

A
Alex Dima 已提交
1659
function _stringSet<T>(value: T | undefined, defaultValue: T, allowedValues: T[]): T {
1660 1661 1662 1663 1664 1665
	if (typeof value !== 'string') {
		return defaultValue;
	}
	if (allowedValues.indexOf(value) === -1) {
		return defaultValue;
	}
M
Martin Aeschlimann 已提交
1666
	return value;
1667 1668 1669 1670 1671 1672 1673 1674 1675 1676
}

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;
1677
		}
1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691
	}
	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 已提交
1692
function _wrappingIndentFromString(wrappingIndent: string | undefined, defaultValue: WrappingIndent): WrappingIndent {
1693 1694 1695
	if (typeof wrappingIndent !== 'string') {
		return defaultValue;
	}
1696
	if (wrappingIndent === 'same') {
1697
		return WrappingIndent.Same;
1698 1699 1700 1701
	} else if (wrappingIndent === 'indent') {
		return WrappingIndent.Indent;
	} else if (wrappingIndent === 'deepIndent') {
		return WrappingIndent.DeepIndent;
1702 1703 1704 1705 1706
	} else {
		return WrappingIndent.None;
	}
}

A
Alex Dima 已提交
1707
function _cursorBlinkingStyleFromString(cursorBlinkingStyle: string | undefined, defaultValue: TextEditorCursorBlinkingStyle): TextEditorCursorBlinkingStyle {
1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726
	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 已提交
1727
function _scrollbarVisibilityFromString(visibility: string | undefined, defaultValue: ScrollbarVisibility): ScrollbarVisibility {
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750
	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 已提交
1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763
		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);
1764
		const contribInfo = this._sanitizeContribInfo(opts, defaults.contribInfo);
A
Alex Dima 已提交
1765

A
Alex Dima 已提交
1766
		let configuredMulticursorModifier: 'altKey' | 'metaKey' | 'ctrlKey' | undefined = undefined;
1767
		if (typeof opts.multiCursorModifier === 'string') {
1768 1769
			if (opts.multiCursorModifier === 'ctrlCmd') {
				configuredMulticursorModifier = platform.isMacintosh ? 'metaKey' : 'ctrlKey';
1770
			} else {
1771
				configuredMulticursorModifier = 'altKey';
1772 1773
			}
		}
1774
		const multiCursorModifier = _stringSet<'altKey' | 'metaKey' | 'ctrlKey'>(configuredMulticursorModifier, defaults.multiCursorModifier, ['altKey', 'metaKey', 'ctrlKey']);
1775

1776 1777
		let autoClosingBrackets: EditorAutoClosingStrategy;
		let autoClosingQuotes: EditorAutoClosingStrategy;
1778
		let autoSurround: EditorAutoSurroundStrategy;
A
Alex Dima 已提交
1779
		if (typeof opts.autoClosingBrackets === 'boolean' && opts.autoClosingBrackets === false) {
1780 1781 1782
			// backwards compatibility: disable all on boolean false
			autoClosingBrackets = 'never';
			autoClosingQuotes = 'never';
1783
			autoSurround = 'never';
1784 1785 1786
		} 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 已提交
1787
			autoSurround = _stringSet<EditorAutoSurroundStrategy>(opts.autoSurround, defaults.autoSurround, ['languageDefined', 'brackets', 'quotes', 'never']);
J
Jackson Kearl 已提交
1788 1789
		}

A
Alex Dima 已提交
1790 1791 1792 1793 1794 1795 1796
		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']),
1797
			disableLayerHinting: _boolean(opts.disableLayerHinting, defaults.disableLayerHinting),
A
Alex Dima 已提交
1798 1799 1800 1801 1802 1803 1804 1805
			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),
1806 1807
			autoClosingBrackets,
			autoClosingQuotes,
1808
			autoSurround,
1809
			autoIndent: _boolean(opts.autoIndent, defaults.autoIndent),
A
Alex Dima 已提交
1810
			dragAndDrop: _boolean(opts.dragAndDrop, defaults.dragAndDrop),
1811
			emptySelectionClipboard: _boolean(opts.emptySelectionClipboard, defaults.emptySelectionClipboard),
1812
			copyWithSyntaxHighlighting: _boolean(opts.copyWithSyntaxHighlighting, defaults.copyWithSyntaxHighlighting),
A
Alex Dima 已提交
1813
			useTabStops: _boolean(opts.useTabStops, defaults.useTabStops),
1814
			multiCursorModifier: multiCursorModifier,
A
Alex Dima 已提交
1815
			multiCursorMergeOverlapping: _boolean(opts.multiCursorMergeOverlapping, defaults.multiCursorMergeOverlapping),
1816
			accessibilitySupport: _stringSet<'auto' | 'on' | 'off'>(opts.accessibilitySupport, defaults.accessibilitySupport, ['auto', 'on', 'off']),
1817
			showUnused: _boolean(opts.showUnused, defaults.showUnused),
A
Alex Dima 已提交
1818 1819 1820 1821 1822
			viewInfo: viewInfo,
			contribInfo: contribInfo,
		};
	}

T
Tiago Ribeiro 已提交
1823
	private static _sanitizeScrollbarOpts(opts: IEditorScrollbarOptions | undefined, defaults: InternalEditorScrollbarOptions, mouseWheelScrollSensitivity: number, fastScrollSensitivity: number): InternalEditorScrollbarOptions {
A
Alex Dima 已提交
1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845
		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 已提交
1846 1847
			mouseWheelScrollSensitivity: mouseWheelScrollSensitivity,
			fastScrollSensitivity: fastScrollSensitivity,
A
Alex Dima 已提交
1848 1849 1850
		};
	}

A
Alex Dima 已提交
1851
	private static _sanitizeMinimapOpts(opts: IEditorMinimapOptions | undefined, defaults: InternalEditorMinimapOptions): InternalEditorMinimapOptions {
A
Alex Dima 已提交
1852 1853 1854 1855 1856
		if (typeof opts !== 'object') {
			return defaults;
		}
		return {
			enabled: _boolean(opts.enabled, defaults.enabled),
1857
			side: _stringSet<'right' | 'left'>(opts.side, defaults.side, ['right', 'left']),
1858
			showSlider: _stringSet<'always' | 'mouseover'>(opts.showSlider, defaults.showSlider, ['always', 'mouseover']),
A
Alex Dima 已提交
1859 1860 1861 1862 1863
			renderCharacters: _boolean(opts.renderCharacters, defaults.renderCharacters),
			maxColumn: _clampedInt(opts.maxColumn, defaults.maxColumn, 1, 10000),
		};
	}

B
bissonex 已提交
1864
	private static _sanitizeFindOpts(opts: IEditorFindOptions | undefined, defaults: InternalEditorFindOptions): InternalEditorFindOptions {
1865 1866 1867 1868 1869
		if (typeof opts !== 'object') {
			return defaults;
		}

		return {
R
rebornix 已提交
1870
			seedSearchStringFromSelection: _boolean(opts.seedSearchStringFromSelection, defaults.seedSearchStringFromSelection),
1871
			autoFindInSelection: _boolean(opts.autoFindInSelection, defaults.autoFindInSelection),
1872 1873
			globalFindClipboard: _boolean(opts.globalFindClipboard, defaults.globalFindClipboard),
			addExtraSpaceOnTop: _boolean(opts.addExtraSpaceOnTop, defaults.addExtraSpaceOnTop)
1874 1875 1876
		};
	}

A
Alex Dima 已提交
1877
	private static _sanitizeParameterHintOpts(opts: IEditorParameterHintOptions | undefined, defaults: InternalParameterHintOptions): InternalParameterHintOptions {
1878 1879 1880 1881 1882 1883 1884 1885 1886 1887
		if (typeof opts !== 'object') {
			return defaults;
		}

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

B
bissonex 已提交
1888
	private static _sanitizeHoverOpts(_opts: boolean | IEditorHoverOptions | undefined, defaults: InternalEditorHoverOptions): InternalEditorHoverOptions {
A
Alex Dima 已提交
1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900
		let opts: IEditorHoverOptions;
		if (typeof _opts === 'boolean') {
			opts = {
				enabled: _opts
			};
		} else if (typeof _opts === 'object') {
			opts = _opts;
		} else {
			return defaults;
		}

		return {
1901
			enabled: _boolean(opts.enabled, defaults.enabled),
1902 1903
			delay: _clampedInt(opts.delay, defaults.delay, 0, 10000),
			sticky: _boolean(opts.sticky, defaults.sticky)
A
Alex Dima 已提交
1904 1905 1906
		};
	}

1907
	private static _sanitizeSuggestOpts(opts: IEditorOptions, defaults: InternalSuggestOptions): InternalSuggestOptions {
1908
		const suggestOpts = opts.suggest || {};
1909
		return {
1910
			filterGraceful: _boolean(suggestOpts.filterGraceful, defaults.filterGraceful),
1911
			snippets: _stringSet<'top' | 'bottom' | 'inline' | 'none'>(opts.snippetSuggestions, defaults.snippets, ['top', 'bottom', 'inline', 'none']),
1912
			snippetsPreventQuickSuggestions: _boolean(suggestOpts.snippetsPreventQuickSuggestions, defaults.filterGraceful),
J
Johannes Rieken 已提交
1913
			localityBonus: _boolean(suggestOpts.localityBonus, defaults.localityBonus),
1914 1915
			shareSuggestSelections: _boolean(suggestOpts.shareSuggestSelections, defaults.shareSuggestSelections),
			showIcons: _boolean(suggestOpts.showIcons, defaults.showIcons),
1916
			maxVisibileSuggestions: _clampedInt(suggestOpts.maxSuggestionsToShow, defaults.maxVisibileSuggestions, 1, 12)
1917 1918 1919
		};
	}

A
Alex Dima 已提交
1920
	private static _sanitizeTabCompletionOpts(opts: boolean | 'on' | 'off' | 'onlySnippets' | undefined, defaults: 'on' | 'off' | 'onlySnippets'): 'on' | 'off' | 'onlySnippets' {
1921 1922 1923 1924 1925 1926 1927 1928
		if (opts === false) {
			return 'off';
		} else if (opts === true) {
			return 'onlySnippets';
		} else {
			return _stringSet<'on' | 'off' | 'onlySnippets'>(opts, defaults, ['on', 'off', 'onlySnippets']);
		}
	}
1929

A
Alex Dima 已提交
1930
	private static _sanitizeViewInfo(opts: IEditorOptions, defaults: InternalEditorViewOptions): InternalEditorViewOptions {
1931 1932 1933 1934 1935 1936 1937

		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();
1938 1939
		}

1940
		let renderLineNumbers: RenderLineNumbersType = defaults.renderLineNumbers;
A
Alex Dima 已提交
1941
		let renderCustomLineNumbers: ((lineNumber: number) => string) | null = defaults.renderCustomLineNumbers;
1942 1943

		if (typeof opts.lineNumbers !== 'undefined') {
1944
			let lineNumbers = opts.lineNumbers;
1945

1946 1947 1948 1949 1950 1951 1952 1953
			// Compatibility with old true or false values
			if (<any>lineNumbers === true) {
				lineNumbers = 'on';
			} else if (<any>lineNumbers === false) {
				lineNumbers = 'off';
			}

			if (typeof lineNumbers === 'function') {
1954
				renderLineNumbers = RenderLineNumbersType.Custom;
1955
				renderCustomLineNumbers = lineNumbers;
1956 1957
			} else if (lineNumbers === 'interval') {
				renderLineNumbers = RenderLineNumbersType.Interval;
1958
			} else if (lineNumbers === 'relative') {
1959
				renderLineNumbers = RenderLineNumbersType.Relative;
1960
			} else if (lineNumbers === 'on') {
1961
				renderLineNumbers = RenderLineNumbersType.On;
1962
			} else {
1963
				renderLineNumbers = RenderLineNumbersType.Off;
1964 1965 1966
			}
		}

A
Alex Dima 已提交
1967 1968
		const fontLigatures = _boolean(opts.fontLigatures, defaults.fontLigatures);
		const disableMonospaceOptimizations = _boolean(opts.disableMonospaceOptimizations, defaults.disableMonospaceOptimizations) || fontLigatures;
1969 1970 1971 1972 1973 1974 1975 1976 1977

		let renderWhitespace = opts.renderWhitespace;
		{
			// Compatibility with old true or false values
			if (<any>renderWhitespace === true) {
				renderWhitespace = 'boundary';
			} else if (<any>renderWhitespace === false) {
				renderWhitespace = 'none';
			}
A
Alex Dima 已提交
1978
			renderWhitespace = _stringSet<'none' | 'boundary' | 'all'>(renderWhitespace, defaults.renderWhitespace, ['none', 'boundary', 'all']);
1979 1980 1981 1982 1983 1984 1985 1986 1987 1988
		}

		let renderLineHighlight = opts.renderLineHighlight;
		{
			// Compatibility with old true or false values
			if (<any>renderLineHighlight === true) {
				renderLineHighlight = 'line';
			} else if (<any>renderLineHighlight === false) {
				renderLineHighlight = 'none';
			}
A
Alex Dima 已提交
1989
			renderLineHighlight = _stringSet<'none' | 'gutter' | 'line' | 'all'>(renderLineHighlight, defaults.renderLineHighlight, ['none', 'gutter', 'line', 'all']);
1990 1991
		}

A
Alex Dima 已提交
1992 1993 1994 1995 1996
		let mouseWheelScrollSensitivity = _float(opts.mouseWheelScrollSensitivity, defaults.scrollbar.mouseWheelScrollSensitivity);
		if (mouseWheelScrollSensitivity === 0) {
			// Disallow 0, as it would prevent/block scrolling
			mouseWheelScrollSensitivity = 1;
		}
T
Tiago Ribeiro 已提交
1997 1998 1999

		let fastScrollSensitivity = _float(opts.fastScrollSensitivity, defaults.scrollbar.fastScrollSensitivity);
		if (fastScrollSensitivity <= 0) {
2000
			fastScrollSensitivity = defaults.scrollbar.fastScrollSensitivity;
T
Tiago Ribeiro 已提交
2001 2002
		}
		const scrollbar = this._sanitizeScrollbarOpts(opts.scrollbar, defaults.scrollbar, mouseWheelScrollSensitivity, fastScrollSensitivity);
2003 2004 2005
		const minimap = this._sanitizeMinimapOpts(opts.minimap, defaults.minimap);

		return {
2006
			extraEditorClassName: _string(opts.extraEditorClassName, defaults.extraEditorClassName),
A
Alex Dima 已提交
2007
			disableMonospaceOptimizations: disableMonospaceOptimizations,
2008
			rulers: rulers,
A
Alex Dima 已提交
2009
			ariaLabel: _string(opts.ariaLabel, defaults.ariaLabel),
2010 2011
			renderLineNumbers: renderLineNumbers,
			renderCustomLineNumbers: renderCustomLineNumbers,
A
Alex Dima 已提交
2012
			renderFinalNewline: _boolean(opts.renderFinalNewline, defaults.renderFinalNewline),
2013 2014 2015 2016 2017 2018 2019 2020
			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),
2021
			cursorSmoothCaretAnimation: _boolean(opts.cursorSmoothCaretAnimation, defaults.cursorSmoothCaretAnimation),
2022
			cursorStyle: _cursorStyleFromString(opts.cursorStyle, defaults.cursorStyle),
2023
			cursorWidth: _clampedInt(opts.cursorWidth, defaults.cursorWidth, 0, Number.MAX_VALUE),
2024 2025
			hideCursorInOverviewRuler: _boolean(opts.hideCursorInOverviewRuler, defaults.hideCursorInOverviewRuler),
			scrollBeyondLastLine: _boolean(opts.scrollBeyondLastLine, defaults.scrollBeyondLastLine),
2026
			scrollBeyondLastColumn: _clampedInt(opts.scrollBeyondLastColumn, defaults.scrollBeyondLastColumn, 0, Constants.MAX_SAFE_SMALL_INTEGER),
2027
			smoothScrolling: _boolean(opts.smoothScrolling, defaults.smoothScrolling),
2028
			stopRenderingLineAfter: _clampedInt(opts.stopRenderingLineAfter, defaults.stopRenderingLineAfter, -1, Constants.MAX_SAFE_SMALL_INTEGER),
A
Alex Dima 已提交
2029 2030 2031 2032
			renderWhitespace: renderWhitespace,
			renderControlCharacters: _boolean(opts.renderControlCharacters, defaults.renderControlCharacters),
			fontLigatures: fontLigatures,
			renderIndentGuides: _boolean(opts.renderIndentGuides, defaults.renderIndentGuides),
2033
			highlightActiveIndentGuide: _boolean(opts.highlightActiveIndentGuide, defaults.highlightActiveIndentGuide),
A
Alex Dima 已提交
2034 2035 2036 2037 2038 2039 2040
			renderLineHighlight: renderLineHighlight,
			scrollbar: scrollbar,
			minimap: minimap,
			fixedOverflowWidgets: _boolean(opts.fixedOverflowWidgets, defaults.fixedOverflowWidgets),
		};
	}

2041
	private static _sanitizeContribInfo(opts: IEditorOptions, defaults: EditorContribOptions): EditorContribOptions {
A
Alex Dima 已提交
2042 2043 2044 2045 2046 2047
		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 已提交
2048 2049 2050 2051
		// Compatibility support for acceptSuggestionOnEnter
		if (typeof opts.acceptSuggestionOnEnter === 'boolean') {
			opts.acceptSuggestionOnEnter = opts.acceptSuggestionOnEnter ? 'on' : 'off';
		}
B
bissonex 已提交
2052
		const find = this._sanitizeFindOpts(opts.find, defaults.find);
A
Alex Dima 已提交
2053 2054
		return {
			selectionClipboard: _boolean(opts.selectionClipboard, defaults.selectionClipboard),
B
bissonex 已提交
2055
			hover: this._sanitizeHoverOpts(opts.hover, defaults.hover),
2056
			links: _boolean(opts.links, defaults.links),
2057 2058 2059
			contextmenu: _boolean(opts.contextmenu, defaults.contextmenu),
			quickSuggestions: quickSuggestions,
			quickSuggestionsDelay: _clampedInt(opts.quickSuggestionsDelay, defaults.quickSuggestionsDelay, Constants.MIN_SAFE_SMALL_INTEGER, Constants.MAX_SAFE_SMALL_INTEGER),
2060
			parameterHints: this._sanitizeParameterHintOpts(opts.parameterHints, defaults.parameterHints),
2061 2062 2063
			formatOnType: _boolean(opts.formatOnType, defaults.formatOnType),
			formatOnPaste: _boolean(opts.formatOnPaste, defaults.formatOnPaste),
			suggestOnTriggerCharacters: _boolean(opts.suggestOnTriggerCharacters, defaults.suggestOnTriggerCharacters),
A
Alex Dima 已提交
2064
			acceptSuggestionOnEnter: _stringSet<'on' | 'smart' | 'off'>(opts.acceptSuggestionOnEnter, defaults.acceptSuggestionOnEnter, ['on', 'smart', 'off']),
2065 2066
			acceptSuggestionOnCommitCharacter: _boolean(opts.acceptSuggestionOnCommitCharacter, defaults.acceptSuggestionOnCommitCharacter),
			wordBasedSuggestions: _boolean(opts.wordBasedSuggestions, defaults.wordBasedSuggestions),
B
Benas Svipas 已提交
2067
			suggestSelection: _stringSet<'first' | 'recentlyUsed' | 'recentlyUsedByPrefix'>(opts.suggestSelection, defaults.suggestSelection, ['first', 'recentlyUsed', 'recentlyUsedByPrefix']),
2068 2069
			suggestFontSize: _clampedInt(opts.suggestFontSize, defaults.suggestFontSize, 0, 1000),
			suggestLineHeight: _clampedInt(opts.suggestLineHeight, defaults.suggestLineHeight, 0, 1000),
2070
			tabCompletion: this._sanitizeTabCompletionOpts(opts.tabCompletion, defaults.tabCompletion),
2071
			suggest: this._sanitizeSuggestOpts(opts, defaults.suggest),
2072 2073
			selectionHighlight: _boolean(opts.selectionHighlight, defaults.selectionHighlight),
			occurrencesHighlight: _boolean(opts.occurrencesHighlight, defaults.occurrencesHighlight),
2074
			codeLens: _boolean(opts.codeLens, defaults.codeLens),
2075
			folding: _boolean(opts.folding, defaults.folding),
2076
			foldingStrategy: _stringSet<'auto' | 'indentation'>(opts.foldingStrategy, defaults.foldingStrategy, ['auto', 'indentation']),
2077
			showFoldingControls: _stringSet<'always' | 'mouseover'>(opts.showFoldingControls, defaults.showFoldingControls, ['always', 'mouseover']),
2078
			matchBrackets: _boolean(opts.matchBrackets, defaults.matchBrackets),
2079
			find: find,
R
rebornix 已提交
2080
			colorDecorators: _boolean(opts.colorDecorators, defaults.colorDecorators),
2081 2082 2083
			lightbulbEnabled: _boolean(opts.lightbulb ? opts.lightbulb.enabled : false, defaults.lightbulbEnabled),
			codeActionsOnSave: _booleanMap(opts.codeActionsOnSave, {}),
			codeActionsOnSaveTimeout: _clampedInt(opts.codeActionsOnSaveTimeout, defaults.codeActionsOnSaveTimeout, 1, 10000)
2084 2085 2086 2087 2088 2089 2090 2091 2092
		};
	}
}

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

2093 2094 2095
	private static _tweakValidatedOptions(opts: IValidatedEditorOptions, accessibilitySupport: AccessibilitySupport): IValidatedEditorOptions {
		const accessibilityIsOn = (accessibilitySupport === AccessibilitySupport.Enabled);
		const accessibilityIsOff = (accessibilitySupport === AccessibilitySupport.Disabled);
2096 2097 2098 2099 2100 2101 2102
		return {
			inDiffEditor: opts.inDiffEditor,
			wordSeparators: opts.wordSeparators,
			lineNumbersMinChars: opts.lineNumbersMinChars,
			lineDecorationsWidth: opts.lineDecorationsWidth,
			readOnly: opts.readOnly,
			mouseStyle: opts.mouseStyle,
2103
			disableLayerHinting: opts.disableLayerHinting,
2104 2105 2106 2107 2108 2109 2110 2111
			automaticLayout: opts.automaticLayout,
			wordWrap: opts.wordWrap,
			wordWrapColumn: opts.wordWrapColumn,
			wordWrapMinified: opts.wordWrapMinified,
			wrappingIndent: opts.wrappingIndent,
			wordWrapBreakBeforeCharacters: opts.wordWrapBreakBeforeCharacters,
			wordWrapBreakAfterCharacters: opts.wordWrapBreakAfterCharacters,
			wordWrapBreakObtrusiveCharacters: opts.wordWrapBreakObtrusiveCharacters,
2112
			autoClosingBrackets: opts.autoClosingBrackets,
J
Jackson Kearl 已提交
2113
			autoClosingQuotes: opts.autoClosingQuotes,
2114
			autoSurround: opts.autoSurround,
2115
			autoIndent: opts.autoIndent,
2116 2117
			dragAndDrop: opts.dragAndDrop,
			emptySelectionClipboard: opts.emptySelectionClipboard,
2118
			copyWithSyntaxHighlighting: opts.copyWithSyntaxHighlighting,
2119
			useTabStops: opts.useTabStops,
2120
			multiCursorModifier: opts.multiCursorModifier,
A
Alex Dima 已提交
2121
			multiCursorMergeOverlapping: opts.multiCursorMergeOverlapping,
2122
			accessibilitySupport: opts.accessibilitySupport,
2123
			showUnused: opts.showUnused,
2124 2125 2126 2127 2128

			viewInfo: {
				extraEditorClassName: opts.viewInfo.extraEditorClassName,
				disableMonospaceOptimizations: opts.viewInfo.disableMonospaceOptimizations,
				rulers: opts.viewInfo.rulers,
2129
				ariaLabel: (accessibilityIsOff ? nls.localize('accessibilityOffAriaLabel', "The editor is not accessible at this time. Press Alt+F1 for options.") : opts.viewInfo.ariaLabel),
2130 2131
				renderLineNumbers: opts.viewInfo.renderLineNumbers,
				renderCustomLineNumbers: opts.viewInfo.renderCustomLineNumbers,
A
Alex Dima 已提交
2132
				renderFinalNewline: opts.viewInfo.renderFinalNewline,
2133 2134 2135
				selectOnLineNumbers: opts.viewInfo.selectOnLineNumbers,
				glyphMargin: opts.viewInfo.glyphMargin,
				revealHorizontalRightPadding: opts.viewInfo.revealHorizontalRightPadding,
2136
				roundedSelection: (accessibilityIsOn ? false : opts.viewInfo.roundedSelection), // DISABLED WHEN SCREEN READER IS ATTACHED
2137 2138 2139 2140
				overviewRulerLanes: opts.viewInfo.overviewRulerLanes,
				overviewRulerBorder: opts.viewInfo.overviewRulerBorder,
				cursorBlinking: opts.viewInfo.cursorBlinking,
				mouseWheelZoom: opts.viewInfo.mouseWheelZoom,
2141
				cursorSmoothCaretAnimation: opts.viewInfo.cursorSmoothCaretAnimation,
2142
				cursorStyle: opts.viewInfo.cursorStyle,
2143
				cursorWidth: opts.viewInfo.cursorWidth,
2144 2145
				hideCursorInOverviewRuler: opts.viewInfo.hideCursorInOverviewRuler,
				scrollBeyondLastLine: opts.viewInfo.scrollBeyondLastLine,
2146
				scrollBeyondLastColumn: opts.viewInfo.scrollBeyondLastColumn,
2147
				smoothScrolling: opts.viewInfo.smoothScrolling,
2148
				stopRenderingLineAfter: opts.viewInfo.stopRenderingLineAfter,
2149 2150 2151 2152
				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
2153
				highlightActiveIndentGuide: opts.viewInfo.highlightActiveIndentGuide,
A
Alex Dima 已提交
2154
				renderLineHighlight: opts.viewInfo.renderLineHighlight,
2155 2156
				scrollbar: opts.viewInfo.scrollbar,
				minimap: {
2157
					enabled: (accessibilityIsOn ? false : opts.viewInfo.minimap.enabled), // DISABLED WHEN SCREEN READER IS ATTACHED
2158
					side: opts.viewInfo.minimap.side,
2159
					renderCharacters: opts.viewInfo.minimap.renderCharacters,
2160
					showSlider: opts.viewInfo.minimap.showSlider,
2161 2162 2163 2164 2165 2166 2167 2168
					maxColumn: opts.viewInfo.minimap.maxColumn
				},
				fixedOverflowWidgets: opts.viewInfo.fixedOverflowWidgets
			},

			contribInfo: {
				selectionClipboard: opts.contribInfo.selectionClipboard,
				hover: opts.contribInfo.hover,
2169
				links: (accessibilityIsOn ? false : opts.contribInfo.links), // DISABLED WHEN SCREEN READER IS ATTACHED
2170 2171 2172 2173 2174 2175 2176 2177 2178 2179
				contextmenu: opts.contribInfo.contextmenu,
				quickSuggestions: opts.contribInfo.quickSuggestions,
				quickSuggestionsDelay: opts.contribInfo.quickSuggestionsDelay,
				parameterHints: opts.contribInfo.parameterHints,
				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 已提交
2180
				suggestSelection: opts.contribInfo.suggestSelection,
2181 2182
				suggestFontSize: opts.contribInfo.suggestFontSize,
				suggestLineHeight: opts.contribInfo.suggestLineHeight,
2183
				tabCompletion: opts.contribInfo.tabCompletion,
2184
				suggest: opts.contribInfo.suggest,
2185 2186 2187 2188
				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
2189
				foldingStrategy: opts.contribInfo.foldingStrategy,
2190
				showFoldingControls: opts.contribInfo.showFoldingControls,
2191
				matchBrackets: (accessibilityIsOn ? false : opts.contribInfo.matchBrackets), // DISABLED WHEN SCREEN READER IS ATTACHED
2192
				find: opts.contribInfo.find,
2193
				colorDecorators: opts.contribInfo.colorDecorators,
2194 2195 2196
				lightbulbEnabled: opts.contribInfo.lightbulbEnabled,
				codeActionsOnSave: opts.contribInfo.codeActionsOnSave,
				codeActionsOnSaveTimeout: opts.contribInfo.codeActionsOnSaveTimeout
2197 2198 2199 2200 2201 2202
			}
		};
	}

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

2203
		let accessibilitySupport: AccessibilitySupport;
2204 2205 2206 2207
		if (_opts.accessibilitySupport === 'auto') {
			// The editor reads the `accessibilitySupport` from the environment
			accessibilitySupport = env.accessibilitySupport;
		} else if (_opts.accessibilitySupport === 'on') {
2208
			accessibilitySupport = AccessibilitySupport.Enabled;
2209
		} else {
2210
			accessibilitySupport = AccessibilitySupport.Disabled;
2211 2212
		}

2213 2214
		// Disable some non critical features to get as best performance as possible
		// See https://github.com/Microsoft/vscode/issues/26730
2215
		const opts = this._tweakValidatedOptions(_opts, accessibilitySupport);
2216 2217 2218 2219 2220 2221 2222 2223

		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 已提交
2224
		if (opts.contribInfo.folding) {
2225 2226 2227
			lineDecorationsWidth += 16;
		}

2228 2229 2230
		const layoutInfo = EditorLayoutProvider.compute({
			outerWidth: env.outerWidth,
			outerHeight: env.outerHeight,
A
Alex Dima 已提交
2231
			showGlyphMargin: opts.viewInfo.glyphMargin,
2232
			lineHeight: env.fontInfo.lineHeight,
2233
			showLineNumbers: (opts.viewInfo.renderLineNumbers !== RenderLineNumbersType.Off),
2234
			lineNumbersMinChars: opts.lineNumbersMinChars,
2235 2236 2237 2238
			lineNumbersDigitCount: env.lineNumbersDigitCount,
			lineDecorationsWidth: lineDecorationsWidth,
			typicalHalfwidthCharacterWidth: env.fontInfo.typicalHalfwidthCharacterWidth,
			maxDigitWidth: env.fontInfo.maxDigitWidth,
A
Alex Dima 已提交
2239 2240 2241 2242 2243
			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,
2244
			minimapSide: opts.viewInfo.minimap.side,
A
Alex Dima 已提交
2245 2246
			minimapRenderCharacters: opts.viewInfo.minimap.renderCharacters,
			minimapMaxColumn: opts.viewInfo.minimap.maxColumn,
2247 2248 2249
			pixelRatio: env.pixelRatio
		});

A
Alex Dima 已提交
2250
		let bareWrappingInfo: { isWordWrapMinified: boolean; isViewportWrapping: boolean; wrappingColumn: number; } | null = null;
2251
		{
A
Alex Dima 已提交
2252
			const wordWrap = opts.wordWrap;
2253 2254
			const wordWrapColumn = opts.wordWrapColumn;
			const wordWrapMinified = opts.wordWrapMinified;
2255

2256
			if (accessibilitySupport === AccessibilitySupport.Enabled) {
2257 2258 2259 2260 2261 2262 2263 2264 2265 2266
				// 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) {
2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299
				// 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 已提交
2300
		const wrappingInfo: EditorWrappingInfo = {
2301
			inDiffEditor: opts.inDiffEditor,
2302 2303 2304 2305
			isDominatedByLongLines: env.isDominatedByLongLines,
			isWordWrapMinified: bareWrappingInfo.isWordWrapMinified,
			isViewportWrapping: bareWrappingInfo.isViewportWrapping,
			wrappingColumn: bareWrappingInfo.wrappingColumn,
2306 2307 2308 2309
			wrappingIndent: opts.wrappingIndent,
			wordWrapBreakBeforeCharacters: opts.wordWrapBreakBeforeCharacters,
			wordWrapBreakAfterCharacters: opts.wordWrapBreakAfterCharacters,
			wordWrapBreakObtrusiveCharacters: opts.wordWrapBreakObtrusiveCharacters,
A
Alex Dima 已提交
2310
		};
2311

2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327
		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';
		}

2328
		return new InternalEditorOptions({
2329
			canUseLayerHinting: opts.disableLayerHinting ? false : true,
2330
			pixelRatio: env.pixelRatio,
2331
			editorClassName: className,
A
Alex Dima 已提交
2332
			lineHeight: env.fontInfo.lineHeight,
2333
			readOnly: opts.readOnly,
2334
			accessibilitySupport: accessibilitySupport,
2335
			multiCursorModifier: opts.multiCursorModifier,
A
Alex Dima 已提交
2336
			multiCursorMergeOverlapping: opts.multiCursorMergeOverlapping,
2337 2338
			wordSeparators: opts.wordSeparators,
			autoClosingBrackets: opts.autoClosingBrackets,
J
Jackson Kearl 已提交
2339
			autoClosingQuotes: opts.autoClosingQuotes,
2340
			autoSurround: opts.autoSurround,
2341
			autoIndent: opts.autoIndent,
2342 2343 2344
			useTabStops: opts.useTabStops,
			tabFocusMode: opts.readOnly ? true : env.tabFocusMode,
			dragAndDrop: opts.dragAndDrop,
2345
			emptySelectionClipboard: opts.emptySelectionClipboard && env.emptySelectionClipboard,
2346
			copyWithSyntaxHighlighting: opts.copyWithSyntaxHighlighting,
2347 2348
			layoutInfo: layoutInfo,
			fontInfo: env.fontInfo,
A
Alex Dima 已提交
2349
			viewInfo: opts.viewInfo,
2350
			wrappingInfo: wrappingInfo,
2351 2352
			contribInfo: opts.contribInfo,
			showUnused: opts.showUnused,
2353 2354 2355 2356 2357 2358 2359 2360
		});
	}
}

/**
 * @internal
 */
export interface IEditorLayoutProviderOpts {
M
Matt Bierner 已提交
2361 2362
	readonly outerWidth: number;
	readonly outerHeight: number;
2363

M
Matt Bierner 已提交
2364 2365
	readonly showGlyphMargin: boolean;
	readonly lineHeight: number;
2366

M
Matt Bierner 已提交
2367 2368 2369
	readonly showLineNumbers: boolean;
	readonly lineNumbersMinChars: number;
	readonly lineNumbersDigitCount: number;
2370

M
Matt Bierner 已提交
2371
	readonly lineDecorationsWidth: number;
2372

M
Matt Bierner 已提交
2373 2374
	readonly typicalHalfwidthCharacterWidth: number;
	readonly maxDigitWidth: number;
2375

M
Matt Bierner 已提交
2376 2377 2378 2379
	readonly verticalScrollbarWidth: number;
	readonly verticalScrollbarHasArrows: boolean;
	readonly scrollbarArrowSize: number;
	readonly horizontalScrollbarHeight: number;
2380

M
Matt Bierner 已提交
2381 2382 2383 2384 2385
	readonly minimap: boolean;
	readonly minimapSide: string;
	readonly minimapRenderCharacters: boolean;
	readonly minimapMaxColumn: number;
	readonly pixelRatio: number;
2386 2387 2388 2389 2390 2391 2392 2393 2394
}

/**
 * @internal
 */
export class EditorLayoutProvider {
	public static compute(_opts: IEditorLayoutProviderOpts): EditorLayoutInfo {
		const outerWidth = _opts.outerWidth | 0;
		const outerHeight = _opts.outerHeight | 0;
A
Alex Dima 已提交
2395
		const showGlyphMargin = _opts.showGlyphMargin;
2396
		const lineHeight = _opts.lineHeight | 0;
A
Alex Dima 已提交
2397
		const showLineNumbers = _opts.showLineNumbers;
2398 2399 2400
		const lineNumbersMinChars = _opts.lineNumbersMinChars | 0;
		const lineNumbersDigitCount = _opts.lineNumbersDigitCount | 0;
		const lineDecorationsWidth = _opts.lineDecorationsWidth | 0;
A
Alex Dima 已提交
2401 2402
		const typicalHalfwidthCharacterWidth = _opts.typicalHalfwidthCharacterWidth;
		const maxDigitWidth = _opts.maxDigitWidth;
A
Alex Dima 已提交
2403
		const verticalScrollbarWidth = _opts.verticalScrollbarWidth | 0;
A
Alex Dima 已提交
2404
		const verticalScrollbarHasArrows = _opts.verticalScrollbarHasArrows;
2405 2406
		const scrollbarArrowSize = _opts.scrollbarArrowSize | 0;
		const horizontalScrollbarHeight = _opts.horizontalScrollbarHeight | 0;
A
Alex Dima 已提交
2407
		const minimap = _opts.minimap;
2408
		const minimapSide = _opts.minimapSide;
A
Alex Dima 已提交
2409
		const minimapRenderCharacters = _opts.minimapRenderCharacters;
2410
		const minimapMaxColumn = _opts.minimapMaxColumn | 0;
A
Alex Dima 已提交
2411
		const pixelRatio = _opts.pixelRatio;
2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423

		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 已提交
2424 2425 2426 2427 2428
		let glyphMarginLeft = 0;
		let lineNumbersLeft = glyphMarginLeft + glyphMarginWidth;
		let decorationsLeft = lineNumbersLeft + lineNumbersWidth;
		let contentLeft = decorationsLeft + lineDecorationsWidth;

2429 2430 2431
		const remainingWidth = outerWidth - glyphMarginWidth - lineNumbersWidth - lineDecorationsWidth;

		let renderMinimap: RenderMinimap;
2432
		let minimapLeft: number;
2433 2434 2435
		let minimapWidth: number;
		let contentWidth: number;
		if (!minimap) {
2436
			minimapLeft = 0;
2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450
			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:
2451 2452
			// (leaving 2px for the cursor to have space after the last character)
			// viewportColumn = (contentWidth - verticalScrollbarWidth - 2) / typicalHalfwidthCharacterWidth
2453 2454 2455 2456
			// minimapWidth = viewportColumn * minimapCharWidth
			// contentWidth = remainingWidth - minimapWidth
			// What are good values for contentWidth and minimapWidth ?

2457 2458 2459 2460 2461
			// 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)
2462

2463
			minimapWidth = Math.max(0, Math.floor(((remainingWidth - verticalScrollbarWidth - 2) * minimapCharWidth) / (typicalHalfwidthCharacterWidth + minimapCharWidth)));
2464 2465 2466 2467 2468
			let minimapColumns = minimapWidth / minimapCharWidth;
			if (minimapColumns > minimapMaxColumn) {
				minimapWidth = Math.floor(minimapMaxColumn * minimapCharWidth);
			}
			contentWidth = remainingWidth - minimapWidth;
2469

A
Alex Dima 已提交
2470
			if (minimapSide === 'left') {
2471
				minimapLeft = 0;
A
Alex Dima 已提交
2472 2473 2474 2475
				glyphMarginLeft += minimapWidth;
				lineNumbersLeft += minimapWidth;
				decorationsLeft += minimapWidth;
				contentLeft += minimapWidth;
2476 2477
			} else {
				minimapLeft = outerWidth - minimapWidth - verticalScrollbarWidth;
2478
			}
2479 2480
		}

2481 2482
		// (leaving 2px for the cursor to have space after the last character)
		const viewportColumn = Math.max(1, Math.floor((contentWidth - verticalScrollbarWidth - 2) / typicalHalfwidthCharacterWidth));
2483 2484 2485

		const verticalArrowSize = (verticalScrollbarHasArrows ? scrollbarArrowSize : 0);

A
Alex Dima 已提交
2486
		return {
2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506
			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,
2507
			minimapLeft: minimapLeft,
2508 2509 2510 2511 2512 2513 2514
			minimapWidth: minimapWidth,

			viewportColumn: viewportColumn,

			verticalScrollbarWidth: verticalScrollbarWidth,
			horizontalScrollbarHeight: horizontalScrollbarHeight,

A
Alex Dima 已提交
2515
			overviewRuler: {
2516 2517 2518 2519
				top: verticalArrowSize,
				width: verticalScrollbarWidth,
				height: (outerHeight - 2 * verticalArrowSize),
				right: 0
A
Alex Dima 已提交
2520 2521
			}
		};
2522 2523
	}
}
2524 2525 2526

const DEFAULT_WINDOWS_FONT_FAMILY = 'Consolas, \'Courier New\', monospace';
const DEFAULT_MAC_FONT_FAMILY = 'Menlo, Monaco, \'Courier New\', monospace';
2527
const DEFAULT_LINUX_FONT_FAMILY = '\'Droid Sans Mono\', \'monospace\', monospace, \'Droid Sans Fallback\'';
2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540

/**
 * @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,
2541
	letterSpacing: 0,
2542 2543 2544 2545 2546 2547 2548
};

/**
 * @internal
 */
export const EDITOR_MODEL_DEFAULTS = {
	tabSize: 4,
D
David Lechner 已提交
2549
	indentSize: 4,
2550 2551
	insertSpaces: true,
	detectIndentation: true,
2552
	trimAutoWhitespace: true,
2553
	largeFileOptimizations: true
2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565
};

/**
 * @internal
 */
export const EDITOR_DEFAULTS: IValidatedEditorOptions = {
	inDiffEditor: false,
	wordSeparators: USUAL_WORD_SEPARATORS,
	lineNumbersMinChars: 5,
	lineDecorationsWidth: 10,
	readOnly: false,
	mouseStyle: 'text',
2566
	disableLayerHinting: false,
2567 2568 2569 2570 2571 2572
	automaticLayout: false,
	wordWrap: 'off',
	wordWrapColumn: 80,
	wordWrapMinified: true,
	wrappingIndent: WrappingIndent.Same,
	wordWrapBreakBeforeCharacters: '([{‘“〈《「『【〔([{「£¥$£¥++',
2573
	wordWrapBreakAfterCharacters: ' \t})]?|/&,;¢°′″‰℃、。。、¢,.:;?!%・・ゝゞヽヾーァィゥェォッャュョヮヵヶぁぃぅぇぉっゃゅょゎゕゖㇰㇱㇲㇳㇴㇵㇶㇷㇸㇹㇺㇻㇼㇽㇾㇿ々〻ァィゥェォャュョッー”〉》」』】〕)]}」',
2574
	wordWrapBreakObtrusiveCharacters: '.',
J
Jackson Kearl 已提交
2575 2576
	autoClosingBrackets: 'languageDefined',
	autoClosingQuotes: 'languageDefined',
2577
	autoSurround: 'languageDefined',
R
rebornix 已提交
2578
	autoIndent: true,
2579
	dragAndDrop: true,
2580
	emptySelectionClipboard: true,
2581
	copyWithSyntaxHighlighting: true,
2582
	useTabStops: true,
2583
	multiCursorModifier: 'altKey',
A
Alex Dima 已提交
2584
	multiCursorMergeOverlapping: true,
2585
	accessibilitySupport: 'auto',
2586
	showUnused: true,
A
Alex Dima 已提交
2587 2588

	viewInfo: {
2589
		extraEditorClassName: '',
A
Alex Dima 已提交
2590 2591 2592
		disableMonospaceOptimizations: false,
		rulers: [],
		ariaLabel: nls.localize('editorViewAccessibleLabel', "Editor content"),
2593
		renderLineNumbers: RenderLineNumbersType.On,
A
Alex Dima 已提交
2594
		renderCustomLineNumbers: null,
A
Alex Dima 已提交
2595
		renderFinalNewline: (platform.isLinux ? false : true),
A
Alex Dima 已提交
2596 2597 2598 2599 2600 2601 2602 2603
		selectOnLineNumbers: true,
		glyphMargin: true,
		revealHorizontalRightPadding: 30,
		roundedSelection: true,
		overviewRulerLanes: 2,
		overviewRulerBorder: true,
		cursorBlinking: TextEditorCursorBlinkingStyle.Blink,
		mouseWheelZoom: false,
2604
		cursorSmoothCaretAnimation: false,
A
Alex Dima 已提交
2605
		cursorStyle: TextEditorCursorStyle.Line,
2606
		cursorWidth: 0,
A
Alex Dima 已提交
2607 2608
		hideCursorInOverviewRuler: false,
		scrollBeyondLastLine: true,
2609
		scrollBeyondLastColumn: 5,
2610
		smoothScrolling: false,
A
Alex Dima 已提交
2611 2612 2613 2614
		stopRenderingLineAfter: 10000,
		renderWhitespace: 'none',
		renderControlCharacters: false,
		fontLigatures: false,
2615
		renderIndentGuides: true,
2616
		highlightActiveIndentGuide: true,
A
Alex Dima 已提交
2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630
		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 已提交
2631
			fastScrollSensitivity: 5,
A
Alex Dima 已提交
2632 2633
		},
		minimap: {
2634
			enabled: true,
2635
			side: 'right',
2636
			showSlider: 'mouseover',
A
Alex Dima 已提交
2637 2638 2639 2640 2641 2642 2643 2644
			renderCharacters: true,
			maxColumn: 120
		},
		fixedOverflowWidgets: false,
	},

	contribInfo: {
		selectionClipboard: true,
A
Alex Dima 已提交
2645
		hover: {
2646
			enabled: true,
2647 2648
			delay: 300,
			sticky: true
A
Alex Dima 已提交
2649
		},
2650
		links: true,
A
Alex Dima 已提交
2651 2652 2653
		contextmenu: true,
		quickSuggestions: { other: true, comments: false, strings: false },
		quickSuggestionsDelay: 10,
2654 2655 2656 2657
		parameterHints: {
			enabled: true,
			cycle: false
		},
A
Alex Dima 已提交
2658
		formatOnType: false,
2659
		formatOnPaste: false,
A
Alex Dima 已提交
2660
		suggestOnTriggerCharacters: true,
2661
		acceptSuggestionOnEnter: 'on',
A
Alex Dima 已提交
2662 2663
		acceptSuggestionOnCommitCharacter: true,
		wordBasedSuggestions: true,
B
Benas Svipas 已提交
2664
		suggestSelection: 'recentlyUsed',
A
Alex Dima 已提交
2665 2666
		suggestFontSize: 0,
		suggestLineHeight: 0,
2667
		tabCompletion: 'off',
2668 2669
		suggest: {
			filterGraceful: true,
2670
			snippets: 'inline',
J
Johannes Rieken 已提交
2671
			snippetsPreventQuickSuggestions: true,
2672
			localityBonus: false,
2673 2674
			shareSuggestSelections: false,
			showIcons: true,
2675
			maxVisibileSuggestions: 12
2676
		},
A
Alex Dima 已提交
2677 2678 2679 2680
		selectionHighlight: true,
		occurrencesHighlight: true,
		codeLens: true,
		folding: true,
2681
		foldingStrategy: 'auto',
2682
		showFoldingControls: 'mouseover',
A
Alex Dima 已提交
2683
		matchBrackets: true,
2684
		find: {
R
rebornix 已提交
2685
			seedSearchStringFromSelection: true,
2686
			autoFindInSelection: false,
2687 2688
			globalFindClipboard: false,
			addExtraSpaceOnTop: true
2689
		},
2690
		colorDecorators: true,
2691 2692 2693
		lightbulbEnabled: true,
		codeActionsOnSave: {},
		codeActionsOnSaveTimeout: 750
A
Alex Dima 已提交
2694
	},
2695
};