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

6 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';
14
import { IDimension } from 'vs/editor/common/editorCommon';
M
Matt Bierner 已提交
15
import { IJSONSchema } from 'vs/base/common/jsonSchema';
16

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

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

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

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

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

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

594 595 596 597 598
export interface IEditorConstructionOptions extends IEditorOptions {
	/**
	 * The initial editor dimension (to avoid measuring the container).
	 */
	dimension?: IDimension;
599 600
}

601 602 603 604 605 606
/**
 * @internal
 * The width of the minimap gutter, in pixels.
 */
export const MINIMAP_GUTTER_WIDTH = 8;

607 608 609 610 611 612 613 614 615 616 617 618 619 620
/**
 * 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;
621 622 623 624
	/**
	 * Timeout in milliseconds after which diff computation is cancelled.
	 * Defaults to 5000.
	 */
625
	maxComputationTime?: number;
626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
	/**
	 * 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;
}

A
Alex Dima 已提交
643
//#endregion
644 645

/**
646
 * An event describing that the configuration of the editor has changed.
647
 */
648 649
export class ConfigurationChangedEvent {
	private readonly _values: boolean[];
650 651 652
	/**
	 * @internal
	 */
653 654
	constructor(values: boolean[]) {
		this._values = values;
655
	}
656 657
	public hasChanged(id: EditorOption): boolean {
		return this._values[id];
658 659 660 661
	}
}

/**
662
 * @internal
663
 */
664 665
export class ValidatedEditorOptions {
	private readonly _values: any[] = [];
A
renames  
Alex Dima 已提交
666
	public _read<T>(option: EditorOption): T {
667 668
		return this._values[option];
	}
A
Alex Dima 已提交
669 670 671
	public get<T extends EditorOption>(id: T): FindComputedEditorOptionValueById<T> {
		return this._values[id];
	}
A
renames  
Alex Dima 已提交
672
	public _write<T>(option: EditorOption, value: T): void {
673 674
		this._values[option] = value;
	}
675
}
676

677
/**
678
 * All computed editor options.
679
 */
A
Alex Dima 已提交
680
export interface IComputedEditorOptions {
A
renames  
Alex Dima 已提交
681
	get<T extends EditorOption>(id: T): FindComputedEditorOptionValueById<T>;
682
}
683

A
Alex Dima 已提交
684 685
//#region IEditorOption

686
/**
A
Alex Dima 已提交
687
 * @internal
688
 */
A
Alex Dima 已提交
689
export interface IEnvironmentalOptions {
690
	readonly memory: ComputeOptionsMemory | null;
A
Alex Dima 已提交
691 692 693 694 695
	readonly outerWidth: number;
	readonly outerHeight: number;
	readonly fontInfo: FontInfo;
	readonly extraEditorClassName: string;
	readonly isDominatedByLongLines: boolean;
696
	readonly viewLineCount: number;
A
Alex Dima 已提交
697 698 699 700 701 702 703
	readonly lineNumbersDigitCount: number;
	readonly emptySelectionClipboard: boolean;
	readonly pixelRatio: number;
	readonly tabFocusMode: boolean;
	readonly accessibilitySupport: AccessibilitySupport;
}

704 705 706
/**
 * @internal
 */
707 708 709 710 711 712 713 714 715
export class ComputeOptionsMemory {

	public lastInput: IEditorLayoutComputerInput | null;
	public lastResult: EditorLayoutInfo | null;

	constructor() {
		this.lastInput = null;
		this.lastResult = null;
	}
716 717
}

A
Alex Dima 已提交
718 719 720
export interface IEditorOption<K1 extends EditorOption, V> {
	readonly id: K1;
	readonly name: string;
721
	defaultValue: V;
722
	/**
723
	 * @internal
724
	 */
725
	readonly schema: IConfigurationPropertySchema | { [path: string]: IConfigurationPropertySchema; } | undefined;
726
	/**
A
Alex Dima 已提交
727
	 * @internal
728
	 */
A
Alex Dima 已提交
729
	validate(input: any): V;
730
	/**
A
Alex Dima 已提交
731
	 * @internal
732
	 */
A
Alex Dima 已提交
733 734 735
	compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, value: V): V;
}

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

739 740 741
/**
 * @internal
 */
742
abstract class BaseEditorOption<K1 extends EditorOption, V> implements IEditorOption<K1, V> {
A
Alex Dima 已提交
743 744

	public readonly id: K1;
745
	public readonly name: string;
A
Alex Dima 已提交
746
	public readonly defaultValue: V;
747
	public readonly schema: IConfigurationPropertySchema | { [path: string]: IConfigurationPropertySchema; } | undefined;
A
Alex Dima 已提交
748

749
	constructor(id: K1, name: string, defaultValue: V, schema?: IConfigurationPropertySchema | { [path: string]: IConfigurationPropertySchema; }) {
A
Alex Dima 已提交
750 751 752
		this.id = id;
		this.name = name;
		this.defaultValue = defaultValue;
753
		this.schema = schema;
A
Alex Dima 已提交
754 755 756 757 758 759 760
	}

	public abstract validate(input: any): V;

	public compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, value: V): V {
		return value;
	}
761 762 763 764 765
}

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

768
	public readonly id: K1;
A
Alex Dima 已提交
769 770 771
	public readonly name: '_never_';
	public readonly defaultValue: V;
	public readonly deps: EditorOption[] | null;
772
	public readonly schema: IConfigurationPropertySchema | undefined = undefined;
A
Alex Dima 已提交
773 774 775 776 777 778

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

A
Alex Dima 已提交
781 782 783
	public validate(input: any): V {
		return this.defaultValue;
	}
784

A
Alex Dima 已提交
785
	public abstract compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, value: V): V;
786 787
}

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

A
Alex Dima 已提交
790 791 792
	public readonly id: K1;
	public readonly name: PossibleKeyName<V>;
	public readonly defaultValue: V;
793
	public readonly schema: IConfigurationPropertySchema | undefined;
A
Alex Dima 已提交
794

795
	constructor(id: K1, name: PossibleKeyName<V>, defaultValue: V, schema?: IConfigurationPropertySchema) {
796 797 798
		this.id = id;
		this.name = name;
		this.defaultValue = defaultValue;
799
		this.schema = schema;
A
Alex Dima 已提交
800
	}
801

A
Alex Dima 已提交
802 803 804
	public validate(input: any): V {
		if (typeof input === 'undefined') {
			return this.defaultValue;
A
Alex Dima 已提交
805
		}
A
Alex Dima 已提交
806 807
		return input as any;
	}
808

A
Alex Dima 已提交
809 810
	public compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, value: V): V {
		return value;
811
	}
812 813
}

A
Alex Dima 已提交
814
class EditorBooleanOption<K1 extends EditorOption> extends SimpleEditorOption<K1, boolean> {
815

A
Alex Dima 已提交
816 817 818 819 820 821 822 823 824
	public static boolean(value: any, defaultValue: boolean): boolean {
		if (typeof value === 'undefined') {
			return defaultValue;
		}
		if (value === 'false') {
			// treat the string 'false' as false
			return false;
		}
		return Boolean(value);
A
Alex Dima 已提交
825
	}
826

827
	constructor(id: K1, name: PossibleKeyName<boolean>, defaultValue: boolean, schema: IConfigurationPropertySchema | undefined = undefined) {
828 829 830 831
		if (typeof schema !== 'undefined') {
			schema.type = 'boolean';
			schema.default = defaultValue;
		}
832
		super(id, name, defaultValue, schema);
833
	}
834

A
Alex Dima 已提交
835
	public validate(input: any): boolean {
A
Alex Dima 已提交
836
		return EditorBooleanOption.boolean(input, this.defaultValue);
837
	}
838 839
}

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

A
Alex Dima 已提交
842 843 844 845 846 847 848 849 850 851 852 853 854 855
	public static clampedInt(value: any, defaultValue: number, minimum: number, maximum: number): number {
		let r: number;
		if (typeof value === 'undefined') {
			r = defaultValue;
		} else {
			r = parseInt(value, 10);
			if (isNaN(r)) {
				r = defaultValue;
			}
		}
		r = Math.max(minimum, r);
		r = Math.min(maximum, r);
		return r | 0;
	}
A
Alex Dima 已提交
856

A
Alex Dima 已提交
857 858
	public readonly minimum: number;
	public readonly maximum: number;
859

860 861 862 863 864 865 866 867
	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 已提交
868 869
		this.minimum = minimum;
		this.maximum = maximum;
870 871
	}

A
Alex Dima 已提交
872
	public validate(input: any): number {
A
Alex Dima 已提交
873
		return EditorIntOption.clampedInt(input, this.defaultValue, this.minimum, this.maximum);
874
	}
A
Alex Dima 已提交
875
}
876

A
Alex Dima 已提交
877
class EditorFloatOption<K1 extends EditorOption> extends SimpleEditorOption<K1, number> {
A
Alex Dima 已提交
878 879 880 881 882 883 884 885 886

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

A
Alex Dima 已提交
889 890 891 892 893 894 895 896 897
	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 已提交
898
	}
899

A
Alex Dima 已提交
900
	public readonly validationFn: (value: number) => number;
901 902 903 904 905 906 907

	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 已提交
908
		this.validationFn = validationFn;
A
Alex Dima 已提交
909 910
	}

A
Alex Dima 已提交
911
	public validate(input: any): number {
A
Alex Dima 已提交
912
		return this.validationFn(EditorFloatOption.float(input, this.defaultValue));
A
Alex Dima 已提交
913
	}
914
}
A
Alex Dima 已提交
915

A
Alex Dima 已提交
916
class EditorStringOption<K1 extends EditorOption> extends SimpleEditorOption<K1, string> {
A
Alex Dima 已提交
917 918 919 920 921 922

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

925 926 927 928 929 930
	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 已提交
931 932
	}

A
Alex Dima 已提交
933
	public validate(input: any): string {
A
Alex Dima 已提交
934
		return EditorStringOption.string(input, this.defaultValue);
935
	}
A
Alex Dima 已提交
936
}
937

A
Alex Dima 已提交
938
class EditorStringEnumOption<K1 extends EditorOption, V extends string> extends SimpleEditorOption<K1, V> {
A
Alex Dima 已提交
939 940 941 942 943 944 945 946 947

	public static stringSet<T>(value: T | undefined, defaultValue: T, allowedValues: ReadonlyArray<T>): T {
		if (typeof value !== 'string') {
			return defaultValue;
		}
		if (allowedValues.indexOf(value) === -1) {
			return defaultValue;
		}
		return value;
948 949
	}

950 951 952 953 954 955 956 957 958 959
	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 已提交
960 961
	}

A
Alex Dima 已提交
962
	public validate(input: any): V {
963
		return EditorStringEnumOption.stringSet<V>(input, this.defaultValue, this._allowedValues);
A
Alex Dima 已提交
964 965 966
	}
}

967 968 969 970 971 972 973 974 975
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;
976
			schema.default = defaultStringValue;
977
		}
978 979 980
		super(id, name, defaultValue, schema);
		this._allowedValues = allowedValues;
		this._convert = convert;
981 982
	}

A
Alex Dima 已提交
983 984
	public validate(input: any): V {
		if (typeof input !== 'string') {
A
Alex Dima 已提交
985 986
			return this.defaultValue;
		}
987
		if (this._allowedValues.indexOf(<T>input) === -1) {
A
Alex Dima 已提交
988 989
			return this.defaultValue;
		}
990
		return this._convert(<any>input);
991
	}
A
Alex Dima 已提交
992
}
993

A
Alex Dima 已提交
994
//#endregion
A
Alex Dima 已提交
995

A
wip  
Alexandru Dima 已提交
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
//#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 已提交
1010 1011
//#region accessibilitySupport

1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
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."),
					nls.localize('accessibilitySupport.on', "The editor will be permanently optimized for usage with a Screen Reader."),
					nls.localize('accessibilitySupport.off', "The editor will never be optimized for usage with a Screen Reader."),
				],
				default: 'auto',
				description: nls.localize('accessibilitySupport', "Controls whether the editor should run in a mode where it is optimized for screen readers.")
			}
A
Alex Dima 已提交
1028 1029 1030
		);
	}

A
Alex Dima 已提交
1031 1032 1033 1034 1035
	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 已提交
1036
		}
A
Alex Dima 已提交
1037
		return this.defaultValue;
A
Alex Dima 已提交
1038
	}
1039

A
Alex Dima 已提交
1040 1041
	public compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, value: AccessibilitySupport): AccessibilitySupport {
		if (value === AccessibilitySupport.Unknown) {
A
Alex Dima 已提交
1042 1043
			// The editor reads the `accessibilitySupport` from the environment
			return env.accessibilitySupport;
A
Alex Dima 已提交
1044
		}
A
Alex Dima 已提交
1045
		return value;
1046 1047 1048
	}
}

A
Alex Dima 已提交
1049 1050
//#endregion

A
Alex Dima 已提交
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
//#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;
}

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

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

	constructor() {
		const defaults: EditorCommentsOptions = {
			insertSpace: true,
		};
		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.")
				},
			}
		);
	}

	public validate(_input: any): EditorCommentsOptions {
A
Alex Dima 已提交
1085
		if (!_input || typeof _input !== 'object') {
A
Alex Dima 已提交
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096
			return this.defaultValue;
		}
		const input = _input as IEditorCommentsOptions;
		return {
			insertSpace: EditorBooleanOption.boolean(input.insertSpace, this.defaultValue.insertSpace),
		};
	}
}

//#endregion

1097
//#region cursorBlinking
A
Alex Dima 已提交
1098

A
Alex Dima 已提交
1099
/**
A
Alex Dima 已提交
1100
 * The kind of animation in which the editor's cursor should be rendered.
A
Alex Dima 已提交
1101
 */
A
Alex Dima 已提交
1102
export const enum TextEditorCursorBlinkingStyle {
A
Alex Dima 已提交
1103
	/**
A
Alex Dima 已提交
1104
	 * Hidden
A
Alex Dima 已提交
1105
	 */
A
Alex Dima 已提交
1106
	Hidden = 0,
A
Alex Dima 已提交
1107
	/**
A
Alex Dima 已提交
1108
	 * Blinking
A
Alex Dima 已提交
1109
	 */
A
Alex Dima 已提交
1110
	Blink = 1,
A
Alex Dima 已提交
1111
	/**
A
Alex Dima 已提交
1112
	 * Blinking with smooth fading
A
Alex Dima 已提交
1113
	 */
A
Alex Dima 已提交
1114
	Smooth = 2,
A
Alex Dima 已提交
1115
	/**
A
Alex Dima 已提交
1116
	 * Blinking with prolonged filled state and smooth fading
A
Alex Dima 已提交
1117
	 */
A
Alex Dima 已提交
1118
	Phase = 3,
1119
	/**
A
Alex Dima 已提交
1120
	 * Expand collapse animation on the y axis
1121
	 */
A
Alex Dima 已提交
1122
	Expand = 4,
1123
	/**
A
Alex Dima 已提交
1124
	 * No-Blinking
1125
	 */
A
Alex Dima 已提交
1126 1127
	Solid = 5
}
1128

A
Alex Dima 已提交
1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
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

1200
//#region editorClassName
A
Alex Dima 已提交
1201

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

1204
	constructor() {
1205
		super(EditorOption.editorClassName, [EditorOption.mouseStyle, EditorOption.extraEditorClassName]);
1206
	}
A
Alex Dima 已提交
1207

A
Alex Dima 已提交
1208
	public compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, _: string): string {
A
Alex Dima 已提交
1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220
		let className = 'monaco-editor';
		if (options.get(EditorOption.extraEditorClassName)) {
			className += ' ' + options.get(EditorOption.extraEditorClassName);
		}
		if (env.extraEditorClassName) {
			className += ' ' + env.extraEditorClassName;
		}
		if (options.get(EditorOption.mouseStyle) === 'default') {
			className += ' mouse-default';
		} else if (options.get(EditorOption.mouseStyle) === 'copy') {
			className += ' mouse-copy';
		}
1221 1222 1223
		if (options.get(EditorOption.showUnused)) {
			className += ' showUnused';
		}
A
Alex Dima 已提交
1224 1225 1226 1227 1228 1229
		return className;
	}
}

//#endregion

A
Alex Dima 已提交
1230
//#region emptySelectionClipboard
1231

1232 1233 1234 1235 1236 1237 1238 1239 1240
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.") }
		);
	}

A
Alex Dima 已提交
1241 1242
	public compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, value: boolean): boolean {
		return value && env.emptySelectionClipboard;
1243 1244 1245 1246 1247
	}
}

//#endregion

A
Alex Dima 已提交
1248
//#region find
A
Alex Dima 已提交
1249

1250 1251 1252 1253 1254 1255 1256 1257 1258
/**
 * Configuration options for editor find widget
 */
export interface IEditorFindOptions {
	/**
	 * Controls if we seed search string in the Find Widget with editor selection.
	 */
	seedSearchStringFromSelection?: boolean;
	/**
P
Peng Lyu 已提交
1259
	 * Controls if Find in Selection flag is turned on in the editor.
1260
	 */
P
Peng Lyu 已提交
1261
	autoFindInSelection?: 'never' | 'always' | 'multiline';
1262 1263 1264 1265 1266 1267 1268 1269 1270
	/*
	 * 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;
1271 1272 1273 1274
	/**
	 * Controls whether the search automatically restarts from the beginning (or the end) when no further matches can be found
	 */
	loop?: boolean;
1275 1276
}

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

1279 1280 1281 1282 1283
class EditorFind extends BaseEditorOption<EditorOption.find, EditorFindOptions> {

	constructor() {
		const defaults: EditorFindOptions = {
			seedSearchStringFromSelection: true,
P
Peng Lyu 已提交
1284
			autoFindInSelection: 'never',
1285
			globalFindClipboard: false,
1286 1287
			addExtraSpaceOnTop: true,
			loop: true
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
		};
		super(
			EditorOption.find, 'find', defaults,
			{
				'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 已提交
1298 1299
					type: 'string',
					enum: ['never', 'always', 'multiline'],
1300
					default: defaults.autoFindInSelection,
P
Peng Lyu 已提交
1301 1302 1303 1304 1305
					enumDescriptions: [
						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'),
						nls.localize('editor.find.autoFindInSelection.multiline', 'Turn on Find in selection automatically when multiple lines of content are selected.')
					],
1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317
					description: nls.localize('find.autoFindInSelection', "Controls whether the find operation is carried out on selected text or the entire file in the editor.")
				},
				'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.")
1318 1319 1320 1321 1322 1323 1324
				},
				'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.")
				},

1325 1326 1327 1328
			}
		);
	}

A
Alex Dima 已提交
1329
	public validate(_input: any): EditorFindOptions {
A
Alex Dima 已提交
1330
		if (!_input || typeof _input !== 'object') {
A
Alex Dima 已提交
1331 1332 1333 1334
			return this.defaultValue;
		}
		const input = _input as IEditorFindOptions;
		return {
A
Alex Dima 已提交
1335
			seedSearchStringFromSelection: EditorBooleanOption.boolean(input.seedSearchStringFromSelection, this.defaultValue.seedSearchStringFromSelection),
P
Peng Lyu 已提交
1336 1337 1338
			autoFindInSelection: typeof _input.autoFindInSelection === 'boolean'
				? (_input.autoFindInSelection ? 'always' : 'never')
				: EditorStringEnumOption.stringSet<'never' | 'always' | 'multiline'>(input.autoFindInSelection, this.defaultValue.autoFindInSelection, ['never', 'always', 'multiline']),
A
Alex Dima 已提交
1339
			globalFindClipboard: EditorBooleanOption.boolean(input.globalFindClipboard, this.defaultValue.globalFindClipboard),
1340 1341
			addExtraSpaceOnTop: EditorBooleanOption.boolean(input.addExtraSpaceOnTop, this.defaultValue.addExtraSpaceOnTop),
			loop: EditorBooleanOption.boolean(input.loop, this.defaultValue.loop),
A
Alex Dima 已提交
1342
		};
A
Alex Dima 已提交
1343 1344 1345 1346 1347
	}
}

//#endregion

1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
//#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',
						description: nls.localize('fontLigatures', "Enables/Disables font ligatures."),
					},
					{
						type: 'string',
						description: nls.localize('fontFeatureSettings', "Explicit font-feature-settings.")
					}
				],
1372
				description: nls.localize('fontLigaturesGeneral', "Configures font ligatures or font features."),
1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399
				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 已提交
1400
//#region fontInfo
A
Alex Dima 已提交
1401

1402 1403 1404 1405 1406 1407
class EditorFontInfo extends ComputedEditorOption<EditorOption.fontInfo, FontInfo> {

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

A
Alex Dima 已提交
1408 1409
	public compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, _: FontInfo): FontInfo {
		return env.fontInfo;
A
Alex Dima 已提交
1410 1411 1412 1413 1414
	}
}

//#endregion

A
Alex Dima 已提交
1415 1416
//#region fontSize

1417 1418 1419 1420 1421 1422 1423
class EditorFontSize extends SimpleEditorOption<EditorOption.fontSize, number> {

	constructor() {
		super(
			EditorOption.fontSize, 'fontSize', EDITOR_FONT_DEFAULTS.fontSize,
			{
				type: 'number',
1424 1425
				minimum: 6,
				maximum: 100,
1426 1427 1428 1429 1430 1431
				default: EDITOR_FONT_DEFAULTS.fontSize,
				description: nls.localize('fontSize', "Controls the font size in pixels.")
			}
		);
	}

A
Alex Dima 已提交
1432
	public validate(input: any): number {
A
Alex Dima 已提交
1433
		let r = EditorFloatOption.float(input, this.defaultValue);
A
Alex Dima 已提交
1434 1435 1436
		if (r === 0) {
			return EDITOR_FONT_DEFAULTS.fontSize;
		}
1437
		return EditorFloatOption.clamp(r, 6, 100);
A
Alex Dima 已提交
1438 1439
	}
	public compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, value: number): number {
A
Alex Dima 已提交
1440 1441 1442
		// The final fontSize respects the editor zoom level.
		// So take the result from env.fontInfo
		return env.fontInfo.fontSize;
A
Alex Dima 已提交
1443 1444 1445 1446 1447
	}
}

//#endregion

A
Alex Dima 已提交
1448
//#region gotoLocation
A
Alex Dima 已提交
1449

1450 1451
export type GoToLocationValues = 'peek' | 'gotoAndPeek' | 'goto';

1452 1453 1454 1455
/**
 * Configuration options for go to location
 */
export interface IGotoLocationOptions {
1456

1457
	multiple?: GoToLocationValues;
1458

1459 1460 1461
	multipleDefinitions?: GoToLocationValues;
	multipleTypeDefinitions?: GoToLocationValues;
	multipleDeclarations?: GoToLocationValues;
R
rzj17 已提交
1462
	multipleImplementations?: GoToLocationValues;
1463
	multipleReferences?: GoToLocationValues;
1464 1465 1466 1467 1468 1469

	alternativeDefinitionCommand?: string;
	alternativeTypeDefinitionCommand?: string;
	alternativeDeclarationCommand?: string;
	alternativeImplementationCommand?: string;
	alternativeReferenceCommand?: string;
1470 1471
}

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

1474 1475 1476
class EditorGoToLocation extends BaseEditorOption<EditorOption.gotoLocation, GoToLocationOptions> {

	constructor() {
1477 1478 1479 1480 1481
		const defaults: GoToLocationOptions = {
			multiple: 'peek',
			multipleDefinitions: 'peek',
			multipleTypeDefinitions: 'peek',
			multipleDeclarations: 'peek',
R
rzj17 已提交
1482
			multipleImplementations: 'peek',
1483
			multipleReferences: 'peek',
1484 1485 1486 1487 1488
			alternativeDefinitionCommand: 'editor.action.goToReferences',
			alternativeTypeDefinitionCommand: 'editor.action.goToReferences',
			alternativeDeclarationCommand: 'editor.action.goToReferences',
			alternativeImplementationCommand: '',
			alternativeReferenceCommand: '',
1489
		};
M
Matt Bierner 已提交
1490
		const jsonSubset: IJSONSchema = {
1491 1492 1493 1494 1495 1496 1497 1498 1499
			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')
			]
		};
1500 1501 1502 1503
		super(
			EditorOption.gotoLocation, 'gotoLocation', defaults,
			{
				'editor.gotoLocation.multiple': {
R
rzj17 已提交
1504
					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."),
1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517
				},
				'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 已提交
1518 1519
				'editor.gotoLocation.multipleImplementations': {
					description: nls.localize('editor.editor.gotoLocation.multipleImplemenattions', "Controls the behavior the 'Go to Implementations'-command when multiple target locations exist."),
1520 1521 1522 1523 1524
					...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,
1525
				},
1526
				'editor.gotoLocation.alternativeDefinitionCommand': {
1527
					type: 'string',
1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549
					default: defaults.alternativeDefinitionCommand,
					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,
					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,
					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,
					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,
					description: nls.localize('alternativeReferenceCommand', "Alternative command id that is being executed when the result of 'Go to Reference' is the current location.")
1550 1551 1552 1553 1554
				},
			}
		);
	}

A
Alex Dima 已提交
1555
	public validate(_input: any): GoToLocationOptions {
A
Alex Dima 已提交
1556
		if (!_input || typeof _input !== 'object') {
A
Alex Dima 已提交
1557 1558
			return this.defaultValue;
		}
A
Alex Dima 已提交
1559
		const input = _input as IGotoLocationOptions;
A
Alex Dima 已提交
1560
		return {
1561 1562 1563 1564
			multiple: EditorStringEnumOption.stringSet<GoToLocationValues>(input.multiple, this.defaultValue.multiple!, ['peek', 'gotoAndPeek', 'goto']),
			multipleDefinitions: input.multipleDefinitions ?? EditorStringEnumOption.stringSet<GoToLocationValues>(input.multipleDefinitions, 'peek', ['peek', 'gotoAndPeek', 'goto']),
			multipleTypeDefinitions: input.multipleTypeDefinitions ?? EditorStringEnumOption.stringSet<GoToLocationValues>(input.multipleTypeDefinitions, 'peek', ['peek', 'gotoAndPeek', 'goto']),
			multipleDeclarations: input.multipleDeclarations ?? EditorStringEnumOption.stringSet<GoToLocationValues>(input.multipleDeclarations, 'peek', ['peek', 'gotoAndPeek', 'goto']),
R
rzj17 已提交
1565
			multipleImplementations: input.multipleImplementations ?? EditorStringEnumOption.stringSet<GoToLocationValues>(input.multipleImplementations, 'peek', ['peek', 'gotoAndPeek', 'goto']),
1566
			multipleReferences: input.multipleReferences ?? EditorStringEnumOption.stringSet<GoToLocationValues>(input.multipleReferences, 'peek', ['peek', 'gotoAndPeek', 'goto']),
1567 1568 1569 1570 1571
			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 已提交
1572 1573 1574 1575 1576 1577
		};
	}
}

//#endregion

A
Alex Dima 已提交
1578
//#region hover
A
Alex Dima 已提交
1579

1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600
/**
 * 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 已提交
1601
export type EditorHoverOptions = Readonly<Required<IEditorHoverOptions>>;
A
Alex Dima 已提交
1602

1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632
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 已提交
1633
	public validate(_input: any): EditorHoverOptions {
A
Alex Dima 已提交
1634
		if (!_input || typeof _input !== 'object') {
A
Alex Dima 已提交
1635 1636
			return this.defaultValue;
		}
A
Alex Dima 已提交
1637
		const input = _input as IEditorHoverOptions;
A
Alex Dima 已提交
1638
		return {
A
Alex Dima 已提交
1639
			enabled: EditorBooleanOption.boolean(input.enabled, this.defaultValue.enabled),
A
Alex Dima 已提交
1640
			delay: EditorIntOption.clampedInt(input.delay, this.defaultValue.delay, 0, 10000),
A
Alex Dima 已提交
1641
			sticky: EditorBooleanOption.boolean(input.sticky, this.defaultValue.sticky)
A
Alex Dima 已提交
1642 1643 1644 1645 1646 1647
		};
	}
}

//#endregion

A
Alex Dima 已提交
1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671
//#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 已提交
1672 1673
export const enum RenderMinimap {
	None = 0,
1674 1675
	Text = 1,
	Blocks = 2,
A
Alex Dima 已提交
1676 1677
}

A
Alex Dima 已提交
1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695
/**
 * 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;
1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727
	/**
	 * 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;

1728 1729 1730 1731
	/**
	 * The position for the minimap
	 */
	readonly minimapLeft: number;
1732 1733 1734 1735
	/**
	 * The width of the minimap
	 */
	readonly minimapWidth: number;
A
Alex Dima 已提交
1736
	readonly minimapHeightIsEditorHeight: boolean;
1737 1738
	readonly minimapIsSampling: boolean;
	readonly minimapScale: number;
1739
	readonly minimapLineHeight: number;
1740 1741 1742 1743
	readonly minimapCanvasInnerWidth: number;
	readonly minimapCanvasInnerHeight: number;
	readonly minimapCanvasOuterWidth: number;
	readonly minimapCanvasOuterHeight: number;
1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754

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

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

1755 1756 1757 1758
	readonly isWordWrapMinified: boolean;
	readonly isViewportWrapping: boolean;
	readonly wrappingColumn: number;

1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774
	/**
	 * 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 已提交
1775
 * @internal
1776
 */
A
Alex Dima 已提交
1777
export interface EditorLayoutInfoComputerEnv {
1778
	readonly memory: ComputeOptionsMemory | null;
1779 1780 1781 1782 1783 1784 1785 1786 1787
	readonly outerWidth: number;
	readonly outerHeight: number;
	readonly isDominatedByLongLines: boolean
	readonly lineHeight: number;
	readonly viewLineCount: number;
	readonly lineNumbersDigitCount: number;
	readonly typicalHalfwidthCharacterWidth: number;
	readonly maxDigitWidth: number;
	readonly pixelRatio: number;
1788
}
1789

1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860
/**
 * @internal
 */
export interface IEditorLayoutComputerInput {
	readonly outerWidth: number;
	readonly outerHeight: number;
	readonly isDominatedByLongLines: boolean
	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;
}

/**
 * @internal
 */
function editorLayoutComputerInputSoftEquals(a: IEditorLayoutComputerInput, b: IEditorLayoutComputerInput): boolean {
	return (
		a.outerWidth === b.outerWidth
		&& a.outerHeight === b.outerHeight
		&& a.isDominatedByLongLines === b.isDominatedByLongLines
		&& a.lineHeight === b.lineHeight
		&& a.lineNumbersDigitCount === b.lineNumbersDigitCount
		&& a.typicalHalfwidthCharacterWidth === b.typicalHalfwidthCharacterWidth
		&& a.maxDigitWidth === b.maxDigitWidth
		&& a.pixelRatio === b.pixelRatio
		&& a.glyphMargin === b.glyphMargin
		&& a.lineDecorationsWidth === b.lineDecorationsWidth
		&& a.folding === b.folding
		&& a.minimap.enabled === b.minimap.enabled
		&& a.minimap.side === b.minimap.side
		&& a.minimap.size === b.minimap.size
		&& a.minimap.showSlider === b.minimap.showSlider
		&& a.minimap.renderCharacters === b.minimap.renderCharacters
		&& a.minimap.maxColumn === b.minimap.maxColumn
		&& a.minimap.scale === b.minimap.scale
		&& a.scrollbar.arrowSize === b.scrollbar.arrowSize
		&& a.scrollbar.vertical === b.scrollbar.vertical
		&& a.scrollbar.horizontal === b.scrollbar.horizontal
		&& a.scrollbar.useShadows === b.scrollbar.useShadows
		&& a.scrollbar.verticalHasArrows === b.scrollbar.verticalHasArrows
		&& a.scrollbar.horizontalHasArrows === b.scrollbar.horizontalHasArrows
		&& a.scrollbar.handleMouseWheel === b.scrollbar.handleMouseWheel
		&& a.scrollbar.alwaysConsumeMouseWheel === b.scrollbar.alwaysConsumeMouseWheel
		&& a.scrollbar.horizontalScrollbarSize === b.scrollbar.horizontalScrollbarSize
		&& a.scrollbar.horizontalSliderSize === b.scrollbar.horizontalSliderSize
		&& a.scrollbar.verticalScrollbarSize === b.scrollbar.verticalScrollbarSize
		&& a.scrollbar.verticalSliderSize === b.scrollbar.verticalSliderSize
		&& a.lineNumbers.renderType === b.lineNumbers.renderType
		&& a.lineNumbersMinChars === b.lineNumbersMinChars
		&& a.scrollBeyondLastLine === b.scrollBeyondLastLine
		&& a.wordWrap === b.wordWrap
		&& a.wordWrapColumn === b.wordWrapColumn
		&& a.wordWrapMinified === b.wordWrapMinified
		&& a.accessibilitySupport === b.accessibilitySupport
	);
}

1861 1862 1863
/**
 * @internal
 */
1864
export class EditorLayoutInfoComputer extends ComputedEditorOption<EditorOption.layoutInfo, EditorLayoutInfo> {
1865

1866 1867 1868
	constructor() {
		super(
			EditorOption.layoutInfo,
1869 1870 1871
			[
				EditorOption.glyphMargin, EditorOption.lineDecorationsWidth, EditorOption.folding,
				EditorOption.minimap, EditorOption.scrollbar, EditorOption.lineNumbers,
1872
				EditorOption.lineNumbersMinChars, EditorOption.scrollBeyondLastLine,
1873 1874 1875
				EditorOption.wordWrap, EditorOption.wordWrapColumn, EditorOption.wordWrapMinified,
				EditorOption.accessibilitySupport
			]
1876
		);
1877
	}
1878

A
Alex Dima 已提交
1879
	public compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, _: EditorLayoutInfo): EditorLayoutInfo {
A
Alex Dima 已提交
1880
		return EditorLayoutInfoComputer.computeLayout(options, {
1881
			memory: env.memory,
A
Alex Dima 已提交
1882 1883
			outerWidth: env.outerWidth,
			outerHeight: env.outerHeight,
1884
			isDominatedByLongLines: env.isDominatedByLongLines,
A
Alex Dima 已提交
1885
			lineHeight: env.fontInfo.lineHeight,
1886
			viewLineCount: env.viewLineCount,
A
Alex Dima 已提交
1887 1888 1889 1890 1891
			lineNumbersDigitCount: env.lineNumbersDigitCount,
			typicalHalfwidthCharacterWidth: env.fontInfo.typicalHalfwidthCharacterWidth,
			maxDigitWidth: env.fontInfo.maxDigitWidth,
			pixelRatio: env.pixelRatio
		});
1892 1893
	}

A
Alex Dima 已提交
1894
	public static computeContainedMinimapLineCount(input: {
1895
		viewLineCount: number;
A
Alex Dima 已提交
1896 1897 1898 1899
		scrollBeyondLastLine: boolean;
		height: number;
		lineHeight: number;
		pixelRatio: number;
1900 1901 1902
	}): { typicalViewportLineCount: number; extraLinesBeyondLastLine: number; desiredRatio: number; minimapLineCount: number; } {
		const typicalViewportLineCount = input.height / input.lineHeight;
		const extraLinesBeyondLastLine = input.scrollBeyondLastLine ? (typicalViewportLineCount - 1) : 0;
1903 1904
		const desiredRatio = (input.viewLineCount + extraLinesBeyondLastLine) / (input.pixelRatio * input.height);
		const minimapLineCount = Math.floor(input.viewLineCount / desiredRatio);
1905
		return { typicalViewportLineCount, extraLinesBeyondLastLine, desiredRatio, minimapLineCount };
A
Alex Dima 已提交
1906 1907
	}

A
Alex Dima 已提交
1908
	public static computeLayout(options: IComputedEditorOptions, env: EditorLayoutInfoComputerEnv): EditorLayoutInfo {
1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970
		return EditorLayoutInfoComputer.doComputeLayout({
			outerWidth: env.outerWidth | 0,
			outerHeight: env.outerHeight | 0,
			isDominatedByLongLines: env.isDominatedByLongLines,
			lineHeight: env.lineHeight | 0,
			lineNumbersDigitCount: env.lineNumbersDigitCount | 0,
			typicalHalfwidthCharacterWidth: env.typicalHalfwidthCharacterWidth,
			maxDigitWidth: env.maxDigitWidth,
			pixelRatio: env.pixelRatio,
			glyphMargin: options.get(EditorOption.glyphMargin),
			lineDecorationsWidth: options.get(EditorOption.lineDecorationsWidth),
			folding: options.get(EditorOption.folding),
			minimap: options.get(EditorOption.minimap),
			scrollbar: options.get(EditorOption.scrollbar),
			lineNumbers: options.get(EditorOption.lineNumbers),
			lineNumbersMinChars: options.get(EditorOption.lineNumbersMinChars),
			scrollBeyondLastLine: options.get(EditorOption.scrollBeyondLastLine),
			wordWrap: options.get(EditorOption.wordWrap),
			wordWrapColumn: options.get(EditorOption.wordWrapColumn),
			wordWrapMinified: options.get(EditorOption.wordWrapMinified),
			accessibilitySupport: options.get(EditorOption.accessibilitySupport)
		}, env.viewLineCount, env.memory);
	}

	public static doComputeLayout(input: IEditorLayoutComputerInput, viewLineCount: number, memory: ComputeOptionsMemory | null): EditorLayoutInfo {

		if (memory && memory.lastInput && memory.lastResult && editorLayoutComputerInputSoftEquals(memory.lastInput, input)) {
			return memory.lastResult;
		}

		const outerWidth = input.outerWidth;
		const outerHeight = input.outerHeight;
		const lineHeight = input.lineHeight;
		const lineNumbersDigitCount = input.lineNumbersDigitCount;
		const typicalHalfwidthCharacterWidth = input.typicalHalfwidthCharacterWidth;
		const maxDigitWidth = input.maxDigitWidth;
		const pixelRatio = input.pixelRatio;

		const wordWrap = input.wordWrap;
		const wordWrapColumn = input.wordWrapColumn;
		const wordWrapMinified = input.wordWrapMinified;
		const accessibilitySupport = input.accessibilitySupport;
		const isDominatedByLongLines = input.isDominatedByLongLines;

		const showGlyphMargin = input.glyphMargin;
		const showLineNumbers = (input.lineNumbers.renderType !== RenderLineNumbersType.Off);
		const lineNumbersMinChars = input.lineNumbersMinChars;
		const scrollBeyondLastLine = input.scrollBeyondLastLine;
		const minimapEnabled = input.minimap.enabled;
		const minimapSide = input.minimap.side;
		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;

		const verticalScrollbarWidth = input.scrollbar.verticalScrollbarSize;
		const verticalScrollbarHasArrows = input.scrollbar.verticalHasArrows;
		const scrollbarArrowSize = input.scrollbar.arrowSize;
		const horizontalScrollbarHeight = input.scrollbar.horizontalScrollbarSize;

		const rawLineDecorationsWidth = input.lineDecorationsWidth;
		const folding = input.folding;
A
Alex Dima 已提交
1971 1972 1973 1974

		let lineDecorationsWidth: number;
		if (typeof rawLineDecorationsWidth === 'string' && /^\d+(\.\d+)?ch$/.test(rawLineDecorationsWidth)) {
			const multiple = parseFloat(rawLineDecorationsWidth.substr(0, rawLineDecorationsWidth.length - 2));
A
Alex Dima 已提交
1975
			lineDecorationsWidth = EditorIntOption.clampedInt(multiple * typicalHalfwidthCharacterWidth, 0, 0, 1000);
A
Alex Dima 已提交
1976
		} else {
A
Alex Dima 已提交
1977
			lineDecorationsWidth = EditorIntOption.clampedInt(rawLineDecorationsWidth, 0, 0, 1000);
A
Alex Dima 已提交
1978 1979 1980
		}
		if (folding) {
			lineDecorationsWidth += 16;
1981 1982
		}

A
Alex Dima 已提交
1983 1984 1985 1986 1987
		let lineNumbersWidth = 0;
		if (showLineNumbers) {
			const digitCount = Math.max(lineNumbersDigitCount, lineNumbersMinChars);
			lineNumbersWidth = Math.round(digitCount * maxDigitWidth);
		}
1988

A
Alex Dima 已提交
1989 1990 1991 1992
		let glyphMarginWidth = 0;
		if (showGlyphMargin) {
			glyphMarginWidth = lineHeight;
		}
1993

A
Alex Dima 已提交
1994 1995 1996 1997 1998 1999 2000
		let glyphMarginLeft = 0;
		let lineNumbersLeft = glyphMarginLeft + glyphMarginWidth;
		let decorationsLeft = lineNumbersLeft + lineNumbersWidth;
		let contentLeft = decorationsLeft + lineDecorationsWidth;

		const remainingWidth = outerWidth - glyphMarginWidth - lineNumbersWidth - lineDecorationsWidth;

2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020
		let isWordWrapMinified = false;
		let isViewportWrapping = false;
		let wrappingColumn = -1;

		if (accessibilitySupport !== AccessibilitySupport.Enabled) {
			// See https://github.com/Microsoft/vscode/issues/27766
			// Never enable wrapping when a screen reader is attached
			// because arrow down etc. will not move the cursor in the way
			// a screen reader expects.
			if (wordWrapMinified && isDominatedByLongLines) {
				// 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;
			}
		}

2021
		const baseCharHeight = minimapRenderCharacters ? 2 : 3;
2022
		let storeResultInMemory = false;
A
Alex Dima 已提交
2023 2024 2025
		let renderMinimap: RenderMinimap;
		let minimapLeft: number;
		let minimapWidth: number;
2026 2027 2028 2029
		let minimapCanvasInnerWidth: number;
		let minimapCanvasInnerHeight = Math.floor(pixelRatio * outerHeight);
		let minimapCanvasOuterWidth: number;
		const minimapCanvasOuterHeight = minimapCanvasInnerHeight / pixelRatio;
A
Alex Dima 已提交
2030
		let minimapHeightIsEditorHeight = false;
2031
		let minimapIsSampling = false;
2032
		let minimapLineHeight = baseCharHeight * minimapScale;
A
Alex Dima 已提交
2033
		let contentWidth: number;
A
Alex Dima 已提交
2034
		if (!minimapEnabled) {
A
Alex Dima 已提交
2035 2036
			minimapLeft = 0;
			minimapWidth = 0;
2037 2038
			minimapCanvasInnerWidth = 0;
			minimapCanvasOuterWidth = 0;
2039
			minimapLineHeight = 1;
A
Alex Dima 已提交
2040 2041 2042
			renderMinimap = RenderMinimap.None;
			contentWidth = remainingWidth;
		} else {
2043
			let minimapCharWidth = minimapScale / pixelRatio;
2044
			let minimapWidthMultiplier: number = 1;
2045

2046
			if (minimapSize === 'fill' || minimapSize === 'fit') {
2047
				const { typicalViewportLineCount, extraLinesBeyondLastLine, desiredRatio, minimapLineCount } = EditorLayoutInfoComputer.computeContainedMinimapLineCount({
2048
					viewLineCount: viewLineCount,
A
Alex Dima 已提交
2049 2050 2051 2052 2053 2054 2055
					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
2056
				const ratio = viewLineCount / minimapLineCount;
2057 2058

				if (ratio > 1) {
A
Alex Dima 已提交
2059
					minimapHeightIsEditorHeight = true;
2060
					minimapIsSampling = true;
2061 2062 2063 2064
					minimapScale = 1;
					minimapLineHeight = 1;
					minimapCharWidth = minimapScale / pixelRatio;
				} else {
2065
					const effectiveMinimapHeight = Math.ceil((viewLineCount + extraLinesBeyondLastLine) * minimapLineHeight);
2066
					if (minimapSize === 'fill' || effectiveMinimapHeight > minimapCanvasInnerHeight) {
2067 2068 2069 2070 2071 2072 2073
						if (minimapSize === 'fit' && isViewportWrapping) {
							// `fit` becomes `fill`: this can cause the `minimapScale` to change, which causes `minimapWidth` to change.
							// With viewport wrapping, this can cause the `viewLineCount` to change, which can lead to a new result
							// where `fit` would not become `fill`... and so on...
							// to break the loop, we store the result in memory and then reuse the same result on the next call.
							storeResultInMemory = true;
						}
A
Alex Dima 已提交
2074 2075
						minimapHeightIsEditorHeight = true;
						const configuredFontScale = minimapScale;
2076
						minimapLineHeight = Math.min(lineHeight * pixelRatio, Math.max(1, Math.floor(1 / desiredRatio)));
A
Alex Dima 已提交
2077 2078 2079 2080 2081
						minimapScale = Math.min(configuredFontScale + 1, Math.max(1, Math.floor(minimapLineHeight / baseCharHeight)));
						if (minimapScale > configuredFontScale) {
							minimapWidthMultiplier = Math.min(2, minimapScale / configuredFontScale);
						}
						minimapCharWidth = minimapScale / pixelRatio / minimapWidthMultiplier;
2082
						minimapCanvasInnerHeight = Math.ceil((Math.max(typicalViewportLineCount, viewLineCount + extraLinesBeyondLastLine)) * minimapLineHeight);
2083
					}
2084 2085 2086
				}
			}

2087
			renderMinimap = minimapRenderCharacters ? RenderMinimap.Text : RenderMinimap.Blocks;
A
Alex Dima 已提交
2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101

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

2102
			minimapWidth = Math.max(0, Math.floor(((remainingWidth - verticalScrollbarWidth - 2) * minimapCharWidth) / (typicalHalfwidthCharacterWidth + minimapCharWidth))) + MINIMAP_GUTTER_WIDTH;
A
Alex Dima 已提交
2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117
			let minimapColumns = minimapWidth / minimapCharWidth;
			if (minimapColumns > minimapMaxColumn) {
				minimapWidth = Math.floor(minimapMaxColumn * minimapCharWidth);
			}
			contentWidth = remainingWidth - minimapWidth;

			if (minimapSide === 'left') {
				minimapLeft = 0;
				glyphMarginLeft += minimapWidth;
				lineNumbersLeft += minimapWidth;
				decorationsLeft += minimapWidth;
				contentLeft += minimapWidth;
			} else {
				minimapLeft = outerWidth - minimapWidth - verticalScrollbarWidth;
			}
2118 2119 2120 2121

			minimapCanvasInnerWidth = Math.floor(pixelRatio * minimapWidth);
			minimapCanvasOuterWidth = minimapCanvasInnerWidth / pixelRatio;
			minimapCanvasInnerWidth = Math.floor(minimapCanvasInnerWidth * minimapWidthMultiplier);
2122
		}
2123

A
Alex Dima 已提交
2124 2125 2126 2127 2128
		// (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);

2129 2130 2131 2132 2133
		if (isViewportWrapping) {
			// compute the actual wrappingColumn
			wrappingColumn = Math.max(1, viewportColumn);
			if (wordWrap === 'bounded') {
				wrappingColumn = Math.min(wrappingColumn, wordWrapColumn);
2134 2135 2136
			}
		}

2137
		const result: EditorLayoutInfo = {
A
Alex Dima 已提交
2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155
			width: outerWidth,
			height: outerHeight,

			glyphMarginLeft: glyphMarginLeft,
			glyphMarginWidth: glyphMarginWidth,

			lineNumbersLeft: lineNumbersLeft,
			lineNumbersWidth: lineNumbersWidth,

			decorationsLeft: decorationsLeft,
			decorationsWidth: lineDecorationsWidth,

			contentLeft: contentLeft,
			contentWidth: contentWidth,

			renderMinimap: renderMinimap,
			minimapLeft: minimapLeft,
			minimapWidth: minimapWidth,
A
Alex Dima 已提交
2156
			minimapHeightIsEditorHeight: minimapHeightIsEditorHeight,
2157 2158
			minimapIsSampling: minimapIsSampling,
			minimapScale: minimapScale,
2159
			minimapLineHeight: minimapLineHeight,
2160 2161 2162 2163
			minimapCanvasInnerWidth: minimapCanvasInnerWidth,
			minimapCanvasInnerHeight: minimapCanvasInnerHeight,
			minimapCanvasOuterWidth: minimapCanvasOuterWidth,
			minimapCanvasOuterHeight: minimapCanvasOuterHeight,
A
Alex Dima 已提交
2164 2165 2166

			viewportColumn: viewportColumn,

2167 2168 2169
			isWordWrapMinified: isWordWrapMinified,
			isViewportWrapping: isViewportWrapping,
			wrappingColumn: wrappingColumn,
2170

A
Alex Dima 已提交
2171 2172 2173 2174 2175 2176 2177 2178 2179 2180
			verticalScrollbarWidth: verticalScrollbarWidth,
			horizontalScrollbarHeight: horizontalScrollbarHeight,

			overviewRuler: {
				top: verticalArrowSize,
				width: verticalScrollbarWidth,
				height: (outerHeight - 2 * verticalArrowSize),
				right: 0
			}
		};
2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192

		if (memory) {
			if (storeResultInMemory) {
				memory.lastInput = input;
				memory.lastResult = result;
			} else {
				memory.lastInput = null;
				memory.lastResult = null;
			}
		}

		return result;
2193 2194 2195
	}
}

A
Alex Dima 已提交
2196 2197
//#endregion

A
Alex Dima 已提交
2198 2199
//#region lightbulb

2200 2201 2202 2203 2204 2205 2206 2207 2208
/**
 * Configuration options for editor lightbulb
 */
export interface IEditorLightbulbOptions {
	/**
	 * Enable the lightbulb code action.
	 * Defaults to true.
	 */
	enabled?: boolean;
2209 2210
}

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

2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226
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.")
				},
			}
		);
2227
	}
2228

A
Alex Dima 已提交
2229
	public validate(_input: any): EditorLightbulbOptions {
A
Alex Dima 已提交
2230
		if (!_input || typeof _input !== 'object') {
A
Alex Dima 已提交
2231 2232 2233 2234
			return this.defaultValue;
		}
		const input = _input as IEditorLightbulbOptions;
		return {
A
Alex Dima 已提交
2235
			enabled: EditorBooleanOption.boolean(input.enabled, this.defaultValue.enabled)
A
Alex Dima 已提交
2236
		};
2237 2238 2239
	}
}

A
Alex Dima 已提交
2240 2241 2242 2243
//#endregion

//#region lineHeight

2244 2245 2246 2247 2248 2249 2250 2251
class EditorLineHeight extends EditorIntOption<EditorOption.lineHeight> {

	constructor() {
		super(
			EditorOption.lineHeight, 'lineHeight',
			EDITOR_FONT_DEFAULTS.lineHeight, 0, 150,
			{ description: nls.localize('lineHeight', "Controls the line height. Use 0 to compute the line height from the font size.") }
		);
2252
	}
2253

A
Alex Dima 已提交
2254 2255 2256 2257 2258
	public compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, value: number): number {
		// 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;
2259 2260 2261
	}
}

A
Alex Dima 已提交
2262 2263 2264 2265
//#endregion

//#region minimap

2266
/**
2267
 * Configuration options for editor minimap
2268
 */
2269
export interface IEditorMinimapOptions {
2270
	/**
2271 2272
	 * Enable the rendering of the minimap.
	 * Defaults to true.
2273
	 */
2274 2275 2276 2277 2278 2279
	enabled?: boolean;
	/**
	 * Control the side of the minimap in editor.
	 * Defaults to 'right'.
	 */
	side?: 'right' | 'left';
A
Alex Dima 已提交
2280 2281 2282 2283
	/**
	 * Control the minimap rendering mode.
	 * Defaults to 'actual'.
	 */
2284
	size?: 'proportional' | 'fill' | 'fit';
2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299
	/**
	 * 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;
2300 2301 2302 2303
	/**
	 * Relative size of the font in the minimap. Defaults to 1.
	 */
	scale?: number;
2304
}
A
Alex Dima 已提交
2305

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

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

2310 2311 2312
	constructor() {
		const defaults: EditorMinimapOptions = {
			enabled: true,
2313
			size: 'proportional',
2314 2315 2316 2317
			side: 'right',
			showSlider: 'mouseover',
			renderCharacters: true,
			maxColumn: 120,
2318
			scale: 1,
2319 2320 2321 2322 2323 2324 2325 2326 2327
		};
		super(
			EditorOption.minimap, 'minimap', defaults,
			{
				'editor.minimap.enabled': {
					type: 'boolean',
					default: defaults.enabled,
					description: nls.localize('minimap.enabled', "Controls whether the minimap is shown.")
				},
2328
				'editor.minimap.size': {
A
Alex Dima 已提交
2329
					type: 'string',
2330
					enum: ['proportional', 'fill', 'fit'],
A
Alex Dima 已提交
2331
					enumDescriptions: [
2332 2333 2334
						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 已提交
2335
					],
2336 2337
					default: defaults.size,
					description: nls.localize('minimap.size', "Controls the size of the minimap.")
A
Alex Dima 已提交
2338
				},
2339 2340 2341 2342 2343 2344 2345 2346 2347 2348
				'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,
2349
					description: nls.localize('minimap.showSlider', "Controls when the minimap slider is shown.")
2350
				},
2351 2352 2353 2354 2355
				'editor.minimap.scale': {
					type: 'number',
					default: defaults.scale,
					minimum: 1,
					maximum: 3,
2356 2357
					enum: [1, 2, 3],
					description: nls.localize('minimap.scale', "Scale of content drawn in the minimap: 1, 2 or 3.")
2358 2359 2360 2361 2362 2363 2364 2365 2366 2367
				},
				'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 已提交
2368
				}
2369
			}
2370 2371
		);
	}
J
Jackson Kearl 已提交
2372

A
Alex Dima 已提交
2373
	public validate(_input: any): EditorMinimapOptions {
A
Alex Dima 已提交
2374
		if (!_input || typeof _input !== 'object') {
A
Alex Dima 已提交
2375 2376 2377
			return this.defaultValue;
		}
		const input = _input as IEditorMinimapOptions;
A
Alex Dima 已提交
2378
		return {
A
Alex Dima 已提交
2379
			enabled: EditorBooleanOption.boolean(input.enabled, this.defaultValue.enabled),
2380
			size: EditorStringEnumOption.stringSet<'proportional' | 'fill' | 'fit'>(input.size, this.defaultValue.size, ['proportional', 'fill', 'fit']),
A
Alex Dima 已提交
2381 2382
			side: EditorStringEnumOption.stringSet<'right' | 'left'>(input.side, this.defaultValue.side, ['right', 'left']),
			showSlider: EditorStringEnumOption.stringSet<'always' | 'mouseover'>(input.showSlider, this.defaultValue.showSlider, ['always', 'mouseover']),
A
Alex Dima 已提交
2383
			renderCharacters: EditorBooleanOption.boolean(input.renderCharacters, this.defaultValue.renderCharacters),
2384
			scale: EditorIntOption.clampedInt(input.scale, 1, 1, 3),
A
Alex Dima 已提交
2385
			maxColumn: EditorIntOption.clampedInt(input.maxColumn, this.defaultValue.maxColumn, 1, 10000),
A
Alex Dima 已提交
2386 2387
		};
	}
A
Alex Dima 已提交
2388
}
A
Alex Dima 已提交
2389

A
Alex Dima 已提交
2390
//#endregion
A
Alex Dima 已提交
2391

A
Alex Dima 已提交
2392
//#region multiCursorModifier
A
Alex Dima 已提交
2393

A
Alex Dima 已提交
2394 2395 2396 2397 2398
function _multiCursorModifierFromString(multiCursorModifier: 'ctrlCmd' | 'alt'): 'altKey' | 'metaKey' | 'ctrlKey' {
	if (multiCursorModifier === 'ctrlCmd') {
		return (platform.isMacintosh ? 'metaKey' : 'ctrlKey');
	}
	return 'altKey';
A
Alex Dima 已提交
2399
}
A
Alex Dima 已提交
2400

A
Alex Dima 已提交
2401
//#endregion
A
Alex Dima 已提交
2402

B
Bailey 已提交
2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432
//#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 已提交
2433 2434
					minimum: 0,
					maximum: 1000,
B
Bailey 已提交
2435 2436 2437 2438 2439
					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 已提交
2440 2441
					minimum: 0,
					maximum: 1000,
B
Bailey 已提交
2442 2443 2444 2445 2446 2447 2448
					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 已提交
2449
		if (!_input || typeof _input !== 'object') {
B
Bailey 已提交
2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461
			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 已提交
2462
//#region parameterHints
A
Alex Dima 已提交
2463

2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479
/**
 * 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 已提交
2480 2481
export type InternalParameterHintOptions = Readonly<Required<IEditorParameterHintOptions>>;

2482 2483 2484 2485 2486 2487
class EditorParameterHints extends BaseEditorOption<EditorOption.parameterHints, InternalParameterHintOptions> {

	constructor() {
		const defaults: InternalParameterHintOptions = {
			enabled: true,
			cycle: false
A
Alex Dima 已提交
2488
		};
2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503
		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 已提交
2504 2505
	}

A
Alex Dima 已提交
2506
	public validate(_input: any): InternalParameterHintOptions {
A
Alex Dima 已提交
2507
		if (!_input || typeof _input !== 'object') {
A
Alex Dima 已提交
2508
			return this.defaultValue;
A
Alex Dima 已提交
2509
		}
A
Alex Dima 已提交
2510
		const input = _input as IEditorParameterHintOptions;
A
Alex Dima 已提交
2511
		return {
A
Alex Dima 已提交
2512 2513
			enabled: EditorBooleanOption.boolean(input.enabled, this.defaultValue.enabled),
			cycle: EditorBooleanOption.boolean(input.cycle, this.defaultValue.cycle)
A
Alex Dima 已提交
2514 2515
		};
	}
A
Alex Dima 已提交
2516
}
A
Alex Dima 已提交
2517

A
Alex Dima 已提交
2518
//#endregion
2519

A
Alex Dima 已提交
2520
//#region pixelRatio
2521

2522
class EditorPixelRatio extends ComputedEditorOption<EditorOption.pixelRatio, number> {
2523

2524 2525
	constructor() {
		super(EditorOption.pixelRatio);
2526 2527
	}

A
Alex Dima 已提交
2528 2529
	public compute(env: IEnvironmentalOptions, options: IComputedEditorOptions, _: number): number {
		return env.pixelRatio;
A
Alex Dima 已提交
2530
	}
A
Alex Dima 已提交
2531
}
A
Alex Dima 已提交
2532

A
Alex Dima 已提交
2533 2534 2535 2536
//#endregion

//#region quickSuggestions

2537 2538 2539 2540 2541 2542 2543 2544 2545
/**
 * Configuration options for quick suggestions
 */
export interface IQuickSuggestionsOptions {
	other: boolean;
	comments: boolean;
	strings: boolean;
}

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

2548 2549
class EditorQuickSuggestions extends BaseEditorOption<EditorOption.quickSuggestions, ValidQuickSuggestionsOptions> {

A
Alex Dima 已提交
2550
	public readonly defaultValue: Readonly<Required<IQuickSuggestionsOptions>>;
2551 2552 2553 2554 2555 2556

	constructor() {
		const defaults: ValidQuickSuggestionsOptions = {
			other: true,
			comments: false,
			strings: false
2557
		};
2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589
		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.")
			}
		);
2590
		this.defaultValue = defaults;
2591 2592
	}

A
Alex Dima 已提交
2593 2594 2595 2596
	public validate(_input: any): ValidQuickSuggestionsOptions {
		if (typeof _input === 'boolean') {
			return _input;
		}
A
Alex Dima 已提交
2597
		if (_input && typeof _input === 'object') {
A
Alex Dima 已提交
2598
			const input = _input as IQuickSuggestionsOptions;
2599
			const opts = {
A
Alex Dima 已提交
2600 2601 2602
				other: EditorBooleanOption.boolean(input.other, this.defaultValue.other),
				comments: EditorBooleanOption.boolean(input.comments, this.defaultValue.comments),
				strings: EditorBooleanOption.boolean(input.strings, this.defaultValue.strings),
A
Alex Dima 已提交
2603
			};
2604 2605 2606 2607 2608 2609 2610
			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;
			}
2611
		}
A
Alex Dima 已提交
2612
		return this.defaultValue;
2613
	}
A
Alex Dima 已提交
2614
}
2615

A
Alex Dima 已提交
2616
//#endregion
2617

A
Alex Dima 已提交
2618 2619 2620
//#region renderLineNumbers

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

A
Alex Dima 已提交
2622 2623 2624 2625 2626 2627 2628
export const enum RenderLineNumbersType {
	Off = 0,
	On = 1,
	Relative = 2,
	Interval = 3,
	Custom = 4
}
2629

A
Alex Dima 已提交
2630 2631 2632 2633
export interface InternalEditorRenderLineNumbersOptions {
	readonly renderType: RenderLineNumbersType;
	readonly renderFn: ((lineNumber: number) => string) | null;
}
2634

2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650
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.")
2651
			}
2652 2653
		);
	}
2654

A
Alex Dima 已提交
2655 2656 2657 2658 2659
	public validate(lineNumbers: any): InternalEditorRenderLineNumbersOptions {
		let renderType: RenderLineNumbersType = this.defaultValue.renderType;
		let renderFn: ((lineNumber: number) => string) | null = this.defaultValue.renderFn;

		if (typeof lineNumbers !== 'undefined') {
2660
			if (typeof lineNumbers === 'function') {
A
Alex Dima 已提交
2661 2662
				renderType = RenderLineNumbersType.Custom;
				renderFn = lineNumbers;
2663
			} else if (lineNumbers === 'interval') {
A
Alex Dima 已提交
2664
				renderType = RenderLineNumbersType.Interval;
2665
			} else if (lineNumbers === 'relative') {
A
Alex Dima 已提交
2666
				renderType = RenderLineNumbersType.Relative;
2667
			} else if (lineNumbers === 'on') {
A
Alex Dima 已提交
2668
				renderType = RenderLineNumbersType.On;
2669
			} else {
A
Alex Dima 已提交
2670
				renderType = RenderLineNumbersType.Off;
2671 2672 2673
			}
		}

A
Alex Dima 已提交
2674 2675 2676 2677 2678 2679
		return {
			renderType,
			renderFn
		};
	}
}
2680

A
Alex Dima 已提交
2681 2682
//#endregion

2683 2684 2685 2686 2687
//#region renderValidationDecorations

/**
 * @internal
 */
2688
export function filterValidationDecorations(options: IComputedEditorOptions): boolean {
2689 2690
	const renderValidationDecorations = options.get(EditorOption.renderValidationDecorations);
	if (renderValidationDecorations === 'editable') {
2691
		return options.get(EditorOption.readOnly);
2692
	}
2693
	return renderValidationDecorations === 'on' ? false : true;
2694 2695 2696 2697
}

//#endregion

A
Alex Dima 已提交
2698 2699
//#region rulers

2700 2701 2702
export interface IRulerOption {
	readonly column: number;
	readonly color: string | null;
2703 2704
}

2705
class EditorRulers extends BaseEditorOption<EditorOption.rulers, IRulerOption[]> {
2706 2707

	constructor() {
2708
		const defaults: IRulerOption[] = [];
2709
		const columnSchema: IJSONSchema = { type: 'number', description: nls.localize('rulers.size', "Number of monospace characters at which this editor ruler will render.") };
2710 2711 2712 2713 2714
		super(
			EditorOption.rulers, 'rulers', defaults,
			{
				type: 'array',
				items: {
2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727
					anyOf: [
						columnSchema,
						{
							type: [
								'object'
							],
							properties: {
								column: columnSchema,
								color: {
									type: 'string',
									description: nls.localize('rulers.color', "Color of this editor ruler."),
									format: 'color-hex'
								}
2728 2729
							}
						}
2730
					]
2731 2732 2733
				},
				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.")
2734
			}
2735 2736
		);
	}
2737

2738
	public validate(input: any): IRulerOption[] {
A
Alex Dima 已提交
2739
		if (Array.isArray(input)) {
2740
			let rulers: IRulerOption[] = [];
2741 2742 2743 2744 2745 2746
			for (let _element of input) {
				if (typeof _element === 'number') {
					rulers.push({
						column: EditorIntOption.clampedInt(_element, 0, 0, 10000),
						color: null
					});
A
Alex Dima 已提交
2747
				} else if (_element && typeof _element === 'object') {
2748 2749 2750 2751 2752
					const element = _element as IRulerOption;
					rulers.push({
						column: EditorIntOption.clampedInt(element.column, 0, 0, 10000),
						color: element.color
					});
2753
				}
2754
			}
2755
			rulers.sort((a, b) => a.column - b.column);
A
Alex Dima 已提交
2756
			return rulers;
2757
		}
A
Alex Dima 已提交
2758 2759 2760
		return this.defaultValue;
	}
}
2761

A
Alex Dima 已提交
2762
//#endregion
T
Tiago Ribeiro 已提交
2763

A
Alex Dima 已提交
2764
//#region scrollbar
2765

2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804
/**
 * 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;
2805 2806 2807 2808 2809
	/**
	 * Always consume mouse wheel events (always call preventDefault() and stopPropagation() on the browser events).
	 * Defaults to true.
	 */
	alwaysConsumeMouseWheel?: boolean;
2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831
	/**
	 * 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;
}

A
Alex Dima 已提交
2832 2833 2834 2835 2836 2837 2838 2839
export interface InternalEditorScrollbarOptions {
	readonly arrowSize: number;
	readonly vertical: ScrollbarVisibility;
	readonly horizontal: ScrollbarVisibility;
	readonly useShadows: boolean;
	readonly verticalHasArrows: boolean;
	readonly horizontalHasArrows: boolean;
	readonly handleMouseWheel: boolean;
2840
	readonly alwaysConsumeMouseWheel: boolean;
A
Alex Dima 已提交
2841 2842 2843 2844 2845 2846
	readonly horizontalScrollbarSize: number;
	readonly horizontalSliderSize: number;
	readonly verticalScrollbarSize: number;
	readonly verticalSliderSize: number;
}

A
Alex Dima 已提交
2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857
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;
	}
}

2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874
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,
				horizontalScrollbarSize: 10,
				horizontalSliderSize: 10,
				verticalScrollbarSize: 14,
				verticalSliderSize: 14,
				handleMouseWheel: true,
2875
				alwaysConsumeMouseWheel: true
2876 2877 2878 2879
			}
		);
	}

A
Alex Dima 已提交
2880
	public validate(_input: any): InternalEditorScrollbarOptions {
A
Alex Dima 已提交
2881
		if (!_input || typeof _input !== 'object') {
A
Alex Dima 已提交
2882 2883 2884
			return this.defaultValue;
		}
		const input = _input as IEditorScrollbarOptions;
A
Alex Dima 已提交
2885 2886
		const horizontalScrollbarSize = EditorIntOption.clampedInt(input.horizontalScrollbarSize, this.defaultValue.horizontalScrollbarSize, 0, 1000);
		const verticalScrollbarSize = EditorIntOption.clampedInt(input.verticalScrollbarSize, this.defaultValue.verticalScrollbarSize, 0, 1000);
2887
		return {
A
Alex Dima 已提交
2888
			arrowSize: EditorIntOption.clampedInt(input.arrowSize, this.defaultValue.arrowSize, 0, 1000),
A
Alex Dima 已提交
2889 2890
			vertical: _scrollbarVisibilityFromString(input.vertical, this.defaultValue.vertical),
			horizontal: _scrollbarVisibilityFromString(input.horizontal, this.defaultValue.horizontal),
A
Alex Dima 已提交
2891 2892 2893 2894
			useShadows: EditorBooleanOption.boolean(input.useShadows, this.defaultValue.useShadows),
			verticalHasArrows: EditorBooleanOption.boolean(input.verticalHasArrows, this.defaultValue.verticalHasArrows),
			horizontalHasArrows: EditorBooleanOption.boolean(input.horizontalHasArrows, this.defaultValue.horizontalHasArrows),
			handleMouseWheel: EditorBooleanOption.boolean(input.handleMouseWheel, this.defaultValue.handleMouseWheel),
2895
			alwaysConsumeMouseWheel: EditorBooleanOption.boolean(input.alwaysConsumeMouseWheel, this.defaultValue.alwaysConsumeMouseWheel),
A
Alex Dima 已提交
2896
			horizontalScrollbarSize: horizontalScrollbarSize,
A
Alex Dima 已提交
2897
			horizontalSliderSize: EditorIntOption.clampedInt(input.horizontalSliderSize, horizontalScrollbarSize, 0, 1000),
A
Alex Dima 已提交
2898
			verticalScrollbarSize: verticalScrollbarSize,
A
Alex Dima 已提交
2899
			verticalSliderSize: EditorIntOption.clampedInt(input.verticalSliderSize, verticalScrollbarSize, 0, 1000),
A
Alex Dima 已提交
2900 2901
		};
	}
A
Alex Dima 已提交
2902
}
A
Alex Dima 已提交
2903

A
Alex Dima 已提交
2904 2905 2906 2907
//#endregion

//#region suggest

2908 2909 2910 2911
/**
 * Configuration options for editor suggest widget
 */
export interface ISuggestOptions {
2912 2913 2914
	/**
	 * Overwrite word ends on accept. Default to false.
	 */
2915
	insertMode?: 'insert' | 'replace';
2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940
	/**
	 * Enable graceful matching. Defaults to true.
	 */
	filterGraceful?: boolean;
	/**
	 * Prevent quick suggestions when a snippet is active. Defaults to true.
	 */
	snippetsPreventQuickSuggestions?: boolean;
	/**
	 * Favours words that appear close to the cursor.
	 */
	localityBonus?: boolean;
	/**
	 * Enable using global storage for remembering suggestions.
	 */
	shareSuggestSelections?: boolean;
	/**
	 * Enable or disable icons in suggestions. Defaults to true.
	 */
	showIcons?: boolean;
	/**
	 * Max suggestions to show in suggestions. Defaults to 12.
	 */
	maxVisibleSuggestions?: number;
	/**
2941
	 * Show method-suggestions.
2942
	 */
2943 2944 2945 2946 2947 2948 2949
	showMethods?: boolean;
	/**
	 * Show function-suggestions.
	 */
	showFunctions?: boolean;
	/**
	 * Show constructor-suggestions.
2950
	 */
2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 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
	showConstructors?: boolean;
	/**
	 * 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;
3036 3037 3038 3039 3040 3041 3042 3043
	/**
	 * Show issue-suggestions.
	 */
	showIssues?: boolean;
	/**
	 * Show user-suggestions.
	 */
	showUsers?: boolean;
3044 3045 3046 3047
	/**
	 * Show snippet-suggestions.
	 */
	showSnippets?: boolean;
P
Pine Wu 已提交
3048
	/**
P
Pine Wu 已提交
3049
	 * Status bar related settings.
P
Pine Wu 已提交
3050
	 */
P
Pine Wu 已提交
3051 3052 3053 3054 3055 3056
	statusBar?: {
		/**
		 * Controls the visibility of the status bar at the bottom of the suggest widget.
		 */
		visible?: boolean;
	}
3057 3058
}

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

A
Alex Dima 已提交
3061
class EditorSuggest extends BaseEditorOption<EditorOption.suggest, InternalSuggestOptions> {
3062 3063 3064

	constructor() {
		const defaults: InternalSuggestOptions = {
3065
			insertMode: 'insert',
3066 3067 3068 3069 3070 3071
			filterGraceful: true,
			snippetsPreventQuickSuggestions: true,
			localityBonus: false,
			shareSuggestSelections: false,
			showIcons: true,
			maxVisibleSuggestions: 12,
3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096
			showMethods: true,
			showFunctions: true,
			showConstructors: true,
			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,
3097 3098
			showUsers: true,
			showIssues: true,
P
Pine Wu 已提交
3099 3100 3101
			statusBar: {
				visible: false
			}
3102 3103 3104 3105
		};
		super(
			EditorOption.suggest, 'suggest', defaults,
			{
3106 3107 3108 3109 3110 3111 3112 3113 3114
				'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.")
3115
				},
3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133
				'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,
					description: nls.localize('suggest.localityBonus', "Controls whether sorting favours words that appear close to the cursor.")
				},
				'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 已提交
3134
					description: nls.localize('suggest.snippetsPreventQuickSuggestions', "Controls whether an active snippet prevents quick suggestions.")
3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149
				},
				'editor.suggest.showIcons': {
					type: 'boolean',
					default: defaults.showIcons,
					description: nls.localize('suggest.showIcons', "Controls whether to show or hide icons in suggestions.")
				},
				'editor.suggest.maxVisibleSuggestions': {
					type: 'number',
					default: defaults.maxVisibleSuggestions,
					minimum: 1,
					maximum: 15,
					description: nls.localize('suggest.maxVisibleSuggestions', "Controls how many suggestions IntelliSense will show before showing a scrollbar (maximum 15).")
				},
				'editor.suggest.filteredTypes': {
					type: 'object',
3150
					deprecationMessage: nls.localize('deprecated', "This setting is deprecated, please use separate settings like 'editor.suggest.showKeywords' or 'editor.suggest.showSnippets' instead.")
J
Johannes Rieken 已提交
3151
				},
3152
				'editor.suggest.showMethods': {
3153 3154
					type: 'boolean',
					default: true,
3155
					markdownDescription: nls.localize('editor.suggest.showMethods', "When enabled IntelliSense shows `method`-suggestions.")
3156
				},
3157
				'editor.suggest.showFunctions': {
3158 3159
					type: 'boolean',
					default: true,
3160
					markdownDescription: nls.localize('editor.suggest.showFunctions', "When enabled IntelliSense shows `function`-suggestions.")
3161
				},
3162
				'editor.suggest.showConstructors': {
3163 3164
					type: 'boolean',
					default: true,
3165
					markdownDescription: nls.localize('editor.suggest.showConstructors', "When enabled IntelliSense shows `constructor`-suggestions.")
3166
				},
3167
				'editor.suggest.showFields': {
3168 3169
					type: 'boolean',
					default: true,
3170
					markdownDescription: nls.localize('editor.suggest.showFields', "When enabled IntelliSense shows `field`-suggestions.")
3171
				},
3172
				'editor.suggest.showVariables': {
3173 3174
					type: 'boolean',
					default: true,
3175
					markdownDescription: nls.localize('editor.suggest.showVariables', "When enabled IntelliSense shows `variable`-suggestions.")
3176
				},
3177
				'editor.suggest.showClasses': {
3178 3179
					type: 'boolean',
					default: true,
3180
					markdownDescription: nls.localize('editor.suggest.showClasss', "When enabled IntelliSense shows `class`-suggestions.")
3181
				},
3182
				'editor.suggest.showStructs': {
3183 3184
					type: 'boolean',
					default: true,
3185
					markdownDescription: nls.localize('editor.suggest.showStructs', "When enabled IntelliSense shows `struct`-suggestions.")
3186
				},
3187
				'editor.suggest.showInterfaces': {
3188 3189
					type: 'boolean',
					default: true,
3190
					markdownDescription: nls.localize('editor.suggest.showInterfaces', "When enabled IntelliSense shows `interface`-suggestions.")
3191
				},
3192
				'editor.suggest.showModules': {
3193 3194
					type: 'boolean',
					default: true,
3195
					markdownDescription: nls.localize('editor.suggest.showModules', "When enabled IntelliSense shows `module`-suggestions.")
3196
				},
3197
				'editor.suggest.showProperties': {
3198 3199
					type: 'boolean',
					default: true,
3200
					markdownDescription: nls.localize('editor.suggest.showPropertys', "When enabled IntelliSense shows `property`-suggestions.")
3201
				},
3202
				'editor.suggest.showEvents': {
3203 3204
					type: 'boolean',
					default: true,
3205
					markdownDescription: nls.localize('editor.suggest.showEvents', "When enabled IntelliSense shows `event`-suggestions.")
3206
				},
3207
				'editor.suggest.showOperators': {
3208 3209
					type: 'boolean',
					default: true,
3210
					markdownDescription: nls.localize('editor.suggest.showOperators', "When enabled IntelliSense shows `operator`-suggestions.")
3211
				},
3212
				'editor.suggest.showUnits': {
3213 3214
					type: 'boolean',
					default: true,
3215
					markdownDescription: nls.localize('editor.suggest.showUnits', "When enabled IntelliSense shows `unit`-suggestions.")
3216
				},
3217
				'editor.suggest.showValues': {
3218 3219
					type: 'boolean',
					default: true,
3220
					markdownDescription: nls.localize('editor.suggest.showValues', "When enabled IntelliSense shows `value`-suggestions.")
3221
				},
3222
				'editor.suggest.showConstants': {
3223 3224
					type: 'boolean',
					default: true,
3225
					markdownDescription: nls.localize('editor.suggest.showConstants', "When enabled IntelliSense shows `constant`-suggestions.")
3226
				},
3227
				'editor.suggest.showEnums': {
3228 3229
					type: 'boolean',
					default: true,
3230
					markdownDescription: nls.localize('editor.suggest.showEnums', "When enabled IntelliSense shows `enum`-suggestions.")
3231
				},
3232
				'editor.suggest.showEnumMembers': {
3233 3234
					type: 'boolean',
					default: true,
3235
					markdownDescription: nls.localize('editor.suggest.showEnumMembers', "When enabled IntelliSense shows `enumMember`-suggestions.")
3236
				},
3237
				'editor.suggest.showKeywords': {
3238 3239
					type: 'boolean',
					default: true,
3240
					markdownDescription: nls.localize('editor.suggest.showKeywords', "When enabled IntelliSense shows `keyword`-suggestions.")
3241
				},
3242
				'editor.suggest.showWords': {
3243 3244
					type: 'boolean',
					default: true,
3245
					markdownDescription: nls.localize('editor.suggest.showTexts', "When enabled IntelliSense shows `text`-suggestions.")
3246
				},
3247
				'editor.suggest.showColors': {
3248 3249
					type: 'boolean',
					default: true,
3250
					markdownDescription: nls.localize('editor.suggest.showColors', "When enabled IntelliSense shows `color`-suggestions.")
3251
				},
3252
				'editor.suggest.showFiles': {
3253 3254
					type: 'boolean',
					default: true,
3255
					markdownDescription: nls.localize('editor.suggest.showFiles', "When enabled IntelliSense shows `file`-suggestions.")
3256
				},
3257
				'editor.suggest.showReferences': {
3258 3259
					type: 'boolean',
					default: true,
3260
					markdownDescription: nls.localize('editor.suggest.showReferences', "When enabled IntelliSense shows `reference`-suggestions.")
3261
				},
3262
				'editor.suggest.showCustomcolors': {
3263 3264
					type: 'boolean',
					default: true,
3265
					markdownDescription: nls.localize('editor.suggest.showCustomcolors', "When enabled IntelliSense shows `customcolor`-suggestions.")
3266
				},
3267
				'editor.suggest.showFolders': {
3268 3269
					type: 'boolean',
					default: true,
3270
					markdownDescription: nls.localize('editor.suggest.showFolders', "When enabled IntelliSense shows `folder`-suggestions.")
3271
				},
3272
				'editor.suggest.showTypeParameters': {
3273 3274
					type: 'boolean',
					default: true,
3275
					markdownDescription: nls.localize('editor.suggest.showTypeParameters', "When enabled IntelliSense shows `typeParameter`-suggestions.")
3276
				},
3277
				'editor.suggest.showSnippets': {
3278 3279
					type: 'boolean',
					default: true,
3280
					markdownDescription: nls.localize('editor.suggest.showSnippets', "When enabled IntelliSense shows `snippet`-suggestions.")
3281
				},
3282 3283 3284 3285 3286 3287 3288 3289 3290 3291
				'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.")
				},
P
Pine Wu 已提交
3292
				'editor.suggest.statusBar.visible': {
P
Pine Wu 已提交
3293
					type: 'boolean',
P
Pine Wu 已提交
3294 3295
					default: false,
					markdownDescription: nls.localize('editor.suggest.statusBar.visible', "Controls the visibility of the status bar at the bottom of the suggest widget.")
3296
				}
3297 3298 3299 3300
			}
		);
	}

A
Alex Dima 已提交
3301
	public validate(_input: any): InternalSuggestOptions {
A
Alex Dima 已提交
3302
		if (!_input || typeof _input !== 'object') {
A
Alex Dima 已提交
3303
			return this.defaultValue;
A
Alex Dima 已提交
3304
		}
A
Alex Dima 已提交
3305
		const input = _input as ISuggestOptions;
A
Alex Dima 已提交
3306
		return {
3307
			insertMode: EditorStringEnumOption.stringSet(input.insertMode, this.defaultValue.insertMode, ['insert', 'replace']),
A
Alex Dima 已提交
3308 3309 3310 3311 3312
			filterGraceful: EditorBooleanOption.boolean(input.filterGraceful, this.defaultValue.filterGraceful),
			snippetsPreventQuickSuggestions: EditorBooleanOption.boolean(input.snippetsPreventQuickSuggestions, this.defaultValue.filterGraceful),
			localityBonus: EditorBooleanOption.boolean(input.localityBonus, this.defaultValue.localityBonus),
			shareSuggestSelections: EditorBooleanOption.boolean(input.shareSuggestSelections, this.defaultValue.shareSuggestSelections),
			showIcons: EditorBooleanOption.boolean(input.showIcons, this.defaultValue.showIcons),
A
Alex Dima 已提交
3313
			maxVisibleSuggestions: EditorIntOption.clampedInt(input.maxVisibleSuggestions, this.defaultValue.maxVisibleSuggestions, 1, 15),
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
			showMethods: EditorBooleanOption.boolean(input.showMethods, this.defaultValue.showMethods),
			showFunctions: EditorBooleanOption.boolean(input.showFunctions, this.defaultValue.showFunctions),
			showConstructors: EditorBooleanOption.boolean(input.showConstructors, this.defaultValue.showConstructors),
			showFields: EditorBooleanOption.boolean(input.showFields, this.defaultValue.showFields),
			showVariables: EditorBooleanOption.boolean(input.showVariables, this.defaultValue.showVariables),
			showClasses: EditorBooleanOption.boolean(input.showClasses, this.defaultValue.showClasses),
			showStructs: EditorBooleanOption.boolean(input.showStructs, this.defaultValue.showStructs),
			showInterfaces: EditorBooleanOption.boolean(input.showInterfaces, this.defaultValue.showInterfaces),
			showModules: EditorBooleanOption.boolean(input.showModules, this.defaultValue.showModules),
			showProperties: EditorBooleanOption.boolean(input.showProperties, this.defaultValue.showProperties),
			showEvents: EditorBooleanOption.boolean(input.showEvents, this.defaultValue.showEvents),
			showOperators: EditorBooleanOption.boolean(input.showOperators, this.defaultValue.showOperators),
			showUnits: EditorBooleanOption.boolean(input.showUnits, this.defaultValue.showUnits),
			showValues: EditorBooleanOption.boolean(input.showValues, this.defaultValue.showValues),
			showConstants: EditorBooleanOption.boolean(input.showConstants, this.defaultValue.showConstants),
			showEnums: EditorBooleanOption.boolean(input.showEnums, this.defaultValue.showEnums),
			showEnumMembers: EditorBooleanOption.boolean(input.showEnumMembers, this.defaultValue.showEnumMembers),
			showKeywords: EditorBooleanOption.boolean(input.showKeywords, this.defaultValue.showKeywords),
			showWords: EditorBooleanOption.boolean(input.showWords, this.defaultValue.showWords),
			showColors: EditorBooleanOption.boolean(input.showColors, this.defaultValue.showColors),
			showFiles: EditorBooleanOption.boolean(input.showFiles, this.defaultValue.showFiles),
			showReferences: EditorBooleanOption.boolean(input.showReferences, this.defaultValue.showReferences),
			showFolders: EditorBooleanOption.boolean(input.showFolders, this.defaultValue.showFolders),
			showTypeParameters: EditorBooleanOption.boolean(input.showTypeParameters, this.defaultValue.showTypeParameters),
			showSnippets: EditorBooleanOption.boolean(input.showSnippets, this.defaultValue.showSnippets),
3339 3340
			showUsers: EditorBooleanOption.boolean(input.showUsers, this.defaultValue.showUsers),
			showIssues: EditorBooleanOption.boolean(input.showIssues, this.defaultValue.showIssues),
P
Pine Wu 已提交
3341 3342 3343
			statusBar: {
				visible: EditorBooleanOption.boolean(input.statusBar?.visible, !!this.defaultValue.statusBar.visible)
			}
3344 3345 3346 3347
		};
	}
}

A
Alex Dima 已提交
3348 3349 3350 3351
//#endregion

//#region tabFocusMode

A
Alex Dima 已提交
3352 3353 3354 3355 3356 3357
class EditorTabFocusMode extends ComputedEditorOption<EditorOption.tabFocusMode, boolean> {

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

A
Alex Dima 已提交
3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395
	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;
3396
	}
A
Alex Dima 已提交
3397
}
3398

A
Alex Dima 已提交
3399
//#endregion
3400

A
Alex Dima 已提交
3401
//#region wrappingInfo
3402

A
Alex Dima 已提交
3403 3404 3405 3406 3407 3408
export interface EditorWrappingInfo {
	readonly isDominatedByLongLines: boolean;
	readonly isWordWrapMinified: boolean;
	readonly isViewportWrapping: boolean;
	readonly wrappingColumn: number;
}
3409

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

A
Alex Dima 已提交
3412
	constructor() {
3413
		super(EditorOption.wrappingInfo, [EditorOption.layoutInfo]);
A
Alex Dima 已提交
3414 3415
	}

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

A
Alex Dima 已提交
3419
		return {
3420
			isDominatedByLongLines: env.isDominatedByLongLines,
3421 3422 3423
			isWordWrapMinified: layoutInfo.isWordWrapMinified,
			isViewportWrapping: layoutInfo.isViewportWrapping,
			wrappingColumn: layoutInfo.wrappingColumn,
A
Alex Dima 已提交
3424
		};
3425 3426 3427
	}
}

A
Alex Dima 已提交
3428
//#endregion
3429 3430 3431

const DEFAULT_WINDOWS_FONT_FAMILY = 'Consolas, \'Courier New\', monospace';
const DEFAULT_MAC_FONT_FAMILY = 'Menlo, Monaco, \'Courier New\', monospace';
3432
const DEFAULT_LINUX_FONT_FAMILY = '\'Droid Sans Mono\', \'monospace\', monospace, \'Droid Sans Fallback\'';
3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445

/**
 * @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,
3446
	letterSpacing: 0,
3447 3448 3449 3450 3451 3452 3453
};

/**
 * @internal
 */
export const EDITOR_MODEL_DEFAULTS = {
	tabSize: 4,
D
David Lechner 已提交
3454
	indentSize: 4,
3455 3456
	insertSpaces: true,
	detectIndentation: true,
3457
	trimAutoWhitespace: true,
3458
	largeFileOptimizations: true
3459 3460 3461 3462 3463
};

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

3466
function register<K1 extends EditorOption, V>(option: IEditorOption<K1, V>): IEditorOption<K1, V> {
A
Alex Dima 已提交
3467 3468 3469 3470
	editorOptionsRegistry[option.id] = option;
	return option;
}

A
renames  
Alex Dima 已提交
3471
export const enum EditorOption {
A
Alex Dima 已提交
3472 3473
	acceptSuggestionOnCommitCharacter,
	acceptSuggestionOnEnter,
A
Alex Dima 已提交
3474
	accessibilitySupport,
I
isidor 已提交
3475
	accessibilityPageSize,
3476
	ariaLabel,
A
Alex Dima 已提交
3477 3478 3479 3480 3481 3482
	autoClosingBrackets,
	autoClosingOvertype,
	autoClosingQuotes,
	autoIndent,
	automaticLayout,
	autoSurround,
A
Alex Dima 已提交
3483 3484
	codeLens,
	colorDecorators,
3485
	columnSelection,
A
Alex Dima 已提交
3486
	comments,
A
Alex Dima 已提交
3487
	contextmenu,
A
Alex Dima 已提交
3488 3489 3490 3491 3492
	copyWithSyntaxHighlighting,
	cursorBlinking,
	cursorSmoothCaretAnimation,
	cursorStyle,
	cursorSurroundingLines,
3493
	cursorSurroundingLinesStyle,
A
Alex Dima 已提交
3494 3495
	cursorWidth,
	disableLayerHinting,
3496
	disableMonospaceOptimizations,
A
Alex Dima 已提交
3497 3498 3499
	dragAndDrop,
	emptySelectionClipboard,
	extraEditorClassName,
A
Alex Dima 已提交
3500
	fastScrollSensitivity,
A
Alex Dima 已提交
3501
	find,
A
Alex Dima 已提交
3502
	fixedOverflowWidgets,
A
Alex Dima 已提交
3503
	folding,
A
Alex Dima 已提交
3504
	foldingStrategy,
3505
	foldingHighlight,
3506
	unfoldOnClickAfterEndOfLine,
3507 3508
	fontFamily,
	fontInfo,
A
Alex Dima 已提交
3509
	fontLigatures,
3510 3511
	fontSize,
	fontWeight,
A
Alex Dima 已提交
3512 3513
	formatOnPaste,
	formatOnType,
A
Alex Dima 已提交
3514
	glyphMargin,
A
Alex Dima 已提交
3515
	gotoLocation,
A
Alex Dima 已提交
3516 3517
	hideCursorInOverviewRuler,
	highlightActiveIndentGuide,
A
Alex Dima 已提交
3518
	hover,
A
Alex Dima 已提交
3519
	inDiffEditor,
3520
	letterSpacing,
A
Alex Dima 已提交
3521
	lightbulb,
A
Alex Dima 已提交
3522
	lineDecorationsWidth,
A
Alex Dima 已提交
3523
	lineHeight,
A
Alex Dima 已提交
3524
	lineNumbers,
A
Alex Dima 已提交
3525
	lineNumbersMinChars,
A
Alex Dima 已提交
3526 3527
	links,
	matchBrackets,
A
Alex Dima 已提交
3528
	minimap,
A
Alex Dima 已提交
3529
	mouseStyle,
A
Alex Dima 已提交
3530
	mouseWheelScrollSensitivity,
A
Alex Dima 已提交
3531 3532 3533
	mouseWheelZoom,
	multiCursorMergeOverlapping,
	multiCursorModifier,
3534
	multiCursorPaste,
A
Alex Dima 已提交
3535
	occurrencesHighlight,
A
Alex Dima 已提交
3536 3537
	overviewRulerBorder,
	overviewRulerLanes,
B
Bailey 已提交
3538
	padding,
A
Alex Dima 已提交
3539
	parameterHints,
3540
	peekWidgetDefaultFocus,
3541
	definitionLinkOpensInPeek,
A
Alex Dima 已提交
3542
	quickSuggestions,
A
Alex Dima 已提交
3543
	quickSuggestionsDelay,
3544
	readOnly,
P
Rename  
Pine Wu 已提交
3545
	renameOnType,
A
Alex Dima 已提交
3546 3547
	renderControlCharacters,
	renderIndentGuides,
A
Alex Dima 已提交
3548
	renderFinalNewline,
A
Alex Dima 已提交
3549
	renderLineHighlight,
3550
	renderLineHighlightOnlyWhenFocus,
3551
	renderValidationDecorations,
A
Alex Dima 已提交
3552 3553 3554 3555
	renderWhitespace,
	revealHorizontalRightPadding,
	roundedSelection,
	rulers,
A
Alex Dima 已提交
3556
	scrollbar,
A
Alex Dima 已提交
3557 3558
	scrollBeyondLastColumn,
	scrollBeyondLastLine,
3559
	scrollPredominantAxis,
A
Alex Dima 已提交
3560
	selectionClipboard,
A
Alex Dima 已提交
3561
	selectionHighlight,
A
Alex Dima 已提交
3562
	selectOnLineNumbers,
A
Alex Dima 已提交
3563
	showFoldingControls,
A
Alex Dima 已提交
3564
	showUnused,
A
Alex Dima 已提交
3565
	snippetSuggestions,
A
Alex Dima 已提交
3566 3567
	smoothScrolling,
	stopRenderingLineAfter,
A
Alex Dima 已提交
3568
	suggest,
A
Alex Dima 已提交
3569 3570
	suggestFontSize,
	suggestLineHeight,
A
Alex Dima 已提交
3571
	suggestOnTriggerCharacters,
A
Alex Dima 已提交
3572 3573
	suggestSelection,
	tabCompletion,
A
Alex Dima 已提交
3574 3575
	useTabStops,
	wordSeparators,
A
Alex Dima 已提交
3576 3577 3578 3579 3580 3581
	wordWrap,
	wordWrapBreakAfterCharacters,
	wordWrapBreakBeforeCharacters,
	wordWrapColumn,
	wordWrapMinified,
	wrappingIndent,
3582
	wrappingStrategy,
A
Alex Dima 已提交
3583

A
Alex Dima 已提交
3584
	// Leave these at the end (because they have dependencies!)
A
Alex Dima 已提交
3585
	editorClassName,
A
Alex Dima 已提交
3586
	pixelRatio,
A
Alex Dima 已提交
3587
	tabFocusMode,
A
Alex Dima 已提交
3588 3589
	layoutInfo,
	wrappingInfo,
3590 3591
}

3592
/**
3593 3594 3595
 * 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 已提交
3596
 * /comments, any/comments, EditorCommentsOptions/
3597 3598 3599 3600 3601 3602 3603 3604 3605
 * /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/
3606
 */
A
renames  
Alex Dima 已提交
3607
export const EditorOptions = {
3608 3609 3610 3611
	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.") }
	)),
3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625
	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 已提交
3626 3627
	accessibilityPageSize: register(new EditorIntOption(EditorOption.accessibilityPageSize, 'accessibilityPageSize', 10, 1, Constants.MAX_SAFE_SMALL_INTEGER,
		{ description: nls.localize('accessibilityPageSize', "Controls the number of lines in the editor that can be read out by a screen reader. Warning: this has a performance implication for numbers larger than the default.") })),
3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671
	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.")
		}
	)),
	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 已提交
3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686
	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.")
		}
3687 3688 3689 3690
	)),
	automaticLayout: register(new EditorBooleanOption(
		EditorOption.automaticLayout, 'automaticLayout', false,
	)),
3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704
	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."),
				''
			],
			description: nls.localize('autoSurround', "Controls whether the editor should automatically surround selections.")
		}
	)),
3705 3706 3707 3708 3709 3710 3711 3712
	codeLens: register(new EditorBooleanOption(
		EditorOption.codeLens, 'codeLens', true,
		{ description: nls.localize('codeLens', "Controls whether the editor shows CodeLens.") }
	)),
	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.") }
	)),
3713 3714 3715 3716
	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 已提交
3717
	comments: register(new EditorComments()),
3718 3719 3720 3721 3722 3723 3724
	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.") }
	)),
3725 3726 3727 3728 3729 3730 3731
	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.") }
	)),
3732 3733 3734 3735
	cursorSmoothCaretAnimation: register(new EditorBooleanOption(
		EditorOption.cursorSmoothCaretAnimation, 'cursorSmoothCaretAnimation', false,
		{ description: nls.localize('cursorSmoothCaretAnimation', "Controls whether the smooth caret animation should be enabled.") }
	)),
3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747
	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,
		{ 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.") }
	)),
3748 3749 3750 3751 3752 3753
	cursorSurroundingLinesStyle: register(new EditorStringEnumOption(
		EditorOption.cursorSurroundingLinesStyle, 'cursorSurroundingLinesStyle',
		'default' as 'default' | 'all',
		['default', 'all'] as const,
		{
			enumDescriptions: [
G
Greg Van Liew 已提交
3754
				nls.localize('cursorSurroundingLinesStyle.default', "`cursorSurroundingLines` is enforced only when triggered via the keyboard or API."),
3755 3756
				nls.localize('cursorSurroundingLinesStyle.all', "`cursorSurroundingLines` is enforced always.")
			],
G
Greg Van Liew 已提交
3757
			description: nls.localize('cursorSurroundingLinesStyle', "Controls when `cursorSurroundingLines` should be enforced.")
3758 3759
		}
	)),
3760 3761 3762 3763 3764
	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`.") }
	)),
3765 3766 3767
	disableLayerHinting: register(new EditorBooleanOption(
		EditorOption.disableLayerHinting, 'disableLayerHinting', false,
	)),
3768 3769 3770
	disableMonospaceOptimizations: register(new EditorBooleanOption(
		EditorOption.disableMonospaceOptimizations, 'disableMonospaceOptimizations', false
	)),
3771 3772 3773 3774
	dragAndDrop: register(new EditorBooleanOption(
		EditorOption.dragAndDrop, 'dragAndDrop', true,
		{ description: nls.localize('dragAndDrop', "Controls whether the editor should allow moving selections via drag and drop.") }
	)),
3775 3776 3777 3778 3779 3780 3781 3782 3783 3784
	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()),
3785 3786 3787 3788 3789 3790 3791
	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.") }
	)),
3792 3793 3794 3795
	foldingStrategy: register(new EditorStringEnumOption(
		EditorOption.foldingStrategy, 'foldingStrategy',
		'auto' as 'auto' | 'indentation',
		['auto', 'indentation'] as const,
3796 3797 3798 3799 3800 3801 3802
		{
			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.")
		}
3803
	)),
3804 3805 3806
	foldingHighlight: register(new EditorBooleanOption(
		EditorOption.foldingHighlight, 'foldingHighlight', true,
		{ description: nls.localize('foldingHighlight', "Controls whether the editor should highlight folded ranges.") }
3807
	)),
3808 3809 3810
	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.") }
3811
	)),
3812 3813 3814 3815 3816
	fontFamily: register(new EditorStringOption(
		EditorOption.fontFamily, 'fontFamily', EDITOR_FONT_DEFAULTS.fontFamily,
		{ description: nls.localize('fontFamily', "Controls the font family.") }
	)),
	fontInfo: register(new EditorFontInfo()),
3817
	fontLigatures2: register(new EditorFontLigatures()),
3818 3819 3820 3821 3822 3823 3824 3825
	fontSize: register(new EditorFontSize()),
	fontWeight: register(new EditorStringOption(
		EditorOption.fontWeight, 'fontWeight', EDITOR_FONT_DEFAULTS.fontWeight,
		{
			enum: ['normal', 'bold', '100', '200', '300', '400', '500', '600', '700', '800', '900'],
			description: nls.localize('fontWeight', "Controls the font weight.")
		}
	)),
3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837
	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.") }
	)),
3838
	gotoLocation: register(new EditorGoToLocation()),
3839 3840 3841 3842 3843 3844 3845 3846
	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.") }
	)),
3847
	hover: register(new EditorHover()),
3848 3849 3850
	inDiffEditor: register(new EditorBooleanOption(
		EditorOption.inDiffEditor, 'inDiffEditor', false,
	)),
3851 3852 3853 3854 3855 3856
	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()),
3857
	lineDecorationsWidth: register(new SimpleEditorOption(EditorOption.lineDecorationsWidth, 'lineDecorationsWidth', 10 as number | string)),
3858 3859 3860 3861
	lineHeight: register(new EditorLineHeight()),
	lineNumbers: register(new EditorRenderLineNumbersOption()),
	lineNumbersMinChars: register(new EditorIntOption(
		EditorOption.lineNumbersMinChars, 'lineNumbersMinChars',
3862
		5, 1, 300
3863
	)),
3864 3865 3866 3867
	links: register(new EditorBooleanOption(
		EditorOption.links, 'links', true,
		{ description: nls.localize('links', "Controls whether the editor should detect links and make them clickable.") }
	)),
3868 3869 3870 3871 3872
	matchBrackets: register(new EditorStringEnumOption(
		EditorOption.matchBrackets, 'matchBrackets',
		'always' as 'never' | 'near' | 'always',
		['always', 'near', 'never'] as const,
		{ description: nls.localize('matchBrackets', "Highlight matching brackets.") }
3873
	)),
3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884
	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.") }
	)),
3885 3886 3887 3888 3889 3890 3891 3892
	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.") }
	)),
3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911
	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).")
		}
	)),
3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923
	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.")
		}
	)),
3924 3925 3926 3927 3928 3929 3930 3931
	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.") }
	)),
3932 3933
	overviewRulerLanes: register(new EditorIntOption(
		EditorOption.overviewRulerLanes, 'overviewRulerLanes',
3934
		3, 0, 3
3935
	)),
B
Bailey 已提交
3936
	padding: register(new EditorPadding()),
3937
	parameterHints: register(new EditorParameterHints()),
3938 3939 3940 3941 3942 3943
	peekWidgetDefaultFocus: register(new EditorStringEnumOption(
		EditorOption.peekWidgetDefaultFocus, 'peekWidgetDefaultFocus',
		'tree' as 'tree' | 'editor',
		['tree', 'editor'] as const,
		{
			enumDescriptions: [
3944
				nls.localize('peekWidgetDefaultFocus.tree', "Focus the tree when opening peek"),
3945 3946 3947 3948
				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.")
		}
3949
	)),
3950 3951
	definitionLinkOpensInPeek: register(new EditorBooleanOption(
		EditorOption.definitionLinkOpensInPeek, 'definitionLinkOpensInPeek', false,
3952
		{ description: nls.localize('definitionLinkOpensInPeek', "Controls whether the Go to Definition mouse gesture always opens the peek widget.") }
3953
	)),
3954 3955 3956 3957 3958 3959
	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.") }
	)),
3960 3961 3962
	readOnly: register(new EditorBooleanOption(
		EditorOption.readOnly, 'readOnly', false,
	)),
P
Rename  
Pine Wu 已提交
3963 3964 3965 3966
	renameOnType: register(new EditorBooleanOption(
		EditorOption.renameOnType, 'renameOnType', false,
		{ description: nls.localize('renameOnType', "Controls whether the editor auto renames on type.") }
	)),
3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978
	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.") }
	)),
3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992
	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.")
		}
	)),
3993 3994 3995 3996
	renderLineHighlightOnlyWhenFocus: register(new EditorBooleanOption(
		EditorOption.renderLineHighlightOnlyWhenFocus, 'renderLineHighlightOnlyWhenFocus', false,
		{ description: nls.localize('renderLineHighlightOnlyWhenFocus', "Controls if the editor should render the current line highlight only when the editor is focused") }
	)),
3997 3998 3999 4000 4001
	renderValidationDecorations: register(new EditorStringEnumOption(
		EditorOption.renderValidationDecorations, 'renderValidationDecorations',
		'editable' as 'editable' | 'on' | 'off',
		['editable', 'on', 'off'] as const
	)),
4002 4003
	renderWhitespace: register(new EditorStringEnumOption(
		EditorOption.renderWhitespace, 'renderWhitespace',
4004
		'selection' as 'selection' | 'none' | 'boundary' | 'all',
4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019
		['none', 'boundary', 'selection', 'all'] as const,
		{
			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."),
				''
			],
			description: nls.localize('renderWhitespace', "Controls how the editor should render whitespace characters.")
		}
	)),
	revealHorizontalRightPadding: register(new EditorIntOption(
		EditorOption.revealHorizontalRightPadding, 'revealHorizontalRightPadding',
		30, 0, 1000,
	)),
4020 4021 4022 4023
	roundedSelection: register(new EditorBooleanOption(
		EditorOption.roundedSelection, 'roundedSelection', true,
		{ description: nls.localize('roundedSelection', "Controls whether selections should have rounded corners.") }
	)),
4024 4025 4026 4027 4028 4029 4030
	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.") }
	)),
4031 4032 4033 4034
	scrollBeyondLastLine: register(new EditorBooleanOption(
		EditorOption.scrollBeyondLastLine, 'scrollBeyondLastLine', true,
		{ description: nls.localize('scrollBeyondLastLine', "Controls whether the editor will scroll beyond the last line.") }
	)),
4035 4036 4037
	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.") }
4038
	)),
4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052
	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,
	)),
4053 4054 4055 4056
	showFoldingControls: register(new EditorStringEnumOption(
		EditorOption.showFoldingControls, 'showFoldingControls',
		'mouseover' as 'always' | 'mouseover',
		['always', 'mouseover'] as const,
4057 4058 4059 4060 4061 4062 4063
		{
			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.")
		}
4064
	)),
4065 4066 4067 4068
	showUnused: register(new EditorBooleanOption(
		EditorOption.showUnused, 'showUnused', true,
		{ description: nls.localize('showUnused', "Controls fading out of unused code.") }
	)),
4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082
	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.")
		}
	)),
4083 4084 4085 4086
	smoothScrolling: register(new EditorBooleanOption(
		EditorOption.smoothScrolling, 'smoothScrolling', false,
		{ description: nls.localize('smoothScrolling', "Controls whether the editor will scroll using an animation.") }
	)),
4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101
	stopRenderingLineAfter: register(new EditorIntOption(
		EditorOption.stopRenderingLineAfter, 'stopRenderingLineAfter',
		10000, -1, Constants.MAX_SAFE_SMALL_INTEGER,
	)),
	suggest: register(new EditorSuggest()),
	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,
		{ markdownDescription: nls.localize('suggestLineHeight', "Line height for the suggest widget. When set to `0`, the value of `#editor.lineHeight#` is used.") }
	)),
4102 4103 4104 4105
	suggestOnTriggerCharacters: register(new EditorBooleanOption(
		EditorOption.suggestOnTriggerCharacters, 'suggestOnTriggerCharacters', true,
		{ description: nls.localize('suggestOnTriggerCharacters', "Controls whether suggestions should automatically show up when typing trigger characters.") }
	)),
4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131
	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.")
		}
	)),
4132 4133 4134 4135
	useTabStops: register(new EditorBooleanOption(
		EditorOption.useTabStops, 'useTabStops', true,
		{ description: nls.localize('useTabStops', "Inserting and deleting whitespace follows tab stops.") }
	)),
4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172
	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',
4173
		' \t})]?|/&.,;¢°′″‰℃、。。、¢,.:;?!%・・ゝゞヽヾーァィゥェォッャュョヮヵヶぁぃぅぇぉっゃゅょゎゕゖㇰㇱㇲㇳㇴㇵㇶㇷㇸㇹㇺㇻㇼㇽㇾㇿ々〻ァィゥェォャュョッー”〉》」』】〕)]}」',
4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191
	)),
	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`.")
		}
	)),
4192 4193 4194
	wordWrapMinified: register(new EditorBooleanOption(
		EditorOption.wordWrapMinified, 'wordWrapMinified', true,
	)),
4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209
	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."),
		}
	)),
4210 4211 4212 4213
	wrappingStrategy: register(new EditorStringEnumOption(
		EditorOption.wrappingStrategy, 'wrappingStrategy',
		'simple' as 'simple' | 'advanced',
		['simple', 'advanced'] as const,
4214 4215
		{
			enumDescriptions: [
4216 4217
				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.")
4218
			],
4219
			description: nls.localize('wrappingStrategy', "Controls the algorithm that computes wrapping points.")
4220 4221
		}
	)),
A
Alex Dima 已提交
4222

A
Alex Dima 已提交
4223
	// Leave these at the end (because they have dependencies!)
4224 4225
	editorClassName: register(new EditorClassName()),
	pixelRatio: register(new EditorPixelRatio()),
A
Alex Dima 已提交
4226
	tabFocusMode: register(new EditorTabFocusMode()),
4227
	layoutInfo: register(new EditorLayoutInfoComputer()),
4228
	wrappingInfo: register(new EditorWrappingInfoComputer())
4229
};
A
Alex Dima 已提交
4230

A
Alex Dima 已提交
4231 4232 4233
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;
4234
export type FindComputedEditorOptionValueById<T extends EditorOption> = NonNullable<ComputedEditorOptionValue<EditorOptionsType[FindEditorOptionsKeyById<T>]>>;