editorOptions.ts 160.0 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 7
import * as nls from 'vs/nls';
import * as platform from 'vs/base/common/platform';
8 9
import { ScrollbarVisibility } from 'vs/base/common/scrollable';
import { FontInfo } from 'vs/editor/common/config/fontInfo';
10
import { Constants } from 'vs/base/common/uint';
11
import { USUAL_WORD_SEPARATORS } from 'vs/editor/common/model/wordHelper';
12
import { AccessibilitySupport } from 'vs/platform/accessibility/common/accessibility';
13
import { IConfigurationPropertySchema } from 'vs/platform/configuration/common/configurationRegistry';
M
Matt Bierner 已提交
14
import { IJSONSchema } from 'vs/base/common/jsonSchema';
15

A
Alex Dima 已提交
16
//#region typed options
17

J
Jackson Kearl 已提交
18
/**
J
Jackson Kearl 已提交
19
 * Configuration options for auto closing quotes and brackets
J
Jackson Kearl 已提交
20
 */
J
Jackson Kearl 已提交
21 22 23 24 25
export type EditorAutoClosingStrategy = 'always' | 'languageDefined' | 'beforeWhitespace' | 'never';

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

28
/**
29
 * Configuration options for typing over closing quotes or brackets
30
 */
31
export type EditorAutoClosingEditStrategy = 'always' | 'auto' | 'never';
32

A
wip  
Alexandru Dima 已提交
33 34 35 36 37 38 39 40 41 42 43
/**
 * Configuration options for auto indentation in the editor
 */
export const enum EditorAutoIndentStrategy {
	None = 0,
	Keep = 1,
	Brackets = 2,
	Advanced = 3,
	Full = 4
}

44 45 46 47 48 49 50 51 52 53 54 55
/**
 * Configuration options for the editor.
 */
export interface IEditorOptions {
	/**
	 * This editor is used inside a diff editor.
	 */
	inDiffEditor?: boolean;
	/**
	 * The aria label for the editor's textarea (when it is focused).
	 */
	ariaLabel?: string;
56 57 58 59
	/**
	 * The `tabindex` property of the editor's textarea
	 */
	tabIndex?: number;
60 61 62 63
	/**
	 * Render vertical lines at the specified columns.
	 * Defaults to empty array.
	 */
64
	rulers?: (number | IRulerOption)[];
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
	/**
	 * 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.
R
rebornix 已提交
80
	 * Defaults to `on`.
81
	 */
A
Alex Dima 已提交
82
	lineNumbers?: LineNumbersType;
P
Peng Lyu 已提交
83
	/**
84
	 * Controls the minimal number of visible leading and trailing lines surrounding the cursor.
P
Peng Lyu 已提交
85 86
	 * Defaults to 0.
	*/
87
	cursorSurroundingLines?: number;
88 89 90 91 92 93
	/**
	 * Controls when `cursorSurroundingLines` should be enforced
	 * Defaults to `default`, `cursorSurroundingLines` is not enforced when cursor position is changed
	 * by mouse.
	*/
	cursorSurroundingLinesStyle?: 'default' | 'all';
A
Alex Dima 已提交
94 95
	/**
	 * Render last line number when the file ends with a newline.
A
Alex Dima 已提交
96
	 * Defaults to true.
97
	*/
A
Alex Dima 已提交
98
	renderFinalNewline?: boolean;
99
	/**
100
	 * Remove unusual line terminators like LINE SEPARATOR (LS), PARAGRAPH SEPARATOR (PS).
101
	 * Defaults to 'prompt'.
102
	 */
103
	unusualLineTerminators?: 'auto' | 'off' | 'prompt';
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
	/**
	 * 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;
	/**
138
	 * Class name to be added to the editor.
139
	 */
140
	extraEditorClassName?: string;
141
	/**
142
	 * Should the editor be read only. See also `domReadOnly`.
143 144 145
	 * Defaults to false.
	 */
	readOnly?: boolean;
146 147 148 149 150
	/**
	 * Should the textarea used for input use the DOM `readonly` attribute.
	 * Defaults to false.
	 */
	domReadOnly?: boolean;
P
Rename  
Pine Wu 已提交
151
	/**
152
	 * Enable linked editing.
P
Rename  
Pine Wu 已提交
153 154
	 * Defaults to false.
	 */
155 156 157 158
	linkedEditing?: boolean;
	/**
	 * deprecated, use linkedEditing instead
	 */
P
Rename  
Pine Wu 已提交
159
	renameOnType?: boolean;
160 161 162 163 164
	/**
	 * Should the editor render validation decorations.
	 * Defaults to editable.
	 */
	renderValidationDecorations?: 'editable' | 'on' | 'off';
165 166 167 168 169 170 171 172
	/**
	 * Control the behavior and rendering of the scrollbars.
	 */
	scrollbar?: IEditorScrollbarOptions;
	/**
	 * Control the behavior and rendering of the minimap.
	 */
	minimap?: IEditorMinimapOptions;
173 174 175 176
	/**
	 * Control the behavior of the find widget.
	 */
	find?: IEditorFindOptions;
177 178 179 180 181 182 183
	/**
	 * Display overflow widgets as `fixed`.
	 * Defaults to `false`.
	 */
	fixedOverflowWidgets?: boolean;
	/**
	 * The number of vertical lanes the overview ruler should render.
184
	 * Defaults to 3.
185 186 187 188 189 190 191 192 193 194 195
	 */
	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'.
	 */
A
Alex Dima 已提交
196
	cursorBlinking?: 'blink' | 'smooth' | 'phase' | 'expand' | 'solid';
197 198 199 200 201 202 203 204 205 206
	/**
	 * 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'
	 */
	mouseStyle?: 'text' | 'default' | 'copy';
207 208 209 210 211
	/**
	 * Enable smooth caret animation.
	 * Defaults to false.
	 */
	cursorSmoothCaretAnimation?: boolean;
212 213 214 215
	/**
	 * Control the cursor style, either 'block' or 'line'.
	 * Defaults to 'line'.
	 */
A
Alex Dima 已提交
216
	cursorStyle?: 'line' | 'block' | 'underline' | 'line-thin' | 'block-outline' | 'underline-thin';
217 218 219
	/**
	 * Control the width of the cursor when cursorStyle is set to 'line'
	 */
220
	cursorWidth?: number;
221 222 223 224
	/**
	 * Enable font ligatures.
	 * Defaults to false.
	 */
225
	fontLigatures?: boolean | string;
226
	/**
227 228
	 * Disable the use of `transform: translate3d(0px, 0px, 0px)` for the editor margin and lines layers.
	 * The usage of `transform: translate3d(0px, 0px, 0px)` acts as a hint for browsers to create an extra layer.
229 230
	 * Defaults to false.
	 */
231
	disableLayerHinting?: boolean;
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
	/**
	 * 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;
247 248 249 250 251
	/**
	 * Enable that scrolling can go beyond the last column by a number of columns.
	 * Defaults to 5.
	 */
	scrollBeyondLastColumn?: number;
252 253
	/**
	 * Enable that the editor animates scrolling to a position.
254
	 * Defaults to false.
255 256
	 */
	smoothScrolling?: boolean;
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
	/**
	 * 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';
272 273 274 275 276 277 278 279
	/**
	 * Override the `wordWrap` setting.
	 */
	wordWrapOverride1?: 'off' | 'on' | 'inherit';
	/**
	 * Override the `wordWrapOverride1` setting.
	 */
	wordWrapOverride2?: 'off' | 'on' | 'inherit';
280 281 282 283 284 285 286 287 288 289
	/**
	 * 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;
	/**
290
	 * Control indentation of wrapped lines. Can be: 'none', 'same', 'indent' or 'deepIndent'.
291 292
	 * Defaults to 'same' in vscode and to 'none' in monaco-editor.
	 */
A
Alex Dima 已提交
293
	wrappingIndent?: 'none' | 'same' | 'indent' | 'deepIndent';
294
	/**
295 296
	 * Controls the wrapping strategy to use.
	 * Defaults to 'simple'.
297
	 */
298
	wrappingStrategy?: 'simple' | 'advanced';
299 300
	/**
	 * Configure word wrapping characters. A break will be introduced before these characters.
301
	 * Defaults to '([{‘“〈《「『【〔([{「£¥$£¥++'.
302 303 304 305
	 */
	wordWrapBreakBeforeCharacters?: string;
	/**
	 * Configure word wrapping characters. A break will be introduced after these characters.
306
	 * Defaults to ' \t})]?|/&.,;¢°′″‰℃、。。、¢,.:;?!%・・ゝゞヽヾーァィゥェォッャュョヮヵヶぁぃぅぇぉっゃゅょゎゕゖㇰㇱㇲㇳㇴㇵㇶㇷㇸㇹㇺㇻㇼㇽㇾㇿ々〻ァィゥェォャュョッー”〉》」』】〕)]}」'.
307 308 309 310 311 312 313 314 315
	 */
	wordWrapBreakAfterCharacters?: string;
	/**
	 * Performance guard: Stop rendering a line after x characters.
	 * Defaults to 10000.
	 * Use -1 to never stop rendering
	 */
	stopRenderingLineAfter?: number;
	/**
A
Alex Dima 已提交
316
	 * Configure the editor's hover.
317
	 */
A
Alex Dima 已提交
318
	hover?: IEditorHoverOptions;
319 320 321 322 323
	/**
	 * Enable detecting links and making them clickable.
	 * Defaults to true.
	 */
	links?: boolean;
324
	/**
325
	 * Enable inline color decorators and color picker rendering.
326
	 */
R
rebornix 已提交
327
	colorDecorators?: boolean;
A
Alex Dima 已提交
328 329 330 331
	/**
	 * Control the behaviour of comments in the editor.
	 */
	comments?: IEditorCommentsOptions;
332 333 334 335 336 337 338 339 340 341
	/**
	 * 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 已提交
342
	/**
343 344
	 * FastScrolling mulitplier speed when pressing `Alt`
	 * Defaults to 5.
T
Tiago Ribeiro 已提交
345 346
	 */
	fastScrollSensitivity?: number;
347 348 349 350
	/**
	 * Enable that the editor scrolls only the predominant axis. Prevents horizontal drift when scrolling vertically on a trackpad.
	 * Defaults to true.
	 */
351
	scrollPredominantAxis?: boolean;
352 353 354 355 356
	/**
	 * Enable that the selection with the mouse and keys is doing column selection.
	 * Defaults to false.
	 */
	columnSelection?: boolean;
357 358 359 360
	/**
	 * The modifier to be used to add multiple cursors with the mouse.
	 * Defaults to 'alt'
	 */
361
	multiCursorModifier?: 'ctrlCmd' | 'alt';
362
	/**
A
Alex Dima 已提交
363
	 * Merge overlapping selections.
364 365
	 * Defaults to true
	 */
A
Alex Dima 已提交
366
	multiCursorMergeOverlapping?: boolean;
367 368 369 370 371
	/**
	 * Configure the behaviour when pasting a text with the line count equal to the cursor count.
	 * Defaults to 'spread'.
	 */
	multiCursorPaste?: 'spread' | 'full';
372 373 374 375 376
	/**
	 * Configure the editor's accessibility support.
	 * Defaults to 'auto'. It is best to leave this to 'auto'.
	 */
	accessibilitySupport?: 'auto' | 'off' | 'on';
I
isidor 已提交
377 378 379
	/**
	 * Controls the number of lines in the editor that can be read out by a screen reader
	 */
I
isidor 已提交
380
	accessibilityPageSize?: number;
381 382 383 384
	/**
	 * Suggest options.
	 */
	suggest?: ISuggestOptions;
385
	inlineSuggest?: IInlineSuggestOptions;
386
	/**
A
Alex Dima 已提交
387
	 * Smart select options.
388 389
	 */
	smartSelect?: ISmartSelectOptions;
390 391 392 393
	/**
	 *
	 */
	gotoLocation?: IGotoLocationOptions;
394 395 396 397
	/**
	 * Enable quick suggestions (shadow suggestions)
	 * Defaults to true.
	 */
A
Alex Dima 已提交
398
	quickSuggestions?: boolean | IQuickSuggestionsOptions;
399 400
	/**
	 * Quick suggestions show delay (in ms)
A
Alex Dima 已提交
401
	 * Defaults to 10 (ms)
402 403
	 */
	quickSuggestionsDelay?: number;
B
Bailey 已提交
404
	/**
B
Bailey 已提交
405
	 * Controls the spacing around the editor.
B
Bailey 已提交
406
	 */
B
Bailey 已提交
407
	padding?: IEditorPaddingOptions;
408
	/**
409
	 * Parameter hint options.
410
	 */
411
	parameterHints?: IEditorParameterHintOptions;
412
	/**
413
	 * Options for auto closing brackets.
414
	 * Defaults to language defined behavior.
415
	 */
J
Jackson Kearl 已提交
416
	autoClosingBrackets?: EditorAutoClosingStrategy;
417
	/**
418
	 * Options for auto closing quotes.
419
	 * Defaults to language defined behavior.
J
Jackson Kearl 已提交
420 421
	 */
	autoClosingQuotes?: EditorAutoClosingStrategy;
422 423 424 425
	/**
	 * Options for pressing backspace near quotes or bracket pairs.
	 */
	autoClosingDelete?: EditorAutoClosingEditStrategy;
426 427 428
	/**
	 * Options for typing over closing quotes or brackets.
	 */
429
	autoClosingOvertype?: EditorAutoClosingEditStrategy;
J
Jackson Kearl 已提交
430
	/**
431 432
	 * Options for auto surrounding.
	 * Defaults to always allowing auto surrounding.
433
	 */
434
	autoSurround?: EditorAutoSurroundStrategy;
435
	/**
R
rebornix 已提交
436 437
	 * Controls whether the editor should automatically adjust the indentation when users type, paste, move or indent lines.
	 * Defaults to advanced.
438
	 */
A
wip  
Alexandru Dima 已提交
439
	autoIndent?: 'none' | 'keep' | 'brackets' | 'advanced' | 'full';
440
	/**
441 442
	 * Emulate selection behaviour of tab characters when using spaces for indentation.
	 * This means selection will stick to tab stops.
443
	 */
444
	stickyTabStops?: boolean;
445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
	/**
	 * 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.
467
	 * Defaults to 'on'.
468
	 */
A
Alex Dima 已提交
469
	acceptSuggestionOnEnter?: 'on' | 'smart' | 'off';
470 471 472 473 474 475 476 477 478 479 480 481 482
	/**
	 * 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;
483
	/**
484
	 * Syntax highlighting is copied.
485
	 */
486
	copyWithSyntaxHighlighting?: boolean;
487 488 489
	/**
	 * The history mode for suggestions.
	 */
M
Martin Aeschlimann 已提交
490
	suggestSelection?: 'first' | 'recentlyUsed' | 'recentlyUsedByPrefix';
491 492 493 494 495 496 497 498 499 500
	/**
	 * 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;
501 502 503
	/**
	 * Enable tab completion.
	 */
A
Alex Dima 已提交
504
	tabCompletion?: 'on' | 'off' | 'onlySnippets';
505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
	/**
	 * 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;
520 521 522 523 524 525 526 527
	/**
	 * Code lens font family. Defaults to editor font family.
	 */
	codeLensFontFamily?: string;
	/**
	 * Code lens font size. Default to 90% of the editor font size
	 */
	codeLensFontSize?: number;
528 529 530 531
	/**
	 * Control the behavior and rendering of the code action lightbulb.
	 */
	lightbulb?: IEditorLightbulbOptions;
532 533 534 535
	/**
	 * Timeout for running code actions on save.
	 */
	codeActionsOnSaveTimeout?: number;
536
	/**
537
	 * Enable code folding.
A
Alex Dima 已提交
538
	 * Defaults to true.
539 540
	 */
	folding?: boolean;
541 542 543 544 545
	/**
	 * 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';
546 547 548 549 550
	/**
	 * Enable highlight for folded regions.
	 * Defaults to true.
	 */
	foldingHighlight?: boolean;
551
	/**
552 553
	 * Controls whether the fold actions in the gutter stay always visible or hide unless the mouse is over the gutter.
	 * Defaults to 'mouseover'.
554
	 */
555
	showFoldingControls?: 'always' | 'mouseover';
556 557 558 559
	/**
	 * Controls whether clicking on the empty content after a folded line will unfold the line.
	 * Defaults to false.
	 */
560
	unfoldOnClickAfterEndOfLine?: boolean;
561 562
	/**
	 * Enable highlighting of matching brackets.
563
	 * Defaults to 'always'.
564
	 */
565
	matchBrackets?: 'never' | 'near' | 'always';
566 567
	/**
	 * Enable rendering of whitespace.
568
	 * Defaults to 'selection'.
569
	 */
570
	renderWhitespace?: 'none' | 'boundary' | 'selection' | 'trailing' | 'all';
571 572 573 574 575 576 577
	/**
	 * Enable rendering of control characters.
	 * Defaults to false.
	 */
	renderControlCharacters?: boolean;
	/**
	 * Enable rendering of indent guides.
578
	 * Defaults to true.
579 580
	 */
	renderIndentGuides?: boolean;
581
	/**
C
typo  
Coenraad Stijne 已提交
582
	 * Enable highlighting of the active indent guide.
583 584 585
	 * Defaults to true.
	 */
	highlightActiveIndentGuide?: boolean;
586 587 588 589 590
	/**
	 * Enable rendering of current line highlight.
	 * Defaults to all.
	 */
	renderLineHighlight?: 'none' | 'gutter' | 'line' | 'all';
591 592 593 594 595
	/**
	 * Control if the current line highlight should be rendered only the editor is focused.
	 * Defaults to false.
	 */
	renderLineHighlightOnlyWhenFocus?: boolean;
596 597 598 599 600 601 602 603 604 605 606
	/**
	 * Inserting and deleting whitespace follows tab stops.
	 */
	useTabStops?: boolean;
	/**
	 * The font family
	 */
	fontFamily?: string;
	/**
	 * The font weight
	 */
607
	fontWeight?: string;
608 609 610 611 612 613 614 615
	/**
	 * The font size
	 */
	fontSize?: number;
	/**
	 * The line height
	 */
	lineHeight?: number;
616 617 618 619
	/**
	 * The letter spacing
	 */
	letterSpacing?: number;
620 621 622 623
	/**
	 * Controls fading out of unused variables.
	 */
	showUnused?: boolean;
624 625 626 627
	/**
	 * Controls whether to focus the inline editor in the peek widget by default.
	 * Defaults to false.
	 */
628
	peekWidgetDefaultFocus?: 'tree' | 'editor';
629
	/**
630
	 * Controls whether the definition link opens element in the peek widget.
631 632
	 * Defaults to false.
	 */
633
	definitionLinkOpensInPeek?: boolean;
634
	/**
635
	 * Controls strikethrough deprecated variables.
636
	 */
637
	showDeprecated?: boolean;
K
kingwl 已提交
638
	/**
K
kingwl 已提交
639
	 * Control the behavior and rendering of the inline hints.
K
kingwl 已提交
640
	 */
641
	inlayHints?: IEditorInlayHintsOptions;
642 643 644 645
	/**
	 * Control if the editor should use shadow DOM.
	 */
	useShadowDOM?: boolean;
646 647
}

648 649 650 651 652 653
/**
 * @internal
 * The width of the minimap gutter, in pixels.
 */
export const MINIMAP_GUTTER_WIDTH = 8;

654 655 656 657 658 659 660 661 662 663 664 665 666 667
/**
 * 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;
668 669 670 671
	/**
	 * Timeout in milliseconds after which diff computation is cancelled.
	 * Defaults to 5000.
	 */
672
	maxComputationTime?: number;
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
	/**
	 * 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;
688
	/**
689
	 * Should the diff editor enable code lens?
690 691
	 * Defaults to false.
	 */
692
	diffCodeLens?: boolean;
R
rebornix 已提交
693 694 695 696 697
	/**
	 * Is the diff editor inside another editor
	 * Defaults to false
	 */
	isInEmbeddedEditor?: boolean;
R
rebornix 已提交
698 699 700 701 702
	/**
	 * Is the diff editor should render overview ruler
	 * Defaults to true
	 */
	renderOverviewRuler?: boolean;
703 704
	/**
	 * Control the wrapping of the diff editor.
705
	 */
706
	diffWordWrap?: 'off' | 'on' | 'inherit';
707 708 709 710 711 712 713 714
	/**
	 * Aria label for original editor.
	 */
	originalAriaLabel?: string;
	/**
	 * Aria label for modifed editor.
	 */
	modifiedAriaLabel?: string;
715 716
}

A
Alex Dima 已提交
717
//#endregion
718 719

/**
720
 * An event describing that the configuration of the editor has changed.
721
 */
722 723
export class ConfigurationChangedEvent {
	private readonly _values: boolean[];
724 725 726
	/**
	 * @internal
	 */
727 728
	constructor(values: boolean[]) {
		this._values = values;
729
	}
730 731
	public hasChanged(id: EditorOption): boolean {
		return this._values[id];
732 733 734 735
	}
}

/**
736
 * @internal
737
 */
738 739
export class ValidatedEditorOptions {
	private readonly _values: any[] = [];
A
renames  
Alex Dima 已提交
740
	public _read<T>(option: EditorOption): T {
741 742
		return this._values[option];
	}
A
Alex Dima 已提交
743 744 745
	public get<T extends EditorOption>(id: T): FindComputedEditorOptionValueById<T> {
		return this._values[id];
	}
A
renames  
Alex Dima 已提交
746
	public _write<T>(option: EditorOption, value: T): void {
747 748
		this._values[option] = value;
	}
749
}
750

751
/**
752
 * All computed editor options.
753
 */
A
Alex Dima 已提交
754
export interface IComputedEditorOptions {
A
renames  
Alex Dima 已提交
755
	get<T extends EditorOption>(id: T): FindComputedEditorOptionValueById<T>;
756
}
757

A
Alex Dima 已提交
758 759
//#region IEditorOption

760
/**
A
Alex Dima 已提交
761
 * @internal
762
 */
A
Alex Dima 已提交
763
export interface IEnvironmentalOptions {
764
	readonly memory: ComputeOptionsMemory | null;
A
Alex Dima 已提交
765 766 767 768 769
	readonly outerWidth: number;
	readonly outerHeight: number;
	readonly fontInfo: FontInfo;
	readonly extraEditorClassName: string;
	readonly isDominatedByLongLines: boolean;
770
	readonly viewLineCount: number;
A
Alex Dima 已提交
771 772 773 774 775 776 777
	readonly lineNumbersDigitCount: number;
	readonly emptySelectionClipboard: boolean;
	readonly pixelRatio: number;
	readonly tabFocusMode: boolean;
	readonly accessibilitySupport: AccessibilitySupport;
}

778 779 780
/**
 * @internal
 */
781 782
export class ComputeOptionsMemory {

A
Alex Dima 已提交
783 784 785
	public stableMinimapLayoutInput: IMinimapLayoutInput | null;
	public stableFitMaxMinimapScale: number;
	public stableFitRemainingWidth: number;
786 787

	constructor() {
A
Alex Dima 已提交
788 789 790
		this.stableMinimapLayoutInput = null;
		this.stableFitMaxMinimapScale = 0;
		this.stableFitRemainingWidth = 0;
791
	}
792 793
}

A
Alex Dima 已提交
794 795 796
export interface IEditorOption<K1 extends EditorOption, V> {
	readonly id: K1;
	readonly name: string;
797
	defaultValue: V;
798
	/**
799
	 * @internal
800
	 */
801
	readonly schema: IConfigurationPropertySchema | { [path: string]: IConfigurationPropertySchema; } | undefined;
802
	/**
A
Alex Dima 已提交
803
	 * @internal
804
	 */
A
Alex Dima 已提交
805
	validate(input: any): V;
806
	/**
A
Alex Dima 已提交
807
	 * @internal
808
	 */
A
Alex Dima 已提交
809 810 811
	compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, value: V): V;
}

A
Alex Dima 已提交
812
type PossibleKeyName0<V> = { [K in keyof IEditorOptions]: IEditorOptions[K] extends V | undefined ? K : never }[keyof IEditorOptions];
813
type PossibleKeyName<V> = NonNullable<PossibleKeyName0<V>>;
814

815 816 817
/**
 * @internal
 */
818
abstract class BaseEditorOption<K1 extends EditorOption, V> implements IEditorOption<K1, V> {
A
Alex Dima 已提交
819 820

	public readonly id: K1;
821
	public readonly name: string;
A
Alex Dima 已提交
822
	public readonly defaultValue: V;
823
	public readonly schema: IConfigurationPropertySchema | { [path: string]: IConfigurationPropertySchema; } | undefined;
A
Alex Dima 已提交
824

825
	constructor(id: K1, name: string, defaultValue: V, schema?: IConfigurationPropertySchema | { [path: string]: IConfigurationPropertySchema; }) {
A
Alex Dima 已提交
826 827 828
		this.id = id;
		this.name = name;
		this.defaultValue = defaultValue;
829
		this.schema = schema;
A
Alex Dima 已提交
830 831 832 833 834 835 836
	}

	public abstract validate(input: any): V;

	public compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, value: V): V {
		return value;
	}
837 838 839 840 841
}

/**
 * @internal
 */
A
Alex Dima 已提交
842
abstract class ComputedEditorOption<K1 extends EditorOption, V> implements IEditorOption<K1, V> {
A
Alex Dima 已提交
843

844
	public readonly id: K1;
A
Alex Dima 已提交
845 846 847
	public readonly name: '_never_';
	public readonly defaultValue: V;
	public readonly deps: EditorOption[] | null;
848
	public readonly schema: IConfigurationPropertySchema | undefined = undefined;
A
Alex Dima 已提交
849 850 851 852 853 854

	constructor(id: K1, deps: EditorOption[] | null = null) {
		this.id = id;
		this.name = '_never_';
		this.defaultValue = <any>undefined;
		this.deps = deps;
A
Alex Dima 已提交
855 856
	}

A
Alex Dima 已提交
857 858 859
	public validate(input: any): V {
		return this.defaultValue;
	}
860

A
Alex Dima 已提交
861
	public abstract compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, value: V): V;
862 863
}

A
Alex Dima 已提交
864
class SimpleEditorOption<K1 extends EditorOption, V> implements IEditorOption<K1, V> {
865

A
Alex Dima 已提交
866 867 868
	public readonly id: K1;
	public readonly name: PossibleKeyName<V>;
	public readonly defaultValue: V;
869
	public readonly schema: IConfigurationPropertySchema | undefined;
A
Alex Dima 已提交
870

871
	constructor(id: K1, name: PossibleKeyName<V>, defaultValue: V, schema?: IConfigurationPropertySchema) {
872 873 874
		this.id = id;
		this.name = name;
		this.defaultValue = defaultValue;
875
		this.schema = schema;
A
Alex Dima 已提交
876
	}
877

A
Alex Dima 已提交
878 879 880
	public validate(input: any): V {
		if (typeof input === 'undefined') {
			return this.defaultValue;
A
Alex Dima 已提交
881
		}
A
Alex Dima 已提交
882 883
		return input as any;
	}
884

A
Alex Dima 已提交
885 886
	public compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, value: V): V {
		return value;
887
	}
888 889
}

890 891 892 893 894 895
/**
 * @internal
 */
export function boolean(value: any, defaultValue: boolean): boolean {
	if (typeof value === 'undefined') {
		return defaultValue;
A
Alex Dima 已提交
896
	}
897 898 899 900 901 902 903 904
	if (value === 'false') {
		// treat the string 'false' as false
		return false;
	}
	return Boolean(value);
}

class EditorBooleanOption<K1 extends EditorOption> extends SimpleEditorOption<K1, boolean> {
905

906
	constructor(id: K1, name: PossibleKeyName<boolean>, defaultValue: boolean, schema: IConfigurationPropertySchema | undefined = undefined) {
907 908 909 910
		if (typeof schema !== 'undefined') {
			schema.type = 'boolean';
			schema.default = defaultValue;
		}
911
		super(id, name, defaultValue, schema);
912
	}
913

914
	public override validate(input: any): boolean {
915
		return boolean(input, this.defaultValue);
916
	}
917 918
}

A
Alex Dima 已提交
919
class EditorIntOption<K1 extends EditorOption> extends SimpleEditorOption<K1, number> {
920

A
Alex Dima 已提交
921
	public static clampedInt<T>(value: any, defaultValue: T, minimum: number, maximum: number): number | T {
A
Alex Dima 已提交
922
		if (typeof value === 'undefined') {
A
Alex Dima 已提交
923 924 925 926 927
			return defaultValue;
		}
		let r = parseInt(value, 10);
		if (isNaN(r)) {
			return defaultValue;
A
Alex Dima 已提交
928 929 930 931 932
		}
		r = Math.max(minimum, r);
		r = Math.min(maximum, r);
		return r | 0;
	}
A
Alex Dima 已提交
933

A
Alex Dima 已提交
934 935
	public readonly minimum: number;
	public readonly maximum: number;
936

937 938 939 940 941 942 943 944
	constructor(id: K1, name: PossibleKeyName<number>, defaultValue: number, minimum: number, maximum: number, schema: IConfigurationPropertySchema | undefined = undefined) {
		if (typeof schema !== 'undefined') {
			schema.type = 'integer';
			schema.default = defaultValue;
			schema.minimum = minimum;
			schema.maximum = maximum;
		}
		super(id, name, defaultValue, schema);
A
Alex Dima 已提交
945 946
		this.minimum = minimum;
		this.maximum = maximum;
947 948
	}

949
	public override validate(input: any): number {
A
Alex Dima 已提交
950
		return EditorIntOption.clampedInt(input, this.defaultValue, this.minimum, this.maximum);
951
	}
A
Alex Dima 已提交
952
}
953

A
Alex Dima 已提交
954
class EditorFloatOption<K1 extends EditorOption> extends SimpleEditorOption<K1, number> {
A
Alex Dima 已提交
955 956 957 958 959 960 961 962 963

	public static clamp(n: number, min: number, max: number): number {
		if (n < min) {
			return min;
		}
		if (n > max) {
			return max;
		}
		return n;
964 965
	}

A
Alex Dima 已提交
966 967 968 969 970 971 972 973 974
	public static float(value: any, defaultValue: number): number {
		if (typeof value === 'number') {
			return value;
		}
		if (typeof value === 'undefined') {
			return defaultValue;
		}
		const r = parseFloat(value);
		return (isNaN(r) ? defaultValue : r);
A
Alex Dima 已提交
975
	}
976

A
Alex Dima 已提交
977
	public readonly validationFn: (value: number) => number;
978 979 980 981 982 983 984

	constructor(id: K1, name: PossibleKeyName<number>, defaultValue: number, validationFn: (value: number) => number, schema?: IConfigurationPropertySchema) {
		if (typeof schema !== 'undefined') {
			schema.type = 'number';
			schema.default = defaultValue;
		}
		super(id, name, defaultValue, schema);
A
Alex Dima 已提交
985
		this.validationFn = validationFn;
A
Alex Dima 已提交
986 987
	}

988
	public override validate(input: any): number {
A
Alex Dima 已提交
989
		return this.validationFn(EditorFloatOption.float(input, this.defaultValue));
A
Alex Dima 已提交
990
	}
991
}
A
Alex Dima 已提交
992

A
Alex Dima 已提交
993
class EditorStringOption<K1 extends EditorOption> extends SimpleEditorOption<K1, string> {
A
Alex Dima 已提交
994 995 996 997 998 999

	public static string(value: any, defaultValue: string): string {
		if (typeof value !== 'string') {
			return defaultValue;
		}
		return value;
A
Alex Dima 已提交
1000 1001
	}

1002 1003 1004 1005 1006 1007
	constructor(id: K1, name: PossibleKeyName<string>, defaultValue: string, schema: IConfigurationPropertySchema | undefined = undefined) {
		if (typeof schema !== 'undefined') {
			schema.type = 'string';
			schema.default = defaultValue;
		}
		super(id, name, defaultValue, schema);
A
Alex Dima 已提交
1008 1009
	}

1010
	public override validate(input: any): string {
A
Alex Dima 已提交
1011
		return EditorStringOption.string(input, this.defaultValue);
1012
	}
A
Alex Dima 已提交
1013
}
1014

1015 1016 1017 1018 1019 1020
/**
 * @internal
 */
export function stringSet<T>(value: T | undefined, defaultValue: T, allowedValues: ReadonlyArray<T>): T {
	if (typeof value !== 'string') {
		return defaultValue;
1021
	}
1022 1023
	if (allowedValues.indexOf(value) === -1) {
		return defaultValue;
1024
	}
1025 1026 1027 1028
	return value;
}

class EditorStringEnumOption<K1 extends EditorOption, V extends string> extends SimpleEditorOption<K1, V> {
1029

1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
	private readonly _allowedValues: ReadonlyArray<V>;

	constructor(id: K1, name: PossibleKeyName<V>, defaultValue: V, allowedValues: ReadonlyArray<V>, schema: IConfigurationPropertySchema | undefined = undefined) {
		if (typeof schema !== 'undefined') {
			schema.type = 'string';
			schema.enum = <any>allowedValues;
			schema.default = defaultValue;
		}
		super(id, name, defaultValue, schema);
		this._allowedValues = allowedValues;
A
Alex Dima 已提交
1040 1041
	}

1042
	public override validate(input: any): V {
1043
		return stringSet<V>(input, this.defaultValue, this._allowedValues);
A
Alex Dima 已提交
1044 1045 1046
	}
}

1047 1048 1049 1050 1051 1052 1053 1054 1055
class EditorEnumOption<K1 extends EditorOption, T extends string, V> extends BaseEditorOption<K1, V> {

	private readonly _allowedValues: T[];
	private readonly _convert: (value: T) => V;

	constructor(id: K1, name: PossibleKeyName<T>, defaultValue: V, defaultStringValue: string, allowedValues: T[], convert: (value: T) => V, schema: IConfigurationPropertySchema | undefined = undefined) {
		if (typeof schema !== 'undefined') {
			schema.type = 'string';
			schema.enum = allowedValues;
1056
			schema.default = defaultStringValue;
1057
		}
1058 1059 1060
		super(id, name, defaultValue, schema);
		this._allowedValues = allowedValues;
		this._convert = convert;
1061 1062
	}

A
Alex Dima 已提交
1063 1064
	public validate(input: any): V {
		if (typeof input !== 'string') {
A
Alex Dima 已提交
1065 1066
			return this.defaultValue;
		}
1067
		if (this._allowedValues.indexOf(<T>input) === -1) {
A
Alex Dima 已提交
1068 1069
			return this.defaultValue;
		}
1070
		return this._convert(<any>input);
1071
	}
A
Alex Dima 已提交
1072
}
1073

A
Alex Dima 已提交
1074
//#endregion
A
Alex Dima 已提交
1075

A
wip  
Alexandru Dima 已提交
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
//#region autoIndent

function _autoIndentFromString(autoIndent: 'none' | 'keep' | 'brackets' | 'advanced' | 'full'): EditorAutoIndentStrategy {
	switch (autoIndent) {
		case 'none': return EditorAutoIndentStrategy.None;
		case 'keep': return EditorAutoIndentStrategy.Keep;
		case 'brackets': return EditorAutoIndentStrategy.Brackets;
		case 'advanced': return EditorAutoIndentStrategy.Advanced;
		case 'full': return EditorAutoIndentStrategy.Full;
	}
}

//#endregion

A
Alex Dima 已提交
1090 1091
//#region accessibilitySupport

1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
class EditorAccessibilitySupport extends BaseEditorOption<EditorOption.accessibilitySupport, AccessibilitySupport> {

	constructor() {
		super(
			EditorOption.accessibilitySupport, 'accessibilitySupport', AccessibilitySupport.Unknown,
			{
				type: 'string',
				enum: ['auto', 'on', 'off'],
				enumDescriptions: [
					nls.localize('accessibilitySupport.auto', "The editor will use platform APIs to detect when a Screen Reader is attached."),
A
Alex Dima 已提交
1102
					nls.localize('accessibilitySupport.on', "The editor will be permanently optimized for usage with a Screen Reader. Word wrapping will be disabled."),
1103 1104 1105
					nls.localize('accessibilitySupport.off', "The editor will never be optimized for usage with a Screen Reader."),
				],
				default: 'auto',
A
Alex Dima 已提交
1106
				description: nls.localize('accessibilitySupport', "Controls whether the editor should run in a mode where it is optimized for screen readers. Setting to on will disable word wrapping.")
1107
			}
A
Alex Dima 已提交
1108 1109 1110
		);
	}

A
Alex Dima 已提交
1111 1112 1113 1114 1115
	public validate(input: any): AccessibilitySupport {
		switch (input) {
			case 'auto': return AccessibilitySupport.Unknown;
			case 'off': return AccessibilitySupport.Disabled;
			case 'on': return AccessibilitySupport.Enabled;
A
Alex Dima 已提交
1116
		}
A
Alex Dima 已提交
1117
		return this.defaultValue;
A
Alex Dima 已提交
1118
	}
1119

1120
	public override compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, value: AccessibilitySupport): AccessibilitySupport {
A
Alex Dima 已提交
1121
		if (value === AccessibilitySupport.Unknown) {
A
Alex Dima 已提交
1122 1123
			// The editor reads the `accessibilitySupport` from the environment
			return env.accessibilitySupport;
A
Alex Dima 已提交
1124
		}
A
Alex Dima 已提交
1125
		return value;
1126 1127 1128
	}
}

A
Alex Dima 已提交
1129 1130
//#endregion

A
Alex Dima 已提交
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141
//#region comments

/**
 * Configuration options for editor comments
 */
export interface IEditorCommentsOptions {
	/**
	 * Insert a space after the line comment token and inside the block comments tokens.
	 * Defaults to true.
	 */
	insertSpace?: boolean;
1142
	/**
1143 1144
	 * Ignore empty lines when inserting line comments.
	 * Defaults to true.
1145
	 */
1146
	ignoreEmptyLines?: boolean;
A
Alex Dima 已提交
1147 1148 1149 1150 1151 1152 1153 1154 1155
}

export type EditorCommentsOptions = Readonly<Required<IEditorCommentsOptions>>;

class EditorComments extends BaseEditorOption<EditorOption.comments, EditorCommentsOptions> {

	constructor() {
		const defaults: EditorCommentsOptions = {
			insertSpace: true,
1156
			ignoreEmptyLines: true,
A
Alex Dima 已提交
1157 1158 1159 1160 1161 1162 1163 1164 1165
		};
		super(
			EditorOption.comments, 'comments', defaults,
			{
				'editor.comments.insertSpace': {
					type: 'boolean',
					default: defaults.insertSpace,
					description: nls.localize('comments.insertSpace', "Controls whether a space character is inserted when commenting.")
				},
1166
				'editor.comments.ignoreEmptyLines': {
1167
					type: 'boolean',
1168 1169
					default: defaults.ignoreEmptyLines,
					description: nls.localize('comments.ignoreEmptyLines', 'Controls if empty lines should be ignored with toggle, add or remove actions for line comments.')
1170
				},
A
Alex Dima 已提交
1171 1172 1173 1174 1175
			}
		);
	}

	public validate(_input: any): EditorCommentsOptions {
A
Alex Dima 已提交
1176
		if (!_input || typeof _input !== 'object') {
A
Alex Dima 已提交
1177 1178 1179 1180
			return this.defaultValue;
		}
		const input = _input as IEditorCommentsOptions;
		return {
1181 1182
			insertSpace: boolean(input.insertSpace, this.defaultValue.insertSpace),
			ignoreEmptyLines: boolean(input.ignoreEmptyLines, this.defaultValue.ignoreEmptyLines),
A
Alex Dima 已提交
1183 1184 1185 1186 1187 1188
		};
	}
}

//#endregion

1189
//#region cursorBlinking
A
Alex Dima 已提交
1190

A
Alex Dima 已提交
1191
/**
A
Alex Dima 已提交
1192
 * The kind of animation in which the editor's cursor should be rendered.
A
Alex Dima 已提交
1193
 */
A
Alex Dima 已提交
1194
export const enum TextEditorCursorBlinkingStyle {
A
Alex Dima 已提交
1195
	/**
A
Alex Dima 已提交
1196
	 * Hidden
A
Alex Dima 已提交
1197
	 */
A
Alex Dima 已提交
1198
	Hidden = 0,
A
Alex Dima 已提交
1199
	/**
A
Alex Dima 已提交
1200
	 * Blinking
A
Alex Dima 已提交
1201
	 */
A
Alex Dima 已提交
1202
	Blink = 1,
A
Alex Dima 已提交
1203
	/**
A
Alex Dima 已提交
1204
	 * Blinking with smooth fading
A
Alex Dima 已提交
1205
	 */
A
Alex Dima 已提交
1206
	Smooth = 2,
A
Alex Dima 已提交
1207
	/**
A
Alex Dima 已提交
1208
	 * Blinking with prolonged filled state and smooth fading
A
Alex Dima 已提交
1209
	 */
A
Alex Dima 已提交
1210
	Phase = 3,
1211
	/**
A
Alex Dima 已提交
1212
	 * Expand collapse animation on the y axis
1213
	 */
A
Alex Dima 已提交
1214
	Expand = 4,
1215
	/**
A
Alex Dima 已提交
1216
	 * No-Blinking
1217
	 */
A
Alex Dima 已提交
1218 1219
	Solid = 5
}
1220

A
Alex Dima 已提交
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291
function _cursorBlinkingStyleFromString(cursorBlinkingStyle: 'blink' | 'smooth' | 'phase' | 'expand' | 'solid'): TextEditorCursorBlinkingStyle {
	switch (cursorBlinkingStyle) {
		case 'blink': return TextEditorCursorBlinkingStyle.Blink;
		case 'smooth': return TextEditorCursorBlinkingStyle.Smooth;
		case 'phase': return TextEditorCursorBlinkingStyle.Phase;
		case 'expand': return TextEditorCursorBlinkingStyle.Expand;
		case 'solid': return TextEditorCursorBlinkingStyle.Solid;
	}
}

//#endregion

//#region cursorStyle

/**
 * 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): 'line' | 'block' | 'underline' | 'line-thin' | 'block-outline' | 'underline-thin' {
	switch (cursorStyle) {
		case TextEditorCursorStyle.Line: return 'line';
		case TextEditorCursorStyle.Block: return 'block';
		case TextEditorCursorStyle.Underline: return 'underline';
		case TextEditorCursorStyle.LineThin: return 'line-thin';
		case TextEditorCursorStyle.BlockOutline: return 'block-outline';
		case TextEditorCursorStyle.UnderlineThin: return 'underline-thin';
	}
}

function _cursorStyleFromString(cursorStyle: 'line' | 'block' | 'underline' | 'line-thin' | 'block-outline' | 'underline-thin'): TextEditorCursorStyle {
	switch (cursorStyle) {
		case 'line': return TextEditorCursorStyle.Line;
		case 'block': return TextEditorCursorStyle.Block;
		case 'underline': return TextEditorCursorStyle.Underline;
		case 'line-thin': return TextEditorCursorStyle.LineThin;
		case 'block-outline': return TextEditorCursorStyle.BlockOutline;
		case 'underline-thin': return TextEditorCursorStyle.UnderlineThin;
	}
}

//#endregion

1292
//#region editorClassName
A
Alex Dima 已提交
1293

1294
class EditorClassName extends ComputedEditorOption<EditorOption.editorClassName, string> {
A
Alex Dima 已提交
1295

1296
	constructor() {
1297
		super(EditorOption.editorClassName, [EditorOption.mouseStyle, EditorOption.extraEditorClassName]);
1298
	}
A
Alex Dima 已提交
1299

A
Alex Dima 已提交
1300
	public compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, _: string): string {
1301
		const classNames = ['monaco-editor'];
A
Alex Dima 已提交
1302
		if (options.get(EditorOption.extraEditorClassName)) {
1303
			classNames.push(options.get(EditorOption.extraEditorClassName));
A
Alex Dima 已提交
1304 1305
		}
		if (env.extraEditorClassName) {
1306
			classNames.push(env.extraEditorClassName);
A
Alex Dima 已提交
1307 1308
		}
		if (options.get(EditorOption.mouseStyle) === 'default') {
1309
			classNames.push('mouse-default');
A
Alex Dima 已提交
1310
		} else if (options.get(EditorOption.mouseStyle) === 'copy') {
1311
			classNames.push('mouse-copy');
A
Alex Dima 已提交
1312
		}
1313

1314
		if (options.get(EditorOption.showUnused)) {
1315
			classNames.push('showUnused');
1316
		}
1317 1318

		if (options.get(EditorOption.showDeprecated)) {
1319
			classNames.push('showDeprecated');
1320
		}
1321 1322

		return classNames.join(' ');
A
Alex Dima 已提交
1323 1324 1325 1326 1327
	}
}

//#endregion

A
Alex Dima 已提交
1328
//#region emptySelectionClipboard
1329

1330 1331 1332 1333 1334 1335 1336 1337 1338
class EditorEmptySelectionClipboard extends EditorBooleanOption<EditorOption.emptySelectionClipboard> {

	constructor() {
		super(
			EditorOption.emptySelectionClipboard, 'emptySelectionClipboard', true,
			{ description: nls.localize('emptySelectionClipboard', "Controls whether copying without a selection copies the current line.") }
		);
	}

1339
	public override compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, value: boolean): boolean {
A
Alex Dima 已提交
1340
		return value && env.emptySelectionClipboard;
1341 1342 1343 1344 1345
	}
}

//#endregion

A
Alex Dima 已提交
1346
//#region find
A
Alex Dima 已提交
1347

1348 1349 1350 1351
/**
 * Configuration options for editor find widget
 */
export interface IEditorFindOptions {
T
Ted Goldman 已提交
1352 1353 1354
	/**
	* Controls whether the cursor should move to find matches while typing.
	*/
R
rebornix 已提交
1355
	cursorMoveOnType?: boolean;
1356 1357 1358 1359 1360
	/**
	 * Controls if we seed search string in the Find Widget with editor selection.
	 */
	seedSearchStringFromSelection?: boolean;
	/**
P
Peng Lyu 已提交
1361
	 * Controls if Find in Selection flag is turned on in the editor.
1362
	 */
P
Peng Lyu 已提交
1363
	autoFindInSelection?: 'never' | 'always' | 'multiline';
1364 1365 1366 1367 1368 1369 1370 1371 1372
	/*
	 * Controls whether the Find Widget should add extra lines on top of the editor.
	 */
	addExtraSpaceOnTop?: boolean;
	/**
	 * @internal
	 * Controls if the Find Widget should read or modify the shared find clipboard on macOS
	 */
	globalFindClipboard?: boolean;
1373 1374 1375 1376
	/**
	 * Controls whether the search automatically restarts from the beginning (or the end) when no further matches can be found
	 */
	loop?: boolean;
1377 1378
}

A
Alex Dima 已提交
1379
export type EditorFindOptions = Readonly<Required<IEditorFindOptions>>;
A
Alex Dima 已提交
1380

1381 1382 1383 1384
class EditorFind extends BaseEditorOption<EditorOption.find, EditorFindOptions> {

	constructor() {
		const defaults: EditorFindOptions = {
R
rebornix 已提交
1385
			cursorMoveOnType: true,
1386
			seedSearchStringFromSelection: true,
P
Peng Lyu 已提交
1387
			autoFindInSelection: 'never',
1388
			globalFindClipboard: false,
1389 1390
			addExtraSpaceOnTop: true,
			loop: true
1391 1392 1393 1394
		};
		super(
			EditorOption.find, 'find', defaults,
			{
R
rebornix 已提交
1395
				'editor.find.cursorMoveOnType': {
T
Ted Goldman 已提交
1396
					type: 'boolean',
R
rebornix 已提交
1397 1398
					default: defaults.cursorMoveOnType,
					description: nls.localize('find.cursorMoveOnType', "Controls whether the cursor should jump to find matches while typing.")
T
Ted Goldman 已提交
1399
				},
1400 1401 1402 1403 1404 1405
				'editor.find.seedSearchStringFromSelection': {
					type: 'boolean',
					default: defaults.seedSearchStringFromSelection,
					description: nls.localize('find.seedSearchStringFromSelection', "Controls whether the search string in the Find Widget is seeded from the editor selection.")
				},
				'editor.find.autoFindInSelection': {
P
Peng Lyu 已提交
1406 1407
					type: 'string',
					enum: ['never', 'always', 'multiline'],
1408
					default: defaults.autoFindInSelection,
P
Peng Lyu 已提交
1409
					enumDescriptions: [
1410 1411
						nls.localize('editor.find.autoFindInSelection.never', 'Never turn on Find in selection automatically (default).'),
						nls.localize('editor.find.autoFindInSelection.always', 'Always turn on Find in selection automatically.'),
P
Peng Lyu 已提交
1412 1413
						nls.localize('editor.find.autoFindInSelection.multiline', 'Turn on Find in selection automatically when multiple lines of content are selected.')
					],
1414
					description: nls.localize('find.autoFindInSelection', "Controls the condition for turning on find in selection automatically.")
1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425
				},
				'editor.find.globalFindClipboard': {
					type: 'boolean',
					default: defaults.globalFindClipboard,
					description: nls.localize('find.globalFindClipboard', "Controls whether the Find Widget should read or modify the shared find clipboard on macOS."),
					included: platform.isMacintosh
				},
				'editor.find.addExtraSpaceOnTop': {
					type: 'boolean',
					default: defaults.addExtraSpaceOnTop,
					description: nls.localize('find.addExtraSpaceOnTop', "Controls whether the Find Widget should add extra lines on top of the editor. When true, you can scroll beyond the first line when the Find Widget is visible.")
1426 1427 1428 1429 1430 1431 1432
				},
				'editor.find.loop': {
					type: 'boolean',
					default: defaults.loop,
					description: nls.localize('find.loop', "Controls whether the search automatically restarts from the beginning (or the end) when no further matches can be found.")
				},

1433 1434 1435 1436
			}
		);
	}

A
Alex Dima 已提交
1437
	public validate(_input: any): EditorFindOptions {
A
Alex Dima 已提交
1438
		if (!_input || typeof _input !== 'object') {
A
Alex Dima 已提交
1439 1440 1441 1442
			return this.defaultValue;
		}
		const input = _input as IEditorFindOptions;
		return {
1443 1444
			cursorMoveOnType: boolean(input.cursorMoveOnType, this.defaultValue.cursorMoveOnType),
			seedSearchStringFromSelection: boolean(input.seedSearchStringFromSelection, this.defaultValue.seedSearchStringFromSelection),
P
Peng Lyu 已提交
1445 1446
			autoFindInSelection: typeof _input.autoFindInSelection === 'boolean'
				? (_input.autoFindInSelection ? 'always' : 'never')
1447
				: stringSet<'never' | 'always' | 'multiline'>(input.autoFindInSelection, this.defaultValue.autoFindInSelection, ['never', 'always', 'multiline']),
1448 1449 1450
			globalFindClipboard: boolean(input.globalFindClipboard, this.defaultValue.globalFindClipboard),
			addExtraSpaceOnTop: boolean(input.addExtraSpaceOnTop, this.defaultValue.addExtraSpaceOnTop),
			loop: boolean(input.loop, this.defaultValue.loop),
A
Alex Dima 已提交
1451
		};
A
Alex Dima 已提交
1452 1453 1454 1455 1456
	}
}

//#endregion

1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473
//#region fontLigatures

/**
 * @internal
 */
export class EditorFontLigatures extends BaseEditorOption<EditorOption.fontLigatures, string> {

	public static OFF = '"liga" off, "calt" off';
	public static ON = '"liga" on, "calt" on';

	constructor() {
		super(
			EditorOption.fontLigatures, 'fontLigatures', EditorFontLigatures.OFF,
			{
				anyOf: [
					{
						type: 'boolean',
J
Jade 已提交
1474
						description: nls.localize('fontLigatures', "Enables/Disables font ligatures ('calt' and 'liga' font features). Change this to a string for fine-grained control of the 'font-feature-settings' CSS property."),
1475 1476 1477
					},
					{
						type: 'string',
J
Jade 已提交
1478
						description: nls.localize('fontFeatureSettings', "Explicit 'font-feature-settings' CSS property. A boolean can be passed instead if one only needs to turn on/off ligatures.")
1479 1480
					}
				],
J
Jade 已提交
1481
				description: nls.localize('fontLigaturesGeneral', "Configures font ligatures or font features. Can be either a boolean to enable/disable ligatures or a string for the value of the CSS 'font-feature-settings' property."),
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
				default: false
			}
		);
	}

	public validate(input: any): string {
		if (typeof input === 'undefined') {
			return this.defaultValue;
		}
		if (typeof input === 'string') {
			if (input === 'false') {
				return EditorFontLigatures.OFF;
			}
			if (input === 'true') {
				return EditorFontLigatures.ON;
			}
			return input;
		}
		if (Boolean(input)) {
			return EditorFontLigatures.ON;
		}
		return EditorFontLigatures.OFF;
	}
}

//#endregion

A
Alex Dima 已提交
1509
//#region fontInfo
A
Alex Dima 已提交
1510

1511 1512 1513 1514 1515 1516
class EditorFontInfo extends ComputedEditorOption<EditorOption.fontInfo, FontInfo> {

	constructor() {
		super(EditorOption.fontInfo);
	}

A
Alex Dima 已提交
1517 1518
	public compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, _: FontInfo): FontInfo {
		return env.fontInfo;
A
Alex Dima 已提交
1519 1520 1521 1522 1523
	}
}

//#endregion

A
Alex Dima 已提交
1524 1525
//#region fontSize

1526 1527 1528 1529 1530 1531 1532
class EditorFontSize extends SimpleEditorOption<EditorOption.fontSize, number> {

	constructor() {
		super(
			EditorOption.fontSize, 'fontSize', EDITOR_FONT_DEFAULTS.fontSize,
			{
				type: 'number',
1533 1534
				minimum: 6,
				maximum: 100,
1535 1536 1537 1538 1539 1540
				default: EDITOR_FONT_DEFAULTS.fontSize,
				description: nls.localize('fontSize', "Controls the font size in pixels.")
			}
		);
	}

1541
	public override validate(input: any): number {
A
Alex Dima 已提交
1542
		let r = EditorFloatOption.float(input, this.defaultValue);
A
Alex Dima 已提交
1543 1544 1545
		if (r === 0) {
			return EDITOR_FONT_DEFAULTS.fontSize;
		}
1546
		return EditorFloatOption.clamp(r, 6, 100);
A
Alex Dima 已提交
1547
	}
1548
	public override compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, value: number): number {
A
Alex Dima 已提交
1549 1550 1551
		// The final fontSize respects the editor zoom level.
		// So take the result from env.fontInfo
		return env.fontInfo.fontSize;
A
Alex Dima 已提交
1552 1553 1554 1555 1556
	}
}

//#endregion

1557 1558 1559
//#region fontWeight

class EditorFontWeight extends BaseEditorOption<EditorOption.fontWeight, string> {
1560
	private static SUGGESTION_VALUES = ['normal', 'bold', '100', '200', '300', '400', '500', '600', '700', '800', '900'];
1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571
	private static MINIMUM_VALUE = 1;
	private static MAXIMUM_VALUE = 1000;

	constructor() {
		super(
			EditorOption.fontWeight, 'fontWeight', EDITOR_FONT_DEFAULTS.fontWeight,
			{
				anyOf: [
					{
						type: 'number',
						minimum: EditorFontWeight.MINIMUM_VALUE,
1572 1573
						maximum: EditorFontWeight.MAXIMUM_VALUE,
						errorMessage: nls.localize('fontWeightErrorMessage', "Only \"normal\" and \"bold\" keywords or numbers between 1 and 1000 are allowed.")
1574 1575
					},
					{
1576 1577
						type: 'string',
						pattern: '^(normal|bold|1000|[1-9][0-9]{0,2})$'
1578 1579
					},
					{
1580
						enum: EditorFontWeight.SUGGESTION_VALUES
1581 1582 1583
					}
				],
				default: EDITOR_FONT_DEFAULTS.fontWeight,
1584
				description: nls.localize('fontWeight', "Controls the font weight. Accepts \"normal\" and \"bold\" keywords or numbers between 1 and 1000.")
1585 1586 1587 1588 1589
			}
		);
	}

	public validate(input: any): string {
1590 1591
		if (input === 'normal' || input === 'bold') {
			return input;
1592
		}
A
Alex Dima 已提交
1593
		return String(EditorIntOption.clampedInt(input, EDITOR_FONT_DEFAULTS.fontWeight, EditorFontWeight.MINIMUM_VALUE, EditorFontWeight.MAXIMUM_VALUE));
1594 1595 1596 1597 1598
	}
}

//#endregion

A
Alex Dima 已提交
1599
//#region gotoLocation
A
Alex Dima 已提交
1600

1601 1602
export type GoToLocationValues = 'peek' | 'gotoAndPeek' | 'goto';

1603 1604 1605 1606
/**
 * Configuration options for go to location
 */
export interface IGotoLocationOptions {
1607

1608
	multiple?: GoToLocationValues;
1609

1610 1611 1612
	multipleDefinitions?: GoToLocationValues;
	multipleTypeDefinitions?: GoToLocationValues;
	multipleDeclarations?: GoToLocationValues;
R
rzj17 已提交
1613
	multipleImplementations?: GoToLocationValues;
1614
	multipleReferences?: GoToLocationValues;
1615 1616 1617 1618 1619 1620

	alternativeDefinitionCommand?: string;
	alternativeTypeDefinitionCommand?: string;
	alternativeDeclarationCommand?: string;
	alternativeImplementationCommand?: string;
	alternativeReferenceCommand?: string;
1621 1622
}

A
Alex Dima 已提交
1623
export type GoToLocationOptions = Readonly<Required<IGotoLocationOptions>>;
A
Alex Dima 已提交
1624

1625 1626 1627
class EditorGoToLocation extends BaseEditorOption<EditorOption.gotoLocation, GoToLocationOptions> {

	constructor() {
1628 1629 1630 1631 1632
		const defaults: GoToLocationOptions = {
			multiple: 'peek',
			multipleDefinitions: 'peek',
			multipleTypeDefinitions: 'peek',
			multipleDeclarations: 'peek',
R
rzj17 已提交
1633
			multipleImplementations: 'peek',
1634
			multipleReferences: 'peek',
1635 1636 1637 1638 1639
			alternativeDefinitionCommand: 'editor.action.goToReferences',
			alternativeTypeDefinitionCommand: 'editor.action.goToReferences',
			alternativeDeclarationCommand: 'editor.action.goToReferences',
			alternativeImplementationCommand: '',
			alternativeReferenceCommand: '',
1640
		};
M
Matt Bierner 已提交
1641
		const jsonSubset: IJSONSchema = {
1642 1643 1644 1645 1646 1647 1648 1649 1650
			type: 'string',
			enum: ['peek', 'gotoAndPeek', 'goto'],
			default: defaults.multiple,
			enumDescriptions: [
				nls.localize('editor.gotoLocation.multiple.peek', 'Show peek view of the results (default)'),
				nls.localize('editor.gotoLocation.multiple.gotoAndPeek', 'Go to the primary result and show a peek view'),
				nls.localize('editor.gotoLocation.multiple.goto', 'Go to the primary result and enable peek-less navigation to others')
			]
		};
1651
		const alternativeCommandOptions = ['', 'editor.action.referenceSearch.trigger', 'editor.action.goToReferences', 'editor.action.peekImplementation', 'editor.action.goToImplementation', 'editor.action.peekTypeDefinition', 'editor.action.goToTypeDefinition', 'editor.action.peekDeclaration', 'editor.action.revealDeclaration', 'editor.action.peekDefinition', 'editor.action.revealDefinitionAside', 'editor.action.revealDefinition'];
1652 1653 1654 1655
		super(
			EditorOption.gotoLocation, 'gotoLocation', defaults,
			{
				'editor.gotoLocation.multiple': {
R
rzj17 已提交
1656
					deprecationMessage: nls.localize('editor.gotoLocation.multiple.deprecated', "This setting is deprecated, please use separate settings like 'editor.editor.gotoLocation.multipleDefinitions' or 'editor.editor.gotoLocation.multipleImplementations' instead."),
1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669
				},
				'editor.gotoLocation.multipleDefinitions': {
					description: nls.localize('editor.editor.gotoLocation.multipleDefinitions', "Controls the behavior the 'Go to Definition'-command when multiple target locations exist."),
					...jsonSubset,
				},
				'editor.gotoLocation.multipleTypeDefinitions': {
					description: nls.localize('editor.editor.gotoLocation.multipleTypeDefinitions', "Controls the behavior the 'Go to Type Definition'-command when multiple target locations exist."),
					...jsonSubset,
				},
				'editor.gotoLocation.multipleDeclarations': {
					description: nls.localize('editor.editor.gotoLocation.multipleDeclarations', "Controls the behavior the 'Go to Declaration'-command when multiple target locations exist."),
					...jsonSubset,
				},
R
rzj17 已提交
1670 1671
				'editor.gotoLocation.multipleImplementations': {
					description: nls.localize('editor.editor.gotoLocation.multipleImplemenattions', "Controls the behavior the 'Go to Implementations'-command when multiple target locations exist."),
1672 1673 1674 1675 1676
					...jsonSubset,
				},
				'editor.gotoLocation.multipleReferences': {
					description: nls.localize('editor.editor.gotoLocation.multipleReferences', "Controls the behavior the 'Go to References'-command when multiple target locations exist."),
					...jsonSubset,
1677
				},
1678
				'editor.gotoLocation.alternativeDefinitionCommand': {
1679
					type: 'string',
1680
					default: defaults.alternativeDefinitionCommand,
1681
					enum: alternativeCommandOptions,
1682 1683 1684 1685 1686
					description: nls.localize('alternativeDefinitionCommand', "Alternative command id that is being executed when the result of 'Go to Definition' is the current location.")
				},
				'editor.gotoLocation.alternativeTypeDefinitionCommand': {
					type: 'string',
					default: defaults.alternativeTypeDefinitionCommand,
1687
					enum: alternativeCommandOptions,
1688 1689 1690 1691 1692
					description: nls.localize('alternativeTypeDefinitionCommand', "Alternative command id that is being executed when the result of 'Go to Type Definition' is the current location.")
				},
				'editor.gotoLocation.alternativeDeclarationCommand': {
					type: 'string',
					default: defaults.alternativeDeclarationCommand,
1693
					enum: alternativeCommandOptions,
1694 1695 1696 1697 1698
					description: nls.localize('alternativeDeclarationCommand', "Alternative command id that is being executed when the result of 'Go to Declaration' is the current location.")
				},
				'editor.gotoLocation.alternativeImplementationCommand': {
					type: 'string',
					default: defaults.alternativeImplementationCommand,
1699
					enum: alternativeCommandOptions,
1700 1701 1702 1703 1704
					description: nls.localize('alternativeImplementationCommand', "Alternative command id that is being executed when the result of 'Go to Implementation' is the current location.")
				},
				'editor.gotoLocation.alternativeReferenceCommand': {
					type: 'string',
					default: defaults.alternativeReferenceCommand,
1705
					enum: alternativeCommandOptions,
1706
					description: nls.localize('alternativeReferenceCommand', "Alternative command id that is being executed when the result of 'Go to Reference' is the current location.")
1707 1708 1709 1710 1711
				},
			}
		);
	}

A
Alex Dima 已提交
1712
	public validate(_input: any): GoToLocationOptions {
A
Alex Dima 已提交
1713
		if (!_input || typeof _input !== 'object') {
A
Alex Dima 已提交
1714 1715
			return this.defaultValue;
		}
A
Alex Dima 已提交
1716
		const input = _input as IGotoLocationOptions;
A
Alex Dima 已提交
1717
		return {
1718 1719 1720 1721 1722 1723
			multiple: stringSet<GoToLocationValues>(input.multiple, this.defaultValue.multiple!, ['peek', 'gotoAndPeek', 'goto']),
			multipleDefinitions: input.multipleDefinitions ?? stringSet<GoToLocationValues>(input.multipleDefinitions, 'peek', ['peek', 'gotoAndPeek', 'goto']),
			multipleTypeDefinitions: input.multipleTypeDefinitions ?? stringSet<GoToLocationValues>(input.multipleTypeDefinitions, 'peek', ['peek', 'gotoAndPeek', 'goto']),
			multipleDeclarations: input.multipleDeclarations ?? stringSet<GoToLocationValues>(input.multipleDeclarations, 'peek', ['peek', 'gotoAndPeek', 'goto']),
			multipleImplementations: input.multipleImplementations ?? stringSet<GoToLocationValues>(input.multipleImplementations, 'peek', ['peek', 'gotoAndPeek', 'goto']),
			multipleReferences: input.multipleReferences ?? stringSet<GoToLocationValues>(input.multipleReferences, 'peek', ['peek', 'gotoAndPeek', 'goto']),
1724 1725 1726 1727 1728
			alternativeDefinitionCommand: EditorStringOption.string(input.alternativeDefinitionCommand, this.defaultValue.alternativeDefinitionCommand),
			alternativeTypeDefinitionCommand: EditorStringOption.string(input.alternativeTypeDefinitionCommand, this.defaultValue.alternativeTypeDefinitionCommand),
			alternativeDeclarationCommand: EditorStringOption.string(input.alternativeDeclarationCommand, this.defaultValue.alternativeDeclarationCommand),
			alternativeImplementationCommand: EditorStringOption.string(input.alternativeImplementationCommand, this.defaultValue.alternativeImplementationCommand),
			alternativeReferenceCommand: EditorStringOption.string(input.alternativeReferenceCommand, this.defaultValue.alternativeReferenceCommand),
A
Alex Dima 已提交
1729 1730 1731 1732 1733 1734
		};
	}
}

//#endregion

A
Alex Dima 已提交
1735
//#region hover
A
Alex Dima 已提交
1736

1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757
/**
 * Configuration options for editor hover
 */
export interface IEditorHoverOptions {
	/**
	 * Enable the hover.
	 * Defaults to true.
	 */
	enabled?: boolean;
	/**
	 * Delay for showing the hover.
	 * Defaults to 300.
	 */
	delay?: number;
	/**
	 * Is the hover sticky such that it can be clicked and its contents selected?
	 * Defaults to true.
	 */
	sticky?: boolean;
}

A
Alex Dima 已提交
1758
export type EditorHoverOptions = Readonly<Required<IEditorHoverOptions>>;
A
Alex Dima 已提交
1759

1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789
class EditorHover extends BaseEditorOption<EditorOption.hover, EditorHoverOptions> {

	constructor() {
		const defaults: EditorHoverOptions = {
			enabled: true,
			delay: 300,
			sticky: true
		};
		super(
			EditorOption.hover, 'hover', defaults,
			{
				'editor.hover.enabled': {
					type: 'boolean',
					default: defaults.enabled,
					description: nls.localize('hover.enabled', "Controls whether the hover is shown.")
				},
				'editor.hover.delay': {
					type: 'number',
					default: defaults.delay,
					description: nls.localize('hover.delay', "Controls the delay in milliseconds after which the hover is shown.")
				},
				'editor.hover.sticky': {
					type: 'boolean',
					default: defaults.sticky,
					description: nls.localize('hover.sticky', "Controls whether the hover should remain visible when mouse is moved over it.")
				},
			}
		);
	}

A
Alex Dima 已提交
1790
	public validate(_input: any): EditorHoverOptions {
A
Alex Dima 已提交
1791
		if (!_input || typeof _input !== 'object') {
A
Alex Dima 已提交
1792 1793
			return this.defaultValue;
		}
A
Alex Dima 已提交
1794
		const input = _input as IEditorHoverOptions;
A
Alex Dima 已提交
1795
		return {
1796
			enabled: boolean(input.enabled, this.defaultValue.enabled),
A
Alex Dima 已提交
1797
			delay: EditorIntOption.clampedInt(input.delay, this.defaultValue.delay, 0, 10000),
1798
			sticky: boolean(input.sticky, this.defaultValue.sticky)
A
Alex Dima 已提交
1799 1800 1801 1802 1803 1804
		};
	}
}

//#endregion

A
Alex Dima 已提交
1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828
//#region layoutInfo

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

A
Alex Dima 已提交
1829 1830
export const enum RenderMinimap {
	None = 0,
1831 1832
	Text = 1,
	Blocks = 2,
A
Alex Dima 已提交
1833 1834
}

A
Alex Dima 已提交
1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852
/**
 * The internal layout details of the editor.
 */
export interface EditorLayoutInfo {

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

	/**
	 * Left position for the glyph margin.
	 */
	readonly glyphMarginLeft: number;
1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884
	/**
	 * The width of the glyph margin.
	 */
	readonly glyphMarginWidth: number;

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

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

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

1885
	/**
A
Alex Dima 已提交
1886
	 * Layout information for the minimap
1887
	 */
A
Alex Dima 已提交
1888
	readonly minimap: EditorMinimapLayoutInfo;
1889 1890 1891 1892 1893 1894

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

1895 1896 1897 1898
	readonly isWordWrapMinified: boolean;
	readonly isViewportWrapping: boolean;
	readonly wrappingColumn: number;

1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913
	/**
	 * 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;
}

A
Alex Dima 已提交
1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930
/**
 * The internal layout details of the editor.
 */
export interface EditorMinimapLayoutInfo {
	readonly renderMinimap: RenderMinimap;
	readonly minimapLeft: number;
	readonly minimapWidth: number;
	readonly minimapHeightIsEditorHeight: boolean;
	readonly minimapIsSampling: boolean;
	readonly minimapScale: number;
	readonly minimapLineHeight: number;
	readonly minimapCanvasInnerWidth: number;
	readonly minimapCanvasInnerHeight: number;
	readonly minimapCanvasOuterWidth: number;
	readonly minimapCanvasOuterHeight: number;
}

1931
/**
A
Alex Dima 已提交
1932
 * @internal
1933
 */
A
Alex Dima 已提交
1934
export interface EditorLayoutInfoComputerEnv {
1935
	readonly memory: ComputeOptionsMemory | null;
1936 1937
	readonly outerWidth: number;
	readonly outerHeight: number;
1938
	readonly isDominatedByLongLines: boolean;
1939 1940 1941 1942 1943 1944
	readonly lineHeight: number;
	readonly viewLineCount: number;
	readonly lineNumbersDigitCount: number;
	readonly typicalHalfwidthCharacterWidth: number;
	readonly maxDigitWidth: number;
	readonly pixelRatio: number;
1945
}
1946

1947 1948 1949 1950 1951 1952
/**
 * @internal
 */
export interface IEditorLayoutComputerInput {
	readonly outerWidth: number;
	readonly outerHeight: number;
1953
	readonly isDominatedByLongLines: boolean;
1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972
	readonly lineHeight: number;
	readonly lineNumbersDigitCount: number;
	readonly typicalHalfwidthCharacterWidth: number;
	readonly maxDigitWidth: number;
	readonly pixelRatio: number;
	readonly glyphMargin: boolean;
	readonly lineDecorationsWidth: string | number;
	readonly folding: boolean;
	readonly minimap: Readonly<Required<IEditorMinimapOptions>>;
	readonly scrollbar: InternalEditorScrollbarOptions;
	readonly lineNumbers: InternalEditorRenderLineNumbersOptions;
	readonly lineNumbersMinChars: number;
	readonly scrollBeyondLastLine: boolean;
	readonly wordWrap: 'wordWrapColumn' | 'on' | 'off' | 'bounded';
	readonly wordWrapColumn: number;
	readonly wordWrapMinified: boolean;
	readonly accessibilitySupport: AccessibilitySupport;
}

A
Alex Dima 已提交
1973 1974 1975 1976
/**
 * @internal
 */
export interface IMinimapLayoutInput {
A
Alex Dima 已提交
1977
	readonly outerWidth: number;
A
Alex Dima 已提交
1978 1979 1980 1981 1982 1983 1984 1985 1986 1987
	readonly outerHeight: number;
	readonly lineHeight: number;
	readonly typicalHalfwidthCharacterWidth: number;
	readonly pixelRatio: number;
	readonly scrollBeyondLastLine: boolean;
	readonly minimap: Readonly<Required<IEditorMinimapOptions>>;
	readonly verticalScrollbarWidth: number;
	readonly viewLineCount: number;
	readonly remainingWidth: number;
	readonly isViewportWrapping: boolean;
1988
}
1989 1990 1991 1992

/**
 * @internal
 */
1993
export class EditorLayoutInfoComputer extends ComputedEditorOption<EditorOption.layoutInfo, EditorLayoutInfo> {
1994

1995 1996 1997
	constructor() {
		super(
			EditorOption.layoutInfo,
1998 1999 2000
			[
				EditorOption.glyphMargin, EditorOption.lineDecorationsWidth, EditorOption.folding,
				EditorOption.minimap, EditorOption.scrollbar, EditorOption.lineNumbers,
2001
				EditorOption.lineNumbersMinChars, EditorOption.scrollBeyondLastLine,
2002
				EditorOption.wordWrap, EditorOption.wordWrapColumn, EditorOption.wordWrapOverride1, EditorOption.wordWrapOverride2,
2003 2004
				EditorOption.accessibilitySupport
			]
2005
		);
2006
	}
2007

A
Alex Dima 已提交
2008
	public compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, _: EditorLayoutInfo): EditorLayoutInfo {
A
Alex Dima 已提交
2009
		return EditorLayoutInfoComputer.computeLayout(options, {
2010
			memory: env.memory,
A
Alex Dima 已提交
2011 2012
			outerWidth: env.outerWidth,
			outerHeight: env.outerHeight,
2013
			isDominatedByLongLines: env.isDominatedByLongLines,
A
Alex Dima 已提交
2014
			lineHeight: env.fontInfo.lineHeight,
2015
			viewLineCount: env.viewLineCount,
A
Alex Dima 已提交
2016 2017 2018 2019 2020
			lineNumbersDigitCount: env.lineNumbersDigitCount,
			typicalHalfwidthCharacterWidth: env.fontInfo.typicalHalfwidthCharacterWidth,
			maxDigitWidth: env.fontInfo.maxDigitWidth,
			pixelRatio: env.pixelRatio
		});
2021 2022
	}

A
Alex Dima 已提交
2023
	public static computeContainedMinimapLineCount(input: {
2024
		viewLineCount: number;
A
Alex Dima 已提交
2025 2026 2027 2028
		scrollBeyondLastLine: boolean;
		height: number;
		lineHeight: number;
		pixelRatio: number;
2029 2030 2031
	}): { typicalViewportLineCount: number; extraLinesBeyondLastLine: number; desiredRatio: number; minimapLineCount: number; } {
		const typicalViewportLineCount = input.height / input.lineHeight;
		const extraLinesBeyondLastLine = input.scrollBeyondLastLine ? (typicalViewportLineCount - 1) : 0;
2032 2033
		const desiredRatio = (input.viewLineCount + extraLinesBeyondLastLine) / (input.pixelRatio * input.height);
		const minimapLineCount = Math.floor(input.viewLineCount / desiredRatio);
2034
		return { typicalViewportLineCount, extraLinesBeyondLastLine, desiredRatio, minimapLineCount };
A
Alex Dima 已提交
2035 2036
	}

A
Alex Dima 已提交
2037 2038
	private static _computeMinimapLayout(input: IMinimapLayoutInput, memory: ComputeOptionsMemory): EditorMinimapLayoutInfo {
		const outerWidth = input.outerWidth;
A
Alex Dima 已提交
2039 2040 2041
		const outerHeight = input.outerHeight;
		const pixelRatio = input.pixelRatio;

A
Alex Dima 已提交
2042 2043
		if (!input.minimap.enabled) {
			return {
A
Alex Dima 已提交
2044 2045
				renderMinimap: RenderMinimap.None,
				minimapLeft: 0,
A
Alex Dima 已提交
2046 2047 2048 2049 2050 2051
				minimapWidth: 0,
				minimapHeightIsEditorHeight: false,
				minimapIsSampling: false,
				minimapScale: 1,
				minimapLineHeight: 1,
				minimapCanvasInnerWidth: 0,
A
Alex Dima 已提交
2052
				minimapCanvasInnerHeight: Math.floor(pixelRatio * outerHeight),
A
Alex Dima 已提交
2053
				minimapCanvasOuterWidth: 0,
A
Alex Dima 已提交
2054
				minimapCanvasOuterHeight: outerHeight,
A
Alex Dima 已提交
2055 2056 2057
			};
		}

A
Alex Dima 已提交
2058 2059 2060 2061
		// Can use memory if only the `viewLineCount` and `remainingWidth` have changed
		const stableMinimapLayoutInput = memory.stableMinimapLayoutInput;
		const couldUseMemory = (
			stableMinimapLayoutInput
A
Alex Dima 已提交
2062
			// && input.outerWidth === lastMinimapLayoutInput.outerWidth !!! INTENTIONAL OMITTED
A
Alex Dima 已提交
2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080
			&& input.outerHeight === stableMinimapLayoutInput.outerHeight
			&& input.lineHeight === stableMinimapLayoutInput.lineHeight
			&& input.typicalHalfwidthCharacterWidth === stableMinimapLayoutInput.typicalHalfwidthCharacterWidth
			&& input.pixelRatio === stableMinimapLayoutInput.pixelRatio
			&& input.scrollBeyondLastLine === stableMinimapLayoutInput.scrollBeyondLastLine
			&& input.minimap.enabled === stableMinimapLayoutInput.minimap.enabled
			&& input.minimap.side === stableMinimapLayoutInput.minimap.side
			&& input.minimap.size === stableMinimapLayoutInput.minimap.size
			&& input.minimap.showSlider === stableMinimapLayoutInput.minimap.showSlider
			&& input.minimap.renderCharacters === stableMinimapLayoutInput.minimap.renderCharacters
			&& input.minimap.maxColumn === stableMinimapLayoutInput.minimap.maxColumn
			&& input.minimap.scale === stableMinimapLayoutInput.minimap.scale
			&& input.verticalScrollbarWidth === stableMinimapLayoutInput.verticalScrollbarWidth
			// && input.viewLineCount === lastMinimapLayoutInput.viewLineCount !!! INTENTIONAL OMITTED
			// && input.remainingWidth === lastMinimapLayoutInput.remainingWidth !!! INTENTIONAL OMITTED
			&& input.isViewportWrapping === stableMinimapLayoutInput.isViewportWrapping
		);

2081 2082 2083 2084 2085 2086 2087
		const lineHeight = input.lineHeight;
		const typicalHalfwidthCharacterWidth = input.typicalHalfwidthCharacterWidth;
		const scrollBeyondLastLine = input.scrollBeyondLastLine;
		const minimapRenderCharacters = input.minimap.renderCharacters;
		let minimapScale = (pixelRatio >= 2 ? Math.round(input.minimap.scale * 2) : input.minimap.scale);
		const minimapMaxColumn = input.minimap.maxColumn;
		const minimapSize = input.minimap.size;
A
Alex Dima 已提交
2088
		const minimapSide = input.minimap.side;
A
Alex Dima 已提交
2089 2090 2091 2092
		const verticalScrollbarWidth = input.verticalScrollbarWidth;
		const viewLineCount = input.viewLineCount;
		const remainingWidth = input.remainingWidth;
		const isViewportWrapping = input.isViewportWrapping;
2093

2094
		const baseCharHeight = minimapRenderCharacters ? 2 : 3;
2095 2096
		let minimapCanvasInnerHeight = Math.floor(pixelRatio * outerHeight);
		const minimapCanvasOuterHeight = minimapCanvasInnerHeight / pixelRatio;
A
Alex Dima 已提交
2097
		let minimapHeightIsEditorHeight = false;
2098
		let minimapIsSampling = false;
2099
		let minimapLineHeight = baseCharHeight * minimapScale;
A
Alex Dima 已提交
2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121
		let minimapCharWidth = minimapScale / pixelRatio;
		let minimapWidthMultiplier: number = 1;

		if (minimapSize === 'fill' || minimapSize === 'fit') {
			const { typicalViewportLineCount, extraLinesBeyondLastLine, desiredRatio, minimapLineCount } = EditorLayoutInfoComputer.computeContainedMinimapLineCount({
				viewLineCount: viewLineCount,
				scrollBeyondLastLine: scrollBeyondLastLine,
				height: outerHeight,
				lineHeight: lineHeight,
				pixelRatio: pixelRatio
			});
			// ratio is intentionally not part of the layout to avoid the layout changing all the time
			// when doing sampling
			const ratio = viewLineCount / minimapLineCount;

			if (ratio > 1) {
				minimapHeightIsEditorHeight = true;
				minimapIsSampling = true;
				minimapScale = 1;
				minimapLineHeight = 1;
				minimapCharWidth = minimapScale / pixelRatio;
			} else {
A
Alex Dima 已提交
2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136
				let fitBecomesFill = false;
				let maxMinimapScale = minimapScale + 1;

				if (minimapSize === 'fit') {
					const effectiveMinimapHeight = Math.ceil((viewLineCount + extraLinesBeyondLastLine) * minimapLineHeight);
					if (isViewportWrapping && couldUseMemory && remainingWidth <= memory.stableFitRemainingWidth) {
						// There is a loop when using `fit` and viewport wrapping:
						// - view line count impacts minimap layout
						// - minimap layout impacts viewport width
						// - viewport width impacts view line count
						// To break the loop, once we go to a smaller minimap scale, we try to stick with it.
						fitBecomesFill = true;
						maxMinimapScale = memory.stableFitMaxMinimapScale;
					} else {
						fitBecomesFill = (effectiveMinimapHeight > minimapCanvasInnerHeight);
A
Alex Dima 已提交
2137
					}
A
Alex Dima 已提交
2138 2139 2140
				}

				if (minimapSize === 'fill' || fitBecomesFill) {
A
Alex Dima 已提交
2141
					minimapHeightIsEditorHeight = true;
A
Alex Dima 已提交
2142
					const configuredMinimapScale = minimapScale;
A
Alex Dima 已提交
2143
					minimapLineHeight = Math.min(lineHeight * pixelRatio, Math.max(1, Math.floor(1 / desiredRatio)));
2144 2145 2146 2147 2148 2149 2150 2151
					if (isViewportWrapping && couldUseMemory && remainingWidth <= memory.stableFitRemainingWidth) {
						// There is a loop when using `fill` and viewport wrapping:
						// - view line count impacts minimap layout
						// - minimap layout impacts viewport width
						// - viewport width impacts view line count
						// To break the loop, once we go to a smaller minimap scale, we try to stick with it.
						maxMinimapScale = memory.stableFitMaxMinimapScale;
					}
A
Alex Dima 已提交
2152 2153 2154
					minimapScale = Math.min(maxMinimapScale, Math.max(1, Math.floor(minimapLineHeight / baseCharHeight)));
					if (minimapScale > configuredMinimapScale) {
						minimapWidthMultiplier = Math.min(2, minimapScale / configuredMinimapScale);
2155
					}
A
Alex Dima 已提交
2156 2157
					minimapCharWidth = minimapScale / pixelRatio / minimapWidthMultiplier;
					minimapCanvasInnerHeight = Math.ceil((Math.max(typicalViewportLineCount, viewLineCount + extraLinesBeyondLastLine)) * minimapLineHeight);
2158 2159 2160 2161
					if (isViewportWrapping) {
						// remember for next time
						memory.stableMinimapLayoutInput = input;
						memory.stableFitRemainingWidth = remainingWidth;
A
Alex Dima 已提交
2162
						memory.stableFitMaxMinimapScale = minimapScale;
2163 2164 2165
					} else {
						memory.stableMinimapLayoutInput = null;
						memory.stableFitRemainingWidth = 0;
A
Alex Dima 已提交
2166
					}
2167 2168
				}
			}
A
Alex Dima 已提交
2169
		}
2170

A
Alex Dima 已提交
2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183
		// Given:
		// (leaving 2px for the cursor to have space after the last character)
		// viewportColumn = (contentWidth - verticalScrollbarWidth - 2) / typicalHalfwidthCharacterWidth
		// minimapWidth = viewportColumn * minimapCharWidth
		// contentWidth = remainingWidth - minimapWidth
		// What are good values for contentWidth and minimapWidth ?

		// 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)

A
Alex Dima 已提交
2184 2185
		const minimapMaxWidth = Math.floor(minimapMaxColumn * minimapCharWidth);
		const minimapWidth = Math.min(minimapMaxWidth, Math.max(0, Math.floor(((remainingWidth - verticalScrollbarWidth - 2) * minimapCharWidth) / (typicalHalfwidthCharacterWidth + minimapCharWidth))) + MINIMAP_GUTTER_WIDTH);
A
Alex Dima 已提交
2186

A
Alex Dima 已提交
2187 2188
		let minimapCanvasInnerWidth = Math.floor(pixelRatio * minimapWidth);
		const minimapCanvasOuterWidth = minimapCanvasInnerWidth / pixelRatio;
A
Alex Dima 已提交
2189 2190
		minimapCanvasInnerWidth = Math.floor(minimapCanvasInnerWidth * minimapWidthMultiplier);

A
Alex Dima 已提交
2191 2192 2193
		const renderMinimap = (minimapRenderCharacters ? RenderMinimap.Text : RenderMinimap.Blocks);
		const minimapLeft = (minimapSide === 'left' ? 0 : (outerWidth - minimapWidth - verticalScrollbarWidth));

A
Alex Dima 已提交
2194
		return {
A
Alex Dima 已提交
2195 2196
			renderMinimap,
			minimapLeft,
A
Alex Dima 已提交
2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208
			minimapWidth,
			minimapHeightIsEditorHeight,
			minimapIsSampling,
			minimapScale,
			minimapLineHeight,
			minimapCanvasInnerWidth,
			minimapCanvasInnerHeight,
			minimapCanvasOuterWidth,
			minimapCanvasOuterHeight,
		};
	}

A
Alex Dima 已提交
2209 2210 2211 2212 2213 2214 2215 2216
	public static computeLayout(options: IComputedEditorOptions, env: EditorLayoutInfoComputerEnv): EditorLayoutInfo {
		const outerWidth = env.outerWidth | 0;
		const outerHeight = env.outerHeight | 0;
		const lineHeight = env.lineHeight | 0;
		const lineNumbersDigitCount = env.lineNumbersDigitCount | 0;
		const typicalHalfwidthCharacterWidth = env.typicalHalfwidthCharacterWidth;
		const maxDigitWidth = env.maxDigitWidth;
		const pixelRatio = env.pixelRatio;
A
Alex Dima 已提交
2217 2218
		const viewLineCount = env.viewLineCount;

2219 2220 2221 2222
		const wordWrapOverride2 = options.get(EditorOption.wordWrapOverride2);
		const wordWrapOverride1 = (wordWrapOverride2 === 'inherit' ? options.get(EditorOption.wordWrapOverride1) : wordWrapOverride2);
		const wordWrap = (wordWrapOverride1 === 'inherit' ? options.get(EditorOption.wordWrap) : wordWrapOverride1);

A
Alex Dima 已提交
2223 2224 2225
		const wordWrapColumn = options.get(EditorOption.wordWrapColumn);
		const accessibilitySupport = options.get(EditorOption.accessibilitySupport);
		const isDominatedByLongLines = env.isDominatedByLongLines;
A
Alex Dima 已提交
2226 2227 2228

		const showGlyphMargin = options.get(EditorOption.glyphMargin);
		const showLineNumbers = (options.get(EditorOption.lineNumbers).renderType !== RenderLineNumbersType.Off);
A
Alex Dima 已提交
2229
		const lineNumbersMinChars = options.get(EditorOption.lineNumbersMinChars);
2230
		const scrollBeyondLastLine = options.get(EditorOption.scrollBeyondLastLine);
A
renames  
Alex Dima 已提交
2231
		const minimap = options.get(EditorOption.minimap);
A
Alex Dima 已提交
2232

A
renames  
Alex Dima 已提交
2233
		const scrollbar = options.get(EditorOption.scrollbar);
A
Alex Dima 已提交
2234
		const verticalScrollbarWidth = scrollbar.verticalScrollbarSize;
A
Alex Dima 已提交
2235
		const verticalScrollbarHasArrows = scrollbar.verticalHasArrows;
A
Alex Dima 已提交
2236 2237
		const scrollbarArrowSize = scrollbar.arrowSize;
		const horizontalScrollbarHeight = scrollbar.horizontalScrollbarSize;
A
Alex Dima 已提交
2238 2239 2240

		const rawLineDecorationsWidth = options.get(EditorOption.lineDecorationsWidth);
		const folding = options.get(EditorOption.folding);
A
Alex Dima 已提交
2241 2242 2243 2244

		let lineDecorationsWidth: number;
		if (typeof rawLineDecorationsWidth === 'string' && /^\d+(\.\d+)?ch$/.test(rawLineDecorationsWidth)) {
			const multiple = parseFloat(rawLineDecorationsWidth.substr(0, rawLineDecorationsWidth.length - 2));
A
Alex Dima 已提交
2245
			lineDecorationsWidth = EditorIntOption.clampedInt(multiple * typicalHalfwidthCharacterWidth, 0, 0, 1000);
A
Alex Dima 已提交
2246
		} else {
A
Alex Dima 已提交
2247
			lineDecorationsWidth = EditorIntOption.clampedInt(rawLineDecorationsWidth, 0, 0, 1000);
A
Alex Dima 已提交
2248 2249 2250
		}
		if (folding) {
			lineDecorationsWidth += 16;
2251 2252
		}

A
Alex Dima 已提交
2253 2254 2255 2256 2257
		let lineNumbersWidth = 0;
		if (showLineNumbers) {
			const digitCount = Math.max(lineNumbersDigitCount, lineNumbersMinChars);
			lineNumbersWidth = Math.round(digitCount * maxDigitWidth);
		}
2258

A
Alex Dima 已提交
2259 2260 2261 2262
		let glyphMarginWidth = 0;
		if (showGlyphMargin) {
			glyphMarginWidth = lineHeight;
		}
2263

A
Alex Dima 已提交
2264 2265 2266 2267 2268 2269 2270
		let glyphMarginLeft = 0;
		let lineNumbersLeft = glyphMarginLeft + glyphMarginWidth;
		let decorationsLeft = lineNumbersLeft + lineNumbersWidth;
		let contentLeft = decorationsLeft + lineDecorationsWidth;

		const remainingWidth = outerWidth - glyphMarginWidth - lineNumbersWidth - lineDecorationsWidth;

A
Alex Dima 已提交
2271 2272 2273
		let isWordWrapMinified = false;
		let isViewportWrapping = false;
		let wrappingColumn = -1;
2274

A
Alex Dima 已提交
2275
		if (accessibilitySupport !== AccessibilitySupport.Enabled) {
C
ChaseKnowlden 已提交
2276
			// See https://github.com/microsoft/vscode/issues/27766
A
Alex Dima 已提交
2277 2278 2279
			// 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.
2280
			if (wordWrapOverride1 === 'inherit' && isDominatedByLongLines) {
A
Alex Dima 已提交
2281 2282 2283 2284 2285 2286 2287
				// Force viewport width wrapping if model is dominated by long lines
				isWordWrapMinified = true;
				isViewportWrapping = true;
			} else if (wordWrap === 'on' || wordWrap === 'bounded') {
				isViewportWrapping = true;
			} else if (wordWrap === 'wordWrapColumn') {
				wrappingColumn = wordWrapColumn;
A
Alex Dima 已提交
2288
			}
A
Alex Dima 已提交
2289
		}
2290

A
Alex Dima 已提交
2291 2292
		const minimapLayout = EditorLayoutInfoComputer._computeMinimapLayout({
			outerWidth: outerWidth,
A
Alex Dima 已提交
2293 2294 2295 2296 2297 2298 2299 2300 2301 2302
			outerHeight: outerHeight,
			lineHeight: lineHeight,
			typicalHalfwidthCharacterWidth: typicalHalfwidthCharacterWidth,
			pixelRatio: pixelRatio,
			scrollBeyondLastLine: scrollBeyondLastLine,
			minimap: minimap,
			verticalScrollbarWidth: verticalScrollbarWidth,
			viewLineCount: viewLineCount,
			remainingWidth: remainingWidth,
			isViewportWrapping: isViewportWrapping,
A
Alex Dima 已提交
2303
		}, env.memory || new ComputeOptionsMemory());
A
Alex Dima 已提交
2304

A
Alex Dima 已提交
2305 2306 2307 2308 2309 2310
		if (minimapLayout.renderMinimap !== RenderMinimap.None && minimapLayout.minimapLeft === 0) {
			// the minimap is rendered to the left, so move everything to the right
			glyphMarginLeft += minimapLayout.minimapWidth;
			lineNumbersLeft += minimapLayout.minimapWidth;
			decorationsLeft += minimapLayout.minimapWidth;
			contentLeft += minimapLayout.minimapWidth;
2311
		}
A
Alex Dima 已提交
2312
		const contentWidth = remainingWidth - minimapLayout.minimapWidth;
2313

A
Alex Dima 已提交
2314 2315 2316 2317 2318
		// (leaving 2px for the cursor to have space after the last character)
		const viewportColumn = Math.max(1, Math.floor((contentWidth - verticalScrollbarWidth - 2) / typicalHalfwidthCharacterWidth));

		const verticalArrowSize = (verticalScrollbarHasArrows ? scrollbarArrowSize : 0);

2319 2320 2321 2322 2323
		if (isViewportWrapping) {
			// compute the actual wrappingColumn
			wrappingColumn = Math.max(1, viewportColumn);
			if (wordWrap === 'bounded') {
				wrappingColumn = Math.min(wrappingColumn, wordWrapColumn);
2324 2325 2326
			}
		}

A
Alex Dima 已提交
2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342
		return {
			width: outerWidth,
			height: outerHeight,

			glyphMarginLeft: glyphMarginLeft,
			glyphMarginWidth: glyphMarginWidth,

			lineNumbersLeft: lineNumbersLeft,
			lineNumbersWidth: lineNumbersWidth,

			decorationsLeft: decorationsLeft,
			decorationsWidth: lineDecorationsWidth,

			contentLeft: contentLeft,
			contentWidth: contentWidth,

A
Alex Dima 已提交
2343
			minimap: minimapLayout,
A
Alex Dima 已提交
2344 2345 2346

			viewportColumn: viewportColumn,

2347 2348 2349
			isWordWrapMinified: isWordWrapMinified,
			isViewportWrapping: isViewportWrapping,
			wrappingColumn: wrappingColumn,
2350

A
Alex Dima 已提交
2351 2352 2353 2354 2355 2356 2357 2358 2359 2360
			verticalScrollbarWidth: verticalScrollbarWidth,
			horizontalScrollbarHeight: horizontalScrollbarHeight,

			overviewRuler: {
				top: verticalArrowSize,
				width: verticalScrollbarWidth,
				height: (outerHeight - 2 * verticalArrowSize),
				right: 0
			}
		};
2361 2362 2363
	}
}

A
Alex Dima 已提交
2364 2365
//#endregion

A
Alex Dima 已提交
2366 2367
//#region lightbulb

2368 2369 2370 2371 2372 2373 2374 2375 2376
/**
 * Configuration options for editor lightbulb
 */
export interface IEditorLightbulbOptions {
	/**
	 * Enable the lightbulb code action.
	 * Defaults to true.
	 */
	enabled?: boolean;
2377 2378
}

A
Alex Dima 已提交
2379
export type EditorLightbulbOptions = Readonly<Required<IEditorLightbulbOptions>>;
A
Alex Dima 已提交
2380

2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394
class EditorLightbulb extends BaseEditorOption<EditorOption.lightbulb, EditorLightbulbOptions> {

	constructor() {
		const defaults: EditorLightbulbOptions = { enabled: true };
		super(
			EditorOption.lightbulb, 'lightbulb', defaults,
			{
				'editor.lightbulb.enabled': {
					type: 'boolean',
					default: defaults.enabled,
					description: nls.localize('codeActions', "Enables the code action lightbulb in the editor.")
				},
			}
		);
2395
	}
2396

A
Alex Dima 已提交
2397
	public validate(_input: any): EditorLightbulbOptions {
A
Alex Dima 已提交
2398
		if (!_input || typeof _input !== 'object') {
A
Alex Dima 已提交
2399 2400 2401 2402
			return this.defaultValue;
		}
		const input = _input as IEditorLightbulbOptions;
		return {
2403
			enabled: boolean(input.enabled, this.defaultValue.enabled)
A
Alex Dima 已提交
2404
		};
2405 2406 2407
	}
}

A
Alex Dima 已提交
2408 2409
//#endregion

2410
//#region inlayHints
K
kingwl 已提交
2411 2412

/**
2413
 * Configuration options for editor inlayHints
K
kingwl 已提交
2414
 */
2415
export interface IEditorInlayHintsOptions {
K
kingwl 已提交
2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434
	/**
	 * Enable the inline hints.
	 * Defaults to true.
	 */
	enabled?: boolean;

	/**
	 * Font size of inline hints.
	 * Default to 90% of the editor font size.
	 */
	fontSize?: number;

	/**
	 * Font family of inline hints.
	 * Defaults to editor font family.
	 */
	fontFamily?: string;
}

2435
export type EditorInlayHintsOptions = Readonly<Required<IEditorInlayHintsOptions>>;
K
kingwl 已提交
2436

2437
class EditorInlayHints extends BaseEditorOption<EditorOption.inlayHints, EditorInlayHintsOptions> {
K
kingwl 已提交
2438 2439

	constructor() {
2440
		const defaults: EditorInlayHintsOptions = { enabled: true, fontSize: 0, fontFamily: EDITOR_FONT_DEFAULTS.fontFamily };
K
kingwl 已提交
2441
		super(
2442
			EditorOption.inlayHints, 'inlayHints', defaults,
K
kingwl 已提交
2443
			{
2444
				'editor.inlayHints.enabled': {
K
kingwl 已提交
2445 2446
					type: 'boolean',
					default: defaults.enabled,
2447
					description: nls.localize('inlayHints.enable', "Enables the inlay hints in the editor.")
K
kingwl 已提交
2448
				},
2449
				'editor.inlayHints.fontSize': {
K
kingwl 已提交
2450 2451
					type: 'number',
					default: defaults.fontSize,
2452
					markdownDescription: nls.localize('inlayHints.fontSize', "Controls font size of inlay hints in the editor. When set to `0`, the 90% of `#editor.fontSize#` is used.")
K
kingwl 已提交
2453
				},
2454
				'editor.inlayHints.fontFamily': {
K
kingwl 已提交
2455 2456
					type: 'string',
					default: defaults.fontFamily,
2457
					description: nls.localize('inlayHints.fontFamily', "Controls font family of inlay hints in the editor.")
K
kingwl 已提交
2458 2459 2460 2461 2462
				},
			}
		);
	}

2463
	public validate(_input: any): EditorInlayHintsOptions {
K
kingwl 已提交
2464 2465 2466
		if (!_input || typeof _input !== 'object') {
			return this.defaultValue;
		}
2467
		const input = _input as IEditorInlayHintsOptions;
K
kingwl 已提交
2468 2469 2470 2471 2472 2473 2474 2475 2476 2477
		return {
			enabled: boolean(input.enabled, this.defaultValue.enabled),
			fontSize: EditorIntOption.clampedInt(input.fontSize, this.defaultValue.fontSize, 0, 100),
			fontFamily: EditorStringOption.string(input.fontFamily, this.defaultValue.fontFamily)
		};
	}
}

//#endregion

A
Alex Dima 已提交
2478 2479
//#region lineHeight

2480
class EditorLineHeight extends EditorFloatOption<EditorOption.lineHeight> {
2481 2482 2483 2484

	constructor() {
		super(
			EditorOption.lineHeight, 'lineHeight',
2485 2486
			EDITOR_FONT_DEFAULTS.lineHeight,
			x => EditorFloatOption.clamp(x, 0, 150),
2487
			{ markdownDescription: nls.localize('lineHeight', "Controls the line height. \n - Use 0 to automatically compute the line height from the font size.\n - Values between 0 and 8 will be used as a multiplier with the font size.\n - Values greater than 8 will be used as effective values.") }
2488
		);
2489
	}
2490

2491
	public override compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, value: number): number {
A
Alex Dima 已提交
2492 2493 2494 2495
		// The lineHeight is computed from the fontSize if it is 0.
		// Moreover, the final lineHeight respects the editor zoom level.
		// So take the result from env.fontInfo
		return env.fontInfo.lineHeight;
2496 2497 2498
	}
}

A
Alex Dima 已提交
2499 2500 2501 2502
//#endregion

//#region minimap

2503
/**
2504
 * Configuration options for editor minimap
2505
 */
2506
export interface IEditorMinimapOptions {
2507
	/**
2508 2509
	 * Enable the rendering of the minimap.
	 * Defaults to true.
2510
	 */
2511 2512 2513 2514 2515 2516
	enabled?: boolean;
	/**
	 * Control the side of the minimap in editor.
	 * Defaults to 'right'.
	 */
	side?: 'right' | 'left';
A
Alex Dima 已提交
2517 2518 2519 2520
	/**
	 * Control the minimap rendering mode.
	 * Defaults to 'actual'.
	 */
2521
	size?: 'proportional' | 'fill' | 'fit';
2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536
	/**
	 * Control the rendering of the minimap slider.
	 * Defaults to 'mouseover'.
	 */
	showSlider?: 'always' | 'mouseover';
	/**
	 * 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;
2537 2538 2539 2540
	/**
	 * Relative size of the font in the minimap. Defaults to 1.
	 */
	scale?: number;
2541
}
A
Alex Dima 已提交
2542

A
Alex Dima 已提交
2543
export type EditorMinimapOptions = Readonly<Required<IEditorMinimapOptions>>;
A
Alex Dima 已提交
2544

2545
class EditorMinimap extends BaseEditorOption<EditorOption.minimap, EditorMinimapOptions> {
A
Alex Dima 已提交
2546

2547 2548 2549
	constructor() {
		const defaults: EditorMinimapOptions = {
			enabled: true,
2550
			size: 'proportional',
2551 2552 2553 2554
			side: 'right',
			showSlider: 'mouseover',
			renderCharacters: true,
			maxColumn: 120,
2555
			scale: 1,
2556 2557 2558 2559 2560 2561 2562 2563 2564
		};
		super(
			EditorOption.minimap, 'minimap', defaults,
			{
				'editor.minimap.enabled': {
					type: 'boolean',
					default: defaults.enabled,
					description: nls.localize('minimap.enabled', "Controls whether the minimap is shown.")
				},
2565
				'editor.minimap.size': {
A
Alex Dima 已提交
2566
					type: 'string',
2567
					enum: ['proportional', 'fill', 'fit'],
A
Alex Dima 已提交
2568
					enumDescriptions: [
2569 2570 2571
						nls.localize('minimap.size.proportional', "The minimap has the same size as the editor contents (and might scroll)."),
						nls.localize('minimap.size.fill', "The minimap will stretch or shrink as necessary to fill the height of the editor (no scrolling)."),
						nls.localize('minimap.size.fit', "The minimap will shrink as necessary to never be larger than the editor (no scrolling)."),
A
Alex Dima 已提交
2572
					],
2573 2574
					default: defaults.size,
					description: nls.localize('minimap.size', "Controls the size of the minimap.")
A
Alex Dima 已提交
2575
				},
2576 2577 2578 2579 2580 2581 2582 2583 2584 2585
				'editor.minimap.side': {
					type: 'string',
					enum: ['left', 'right'],
					default: defaults.side,
					description: nls.localize('minimap.side', "Controls the side where to render the minimap.")
				},
				'editor.minimap.showSlider': {
					type: 'string',
					enum: ['always', 'mouseover'],
					default: defaults.showSlider,
2586
					description: nls.localize('minimap.showSlider', "Controls when the minimap slider is shown.")
2587
				},
2588 2589 2590 2591 2592
				'editor.minimap.scale': {
					type: 'number',
					default: defaults.scale,
					minimum: 1,
					maximum: 3,
2593 2594
					enum: [1, 2, 3],
					description: nls.localize('minimap.scale', "Scale of content drawn in the minimap: 1, 2 or 3.")
2595 2596 2597 2598 2599 2600 2601 2602 2603 2604
				},
				'editor.minimap.renderCharacters': {
					type: 'boolean',
					default: defaults.renderCharacters,
					description: nls.localize('minimap.renderCharacters', "Render the actual characters on a line as opposed to color blocks.")
				},
				'editor.minimap.maxColumn': {
					type: 'number',
					default: defaults.maxColumn,
					description: nls.localize('minimap.maxColumn', "Limit the width of the minimap to render at most a certain number of columns.")
A
Alex Dima 已提交
2605
				}
2606
			}
2607 2608
		);
	}
J
Jackson Kearl 已提交
2609

A
Alex Dima 已提交
2610
	public validate(_input: any): EditorMinimapOptions {
A
Alex Dima 已提交
2611
		if (!_input || typeof _input !== 'object') {
A
Alex Dima 已提交
2612 2613 2614
			return this.defaultValue;
		}
		const input = _input as IEditorMinimapOptions;
A
Alex Dima 已提交
2615
		return {
2616
			enabled: boolean(input.enabled, this.defaultValue.enabled),
2617 2618 2619
			size: stringSet<'proportional' | 'fill' | 'fit'>(input.size, this.defaultValue.size, ['proportional', 'fill', 'fit']),
			side: stringSet<'right' | 'left'>(input.side, this.defaultValue.side, ['right', 'left']),
			showSlider: stringSet<'always' | 'mouseover'>(input.showSlider, this.defaultValue.showSlider, ['always', 'mouseover']),
2620
			renderCharacters: boolean(input.renderCharacters, this.defaultValue.renderCharacters),
2621
			scale: EditorIntOption.clampedInt(input.scale, 1, 1, 3),
A
Alex Dima 已提交
2622
			maxColumn: EditorIntOption.clampedInt(input.maxColumn, this.defaultValue.maxColumn, 1, 10000),
A
Alex Dima 已提交
2623 2624
		};
	}
A
Alex Dima 已提交
2625
}
A
Alex Dima 已提交
2626

A
Alex Dima 已提交
2627
//#endregion
A
Alex Dima 已提交
2628

A
Alex Dima 已提交
2629
//#region multiCursorModifier
A
Alex Dima 已提交
2630

A
Alex Dima 已提交
2631 2632 2633 2634 2635
function _multiCursorModifierFromString(multiCursorModifier: 'ctrlCmd' | 'alt'): 'altKey' | 'metaKey' | 'ctrlKey' {
	if (multiCursorModifier === 'ctrlCmd') {
		return (platform.isMacintosh ? 'metaKey' : 'ctrlKey');
	}
	return 'altKey';
A
Alex Dima 已提交
2636
}
A
Alex Dima 已提交
2637

A
Alex Dima 已提交
2638
//#endregion
A
Alex Dima 已提交
2639

B
Bailey 已提交
2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669
//#region padding

/**
 * Configuration options for editor padding
 */
export interface IEditorPaddingOptions {
	/**
	 * Spacing between top edge of editor and first line.
	 */
	top?: number;
	/**
	 * Spacing between bottom edge of editor and last line.
	 */
	bottom?: number;
}

export interface InternalEditorPaddingOptions {
	readonly top: number;
	readonly bottom: number;
}

class EditorPadding extends BaseEditorOption<EditorOption.padding, InternalEditorPaddingOptions> {

	constructor() {
		super(
			EditorOption.padding, 'padding', { top: 0, bottom: 0 },
			{
				'editor.padding.top': {
					type: 'number',
					default: 0,
B
Bailey 已提交
2670 2671
					minimum: 0,
					maximum: 1000,
B
Bailey 已提交
2672 2673 2674 2675 2676
					description: nls.localize('padding.top', "Controls the amount of space between the top edge of the editor and the first line.")
				},
				'editor.padding.bottom': {
					type: 'number',
					default: 0,
B
Bailey 已提交
2677 2678
					minimum: 0,
					maximum: 1000,
B
Bailey 已提交
2679 2680 2681 2682 2683 2684 2685
					description: nls.localize('padding.bottom', "Controls the amount of space between the bottom edge of the editor and the last line.")
				}
			}
		);
	}

	public validate(_input: any): InternalEditorPaddingOptions {
A
Alex Dima 已提交
2686
		if (!_input || typeof _input !== 'object') {
B
Bailey 已提交
2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698
			return this.defaultValue;
		}
		const input = _input as IEditorPaddingOptions;

		return {
			top: EditorIntOption.clampedInt(input.top, 0, 0, 1000),
			bottom: EditorIntOption.clampedInt(input.bottom, 0, 0, 1000)
		};
	}
}
//#endregion

A
Alex Dima 已提交
2699
//#region parameterHints
A
Alex Dima 已提交
2700

2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716
/**
 * 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;
}

A
Alex Dima 已提交
2717 2718
export type InternalParameterHintOptions = Readonly<Required<IEditorParameterHintOptions>>;

2719 2720 2721 2722 2723 2724
class EditorParameterHints extends BaseEditorOption<EditorOption.parameterHints, InternalParameterHintOptions> {

	constructor() {
		const defaults: InternalParameterHintOptions = {
			enabled: true,
			cycle: false
A
Alex Dima 已提交
2725
		};
2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740
		super(
			EditorOption.parameterHints, 'parameterHints', defaults,
			{
				'editor.parameterHints.enabled': {
					type: 'boolean',
					default: defaults.enabled,
					description: nls.localize('parameterHints.enabled', "Enables a pop-up that shows parameter documentation and type information as you type.")
				},
				'editor.parameterHints.cycle': {
					type: 'boolean',
					default: defaults.cycle,
					description: nls.localize('parameterHints.cycle', "Controls whether the parameter hints menu cycles or closes when reaching the end of the list.")
				},
			}
		);
A
Alex Dima 已提交
2741 2742
	}

A
Alex Dima 已提交
2743
	public validate(_input: any): InternalParameterHintOptions {
A
Alex Dima 已提交
2744
		if (!_input || typeof _input !== 'object') {
A
Alex Dima 已提交
2745
			return this.defaultValue;
A
Alex Dima 已提交
2746
		}
A
Alex Dima 已提交
2747
		const input = _input as IEditorParameterHintOptions;
A
Alex Dima 已提交
2748
		return {
2749 2750
			enabled: boolean(input.enabled, this.defaultValue.enabled),
			cycle: boolean(input.cycle, this.defaultValue.cycle)
A
Alex Dima 已提交
2751 2752
		};
	}
A
Alex Dima 已提交
2753
}
A
Alex Dima 已提交
2754

A
Alex Dima 已提交
2755
//#endregion
2756

A
Alex Dima 已提交
2757
//#region pixelRatio
2758

2759
class EditorPixelRatio extends ComputedEditorOption<EditorOption.pixelRatio, number> {
2760

2761 2762
	constructor() {
		super(EditorOption.pixelRatio);
2763 2764
	}

A
Alex Dima 已提交
2765 2766
	public compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, _: number): number {
		return env.pixelRatio;
A
Alex Dima 已提交
2767
	}
A
Alex Dima 已提交
2768
}
A
Alex Dima 已提交
2769

A
Alex Dima 已提交
2770 2771 2772 2773
//#endregion

//#region quickSuggestions

2774 2775 2776 2777
/**
 * Configuration options for quick suggestions
 */
export interface IQuickSuggestionsOptions {
A
Alex Dima 已提交
2778 2779 2780
	other?: boolean;
	comments?: boolean;
	strings?: boolean;
2781 2782
}

A
Alex Dima 已提交
2783 2784
export type ValidQuickSuggestionsOptions = boolean | Readonly<Required<IQuickSuggestionsOptions>>;

2785 2786
class EditorQuickSuggestions extends BaseEditorOption<EditorOption.quickSuggestions, ValidQuickSuggestionsOptions> {

2787
	public override readonly defaultValue: Readonly<Required<IQuickSuggestionsOptions>>;
2788 2789 2790 2791 2792 2793

	constructor() {
		const defaults: ValidQuickSuggestionsOptions = {
			other: true,
			comments: false,
			strings: false
2794
		};
2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826
		super(
			EditorOption.quickSuggestions, 'quickSuggestions', defaults,
			{
				anyOf: [
					{
						type: 'boolean',
					},
					{
						type: 'object',
						properties: {
							strings: {
								type: 'boolean',
								default: defaults.strings,
								description: nls.localize('quickSuggestions.strings', "Enable quick suggestions inside strings.")
							},
							comments: {
								type: 'boolean',
								default: defaults.comments,
								description: nls.localize('quickSuggestions.comments', "Enable quick suggestions inside comments.")
							},
							other: {
								type: 'boolean',
								default: defaults.other,
								description: nls.localize('quickSuggestions.other', "Enable quick suggestions outside of strings and comments.")
							},
						}
					}
				],
				default: defaults,
				description: nls.localize('quickSuggestions', "Controls whether suggestions should automatically show up while typing.")
			}
		);
2827
		this.defaultValue = defaults;
2828 2829
	}

A
Alex Dima 已提交
2830 2831 2832 2833
	public validate(_input: any): ValidQuickSuggestionsOptions {
		if (typeof _input === 'boolean') {
			return _input;
		}
A
Alex Dima 已提交
2834
		if (_input && typeof _input === 'object') {
A
Alex Dima 已提交
2835
			const input = _input as IQuickSuggestionsOptions;
2836
			const opts = {
2837 2838 2839
				other: boolean(input.other, this.defaultValue.other),
				comments: boolean(input.comments, this.defaultValue.comments),
				strings: boolean(input.strings, this.defaultValue.strings),
A
Alex Dima 已提交
2840
			};
2841 2842 2843 2844 2845 2846 2847
			if (opts.other && opts.comments && opts.strings) {
				return true; // all on
			} else if (!opts.other && !opts.comments && !opts.strings) {
				return false; // all off
			} else {
				return opts;
			}
2848
		}
A
Alex Dima 已提交
2849
		return this.defaultValue;
2850
	}
A
Alex Dima 已提交
2851
}
2852

A
Alex Dima 已提交
2853
//#endregion
2854

A
Alex Dima 已提交
2855 2856 2857
//#region renderLineNumbers

export type LineNumbersType = 'on' | 'off' | 'relative' | 'interval' | ((lineNumber: number) => string);
2858

A
Alex Dima 已提交
2859 2860 2861 2862 2863 2864 2865
export const enum RenderLineNumbersType {
	Off = 0,
	On = 1,
	Relative = 2,
	Interval = 3,
	Custom = 4
}
2866

A
Alex Dima 已提交
2867 2868 2869 2870
export interface InternalEditorRenderLineNumbersOptions {
	readonly renderType: RenderLineNumbersType;
	readonly renderFn: ((lineNumber: number) => string) | null;
}
2871

2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887
class EditorRenderLineNumbersOption extends BaseEditorOption<EditorOption.lineNumbers, InternalEditorRenderLineNumbersOptions> {

	constructor() {
		super(
			EditorOption.lineNumbers, 'lineNumbers', { renderType: RenderLineNumbersType.On, renderFn: null },
			{
				type: 'string',
				enum: ['off', 'on', 'relative', 'interval'],
				enumDescriptions: [
					nls.localize('lineNumbers.off', "Line numbers are not rendered."),
					nls.localize('lineNumbers.on', "Line numbers are rendered as absolute number."),
					nls.localize('lineNumbers.relative', "Line numbers are rendered as distance in lines to cursor position."),
					nls.localize('lineNumbers.interval', "Line numbers are rendered every 10 lines.")
				],
				default: 'on',
				description: nls.localize('lineNumbers', "Controls the display of line numbers.")
2888
			}
2889 2890
		);
	}
2891

A
Alex Dima 已提交
2892 2893 2894 2895 2896
	public validate(lineNumbers: any): InternalEditorRenderLineNumbersOptions {
		let renderType: RenderLineNumbersType = this.defaultValue.renderType;
		let renderFn: ((lineNumber: number) => string) | null = this.defaultValue.renderFn;

		if (typeof lineNumbers !== 'undefined') {
2897
			if (typeof lineNumbers === 'function') {
A
Alex Dima 已提交
2898 2899
				renderType = RenderLineNumbersType.Custom;
				renderFn = lineNumbers;
2900
			} else if (lineNumbers === 'interval') {
A
Alex Dima 已提交
2901
				renderType = RenderLineNumbersType.Interval;
2902
			} else if (lineNumbers === 'relative') {
A
Alex Dima 已提交
2903
				renderType = RenderLineNumbersType.Relative;
2904
			} else if (lineNumbers === 'on') {
A
Alex Dima 已提交
2905
				renderType = RenderLineNumbersType.On;
2906
			} else {
A
Alex Dima 已提交
2907
				renderType = RenderLineNumbersType.Off;
2908 2909 2910
			}
		}

A
Alex Dima 已提交
2911 2912 2913 2914 2915 2916
		return {
			renderType,
			renderFn
		};
	}
}
2917

A
Alex Dima 已提交
2918 2919
//#endregion

2920 2921 2922 2923 2924
//#region renderValidationDecorations

/**
 * @internal
 */
2925
export function filterValidationDecorations(options: IComputedEditorOptions): boolean {
2926 2927
	const renderValidationDecorations = options.get(EditorOption.renderValidationDecorations);
	if (renderValidationDecorations === 'editable') {
2928
		return options.get(EditorOption.readOnly);
2929
	}
2930
	return renderValidationDecorations === 'on' ? false : true;
2931 2932 2933 2934
}

//#endregion

A
Alex Dima 已提交
2935 2936
//#region rulers

2937 2938 2939
export interface IRulerOption {
	readonly column: number;
	readonly color: string | null;
2940 2941
}

2942
class EditorRulers extends BaseEditorOption<EditorOption.rulers, IRulerOption[]> {
2943 2944

	constructor() {
2945
		const defaults: IRulerOption[] = [];
2946
		const columnSchema: IJSONSchema = { type: 'number', description: nls.localize('rulers.size', "Number of monospace characters at which this editor ruler will render.") };
2947 2948 2949 2950 2951
		super(
			EditorOption.rulers, 'rulers', defaults,
			{
				type: 'array',
				items: {
2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964
					anyOf: [
						columnSchema,
						{
							type: [
								'object'
							],
							properties: {
								column: columnSchema,
								color: {
									type: 'string',
									description: nls.localize('rulers.color', "Color of this editor ruler."),
									format: 'color-hex'
								}
2965 2966
							}
						}
2967
					]
2968 2969 2970
				},
				default: defaults,
				description: nls.localize('rulers', "Render vertical rulers after a certain number of monospace characters. Use multiple values for multiple rulers. No rulers are drawn if array is empty.")
2971
			}
2972 2973
		);
	}
2974

2975
	public validate(input: any): IRulerOption[] {
A
Alex Dima 已提交
2976
		if (Array.isArray(input)) {
2977
			let rulers: IRulerOption[] = [];
2978 2979 2980 2981 2982 2983
			for (let _element of input) {
				if (typeof _element === 'number') {
					rulers.push({
						column: EditorIntOption.clampedInt(_element, 0, 0, 10000),
						color: null
					});
A
Alex Dima 已提交
2984
				} else if (_element && typeof _element === 'object') {
2985 2986 2987 2988 2989
					const element = _element as IRulerOption;
					rulers.push({
						column: EditorIntOption.clampedInt(element.column, 0, 0, 10000),
						color: element.color
					});
2990
				}
2991
			}
2992
			rulers.sort((a, b) => a.column - b.column);
A
Alex Dima 已提交
2993
			return rulers;
2994
		}
A
Alex Dima 已提交
2995 2996 2997
		return this.defaultValue;
	}
}
2998

A
Alex Dima 已提交
2999
//#endregion
T
Tiago Ribeiro 已提交
3000

A
Alex Dima 已提交
3001
//#region scrollbar
3002

3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041
/**
 * 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'.
	 */
	vertical?: 'auto' | 'visible' | 'hidden';
	/**
	 * Render horizontal scrollbar.
	 * Defaults to 'auto'.
	 */
	horizontal?: 'auto' | 'visible' | 'hidden';
	/**
	 * 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;
3042 3043 3044 3045 3046
	/**
	 * Always consume mouse wheel events (always call preventDefault() and stopPropagation() on the browser events).
	 * Defaults to true.
	 */
	alwaysConsumeMouseWheel?: boolean;
3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066
	/**
	 * 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;
3067 3068 3069 3070
	/**
	 * Scroll gutter clicks move by page vs jump to position.
	 * Defaults to false.
	 */
A
Alex Dima 已提交
3071
	scrollByPage?: boolean;
3072 3073
}

A
Alex Dima 已提交
3074 3075 3076 3077 3078 3079 3080 3081
export interface InternalEditorScrollbarOptions {
	readonly arrowSize: number;
	readonly vertical: ScrollbarVisibility;
	readonly horizontal: ScrollbarVisibility;
	readonly useShadows: boolean;
	readonly verticalHasArrows: boolean;
	readonly horizontalHasArrows: boolean;
	readonly handleMouseWheel: boolean;
3082
	readonly alwaysConsumeMouseWheel: boolean;
A
Alex Dima 已提交
3083 3084 3085 3086
	readonly horizontalScrollbarSize: number;
	readonly horizontalSliderSize: number;
	readonly verticalScrollbarSize: number;
	readonly verticalSliderSize: number;
A
Alex Dima 已提交
3087
	readonly scrollByPage: boolean;
A
Alex Dima 已提交
3088 3089
}

A
Alex Dima 已提交
3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100
function _scrollbarVisibilityFromString(visibility: string | undefined, defaultValue: ScrollbarVisibility): ScrollbarVisibility {
	if (typeof visibility !== 'string') {
		return defaultValue;
	}
	switch (visibility) {
		case 'hidden': return ScrollbarVisibility.Hidden;
		case 'visible': return ScrollbarVisibility.Visible;
		default: return ScrollbarVisibility.Auto;
	}
}

3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112
class EditorScrollbar extends BaseEditorOption<EditorOption.scrollbar, InternalEditorScrollbarOptions> {

	constructor() {
		super(
			EditorOption.scrollbar, 'scrollbar',
			{
				vertical: ScrollbarVisibility.Auto,
				horizontal: ScrollbarVisibility.Auto,
				arrowSize: 11,
				useShadows: true,
				verticalHasArrows: false,
				horizontalHasArrows: false,
3113 3114
				horizontalScrollbarSize: 12,
				horizontalSliderSize: 12,
3115 3116 3117
				verticalScrollbarSize: 14,
				verticalSliderSize: 14,
				handleMouseWheel: true,
3118
				alwaysConsumeMouseWheel: true,
A
Alex Dima 已提交
3119
				scrollByPage: false
3120 3121 3122 3123
			}
		);
	}

A
Alex Dima 已提交
3124
	public validate(_input: any): InternalEditorScrollbarOptions {
A
Alex Dima 已提交
3125
		if (!_input || typeof _input !== 'object') {
A
Alex Dima 已提交
3126 3127 3128
			return this.defaultValue;
		}
		const input = _input as IEditorScrollbarOptions;
A
Alex Dima 已提交
3129 3130
		const horizontalScrollbarSize = EditorIntOption.clampedInt(input.horizontalScrollbarSize, this.defaultValue.horizontalScrollbarSize, 0, 1000);
		const verticalScrollbarSize = EditorIntOption.clampedInt(input.verticalScrollbarSize, this.defaultValue.verticalScrollbarSize, 0, 1000);
3131
		return {
A
Alex Dima 已提交
3132
			arrowSize: EditorIntOption.clampedInt(input.arrowSize, this.defaultValue.arrowSize, 0, 1000),
A
Alex Dima 已提交
3133 3134
			vertical: _scrollbarVisibilityFromString(input.vertical, this.defaultValue.vertical),
			horizontal: _scrollbarVisibilityFromString(input.horizontal, this.defaultValue.horizontal),
3135 3136 3137 3138 3139
			useShadows: boolean(input.useShadows, this.defaultValue.useShadows),
			verticalHasArrows: boolean(input.verticalHasArrows, this.defaultValue.verticalHasArrows),
			horizontalHasArrows: boolean(input.horizontalHasArrows, this.defaultValue.horizontalHasArrows),
			handleMouseWheel: boolean(input.handleMouseWheel, this.defaultValue.handleMouseWheel),
			alwaysConsumeMouseWheel: boolean(input.alwaysConsumeMouseWheel, this.defaultValue.alwaysConsumeMouseWheel),
A
Alex Dima 已提交
3140
			horizontalScrollbarSize: horizontalScrollbarSize,
A
Alex Dima 已提交
3141
			horizontalSliderSize: EditorIntOption.clampedInt(input.horizontalSliderSize, horizontalScrollbarSize, 0, 1000),
A
Alex Dima 已提交
3142
			verticalScrollbarSize: verticalScrollbarSize,
A
Alex Dima 已提交
3143
			verticalSliderSize: EditorIntOption.clampedInt(input.verticalSliderSize, verticalScrollbarSize, 0, 1000),
3144
			scrollByPage: boolean(input.scrollByPage, this.defaultValue.scrollByPage),
A
Alex Dima 已提交
3145 3146
		};
	}
A
Alex Dima 已提交
3147
}
A
Alex Dima 已提交
3148

A
Alex Dima 已提交
3149 3150
//#endregion

3151 3152 3153 3154 3155 3156 3157
//#region inlineSuggest

export interface IInlineSuggestOptions {
	/**
	 * Enable or disable the rendering of automatic inline completions.
	*/
	enabled?: boolean;
3158 3159 3160 3161 3162 3163 3164 3165

	/**
	 * Configures the mode.
	 * Use `prefix` to only show ghost text if the text to replace is a prefix of the suggestion text.
	 * Use `subwordDiff` to only show ghost text if the replace text is a subword of the suggestion text and diffing should be used to compute the ghost text.
	 * Defaults to `prefix`.
	*/
	mode?: 'prefix' | 'subwordDiff';
3166 3167 3168 3169 3170 3171 3172 3173 3174 3175
}

export type InternalInlineSuggestOptions = Readonly<Required<IInlineSuggestOptions>>;

/**
 * Configuration options for inline suggestions
 */
class InlineEditorSuggest extends BaseEditorOption<EditorOption.inlineSuggest, InternalInlineSuggestOptions> {
	constructor() {
		const defaults: InternalInlineSuggestOptions = {
3176
			enabled: false,
3177
			mode: 'subwordDiff'
3178 3179 3180 3181 3182 3183 3184 3185 3186 3187
		};

		super(
			EditorOption.inlineSuggest, 'inlineSuggest', defaults,
			{
				'editor.inlineSuggest.enabled': {
					type: 'boolean',
					default: defaults.enabled,
					description: nls.localize('inlineSuggest.enabled', "Controls whether to automatically show inline suggestions in the editor.")
				},
3188 3189 3190 3191 3192 3193 3194 3195 3196 3197
				'editor.inlineSuggest.mode': {
					type: 'string',
					enum: ['prefix', 'subwordDiff'],
					enumDescriptions: [
						nls.localize('inlineSuggest.mode.prefix', "Only render an inline suggestion if the replace text is a prefix of the insert text."),
						nls.localize('inlineSuggest.mode.subwordDiff', "Only render an inline suggestion if the replace text is a subword of the insert text."),
					],
					default: defaults.mode,
					description: nls.localize('inlineSuggest.mode', "Controls which mode to use for rendering inline suggestions.")
				},
3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208
			}
		);
	}

	public validate(_input: any): InternalInlineSuggestOptions {
		if (!_input || typeof _input !== 'object') {
			return this.defaultValue;
		}
		const input = _input as IInlineSuggestOptions;
		return {
			enabled: boolean(input.enabled, this.defaultValue.enabled),
3209
			mode: stringSet(input.mode, this.defaultValue.mode, ['prefix', 'subwordDiff']),
3210 3211 3212 3213 3214 3215
		};
	}
}

//#endregion

A
Alex Dima 已提交
3216 3217
//#region suggest

3218 3219 3220 3221
/**
 * Configuration options for editor suggest widget
 */
export interface ISuggestOptions {
3222 3223 3224
	/**
	 * Overwrite word ends on accept. Default to false.
	 */
3225
	insertMode?: 'insert' | 'replace';
3226 3227 3228 3229 3230 3231 3232 3233 3234
	/**
	 * Enable graceful matching. Defaults to true.
	 */
	filterGraceful?: boolean;
	/**
	 * Prevent quick suggestions when a snippet is active. Defaults to true.
	 */
	snippetsPreventQuickSuggestions?: boolean;
	/**
N
Noah Bliss 已提交
3235
	 * Favors words that appear close to the cursor.
3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246
	 */
	localityBonus?: boolean;
	/**
	 * Enable using global storage for remembering suggestions.
	 */
	shareSuggestSelections?: boolean;
	/**
	 * Enable or disable icons in suggestions. Defaults to true.
	 */
	showIcons?: boolean;
	/**
3247
	 * Enable or disable the suggest status bar.
3248
	 */
3249
	showStatusBar?: boolean;
3250
	/**
3251
	 * Enable or disable the rendering of the suggestion preview.
3252
	 */
3253
	preview?: boolean;
3254 3255 3256 3257
	/**
	 * Configures the mode of the preview. Defaults to `subwordDiff`.
	*/
	previewMode?: 'prefix' | 'subwordDiff';
3258 3259 3260
	/**
	 * Show details inline with the label. Defaults to true.
	 */
3261
	showInlineDetails?: boolean;
3262
	/**
3263
	 * Show method-suggestions.
3264
	 */
3265 3266 3267 3268 3269 3270 3271
	showMethods?: boolean;
	/**
	 * Show function-suggestions.
	 */
	showFunctions?: boolean;
	/**
	 * Show constructor-suggestions.
3272
	 */
3273
	showConstructors?: boolean;
3274 3275 3276 3277
	/**
	 * Show deprecated-suggestions.
	 */
	showDeprecated?: boolean;
3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361
	/**
	 * Show field-suggestions.
	 */
	showFields?: boolean;
	/**
	 * Show variable-suggestions.
	 */
	showVariables?: boolean;
	/**
	 * Show class-suggestions.
	 */
	showClasses?: boolean;
	/**
	 * Show struct-suggestions.
	 */
	showStructs?: boolean;
	/**
	 * Show interface-suggestions.
	 */
	showInterfaces?: boolean;
	/**
	 * Show module-suggestions.
	 */
	showModules?: boolean;
	/**
	 * Show property-suggestions.
	 */
	showProperties?: boolean;
	/**
	 * Show event-suggestions.
	 */
	showEvents?: boolean;
	/**
	 * Show operator-suggestions.
	 */
	showOperators?: boolean;
	/**
	 * Show unit-suggestions.
	 */
	showUnits?: boolean;
	/**
	 * Show value-suggestions.
	 */
	showValues?: boolean;
	/**
	 * Show constant-suggestions.
	 */
	showConstants?: boolean;
	/**
	 * Show enum-suggestions.
	 */
	showEnums?: boolean;
	/**
	 * Show enumMember-suggestions.
	 */
	showEnumMembers?: boolean;
	/**
	 * Show keyword-suggestions.
	 */
	showKeywords?: boolean;
	/**
	 * Show text-suggestions.
	 */
	showWords?: boolean;
	/**
	 * Show color-suggestions.
	 */
	showColors?: boolean;
	/**
	 * Show file-suggestions.
	 */
	showFiles?: boolean;
	/**
	 * Show reference-suggestions.
	 */
	showReferences?: boolean;
	/**
	 * Show folder-suggestions.
	 */
	showFolders?: boolean;
	/**
	 * Show typeParameter-suggestions.
	 */
	showTypeParameters?: boolean;
3362 3363 3364 3365 3366 3367 3368 3369
	/**
	 * Show issue-suggestions.
	 */
	showIssues?: boolean;
	/**
	 * Show user-suggestions.
	 */
	showUsers?: boolean;
3370 3371 3372 3373
	/**
	 * Show snippet-suggestions.
	 */
	showSnippets?: boolean;
3374 3375
}

A
Alex Dima 已提交
3376
export type InternalSuggestOptions = Readonly<Required<ISuggestOptions>>;
A
Alex Dima 已提交
3377

A
Alex Dima 已提交
3378
class EditorSuggest extends BaseEditorOption<EditorOption.suggest, InternalSuggestOptions> {
3379 3380 3381

	constructor() {
		const defaults: InternalSuggestOptions = {
3382
			insertMode: 'insert',
3383 3384 3385 3386 3387
			filterGraceful: true,
			snippetsPreventQuickSuggestions: true,
			localityBonus: false,
			shareSuggestSelections: false,
			showIcons: true,
3388
			showStatusBar: false,
3389
			preview: false,
3390
			previewMode: 'prefix',
3391
			showInlineDetails: true,
3392 3393 3394
			showMethods: true,
			showFunctions: true,
			showConstructors: true,
3395
			showDeprecated: true,
3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417
			showFields: true,
			showVariables: true,
			showClasses: true,
			showStructs: true,
			showInterfaces: true,
			showModules: true,
			showProperties: true,
			showEvents: true,
			showOperators: true,
			showUnits: true,
			showValues: true,
			showConstants: true,
			showEnums: true,
			showEnumMembers: true,
			showKeywords: true,
			showWords: true,
			showColors: true,
			showFiles: true,
			showReferences: true,
			showFolders: true,
			showTypeParameters: true,
			showSnippets: true,
3418 3419
			showUsers: true,
			showIssues: true,
3420 3421 3422 3423
		};
		super(
			EditorOption.suggest, 'suggest', defaults,
			{
3424 3425 3426 3427 3428 3429 3430 3431 3432
				'editor.suggest.insertMode': {
					type: 'string',
					enum: ['insert', 'replace'],
					enumDescriptions: [
						nls.localize('suggest.insertMode.insert', "Insert suggestion without overwriting text right of the cursor."),
						nls.localize('suggest.insertMode.replace', "Insert suggestion and overwrite text right of the cursor."),
					],
					default: defaults.insertMode,
					description: nls.localize('suggest.insertMode', "Controls whether words are overwritten when accepting completions. Note that this depends on extensions opting into this feature.")
3433
				},
3434 3435 3436 3437 3438 3439 3440 3441
				'editor.suggest.filterGraceful': {
					type: 'boolean',
					default: defaults.filterGraceful,
					description: nls.localize('suggest.filterGraceful', "Controls whether filtering and sorting suggestions accounts for small typos.")
				},
				'editor.suggest.localityBonus': {
					type: 'boolean',
					default: defaults.localityBonus,
N
Noah Bliss 已提交
3442
					description: nls.localize('suggest.localityBonus', "Controls whether sorting favors words that appear close to the cursor.")
3443 3444 3445 3446 3447 3448 3449 3450 3451
				},
				'editor.suggest.shareSuggestSelections': {
					type: 'boolean',
					default: defaults.shareSuggestSelections,
					markdownDescription: nls.localize('suggest.shareSuggestSelections', "Controls whether remembered suggestion selections are shared between multiple workspaces and windows (needs `#editor.suggestSelection#`).")
				},
				'editor.suggest.snippetsPreventQuickSuggestions': {
					type: 'boolean',
					default: defaults.snippetsPreventQuickSuggestions,
P
Pine Wu 已提交
3452
					description: nls.localize('suggest.snippetsPreventQuickSuggestions', "Controls whether an active snippet prevents quick suggestions.")
3453 3454 3455 3456 3457 3458
				},
				'editor.suggest.showIcons': {
					type: 'boolean',
					default: defaults.showIcons,
					description: nls.localize('suggest.showIcons', "Controls whether to show or hide icons in suggestions.")
				},
3459 3460 3461 3462 3463
				'editor.suggest.showStatusBar': {
					type: 'boolean',
					default: defaults.showStatusBar,
					description: nls.localize('suggest.showStatusBar', "Controls the visibility of the status bar at the bottom of the suggest widget.")
				},
3464
				'editor.suggest.preview': {
3465
					type: 'boolean',
3466 3467
					default: defaults.preview,
					description: nls.localize('suggest.preview', "Controls whether to preview the suggestion outcome in the editor.")
3468
				},
3469 3470 3471 3472 3473 3474 3475 3476 3477 3478
				'editor.suggest.previewMode': {
					type: 'string',
					enum: ['prefix', 'subwordDiff'],
					enumDescriptions: [
						nls.localize('suggest.previewMode.prefix', "Only render a preview if the replace text is a prefix of the insert text."),
						nls.localize('suggest.previewMode.subwordDiff', "Only render a preview if the replace text is a subword of the insert text."),
					],
					default: defaults.previewMode,
					description: nls.localize('suggest.previewMode', "Controls which mode to use for rendering the suggest preview.")
				},
3479
				'editor.suggest.showInlineDetails': {
3480
					type: 'boolean',
3481
					default: defaults.showInlineDetails,
3482
					description: nls.localize('suggest.showInlineDetails', "Controls whether suggest details show inline with the label or only in the details widget")
3483
				},
3484 3485
				'editor.suggest.maxVisibleSuggestions': {
					type: 'number',
3486
					deprecationMessage: nls.localize('suggest.maxVisibleSuggestions.dep', "This setting is deprecated. The suggest widget can now be resized."),
3487 3488 3489
				},
				'editor.suggest.filteredTypes': {
					type: 'object',
3490
					deprecationMessage: nls.localize('deprecated', "This setting is deprecated, please use separate settings like 'editor.suggest.showKeywords' or 'editor.suggest.showSnippets' instead.")
J
Johannes Rieken 已提交
3491
				},
3492
				'editor.suggest.showMethods': {
3493 3494
					type: 'boolean',
					default: true,
3495
					markdownDescription: nls.localize('editor.suggest.showMethods', "When enabled IntelliSense shows `method`-suggestions.")
3496
				},
3497
				'editor.suggest.showFunctions': {
3498 3499
					type: 'boolean',
					default: true,
3500
					markdownDescription: nls.localize('editor.suggest.showFunctions', "When enabled IntelliSense shows `function`-suggestions.")
3501
				},
3502
				'editor.suggest.showConstructors': {
3503 3504
					type: 'boolean',
					default: true,
3505
					markdownDescription: nls.localize('editor.suggest.showConstructors', "When enabled IntelliSense shows `constructor`-suggestions.")
3506
				},
3507 3508 3509 3510 3511
				'editor.suggest.showDeprecated': {
					type: 'boolean',
					default: true,
					markdownDescription: nls.localize('editor.suggest.showDeprecated', "When enabled IntelliSense shows `deprecated`-suggestions.")
				},
3512
				'editor.suggest.showFields': {
3513 3514
					type: 'boolean',
					default: true,
3515
					markdownDescription: nls.localize('editor.suggest.showFields', "When enabled IntelliSense shows `field`-suggestions.")
3516
				},
3517
				'editor.suggest.showVariables': {
3518 3519
					type: 'boolean',
					default: true,
3520
					markdownDescription: nls.localize('editor.suggest.showVariables', "When enabled IntelliSense shows `variable`-suggestions.")
3521
				},
3522
				'editor.suggest.showClasses': {
3523 3524
					type: 'boolean',
					default: true,
3525
					markdownDescription: nls.localize('editor.suggest.showClasss', "When enabled IntelliSense shows `class`-suggestions.")
3526
				},
3527
				'editor.suggest.showStructs': {
3528 3529
					type: 'boolean',
					default: true,
3530
					markdownDescription: nls.localize('editor.suggest.showStructs', "When enabled IntelliSense shows `struct`-suggestions.")
3531
				},
3532
				'editor.suggest.showInterfaces': {
3533 3534
					type: 'boolean',
					default: true,
3535
					markdownDescription: nls.localize('editor.suggest.showInterfaces', "When enabled IntelliSense shows `interface`-suggestions.")
3536
				},
3537
				'editor.suggest.showModules': {
3538 3539
					type: 'boolean',
					default: true,
3540
					markdownDescription: nls.localize('editor.suggest.showModules', "When enabled IntelliSense shows `module`-suggestions.")
3541
				},
3542
				'editor.suggest.showProperties': {
3543 3544
					type: 'boolean',
					default: true,
3545
					markdownDescription: nls.localize('editor.suggest.showPropertys', "When enabled IntelliSense shows `property`-suggestions.")
3546
				},
3547
				'editor.suggest.showEvents': {
3548 3549
					type: 'boolean',
					default: true,
3550
					markdownDescription: nls.localize('editor.suggest.showEvents', "When enabled IntelliSense shows `event`-suggestions.")
3551
				},
3552
				'editor.suggest.showOperators': {
3553 3554
					type: 'boolean',
					default: true,
3555
					markdownDescription: nls.localize('editor.suggest.showOperators', "When enabled IntelliSense shows `operator`-suggestions.")
3556
				},
3557
				'editor.suggest.showUnits': {
3558 3559
					type: 'boolean',
					default: true,
3560
					markdownDescription: nls.localize('editor.suggest.showUnits', "When enabled IntelliSense shows `unit`-suggestions.")
3561
				},
3562
				'editor.suggest.showValues': {
3563 3564
					type: 'boolean',
					default: true,
3565
					markdownDescription: nls.localize('editor.suggest.showValues', "When enabled IntelliSense shows `value`-suggestions.")
3566
				},
3567
				'editor.suggest.showConstants': {
3568 3569
					type: 'boolean',
					default: true,
3570
					markdownDescription: nls.localize('editor.suggest.showConstants', "When enabled IntelliSense shows `constant`-suggestions.")
3571
				},
3572
				'editor.suggest.showEnums': {
3573 3574
					type: 'boolean',
					default: true,
3575
					markdownDescription: nls.localize('editor.suggest.showEnums', "When enabled IntelliSense shows `enum`-suggestions.")
3576
				},
3577
				'editor.suggest.showEnumMembers': {
3578 3579
					type: 'boolean',
					default: true,
3580
					markdownDescription: nls.localize('editor.suggest.showEnumMembers', "When enabled IntelliSense shows `enumMember`-suggestions.")
3581
				},
3582
				'editor.suggest.showKeywords': {
3583 3584
					type: 'boolean',
					default: true,
3585
					markdownDescription: nls.localize('editor.suggest.showKeywords', "When enabled IntelliSense shows `keyword`-suggestions.")
3586
				},
3587
				'editor.suggest.showWords': {
3588 3589
					type: 'boolean',
					default: true,
3590
					markdownDescription: nls.localize('editor.suggest.showTexts', "When enabled IntelliSense shows `text`-suggestions.")
3591
				},
3592
				'editor.suggest.showColors': {
3593 3594
					type: 'boolean',
					default: true,
3595
					markdownDescription: nls.localize('editor.suggest.showColors', "When enabled IntelliSense shows `color`-suggestions.")
3596
				},
3597
				'editor.suggest.showFiles': {
3598 3599
					type: 'boolean',
					default: true,
3600
					markdownDescription: nls.localize('editor.suggest.showFiles', "When enabled IntelliSense shows `file`-suggestions.")
3601
				},
3602
				'editor.suggest.showReferences': {
3603 3604
					type: 'boolean',
					default: true,
3605
					markdownDescription: nls.localize('editor.suggest.showReferences', "When enabled IntelliSense shows `reference`-suggestions.")
3606
				},
3607
				'editor.suggest.showCustomcolors': {
3608 3609
					type: 'boolean',
					default: true,
3610
					markdownDescription: nls.localize('editor.suggest.showCustomcolors', "When enabled IntelliSense shows `customcolor`-suggestions.")
3611
				},
3612
				'editor.suggest.showFolders': {
3613 3614
					type: 'boolean',
					default: true,
3615
					markdownDescription: nls.localize('editor.suggest.showFolders', "When enabled IntelliSense shows `folder`-suggestions.")
3616
				},
3617
				'editor.suggest.showTypeParameters': {
3618 3619
					type: 'boolean',
					default: true,
3620
					markdownDescription: nls.localize('editor.suggest.showTypeParameters', "When enabled IntelliSense shows `typeParameter`-suggestions.")
3621
				},
3622
				'editor.suggest.showSnippets': {
3623 3624
					type: 'boolean',
					default: true,
3625
					markdownDescription: nls.localize('editor.suggest.showSnippets', "When enabled IntelliSense shows `snippet`-suggestions.")
3626
				},
3627 3628 3629 3630 3631 3632 3633 3634 3635
				'editor.suggest.showUsers': {
					type: 'boolean',
					default: true,
					markdownDescription: nls.localize('editor.suggest.showUsers', "When enabled IntelliSense shows `user`-suggestions.")
				},
				'editor.suggest.showIssues': {
					type: 'boolean',
					default: true,
					markdownDescription: nls.localize('editor.suggest.showIssues', "When enabled IntelliSense shows `issues`-suggestions.")
3636
				}
3637 3638 3639 3640
			}
		);
	}

A
Alex Dima 已提交
3641
	public validate(_input: any): InternalSuggestOptions {
A
Alex Dima 已提交
3642
		if (!_input || typeof _input !== 'object') {
A
Alex Dima 已提交
3643
			return this.defaultValue;
A
Alex Dima 已提交
3644
		}
A
Alex Dima 已提交
3645
		const input = _input as ISuggestOptions;
A
Alex Dima 已提交
3646
		return {
3647
			insertMode: stringSet(input.insertMode, this.defaultValue.insertMode, ['insert', 'replace']),
3648 3649 3650 3651 3652 3653
			filterGraceful: boolean(input.filterGraceful, this.defaultValue.filterGraceful),
			snippetsPreventQuickSuggestions: boolean(input.snippetsPreventQuickSuggestions, this.defaultValue.filterGraceful),
			localityBonus: boolean(input.localityBonus, this.defaultValue.localityBonus),
			shareSuggestSelections: boolean(input.shareSuggestSelections, this.defaultValue.shareSuggestSelections),
			showIcons: boolean(input.showIcons, this.defaultValue.showIcons),
			showStatusBar: boolean(input.showStatusBar, this.defaultValue.showStatusBar),
3654
			preview: boolean(input.preview, this.defaultValue.preview),
3655
			previewMode: stringSet(input.previewMode, this.defaultValue.previewMode, ['prefix', 'subwordDiff']),
3656 3657 3658 3659
			showInlineDetails: boolean(input.showInlineDetails, this.defaultValue.showInlineDetails),
			showMethods: boolean(input.showMethods, this.defaultValue.showMethods),
			showFunctions: boolean(input.showFunctions, this.defaultValue.showFunctions),
			showConstructors: boolean(input.showConstructors, this.defaultValue.showConstructors),
3660
			showDeprecated: boolean(input.showDeprecated, this.defaultValue.showDeprecated),
3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684
			showFields: boolean(input.showFields, this.defaultValue.showFields),
			showVariables: boolean(input.showVariables, this.defaultValue.showVariables),
			showClasses: boolean(input.showClasses, this.defaultValue.showClasses),
			showStructs: boolean(input.showStructs, this.defaultValue.showStructs),
			showInterfaces: boolean(input.showInterfaces, this.defaultValue.showInterfaces),
			showModules: boolean(input.showModules, this.defaultValue.showModules),
			showProperties: boolean(input.showProperties, this.defaultValue.showProperties),
			showEvents: boolean(input.showEvents, this.defaultValue.showEvents),
			showOperators: boolean(input.showOperators, this.defaultValue.showOperators),
			showUnits: boolean(input.showUnits, this.defaultValue.showUnits),
			showValues: boolean(input.showValues, this.defaultValue.showValues),
			showConstants: boolean(input.showConstants, this.defaultValue.showConstants),
			showEnums: boolean(input.showEnums, this.defaultValue.showEnums),
			showEnumMembers: boolean(input.showEnumMembers, this.defaultValue.showEnumMembers),
			showKeywords: boolean(input.showKeywords, this.defaultValue.showKeywords),
			showWords: boolean(input.showWords, this.defaultValue.showWords),
			showColors: boolean(input.showColors, this.defaultValue.showColors),
			showFiles: boolean(input.showFiles, this.defaultValue.showFiles),
			showReferences: boolean(input.showReferences, this.defaultValue.showReferences),
			showFolders: boolean(input.showFolders, this.defaultValue.showFolders),
			showTypeParameters: boolean(input.showTypeParameters, this.defaultValue.showTypeParameters),
			showSnippets: boolean(input.showSnippets, this.defaultValue.showSnippets),
			showUsers: boolean(input.showUsers, this.defaultValue.showUsers),
			showIssues: boolean(input.showIssues, this.defaultValue.showIssues),
3685 3686 3687 3688
		};
	}
}

A
Alex Dima 已提交
3689 3690
//#endregion

3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712
//#region smart select

export interface ISmartSelectOptions {
	selectLeadingAndTrailingWhitespace?: boolean
}

export type SmartSelectOptions = Readonly<Required<ISmartSelectOptions>>;

class SmartSelect extends BaseEditorOption<EditorOption.smartSelect, SmartSelectOptions> {

	constructor() {
		super(
			EditorOption.smartSelect, 'smartSelect',
			{
				selectLeadingAndTrailingWhitespace: true
			},
			{
				'editor.smartSelect.selectLeadingAndTrailingWhitespace': {
					description: nls.localize('selectLeadingAndTrailingWhitespace', "Whether leading and trailing whitespace should always be selected."),
					default: true,
					type: 'boolean'
				}
P
Pine Wu 已提交
3713
			}
3714 3715 3716 3717 3718 3719 3720 3721
		);
	}

	public validate(input: any): Readonly<Required<ISmartSelectOptions>> {
		if (!input || typeof input !== 'object') {
			return this.defaultValue;
		}
		return {
3722
			selectLeadingAndTrailingWhitespace: boolean((input as ISmartSelectOptions).selectLeadingAndTrailingWhitespace, this.defaultValue.selectLeadingAndTrailingWhitespace)
3723 3724 3725 3726
		};
	}
}

A
Alex Dima 已提交
3727 3728 3729 3730
//#endregion

//#region tabFocusMode

A
Alex Dima 已提交
3731 3732 3733 3734 3735 3736
class EditorTabFocusMode extends ComputedEditorOption<EditorOption.tabFocusMode, boolean> {

	constructor() {
		super(EditorOption.tabFocusMode, [EditorOption.readOnly]);
	}

A
Alex Dima 已提交
3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774
	public compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, _: boolean): boolean {
		const readOnly = options.get(EditorOption.readOnly);
		return (readOnly ? true : env.tabFocusMode);
	}
}

//#endregion

//#region wrappingIndent

/**
 * Describes how to indent wrapped lines.
 */
export const enum WrappingIndent {
	/**
	 * No indentation => wrapped lines begin at column 1.
	 */
	None = 0,
	/**
	 * Same => wrapped lines get the same indentation as the parent.
	 */
	Same = 1,
	/**
	 * Indent => wrapped lines get +1 indentation toward the parent.
	 */
	Indent = 2,
	/**
	 * DeepIndent => wrapped lines get +2 indentation toward the parent.
	 */
	DeepIndent = 3
}

function _wrappingIndentFromString(wrappingIndent: 'none' | 'same' | 'indent' | 'deepIndent'): WrappingIndent {
	switch (wrappingIndent) {
		case 'none': return WrappingIndent.None;
		case 'same': return WrappingIndent.Same;
		case 'indent': return WrappingIndent.Indent;
		case 'deepIndent': return WrappingIndent.DeepIndent;
3775
	}
A
Alex Dima 已提交
3776
}
3777

A
Alex Dima 已提交
3778
//#endregion
3779

A
Alex Dima 已提交
3780
//#region wrappingInfo
3781

A
Alex Dima 已提交
3782 3783 3784 3785 3786 3787
export interface EditorWrappingInfo {
	readonly isDominatedByLongLines: boolean;
	readonly isWordWrapMinified: boolean;
	readonly isViewportWrapping: boolean;
	readonly wrappingColumn: number;
}
3788

A
Alex Dima 已提交
3789
class EditorWrappingInfoComputer extends ComputedEditorOption<EditorOption.wrappingInfo, EditorWrappingInfo> {
3790

A
Alex Dima 已提交
3791
	constructor() {
3792
		super(EditorOption.wrappingInfo, [EditorOption.layoutInfo]);
A
Alex Dima 已提交
3793 3794
	}

A
Alex Dima 已提交
3795
	public compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, _: EditorWrappingInfo): EditorWrappingInfo {
A
renames  
Alex Dima 已提交
3796
		const layoutInfo = options.get(EditorOption.layoutInfo);
3797

A
Alex Dima 已提交
3798
		return {
3799
			isDominatedByLongLines: env.isDominatedByLongLines,
3800 3801 3802
			isWordWrapMinified: layoutInfo.isWordWrapMinified,
			isViewportWrapping: layoutInfo.isViewportWrapping,
			wrappingColumn: layoutInfo.wrappingColumn,
A
Alex Dima 已提交
3803
		};
3804 3805 3806
	}
}

A
Alex Dima 已提交
3807
//#endregion
3808 3809 3810

const DEFAULT_WINDOWS_FONT_FAMILY = 'Consolas, \'Courier New\', monospace';
const DEFAULT_MAC_FONT_FAMILY = 'Menlo, Monaco, \'Courier New\', monospace';
3811
const DEFAULT_LINUX_FONT_FAMILY = '\'Droid Sans Mono\', \'monospace\', monospace, \'Droid Sans Fallback\'';
3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824

/**
 * @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,
3825
	letterSpacing: 0,
3826 3827 3828 3829 3830 3831 3832
};

/**
 * @internal
 */
export const EDITOR_MODEL_DEFAULTS = {
	tabSize: 4,
D
David Lechner 已提交
3833
	indentSize: 4,
3834 3835
	insertSpaces: true,
	detectIndentation: true,
3836
	trimAutoWhitespace: true,
3837
	largeFileOptimizations: true
3838 3839 3840 3841 3842
};

/**
 * @internal
 */
A
Alex Dima 已提交
3843 3844
export const editorOptionsRegistry: IEditorOption<EditorOption, any>[] = [];

3845
function register<K1 extends EditorOption, V>(option: IEditorOption<K1, V>): IEditorOption<K1, V> {
A
Alex Dima 已提交
3846 3847 3848 3849
	editorOptionsRegistry[option.id] = option;
	return option;
}

A
renames  
Alex Dima 已提交
3850
export const enum EditorOption {
A
Alex Dima 已提交
3851 3852
	acceptSuggestionOnCommitCharacter,
	acceptSuggestionOnEnter,
A
Alex Dima 已提交
3853
	accessibilitySupport,
I
isidor 已提交
3854
	accessibilityPageSize,
3855
	ariaLabel,
A
Alex Dima 已提交
3856
	autoClosingBrackets,
3857
	autoClosingDelete,
A
Alex Dima 已提交
3858 3859 3860 3861 3862
	autoClosingOvertype,
	autoClosingQuotes,
	autoIndent,
	automaticLayout,
	autoSurround,
A
Alex Dima 已提交
3863
	codeLens,
3864 3865
	codeLensFontFamily,
	codeLensFontSize,
A
Alex Dima 已提交
3866
	colorDecorators,
3867
	columnSelection,
A
Alex Dima 已提交
3868
	comments,
A
Alex Dima 已提交
3869
	contextmenu,
A
Alex Dima 已提交
3870 3871 3872 3873 3874
	copyWithSyntaxHighlighting,
	cursorBlinking,
	cursorSmoothCaretAnimation,
	cursorStyle,
	cursorSurroundingLines,
3875
	cursorSurroundingLinesStyle,
A
Alex Dima 已提交
3876 3877
	cursorWidth,
	disableLayerHinting,
3878
	disableMonospaceOptimizations,
3879
	domReadOnly,
A
Alex Dima 已提交
3880 3881 3882
	dragAndDrop,
	emptySelectionClipboard,
	extraEditorClassName,
A
Alex Dima 已提交
3883
	fastScrollSensitivity,
A
Alex Dima 已提交
3884
	find,
A
Alex Dima 已提交
3885
	fixedOverflowWidgets,
A
Alex Dima 已提交
3886
	folding,
A
Alex Dima 已提交
3887
	foldingStrategy,
3888
	foldingHighlight,
3889
	unfoldOnClickAfterEndOfLine,
3890 3891
	fontFamily,
	fontInfo,
A
Alex Dima 已提交
3892
	fontLigatures,
3893 3894
	fontSize,
	fontWeight,
A
Alex Dima 已提交
3895 3896
	formatOnPaste,
	formatOnType,
A
Alex Dima 已提交
3897
	glyphMargin,
A
Alex Dima 已提交
3898
	gotoLocation,
A
Alex Dima 已提交
3899 3900
	hideCursorInOverviewRuler,
	highlightActiveIndentGuide,
A
Alex Dima 已提交
3901
	hover,
A
Alex Dima 已提交
3902
	inDiffEditor,
3903
	inlineSuggest,
3904
	letterSpacing,
A
Alex Dima 已提交
3905
	lightbulb,
A
Alex Dima 已提交
3906
	lineDecorationsWidth,
A
Alex Dima 已提交
3907
	lineHeight,
A
Alex Dima 已提交
3908
	lineNumbers,
A
Alex Dima 已提交
3909
	lineNumbersMinChars,
3910
	linkedEditing,
A
Alex Dima 已提交
3911 3912
	links,
	matchBrackets,
A
Alex Dima 已提交
3913
	minimap,
A
Alex Dima 已提交
3914
	mouseStyle,
A
Alex Dima 已提交
3915
	mouseWheelScrollSensitivity,
A
Alex Dima 已提交
3916 3917 3918
	mouseWheelZoom,
	multiCursorMergeOverlapping,
	multiCursorModifier,
3919
	multiCursorPaste,
A
Alex Dima 已提交
3920
	occurrencesHighlight,
A
Alex Dima 已提交
3921 3922
	overviewRulerBorder,
	overviewRulerLanes,
B
Bailey 已提交
3923
	padding,
A
Alex Dima 已提交
3924
	parameterHints,
3925
	peekWidgetDefaultFocus,
3926
	definitionLinkOpensInPeek,
A
Alex Dima 已提交
3927
	quickSuggestions,
A
Alex Dima 已提交
3928
	quickSuggestionsDelay,
3929
	readOnly,
P
Rename  
Pine Wu 已提交
3930
	renameOnType,
A
Alex Dima 已提交
3931 3932
	renderControlCharacters,
	renderIndentGuides,
A
Alex Dima 已提交
3933
	renderFinalNewline,
A
Alex Dima 已提交
3934
	renderLineHighlight,
3935
	renderLineHighlightOnlyWhenFocus,
3936
	renderValidationDecorations,
A
Alex Dima 已提交
3937 3938 3939 3940
	renderWhitespace,
	revealHorizontalRightPadding,
	roundedSelection,
	rulers,
A
Alex Dima 已提交
3941
	scrollbar,
A
Alex Dima 已提交
3942 3943
	scrollBeyondLastColumn,
	scrollBeyondLastLine,
3944
	scrollPredominantAxis,
A
Alex Dima 已提交
3945
	selectionClipboard,
A
Alex Dima 已提交
3946
	selectionHighlight,
A
Alex Dima 已提交
3947
	selectOnLineNumbers,
A
Alex Dima 已提交
3948
	showFoldingControls,
A
Alex Dima 已提交
3949
	showUnused,
A
Alex Dima 已提交
3950
	snippetSuggestions,
3951
	smartSelect,
A
Alex Dima 已提交
3952
	smoothScrolling,
3953
	stickyTabStops,
A
Alex Dima 已提交
3954
	stopRenderingLineAfter,
A
Alex Dima 已提交
3955
	suggest,
A
Alex Dima 已提交
3956 3957
	suggestFontSize,
	suggestLineHeight,
A
Alex Dima 已提交
3958
	suggestOnTriggerCharacters,
A
Alex Dima 已提交
3959 3960
	suggestSelection,
	tabCompletion,
3961
	tabIndex,
3962
	unusualLineTerminators,
3963
	useShadowDOM,
A
Alex Dima 已提交
3964 3965
	useTabStops,
	wordSeparators,
A
Alex Dima 已提交
3966 3967 3968 3969
	wordWrap,
	wordWrapBreakAfterCharacters,
	wordWrapBreakBeforeCharacters,
	wordWrapColumn,
3970 3971
	wordWrapOverride1,
	wordWrapOverride2,
A
Alex Dima 已提交
3972
	wrappingIndent,
3973
	wrappingStrategy,
3974
	showDeprecated,
3975
	inlayHints,
A
Alex Dima 已提交
3976
	// Leave these at the end (because they have dependencies!)
A
Alex Dima 已提交
3977
	editorClassName,
A
Alex Dima 已提交
3978
	pixelRatio,
A
Alex Dima 已提交
3979
	tabFocusMode,
A
Alex Dima 已提交
3980 3981
	layoutInfo,
	wrappingInfo,
3982 3983
}

3984
/**
3985 3986 3987
 * WORKAROUND: TS emits "any" for complex editor options values (anything except string, bool, enum, etc. ends up being "any")
 * @monacodtsreplace
 * /accessibilitySupport, any/accessibilitySupport, AccessibilitySupport/
A
Alex Dima 已提交
3988
 * /comments, any/comments, EditorCommentsOptions/
3989 3990 3991 3992 3993 3994 3995 3996 3997
 * /find, any/find, EditorFindOptions/
 * /fontInfo, any/fontInfo, FontInfo/
 * /gotoLocation, any/gotoLocation, GoToLocationOptions/
 * /hover, any/hover, EditorHoverOptions/
 * /lightbulb, any/lightbulb, EditorLightbulbOptions/
 * /minimap, any/minimap, EditorMinimapOptions/
 * /parameterHints, any/parameterHints, InternalParameterHintOptions/
 * /quickSuggestions, any/quickSuggestions, ValidQuickSuggestionsOptions/
 * /suggest, any/suggest, InternalSuggestOptions/
3998
 */
A
renames  
Alex Dima 已提交
3999
export const EditorOptions = {
4000 4001 4002 4003
	acceptSuggestionOnCommitCharacter: register(new EditorBooleanOption(
		EditorOption.acceptSuggestionOnCommitCharacter, 'acceptSuggestionOnCommitCharacter', true,
		{ markdownDescription: nls.localize('acceptSuggestionOnCommitCharacter', "Controls whether suggestions should be accepted on commit characters. For example, in JavaScript, the semi-colon (`;`) can be a commit character that accepts a suggestion and types that character.") }
	)),
4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017
	acceptSuggestionOnEnter: register(new EditorStringEnumOption(
		EditorOption.acceptSuggestionOnEnter, 'acceptSuggestionOnEnter',
		'on' as 'on' | 'smart' | 'off',
		['on', 'smart', 'off'] as const,
		{
			markdownEnumDescriptions: [
				'',
				nls.localize('acceptSuggestionOnEnterSmart', "Only accept a suggestion with `Enter` when it makes a textual change."),
				''
			],
			markdownDescription: nls.localize('acceptSuggestionOnEnter', "Controls whether suggestions should be accepted on `Enter`, in addition to `Tab`. Helps to avoid ambiguity between inserting new lines or accepting suggestions.")
		}
	)),
	accessibilitySupport: register(new EditorAccessibilitySupport()),
I
isidor 已提交
4018
	accessibilityPageSize: register(new EditorIntOption(EditorOption.accessibilityPageSize, 'accessibilityPageSize', 10, 1, Constants.MAX_SAFE_SMALL_INTEGER,
4019
		{
4020
			description: nls.localize('accessibilityPageSize', "Controls the number of lines in the editor that can be read out by a screen reader at once. When we detect a screen reader we automatically set the default to be 500. Warning: this has a performance implication for numbers larger than the default.")
4021
		})),
4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038
	ariaLabel: register(new EditorStringOption(
		EditorOption.ariaLabel, 'ariaLabel', nls.localize('editorViewAccessibleLabel', "Editor content")
	)),
	autoClosingBrackets: register(new EditorStringEnumOption(
		EditorOption.autoClosingBrackets, 'autoClosingBrackets',
		'languageDefined' as 'always' | 'languageDefined' | 'beforeWhitespace' | 'never',
		['always', 'languageDefined', 'beforeWhitespace', 'never'] as const,
		{
			enumDescriptions: [
				'',
				nls.localize('editor.autoClosingBrackets.languageDefined', "Use language configurations to determine when to autoclose brackets."),
				nls.localize('editor.autoClosingBrackets.beforeWhitespace', "Autoclose brackets only when the cursor is to the left of whitespace."),
				'',
			],
			description: nls.localize('autoClosingBrackets', "Controls whether the editor should automatically close brackets after the user adds an opening bracket.")
		}
	)),
4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051
	autoClosingDelete: register(new EditorStringEnumOption(
		EditorOption.autoClosingDelete, 'autoClosingDelete',
		'auto' as 'always' | 'auto' | 'never',
		['always', 'auto', 'never'] as const,
		{
			enumDescriptions: [
				'',
				nls.localize('editor.autoClosingDelete.auto', "Remove adjacent closing quotes or brackets only if they were automatically inserted."),
				'',
			],
			description: nls.localize('autoClosingDelete', "Controls whether the editor should remove adjacent closing quotes or brackets when deleting.")
		}
	)),
4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078
	autoClosingOvertype: register(new EditorStringEnumOption(
		EditorOption.autoClosingOvertype, 'autoClosingOvertype',
		'auto' as 'always' | 'auto' | 'never',
		['always', 'auto', 'never'] as const,
		{
			enumDescriptions: [
				'',
				nls.localize('editor.autoClosingOvertype.auto', "Type over closing quotes or brackets only if they were automatically inserted."),
				'',
			],
			description: nls.localize('autoClosingOvertype', "Controls whether the editor should type over closing quotes or brackets.")
		}
	)),
	autoClosingQuotes: register(new EditorStringEnumOption(
		EditorOption.autoClosingQuotes, 'autoClosingQuotes',
		'languageDefined' as 'always' | 'languageDefined' | 'beforeWhitespace' | 'never',
		['always', 'languageDefined', 'beforeWhitespace', 'never'] as const,
		{
			enumDescriptions: [
				'',
				nls.localize('editor.autoClosingQuotes.languageDefined', "Use language configurations to determine when to autoclose quotes."),
				nls.localize('editor.autoClosingQuotes.beforeWhitespace', "Autoclose quotes only when the cursor is to the left of whitespace."),
				'',
			],
			description: nls.localize('autoClosingQuotes', "Controls whether the editor should automatically close quotes after the user adds an opening quote.")
		}
	)),
A
wip  
Alexandru Dima 已提交
4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093
	autoIndent: register(new EditorEnumOption(
		EditorOption.autoIndent, 'autoIndent',
		EditorAutoIndentStrategy.Full, 'full',
		['none', 'keep', 'brackets', 'advanced', 'full'],
		_autoIndentFromString,
		{
			enumDescriptions: [
				nls.localize('editor.autoIndent.none', "The editor will not insert indentation automatically."),
				nls.localize('editor.autoIndent.keep', "The editor will keep the current line's indentation."),
				nls.localize('editor.autoIndent.brackets', "The editor will keep the current line's indentation and honor language defined brackets."),
				nls.localize('editor.autoIndent.advanced', "The editor will keep the current line's indentation, honor language defined brackets and invoke special onEnterRules defined by languages."),
				nls.localize('editor.autoIndent.full', "The editor will keep the current line's indentation, honor language defined brackets, invoke special onEnterRules defined by languages, and honor indentationRules defined by languages."),
			],
			description: nls.localize('autoIndent', "Controls whether the editor should automatically adjust the indentation when users type, paste, move or indent lines.")
		}
4094 4095 4096 4097
	)),
	automaticLayout: register(new EditorBooleanOption(
		EditorOption.automaticLayout, 'automaticLayout', false,
	)),
4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108
	autoSurround: register(new EditorStringEnumOption(
		EditorOption.autoSurround, 'autoSurround',
		'languageDefined' as 'languageDefined' | 'quotes' | 'brackets' | 'never',
		['languageDefined', 'quotes', 'brackets', 'never'] as const,
		{
			enumDescriptions: [
				nls.localize('editor.autoSurround.languageDefined', "Use language configurations to determine when to automatically surround selections."),
				nls.localize('editor.autoSurround.quotes', "Surround with quotes but not brackets."),
				nls.localize('editor.autoSurround.brackets', "Surround with brackets but not quotes."),
				''
			],
4109
			description: nls.localize('autoSurround', "Controls whether the editor should automatically surround selections when typing quotes or brackets.")
4110 4111
		}
	)),
4112 4113
	stickyTabStops: register(new EditorBooleanOption(
		EditorOption.stickyTabStops, 'stickyTabStops', false,
4114
		{ description: nls.localize('stickyTabStops', "Emulate selection behavior of tab characters when using spaces for indentation. Selection will stick to tab stops.") }
4115
	)),
4116 4117 4118 4119
	codeLens: register(new EditorBooleanOption(
		EditorOption.codeLens, 'codeLens', true,
		{ description: nls.localize('codeLens', "Controls whether the editor shows CodeLens.") }
	)),
4120 4121 4122 4123 4124 4125 4126 4127 4128
	codeLensFontFamily: register(new EditorStringOption(
		EditorOption.codeLensFontFamily, 'codeLensFontFamily', '',
		{ description: nls.localize('codeLensFontFamily', "Controls the font family for CodeLens.") }
	)),
	codeLensFontSize: register(new EditorIntOption(EditorOption.codeLensFontSize, 'codeLensFontSize', 0, 0, 100, {
		type: 'number',
		default: 0,
		minimum: 0,
		maximum: 100,
4129
		markdownDescription: nls.localize('codeLensFontSize', "Controls the font size in pixels for CodeLens. When set to `0`, the 90% of `#editor.fontSize#` is used.")
4130
	})),
4131 4132 4133 4134
	colorDecorators: register(new EditorBooleanOption(
		EditorOption.colorDecorators, 'colorDecorators', true,
		{ description: nls.localize('colorDecorators', "Controls whether the editor should render the inline color decorators and color picker.") }
	)),
4135 4136 4137 4138
	columnSelection: register(new EditorBooleanOption(
		EditorOption.columnSelection, 'columnSelection', false,
		{ description: nls.localize('columnSelection', "Enable that the selection with the mouse and keys is doing column selection.") }
	)),
A
Alex Dima 已提交
4139
	comments: register(new EditorComments()),
4140 4141 4142 4143 4144 4145 4146
	contextmenu: register(new EditorBooleanOption(
		EditorOption.contextmenu, 'contextmenu', true,
	)),
	copyWithSyntaxHighlighting: register(new EditorBooleanOption(
		EditorOption.copyWithSyntaxHighlighting, 'copyWithSyntaxHighlighting', true,
		{ description: nls.localize('copyWithSyntaxHighlighting', "Controls whether syntax highlighting should be copied into the clipboard.") }
	)),
4147 4148 4149 4150 4151 4152 4153
	cursorBlinking: register(new EditorEnumOption(
		EditorOption.cursorBlinking, 'cursorBlinking',
		TextEditorCursorBlinkingStyle.Blink, 'blink',
		['blink', 'smooth', 'phase', 'expand', 'solid'],
		_cursorBlinkingStyleFromString,
		{ description: nls.localize('cursorBlinking', "Control the cursor animation style.") }
	)),
4154 4155 4156 4157
	cursorSmoothCaretAnimation: register(new EditorBooleanOption(
		EditorOption.cursorSmoothCaretAnimation, 'cursorSmoothCaretAnimation', false,
		{ description: nls.localize('cursorSmoothCaretAnimation', "Controls whether the smooth caret animation should be enabled.") }
	)),
4158 4159 4160 4161 4162 4163 4164 4165 4166 4167
	cursorStyle: register(new EditorEnumOption(
		EditorOption.cursorStyle, 'cursorStyle',
		TextEditorCursorStyle.Line, 'line',
		['line', 'block', 'underline', 'line-thin', 'block-outline', 'underline-thin'],
		_cursorStyleFromString,
		{ description: nls.localize('cursorStyle', "Controls the cursor style.") }
	)),
	cursorSurroundingLines: register(new EditorIntOption(
		EditorOption.cursorSurroundingLines, 'cursorSurroundingLines',
		0, 0, Constants.MAX_SAFE_SMALL_INTEGER,
4168
		{ description: nls.localize('cursorSurroundingLines', "Controls the minimal number of visible leading and trailing lines surrounding the cursor. Known as 'scrollOff' or 'scrollOffset' in some other editors.") }
4169
	)),
4170 4171 4172 4173 4174 4175
	cursorSurroundingLinesStyle: register(new EditorStringEnumOption(
		EditorOption.cursorSurroundingLinesStyle, 'cursorSurroundingLinesStyle',
		'default' as 'default' | 'all',
		['default', 'all'] as const,
		{
			enumDescriptions: [
G
Greg Van Liew 已提交
4176
				nls.localize('cursorSurroundingLinesStyle.default', "`cursorSurroundingLines` is enforced only when triggered via the keyboard or API."),
4177 4178
				nls.localize('cursorSurroundingLinesStyle.all', "`cursorSurroundingLines` is enforced always.")
			],
G
Greg Van Liew 已提交
4179
			description: nls.localize('cursorSurroundingLinesStyle', "Controls when `cursorSurroundingLines` should be enforced.")
4180 4181
		}
	)),
4182 4183 4184 4185 4186
	cursorWidth: register(new EditorIntOption(
		EditorOption.cursorWidth, 'cursorWidth',
		0, 0, Constants.MAX_SAFE_SMALL_INTEGER,
		{ markdownDescription: nls.localize('cursorWidth', "Controls the width of the cursor when `#editor.cursorStyle#` is set to `line`.") }
	)),
4187 4188 4189
	disableLayerHinting: register(new EditorBooleanOption(
		EditorOption.disableLayerHinting, 'disableLayerHinting', false,
	)),
4190 4191 4192
	disableMonospaceOptimizations: register(new EditorBooleanOption(
		EditorOption.disableMonospaceOptimizations, 'disableMonospaceOptimizations', false
	)),
4193 4194 4195
	domReadOnly: register(new EditorBooleanOption(
		EditorOption.domReadOnly, 'domReadOnly', false,
	)),
4196 4197 4198 4199
	dragAndDrop: register(new EditorBooleanOption(
		EditorOption.dragAndDrop, 'dragAndDrop', true,
		{ description: nls.localize('dragAndDrop', "Controls whether the editor should allow moving selections via drag and drop.") }
	)),
4200 4201 4202 4203 4204 4205 4206 4207 4208 4209
	emptySelectionClipboard: register(new EditorEmptySelectionClipboard()),
	extraEditorClassName: register(new EditorStringOption(
		EditorOption.extraEditorClassName, 'extraEditorClassName', '',
	)),
	fastScrollSensitivity: register(new EditorFloatOption(
		EditorOption.fastScrollSensitivity, 'fastScrollSensitivity',
		5, x => (x <= 0 ? 5 : x),
		{ markdownDescription: nls.localize('fastScrollSensitivity', "Scrolling speed multiplier when pressing `Alt`.") }
	)),
	find: register(new EditorFind()),
4210 4211 4212 4213 4214 4215 4216
	fixedOverflowWidgets: register(new EditorBooleanOption(
		EditorOption.fixedOverflowWidgets, 'fixedOverflowWidgets', false,
	)),
	folding: register(new EditorBooleanOption(
		EditorOption.folding, 'folding', true,
		{ description: nls.localize('folding', "Controls whether the editor has code folding enabled.") }
	)),
4217 4218 4219 4220
	foldingStrategy: register(new EditorStringEnumOption(
		EditorOption.foldingStrategy, 'foldingStrategy',
		'auto' as 'auto' | 'indentation',
		['auto', 'indentation'] as const,
4221 4222 4223 4224 4225 4226 4227
		{
			enumDescriptions: [
				nls.localize('foldingStrategy.auto', "Use a language-specific folding strategy if available, else the indentation-based one."),
				nls.localize('foldingStrategy.indentation', "Use the indentation-based folding strategy."),
			],
			description: nls.localize('foldingStrategy', "Controls the strategy for computing folding ranges.")
		}
4228
	)),
4229 4230 4231
	foldingHighlight: register(new EditorBooleanOption(
		EditorOption.foldingHighlight, 'foldingHighlight', true,
		{ description: nls.localize('foldingHighlight', "Controls whether the editor should highlight folded ranges.") }
4232
	)),
4233 4234 4235
	unfoldOnClickAfterEndOfLine: register(new EditorBooleanOption(
		EditorOption.unfoldOnClickAfterEndOfLine, 'unfoldOnClickAfterEndOfLine', false,
		{ description: nls.localize('unfoldOnClickAfterEndOfLine', "Controls whether clicking on the empty content after a folded line will unfold the line.") }
4236
	)),
4237 4238 4239 4240 4241
	fontFamily: register(new EditorStringOption(
		EditorOption.fontFamily, 'fontFamily', EDITOR_FONT_DEFAULTS.fontFamily,
		{ description: nls.localize('fontFamily', "Controls the font family.") }
	)),
	fontInfo: register(new EditorFontInfo()),
4242
	fontLigatures2: register(new EditorFontLigatures()),
4243
	fontSize: register(new EditorFontSize()),
4244
	fontWeight: register(new EditorFontWeight()),
4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256
	formatOnPaste: register(new EditorBooleanOption(
		EditorOption.formatOnPaste, 'formatOnPaste', false,
		{ description: nls.localize('formatOnPaste', "Controls whether the editor should automatically format the pasted content. A formatter must be available and the formatter should be able to format a range in a document.") }
	)),
	formatOnType: register(new EditorBooleanOption(
		EditorOption.formatOnType, 'formatOnType', false,
		{ description: nls.localize('formatOnType', "Controls whether the editor should automatically format the line after typing.") }
	)),
	glyphMargin: register(new EditorBooleanOption(
		EditorOption.glyphMargin, 'glyphMargin', true,
		{ description: nls.localize('glyphMargin', "Controls whether the editor should render the vertical glyph margin. Glyph margin is mostly used for debugging.") }
	)),
4257
	gotoLocation: register(new EditorGoToLocation()),
4258 4259 4260 4261 4262 4263 4264 4265
	hideCursorInOverviewRuler: register(new EditorBooleanOption(
		EditorOption.hideCursorInOverviewRuler, 'hideCursorInOverviewRuler', false,
		{ description: nls.localize('hideCursorInOverviewRuler', "Controls whether the cursor should be hidden in the overview ruler.") }
	)),
	highlightActiveIndentGuide: register(new EditorBooleanOption(
		EditorOption.highlightActiveIndentGuide, 'highlightActiveIndentGuide', true,
		{ description: nls.localize('highlightActiveIndentGuide', "Controls whether the editor should highlight the active indent guide.") }
	)),
4266
	hover: register(new EditorHover()),
4267
	inDiffEditor: register(new EditorBooleanOption(
4268
		EditorOption.inDiffEditor, 'inDiffEditor', false
4269
	)),
4270 4271 4272 4273 4274 4275
	letterSpacing: register(new EditorFloatOption(
		EditorOption.letterSpacing, 'letterSpacing',
		EDITOR_FONT_DEFAULTS.letterSpacing, x => EditorFloatOption.clamp(x, -5, 20),
		{ description: nls.localize('letterSpacing', "Controls the letter spacing in pixels.") }
	)),
	lightbulb: register(new EditorLightbulb()),
4276
	lineDecorationsWidth: register(new SimpleEditorOption(EditorOption.lineDecorationsWidth, 'lineDecorationsWidth', 10 as number | string)),
4277 4278 4279 4280
	lineHeight: register(new EditorLineHeight()),
	lineNumbers: register(new EditorRenderLineNumbersOption()),
	lineNumbersMinChars: register(new EditorIntOption(
		EditorOption.lineNumbersMinChars, 'lineNumbersMinChars',
4281
		5, 1, 300
4282
	)),
4283 4284 4285 4286
	linkedEditing: register(new EditorBooleanOption(
		EditorOption.linkedEditing, 'linkedEditing', false,
		{ description: nls.localize('linkedEditing', "Controls whether the editor has linked editing enabled. Depending on the language, related symbols, e.g. HTML tags, are updated while editing.") }
	)),
4287 4288 4289 4290
	links: register(new EditorBooleanOption(
		EditorOption.links, 'links', true,
		{ description: nls.localize('links', "Controls whether the editor should detect links and make them clickable.") }
	)),
4291 4292 4293 4294 4295
	matchBrackets: register(new EditorStringEnumOption(
		EditorOption.matchBrackets, 'matchBrackets',
		'always' as 'never' | 'near' | 'always',
		['always', 'near', 'never'] as const,
		{ description: nls.localize('matchBrackets', "Highlight matching brackets.") }
4296
	)),
4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307
	minimap: register(new EditorMinimap()),
	mouseStyle: register(new EditorStringEnumOption(
		EditorOption.mouseStyle, 'mouseStyle',
		'text' as 'text' | 'default' | 'copy',
		['text', 'default', 'copy'] as const,
	)),
	mouseWheelScrollSensitivity: register(new EditorFloatOption(
		EditorOption.mouseWheelScrollSensitivity, 'mouseWheelScrollSensitivity',
		1, x => (x === 0 ? 1 : x),
		{ markdownDescription: nls.localize('mouseWheelScrollSensitivity', "A multiplier to be used on the `deltaX` and `deltaY` of mouse wheel scroll events.") }
	)),
4308 4309 4310 4311 4312 4313 4314 4315
	mouseWheelZoom: register(new EditorBooleanOption(
		EditorOption.mouseWheelZoom, 'mouseWheelZoom', false,
		{ markdownDescription: nls.localize('mouseWheelZoom', "Zoom the font of the editor when using mouse wheel and holding `Ctrl`.") }
	)),
	multiCursorMergeOverlapping: register(new EditorBooleanOption(
		EditorOption.multiCursorMergeOverlapping, 'multiCursorMergeOverlapping', true,
		{ description: nls.localize('multiCursorMergeOverlapping', "Merge multiple cursors when they are overlapping.") }
	)),
4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334
	multiCursorModifier: register(new EditorEnumOption(
		EditorOption.multiCursorModifier, 'multiCursorModifier',
		'altKey', 'alt',
		['ctrlCmd', 'alt'],
		_multiCursorModifierFromString,
		{
			markdownEnumDescriptions: [
				nls.localize('multiCursorModifier.ctrlCmd', "Maps to `Control` on Windows and Linux and to `Command` on macOS."),
				nls.localize('multiCursorModifier.alt', "Maps to `Alt` on Windows and Linux and to `Option` on macOS.")
			],
			markdownDescription: nls.localize({
				key: 'multiCursorModifier',
				comment: [
					'- `ctrlCmd` refers to a value the setting can take and should not be localized.',
					'- `Control` and `Command` refer to the modifier keys Ctrl or Cmd on the keyboard and can be localized.'
				]
			}, "The modifier to be used to add multiple cursors with the mouse. The Go To Definition and Open Link mouse gestures will adapt such that they do not conflict with the multicursor modifier. [Read more](https://code.visualstudio.com/docs/editor/codebasics#_multicursor-modifier).")
		}
	)),
4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346
	multiCursorPaste: register(new EditorStringEnumOption(
		EditorOption.multiCursorPaste, 'multiCursorPaste',
		'spread' as 'spread' | 'full',
		['spread', 'full'] as const,
		{
			markdownEnumDescriptions: [
				nls.localize('multiCursorPaste.spread', "Each cursor pastes a single line of the text."),
				nls.localize('multiCursorPaste.full', "Each cursor pastes the full text.")
			],
			markdownDescription: nls.localize('multiCursorPaste', "Controls pasting when the line count of the pasted text matches the cursor count.")
		}
	)),
4347 4348 4349 4350 4351 4352 4353 4354
	occurrencesHighlight: register(new EditorBooleanOption(
		EditorOption.occurrencesHighlight, 'occurrencesHighlight', true,
		{ description: nls.localize('occurrencesHighlight', "Controls whether the editor should highlight semantic symbol occurrences.") }
	)),
	overviewRulerBorder: register(new EditorBooleanOption(
		EditorOption.overviewRulerBorder, 'overviewRulerBorder', true,
		{ description: nls.localize('overviewRulerBorder', "Controls whether a border should be drawn around the overview ruler.") }
	)),
4355 4356
	overviewRulerLanes: register(new EditorIntOption(
		EditorOption.overviewRulerLanes, 'overviewRulerLanes',
4357
		3, 0, 3
4358
	)),
B
Bailey 已提交
4359
	padding: register(new EditorPadding()),
4360
	parameterHints: register(new EditorParameterHints()),
4361 4362 4363 4364 4365 4366
	peekWidgetDefaultFocus: register(new EditorStringEnumOption(
		EditorOption.peekWidgetDefaultFocus, 'peekWidgetDefaultFocus',
		'tree' as 'tree' | 'editor',
		['tree', 'editor'] as const,
		{
			enumDescriptions: [
4367
				nls.localize('peekWidgetDefaultFocus.tree', "Focus the tree when opening peek"),
4368 4369 4370 4371
				nls.localize('peekWidgetDefaultFocus.editor', "Focus the editor when opening peek")
			],
			description: nls.localize('peekWidgetDefaultFocus', "Controls whether to focus the inline editor or the tree in the peek widget.")
		}
4372
	)),
4373 4374
	definitionLinkOpensInPeek: register(new EditorBooleanOption(
		EditorOption.definitionLinkOpensInPeek, 'definitionLinkOpensInPeek', false,
4375
		{ description: nls.localize('definitionLinkOpensInPeek', "Controls whether the Go to Definition mouse gesture always opens the peek widget.") }
4376
	)),
4377 4378 4379 4380 4381 4382
	quickSuggestions: register(new EditorQuickSuggestions()),
	quickSuggestionsDelay: register(new EditorIntOption(
		EditorOption.quickSuggestionsDelay, 'quickSuggestionsDelay',
		10, 0, Constants.MAX_SAFE_SMALL_INTEGER,
		{ description: nls.localize('quickSuggestionsDelay', "Controls the delay in milliseconds after which quick suggestions will show up.") }
	)),
4383 4384 4385
	readOnly: register(new EditorBooleanOption(
		EditorOption.readOnly, 'readOnly', false,
	)),
P
Rename  
Pine Wu 已提交
4386 4387
	renameOnType: register(new EditorBooleanOption(
		EditorOption.renameOnType, 'renameOnType', false,
4388
		{ description: nls.localize('renameOnType', "Controls whether the editor auto renames on type."), markdownDeprecationMessage: nls.localize('renameOnTypeDeprecate', "Deprecated, use `editor.linkedEditing` instead.") }
P
Rename  
Pine Wu 已提交
4389
	)),
4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401
	renderControlCharacters: register(new EditorBooleanOption(
		EditorOption.renderControlCharacters, 'renderControlCharacters', false,
		{ description: nls.localize('renderControlCharacters', "Controls whether the editor should render control characters.") }
	)),
	renderIndentGuides: register(new EditorBooleanOption(
		EditorOption.renderIndentGuides, 'renderIndentGuides', true,
		{ description: nls.localize('renderIndentGuides', "Controls whether the editor should render indent guides.") }
	)),
	renderFinalNewline: register(new EditorBooleanOption(
		EditorOption.renderFinalNewline, 'renderFinalNewline', true,
		{ description: nls.localize('renderFinalNewline', "Render last line number when the file ends with a newline.") }
	)),
4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415
	renderLineHighlight: register(new EditorStringEnumOption(
		EditorOption.renderLineHighlight, 'renderLineHighlight',
		'line' as 'none' | 'gutter' | 'line' | 'all',
		['none', 'gutter', 'line', 'all'] as const,
		{
			enumDescriptions: [
				'',
				'',
				'',
				nls.localize('renderLineHighlight.all', "Highlights both the gutter and the current line."),
			],
			description: nls.localize('renderLineHighlight', "Controls how the editor should render the current line highlight.")
		}
	)),
4416 4417
	renderLineHighlightOnlyWhenFocus: register(new EditorBooleanOption(
		EditorOption.renderLineHighlightOnlyWhenFocus, 'renderLineHighlightOnlyWhenFocus', false,
4418
		{ description: nls.localize('renderLineHighlightOnlyWhenFocus', "Controls if the editor should render the current line highlight only when the editor is focused.") }
4419
	)),
4420 4421 4422 4423 4424
	renderValidationDecorations: register(new EditorStringEnumOption(
		EditorOption.renderValidationDecorations, 'renderValidationDecorations',
		'editable' as 'editable' | 'on' | 'off',
		['editable', 'on', 'off'] as const
	)),
4425 4426
	renderWhitespace: register(new EditorStringEnumOption(
		EditorOption.renderWhitespace, 'renderWhitespace',
4427 4428
		'selection' as 'selection' | 'none' | 'boundary' | 'trailing' | 'all',
		['none', 'boundary', 'selection', 'trailing', 'all'] as const,
4429 4430 4431 4432 4433
		{
			enumDescriptions: [
				'',
				nls.localize('renderWhitespace.boundary', "Render whitespace characters except for single spaces between words."),
				nls.localize('renderWhitespace.selection', "Render whitespace characters only on selected text."),
4434
				nls.localize('renderWhitespace.trailing', "Render only trailing whitespace characters."),
4435 4436 4437 4438 4439 4440 4441 4442 4443
				''
			],
			description: nls.localize('renderWhitespace', "Controls how the editor should render whitespace characters.")
		}
	)),
	revealHorizontalRightPadding: register(new EditorIntOption(
		EditorOption.revealHorizontalRightPadding, 'revealHorizontalRightPadding',
		30, 0, 1000,
	)),
4444 4445 4446 4447
	roundedSelection: register(new EditorBooleanOption(
		EditorOption.roundedSelection, 'roundedSelection', true,
		{ description: nls.localize('roundedSelection', "Controls whether selections should have rounded corners.") }
	)),
4448 4449 4450 4451 4452 4453 4454
	rulers: register(new EditorRulers()),
	scrollbar: register(new EditorScrollbar()),
	scrollBeyondLastColumn: register(new EditorIntOption(
		EditorOption.scrollBeyondLastColumn, 'scrollBeyondLastColumn',
		5, 0, Constants.MAX_SAFE_SMALL_INTEGER,
		{ description: nls.localize('scrollBeyondLastColumn', "Controls the number of extra characters beyond which the editor will scroll horizontally.") }
	)),
4455 4456 4457 4458
	scrollBeyondLastLine: register(new EditorBooleanOption(
		EditorOption.scrollBeyondLastLine, 'scrollBeyondLastLine', true,
		{ description: nls.localize('scrollBeyondLastLine', "Controls whether the editor will scroll beyond the last line.") }
	)),
4459 4460 4461
	scrollPredominantAxis: register(new EditorBooleanOption(
		EditorOption.scrollPredominantAxis, 'scrollPredominantAxis', true,
		{ description: nls.localize('scrollPredominantAxis', "Scroll only along the predominant axis when scrolling both vertically and horizontally at the same time. Prevents horizontal drift when scrolling vertically on a trackpad.") }
4462
	)),
4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476
	selectionClipboard: register(new EditorBooleanOption(
		EditorOption.selectionClipboard, 'selectionClipboard', true,
		{
			description: nls.localize('selectionClipboard', "Controls whether the Linux primary clipboard should be supported."),
			included: platform.isLinux
		}
	)),
	selectionHighlight: register(new EditorBooleanOption(
		EditorOption.selectionHighlight, 'selectionHighlight', true,
		{ description: nls.localize('selectionHighlight', "Controls whether the editor should highlight matches similar to the selection.") }
	)),
	selectOnLineNumbers: register(new EditorBooleanOption(
		EditorOption.selectOnLineNumbers, 'selectOnLineNumbers', true,
	)),
4477 4478 4479 4480
	showFoldingControls: register(new EditorStringEnumOption(
		EditorOption.showFoldingControls, 'showFoldingControls',
		'mouseover' as 'always' | 'mouseover',
		['always', 'mouseover'] as const,
4481 4482 4483 4484 4485 4486 4487
		{
			enumDescriptions: [
				nls.localize('showFoldingControls.always', "Always show the folding controls."),
				nls.localize('showFoldingControls.mouseover', "Only show the folding controls when the mouse is over the gutter."),
			],
			description: nls.localize('showFoldingControls', "Controls when the folding controls on the gutter are shown.")
		}
4488
	)),
4489 4490 4491 4492
	showUnused: register(new EditorBooleanOption(
		EditorOption.showUnused, 'showUnused', true,
		{ description: nls.localize('showUnused', "Controls fading out of unused code.") }
	)),
4493 4494 4495 4496
	showDeprecated: register(new EditorBooleanOption(
		EditorOption.showDeprecated, 'showDeprecated', true,
		{ description: nls.localize('showDeprecated', "Controls strikethrough deprecated variables.") }
	)),
4497
	inlayHints: register(new EditorInlayHints()),
4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511
	snippetSuggestions: register(new EditorStringEnumOption(
		EditorOption.snippetSuggestions, 'snippetSuggestions',
		'inline' as 'top' | 'bottom' | 'inline' | 'none',
		['top', 'bottom', 'inline', 'none'] as const,
		{
			enumDescriptions: [
				nls.localize('snippetSuggestions.top', "Show snippet suggestions on top of other suggestions."),
				nls.localize('snippetSuggestions.bottom', "Show snippet suggestions below other suggestions."),
				nls.localize('snippetSuggestions.inline', "Show snippets suggestions with other suggestions."),
				nls.localize('snippetSuggestions.none', "Do not show snippet suggestions."),
			],
			description: nls.localize('snippetSuggestions', "Controls whether snippets are shown with other suggestions and how they are sorted.")
		}
	)),
4512
	smartSelect: register(new SmartSelect()),
4513 4514 4515 4516
	smoothScrolling: register(new EditorBooleanOption(
		EditorOption.smoothScrolling, 'smoothScrolling', false,
		{ description: nls.localize('smoothScrolling', "Controls whether the editor will scroll using an animation.") }
	)),
4517 4518 4519 4520 4521
	stopRenderingLineAfter: register(new EditorIntOption(
		EditorOption.stopRenderingLineAfter, 'stopRenderingLineAfter',
		10000, -1, Constants.MAX_SAFE_SMALL_INTEGER,
	)),
	suggest: register(new EditorSuggest()),
4522
	inlineSuggest: register(new InlineEditorSuggest()),
4523 4524 4525 4526 4527 4528 4529 4530
	suggestFontSize: register(new EditorIntOption(
		EditorOption.suggestFontSize, 'suggestFontSize',
		0, 0, 1000,
		{ markdownDescription: nls.localize('suggestFontSize', "Font size for the suggest widget. When set to `0`, the value of `#editor.fontSize#` is used.") }
	)),
	suggestLineHeight: register(new EditorIntOption(
		EditorOption.suggestLineHeight, 'suggestLineHeight',
		0, 0, 1000,
4531
		{ markdownDescription: nls.localize('suggestLineHeight', "Line height for the suggest widget. When set to `0`, the value of `#editor.lineHeight#` is used. The minimum value is 8.") }
4532
	)),
4533 4534 4535 4536
	suggestOnTriggerCharacters: register(new EditorBooleanOption(
		EditorOption.suggestOnTriggerCharacters, 'suggestOnTriggerCharacters', true,
		{ description: nls.localize('suggestOnTriggerCharacters', "Controls whether suggestions should automatically show up when typing trigger characters.") }
	)),
4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562
	suggestSelection: register(new EditorStringEnumOption(
		EditorOption.suggestSelection, 'suggestSelection',
		'recentlyUsed' as 'first' | 'recentlyUsed' | 'recentlyUsedByPrefix',
		['first', 'recentlyUsed', 'recentlyUsedByPrefix'] as const,
		{
			markdownEnumDescriptions: [
				nls.localize('suggestSelection.first', "Always select the first suggestion."),
				nls.localize('suggestSelection.recentlyUsed', "Select recent suggestions unless further typing selects one, e.g. `console.| -> console.log` because `log` has been completed recently."),
				nls.localize('suggestSelection.recentlyUsedByPrefix', "Select suggestions based on previous prefixes that have completed those suggestions, e.g. `co -> console` and `con -> const`."),
			],
			description: nls.localize('suggestSelection', "Controls how suggestions are pre-selected when showing the suggest list.")
		}
	)),
	tabCompletion: register(new EditorStringEnumOption(
		EditorOption.tabCompletion, 'tabCompletion',
		'off' as 'on' | 'off' | 'onlySnippets',
		['on', 'off', 'onlySnippets'] as const,
		{
			enumDescriptions: [
				nls.localize('tabCompletion.on', "Tab complete will insert the best matching suggestion when pressing tab."),
				nls.localize('tabCompletion.off', "Disable tab completions."),
				nls.localize('tabCompletion.onlySnippets', "Tab complete snippets when their prefix match. Works best when 'quickSuggestions' aren't enabled."),
			],
			description: nls.localize('tabCompletion', "Enables tab completions.")
		}
	)),
4563 4564 4565 4566
	tabIndex: register(new EditorIntOption(
		EditorOption.tabIndex, 'tabIndex',
		0, -1, Constants.MAX_SAFE_SMALL_INTEGER
	)),
4567 4568
	unusualLineTerminators: register(new EditorStringEnumOption(
		EditorOption.unusualLineTerminators, 'unusualLineTerminators',
4569 4570
		'prompt' as 'auto' | 'off' | 'prompt',
		['auto', 'off', 'prompt'] as const,
4571 4572
		{
			enumDescriptions: [
4573
				nls.localize('unusualLineTerminators.auto', "Unusual line terminators are automatically removed."),
4574 4575 4576 4577 4578 4579
				nls.localize('unusualLineTerminators.off', "Unusual line terminators are ignored."),
				nls.localize('unusualLineTerminators.prompt', "Unusual line terminators prompt to be removed."),
			],
			description: nls.localize('unusualLineTerminators', "Remove unusual line terminators that might cause problems.")
		}
	)),
4580 4581 4582
	useShadowDOM: register(new EditorBooleanOption(
		EditorOption.useShadowDOM, 'useShadowDOM', true
	)),
4583 4584 4585 4586
	useTabStops: register(new EditorBooleanOption(
		EditorOption.useTabStops, 'useTabStops', true,
		{ description: nls.localize('useTabStops', "Inserting and deleting whitespace follows tab stops.") }
	)),
4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623
	wordSeparators: register(new EditorStringOption(
		EditorOption.wordSeparators, 'wordSeparators', USUAL_WORD_SEPARATORS,
		{ description: nls.localize('wordSeparators', "Characters that will be used as word separators when doing word related navigations or operations.") }
	)),
	wordWrap: register(new EditorStringEnumOption(
		EditorOption.wordWrap, 'wordWrap',
		'off' as 'off' | 'on' | 'wordWrapColumn' | 'bounded',
		['off', 'on', 'wordWrapColumn', 'bounded'] as const,
		{
			markdownEnumDescriptions: [
				nls.localize('wordWrap.off', "Lines will never wrap."),
				nls.localize('wordWrap.on', "Lines will wrap at the viewport width."),
				nls.localize({
					key: 'wordWrap.wordWrapColumn',
					comment: [
						'- `editor.wordWrapColumn` refers to a different setting and should not be localized.'
					]
				}, "Lines will wrap at `#editor.wordWrapColumn#`."),
				nls.localize({
					key: 'wordWrap.bounded',
					comment: [
						'- viewport means the edge of the visible window size.',
						'- `editor.wordWrapColumn` refers to a different setting and should not be localized.'
					]
				}, "Lines will wrap at the minimum of viewport and `#editor.wordWrapColumn#`."),
			],
			description: nls.localize({
				key: 'wordWrap',
				comment: [
					'- \'off\', \'on\', \'wordWrapColumn\' and \'bounded\' refer to values the setting can take and should not be localized.',
					'- `editor.wordWrapColumn` refers to a different setting and should not be localized.'
				]
			}, "Controls how lines should wrap.")
		}
	)),
	wordWrapBreakAfterCharacters: register(new EditorStringOption(
		EditorOption.wordWrapBreakAfterCharacters, 'wordWrapBreakAfterCharacters',
4624
		' \t})]?|/&.,;¢°′″‰℃、。。、¢,.:;?!%・・ゝゞヽヾーァィゥェォッャュョヮヵヶぁぃぅぇぉっゃゅょゎゕゖㇰㇱㇲㇳㇴㇵㇶㇷㇸㇹㇺㇻㇼㇽㇾㇿ々〻ァィゥェォャュョッー”〉》」』】〕)]}」',
4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642
	)),
	wordWrapBreakBeforeCharacters: register(new EditorStringOption(
		EditorOption.wordWrapBreakBeforeCharacters, 'wordWrapBreakBeforeCharacters',
		'([{‘“〈《「『【〔([{「£¥$£¥++'
	)),
	wordWrapColumn: register(new EditorIntOption(
		EditorOption.wordWrapColumn, 'wordWrapColumn',
		80, 1, Constants.MAX_SAFE_SMALL_INTEGER,
		{
			markdownDescription: nls.localize({
				key: 'wordWrapColumn',
				comment: [
					'- `editor.wordWrap` refers to a different setting and should not be localized.',
					'- \'wordWrapColumn\' and \'bounded\' refer to values the different setting can take and should not be localized.'
				]
			}, "Controls the wrapping column of the editor when `#editor.wordWrap#` is `wordWrapColumn` or `bounded`.")
		}
	)),
4643 4644 4645 4646 4647 4648 4649 4650 4651
	wordWrapOverride1: register(new EditorStringEnumOption(
		EditorOption.wordWrapOverride1, 'wordWrapOverride1',
		'inherit' as 'off' | 'on' | 'inherit',
		['off', 'on', 'inherit'] as const
	)),
	wordWrapOverride2: register(new EditorStringEnumOption(
		EditorOption.wordWrapOverride2, 'wordWrapOverride2',
		'inherit' as 'off' | 'on' | 'inherit',
		['off', 'on', 'inherit'] as const
4652
	)),
4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667
	wrappingIndent: register(new EditorEnumOption(
		EditorOption.wrappingIndent, 'wrappingIndent',
		WrappingIndent.Same, 'same',
		['none', 'same', 'indent', 'deepIndent'],
		_wrappingIndentFromString,
		{
			enumDescriptions: [
				nls.localize('wrappingIndent.none', "No indentation. Wrapped lines begin at column 1."),
				nls.localize('wrappingIndent.same', "Wrapped lines get the same indentation as the parent."),
				nls.localize('wrappingIndent.indent', "Wrapped lines get +1 indentation toward the parent."),
				nls.localize('wrappingIndent.deepIndent', "Wrapped lines get +2 indentation toward the parent."),
			],
			description: nls.localize('wrappingIndent', "Controls the indentation of wrapped lines."),
		}
	)),
4668 4669 4670 4671
	wrappingStrategy: register(new EditorStringEnumOption(
		EditorOption.wrappingStrategy, 'wrappingStrategy',
		'simple' as 'simple' | 'advanced',
		['simple', 'advanced'] as const,
4672 4673
		{
			enumDescriptions: [
4674 4675
				nls.localize('wrappingStrategy.simple', "Assumes that all characters are of the same width. This is a fast algorithm that works correctly for monospace fonts and certain scripts (like Latin characters) where glyphs are of equal width."),
				nls.localize('wrappingStrategy.advanced', "Delegates wrapping points computation to the browser. This is a slow algorithm, that might cause freezes for large files, but it works correctly in all cases.")
4676
			],
4677
			description: nls.localize('wrappingStrategy', "Controls the algorithm that computes wrapping points.")
4678 4679
		}
	)),
A
Alex Dima 已提交
4680

A
Alex Dima 已提交
4681
	// Leave these at the end (because they have dependencies!)
4682 4683
	editorClassName: register(new EditorClassName()),
	pixelRatio: register(new EditorPixelRatio()),
A
Alex Dima 已提交
4684
	tabFocusMode: register(new EditorTabFocusMode()),
4685
	layoutInfo: register(new EditorLayoutInfoComputer()),
4686
	wrappingInfo: register(new EditorWrappingInfoComputer())
4687
};
A
Alex Dima 已提交
4688

A
Alex Dima 已提交
4689 4690 4691
type EditorOptionsType = typeof EditorOptions;
type FindEditorOptionsKeyById<T extends EditorOption> = { [K in keyof EditorOptionsType]: EditorOptionsType[K]['id'] extends T ? K : never }[keyof EditorOptionsType];
type ComputedEditorOptionValue<T extends IEditorOption<any, any>> = T extends IEditorOption<any, infer R> ? R : never;
4692
export type FindComputedEditorOptionValueById<T extends EditorOption> = NonNullable<ComputedEditorOptionValue<EditorOptionsType[FindEditorOptionsKeyById<T>]>>;