editorOptions.ts 92.8 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
import { isObject } from 'vs/base/common/types';
16 17 18 19 20 21 22 23 24 25 26 27 28 29

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

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

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

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

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

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

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

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

190 191 192 193 194
export interface ISuggestOptions {
	/**
	 * Enable graceful matching. Defaults to true.
	 */
	filterGraceful?: boolean;
195 196 197 198
	/**
	 * Prevent quick suggestions when a snippet is active. Defaults to true.
	 */
	snippetsPreventQuickSuggestions?: boolean;
J
Johannes Rieken 已提交
199 200 201 202
	/**
	 * Favours words that appear close to the cursor.
	 */
	localityBonus?: boolean;
203 204 205
	/**
	 * Enable using global storage for remembering suggestions.
	 */
206
	shareSuggestSelections?: boolean;
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.
	 */
J
Johannes Rieken 已提交
214
	maxVisibleSuggestions?: boolean;
215 216 217 218
	/**
	 * Names of suggestion types to filter.
	 */
	filteredTypes?: Record<string, boolean>;
219 220
}

221 222 223 224
export interface IGotoLocationOptions {
	/**
	 * Control how goto-command work when having multiple results.
	 */
J
Johannes Rieken 已提交
225
	multiple?: 'peek' | 'gotoAndPeek' | 'goto';
226 227
}

228 229 230 231 232 233 234
/**
 * Configuration map for codeActionsOnSave
 */
export interface ICodeActionsOnSaveOptions {
	[kind: string]: boolean;
}

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

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

754
export const enum RenderMinimap {
755 756 757 758 759 760 761 762 763 764
	None = 0,
	Small = 1,
	Large = 2,
	SmallBlocks = 3,
	LargeBlocks = 4,
}

/**
 * Describes how to indent wrapped lines.
 */
765
export const enum WrappingIndent {
766 767 768 769 770 771 772 773 774
	/**
	 * No indentation => wrapped lines begin at column 1.
	 */
	None = 0,
	/**
	 * Same => wrapped lines get the same indentation as the parent.
	 */
	Same = 1,
	/**
775
	 * Indent => wrapped lines get +1 indentation toward the parent.
776
	 */
777 778 779
	Indent = 2,
	/**
	 * DeepIndent => wrapped lines get +2 indentation toward the parent.
780
	 */
781
	DeepIndent = 3
782 783 784 785 786
}

/**
 * The kind of animation in which the editor's cursor should be rendered.
 */
787
export const enum TextEditorCursorBlinkingStyle {
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
	/**
	 * 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
}
813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
/**
 * @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');
	}
}
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 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882

/**
 * 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 已提交
883
function _cursorStyleFromString(cursorStyle: string | undefined, defaultValue: TextEditorCursorStyle): TextEditorCursorStyle {
A
Alex Dima 已提交
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
	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 已提交
903
export interface InternalEditorScrollbarOptions {
904 905 906 907 908 909 910 911 912 913 914 915
	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 已提交
916
	readonly fastScrollSensitivity: number;
917 918
}

A
Alex Dima 已提交
919
export interface InternalEditorMinimapOptions {
920
	readonly enabled: boolean;
921
	readonly side: 'right' | 'left';
922
	readonly showSlider: 'always' | 'mouseover';
923 924 925 926
	readonly renderCharacters: boolean;
	readonly maxColumn: number;
}

927 928
export interface InternalEditorFindOptions {
	readonly seedSearchStringFromSelection: boolean;
R
rebornix 已提交
929
	readonly autoFindInSelection: boolean;
930
	readonly addExtraSpaceOnTop: boolean;
931 932 933 934
	/**
	 * @internal
	 */
	readonly globalFindClipboard: boolean;
935 936
}

A
Alex Dima 已提交
937 938
export interface InternalEditorHoverOptions {
	readonly enabled: boolean;
939
	readonly delay: number;
940
	readonly sticky: boolean;
A
Alex Dima 已提交
941 942
}

943
export interface InternalGoToLocationOptions {
J
Johannes Rieken 已提交
944
	readonly multiple: 'peek' | 'gotoAndPeek' | 'goto';
945 946
}

947 948
export interface InternalSuggestOptions {
	readonly filterGraceful: boolean;
949
	readonly snippets: 'top' | 'bottom' | 'inline' | 'none';
950
	readonly snippetsPreventQuickSuggestions: boolean;
J
Johannes Rieken 已提交
951
	readonly localityBonus: boolean;
J
Johannes Rieken 已提交
952
	readonly shareSuggestSelections: boolean;
953
	readonly showIcons: boolean;
J
Johannes Rieken 已提交
954
	readonly maxVisibleSuggestions: number;
955
	readonly filteredTypes: Record<string, boolean>;
956 957
}

958 959 960 961 962
export interface InternalParameterHintOptions {
	readonly enabled: boolean;
	readonly cycle: boolean;
}

A
Alex Dima 已提交
963
export interface EditorWrappingInfo {
964 965 966 967 968 969 970 971 972 973 974
	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;
}

975 976 977 978
export const enum RenderLineNumbersType {
	Off = 0,
	On = 1,
	Relative = 2,
979 980
	Interval = 3,
	Custom = 4
981 982
}

A
Alex Dima 已提交
983
export interface InternalEditorViewOptions {
984
	readonly extraEditorClassName: string;
985 986 987
	readonly disableMonospaceOptimizations: boolean;
	readonly rulers: number[];
	readonly ariaLabel: string;
988
	readonly renderLineNumbers: RenderLineNumbersType;
A
Alex Dima 已提交
989
	readonly renderCustomLineNumbers: ((lineNumber: number) => string) | null;
990
	readonly cursorSurroundingLines: number;
A
Alex Dima 已提交
991
	readonly renderFinalNewline: boolean;
992 993 994 995 996 997 998 999
	readonly selectOnLineNumbers: boolean;
	readonly glyphMargin: boolean;
	readonly revealHorizontalRightPadding: number;
	readonly roundedSelection: boolean;
	readonly overviewRulerLanes: number;
	readonly overviewRulerBorder: boolean;
	readonly cursorBlinking: TextEditorCursorBlinkingStyle;
	readonly mouseWheelZoom: boolean;
1000
	readonly cursorSmoothCaretAnimation: boolean;
1001
	readonly cursorStyle: TextEditorCursorStyle;
1002
	readonly cursorWidth: number;
1003 1004
	readonly hideCursorInOverviewRuler: boolean;
	readonly scrollBeyondLastLine: boolean;
1005
	readonly scrollBeyondLastColumn: number;
1006
	readonly smoothScrolling: boolean;
1007
	readonly stopRenderingLineAfter: number;
1008
	readonly renderWhitespace: 'none' | 'boundary' | 'selection' | 'all';
1009 1010 1011
	readonly renderControlCharacters: boolean;
	readonly fontLigatures: boolean;
	readonly renderIndentGuides: boolean;
1012
	readonly highlightActiveIndentGuide: boolean;
1013 1014 1015 1016 1017 1018
	readonly renderLineHighlight: 'none' | 'gutter' | 'line' | 'all';
	readonly scrollbar: InternalEditorScrollbarOptions;
	readonly minimap: InternalEditorMinimapOptions;
	readonly fixedOverflowWidgets: boolean;
}

A
Alex Dima 已提交
1019
export interface EditorContribOptions {
1020
	readonly selectionClipboard: boolean;
A
Alex Dima 已提交
1021
	readonly hover: InternalEditorHoverOptions;
1022
	readonly links: boolean;
1023 1024 1025
	readonly contextmenu: boolean;
	readonly quickSuggestions: boolean | { other: boolean, comments: boolean, strings: boolean };
	readonly quickSuggestionsDelay: number;
1026
	readonly parameterHints: InternalParameterHintOptions;
1027 1028 1029
	readonly formatOnType: boolean;
	readonly formatOnPaste: boolean;
	readonly suggestOnTriggerCharacters: boolean;
1030
	readonly acceptSuggestionOnEnter: 'on' | 'smart' | 'off';
1031 1032
	readonly acceptSuggestionOnCommitCharacter: boolean;
	readonly wordBasedSuggestions: boolean;
B
Benas Svipas 已提交
1033
	readonly suggestSelection: 'first' | 'recentlyUsed' | 'recentlyUsedByPrefix';
1034 1035
	readonly suggestFontSize: number;
	readonly suggestLineHeight: number;
1036
	readonly tabCompletion: 'on' | 'off' | 'onlySnippets';
1037
	readonly suggest: InternalSuggestOptions;
1038
	readonly gotoLocation: InternalGoToLocationOptions;
1039 1040 1041 1042
	readonly selectionHighlight: boolean;
	readonly occurrencesHighlight: boolean;
	readonly codeLens: boolean;
	readonly folding: boolean;
1043
	readonly foldingStrategy: 'auto' | 'indentation';
1044
	readonly showFoldingControls: 'always' | 'mouseover';
1045
	readonly matchBrackets: boolean;
1046
	readonly find: InternalEditorFindOptions;
R
rebornix 已提交
1047
	readonly colorDecorators: boolean;
1048
	readonly lightbulbEnabled: boolean;
1049 1050
	readonly codeActionsOnSave: ICodeActionsOnSaveOptions;
	readonly codeActionsOnSaveTimeout: number;
1051 1052
}

1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
/**
 * 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';
1065
	readonly disableLayerHinting: boolean;
1066 1067 1068 1069 1070 1071 1072 1073
	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 已提交
1074 1075
	readonly autoClosingBrackets: EditorAutoClosingStrategy;
	readonly autoClosingQuotes: EditorAutoClosingStrategy;
1076
	readonly autoSurround: EditorAutoSurroundStrategy;
1077
	readonly autoIndent: boolean;
1078 1079
	readonly dragAndDrop: boolean;
	readonly emptySelectionClipboard: boolean;
1080
	readonly copyWithSyntaxHighlighting: boolean;
1081
	readonly useTabStops: boolean;
1082
	readonly multiCursorModifier: 'altKey' | 'ctrlKey' | 'metaKey';
A
Alex Dima 已提交
1083
	readonly multiCursorMergeOverlapping: boolean;
1084
	readonly accessibilitySupport: 'auto' | 'off' | 'on';
1085
	readonly showUnused: boolean;
1086 1087 1088 1089 1090

	readonly viewInfo: InternalEditorViewOptions;
	readonly contribInfo: EditorContribOptions;
}

1091 1092 1093 1094 1095 1096
/**
 * Internal configuration options (transformed or computed) for the editor.
 */
export class InternalEditorOptions {
	readonly _internalEditorOptionsBrand: void;

1097
	readonly canUseLayerHinting: boolean;
1098
	readonly pixelRatio: number;
A
Alex Dima 已提交
1099
	readonly editorClassName: string;
A
Alex Dima 已提交
1100
	readonly lineHeight: number;
1101
	readonly readOnly: boolean;
1102 1103 1104
	/**
	 * @internal
	 */
1105
	readonly accessibilitySupport: AccessibilitySupport;
1106
	readonly multiCursorModifier: 'altKey' | 'ctrlKey' | 'metaKey';
A
Alex Dima 已提交
1107
	readonly multiCursorMergeOverlapping: boolean;
1108
	readonly showUnused: boolean;
A
Alex Dima 已提交
1109

1110 1111
	// ---- cursor options
	readonly wordSeparators: string;
J
Jackson Kearl 已提交
1112 1113
	readonly autoClosingBrackets: EditorAutoClosingStrategy;
	readonly autoClosingQuotes: EditorAutoClosingStrategy;
1114
	readonly autoSurround: EditorAutoSurroundStrategy;
1115
	readonly autoIndent: boolean;
1116 1117 1118
	readonly useTabStops: boolean;
	readonly tabFocusMode: boolean;
	readonly dragAndDrop: boolean;
1119
	readonly emptySelectionClipboard: boolean;
1120
	readonly copyWithSyntaxHighlighting: boolean;
A
Alex Dima 已提交
1121

1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132
	// ---- grouped options
	readonly layoutInfo: EditorLayoutInfo;
	readonly fontInfo: FontInfo;
	readonly viewInfo: InternalEditorViewOptions;
	readonly wrappingInfo: EditorWrappingInfo;
	readonly contribInfo: EditorContribOptions;

	/**
	 * @internal
	 */
	constructor(source: {
1133
		canUseLayerHinting: boolean;
1134
		pixelRatio: number;
A
Alex Dima 已提交
1135
		editorClassName: string;
1136 1137
		lineHeight: number;
		readOnly: boolean;
1138
		accessibilitySupport: AccessibilitySupport;
1139
		multiCursorModifier: 'altKey' | 'ctrlKey' | 'metaKey';
A
Alex Dima 已提交
1140
		multiCursorMergeOverlapping: boolean;
1141
		wordSeparators: string;
J
Jackson Kearl 已提交
1142 1143
		autoClosingBrackets: EditorAutoClosingStrategy;
		autoClosingQuotes: EditorAutoClosingStrategy;
1144
		autoSurround: EditorAutoSurroundStrategy;
1145
		autoIndent: boolean;
1146 1147 1148
		useTabStops: boolean;
		tabFocusMode: boolean;
		dragAndDrop: boolean;
1149
		emptySelectionClipboard: boolean;
1150
		copyWithSyntaxHighlighting: boolean;
1151 1152 1153 1154 1155
		layoutInfo: EditorLayoutInfo;
		fontInfo: FontInfo;
		viewInfo: InternalEditorViewOptions;
		wrappingInfo: EditorWrappingInfo;
		contribInfo: EditorContribOptions;
1156
		showUnused: boolean;
1157
	}) {
1158
		this.canUseLayerHinting = source.canUseLayerHinting;
1159 1160
		this.pixelRatio = source.pixelRatio;
		this.editorClassName = source.editorClassName;
1161
		this.lineHeight = source.lineHeight | 0;
1162
		this.readOnly = source.readOnly;
1163
		this.accessibilitySupport = source.accessibilitySupport;
1164
		this.multiCursorModifier = source.multiCursorModifier;
A
Alex Dima 已提交
1165
		this.multiCursorMergeOverlapping = source.multiCursorMergeOverlapping;
1166 1167
		this.wordSeparators = source.wordSeparators;
		this.autoClosingBrackets = source.autoClosingBrackets;
J
Jackson Kearl 已提交
1168
		this.autoClosingQuotes = source.autoClosingQuotes;
1169
		this.autoSurround = source.autoSurround;
1170
		this.autoIndent = source.autoIndent;
1171 1172 1173
		this.useTabStops = source.useTabStops;
		this.tabFocusMode = source.tabFocusMode;
		this.dragAndDrop = source.dragAndDrop;
1174
		this.emptySelectionClipboard = source.emptySelectionClipboard;
1175
		this.copyWithSyntaxHighlighting = source.copyWithSyntaxHighlighting;
1176 1177 1178 1179 1180
		this.layoutInfo = source.layoutInfo;
		this.fontInfo = source.fontInfo;
		this.viewInfo = source.viewInfo;
		this.wrappingInfo = source.wrappingInfo;
		this.contribInfo = source.contribInfo;
1181
		this.showUnused = source.showUnused;
1182 1183 1184 1185 1186 1187 1188
	}

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

	/**
	 * @internal
	 */
	public createChangeEvent(newOpts: InternalEditorOptions): IConfigurationChangedEvent {
		return {
1221
			canUseLayerHinting: (this.canUseLayerHinting !== newOpts.canUseLayerHinting),
1222
			pixelRatio: (this.pixelRatio !== newOpts.pixelRatio),
A
Alex Dima 已提交
1223
			editorClassName: (this.editorClassName !== newOpts.editorClassName),
1224 1225
			lineHeight: (this.lineHeight !== newOpts.lineHeight),
			readOnly: (this.readOnly !== newOpts.readOnly),
1226
			accessibilitySupport: (this.accessibilitySupport !== newOpts.accessibilitySupport),
1227
			multiCursorModifier: (this.multiCursorModifier !== newOpts.multiCursorModifier),
A
Alex Dima 已提交
1228
			multiCursorMergeOverlapping: (this.multiCursorMergeOverlapping !== newOpts.multiCursorMergeOverlapping),
1229 1230
			wordSeparators: (this.wordSeparators !== newOpts.wordSeparators),
			autoClosingBrackets: (this.autoClosingBrackets !== newOpts.autoClosingBrackets),
J
Jackson Kearl 已提交
1231
			autoClosingQuotes: (this.autoClosingQuotes !== newOpts.autoClosingQuotes),
1232
			autoSurround: (this.autoSurround !== newOpts.autoSurround),
1233
			autoIndent: (this.autoIndent !== newOpts.autoIndent),
1234 1235 1236
			useTabStops: (this.useTabStops !== newOpts.useTabStops),
			tabFocusMode: (this.tabFocusMode !== newOpts.tabFocusMode),
			dragAndDrop: (this.dragAndDrop !== newOpts.dragAndDrop),
1237
			emptySelectionClipboard: (this.emptySelectionClipboard !== newOpts.emptySelectionClipboard),
1238
			copyWithSyntaxHighlighting: (this.copyWithSyntaxHighlighting !== newOpts.copyWithSyntaxHighlighting),
A
Alex Dima 已提交
1239
			layoutInfo: (!InternalEditorOptions._equalsLayoutInfo(this.layoutInfo, newOpts.layoutInfo)),
1240
			fontInfo: (!this.fontInfo.equals(newOpts.fontInfo)),
A
Alex Dima 已提交
1241 1242
			viewInfo: (!InternalEditorOptions._equalsViewOptions(this.viewInfo, newOpts.viewInfo)),
			wrappingInfo: (!InternalEditorOptions._equalsWrappingInfo(this.wrappingInfo, newOpts.wrappingInfo)),
1243
			contribInfo: (!InternalEditorOptions._equalsContribOptions(this.contribInfo, newOpts.contribInfo))
1244 1245 1246
		};
	}

A
Alex Dima 已提交
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266
	/**
	 * @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
1267
			&& a.minimapLeft === b.minimapLeft
A
Alex Dima 已提交
1268 1269 1270 1271 1272 1273 1274
			&& a.minimapWidth === b.minimapWidth
			&& a.viewportColumn === b.viewportColumn
			&& a.verticalScrollbarWidth === b.verticalScrollbarWidth
			&& a.horizontalScrollbarHeight === b.horizontalScrollbarHeight
			&& this._equalsOverviewRuler(a.overviewRuler, b.overviewRuler)
		);
	}
1275 1276

	/**
A
Alex Dima 已提交
1277
	 * @internal
1278
	 */
A
Alex Dima 已提交
1279 1280 1281 1282 1283 1284 1285 1286 1287
	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
		);
	}

1288
	/**
A
Alex Dima 已提交
1289
	 * @internal
1290
	 */
A
Alex Dima 已提交
1291 1292
	private static _equalsViewOptions(a: InternalEditorViewOptions, b: InternalEditorViewOptions): boolean {
		return (
1293
			a.extraEditorClassName === b.extraEditorClassName
A
Alex Dima 已提交
1294
			&& a.disableMonospaceOptimizations === b.disableMonospaceOptimizations
1295
			&& arrays.equals(a.rulers, b.rulers)
A
Alex Dima 已提交
1296 1297 1298
			&& a.ariaLabel === b.ariaLabel
			&& a.renderLineNumbers === b.renderLineNumbers
			&& a.renderCustomLineNumbers === b.renderCustomLineNumbers
1299
			&& a.cursorSurroundingLines === b.cursorSurroundingLines
A
Alex Dima 已提交
1300
			&& a.renderFinalNewline === b.renderFinalNewline
A
Alex Dima 已提交
1301 1302 1303 1304 1305 1306 1307 1308
			&& 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
1309
			&& a.cursorSmoothCaretAnimation === b.cursorSmoothCaretAnimation
A
Alex Dima 已提交
1310
			&& a.cursorStyle === b.cursorStyle
1311
			&& a.cursorWidth === b.cursorWidth
A
Alex Dima 已提交
1312 1313
			&& a.hideCursorInOverviewRuler === b.hideCursorInOverviewRuler
			&& a.scrollBeyondLastLine === b.scrollBeyondLastLine
1314
			&& a.scrollBeyondLastColumn === b.scrollBeyondLastColumn
1315
			&& a.smoothScrolling === b.smoothScrolling
A
Alex Dima 已提交
1316 1317 1318 1319 1320
			&& a.stopRenderingLineAfter === b.stopRenderingLineAfter
			&& a.renderWhitespace === b.renderWhitespace
			&& a.renderControlCharacters === b.renderControlCharacters
			&& a.fontLigatures === b.fontLigatures
			&& a.renderIndentGuides === b.renderIndentGuides
A
Alex Dima 已提交
1321
			&& a.highlightActiveIndentGuide === b.highlightActiveIndentGuide
A
Alex Dima 已提交
1322 1323 1324 1325 1326 1327 1328
			&& a.renderLineHighlight === b.renderLineHighlight
			&& this._equalsScrollbarOptions(a.scrollbar, b.scrollbar)
			&& this._equalsMinimapOptions(a.minimap, b.minimap)
			&& a.fixedOverflowWidgets === b.fixedOverflowWidgets
		);
	}

1329
	/**
A
Alex Dima 已提交
1330
	 * @internal
1331
	 */
A
Alex Dima 已提交
1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345
	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 已提交
1346
			&& a.fastScrollSensitivity === b.fastScrollSensitivity
A
Alex Dima 已提交
1347 1348 1349
		);
	}

1350
	/**
A
Alex Dima 已提交
1351
	 * @internal
1352
	 */
A
Alex Dima 已提交
1353 1354 1355
	private static _equalsMinimapOptions(a: InternalEditorMinimapOptions, b: InternalEditorMinimapOptions): boolean {
		return (
			a.enabled === b.enabled
1356
			&& a.side === b.side
1357
			&& a.showSlider === b.showSlider
A
Alex Dima 已提交
1358 1359 1360 1361 1362
			&& a.renderCharacters === b.renderCharacters
			&& a.maxColumn === b.maxColumn
		);
	}

1363 1364 1365 1366 1367 1368
	/**
	 * @internal
	 */
	private static _equalFindOptions(a: InternalEditorFindOptions, b: InternalEditorFindOptions): boolean {
		return (
			a.seedSearchStringFromSelection === b.seedSearchStringFromSelection
R
rebornix 已提交
1369
			&& a.autoFindInSelection === b.autoFindInSelection
1370
			&& a.globalFindClipboard === b.globalFindClipboard
1371
			&& a.addExtraSpaceOnTop === b.addExtraSpaceOnTop
1372 1373 1374
		);
	}

1375 1376 1377 1378 1379 1380 1381 1382 1383 1384
	/**
	 * @internal
	 */
	private static _equalsParameterHintOptions(a: InternalParameterHintOptions, b: InternalParameterHintOptions): boolean {
		return (
			a.enabled === b.enabled
			&& a.cycle === b.cycle
		);
	}

A
Alex Dima 已提交
1385 1386 1387 1388 1389 1390
	/**
	 * @internal
	 */
	private static _equalsHoverOptions(a: InternalEditorHoverOptions, b: InternalEditorHoverOptions): boolean {
		return (
			a.enabled === b.enabled
1391
			&& a.delay === b.delay
1392
			&& a.sticky === b.sticky
A
Alex Dima 已提交
1393 1394 1395
		);
	}

1396 1397 1398
	/**
	 * @internal
	 */
1399
	private static _equalsSuggestOptions(a: InternalSuggestOptions, b: InternalSuggestOptions): any {
1400 1401 1402 1403 1404
		if (a === b) {
			return true;
		} else if (!a || !b) {
			return false;
		} else {
1405 1406
			return a.filterGraceful === b.filterGraceful
				&& a.snippets === b.snippets
J
Johannes Rieken 已提交
1407
				&& a.snippetsPreventQuickSuggestions === b.snippetsPreventQuickSuggestions
1408
				&& a.localityBonus === b.localityBonus
1409 1410
				&& a.shareSuggestSelections === b.shareSuggestSelections
				&& a.showIcons === b.showIcons
J
Johannes Rieken 已提交
1411 1412
				&& a.maxVisibleSuggestions === b.maxVisibleSuggestions
				&& objects.equals(a.filteredTypes, b.filteredTypes);
1413 1414 1415
		}
	}

1416 1417 1418 1419 1420 1421
	private static _equalsGotoLocationOptions(a: InternalGoToLocationOptions | undefined, b: InternalGoToLocationOptions | undefined): boolean {
		if (a === b) {
			return true;
		} else if (!a || !b) {
			return false;
		} else {
J
Johannes Rieken 已提交
1422
			return a.multiple === b.multiple;
1423 1424 1425
		}
	}

1426 1427 1428
	/**
	 * @internal
	 */
A
Alex Dima 已提交
1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440
	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
		);
1441 1442 1443 1444 1445
	}

	/**
	 * @internal
	 */
A
Alex Dima 已提交
1446 1447 1448
	private static _equalsContribOptions(a: EditorContribOptions, b: EditorContribOptions): boolean {
		return (
			a.selectionClipboard === b.selectionClipboard
A
Alex Dima 已提交
1449
			&& this._equalsHoverOptions(a.hover, b.hover)
1450
			&& a.links === b.links
A
Alex Dima 已提交
1451 1452 1453
			&& a.contextmenu === b.contextmenu
			&& InternalEditorOptions._equalsQuickSuggestions(a.quickSuggestions, b.quickSuggestions)
			&& a.quickSuggestionsDelay === b.quickSuggestionsDelay
1454
			&& this._equalsParameterHintOptions(a.parameterHints, b.parameterHints)
A
Alex Dima 已提交
1455 1456 1457 1458 1459 1460
			&& 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 已提交
1461
			&& a.suggestSelection === b.suggestSelection
A
Alex Dima 已提交
1462 1463
			&& a.suggestFontSize === b.suggestFontSize
			&& a.suggestLineHeight === b.suggestLineHeight
1464
			&& a.tabCompletion === b.tabCompletion
1465
			&& this._equalsSuggestOptions(a.suggest, b.suggest)
1466
			&& InternalEditorOptions._equalsGotoLocationOptions(a.gotoLocation, b.gotoLocation)
A
Alex Dima 已提交
1467 1468 1469 1470
			&& a.selectionHighlight === b.selectionHighlight
			&& a.occurrencesHighlight === b.occurrencesHighlight
			&& a.codeLens === b.codeLens
			&& a.folding === b.folding
1471
			&& a.foldingStrategy === b.foldingStrategy
1472
			&& a.showFoldingControls === b.showFoldingControls
A
Alex Dima 已提交
1473
			&& a.matchBrackets === b.matchBrackets
1474
			&& this._equalFindOptions(a.find, b.find)
R
rebornix 已提交
1475
			&& a.colorDecorators === b.colorDecorators
1476 1477
			&& objects.equals(a.codeActionsOnSave, b.codeActionsOnSave)
			&& a.codeActionsOnSaveTimeout === b.codeActionsOnSaveTimeout
1478
			&& a.lightbulbEnabled === b.lightbulbEnabled
A
Alex Dima 已提交
1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491
		);
	}

	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;
		}
1492
		return (
A
Alex Dima 已提交
1493 1494 1495
			a.comments === b.comments
			&& a.other === b.other
			&& a.strings === b.strings
1496 1497 1498 1499
		);
	}
}

A
Alex Dima 已提交
1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
/**
 * 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;
}

1522 1523 1524
/**
 * The internal layout details of the editor.
 */
A
Alex Dima 已提交
1525
export interface EditorLayoutInfo {
1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587

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

1588 1589 1590 1591
	/**
	 * The position for the minimap
	 */
	readonly minimapLeft: number;
1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625
	/**
	 * 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 {
1626
	readonly canUseLayerHinting: boolean;
1627
	readonly pixelRatio: boolean;
A
Alex Dima 已提交
1628
	readonly editorClassName: boolean;
1629 1630
	readonly lineHeight: boolean;
	readonly readOnly: boolean;
1631
	readonly accessibilitySupport: boolean;
1632
	readonly multiCursorModifier: boolean;
A
Alex Dima 已提交
1633
	readonly multiCursorMergeOverlapping: boolean;
1634 1635
	readonly wordSeparators: boolean;
	readonly autoClosingBrackets: boolean;
J
Jackson Kearl 已提交
1636
	readonly autoClosingQuotes: boolean;
1637
	readonly autoSurround: boolean;
1638
	readonly autoIndent: boolean;
1639 1640 1641
	readonly useTabStops: boolean;
	readonly tabFocusMode: boolean;
	readonly dragAndDrop: boolean;
1642
	readonly emptySelectionClipboard: boolean;
1643
	readonly copyWithSyntaxHighlighting: boolean;
1644 1645
	readonly layoutInfo: boolean;
	readonly fontInfo: boolean;
A
Alex Dima 已提交
1646
	readonly viewInfo: boolean;
1647 1648 1649
	readonly wrappingInfo: boolean;
	readonly contribInfo: boolean;
}
1650 1651 1652 1653

/**
 * @internal
 */
A
Alex Dima 已提交
1654 1655 1656 1657
export interface IEnvironmentalOptions {
	readonly outerWidth: number;
	readonly outerHeight: number;
	readonly fontInfo: FontInfo;
1658
	readonly extraEditorClassName: string;
A
Alex Dima 已提交
1659 1660
	readonly isDominatedByLongLines: boolean;
	readonly lineNumbersDigitCount: number;
1661
	readonly emptySelectionClipboard: boolean;
A
Alex Dima 已提交
1662 1663
	readonly pixelRatio: number;
	readonly tabFocusMode: boolean;
1664
	readonly accessibilitySupport: AccessibilitySupport;
1665
}
1666

1667 1668 1669 1670 1671 1672 1673 1674 1675 1676
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);
}
1677

A
Alex Dima 已提交
1678
function _booleanMap(value: { [key: string]: boolean } | undefined, defaultValue: { [key: string]: boolean }): { [key: string]: boolean } {
1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692
	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;
}

1693 1694 1695 1696 1697 1698
function _string(value: any, defaultValue: string): string {
	if (typeof value !== 'string') {
		return defaultValue;
	}
	return value;
}
1699

A
Alex Dima 已提交
1700
function _stringSet<T>(value: T | undefined, defaultValue: T, allowedValues: T[]): T {
1701 1702 1703 1704 1705 1706
	if (typeof value !== 'string') {
		return defaultValue;
	}
	if (allowedValues.indexOf(value) === -1) {
		return defaultValue;
	}
M
Martin Aeschlimann 已提交
1707
	return value;
1708 1709 1710 1711 1712 1713 1714 1715 1716 1717
}

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;
1718
		}
1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732
	}
	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 已提交
1733
function _wrappingIndentFromString(wrappingIndent: string | undefined, defaultValue: WrappingIndent): WrappingIndent {
1734 1735 1736
	if (typeof wrappingIndent !== 'string') {
		return defaultValue;
	}
1737
	if (wrappingIndent === 'same') {
1738
		return WrappingIndent.Same;
1739 1740 1741 1742
	} else if (wrappingIndent === 'indent') {
		return WrappingIndent.Indent;
	} else if (wrappingIndent === 'deepIndent') {
		return WrappingIndent.DeepIndent;
1743 1744 1745 1746 1747
	} else {
		return WrappingIndent.None;
	}
}

A
Alex Dima 已提交
1748
function _cursorBlinkingStyleFromString(cursorBlinkingStyle: string | undefined, defaultValue: TextEditorCursorBlinkingStyle): TextEditorCursorBlinkingStyle {
1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767
	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 已提交
1768
function _scrollbarVisibilityFromString(visibility: string | undefined, defaultValue: ScrollbarVisibility): ScrollbarVisibility {
1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791
	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 已提交
1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804
		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);
1805
		const contribInfo = this._sanitizeContribInfo(opts, defaults.contribInfo);
A
Alex Dima 已提交
1806

A
Alex Dima 已提交
1807
		let configuredMulticursorModifier: 'altKey' | 'metaKey' | 'ctrlKey' | undefined = undefined;
1808
		if (typeof opts.multiCursorModifier === 'string') {
1809 1810
			if (opts.multiCursorModifier === 'ctrlCmd') {
				configuredMulticursorModifier = platform.isMacintosh ? 'metaKey' : 'ctrlKey';
1811
			} else {
1812
				configuredMulticursorModifier = 'altKey';
1813 1814
			}
		}
1815
		const multiCursorModifier = _stringSet<'altKey' | 'metaKey' | 'ctrlKey'>(configuredMulticursorModifier, defaults.multiCursorModifier, ['altKey', 'metaKey', 'ctrlKey']);
1816

1817 1818
		let autoClosingBrackets: EditorAutoClosingStrategy;
		let autoClosingQuotes: EditorAutoClosingStrategy;
1819
		let autoSurround: EditorAutoSurroundStrategy;
A
Alex Dima 已提交
1820
		if (typeof opts.autoClosingBrackets === 'boolean' && opts.autoClosingBrackets === false) {
1821 1822 1823
			// backwards compatibility: disable all on boolean false
			autoClosingBrackets = 'never';
			autoClosingQuotes = 'never';
1824
			autoSurround = 'never';
1825 1826 1827
		} 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 已提交
1828
			autoSurround = _stringSet<EditorAutoSurroundStrategy>(opts.autoSurround, defaults.autoSurround, ['languageDefined', 'brackets', 'quotes', 'never']);
J
Jackson Kearl 已提交
1829 1830
		}

A
Alex Dima 已提交
1831 1832 1833 1834 1835 1836 1837
		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']),
1838
			disableLayerHinting: _boolean(opts.disableLayerHinting, defaults.disableLayerHinting),
A
Alex Dima 已提交
1839 1840 1841 1842 1843 1844 1845 1846
			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),
1847 1848
			autoClosingBrackets,
			autoClosingQuotes,
1849
			autoSurround,
1850
			autoIndent: _boolean(opts.autoIndent, defaults.autoIndent),
A
Alex Dima 已提交
1851
			dragAndDrop: _boolean(opts.dragAndDrop, defaults.dragAndDrop),
1852
			emptySelectionClipboard: _boolean(opts.emptySelectionClipboard, defaults.emptySelectionClipboard),
1853
			copyWithSyntaxHighlighting: _boolean(opts.copyWithSyntaxHighlighting, defaults.copyWithSyntaxHighlighting),
A
Alex Dima 已提交
1854
			useTabStops: _boolean(opts.useTabStops, defaults.useTabStops),
1855
			multiCursorModifier: multiCursorModifier,
A
Alex Dima 已提交
1856
			multiCursorMergeOverlapping: _boolean(opts.multiCursorMergeOverlapping, defaults.multiCursorMergeOverlapping),
1857
			accessibilitySupport: _stringSet<'auto' | 'on' | 'off'>(opts.accessibilitySupport, defaults.accessibilitySupport, ['auto', 'on', 'off']),
1858
			showUnused: _boolean(opts.showUnused, defaults.showUnused),
A
Alex Dima 已提交
1859 1860 1861 1862 1863
			viewInfo: viewInfo,
			contribInfo: contribInfo,
		};
	}

T
Tiago Ribeiro 已提交
1864
	private static _sanitizeScrollbarOpts(opts: IEditorScrollbarOptions | undefined, defaults: InternalEditorScrollbarOptions, mouseWheelScrollSensitivity: number, fastScrollSensitivity: number): InternalEditorScrollbarOptions {
A
Alex Dima 已提交
1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886
		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 已提交
1887 1888
			mouseWheelScrollSensitivity: mouseWheelScrollSensitivity,
			fastScrollSensitivity: fastScrollSensitivity,
A
Alex Dima 已提交
1889 1890 1891
		};
	}

A
Alex Dima 已提交
1892
	private static _sanitizeMinimapOpts(opts: IEditorMinimapOptions | undefined, defaults: InternalEditorMinimapOptions): InternalEditorMinimapOptions {
A
Alex Dima 已提交
1893 1894 1895 1896 1897
		if (typeof opts !== 'object') {
			return defaults;
		}
		return {
			enabled: _boolean(opts.enabled, defaults.enabled),
1898
			side: _stringSet<'right' | 'left'>(opts.side, defaults.side, ['right', 'left']),
1899
			showSlider: _stringSet<'always' | 'mouseover'>(opts.showSlider, defaults.showSlider, ['always', 'mouseover']),
A
Alex Dima 已提交
1900 1901 1902 1903 1904
			renderCharacters: _boolean(opts.renderCharacters, defaults.renderCharacters),
			maxColumn: _clampedInt(opts.maxColumn, defaults.maxColumn, 1, 10000),
		};
	}

B
bissonex 已提交
1905
	private static _sanitizeFindOpts(opts: IEditorFindOptions | undefined, defaults: InternalEditorFindOptions): InternalEditorFindOptions {
1906 1907 1908 1909 1910
		if (typeof opts !== 'object') {
			return defaults;
		}

		return {
R
rebornix 已提交
1911
			seedSearchStringFromSelection: _boolean(opts.seedSearchStringFromSelection, defaults.seedSearchStringFromSelection),
1912
			autoFindInSelection: _boolean(opts.autoFindInSelection, defaults.autoFindInSelection),
1913 1914
			globalFindClipboard: _boolean(opts.globalFindClipboard, defaults.globalFindClipboard),
			addExtraSpaceOnTop: _boolean(opts.addExtraSpaceOnTop, defaults.addExtraSpaceOnTop)
1915 1916 1917
		};
	}

A
Alex Dima 已提交
1918
	private static _sanitizeParameterHintOpts(opts: IEditorParameterHintOptions | undefined, defaults: InternalParameterHintOptions): InternalParameterHintOptions {
1919 1920 1921 1922 1923 1924 1925 1926 1927 1928
		if (typeof opts !== 'object') {
			return defaults;
		}

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

B
bissonex 已提交
1929
	private static _sanitizeHoverOpts(_opts: boolean | IEditorHoverOptions | undefined, defaults: InternalEditorHoverOptions): InternalEditorHoverOptions {
A
Alex Dima 已提交
1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941
		let opts: IEditorHoverOptions;
		if (typeof _opts === 'boolean') {
			opts = {
				enabled: _opts
			};
		} else if (typeof _opts === 'object') {
			opts = _opts;
		} else {
			return defaults;
		}

		return {
1942
			enabled: _boolean(opts.enabled, defaults.enabled),
1943 1944
			delay: _clampedInt(opts.delay, defaults.delay, 0, 10000),
			sticky: _boolean(opts.sticky, defaults.sticky)
A
Alex Dima 已提交
1945 1946 1947
		};
	}

1948
	private static _sanitizeSuggestOpts(opts: IEditorOptions, defaults: InternalSuggestOptions): InternalSuggestOptions {
1949
		const suggestOpts = opts.suggest || {};
1950
		return {
1951
			filterGraceful: _boolean(suggestOpts.filterGraceful, defaults.filterGraceful),
1952
			snippets: _stringSet<'top' | 'bottom' | 'inline' | 'none'>(opts.snippetSuggestions, defaults.snippets, ['top', 'bottom', 'inline', 'none']),
1953
			snippetsPreventQuickSuggestions: _boolean(suggestOpts.snippetsPreventQuickSuggestions, defaults.filterGraceful),
J
Johannes Rieken 已提交
1954
			localityBonus: _boolean(suggestOpts.localityBonus, defaults.localityBonus),
1955 1956
			shareSuggestSelections: _boolean(suggestOpts.shareSuggestSelections, defaults.shareSuggestSelections),
			showIcons: _boolean(suggestOpts.showIcons, defaults.showIcons),
J
Johannes Rieken 已提交
1957
			maxVisibleSuggestions: _clampedInt(suggestOpts.maxVisibleSuggestions, defaults.maxVisibleSuggestions, 1, 15),
1958
			filteredTypes: isObject(suggestOpts.filteredTypes) ? suggestOpts.filteredTypes : Object.create(null)
1959 1960 1961
		};
	}

T
Tony Xia 已提交
1962
	private static _sanitizeGotoLocationOpts(opts: IEditorOptions, defaults: InternalGoToLocationOptions): InternalGoToLocationOptions {
1963 1964
		const gotoOpts = opts.gotoLocation || {};
		return {
J
Johannes Rieken 已提交
1965
			multiple: _stringSet<'peek' | 'gotoAndPeek' | 'goto'>(gotoOpts.multiple, defaults.multiple, ['peek', 'gotoAndPeek', 'goto'])
1966 1967 1968
		};
	}

A
Alex Dima 已提交
1969
	private static _sanitizeTabCompletionOpts(opts: boolean | 'on' | 'off' | 'onlySnippets' | undefined, defaults: 'on' | 'off' | 'onlySnippets'): 'on' | 'off' | 'onlySnippets' {
1970 1971 1972 1973 1974 1975 1976 1977
		if (opts === false) {
			return 'off';
		} else if (opts === true) {
			return 'onlySnippets';
		} else {
			return _stringSet<'on' | 'off' | 'onlySnippets'>(opts, defaults, ['on', 'off', 'onlySnippets']);
		}
	}
1978

A
Alex Dima 已提交
1979
	private static _sanitizeViewInfo(opts: IEditorOptions, defaults: InternalEditorViewOptions): InternalEditorViewOptions {
1980 1981 1982 1983 1984 1985 1986

		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();
1987 1988
		}

1989
		let renderLineNumbers: RenderLineNumbersType = defaults.renderLineNumbers;
A
Alex Dima 已提交
1990
		let renderCustomLineNumbers: ((lineNumber: number) => string) | null = defaults.renderCustomLineNumbers;
1991 1992

		if (typeof opts.lineNumbers !== 'undefined') {
1993
			let lineNumbers = opts.lineNumbers;
1994

1995 1996 1997 1998 1999 2000 2001 2002
			// Compatibility with old true or false values
			if (<any>lineNumbers === true) {
				lineNumbers = 'on';
			} else if (<any>lineNumbers === false) {
				lineNumbers = 'off';
			}

			if (typeof lineNumbers === 'function') {
2003
				renderLineNumbers = RenderLineNumbersType.Custom;
2004
				renderCustomLineNumbers = lineNumbers;
2005 2006
			} else if (lineNumbers === 'interval') {
				renderLineNumbers = RenderLineNumbersType.Interval;
2007
			} else if (lineNumbers === 'relative') {
2008
				renderLineNumbers = RenderLineNumbersType.Relative;
2009
			} else if (lineNumbers === 'on') {
2010
				renderLineNumbers = RenderLineNumbersType.On;
2011
			} else {
2012
				renderLineNumbers = RenderLineNumbersType.Off;
2013 2014 2015
			}
		}

A
Alex Dima 已提交
2016 2017
		const fontLigatures = _boolean(opts.fontLigatures, defaults.fontLigatures);
		const disableMonospaceOptimizations = _boolean(opts.disableMonospaceOptimizations, defaults.disableMonospaceOptimizations) || fontLigatures;
2018 2019 2020 2021 2022 2023 2024 2025 2026

		let renderWhitespace = opts.renderWhitespace;
		{
			// Compatibility with old true or false values
			if (<any>renderWhitespace === true) {
				renderWhitespace = 'boundary';
			} else if (<any>renderWhitespace === false) {
				renderWhitespace = 'none';
			}
2027
			renderWhitespace = _stringSet<'none' | 'boundary' | 'selection' | 'all'>(renderWhitespace, defaults.renderWhitespace, ['none', 'boundary', 'selection', 'all']);
2028 2029 2030 2031 2032 2033 2034 2035 2036 2037
		}

		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 已提交
2038
			renderLineHighlight = _stringSet<'none' | 'gutter' | 'line' | 'all'>(renderLineHighlight, defaults.renderLineHighlight, ['none', 'gutter', 'line', 'all']);
2039 2040
		}

A
Alex Dima 已提交
2041 2042 2043 2044 2045
		let mouseWheelScrollSensitivity = _float(opts.mouseWheelScrollSensitivity, defaults.scrollbar.mouseWheelScrollSensitivity);
		if (mouseWheelScrollSensitivity === 0) {
			// Disallow 0, as it would prevent/block scrolling
			mouseWheelScrollSensitivity = 1;
		}
T
Tiago Ribeiro 已提交
2046 2047 2048

		let fastScrollSensitivity = _float(opts.fastScrollSensitivity, defaults.scrollbar.fastScrollSensitivity);
		if (fastScrollSensitivity <= 0) {
2049
			fastScrollSensitivity = defaults.scrollbar.fastScrollSensitivity;
T
Tiago Ribeiro 已提交
2050 2051
		}
		const scrollbar = this._sanitizeScrollbarOpts(opts.scrollbar, defaults.scrollbar, mouseWheelScrollSensitivity, fastScrollSensitivity);
2052 2053 2054
		const minimap = this._sanitizeMinimapOpts(opts.minimap, defaults.minimap);

		return {
2055
			extraEditorClassName: _string(opts.extraEditorClassName, defaults.extraEditorClassName),
A
Alex Dima 已提交
2056
			disableMonospaceOptimizations: disableMonospaceOptimizations,
2057
			rulers: rulers,
A
Alex Dima 已提交
2058
			ariaLabel: _string(opts.ariaLabel, defaults.ariaLabel),
2059
			cursorSurroundingLines: _clampedInt(opts.cursorSurroundingLines, defaults.cursorWidth, 0, Number.MAX_VALUE),
2060 2061
			renderLineNumbers: renderLineNumbers,
			renderCustomLineNumbers: renderCustomLineNumbers,
A
Alex Dima 已提交
2062
			renderFinalNewline: _boolean(opts.renderFinalNewline, defaults.renderFinalNewline),
2063 2064 2065 2066 2067 2068 2069 2070
			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),
2071
			cursorSmoothCaretAnimation: _boolean(opts.cursorSmoothCaretAnimation, defaults.cursorSmoothCaretAnimation),
2072
			cursorStyle: _cursorStyleFromString(opts.cursorStyle, defaults.cursorStyle),
2073
			cursorWidth: _clampedInt(opts.cursorWidth, defaults.cursorWidth, 0, Number.MAX_VALUE),
2074 2075
			hideCursorInOverviewRuler: _boolean(opts.hideCursorInOverviewRuler, defaults.hideCursorInOverviewRuler),
			scrollBeyondLastLine: _boolean(opts.scrollBeyondLastLine, defaults.scrollBeyondLastLine),
2076
			scrollBeyondLastColumn: _clampedInt(opts.scrollBeyondLastColumn, defaults.scrollBeyondLastColumn, 0, Constants.MAX_SAFE_SMALL_INTEGER),
2077
			smoothScrolling: _boolean(opts.smoothScrolling, defaults.smoothScrolling),
2078
			stopRenderingLineAfter: _clampedInt(opts.stopRenderingLineAfter, defaults.stopRenderingLineAfter, -1, Constants.MAX_SAFE_SMALL_INTEGER),
A
Alex Dima 已提交
2079 2080 2081 2082
			renderWhitespace: renderWhitespace,
			renderControlCharacters: _boolean(opts.renderControlCharacters, defaults.renderControlCharacters),
			fontLigatures: fontLigatures,
			renderIndentGuides: _boolean(opts.renderIndentGuides, defaults.renderIndentGuides),
2083
			highlightActiveIndentGuide: _boolean(opts.highlightActiveIndentGuide, defaults.highlightActiveIndentGuide),
A
Alex Dima 已提交
2084 2085 2086 2087 2088 2089 2090
			renderLineHighlight: renderLineHighlight,
			scrollbar: scrollbar,
			minimap: minimap,
			fixedOverflowWidgets: _boolean(opts.fixedOverflowWidgets, defaults.fixedOverflowWidgets),
		};
	}

2091
	private static _sanitizeContribInfo(opts: IEditorOptions, defaults: EditorContribOptions): EditorContribOptions {
A
Alex Dima 已提交
2092 2093 2094 2095 2096 2097
		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 已提交
2098 2099 2100 2101
		// Compatibility support for acceptSuggestionOnEnter
		if (typeof opts.acceptSuggestionOnEnter === 'boolean') {
			opts.acceptSuggestionOnEnter = opts.acceptSuggestionOnEnter ? 'on' : 'off';
		}
B
bissonex 已提交
2102
		const find = this._sanitizeFindOpts(opts.find, defaults.find);
A
Alex Dima 已提交
2103 2104
		return {
			selectionClipboard: _boolean(opts.selectionClipboard, defaults.selectionClipboard),
B
bissonex 已提交
2105
			hover: this._sanitizeHoverOpts(opts.hover, defaults.hover),
2106
			links: _boolean(opts.links, defaults.links),
2107 2108 2109
			contextmenu: _boolean(opts.contextmenu, defaults.contextmenu),
			quickSuggestions: quickSuggestions,
			quickSuggestionsDelay: _clampedInt(opts.quickSuggestionsDelay, defaults.quickSuggestionsDelay, Constants.MIN_SAFE_SMALL_INTEGER, Constants.MAX_SAFE_SMALL_INTEGER),
2110
			parameterHints: this._sanitizeParameterHintOpts(opts.parameterHints, defaults.parameterHints),
2111 2112 2113
			formatOnType: _boolean(opts.formatOnType, defaults.formatOnType),
			formatOnPaste: _boolean(opts.formatOnPaste, defaults.formatOnPaste),
			suggestOnTriggerCharacters: _boolean(opts.suggestOnTriggerCharacters, defaults.suggestOnTriggerCharacters),
A
Alex Dima 已提交
2114
			acceptSuggestionOnEnter: _stringSet<'on' | 'smart' | 'off'>(opts.acceptSuggestionOnEnter, defaults.acceptSuggestionOnEnter, ['on', 'smart', 'off']),
2115 2116
			acceptSuggestionOnCommitCharacter: _boolean(opts.acceptSuggestionOnCommitCharacter, defaults.acceptSuggestionOnCommitCharacter),
			wordBasedSuggestions: _boolean(opts.wordBasedSuggestions, defaults.wordBasedSuggestions),
B
Benas Svipas 已提交
2117
			suggestSelection: _stringSet<'first' | 'recentlyUsed' | 'recentlyUsedByPrefix'>(opts.suggestSelection, defaults.suggestSelection, ['first', 'recentlyUsed', 'recentlyUsedByPrefix']),
2118 2119
			suggestFontSize: _clampedInt(opts.suggestFontSize, defaults.suggestFontSize, 0, 1000),
			suggestLineHeight: _clampedInt(opts.suggestLineHeight, defaults.suggestLineHeight, 0, 1000),
2120
			tabCompletion: this._sanitizeTabCompletionOpts(opts.tabCompletion, defaults.tabCompletion),
2121
			suggest: this._sanitizeSuggestOpts(opts, defaults.suggest),
T
Tony Xia 已提交
2122
			gotoLocation: this._sanitizeGotoLocationOpts(opts, defaults.gotoLocation),
2123 2124
			selectionHighlight: _boolean(opts.selectionHighlight, defaults.selectionHighlight),
			occurrencesHighlight: _boolean(opts.occurrencesHighlight, defaults.occurrencesHighlight),
2125
			codeLens: _boolean(opts.codeLens, defaults.codeLens),
2126
			folding: _boolean(opts.folding, defaults.folding),
2127
			foldingStrategy: _stringSet<'auto' | 'indentation'>(opts.foldingStrategy, defaults.foldingStrategy, ['auto', 'indentation']),
2128
			showFoldingControls: _stringSet<'always' | 'mouseover'>(opts.showFoldingControls, defaults.showFoldingControls, ['always', 'mouseover']),
2129
			matchBrackets: _boolean(opts.matchBrackets, defaults.matchBrackets),
2130
			find: find,
R
rebornix 已提交
2131
			colorDecorators: _boolean(opts.colorDecorators, defaults.colorDecorators),
2132 2133 2134
			lightbulbEnabled: _boolean(opts.lightbulb ? opts.lightbulb.enabled : false, defaults.lightbulbEnabled),
			codeActionsOnSave: _booleanMap(opts.codeActionsOnSave, {}),
			codeActionsOnSaveTimeout: _clampedInt(opts.codeActionsOnSaveTimeout, defaults.codeActionsOnSaveTimeout, 1, 10000)
2135 2136 2137 2138 2139 2140 2141 2142 2143
		};
	}
}

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

2144 2145 2146
	private static _tweakValidatedOptions(opts: IValidatedEditorOptions, accessibilitySupport: AccessibilitySupport): IValidatedEditorOptions {
		const accessibilityIsOn = (accessibilitySupport === AccessibilitySupport.Enabled);
		const accessibilityIsOff = (accessibilitySupport === AccessibilitySupport.Disabled);
2147 2148 2149 2150 2151 2152 2153
		return {
			inDiffEditor: opts.inDiffEditor,
			wordSeparators: opts.wordSeparators,
			lineNumbersMinChars: opts.lineNumbersMinChars,
			lineDecorationsWidth: opts.lineDecorationsWidth,
			readOnly: opts.readOnly,
			mouseStyle: opts.mouseStyle,
2154
			disableLayerHinting: opts.disableLayerHinting,
2155 2156 2157 2158 2159 2160 2161 2162
			automaticLayout: opts.automaticLayout,
			wordWrap: opts.wordWrap,
			wordWrapColumn: opts.wordWrapColumn,
			wordWrapMinified: opts.wordWrapMinified,
			wrappingIndent: opts.wrappingIndent,
			wordWrapBreakBeforeCharacters: opts.wordWrapBreakBeforeCharacters,
			wordWrapBreakAfterCharacters: opts.wordWrapBreakAfterCharacters,
			wordWrapBreakObtrusiveCharacters: opts.wordWrapBreakObtrusiveCharacters,
2163
			autoClosingBrackets: opts.autoClosingBrackets,
J
Jackson Kearl 已提交
2164
			autoClosingQuotes: opts.autoClosingQuotes,
2165
			autoSurround: opts.autoSurround,
2166
			autoIndent: opts.autoIndent,
2167 2168
			dragAndDrop: opts.dragAndDrop,
			emptySelectionClipboard: opts.emptySelectionClipboard,
2169
			copyWithSyntaxHighlighting: opts.copyWithSyntaxHighlighting,
2170
			useTabStops: opts.useTabStops,
2171
			multiCursorModifier: opts.multiCursorModifier,
A
Alex Dima 已提交
2172
			multiCursorMergeOverlapping: opts.multiCursorMergeOverlapping,
2173
			accessibilitySupport: opts.accessibilitySupport,
2174
			showUnused: opts.showUnused,
2175 2176 2177 2178 2179

			viewInfo: {
				extraEditorClassName: opts.viewInfo.extraEditorClassName,
				disableMonospaceOptimizations: opts.viewInfo.disableMonospaceOptimizations,
				rulers: opts.viewInfo.rulers,
2180
				ariaLabel: (accessibilityIsOff ? nls.localize('accessibilityOffAriaLabel', "The editor is not accessible at this time. Press Alt+F1 for options.") : opts.viewInfo.ariaLabel),
2181 2182
				renderLineNumbers: opts.viewInfo.renderLineNumbers,
				renderCustomLineNumbers: opts.viewInfo.renderCustomLineNumbers,
2183
				cursorSurroundingLines: opts.viewInfo.cursorSurroundingLines,
A
Alex Dima 已提交
2184
				renderFinalNewline: opts.viewInfo.renderFinalNewline,
2185 2186 2187
				selectOnLineNumbers: opts.viewInfo.selectOnLineNumbers,
				glyphMargin: opts.viewInfo.glyphMargin,
				revealHorizontalRightPadding: opts.viewInfo.revealHorizontalRightPadding,
2188
				roundedSelection: (accessibilityIsOn ? false : opts.viewInfo.roundedSelection), // DISABLED WHEN SCREEN READER IS ATTACHED
2189 2190 2191 2192
				overviewRulerLanes: opts.viewInfo.overviewRulerLanes,
				overviewRulerBorder: opts.viewInfo.overviewRulerBorder,
				cursorBlinking: opts.viewInfo.cursorBlinking,
				mouseWheelZoom: opts.viewInfo.mouseWheelZoom,
2193
				cursorSmoothCaretAnimation: opts.viewInfo.cursorSmoothCaretAnimation,
2194
				cursorStyle: opts.viewInfo.cursorStyle,
2195
				cursorWidth: opts.viewInfo.cursorWidth,
2196 2197
				hideCursorInOverviewRuler: opts.viewInfo.hideCursorInOverviewRuler,
				scrollBeyondLastLine: opts.viewInfo.scrollBeyondLastLine,
2198
				scrollBeyondLastColumn: opts.viewInfo.scrollBeyondLastColumn,
2199
				smoothScrolling: opts.viewInfo.smoothScrolling,
2200
				stopRenderingLineAfter: opts.viewInfo.stopRenderingLineAfter,
2201 2202
				renderWhitespace: (accessibilityIsOn ? 'none' : opts.viewInfo.renderWhitespace), // DISABLED WHEN SCREEN READER IS ATTACHED
				renderControlCharacters: (accessibilityIsOn ? false : opts.viewInfo.renderControlCharacters), // DISABLED WHEN SCREEN READER IS ATTACHED
A
Alex Dima 已提交
2203
				fontLigatures: opts.viewInfo.fontLigatures,
2204
				renderIndentGuides: (accessibilityIsOn ? false : opts.viewInfo.renderIndentGuides), // DISABLED WHEN SCREEN READER IS ATTACHED
2205
				highlightActiveIndentGuide: opts.viewInfo.highlightActiveIndentGuide,
A
Alex Dima 已提交
2206
				renderLineHighlight: opts.viewInfo.renderLineHighlight,
2207 2208
				scrollbar: opts.viewInfo.scrollbar,
				minimap: {
2209
					enabled: (accessibilityIsOn ? false : opts.viewInfo.minimap.enabled), // DISABLED WHEN SCREEN READER IS ATTACHED
2210
					side: opts.viewInfo.minimap.side,
2211
					renderCharacters: opts.viewInfo.minimap.renderCharacters,
2212
					showSlider: opts.viewInfo.minimap.showSlider,
2213 2214 2215 2216 2217 2218 2219 2220
					maxColumn: opts.viewInfo.minimap.maxColumn
				},
				fixedOverflowWidgets: opts.viewInfo.fixedOverflowWidgets
			},

			contribInfo: {
				selectionClipboard: opts.contribInfo.selectionClipboard,
				hover: opts.contribInfo.hover,
2221
				links: (accessibilityIsOn ? false : opts.contribInfo.links), // DISABLED WHEN SCREEN READER IS ATTACHED
2222 2223 2224 2225 2226 2227 2228 2229 2230 2231
				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 已提交
2232
				suggestSelection: opts.contribInfo.suggestSelection,
2233 2234
				suggestFontSize: opts.contribInfo.suggestFontSize,
				suggestLineHeight: opts.contribInfo.suggestLineHeight,
2235
				tabCompletion: opts.contribInfo.tabCompletion,
2236
				suggest: opts.contribInfo.suggest,
2237
				gotoLocation: opts.contribInfo.gotoLocation,
2238 2239 2240 2241
				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
2242
				foldingStrategy: opts.contribInfo.foldingStrategy,
2243
				showFoldingControls: opts.contribInfo.showFoldingControls,
2244
				matchBrackets: (accessibilityIsOn ? false : opts.contribInfo.matchBrackets), // DISABLED WHEN SCREEN READER IS ATTACHED
2245
				find: opts.contribInfo.find,
2246
				colorDecorators: opts.contribInfo.colorDecorators,
2247 2248 2249
				lightbulbEnabled: opts.contribInfo.lightbulbEnabled,
				codeActionsOnSave: opts.contribInfo.codeActionsOnSave,
				codeActionsOnSaveTimeout: opts.contribInfo.codeActionsOnSaveTimeout
2250 2251 2252 2253 2254 2255
			}
		};
	}

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

2256
		let accessibilitySupport: AccessibilitySupport;
2257 2258 2259 2260
		if (_opts.accessibilitySupport === 'auto') {
			// The editor reads the `accessibilitySupport` from the environment
			accessibilitySupport = env.accessibilitySupport;
		} else if (_opts.accessibilitySupport === 'on') {
2261
			accessibilitySupport = AccessibilitySupport.Enabled;
2262
		} else {
2263
			accessibilitySupport = AccessibilitySupport.Disabled;
2264 2265
		}

2266 2267
		// Disable some non critical features to get as best performance as possible
		// See https://github.com/Microsoft/vscode/issues/26730
2268
		const opts = this._tweakValidatedOptions(_opts, accessibilitySupport);
2269 2270 2271 2272 2273 2274 2275 2276

		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 已提交
2277
		if (opts.contribInfo.folding) {
2278 2279 2280
			lineDecorationsWidth += 16;
		}

2281 2282 2283
		const layoutInfo = EditorLayoutProvider.compute({
			outerWidth: env.outerWidth,
			outerHeight: env.outerHeight,
A
Alex Dima 已提交
2284
			showGlyphMargin: opts.viewInfo.glyphMargin,
2285
			lineHeight: env.fontInfo.lineHeight,
2286
			showLineNumbers: (opts.viewInfo.renderLineNumbers !== RenderLineNumbersType.Off),
2287
			lineNumbersMinChars: opts.lineNumbersMinChars,
2288 2289 2290 2291
			lineNumbersDigitCount: env.lineNumbersDigitCount,
			lineDecorationsWidth: lineDecorationsWidth,
			typicalHalfwidthCharacterWidth: env.fontInfo.typicalHalfwidthCharacterWidth,
			maxDigitWidth: env.fontInfo.maxDigitWidth,
A
Alex Dima 已提交
2292 2293 2294 2295 2296
			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,
2297
			minimapSide: opts.viewInfo.minimap.side,
A
Alex Dima 已提交
2298 2299
			minimapRenderCharacters: opts.viewInfo.minimap.renderCharacters,
			minimapMaxColumn: opts.viewInfo.minimap.maxColumn,
2300 2301 2302
			pixelRatio: env.pixelRatio
		});

A
Alex Dima 已提交
2303
		let bareWrappingInfo: { isWordWrapMinified: boolean; isViewportWrapping: boolean; wrappingColumn: number; } | null = null;
2304
		{
A
Alex Dima 已提交
2305
			const wordWrap = opts.wordWrap;
2306 2307
			const wordWrapColumn = opts.wordWrapColumn;
			const wordWrapMinified = opts.wordWrapMinified;
2308

2309
			if (accessibilitySupport === AccessibilitySupport.Enabled) {
2310 2311 2312 2313 2314 2315 2316 2317 2318 2319
				// 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) {
2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352
				// 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 已提交
2353
		const wrappingInfo: EditorWrappingInfo = {
2354
			inDiffEditor: opts.inDiffEditor,
2355 2356 2357 2358
			isDominatedByLongLines: env.isDominatedByLongLines,
			isWordWrapMinified: bareWrappingInfo.isWordWrapMinified,
			isViewportWrapping: bareWrappingInfo.isViewportWrapping,
			wrappingColumn: bareWrappingInfo.wrappingColumn,
2359 2360 2361 2362
			wrappingIndent: opts.wrappingIndent,
			wordWrapBreakBeforeCharacters: opts.wordWrapBreakBeforeCharacters,
			wordWrapBreakAfterCharacters: opts.wordWrapBreakAfterCharacters,
			wordWrapBreakObtrusiveCharacters: opts.wordWrapBreakObtrusiveCharacters,
A
Alex Dima 已提交
2363
		};
2364

2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380
		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';
		}

2381
		return new InternalEditorOptions({
2382
			canUseLayerHinting: opts.disableLayerHinting ? false : true,
2383
			pixelRatio: env.pixelRatio,
2384
			editorClassName: className,
A
Alex Dima 已提交
2385
			lineHeight: env.fontInfo.lineHeight,
2386
			readOnly: opts.readOnly,
2387
			accessibilitySupport: accessibilitySupport,
2388
			multiCursorModifier: opts.multiCursorModifier,
A
Alex Dima 已提交
2389
			multiCursorMergeOverlapping: opts.multiCursorMergeOverlapping,
2390 2391
			wordSeparators: opts.wordSeparators,
			autoClosingBrackets: opts.autoClosingBrackets,
J
Jackson Kearl 已提交
2392
			autoClosingQuotes: opts.autoClosingQuotes,
2393
			autoSurround: opts.autoSurround,
2394
			autoIndent: opts.autoIndent,
2395 2396 2397
			useTabStops: opts.useTabStops,
			tabFocusMode: opts.readOnly ? true : env.tabFocusMode,
			dragAndDrop: opts.dragAndDrop,
2398
			emptySelectionClipboard: opts.emptySelectionClipboard && env.emptySelectionClipboard,
2399
			copyWithSyntaxHighlighting: opts.copyWithSyntaxHighlighting,
2400 2401
			layoutInfo: layoutInfo,
			fontInfo: env.fontInfo,
A
Alex Dima 已提交
2402
			viewInfo: opts.viewInfo,
2403
			wrappingInfo: wrappingInfo,
2404 2405
			contribInfo: opts.contribInfo,
			showUnused: opts.showUnused,
2406 2407 2408 2409 2410 2411 2412 2413
		});
	}
}

/**
 * @internal
 */
export interface IEditorLayoutProviderOpts {
M
Matt Bierner 已提交
2414 2415
	readonly outerWidth: number;
	readonly outerHeight: number;
2416

M
Matt Bierner 已提交
2417 2418
	readonly showGlyphMargin: boolean;
	readonly lineHeight: number;
2419

M
Matt Bierner 已提交
2420 2421 2422
	readonly showLineNumbers: boolean;
	readonly lineNumbersMinChars: number;
	readonly lineNumbersDigitCount: number;
2423

M
Matt Bierner 已提交
2424
	readonly lineDecorationsWidth: number;
2425

M
Matt Bierner 已提交
2426 2427
	readonly typicalHalfwidthCharacterWidth: number;
	readonly maxDigitWidth: number;
2428

M
Matt Bierner 已提交
2429 2430 2431 2432
	readonly verticalScrollbarWidth: number;
	readonly verticalScrollbarHasArrows: boolean;
	readonly scrollbarArrowSize: number;
	readonly horizontalScrollbarHeight: number;
2433

M
Matt Bierner 已提交
2434 2435 2436 2437 2438
	readonly minimap: boolean;
	readonly minimapSide: string;
	readonly minimapRenderCharacters: boolean;
	readonly minimapMaxColumn: number;
	readonly pixelRatio: number;
2439 2440 2441 2442 2443 2444 2445 2446 2447
}

/**
 * @internal
 */
export class EditorLayoutProvider {
	public static compute(_opts: IEditorLayoutProviderOpts): EditorLayoutInfo {
		const outerWidth = _opts.outerWidth | 0;
		const outerHeight = _opts.outerHeight | 0;
A
Alex Dima 已提交
2448
		const showGlyphMargin = _opts.showGlyphMargin;
2449
		const lineHeight = _opts.lineHeight | 0;
A
Alex Dima 已提交
2450
		const showLineNumbers = _opts.showLineNumbers;
2451 2452 2453
		const lineNumbersMinChars = _opts.lineNumbersMinChars | 0;
		const lineNumbersDigitCount = _opts.lineNumbersDigitCount | 0;
		const lineDecorationsWidth = _opts.lineDecorationsWidth | 0;
A
Alex Dima 已提交
2454 2455
		const typicalHalfwidthCharacterWidth = _opts.typicalHalfwidthCharacterWidth;
		const maxDigitWidth = _opts.maxDigitWidth;
A
Alex Dima 已提交
2456
		const verticalScrollbarWidth = _opts.verticalScrollbarWidth | 0;
A
Alex Dima 已提交
2457
		const verticalScrollbarHasArrows = _opts.verticalScrollbarHasArrows;
2458 2459
		const scrollbarArrowSize = _opts.scrollbarArrowSize | 0;
		const horizontalScrollbarHeight = _opts.horizontalScrollbarHeight | 0;
A
Alex Dima 已提交
2460
		const minimap = _opts.minimap;
2461
		const minimapSide = _opts.minimapSide;
A
Alex Dima 已提交
2462
		const minimapRenderCharacters = _opts.minimapRenderCharacters;
2463
		const minimapMaxColumn = _opts.minimapMaxColumn | 0;
A
Alex Dima 已提交
2464
		const pixelRatio = _opts.pixelRatio;
2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476

		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 已提交
2477 2478 2479 2480 2481
		let glyphMarginLeft = 0;
		let lineNumbersLeft = glyphMarginLeft + glyphMarginWidth;
		let decorationsLeft = lineNumbersLeft + lineNumbersWidth;
		let contentLeft = decorationsLeft + lineDecorationsWidth;

2482 2483 2484
		const remainingWidth = outerWidth - glyphMarginWidth - lineNumbersWidth - lineDecorationsWidth;

		let renderMinimap: RenderMinimap;
2485
		let minimapLeft: number;
2486 2487 2488
		let minimapWidth: number;
		let contentWidth: number;
		if (!minimap) {
2489
			minimapLeft = 0;
2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503
			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:
2504 2505
			// (leaving 2px for the cursor to have space after the last character)
			// viewportColumn = (contentWidth - verticalScrollbarWidth - 2) / typicalHalfwidthCharacterWidth
2506 2507 2508 2509
			// minimapWidth = viewportColumn * minimapCharWidth
			// contentWidth = remainingWidth - minimapWidth
			// What are good values for contentWidth and minimapWidth ?

2510 2511 2512 2513 2514
			// 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)
2515

2516
			minimapWidth = Math.max(0, Math.floor(((remainingWidth - verticalScrollbarWidth - 2) * minimapCharWidth) / (typicalHalfwidthCharacterWidth + minimapCharWidth)));
2517 2518 2519 2520 2521
			let minimapColumns = minimapWidth / minimapCharWidth;
			if (minimapColumns > minimapMaxColumn) {
				minimapWidth = Math.floor(minimapMaxColumn * minimapCharWidth);
			}
			contentWidth = remainingWidth - minimapWidth;
2522

A
Alex Dima 已提交
2523
			if (minimapSide === 'left') {
2524
				minimapLeft = 0;
A
Alex Dima 已提交
2525 2526 2527 2528
				glyphMarginLeft += minimapWidth;
				lineNumbersLeft += minimapWidth;
				decorationsLeft += minimapWidth;
				contentLeft += minimapWidth;
2529 2530
			} else {
				minimapLeft = outerWidth - minimapWidth - verticalScrollbarWidth;
2531
			}
2532 2533
		}

2534 2535
		// (leaving 2px for the cursor to have space after the last character)
		const viewportColumn = Math.max(1, Math.floor((contentWidth - verticalScrollbarWidth - 2) / typicalHalfwidthCharacterWidth));
2536 2537 2538

		const verticalArrowSize = (verticalScrollbarHasArrows ? scrollbarArrowSize : 0);

A
Alex Dima 已提交
2539
		return {
2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559
			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,
2560
			minimapLeft: minimapLeft,
2561 2562 2563 2564 2565 2566 2567
			minimapWidth: minimapWidth,

			viewportColumn: viewportColumn,

			verticalScrollbarWidth: verticalScrollbarWidth,
			horizontalScrollbarHeight: horizontalScrollbarHeight,

A
Alex Dima 已提交
2568
			overviewRuler: {
2569 2570 2571 2572
				top: verticalArrowSize,
				width: verticalScrollbarWidth,
				height: (outerHeight - 2 * verticalArrowSize),
				right: 0
A
Alex Dima 已提交
2573 2574
			}
		};
2575 2576
	}
}
2577 2578 2579

const DEFAULT_WINDOWS_FONT_FAMILY = 'Consolas, \'Courier New\', monospace';
const DEFAULT_MAC_FONT_FAMILY = 'Menlo, Monaco, \'Courier New\', monospace';
2580
const DEFAULT_LINUX_FONT_FAMILY = '\'Droid Sans Mono\', \'monospace\', monospace, \'Droid Sans Fallback\'';
2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593

/**
 * @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,
2594
	letterSpacing: 0,
2595 2596 2597 2598 2599 2600 2601
};

/**
 * @internal
 */
export const EDITOR_MODEL_DEFAULTS = {
	tabSize: 4,
D
David Lechner 已提交
2602
	indentSize: 4,
2603 2604
	insertSpaces: true,
	detectIndentation: true,
2605
	trimAutoWhitespace: true,
2606
	largeFileOptimizations: true
2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618
};

/**
 * @internal
 */
export const EDITOR_DEFAULTS: IValidatedEditorOptions = {
	inDiffEditor: false,
	wordSeparators: USUAL_WORD_SEPARATORS,
	lineNumbersMinChars: 5,
	lineDecorationsWidth: 10,
	readOnly: false,
	mouseStyle: 'text',
2619
	disableLayerHinting: false,
2620 2621 2622 2623 2624 2625
	automaticLayout: false,
	wordWrap: 'off',
	wordWrapColumn: 80,
	wordWrapMinified: true,
	wrappingIndent: WrappingIndent.Same,
	wordWrapBreakBeforeCharacters: '([{‘“〈《「『【〔([{「£¥$£¥++',
2626
	wordWrapBreakAfterCharacters: ' \t})]?|/&,;¢°′″‰℃、。。、¢,.:;?!%・・ゝゞヽヾーァィゥェォッャュョヮヵヶぁぃぅぇぉっゃゅょゎゕゖㇰㇱㇲㇳㇴㇵㇶㇷㇸㇹㇺㇻㇼㇽㇾㇿ々〻ァィゥェォャュョッー”〉》」』】〕)]}」',
2627
	wordWrapBreakObtrusiveCharacters: '.',
J
Jackson Kearl 已提交
2628 2629
	autoClosingBrackets: 'languageDefined',
	autoClosingQuotes: 'languageDefined',
2630
	autoSurround: 'languageDefined',
R
rebornix 已提交
2631
	autoIndent: true,
2632
	dragAndDrop: true,
2633
	emptySelectionClipboard: true,
2634
	copyWithSyntaxHighlighting: true,
2635
	useTabStops: true,
2636
	multiCursorModifier: 'altKey',
A
Alex Dima 已提交
2637
	multiCursorMergeOverlapping: true,
2638
	accessibilitySupport: 'auto',
2639
	showUnused: true,
A
Alex Dima 已提交
2640 2641

	viewInfo: {
2642
		extraEditorClassName: '',
A
Alex Dima 已提交
2643 2644 2645
		disableMonospaceOptimizations: false,
		rulers: [],
		ariaLabel: nls.localize('editorViewAccessibleLabel', "Editor content"),
2646
		renderLineNumbers: RenderLineNumbersType.On,
A
Alex Dima 已提交
2647
		renderCustomLineNumbers: null,
2648
		cursorSurroundingLines: 0,
2649
		renderFinalNewline: true,
A
Alex Dima 已提交
2650 2651 2652 2653 2654 2655 2656 2657
		selectOnLineNumbers: true,
		glyphMargin: true,
		revealHorizontalRightPadding: 30,
		roundedSelection: true,
		overviewRulerLanes: 2,
		overviewRulerBorder: true,
		cursorBlinking: TextEditorCursorBlinkingStyle.Blink,
		mouseWheelZoom: false,
2658
		cursorSmoothCaretAnimation: false,
A
Alex Dima 已提交
2659
		cursorStyle: TextEditorCursorStyle.Line,
2660
		cursorWidth: 0,
A
Alex Dima 已提交
2661 2662
		hideCursorInOverviewRuler: false,
		scrollBeyondLastLine: true,
2663
		scrollBeyondLastColumn: 5,
2664
		smoothScrolling: false,
A
Alex Dima 已提交
2665 2666 2667 2668
		stopRenderingLineAfter: 10000,
		renderWhitespace: 'none',
		renderControlCharacters: false,
		fontLigatures: false,
2669
		renderIndentGuides: true,
2670
		highlightActiveIndentGuide: true,
A
Alex Dima 已提交
2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684
		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 已提交
2685
			fastScrollSensitivity: 5,
A
Alex Dima 已提交
2686 2687
		},
		minimap: {
2688
			enabled: true,
2689
			side: 'right',
2690
			showSlider: 'mouseover',
A
Alex Dima 已提交
2691 2692 2693 2694 2695 2696 2697 2698
			renderCharacters: true,
			maxColumn: 120
		},
		fixedOverflowWidgets: false,
	},

	contribInfo: {
		selectionClipboard: true,
A
Alex Dima 已提交
2699
		hover: {
2700
			enabled: true,
2701 2702
			delay: 300,
			sticky: true
A
Alex Dima 已提交
2703
		},
2704
		links: true,
A
Alex Dima 已提交
2705 2706 2707
		contextmenu: true,
		quickSuggestions: { other: true, comments: false, strings: false },
		quickSuggestionsDelay: 10,
2708 2709 2710 2711
		parameterHints: {
			enabled: true,
			cycle: false
		},
A
Alex Dima 已提交
2712
		formatOnType: false,
2713
		formatOnPaste: false,
A
Alex Dima 已提交
2714
		suggestOnTriggerCharacters: true,
2715
		acceptSuggestionOnEnter: 'on',
A
Alex Dima 已提交
2716 2717
		acceptSuggestionOnCommitCharacter: true,
		wordBasedSuggestions: true,
B
Benas Svipas 已提交
2718
		suggestSelection: 'recentlyUsed',
A
Alex Dima 已提交
2719 2720
		suggestFontSize: 0,
		suggestLineHeight: 0,
2721
		tabCompletion: 'off',
2722 2723
		suggest: {
			filterGraceful: true,
2724
			snippets: 'inline',
J
Johannes Rieken 已提交
2725
			snippetsPreventQuickSuggestions: true,
2726
			localityBonus: false,
2727 2728
			shareSuggestSelections: false,
			showIcons: true,
J
Johannes Rieken 已提交
2729
			maxVisibleSuggestions: 12,
2730
			filteredTypes: Object.create(null)
2731
		},
2732
		gotoLocation: {
J
Johannes Rieken 已提交
2733
			multiple: 'peek'
2734
		},
A
Alex Dima 已提交
2735 2736 2737 2738
		selectionHighlight: true,
		occurrencesHighlight: true,
		codeLens: true,
		folding: true,
2739
		foldingStrategy: 'auto',
2740
		showFoldingControls: 'mouseover',
A
Alex Dima 已提交
2741
		matchBrackets: true,
2742
		find: {
R
rebornix 已提交
2743
			seedSearchStringFromSelection: true,
2744
			autoFindInSelection: false,
2745 2746
			globalFindClipboard: false,
			addExtraSpaceOnTop: true
2747
		},
2748
		colorDecorators: true,
2749 2750 2751
		lightbulbEnabled: true,
		codeActionsOnSave: {},
		codeActionsOnSaveTimeout: 750
A
Alex Dima 已提交
2752
	},
2753
};