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

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

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

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

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

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

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

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

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

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

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

	/**
	 * Enable using global storage for remembering suggestions.
	 */
205
	shareSuggestSelections?: boolean;
206 207
}

208 209 210 211 212 213 214
/**
 * Configuration map for codeActionsOnSave
 */
export interface ICodeActionsOnSaveOptions {
	[kind: string]: boolean;
}

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

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

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

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

/**
 * The kind of animation in which the editor's cursor should be rendered.
 */
763
export const enum TextEditorCursorBlinkingStyle {
764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788
	/**
	 * 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
}
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
/**
 * @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');
	}
}
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858

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

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

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

A
Alex Dima 已提交
913 914
export interface InternalEditorHoverOptions {
	readonly enabled: boolean;
915
	readonly delay: number;
916
	readonly sticky: boolean;
A
Alex Dima 已提交
917 918
}

919 920
export interface InternalSuggestOptions {
	readonly filterGraceful: boolean;
921
	readonly snippets: 'top' | 'bottom' | 'inline' | 'none';
922
	readonly snippetsPreventQuickSuggestions: boolean;
J
Johannes Rieken 已提交
923
	readonly localityBonus: boolean;
J
Johannes Rieken 已提交
924
	readonly shareSuggestSelections: boolean;
925 926
}

927 928 929 930 931
export interface InternalParameterHintOptions {
	readonly enabled: boolean;
	readonly cycle: boolean;
}

A
Alex Dima 已提交
932
export interface EditorWrappingInfo {
933 934 935 936 937 938 939 940 941 942 943
	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;
}

944 945 946 947
export const enum RenderLineNumbersType {
	Off = 0,
	On = 1,
	Relative = 2,
948 949
	Interval = 3,
	Custom = 4
950 951
}

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

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

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

	readonly viewInfo: InternalEditorViewOptions;
	readonly contribInfo: EditorContribOptions;
}

1059 1060 1061 1062 1063 1064
/**
 * Internal configuration options (transformed or computed) for the editor.
 */
export class InternalEditorOptions {
	readonly _internalEditorOptionsBrand: void;

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

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

1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
	// ---- grouped options
	readonly layoutInfo: EditorLayoutInfo;
	readonly fontInfo: FontInfo;
	readonly viewInfo: InternalEditorViewOptions;
	readonly wrappingInfo: EditorWrappingInfo;
	readonly contribInfo: EditorContribOptions;

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

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

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

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

	/**
A
Alex Dima 已提交
1245
	 * @internal
1246
	 */
A
Alex Dima 已提交
1247 1248 1249 1250 1251 1252 1253 1254 1255
	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
		);
	}

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

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

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

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

1342 1343 1344 1345 1346 1347 1348 1349 1350 1351
	/**
	 * @internal
	 */
	private static _equalsParameterHintOptions(a: InternalParameterHintOptions, b: InternalParameterHintOptions): boolean {
		return (
			a.enabled === b.enabled
			&& a.cycle === b.cycle
		);
	}

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

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

1380 1381 1382
	/**
	 * @internal
	 */
A
Alex Dima 已提交
1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394
	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
		);
1395 1396 1397 1398 1399
	}

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

	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;
		}
1446
		return (
A
Alex Dima 已提交
1447 1448 1449
			a.comments === b.comments
			&& a.other === b.other
			&& a.strings === b.strings
1450 1451 1452 1453
		);
	}
}

A
Alex Dima 已提交
1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475
/**
 * 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;
}

1476 1477 1478
/**
 * The internal layout details of the editor.
 */
A
Alex Dima 已提交
1479
export interface EditorLayoutInfo {
1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541

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

1542 1543 1544 1545
	/**
	 * The position for the minimap
	 */
	readonly minimapLeft: number;
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
	/**
	 * 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 {
1580
	readonly canUseLayerHinting: boolean;
1581
	readonly pixelRatio: boolean;
A
Alex Dima 已提交
1582
	readonly editorClassName: boolean;
1583 1584
	readonly lineHeight: boolean;
	readonly readOnly: boolean;
1585
	readonly accessibilitySupport: boolean;
1586
	readonly multiCursorModifier: boolean;
A
Alex Dima 已提交
1587
	readonly multiCursorMergeOverlapping: boolean;
1588 1589
	readonly wordSeparators: boolean;
	readonly autoClosingBrackets: boolean;
J
Jackson Kearl 已提交
1590
	readonly autoClosingQuotes: boolean;
1591
	readonly autoSurround: boolean;
1592
	readonly autoIndent: boolean;
1593 1594 1595
	readonly useTabStops: boolean;
	readonly tabFocusMode: boolean;
	readonly dragAndDrop: boolean;
1596
	readonly emptySelectionClipboard: boolean;
1597
	readonly copyWithSyntaxHighlighting: boolean;
1598 1599
	readonly layoutInfo: boolean;
	readonly fontInfo: boolean;
A
Alex Dima 已提交
1600
	readonly viewInfo: boolean;
1601 1602 1603
	readonly wrappingInfo: boolean;
	readonly contribInfo: boolean;
}
1604 1605 1606 1607

/**
 * @internal
 */
A
Alex Dima 已提交
1608 1609 1610 1611
export interface IEnvironmentalOptions {
	readonly outerWidth: number;
	readonly outerHeight: number;
	readonly fontInfo: FontInfo;
1612
	readonly extraEditorClassName: string;
A
Alex Dima 已提交
1613 1614
	readonly isDominatedByLongLines: boolean;
	readonly lineNumbersDigitCount: number;
1615
	readonly emptySelectionClipboard: boolean;
A
Alex Dima 已提交
1616 1617
	readonly pixelRatio: number;
	readonly tabFocusMode: boolean;
1618
	readonly accessibilitySupport: platform.AccessibilitySupport;
1619
}
1620

1621 1622 1623 1624 1625 1626 1627 1628 1629 1630
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);
}
1631

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

1647 1648 1649 1650 1651 1652
function _string(value: any, defaultValue: string): string {
	if (typeof value !== 'string') {
		return defaultValue;
	}
	return value;
}
1653

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

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

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

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

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

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

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

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

B
bissonex 已提交
1859
	private static _sanitizeFindOpts(opts: IEditorFindOptions | undefined, defaults: InternalEditorFindOptions): InternalEditorFindOptions {
1860 1861 1862 1863 1864
		if (typeof opts !== 'object') {
			return defaults;
		}

		return {
R
rebornix 已提交
1865
			seedSearchStringFromSelection: _boolean(opts.seedSearchStringFromSelection, defaults.seedSearchStringFromSelection),
1866
			autoFindInSelection: _boolean(opts.autoFindInSelection, defaults.autoFindInSelection),
1867 1868
			globalFindClipboard: _boolean(opts.globalFindClipboard, defaults.globalFindClipboard),
			addExtraSpaceOnTop: _boolean(opts.addExtraSpaceOnTop, defaults.addExtraSpaceOnTop)
1869 1870 1871
		};
	}

A
Alex Dima 已提交
1872
	private static _sanitizeParameterHintOpts(opts: IEditorParameterHintOptions | undefined, defaults: InternalParameterHintOptions): InternalParameterHintOptions {
1873 1874 1875 1876 1877 1878 1879 1880 1881 1882
		if (typeof opts !== 'object') {
			return defaults;
		}

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

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

		return {
1896
			enabled: _boolean(opts.enabled, defaults.enabled),
1897 1898
			delay: _clampedInt(opts.delay, defaults.delay, 0, 10000),
			sticky: _boolean(opts.sticky, defaults.sticky)
A
Alex Dima 已提交
1899 1900 1901
		};
	}

1902
	private static _sanitizeSuggestOpts(opts: IEditorOptions, defaults: InternalSuggestOptions): InternalSuggestOptions {
1903
		const suggestOpts = opts.suggest || {};
1904
		return {
1905
			filterGraceful: _boolean(suggestOpts.filterGraceful, defaults.filterGraceful),
1906
			snippets: _stringSet<'top' | 'bottom' | 'inline' | 'none'>(opts.snippetSuggestions, defaults.snippets, ['top', 'bottom', 'inline', 'none']),
1907
			snippetsPreventQuickSuggestions: _boolean(suggestOpts.snippetsPreventQuickSuggestions, defaults.filterGraceful),
J
Johannes Rieken 已提交
1908
			localityBonus: _boolean(suggestOpts.localityBonus, defaults.localityBonus),
1909
			shareSuggestSelections: _boolean(suggestOpts.shareSuggestSelections, defaults.shareSuggestSelections)
1910 1911 1912
		};
	}

A
Alex Dima 已提交
1913
	private static _sanitizeTabCompletionOpts(opts: boolean | 'on' | 'off' | 'onlySnippets' | undefined, defaults: 'on' | 'off' | 'onlySnippets'): 'on' | 'off' | 'onlySnippets' {
1914 1915 1916 1917 1918 1919 1920 1921
		if (opts === false) {
			return 'off';
		} else if (opts === true) {
			return 'onlySnippets';
		} else {
			return _stringSet<'on' | 'off' | 'onlySnippets'>(opts, defaults, ['on', 'off', 'onlySnippets']);
		}
	}
1922

A
Alex Dima 已提交
1923
	private static _sanitizeViewInfo(opts: IEditorOptions, defaults: InternalEditorViewOptions): InternalEditorViewOptions {
1924 1925 1926 1927 1928 1929 1930

		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();
1931 1932
		}

1933
		let renderLineNumbers: RenderLineNumbersType = defaults.renderLineNumbers;
A
Alex Dima 已提交
1934
		let renderCustomLineNumbers: ((lineNumber: number) => string) | null = defaults.renderCustomLineNumbers;
1935 1936

		if (typeof opts.lineNumbers !== 'undefined') {
1937
			let lineNumbers = opts.lineNumbers;
1938

1939 1940 1941 1942 1943 1944 1945 1946
			// Compatibility with old true or false values
			if (<any>lineNumbers === true) {
				lineNumbers = 'on';
			} else if (<any>lineNumbers === false) {
				lineNumbers = 'off';
			}

			if (typeof lineNumbers === 'function') {
1947
				renderLineNumbers = RenderLineNumbersType.Custom;
1948
				renderCustomLineNumbers = lineNumbers;
1949 1950
			} else if (lineNumbers === 'interval') {
				renderLineNumbers = RenderLineNumbersType.Interval;
1951
			} else if (lineNumbers === 'relative') {
1952
				renderLineNumbers = RenderLineNumbersType.Relative;
1953
			} else if (lineNumbers === 'on') {
1954
				renderLineNumbers = RenderLineNumbersType.On;
1955
			} else {
1956
				renderLineNumbers = RenderLineNumbersType.Off;
1957 1958 1959
			}
		}

A
Alex Dima 已提交
1960 1961
		const fontLigatures = _boolean(opts.fontLigatures, defaults.fontLigatures);
		const disableMonospaceOptimizations = _boolean(opts.disableMonospaceOptimizations, defaults.disableMonospaceOptimizations) || fontLigatures;
1962 1963 1964 1965 1966 1967 1968 1969 1970

		let renderWhitespace = opts.renderWhitespace;
		{
			// Compatibility with old true or false values
			if (<any>renderWhitespace === true) {
				renderWhitespace = 'boundary';
			} else if (<any>renderWhitespace === false) {
				renderWhitespace = 'none';
			}
A
Alex Dima 已提交
1971
			renderWhitespace = _stringSet<'none' | 'boundary' | 'all'>(renderWhitespace, defaults.renderWhitespace, ['none', 'boundary', 'all']);
1972 1973 1974 1975 1976 1977 1978 1979 1980 1981
		}

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

A
Alex Dima 已提交
1985 1986 1987 1988 1989
		let mouseWheelScrollSensitivity = _float(opts.mouseWheelScrollSensitivity, defaults.scrollbar.mouseWheelScrollSensitivity);
		if (mouseWheelScrollSensitivity === 0) {
			// Disallow 0, as it would prevent/block scrolling
			mouseWheelScrollSensitivity = 1;
		}
T
Tiago Ribeiro 已提交
1990 1991 1992

		let fastScrollSensitivity = _float(opts.fastScrollSensitivity, defaults.scrollbar.fastScrollSensitivity);
		if (fastScrollSensitivity <= 0) {
1993
			fastScrollSensitivity = defaults.scrollbar.fastScrollSensitivity;
T
Tiago Ribeiro 已提交
1994 1995
		}
		const scrollbar = this._sanitizeScrollbarOpts(opts.scrollbar, defaults.scrollbar, mouseWheelScrollSensitivity, fastScrollSensitivity);
1996 1997 1998
		const minimap = this._sanitizeMinimapOpts(opts.minimap, defaults.minimap);

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

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

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

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

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

			contribInfo: {
				selectionClipboard: opts.contribInfo.selectionClipboard,
				hover: opts.contribInfo.hover,
2163
				links: (accessibilityIsOn ? false : opts.contribInfo.links), // DISABLED WHEN SCREEN READER IS ATTACHED
2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174
				contextmenu: opts.contribInfo.contextmenu,
				quickSuggestions: opts.contribInfo.quickSuggestions,
				quickSuggestionsDelay: opts.contribInfo.quickSuggestionsDelay,
				parameterHints: opts.contribInfo.parameterHints,
				iconsInSuggestions: opts.contribInfo.iconsInSuggestions,
				formatOnType: opts.contribInfo.formatOnType,
				formatOnPaste: opts.contribInfo.formatOnPaste,
				suggestOnTriggerCharacters: opts.contribInfo.suggestOnTriggerCharacters,
				acceptSuggestionOnEnter: opts.contribInfo.acceptSuggestionOnEnter,
				acceptSuggestionOnCommitCharacter: opts.contribInfo.acceptSuggestionOnCommitCharacter,
				wordBasedSuggestions: opts.contribInfo.wordBasedSuggestions,
J
Johannes Rieken 已提交
2175
				suggestSelection: opts.contribInfo.suggestSelection,
2176 2177
				suggestFontSize: opts.contribInfo.suggestFontSize,
				suggestLineHeight: opts.contribInfo.suggestLineHeight,
2178
				tabCompletion: opts.contribInfo.tabCompletion,
2179
				suggest: opts.contribInfo.suggest,
2180 2181 2182 2183
				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
2184
				foldingStrategy: opts.contribInfo.foldingStrategy,
2185
				showFoldingControls: opts.contribInfo.showFoldingControls,
2186
				matchBrackets: (accessibilityIsOn ? false : opts.contribInfo.matchBrackets), // DISABLED WHEN SCREEN READER IS ATTACHED
2187
				find: opts.contribInfo.find,
2188
				colorDecorators: opts.contribInfo.colorDecorators,
2189 2190 2191
				lightbulbEnabled: opts.contribInfo.lightbulbEnabled,
				codeActionsOnSave: opts.contribInfo.codeActionsOnSave,
				codeActionsOnSaveTimeout: opts.contribInfo.codeActionsOnSaveTimeout
2192 2193 2194 2195 2196 2197
			}
		};
	}

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

2198 2199 2200 2201 2202 2203 2204 2205 2206 2207
		let accessibilitySupport: platform.AccessibilitySupport;
		if (_opts.accessibilitySupport === 'auto') {
			// The editor reads the `accessibilitySupport` from the environment
			accessibilitySupport = env.accessibilitySupport;
		} else if (_opts.accessibilitySupport === 'on') {
			accessibilitySupport = platform.AccessibilitySupport.Enabled;
		} else {
			accessibilitySupport = platform.AccessibilitySupport.Disabled;
		}

2208 2209
		// Disable some non critical features to get as best performance as possible
		// See https://github.com/Microsoft/vscode/issues/26730
2210
		const opts = this._tweakValidatedOptions(_opts, accessibilitySupport);
2211 2212 2213 2214 2215 2216 2217 2218

		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 已提交
2219
		if (opts.contribInfo.folding) {
2220 2221 2222
			lineDecorationsWidth += 16;
		}

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

A
Alex Dima 已提交
2245
		let bareWrappingInfo: { isWordWrapMinified: boolean; isViewportWrapping: boolean; wrappingColumn: number; } | null = null;
2246
		{
A
Alex Dima 已提交
2247
			const wordWrap = opts.wordWrap;
2248 2249
			const wordWrapColumn = opts.wordWrapColumn;
			const wordWrapMinified = opts.wordWrapMinified;
2250

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

2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322
		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';
		}

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

/**
 * @internal
 */
export interface IEditorLayoutProviderOpts {
M
Matt Bierner 已提交
2356 2357
	readonly outerWidth: number;
	readonly outerHeight: number;
2358

M
Matt Bierner 已提交
2359 2360
	readonly showGlyphMargin: boolean;
	readonly lineHeight: number;
2361

M
Matt Bierner 已提交
2362 2363 2364
	readonly showLineNumbers: boolean;
	readonly lineNumbersMinChars: number;
	readonly lineNumbersDigitCount: number;
2365

M
Matt Bierner 已提交
2366
	readonly lineDecorationsWidth: number;
2367

M
Matt Bierner 已提交
2368 2369
	readonly typicalHalfwidthCharacterWidth: number;
	readonly maxDigitWidth: number;
2370

M
Matt Bierner 已提交
2371 2372 2373 2374
	readonly verticalScrollbarWidth: number;
	readonly verticalScrollbarHasArrows: boolean;
	readonly scrollbarArrowSize: number;
	readonly horizontalScrollbarHeight: number;
2375

M
Matt Bierner 已提交
2376 2377 2378 2379 2380
	readonly minimap: boolean;
	readonly minimapSide: string;
	readonly minimapRenderCharacters: boolean;
	readonly minimapMaxColumn: number;
	readonly pixelRatio: number;
2381 2382 2383 2384 2385 2386 2387 2388 2389
}

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

		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 已提交
2419 2420 2421 2422 2423
		let glyphMarginLeft = 0;
		let lineNumbersLeft = glyphMarginLeft + glyphMarginWidth;
		let decorationsLeft = lineNumbersLeft + lineNumbersWidth;
		let contentLeft = decorationsLeft + lineDecorationsWidth;

2424 2425 2426
		const remainingWidth = outerWidth - glyphMarginWidth - lineNumbersWidth - lineDecorationsWidth;

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

2452 2453 2454 2455 2456
			// 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)
2457

2458
			minimapWidth = Math.max(0, Math.floor(((remainingWidth - verticalScrollbarWidth - 2) * minimapCharWidth) / (typicalHalfwidthCharacterWidth + minimapCharWidth)));
2459 2460 2461 2462 2463
			let minimapColumns = minimapWidth / minimapCharWidth;
			if (minimapColumns > minimapMaxColumn) {
				minimapWidth = Math.floor(minimapMaxColumn * minimapCharWidth);
			}
			contentWidth = remainingWidth - minimapWidth;
2464

A
Alex Dima 已提交
2465
			if (minimapSide === 'left') {
2466
				minimapLeft = 0;
A
Alex Dima 已提交
2467 2468 2469 2470
				glyphMarginLeft += minimapWidth;
				lineNumbersLeft += minimapWidth;
				decorationsLeft += minimapWidth;
				contentLeft += minimapWidth;
2471 2472
			} else {
				minimapLeft = outerWidth - minimapWidth - verticalScrollbarWidth;
2473
			}
2474 2475
		}

2476 2477
		// (leaving 2px for the cursor to have space after the last character)
		const viewportColumn = Math.max(1, Math.floor((contentWidth - verticalScrollbarWidth - 2) / typicalHalfwidthCharacterWidth));
2478 2479 2480

		const verticalArrowSize = (verticalScrollbarHasArrows ? scrollbarArrowSize : 0);

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

			viewportColumn: viewportColumn,

			verticalScrollbarWidth: verticalScrollbarWidth,
			horizontalScrollbarHeight: horizontalScrollbarHeight,

A
Alex Dima 已提交
2510
			overviewRuler: {
2511 2512 2513 2514
				top: verticalArrowSize,
				width: verticalScrollbarWidth,
				height: (outerHeight - 2 * verticalArrowSize),
				right: 0
A
Alex Dima 已提交
2515 2516
			}
		};
2517 2518
	}
}
2519 2520 2521

const DEFAULT_WINDOWS_FONT_FAMILY = 'Consolas, \'Courier New\', monospace';
const DEFAULT_MAC_FONT_FAMILY = 'Menlo, Monaco, \'Courier New\', monospace';
2522
const DEFAULT_LINUX_FONT_FAMILY = '\'Droid Sans Mono\', \'monospace\', monospace, \'Droid Sans Fallback\'';
2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535

/**
 * @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,
2536
	letterSpacing: 0,
2537 2538 2539 2540 2541 2542 2543 2544 2545
};

/**
 * @internal
 */
export const EDITOR_MODEL_DEFAULTS = {
	tabSize: 4,
	insertSpaces: true,
	detectIndentation: true,
2546
	trimAutoWhitespace: true,
2547
	largeFileOptimizations: true
2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559
};

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

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

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