monaco.d.ts 185.2 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
declare let MonacoEnvironment: monaco.Environment | undefined;
7

8
declare namespace monaco {
K
Kamran Ayub 已提交
9

A
Alex Dima 已提交
10
	export type Thenable<T> = PromiseLike<T>;
11

12 13 14 15 16 17
	export interface Environment {
		baseUrl?: string;
		getWorker?(workerId: string, label: string): Worker;
		getWorkerUrl?(workerId: string, label: string): string;
	}

18 19 20 21 22 23 24 25 26 27 28 29 30 31
	export interface IDisposable {
		dispose(): void;
	}

	export interface IEvent<T> {
		(listener: (e: T) => any, thisArg?: any): IDisposable;
	}

	/**
	 * A helper that allows to emit and listen to typed events
	 */
	export class Emitter<T> {
		constructor();
		readonly event: IEvent<T>;
32
		fire(event: T): void;
33 34 35 36
		dispose(): void;
	}


37
	export enum MarkerTag {
38 39
		Unnecessary = 1,
		Deprecated = 2
40 41
	}

J
Johannes Rieken 已提交
42 43 44 45
	export enum MarkerSeverity {
		Hint = 1,
		Info = 2,
		Warning = 4,
46
		Error = 8
J
Johannes Rieken 已提交
47 48
	}

49
	export class CancellationTokenSource {
50
		constructor(parent?: CancellationToken);
M
Matt Bierner 已提交
51
		get token(): CancellationToken;
52
		cancel(): void;
53
		dispose(cancel?: boolean): void;
54 55 56
	}

	export interface CancellationToken {
57 58 59
		/**
		 * A flag signalling is cancellation has been requested.
		 */
60 61
		readonly isCancellationRequested: boolean;
		/**
62 63 64 65
		 * An event which fires when cancellation is requested. This event
		 * only ever fires `once` as cancellation can only happen once. Listeners
		 * that are registered after cancellation will be called (next event loop run),
		 * but also only once.
66
		 *
67 68
		 * @event
		 */
69
		readonly onCancellationRequested: (listener: (e: any) => any, thisArgs?: any, disposables?: IDisposable[]) => IDisposable;
70 71 72
	}
	/**
	 * Uniform Resource Identifier (Uri) http://tools.ietf.org/html/rfc3986.
73
	 * This class is a simple parser which creates the basic component parts
74 75 76 77 78 79 80 81 82 83 84
	 * (http://tools.ietf.org/html/rfc3986#section-3) with minimal validation
	 * and encoding.
	 *
	 *       foo://example.com:8042/over/there?name=ferret#nose
	 *       \_/   \______________/\_________/ \_________/ \__/
	 *        |           |            |            |        |
	 *     scheme     authority       path        query   fragment
	 *        |   _____________________|__
	 *       / \ /                        \
	 *       urn:example:animal:ferret:nose
	 */
J
Johannes Rieken 已提交
85
	export class Uri implements UriComponents {
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
		static isUri(thing: any): thing is Uri;
		/**
		 * scheme is the 'http' part of 'http://www.msft.com/some/path?query#fragment'.
		 * The part before the first colon.
		 */
		readonly scheme: string;
		/**
		 * authority is the 'www.msft.com' part of 'http://www.msft.com/some/path?query#fragment'.
		 * The part between the first double slashes and the next slash.
		 */
		readonly authority: string;
		/**
		 * path is the '/some/path' part of 'http://www.msft.com/some/path?query#fragment'.
		 */
		readonly path: string;
		/**
		 * query is the 'query' part of 'http://www.msft.com/some/path?query#fragment'.
		 */
		readonly query: string;
		/**
		 * fragment is the 'fragment' part of 'http://www.msft.com/some/path?query#fragment'.
		 */
		readonly fragment: string;
		/**
		 * Returns a string representing the corresponding file system path of this Uri.
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
		 * Will handle UNC paths, normalizes windows drive letters to lower-case, and uses the
		 * platform specific path separator.
		 *
		 * * Will *not* validate the path for invalid characters and semantics.
		 * * Will *not* look at the scheme of this Uri.
		 * * The result shall *not* be used for display purposes but for accessing a file on disk.
		 *
		 *
		 * The *difference* to `Uri#path` is the use of the platform specific separator and the handling
		 * of UNC paths. See the below sample of a file-uri with an authority (UNC path).
		 *
		 * ```ts
			const u = Uri.parse('file://server/c$/folder/file.txt')
			u.authority === 'server'
			u.path === '/shares/c$/file.txt'
			u.fsPath === '\\server\c$\folder\file.txt'
		```
		 *
		 * Using `Uri#path` to read a file (using fs-apis) would not be enough because parts of the path,
		 * namely the server name, would be missing. Therefore `Uri#fsPath` exists - it's sugar to ease working
		 * with URIs that represent files on disk (`file` scheme).
132
		 */
M
Matt Bierner 已提交
133
		get fsPath(): string;
134 135
		with(change: {
			scheme?: string;
136 137 138 139
			authority?: string | null;
			path?: string | null;
			query?: string | null;
			fragment?: string | null;
140
		}): Uri;
141 142 143 144 145 146
		/**
		 * Creates a new Uri from a string, e.g. `http://www.msft.com/some/path`,
		 * `file:///usr/home`, or `scheme:with/path`.
		 *
		 * @param value A string which represents an Uri (see `Uri#toString`).
		 */
J
Johannes Rieken 已提交
147
		static parse(value: string, _strict?: boolean): Uri;
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
		/**
		 * Creates a new Uri from a file system path, e.g. `c:\my\files`,
		 * `/usr/home`, or `\\server\share\some\path`.
		 *
		 * The *difference* between `Uri#parse` and `Uri#file` is that the latter treats the argument
		 * as path, not as stringified-uri. E.g. `Uri.file(path)` is **not the same as**
		 * `Uri.parse('file://' + path)` because the path might contain characters that are
		 * interpreted (# and ?). See the following sample:
		 * ```ts
		const good = Uri.file('/coding/c#/project1');
		good.scheme === 'file';
		good.path === '/coding/c#/project1';
		good.fragment === '';
		const bad = Uri.parse('file://' + '/coding/c#/project1');
		bad.scheme === 'file';
		bad.path === '/coding/c'; // path is now broken
		bad.fragment === '/project1';
		```
		 *
		 * @param path A file system path (see `Uri#fsPath`)
		 */
169 170
		static file(path: string): Uri;
		static from(components: {
171
			scheme: string;
172 173 174 175 176 177
			authority?: string;
			path?: string;
			query?: string;
			fragment?: string;
		}): Uri;
		/**
J
Johannes Rieken 已提交
178
		 * Creates a string representation for this Uri. It's guaranteed that calling
179 180 181 182 183 184
		 * `Uri.parse` with the result of this function creates an Uri which is equal
		 * to this Uri.
		 *
		 * * The result shall *not* be used for display purposes but for externalization or transport.
		 * * The result will be encoded using the percentage encoding and encoding happens mostly
		 * ignore the scheme-specific encoding rules.
185 186 187 188
		 *
		 * @param skipEncoding Do not encode the result, default is `false`
		 */
		toString(skipEncoding?: boolean): string;
J
Johannes Rieken 已提交
189
		toJSON(): UriComponents;
J
Johannes Rieken 已提交
190
		static revive(data: UriComponents | Uri): Uri;
191 192 193
		static revive(data: UriComponents | Uri | undefined): Uri | undefined;
		static revive(data: UriComponents | Uri | null): Uri | null;
		static revive(data: UriComponents | Uri | undefined | null): Uri | undefined | null;
J
Johannes Rieken 已提交
194 195 196 197 198 199 200 201
	}

	export interface UriComponents {
		scheme: string;
		authority: string;
		path: string;
		query: string;
		fragment: string;
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
	}

	/**
	 * Virtual Key Codes, the value does not hold any inherent meaning.
	 * Inspired somewhat from https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731(v=vs.85).aspx
	 * But these are "more general", as they should work across browsers & OS`s.
	 */
	export enum KeyCode {
		/**
		 * Placed first to cover the 0 value of the enum.
		 */
		Unknown = 0,
		Backspace = 1,
		Tab = 2,
		Enter = 3,
		Shift = 4,
		Ctrl = 5,
		Alt = 6,
		PauseBreak = 7,
		CapsLock = 8,
		Escape = 9,
		Space = 10,
		PageUp = 11,
		PageDown = 12,
		End = 13,
		Home = 14,
		LeftArrow = 15,
		UpArrow = 16,
		RightArrow = 17,
		DownArrow = 18,
		Insert = 19,
		Delete = 20,
		KEY_0 = 21,
		KEY_1 = 22,
		KEY_2 = 23,
		KEY_3 = 24,
		KEY_4 = 25,
		KEY_5 = 26,
		KEY_6 = 27,
		KEY_7 = 28,
		KEY_8 = 29,
		KEY_9 = 30,
		KEY_A = 31,
		KEY_B = 32,
		KEY_C = 33,
		KEY_D = 34,
		KEY_E = 35,
		KEY_F = 36,
		KEY_G = 37,
		KEY_H = 38,
		KEY_I = 39,
		KEY_J = 40,
		KEY_K = 41,
		KEY_L = 42,
		KEY_M = 43,
		KEY_N = 44,
		KEY_O = 45,
		KEY_P = 46,
		KEY_Q = 47,
		KEY_R = 48,
		KEY_S = 49,
		KEY_T = 50,
		KEY_U = 51,
		KEY_V = 52,
		KEY_W = 53,
		KEY_X = 54,
		KEY_Y = 55,
		KEY_Z = 56,
		Meta = 57,
		ContextMenu = 58,
		F1 = 59,
		F2 = 60,
		F3 = 61,
		F4 = 62,
		F5 = 63,
		F6 = 64,
		F7 = 65,
		F8 = 66,
		F9 = 67,
		F10 = 68,
		F11 = 69,
		F12 = 70,
		F13 = 71,
		F14 = 72,
		F15 = 73,
		F16 = 74,
		F17 = 75,
		F18 = 76,
		F19 = 77,
		NumLock = 78,
		ScrollLock = 79,
		/**
		 * Used for miscellaneous characters; it can vary by keyboard.
		 * For the US standard keyboard, the ';:' key
		 */
		US_SEMICOLON = 80,
		/**
		 * For any country/region, the '+' key
		 * For the US standard keyboard, the '=+' key
		 */
		US_EQUAL = 81,
		/**
		 * For any country/region, the ',' key
		 * For the US standard keyboard, the ',<' key
		 */
		US_COMMA = 82,
		/**
		 * For any country/region, the '-' key
		 * For the US standard keyboard, the '-_' key
		 */
		US_MINUS = 83,
		/**
		 * For any country/region, the '.' key
		 * For the US standard keyboard, the '.>' key
		 */
		US_DOT = 84,
		/**
		 * Used for miscellaneous characters; it can vary by keyboard.
		 * For the US standard keyboard, the '/?' key
		 */
		US_SLASH = 85,
		/**
		 * Used for miscellaneous characters; it can vary by keyboard.
		 * For the US standard keyboard, the '`~' key
		 */
		US_BACKTICK = 86,
		/**
		 * Used for miscellaneous characters; it can vary by keyboard.
		 * For the US standard keyboard, the '[{' key
		 */
		US_OPEN_SQUARE_BRACKET = 87,
		/**
		 * Used for miscellaneous characters; it can vary by keyboard.
		 * For the US standard keyboard, the '\|' key
		 */
		US_BACKSLASH = 88,
		/**
		 * Used for miscellaneous characters; it can vary by keyboard.
		 * For the US standard keyboard, the ']}' key
		 */
		US_CLOSE_SQUARE_BRACKET = 89,
		/**
		 * Used for miscellaneous characters; it can vary by keyboard.
		 * For the US standard keyboard, the ''"' key
		 */
		US_QUOTE = 90,
		/**
		 * Used for miscellaneous characters; it can vary by keyboard.
		 */
		OEM_8 = 91,
		/**
		 * Either the angle bracket key or the backslash key on the RT 102-key keyboard.
		 */
		OEM_102 = 92,
		NUMPAD_0 = 93,
		NUMPAD_1 = 94,
		NUMPAD_2 = 95,
		NUMPAD_3 = 96,
		NUMPAD_4 = 97,
		NUMPAD_5 = 98,
		NUMPAD_6 = 99,
		NUMPAD_7 = 100,
		NUMPAD_8 = 101,
		NUMPAD_9 = 102,
		NUMPAD_MULTIPLY = 103,
		NUMPAD_ADD = 104,
		NUMPAD_SEPARATOR = 105,
		NUMPAD_SUBTRACT = 106,
		NUMPAD_DECIMAL = 107,
		NUMPAD_DIVIDE = 108,
		/**
		 * Cover all key codes when IME is processing input.
		 */
		KEY_IN_COMPOSITION = 109,
376 377
		ABNT_C1 = 110,
		ABNT_C2 = 111,
378 379 380 381
		/**
		 * Placed last to cover the length of the enum.
		 * Please do not depend on this value!
		 */
R
Rob Lourens 已提交
382
		MAX_VALUE = 112
383
	}
384

385 386 387 388 389 390 391
	export class KeyMod {
		static readonly CtrlCmd: number;
		static readonly Shift: number;
		static readonly Alt: number;
		static readonly WinCtrl: number;
		static chord(firstPart: number, secondPart: number): number;
	}
J
Johannes Rieken 已提交
392

393
	export interface IMarkdownString {
394 395
		readonly value: string;
		readonly isTrusted?: boolean;
E
Eric Amodio 已提交
396
		readonly supportThemeIcons?: boolean;
J
Johannes Rieken 已提交
397 398 399
		uris?: {
			[href: string]: UriComponents;
		};
400
	}
401 402

	export interface IKeyboardEvent {
403
		readonly _standardKeyboardEventBrand: true;
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420
		readonly browserEvent: KeyboardEvent;
		readonly target: HTMLElement;
		readonly ctrlKey: boolean;
		readonly shiftKey: boolean;
		readonly altKey: boolean;
		readonly metaKey: boolean;
		readonly keyCode: KeyCode;
		readonly code: string;
		equals(keybinding: number): boolean;
		preventDefault(): void;
		stopPropagation(): void;
	}
	export interface IMouseEvent {
		readonly browserEvent: MouseEvent;
		readonly leftButton: boolean;
		readonly middleButton: boolean;
		readonly rightButton: boolean;
421
		readonly buttons: number;
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
		readonly target: HTMLElement;
		readonly detail: number;
		readonly posx: number;
		readonly posy: number;
		readonly ctrlKey: boolean;
		readonly shiftKey: boolean;
		readonly altKey: boolean;
		readonly metaKey: boolean;
		readonly timestamp: number;
		preventDefault(): void;
		stopPropagation(): void;
	}

	export interface IScrollEvent {
		readonly scrollTop: number;
		readonly scrollLeft: number;
		readonly scrollWidth: number;
		readonly scrollHeight: number;
		readonly scrollTopChanged: boolean;
		readonly scrollLeftChanged: boolean;
		readonly scrollWidthChanged: boolean;
		readonly scrollHeightChanged: boolean;
	}
	/**
	 * A position in the editor. This interface is suitable for serialization.
	 */
	export interface IPosition {
		/**
		 * line number (starts at 1)
		 */
		readonly lineNumber: number;
		/**
		 * column (the first character in a line is between column 1 and column 2)
		 */
		readonly column: number;
	}

	/**
	 * A position in the editor.
	 */
	export class Position {
		/**
		 * line number (starts at 1)
		 */
		readonly lineNumber: number;
		/**
		 * column (the first character in a line is between column 1 and column 2)
		 */
		readonly column: number;
		constructor(lineNumber: number, column: number);
472
		/**
J
Julien Brianceau 已提交
473
		 * Create a new position from this position.
474 475 476 477 478 479 480 481 482 483 484 485
		 *
		 * @param newLineNumber new line number
		 * @param newColumn new column
		 */
		with(newLineNumber?: number, newColumn?: number): Position;
		/**
		 * Derive a new position from this position.
		 *
		 * @param deltaLineNumber line number delta
		 * @param deltaColumn column delta
		 */
		delta(deltaLineNumber?: number, deltaColumn?: number): Position;
486 487 488 489 490 491 492
		/**
		 * Test if this position equals other position
		 */
		equals(other: IPosition): boolean;
		/**
		 * Test if position `a` equals position `b`
		 */
A
Alex Dima 已提交
493
		static equals(a: IPosition | null, b: IPosition | null): boolean;
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
		/**
		 * Test if this position is before other position.
		 * If the two positions are equal, the result will be false.
		 */
		isBefore(other: IPosition): boolean;
		/**
		 * Test if position `a` is before position `b`.
		 * If the two positions are equal, the result will be false.
		 */
		static isBefore(a: IPosition, b: IPosition): boolean;
		/**
		 * Test if this position is before other position.
		 * If the two positions are equal, the result will be true.
		 */
		isBeforeOrEqual(other: IPosition): boolean;
		/**
		 * Test if position `a` is before position `b`.
		 * If the two positions are equal, the result will be true.
		 */
		static isBeforeOrEqual(a: IPosition, b: IPosition): boolean;
		/**
		 * A function that compares positions, useful for sorting
		 */
		static compare(a: IPosition, b: IPosition): number;
		/**
		 * Clone this position.
		 */
		clone(): Position;
		/**
		 * Convert to a human-readable representation.
		 */
		toString(): string;
		/**
		 * Create a `Position` from an `IPosition`.
		 */
		static lift(pos: IPosition): Position;
		/**
		 * Test if `obj` is an `IPosition`.
		 */
		static isIPosition(obj: any): obj is IPosition;
	}

	/**
	 * A range in the editor. This interface is suitable for serialization.
	 */
	export interface IRange {
		/**
		 * Line number on which the range starts (starts at 1).
		 */
		readonly startLineNumber: number;
		/**
		 * Column on which the range starts in line `startLineNumber` (starts at 1).
		 */
		readonly startColumn: number;
		/**
		 * Line number on which the range ends.
		 */
		readonly endLineNumber: number;
		/**
		 * Column on which the range ends in line `endLineNumber`.
		 */
		readonly endColumn: number;
	}

	/**
	 * A range in the editor. (startLineNumber,startColumn) is <= (endLineNumber,endColumn)
	 */
	export class Range {
		/**
		 * Line number on which the range starts (starts at 1).
		 */
		readonly startLineNumber: number;
		/**
		 * Column on which the range starts in line `startLineNumber` (starts at 1).
		 */
		readonly startColumn: number;
		/**
		 * Line number on which the range ends.
		 */
		readonly endLineNumber: number;
		/**
		 * Column on which the range ends in line `endLineNumber`.
		 */
		readonly endColumn: number;
		constructor(startLineNumber: number, startColumn: number, endLineNumber: number, endColumn: number);
		/**
		 * Test if this range is empty.
		 */
		isEmpty(): boolean;
		/**
		 * Test if `range` is empty.
		 */
		static isEmpty(range: IRange): boolean;
		/**
		 * Test if position is in this range. If the position is at the edges, will return true.
		 */
		containsPosition(position: IPosition): boolean;
		/**
		 * Test if `position` is in `range`. If the position is at the edges, will return true.
		 */
		static containsPosition(range: IRange, position: IPosition): boolean;
		/**
		 * Test if range is in this range. If the range is equal to this range, will return true.
		 */
		containsRange(range: IRange): boolean;
		/**
		 * Test if `otherRange` is in `range`. If the ranges are equal, will return true.
		 */
		static containsRange(range: IRange, otherRange: IRange): boolean;
603 604 605 606 607 608 609 610
		/**
		 * Test if `range` is strictly in this range. `range` must start after and end before this range for the result to be true.
		 */
		strictContainsRange(range: IRange): boolean;
		/**
		 * Test if `otherRange` is strinctly in `range` (must start after, and end before). If the ranges are equal, will return false.
		 */
		static strictContainsRange(range: IRange, otherRange: IRange): boolean;
611 612 613 614 615 616 617 618 619 620 621 622 623
		/**
		 * A reunion of the two ranges.
		 * The smallest position will be used as the start point, and the largest one as the end point.
		 */
		plusRange(range: IRange): Range;
		/**
		 * A reunion of the two ranges.
		 * The smallest position will be used as the start point, and the largest one as the end point.
		 */
		static plusRange(a: IRange, b: IRange): Range;
		/**
		 * A intersection of the two ranges.
		 */
624
		intersectRanges(range: IRange): Range | null;
625 626 627
		/**
		 * A intersection of the two ranges.
		 */
628
		static intersectRanges(a: IRange, b: IRange): Range | null;
629 630 631
		/**
		 * Test if this range equals other.
		 */
A
Alex Dima 已提交
632
		equalsRange(other: IRange | null): boolean;
633 634 635
		/**
		 * Test if range `a` equals `b`.
		 */
A
Alex Dima 已提交
636
		static equalsRange(a: IRange | null, b: IRange | null): boolean;
637 638 639 640
		/**
		 * Return the end position (which will be after or equal to the start position)
		 */
		getEndPosition(): Position;
641 642 643 644
		/**
		 * Return the end position (which will be after or equal to the start position)
		 */
		static getEndPosition(range: IRange): Position;
645 646 647 648
		/**
		 * Return the start position (which will be before or equal to the end position)
		 */
		getStartPosition(): Position;
649 650 651 652
		/**
		 * Return the start position (which will be before or equal to the end position)
		 */
		static getStartPosition(range: IRange): Position;
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
		/**
		 * Transform to a user presentable string representation.
		 */
		toString(): string;
		/**
		 * Create a new range using this range's start position, and using endLineNumber and endColumn as the end position.
		 */
		setEndPosition(endLineNumber: number, endColumn: number): Range;
		/**
		 * Create a new range using this range's end position, and using startLineNumber and startColumn as the start position.
		 */
		setStartPosition(startLineNumber: number, startColumn: number): Range;
		/**
		 * Create a new empty range using this range's start position.
		 */
		collapseToStart(): Range;
		/**
		 * Create a new empty range using this range's start position.
		 */
		static collapseToStart(range: IRange): Range;
J
Johannes Rieken 已提交
673
		static fromPositions(start: IPosition, end?: IPosition): Range;
674 675 676
		/**
		 * Create a `Range` from an `IRange`.
		 */
677
		static lift(range: undefined | null): null;
678 679 680 681 682 683 684 685 686
		static lift(range: IRange): Range;
		/**
		 * Test if `obj` is an `IRange`.
		 */
		static isIRange(obj: any): obj is IRange;
		/**
		 * Test if the two ranges are touching in any way.
		 */
		static areIntersectingOrTouching(a: IRange, b: IRange): boolean;
687 688 689 690
		/**
		 * Test if the two ranges are intersecting. If the ranges are touching it returns true.
		 */
		static areIntersecting(a: IRange, b: IRange): boolean;
691 692 693 694
		/**
		 * A function that compares ranges, useful for sorting ranges
		 * It will first compare ranges on the startPosition and then on the endPosition
		 */
A
Alex Dima 已提交
695
		static compareRangesUsingStarts(a: IRange | null | undefined, b: IRange | null | undefined): number;
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771
		/**
		 * A function that compares ranges, useful for sorting ranges
		 * It will first compare ranges on the endPosition and then on the startPosition
		 */
		static compareRangesUsingEnds(a: IRange, b: IRange): number;
		/**
		 * Test if the range spans multiple lines.
		 */
		static spansMultipleLines(range: IRange): boolean;
	}

	/**
	 * A selection in the editor.
	 * The selection is a range that has an orientation.
	 */
	export interface ISelection {
		/**
		 * The line number on which the selection has started.
		 */
		readonly selectionStartLineNumber: number;
		/**
		 * The column on `selectionStartLineNumber` where the selection has started.
		 */
		readonly selectionStartColumn: number;
		/**
		 * The line number on which the selection has ended.
		 */
		readonly positionLineNumber: number;
		/**
		 * The column on `positionLineNumber` where the selection has ended.
		 */
		readonly positionColumn: number;
	}

	/**
	 * A selection in the editor.
	 * The selection is a range that has an orientation.
	 */
	export class Selection extends Range {
		/**
		 * The line number on which the selection has started.
		 */
		readonly selectionStartLineNumber: number;
		/**
		 * The column on `selectionStartLineNumber` where the selection has started.
		 */
		readonly selectionStartColumn: number;
		/**
		 * The line number on which the selection has ended.
		 */
		readonly positionLineNumber: number;
		/**
		 * The column on `positionLineNumber` where the selection has ended.
		 */
		readonly positionColumn: number;
		constructor(selectionStartLineNumber: number, selectionStartColumn: number, positionLineNumber: number, positionColumn: number);
		/**
		 * Transform to a human-readable representation.
		 */
		toString(): string;
		/**
		 * Test if equals other selection.
		 */
		equalsSelection(other: ISelection): boolean;
		/**
		 * Test if the two selections are equal.
		 */
		static selectionsEqual(a: ISelection, b: ISelection): boolean;
		/**
		 * Get directions (LTR or RTL).
		 */
		getDirection(): SelectionDirection;
		/**
		 * Create a new selection with a different `positionLineNumber` and `positionColumn`.
		 */
		setEndPosition(endLineNumber: number, endColumn: number): Selection;
772 773 774 775
		/**
		 * Get the position at `positionLineNumber` and `positionColumn`.
		 */
		getPosition(): Position;
776 777 778 779
		/**
		 * Create a new selection with a different `selectionStartLineNumber` and `selectionStartColumn`.
		 */
		setStartPosition(startLineNumber: number, startColumn: number): Selection;
780 781 782 783
		/**
		 * Create a `Selection` from one or two positions
		 */
		static fromPositions(start: IPosition, end?: IPosition): Selection;
784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
		/**
		 * Create a `Selection` from an `ISelection`.
		 */
		static liftSelection(sel: ISelection): Selection;
		/**
		 * `a` equals `b`.
		 */
		static selectionsArrEqual(a: ISelection[], b: ISelection[]): boolean;
		/**
		 * Test if `obj` is an `ISelection`.
		 */
		static isISelection(obj: any): obj is ISelection;
		/**
		 * Create with a direction.
		 */
		static createWithDirection(startLineNumber: number, startColumn: number, endLineNumber: number, endColumn: number, direction: SelectionDirection): Selection;
	}

	/**
	 * The direction of a selection.
	 */
	export enum SelectionDirection {
		/**
		 * The selection starts above where it ends.
		 */
		LTR = 0,
		/**
		 * The selection starts below where it ends.
		 */
R
Rob Lourens 已提交
813
		RTL = 1
814 815 816 817 818 819 820 821 822 823
	}

	export class Token {
		_tokenBrand: void;
		readonly offset: number;
		readonly type: string;
		readonly language: string;
		constructor(offset: number, type: string, language: string);
		toString(): string;
	}
A
Alex Dima 已提交
824
}
825

A
Alex Dima 已提交
826
declare namespace monaco.editor {
827

828 829 830 831 832 833
	export interface IDiffNavigator {
		canNavigate(): boolean;
		next(): void;
		previous(): void;
		dispose(): void;
	}
834

835 836 837 838 839
	/**
	 * Create a new editor under `domElement`.
	 * `domElement` should be empty (not contain other dom nodes).
	 * The editor will read the size of `domElement`.
	 */
840
	export function create(domElement: HTMLElement, options?: IStandaloneEditorConstructionOptions, override?: IEditorOverrideServices): IStandaloneCodeEditor;
841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867

	/**
	 * Emitted when an editor is created.
	 * Creating a diff editor might cause this listener to be invoked with the two editors.
	 * @event
	 */
	export function onDidCreateEditor(listener: (codeEditor: ICodeEditor) => void): IDisposable;

	/**
	 * Create a new diff editor under `domElement`.
	 * `domElement` should be empty (not contain other dom nodes).
	 * The editor will read the size of `domElement`.
	 */
	export function createDiffEditor(domElement: HTMLElement, options?: IDiffEditorConstructionOptions, override?: IEditorOverrideServices): IStandaloneDiffEditor;

	export interface IDiffNavigatorOptions {
		readonly followsCaret?: boolean;
		readonly ignoreCharChanges?: boolean;
		readonly alwaysRevealFirst?: boolean;
	}

	export function createDiffNavigator(diffEditor: IStandaloneDiffEditor, opts?: IDiffNavigatorOptions): IDiffNavigator;

	/**
	 * Create a new editor model.
	 * You can specify the language that should be set for this model or let the language be inferred from the `uri`.
	 */
868
	export function createModel(value: string, language?: string, uri?: Uri): ITextModel;
869 870 871 872

	/**
	 * Change the language for a model.
	 */
M
Martin Aeschlimann 已提交
873
	export function setModelLanguage(model: ITextModel, languageId: string): void;
874 875 876 877

	/**
	 * Set the markers for a model.
	 */
878
	export function setModelMarkers(model: ITextModel, owner: string, markers: IMarkerData[]): void;
879

R
Roman Safronov 已提交
880
	/**
R
rebornix 已提交
881
	 * Get markers for owner and/or resource
882 883
	 *
	 * @returns list of markers
R
Roman Safronov 已提交
884 885 886 887 888
	 */
	export function getModelMarkers(filter: {
		owner?: string;
		resource?: Uri;
		take?: number;
R
rsafronov 已提交
889
	}): IMarker[];
R
Roman Safronov 已提交
890

891 892 893
	/**
	 * Get the model that has `uri` if it exists.
	 */
A
Alex Dima 已提交
894
	export function getModel(uri: Uri): ITextModel | null;
895 896 897 898

	/**
	 * Get all the created models.
	 */
899
	export function getModels(): ITextModel[];
900 901 902 903 904

	/**
	 * Emitted when a model is created.
	 * @event
	 */
905
	export function onDidCreateModel(listener: (model: ITextModel) => void): IDisposable;
906 907 908 909 910

	/**
	 * Emitted right before a model is disposed.
	 * @event
	 */
911
	export function onWillDisposeModel(listener: (model: ITextModel) => void): IDisposable;
912 913 914 915 916 917

	/**
	 * Emitted when a different language is set to a model.
	 * @event
	 */
	export function onDidChangeModelLanguage(listener: (e: {
918
		readonly model: ITextModel;
919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
		readonly oldLanguage: string;
	}) => void): IDisposable;

	/**
	 * Create a new web worker that has model syncing capabilities built in.
	 * Specify an AMD module to load that will `create` an object that will be proxied.
	 */
	export function createWebWorker<T>(opts: IWebWorkerOptions): MonacoWebWorker<T>;

	/**
	 * Colorize the contents of `domNode` using attribute `data-lang`.
	 */
	export function colorizeElement(domNode: HTMLElement, options: IColorizerElementOptions): Promise<void>;

	/**
	 * Colorize `text` using language `languageId`.
	 */
	export function colorize(text: string, languageId: string, options: IColorizerOptions): Promise<string>;

	/**
	 * Colorize a line in a model.
	 */
941
	export function colorizeModelLine(model: ITextModel, lineNumber: number, tabSize?: number): string;
942 943 944 945 946 947 948

	/**
	 * Tokenize `text` using language `languageId`
	 */
	export function tokenize(text: string, languageId: string): Token[][];

	/**
A
Alex Dima 已提交
949
	 * Define a new theme or update an existing theme.
950 951 952
	 */
	export function defineTheme(themeName: string, themeData: IStandaloneThemeData): void;

953 954 955 956 957
	/**
	 * Switches to a theme.
	 */
	export function setTheme(themeName: string): void;

958 959 960 961 962
	/**
	 * Clears all cached font measurements and triggers re-measurement.
	 */
	export function remeasureFonts(): void;

963 964 965 966 967 968
	export type BuiltinTheme = 'vs' | 'vs-dark' | 'hc-black';

	export interface IStandaloneThemeData {
		base: BuiltinTheme;
		inherit: boolean;
		rules: ITokenThemeRule[];
M
Martin Aeschlimann 已提交
969
		encodedTokensColors?: string[];
970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
		colors: IColors;
	}

	export type IColors = {
		[colorId: string]: string;
	};

	export interface ITokenThemeRule {
		token: string;
		foreground?: string;
		background?: string;
		fontStyle?: string;
	}

	/**
	 * A web worker that can provide a proxy to an arbitrary file.
	 */
	export interface MonacoWebWorker<T> {
		/**
		 * Terminate the web worker, thus invalidating the returned proxy.
		 */
		dispose(): void;
		/**
		 * Get a proxy to the arbitrary loaded code.
		 */
		getProxy(): Promise<T>;
		/**
		 * Synchronize (send) the models at `resources` to the web worker,
		 * making them available in the monaco.worker.getMirrorModels().
		 */
		withSyncedResources(resources: Uri[]): Promise<T>;
	}

	export interface IWebWorkerOptions {
		/**
		 * The AMD moduleId to load.
		 * It should export a function `create` that should return the exported proxy.
		 */
		moduleId: string;
		/**
		 * The data to send over when calling create on the module.
		 */
		createData?: any;
		/**
		 * A label to be used to identify the web worker for debugging purposes.
		 */
		label?: string;
1017 1018 1019
		/**
		 * An object that can be used by the web worker to make calls back to the main thread.
		 */
1020
		host?: any;
1021 1022 1023 1024 1025
		/**
		 * Keep idle models.
		 * Defaults to false, which means that idle models will stop syncing after a while.
		 */
		keepIdleModels?: boolean;
1026 1027
	}

A
Alex Dima 已提交
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
	/**
	 * Description of an action contribution
	 */
	export interface IActionDescriptor {
		/**
		 * An unique identifier of the contributed action.
		 */
		id: string;
		/**
		 * A label of the action that will be presented to the user.
		 */
		label: string;
		/**
		 * Precondition rule.
		 */
		precondition?: string;
		/**
		 * An array of keybindings for the action.
		 */
		keybindings?: number[];
		/**
		 * The keybinding rule (condition on top of precondition).
		 */
		keybindingContext?: string;
		/**
		 * Control if the action should show up in the context menu and where.
		 * The context menu of the editor has these default:
		 *   navigation - The navigation group comes first in all cases.
		 *   1_modification - This group comes next and contains commands that modify your code.
		 *   9_cutcopypaste - The last default group with the basic editing commands.
		 * You can also create your own group.
		 * Defaults to null (don't show in context menu).
		 */
		contextMenuGroupId?: string;
		/**
		 * Control the order in the context menu group.
		 */
		contextMenuOrder?: number;
		/**
		 * Method that will be executed when the action is triggered.
A
Alex Dima 已提交
1068
		 * @param editor The editor instance is passed in as a convenience
A
Alex Dima 已提交
1069
		 */
1070
		run(editor: ICodeEditor, ...args: any[]): void | Promise<void>;
A
Alex Dima 已提交
1071 1072
	}

1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
	/**
	 * Options which apply for all editors.
	 */
	export interface IGlobalEditorOptions {
		/**
		 * The number of spaces a tab is equal to.
		 * This setting is overridden based on the file contents when `detectIndentation` is on.
		 * Defaults to 4.
		 */
		tabSize?: number;
		/**
		 * Insert spaces when pressing `Tab`.
A
Alex Dima 已提交
1085
		 * This setting is overridden based on the file contents when `detectIndentation` is on.
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
		 * Defaults to true.
		 */
		insertSpaces?: boolean;
		/**
		 * Controls whether `tabSize` and `insertSpaces` will be automatically detected when a file is opened based on the file contents.
		 * Defaults to true.
		 */
		detectIndentation?: boolean;
		/**
		 * Remove trailing auto inserted whitespace.
		 * Defaults to true.
		 */
		trimAutoWhitespace?: boolean;
		/**
		 * Special handling for large files to disable certain memory intensive features.
		 * Defaults to true.
		 */
		largeFileOptimizations?: boolean;
		/**
		 * Controls whether completions should be computed based on words in the document.
		 * Defaults to true.
		 */
		wordBasedSuggestions?: boolean;
1109 1110 1111 1112 1113
		/**
		 * Controls whether the semanticHighlighting is shown for the languages that support it.
		 * Defaults to true.
		 */
		'semanticHighlighting.enabled'?: boolean;
1114 1115 1116 1117 1118 1119 1120 1121 1122 1123
		/**
		 * Keep peek editors open even when double clicking their content or when hitting `Escape`.
		 * Defaults to false.
		 */
		stablePeek?: boolean;
		/**
		 * Lines above this length will not be tokenized for performance reasons.
		 * Defaults to 20000.
		 */
		maxTokenizationLineLength?: number;
1124 1125 1126 1127 1128 1129 1130
		/**
		 * Theme to be used for rendering.
		 * The current out-of-the-box available themes are: 'vs' (default), 'vs-dark', 'hc-black'.
		 * You can create custom themes via `monaco.editor.defineTheme`.
		 * To switch a theme, use `monaco.editor.setTheme`
		 */
		theme?: string;
A
Alex Dima 已提交
1131 1132
	}

1133 1134 1135
	/**
	 * The options to create an editor.
	 */
1136
	export interface IStandaloneEditorConstructionOptions extends IEditorConstructionOptions, IGlobalEditorOptions {
1137 1138 1139
		/**
		 * The initial model associated with this code editor.
		 */
A
Alex Dima 已提交
1140
		model?: ITextModel | null;
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
		/**
		 * The initial value of the auto created model in the editor.
		 * To not create automatically a model, use `model: null`.
		 */
		value?: string;
		/**
		 * The initial language of the auto created model in the editor.
		 * To not create automatically a model, use `model: null`.
		 */
		language?: string;
1151 1152 1153 1154 1155 1156 1157
		/**
		 * Initial theme to be used for rendering.
		 * The current out-of-the-box available themes are: 'vs' (default), 'vs-dark', 'hc-black'.
		 * You can create custom themes via `monaco.editor.defineTheme`.
		 * To switch a theme, use `monaco.editor.setTheme`
		 */
		theme?: string;
1158 1159 1160 1161 1162 1163 1164
		/**
		 * An URL to open when Ctrl+H (Windows and Linux) or Cmd+H (OSX) is pressed in
		 * the accessibility help dialog in the editor.
		 *
		 * Defaults to "https://go.microsoft.com/fwlink/?linkid=852450"
		 */
		accessibilityHelpUrl?: string;
1165 1166 1167 1168 1169 1170
	}

	/**
	 * The options to create a diff editor.
	 */
	export interface IDiffEditorConstructionOptions extends IDiffEditorOptions {
1171 1172 1173 1174 1175 1176 1177
		/**
		 * Initial theme to be used for rendering.
		 * The current out-of-the-box available themes are: 'vs' (default), 'vs-dark', 'hc-black'.
		 * You can create custom themes via `monaco.editor.defineTheme`.
		 * To switch a theme, use `monaco.editor.setTheme`
		 */
		theme?: string;
1178 1179 1180
	}

	export interface IStandaloneCodeEditor extends ICodeEditor {
1181
		updateOptions(newOptions: IEditorOptions & IGlobalEditorOptions): void;
1182
		addCommand(keybinding: number, handler: ICommandHandler, context?: string): string | null;
1183 1184 1185 1186 1187
		createContextKey<T>(key: string, defaultValue: T): IContextKey<T>;
		addAction(descriptor: IActionDescriptor): IDisposable;
	}

	export interface IStandaloneDiffEditor extends IDiffEditor {
1188
		addCommand(keybinding: number, handler: ICommandHandler, context?: string): string | null;
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
		createContextKey<T>(key: string, defaultValue: T): IContextKey<T>;
		addAction(descriptor: IActionDescriptor): IDisposable;
		getOriginalEditor(): IStandaloneCodeEditor;
		getModifiedEditor(): IStandaloneCodeEditor;
	}
	export interface ICommandHandler {
		(...args: any[]): void;
	}

	export interface IContextKey<T> {
		set(value: T): void;
		reset(): void;
A
Alex Dima 已提交
1201
		get(): T | undefined;
1202 1203 1204 1205 1206 1207
	}

	export interface IEditorOverrideServices {
		[index: string]: any;
	}

R
rsafronov 已提交
1208 1209 1210
	export interface IMarker {
		owner: string;
		resource: Uri;
1211
		severity: MarkerSeverity;
1212 1213
		code?: string | {
			value: string;
P
Pine Wu 已提交
1214
			target: Uri;
1215
		};
R
rsafronov 已提交
1216 1217 1218 1219 1220 1221
		message: string;
		source?: string;
		startLineNumber: number;
		startColumn: number;
		endLineNumber: number;
		endColumn: number;
1222
		relatedInformation?: IRelatedInformation[];
1223
		tags?: MarkerTag[];
R
rsafronov 已提交
1224 1225
	}

1226 1227 1228 1229
	/**
	 * A structure defining a problem/warning/etc.
	 */
	export interface IMarkerData {
1230 1231
		code?: string | {
			value: string;
P
Pine Wu 已提交
1232
			target: Uri;
1233
		};
1234
		severity: MarkerSeverity;
1235 1236 1237 1238 1239 1240
		message: string;
		source?: string;
		startLineNumber: number;
		startColumn: number;
		endLineNumber: number;
		endColumn: number;
1241
		relatedInformation?: IRelatedInformation[];
1242
		tags?: MarkerTag[];
1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
	}

	/**
	 *
	 */
	export interface IRelatedInformation {
		resource: Uri;
		message: string;
		startLineNumber: number;
		startColumn: number;
		endLineNumber: number;
		endColumn: number;
1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
	}

	export interface IColorizerOptions {
		tabSize?: number;
	}

	export interface IColorizerElementOptions extends IColorizerOptions {
		theme?: string;
		mimeType?: string;
	}

	export enum ScrollbarVisibility {
		Auto = 1,
		Hidden = 2,
R
Rob Lourens 已提交
1269
		Visible = 3
1270 1271
	}

1272 1273 1274 1275
	export interface ThemeColor {
		id: string;
	}

1276 1277 1278 1279 1280 1281 1282
	/**
	 * Vertical Lane in the overview ruler of the editor.
	 */
	export enum OverviewRulerLane {
		Left = 1,
		Center = 2,
		Right = 4,
R
Rob Lourens 已提交
1283
		Full = 7
1284 1285 1286
	}

	/**
1287
	 * Position in the minimap to render the decoration.
1288
	 */
1289
	export enum MinimapPosition {
1290 1291
		Inline = 1,
		Gutter = 2
1292 1293 1294
	}

	export interface IDecorationOptions {
1295
		/**
1296
		 * CSS color to render.
1297
		 * e.g.: rgba(100, 100, 100, 0.5) or a color from the color registry
1298
		 */
A
Alex Dima 已提交
1299
		color: string | ThemeColor | undefined;
1300
		/**
1301
		 * CSS color to render.
1302
		 * e.g.: rgba(100, 100, 100, 0.5) or a color from the color registry
1303
		 */
1304
		darkColor?: string | ThemeColor;
1305 1306 1307 1308 1309 1310
	}

	/**
	 * Options for rendering a model decoration in the overview ruler.
	 */
	export interface IModelDecorationOverviewRulerOptions extends IDecorationOptions {
1311 1312 1313 1314 1315 1316
		/**
		 * The position in the overview ruler.
		 */
		position: OverviewRulerLane;
	}

1317 1318 1319 1320 1321 1322 1323 1324 1325 1326
	/**
	 * Options for rendering a model decoration in the overview ruler.
	 */
	export interface IModelDecorationMinimapOptions extends IDecorationOptions {
		/**
		 * The position in the overview ruler.
		 */
		position: MinimapPosition;
	}

1327 1328 1329 1330 1331
	/**
	 * Options for a model decoration.
	 */
	export interface IModelDecorationOptions {
		/**
A
Alex Dima 已提交
1332
		 * Customize the growing behavior of the decoration when typing at the edges of the decoration.
1333 1334 1335 1336 1337 1338
		 * Defaults to TrackedRangeStickiness.AlwaysGrowsWhenTypingAtEdges
		 */
		stickiness?: TrackedRangeStickiness;
		/**
		 * CSS class name describing the decoration.
		 */
A
Alex Dima 已提交
1339
		className?: string | null;
1340 1341 1342
		/**
		 * Message to be rendered when hovering over the glyph margin decoration.
		 */
A
Alex Dima 已提交
1343
		glyphMarginHoverMessage?: IMarkdownString | IMarkdownString[] | null;
1344
		/**
1345
		 * Array of MarkdownString to render as the decoration message.
1346
		 */
A
Alex Dima 已提交
1347
		hoverMessage?: IMarkdownString | IMarkdownString[] | null;
1348 1349 1350 1351
		/**
		 * Should the decoration expand to encompass a whole line.
		 */
		isWholeLine?: boolean;
1352 1353 1354 1355 1356
		/**
		 * Specifies the stack order of a decoration.
		 * A decoration with greater stack order is always in front of a decoration with a lower stack order.
		 */
		zIndex?: number;
1357 1358 1359
		/**
		 * If set, render this decoration in the overview ruler.
		 */
A
Alex Dima 已提交
1360
		overviewRuler?: IModelDecorationOverviewRulerOptions | null;
1361 1362 1363 1364
		/**
		 * If set, render this decoration in the minimap.
		 */
		minimap?: IModelDecorationMinimapOptions | null;
1365 1366 1367
		/**
		 * If set, the decoration will be rendered in the glyph margin with this CSS class name.
		 */
A
Alex Dima 已提交
1368
		glyphMarginClassName?: string | null;
1369 1370 1371
		/**
		 * If set, the decoration will be rendered in the lines decorations with this CSS class name.
		 */
A
Alex Dima 已提交
1372
		linesDecorationsClassName?: string | null;
1373 1374 1375
		/**
		 * If set, the decoration will be rendered in the margin (covering its full width) with this CSS class name.
		 */
A
Alex Dima 已提交
1376
		marginClassName?: string | null;
1377 1378 1379 1380 1381
		/**
		 * If set, the decoration will be rendered inline with the text with this CSS class name.
		 * Please use this only for CSS rules that must impact the text. For example, use `className`
		 * to have a background color decoration.
		 */
A
Alex Dima 已提交
1382
		inlineClassName?: string | null;
A
Alex Dima 已提交
1383 1384 1385 1386
		/**
		 * If there is an `inlineClassName` which affects letter spacing.
		 */
		inlineClassNameAffectsLetterSpacing?: boolean;
1387 1388 1389
		/**
		 * If set, the decoration will be rendered before the text with this CSS class name.
		 */
A
Alex Dima 已提交
1390
		beforeContentClassName?: string | null;
1391 1392 1393
		/**
		 * If set, the decoration will be rendered after the text with this CSS class name.
		 */
A
Alex Dima 已提交
1394
		afterContentClassName?: string | null;
1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419
	}

	/**
	 * New model decorations.
	 */
	export interface IModelDeltaDecoration {
		/**
		 * Range that this decoration covers.
		 */
		range: IRange;
		/**
		 * Options associated with this decoration.
		 */
		options: IModelDecorationOptions;
	}

	/**
	 * A decoration in the model.
	 */
	export interface IModelDecoration {
		/**
		 * Identifier for a decoration.
		 */
		readonly id: string;
		/**
A
Alex Dima 已提交
1420
		 * Identifier for a decoration's owner.
1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465
		 */
		readonly ownerId: number;
		/**
		 * Range that this decoration covers.
		 */
		readonly range: Range;
		/**
		 * Options associated with this decoration.
		 */
		readonly options: IModelDecorationOptions;
	}

	/**
	 * Word inside a model.
	 */
	export interface IWordAtPosition {
		/**
		 * The word.
		 */
		readonly word: string;
		/**
		 * The column where the word starts.
		 */
		readonly startColumn: number;
		/**
		 * The column where the word ends.
		 */
		readonly endColumn: number;
	}

	/**
	 * End of line character preference.
	 */
	export enum EndOfLinePreference {
		/**
		 * Use the end of line character identified in the text buffer.
		 */
		TextDefined = 0,
		/**
		 * Use line feed (\n) as the end of line character.
		 */
		LF = 1,
		/**
		 * Use carriage return and line feed (\r\n) as the end of line character.
		 */
R
Rob Lourens 已提交
1466
		CRLF = 2
1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479
	}

	/**
	 * The default end of line to use when instantiating models.
	 */
	export enum DefaultEndOfLine {
		/**
		 * Use line feed (\n) as the end of line character.
		 */
		LF = 1,
		/**
		 * Use carriage return and line feed (\r\n) as the end of line character.
		 */
R
Rob Lourens 已提交
1480
		CRLF = 2
1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
	}

	/**
	 * End of line character preference.
	 */
	export enum EndOfLineSequence {
		/**
		 * Use line feed (\n) as the end of line character.
		 */
		LF = 0,
		/**
		 * Use carriage return and line feed (\r\n) as the end of line character.
		 */
R
Rob Lourens 已提交
1494
		CRLF = 1
1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508
	}

	/**
	 * A single edit operation, that acts as a simple replace.
	 * i.e. Replace text at `range` with `text` in model.
	 */
	export interface ISingleEditOperation {
		/**
		 * The range to replace. This can be empty to emulate a simple insert.
		 */
		range: IRange;
		/**
		 * The text to replace with. This can be null to emulate a simple delete.
		 */
M
Matt Bierner 已提交
1509
		text: string | null;
1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523
		/**
		 * This indicates that this operation has "insert" semantics.
		 * i.e. forceMoveMarkers = true => if `range` is collapsed, all markers at the position will be moved.
		 */
		forceMoveMarkers?: boolean;
	}

	/**
	 * A single edit operation, that has an identifier.
	 */
	export interface IIdentifiedSingleEditOperation {
		/**
		 * The range to replace. This can be empty to emulate a simple insert.
		 */
1524
		range: IRange;
1525 1526 1527
		/**
		 * The text to replace with. This can be null to emulate a simple delete.
		 */
A
Alex Dima 已提交
1528
		text: string | null;
1529 1530 1531 1532
		/**
		 * This indicates that this operation has "insert" semantics.
		 * i.e. forceMoveMarkers = true => if `range` is collapsed, all markers at the position will be moved.
		 */
1533
		forceMoveMarkers?: boolean;
1534 1535
	}

1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551
	export interface IValidEditOperation {
		/**
		 * The range to replace. This can be empty to emulate a simple insert.
		 */
		range: Range;
		/**
		 * The text to replace with. This can be null to emulate a simple delete.
		 */
		text: string | null;
		/**
		 * This indicates that this operation has "insert" semantics.
		 * i.e. forceMoveMarkers = true => if `range` is collapsed, all markers at the position will be moved.
		 */
		forceMoveMarkers: boolean;
	}

1552 1553 1554 1555 1556 1557 1558
	/**
	 * A callback that can compute the cursor state after applying a series of edit operations.
	 */
	export interface ICursorStateComputer {
		/**
		 * A callback that can compute the resulting cursors state after some edit operations have been executed.
		 */
1559
		(inverseEditOperations: IValidEditOperation[]): Selection[] | null;
1560 1561 1562 1563 1564
	}

	export class TextModelResolvedOptions {
		_textModelResolvedOptionsBrand: void;
		readonly tabSize: number;
D
David Lechner 已提交
1565
		readonly indentSize: number;
1566 1567 1568 1569 1570 1571 1572
		readonly insertSpaces: boolean;
		readonly defaultEOL: DefaultEndOfLine;
		readonly trimAutoWhitespace: boolean;
	}

	export interface ITextModelUpdateOptions {
		tabSize?: number;
D
David Lechner 已提交
1573
		indentSize?: number;
1574 1575 1576 1577
		insertSpaces?: boolean;
		trimAutoWhitespace?: boolean;
	}

1578 1579 1580
	export class FindMatch {
		_findMatchBrand: void;
		readonly range: Range;
A
Alex Dima 已提交
1581
		readonly matches: string[] | null;
1582
	}
1583

1584
	/**
1585 1586 1587 1588 1589 1590 1591
	 * Describes the behavior of decorations when typing/editing near their edges.
	 * Note: Please do not edit the values, as they very carefully match `DecorationRangeBehavior`
	 */
	export enum TrackedRangeStickiness {
		AlwaysGrowsWhenTypingAtEdges = 0,
		NeverGrowsWhenTypingAtEdges = 1,
		GrowsOnlyWhenTypingBefore = 2,
R
Rob Lourens 已提交
1592
		GrowsOnlyWhenTypingAfter = 3
1593
	}
1594

1595 1596
	/**
	 * A model.
1597 1598 1599
	 */
	export interface ITextModel {
		/**
1600
		 * Gets the resource associated with this editor model.
1601
		 */
1602
		readonly uri: Uri;
1603
		/**
1604
		 * A unique identifier associated with this model.
1605
		 */
1606
		readonly id: string;
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 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650
		/**
		 * Get the resolved options for this model.
		 */
		getOptions(): TextModelResolvedOptions;
		/**
		 * Get the current version id of the model.
		 * Anytime a change happens to the model (even undo/redo),
		 * the version id is incremented.
		 */
		getVersionId(): number;
		/**
		 * Get the alternative version id of the model.
		 * This alternative version id is not always incremented,
		 * it will return the same values in the case of undo-redo.
		 */
		getAlternativeVersionId(): number;
		/**
		 * Replace the entire text buffer value contained in this model.
		 */
		setValue(newValue: string): void;
		/**
		 * Get the text stored in this model.
		 * @param eol The end of line character preference. Defaults to `EndOfLinePreference.TextDefined`.
		 * @param preserverBOM Preserve a BOM character if it was detected when the model was constructed.
		 * @return The text.
		 */
		getValue(eol?: EndOfLinePreference, preserveBOM?: boolean): string;
		/**
		 * Get the length of the text stored in this model.
		 */
		getValueLength(eol?: EndOfLinePreference, preserveBOM?: boolean): number;
		/**
		 * Get the text in a certain range.
		 * @param range The range describing what text to get.
		 * @param eol The end of line character preference. This will only be used for multiline ranges. Defaults to `EndOfLinePreference.TextDefined`.
		 * @return The text.
		 */
		getValueInRange(range: IRange, eol?: EndOfLinePreference): string;
		/**
		 * Get the length of text in a certain range.
		 * @param range The range describing what text length to get.
		 * @return The text length.
		 */
		getValueLengthInRange(range: IRange): number;
1651 1652 1653 1654 1655
		/**
		 * Get the character count of text in a certain range.
		 * @param range The range describing what text length to get.
		 */
		getCharacterCountInRange(range: IRange): number;
1656 1657 1658 1659 1660 1661 1662 1663
		/**
		 * Get the number of lines in the model.
		 */
		getLineCount(): number;
		/**
		 * Get the text for a certain line.
		 */
		getLineContent(lineNumber: number): string;
A
Alex Dima 已提交
1664 1665 1666 1667
		/**
		 * Get the text length for a certain line.
		 */
		getLineLength(lineNumber: number): number;
1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699
		/**
		 * Get the text for all lines.
		 */
		getLinesContent(): string[];
		/**
		 * Get the end of line sequence predominantly used in the text buffer.
		 * @return EOL char sequence (e.g.: '\n' or '\r\n').
		 */
		getEOL(): string;
		/**
		 * Get the minimum legal column for line at `lineNumber`
		 */
		getLineMinColumn(lineNumber: number): number;
		/**
		 * Get the maximum legal column for line at `lineNumber`
		 */
		getLineMaxColumn(lineNumber: number): number;
		/**
		 * Returns the column before the first non whitespace character for line at `lineNumber`.
		 * Returns 0 if line is empty or contains only whitespace.
		 */
		getLineFirstNonWhitespaceColumn(lineNumber: number): number;
		/**
		 * Returns the column after the last non whitespace character for line at `lineNumber`.
		 * Returns 0 if line is empty or contains only whitespace.
		 */
		getLineLastNonWhitespaceColumn(lineNumber: number): number;
		/**
		 * Create a valid position,
		 */
		validatePosition(position: IPosition): Position;
		/**
A
Alex Dima 已提交
1700
		 * Advances the given position by the given offset (negative offsets are also accepted)
1701 1702 1703 1704 1705
		 * and returns it as a new valid position.
		 *
		 * If the offset and position are such that their combination goes beyond the beginning or
		 * end of the model, throws an exception.
		 *
A
Alex Dima 已提交
1706
		 * If the offset is such that the new position would be in the middle of a multi-byte
1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734
		 * line terminator, throws an exception.
		 */
		modifyPosition(position: IPosition, offset: number): Position;
		/**
		 * Create a valid range.
		 */
		validateRange(range: IRange): Range;
		/**
		 * Converts the position to a zero-based offset.
		 *
		 * The position will be [adjusted](#TextDocument.validatePosition).
		 *
		 * @param position A position.
		 * @return A valid zero-based offset.
		 */
		getOffsetAt(position: IPosition): number;
		/**
		 * Converts a zero-based offset to a position.
		 *
		 * @param offset A zero-based offset.
		 * @return A valid [position](#Position).
		 */
		getPositionAt(offset: number): Position;
		/**
		 * Get a range covering the entire model
		 */
		getFullModelRange(): Range;
		/**
1735
		 * Returns if the model was disposed or not.
1736 1737 1738 1739 1740 1741 1742 1743
		 */
		isDisposed(): boolean;
		/**
		 * Search the model.
		 * @param searchString The string used to search. If it is a regular expression, set `isRegex` to true.
		 * @param searchOnlyEditableRange Limit the searching to only search inside the editable range of the model.
		 * @param isRegex Used to indicate that `searchString` is a regular expression.
		 * @param matchCase Force the matching to match lower/upper case exactly.
1744
		 * @param wordSeparators Force the matching to match entire words only. Pass null otherwise.
1745 1746 1747 1748
		 * @param captureMatches The result will contain the captured groups.
		 * @param limitResultCount Limit the number of results
		 * @return The ranges where the matches are. It is empty if not matches have been found.
		 */
1749
		findMatches(searchString: string, searchOnlyEditableRange: boolean, isRegex: boolean, matchCase: boolean, wordSeparators: string | null, captureMatches: boolean, limitResultCount?: number): FindMatch[];
1750 1751 1752 1753 1754 1755
		/**
		 * Search the model.
		 * @param searchString The string used to search. If it is a regular expression, set `isRegex` to true.
		 * @param searchScope Limit the searching to only search inside this range.
		 * @param isRegex Used to indicate that `searchString` is a regular expression.
		 * @param matchCase Force the matching to match lower/upper case exactly.
1756
		 * @param wordSeparators Force the matching to match entire words only. Pass null otherwise.
1757 1758 1759 1760
		 * @param captureMatches The result will contain the captured groups.
		 * @param limitResultCount Limit the number of results
		 * @return The ranges where the matches are. It is empty if no matches have been found.
		 */
1761
		findMatches(searchString: string, searchScope: IRange, isRegex: boolean, matchCase: boolean, wordSeparators: string | null, captureMatches: boolean, limitResultCount?: number): FindMatch[];
1762 1763 1764 1765 1766 1767
		/**
		 * Search the model for the next match. Loops to the beginning of the model if needed.
		 * @param searchString The string used to search. If it is a regular expression, set `isRegex` to true.
		 * @param searchStart Start the searching at the specified position.
		 * @param isRegex Used to indicate that `searchString` is a regular expression.
		 * @param matchCase Force the matching to match lower/upper case exactly.
1768
		 * @param wordSeparators Force the matching to match entire words only. Pass null otherwise.
1769 1770 1771
		 * @param captureMatches The result will contain the captured groups.
		 * @return The range where the next match is. It is null if no next match has been found.
		 */
A
Alex Dima 已提交
1772
		findNextMatch(searchString: string, searchStart: IPosition, isRegex: boolean, matchCase: boolean, wordSeparators: string | null, captureMatches: boolean): FindMatch | null;
1773 1774 1775 1776 1777 1778
		/**
		 * Search the model for the previous match. Loops to the end of the model if needed.
		 * @param searchString The string used to search. If it is a regular expression, set `isRegex` to true.
		 * @param searchStart Start the searching at the specified position.
		 * @param isRegex Used to indicate that `searchString` is a regular expression.
		 * @param matchCase Force the matching to match lower/upper case exactly.
1779
		 * @param wordSeparators Force the matching to match entire words only. Pass null otherwise.
1780 1781 1782
		 * @param captureMatches The result will contain the captured groups.
		 * @return The range where the previous match is. It is null if no previous match has been found.
		 */
A
Alex Dima 已提交
1783
		findPreviousMatch(searchString: string, searchStart: IPosition, isRegex: boolean, matchCase: boolean, wordSeparators: string | null, captureMatches: boolean): FindMatch | null;
1784 1785 1786 1787 1788 1789 1790 1791 1792
		/**
		 * Get the language associated with this model.
		 */
		getModeId(): string;
		/**
		 * Get the word under or besides `position`.
		 * @param position The position to look for a word.
		 * @return The word under or besides `position`. Might be null.
		 */
A
Alex Dima 已提交
1793
		getWordAtPosition(position: IPosition): IWordAtPosition | null;
1794 1795 1796 1797 1798 1799 1800
		/**
		 * Get the word under or besides `position` trimmed to `position`.column
		 * @param position The position to look for a word.
		 * @return The word under or besides `position`. Will never be null.
		 */
		getWordUntilPosition(position: IPosition): IWordAtPosition;
		/**
A
Alex Dima 已提交
1801
		 * Perform a minimum amount of operations, in order to transform the decorations
1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815
		 * identified by `oldDecorations` to the decorations described by `newDecorations`
		 * and returns the new identifiers associated with the resulting decorations.
		 *
		 * @param oldDecorations Array containing previous decorations identifiers.
		 * @param newDecorations Array describing what decorations should result after the call.
		 * @param ownerId Identifies the editor id in which these decorations should appear. If no `ownerId` is provided, the decorations will appear in all editors that attach this model.
		 * @return An array containing the new decorations identifiers.
		 */
		deltaDecorations(oldDecorations: string[], newDecorations: IModelDeltaDecoration[], ownerId?: number): string[];
		/**
		 * Get the options associated with a decoration.
		 * @param id The decoration id.
		 * @return The decoration options or null if the decoration was not found.
		 */
A
Alex Dima 已提交
1816
		getDecorationOptions(id: string): IModelDecorationOptions | null;
1817 1818 1819 1820 1821
		/**
		 * Get the range associated with a decoration.
		 * @param id The decoration id.
		 * @return The decoration range or null if the decoration was not found.
		 */
A
Alex Dima 已提交
1822
		getDecorationRange(id: string): Range | null;
1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840
		/**
		 * Gets all the decorations for the line `lineNumber` as an array.
		 * @param lineNumber The line number
		 * @param ownerId If set, it will ignore decorations belonging to other owners.
		 * @param filterOutValidation If set, it will ignore decorations specific to validation (i.e. warnings, errors).
		 * @return An array with the decorations
		 */
		getLineDecorations(lineNumber: number, ownerId?: number, filterOutValidation?: boolean): IModelDecoration[];
		/**
		 * Gets all the decorations for the lines between `startLineNumber` and `endLineNumber` as an array.
		 * @param startLineNumber The start line number
		 * @param endLineNumber The end line number
		 * @param ownerId If set, it will ignore decorations belonging to other owners.
		 * @param filterOutValidation If set, it will ignore decorations specific to validation (i.e. warnings, errors).
		 * @return An array with the decorations
		 */
		getLinesDecorations(startLineNumber: number, endLineNumber: number, ownerId?: number, filterOutValidation?: boolean): IModelDecoration[];
		/**
A
Alex Dima 已提交
1841
		 * Gets all the decorations in a range as an array. Only `startLineNumber` and `endLineNumber` from `range` are used for filtering.
1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854
		 * So for now it returns all the decorations on the same line as `range`.
		 * @param range The range to search in
		 * @param ownerId If set, it will ignore decorations belonging to other owners.
		 * @param filterOutValidation If set, it will ignore decorations specific to validation (i.e. warnings, errors).
		 * @return An array with the decorations
		 */
		getDecorationsInRange(range: IRange, ownerId?: number, filterOutValidation?: boolean): IModelDecoration[];
		/**
		 * Gets all the decorations as an array.
		 * @param ownerId If set, it will ignore decorations belonging to other owners.
		 * @param filterOutValidation If set, it will ignore decorations specific to validation (i.e. warnings, errors).
		 */
		getAllDecorations(ownerId?: number, filterOutValidation?: boolean): IModelDecoration[];
1855 1856 1857 1858 1859 1860
		/**
		 * Gets all the decorations that should be rendered in the overview ruler as an array.
		 * @param ownerId If set, it will ignore decorations belonging to other owners.
		 * @param filterOutValidation If set, it will ignore decorations specific to validation (i.e. warnings, errors).
		 */
		getOverviewRulerDecorations(ownerId?: number, filterOutValidation?: boolean): IModelDecoration[];
1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881
		/**
		 * Normalize a string containing whitespace according to indentation rules (converts to spaces or to tabs).
		 */
		normalizeIndentation(str: string): string;
		/**
		 * Change the options of this model.
		 */
		updateOptions(newOpts: ITextModelUpdateOptions): void;
		/**
		 * Detect the indentation options for this model from its content.
		 */
		detectIndentation(defaultInsertSpaces: boolean, defaultTabSize: number): void;
		/**
		 * Push a stack element onto the undo stack. This acts as an undo/redo point.
		 * The idea is to use `pushEditOperations` to edit the model and then to
		 * `pushStackElement` to create an undo/redo stop point.
		 */
		pushStackElement(): void;
		/**
		 * Push edit operations, basically editing the model. This is the preferred way
		 * of editing the model. The edit operations will land on the undo stack.
A
Alex Dima 已提交
1882
		 * @param beforeCursorState The cursor state before the edit operations. This cursor state will be returned when `undo` or `redo` are invoked.
1883 1884 1885 1886
		 * @param editOperations The edit operations.
		 * @param cursorStateComputer A callback that can compute the resulting cursors state after the edit operations have been executed.
		 * @return The cursor state returned by the `cursorStateComputer`.
		 */
A
Alex Dima 已提交
1887
		pushEditOperations(beforeCursorState: Selection[] | null, editOperations: IIdentifiedSingleEditOperation[], cursorStateComputer: ICursorStateComputer): Selection[] | null;
A
Alex Dima 已提交
1888 1889 1890 1891 1892
		/**
		 * Change the end of line sequence. This is the preferred way of
		 * changing the eol sequence. This will land on the undo stack.
		 */
		pushEOL(eol: EndOfLineSequence): void;
1893 1894 1895 1896 1897 1898
		/**
		 * Edit the model without adding the edits to the undo stack.
		 * This can have dire consequences on the undo stack! See @pushEditOperations for the preferred way.
		 * @param operations The edit operations.
		 * @return The inverse edit operations, that, when applied, will bring the model back to the previous state.
		 */
1899
		applyEdits(operations: IIdentifiedSingleEditOperation[]): IValidEditOperation[];
A
Alex Dima 已提交
1900 1901 1902 1903 1904
		/**
		 * Change the end of line sequence without recording in the undo stack.
		 * This can have dire consequences on the undo stack! See @pushEOL for the preferred way.
		 */
		setEOL(eol: EndOfLineSequence): void;
1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924
		/**
		 * An event emitted when the contents of the model have changed.
		 * @event
		 */
		onDidChangeContent(listener: (e: IModelContentChangedEvent) => void): IDisposable;
		/**
		 * An event emitted when decorations of the model have changed.
		 * @event
		 */
		onDidChangeDecorations(listener: (e: IModelDecorationsChangedEvent) => void): IDisposable;
		/**
		 * An event emitted when the model options have changed.
		 * @event
		 */
		onDidChangeOptions(listener: (e: IModelOptionsChangedEvent) => void): IDisposable;
		/**
		 * An event emitted when the language associated with the model has changed.
		 * @event
		 */
		onDidChangeLanguage(listener: (e: IModelLanguageChangedEvent) => void): IDisposable;
1925 1926 1927 1928 1929
		/**
		 * An event emitted when the language configuration associated with the model has changed.
		 * @event
		 */
		onDidChangeLanguageConfiguration(listener: (e: IModelLanguageConfigurationChangedEvent) => void): IDisposable;
1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941
		/**
		 * An event emitted right before disposing the model.
		 * @event
		 */
		onWillDispose(listener: () => void): IDisposable;
		/**
		 * Destroy this model. This will unbind the model from the mode
		 * and make all necessary clean-up to release this object to the GC.
		 */
		dispose(): void;
	}

1942 1943 1944 1945 1946 1947 1948 1949 1950
	/**
	 * A builder and helper for edit operations for a command.
	 */
	export interface IEditOperationBuilder {
		/**
		 * Add a new edit operation (a replace operation).
		 * @param range The range to replace (delete). May be empty to represent a simple insert.
		 * @param text The text to replace with. May be null to represent a simple delete.
		 */
1951
		addEditOperation(range: IRange, text: string | null, forceMoveMarkers?: boolean): void;
1952 1953 1954 1955 1956 1957
		/**
		 * Add a new edit operation (a replace operation).
		 * The inverse edits will be accessible in `ICursorStateComputerData.getInverseEditOperations()`
		 * @param range The range to replace (delete). May be empty to represent a simple insert.
		 * @param text The text to replace with. May be null to represent a simple delete.
		 */
1958
		addTrackedEditOperation(range: IRange, text: string | null, forceMoveMarkers?: boolean): void;
1959 1960 1961 1962 1963 1964 1965
		/**
		 * Track `selection` when applying edit operations.
		 * A best effort will be made to not grow/expand the selection.
		 * An empty selection will clamp to a nearby character.
		 * @param selection The selection to track.
		 * @param trackPreviousOnEmpty If set, and the selection is empty, indicates whether the selection
		 *           should clamp to the previous or the next character.
A
Alex Dima 已提交
1966
		 * @return A unique identifier.
1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977
		 */
		trackSelection(selection: Selection, trackPreviousOnEmpty?: boolean): string;
	}

	/**
	 * A helper for computing cursor state after a command.
	 */
	export interface ICursorStateComputerData {
		/**
		 * Get the inverse edit operations of the added edit operations.
		 */
1978
		getInverseEditOperations(): IValidEditOperation[];
1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998
		/**
		 * Get a previously tracked selection.
		 * @param id The unique identifier returned by `trackSelection`.
		 * @return The selection.
		 */
		getTrackedSelection(id: string): Selection;
	}

	/**
	 * A command that modifies text / cursor state on a model.
	 */
	export interface ICommand {
		/**
		 * Get the edit operations needed to execute this command.
		 * @param model The model the command will execute on.
		 * @param builder A helper to collect the needed edit operations and to track selections.
		 */
		getEditOperations(model: ITextModel, builder: IEditOperationBuilder): void;
		/**
		 * Compute the cursor state after the edit operations were applied.
A
Alex Dima 已提交
1999
		 * @param model The model the command has executed on.
2000 2001 2002 2003 2004 2005
		 * @param helper A helper to get inverse edit operations and to get previously tracked selections.
		 * @return The cursor state after the command executed.
		 */
		computeCursorState(model: ITextModel, helper: ICursorStateComputerData): Selection;
	}

2006 2007 2008 2009 2010 2011 2012
	/**
	 * A model for the diff editor.
	 */
	export interface IDiffEditorModel {
		/**
		 * Original model.
		 */
2013
		original: ITextModel;
2014 2015 2016
		/**
		 * Modified model.
		 */
2017
		modified: ITextModel;
2018 2019 2020 2021 2022 2023 2024 2025 2026
	}

	/**
	 * An event describing that an editor has had its model reset (i.e. `editor.setModel()`).
	 */
	export interface IModelChangedEvent {
		/**
		 * The `uri` of the previous model or null.
		 */
A
Alex Dima 已提交
2027
		readonly oldModelUrl: Uri | null;
2028 2029 2030
		/**
		 * The `uri` of the new model or null.
		 */
A
Alex Dima 已提交
2031
		readonly newModelUrl: Uri | null;
2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062
	}

	export interface IDimension {
		width: number;
		height: number;
	}

	/**
	 * A change
	 */
	export interface IChange {
		readonly originalStartLineNumber: number;
		readonly originalEndLineNumber: number;
		readonly modifiedStartLineNumber: number;
		readonly modifiedEndLineNumber: number;
	}

	/**
	 * A character level change.
	 */
	export interface ICharChange extends IChange {
		readonly originalStartColumn: number;
		readonly originalEndColumn: number;
		readonly modifiedStartColumn: number;
		readonly modifiedEndColumn: number;
	}

	/**
	 * A line change
	 */
	export interface ILineChange extends IChange {
A
Alex Dima 已提交
2063
		readonly charChanges: ICharChange[] | undefined;
2064 2065
	}

2066 2067 2068 2069 2070 2071 2072
	export interface IContentSizeChangedEvent {
		readonly contentWidth: number;
		readonly contentHeight: number;
		readonly contentWidthChanged: boolean;
		readonly contentHeightChanged: boolean;
	}

2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085
	export interface INewScrollPosition {
		scrollLeft?: number;
		scrollTop?: number;
	}

	export interface IEditorAction {
		readonly id: string;
		readonly label: string;
		readonly alias: string;
		isSupported(): boolean;
		run(): Promise<void>;
	}

2086
	export type IEditorModel = ITextModel | IDiffEditorModel;
2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100

	/**
	 * A (serializable) state of the cursors.
	 */
	export interface ICursorState {
		inSelectionMode: boolean;
		selectionStart: IPosition;
		position: IPosition;
	}

	/**
	 * A (serializable) state of the view.
	 */
	export interface IViewState {
2101 2102 2103 2104
		/** written by previous versions */
		scrollTop?: number;
		/** written by previous versions */
		scrollTopWithoutViewZones?: number;
2105
		scrollLeft: number;
2106 2107
		firstPosition: IPosition;
		firstPositionDeltaTop: number;
2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124
	}

	/**
	 * A (serializable) state of the code editor.
	 */
	export interface ICodeEditorViewState {
		cursorState: ICursorState[];
		viewState: IViewState;
		contributionsState: {
			[id: string]: any;
		};
	}

	/**
	 * (Serializable) View state for the diff editor.
	 */
	export interface IDiffEditorViewState {
J
Johannes Rieken 已提交
2125 2126
		original: ICodeEditorViewState | null;
		modified: ICodeEditorViewState | null;
2127 2128 2129 2130 2131 2132 2133
	}

	/**
	 * An editor view state.
	 */
	export type IEditorViewState = ICodeEditorViewState | IDiffEditorViewState;

2134
	export enum ScrollType {
2135
		Smooth = 0,
R
Rob Lourens 已提交
2136
		Immediate = 1
2137 2138
	}

2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167
	/**
	 * An editor.
	 */
	export interface IEditor {
		/**
		 * An event emitted when the editor has been disposed.
		 * @event
		 */
		onDidDispose(listener: () => void): IDisposable;
		/**
		 * Dispose the editor.
		 */
		dispose(): void;
		/**
		 * Get a unique id for this editor instance.
		 */
		getId(): string;
		/**
		 * Get the editor type. Please see `EditorType`.
		 * This is to avoid an instanceof check
		 */
		getEditorType(): string;
		/**
		 * Update the editor's options after the editor has been created.
		 */
		updateOptions(newOptions: IEditorOptions): void;
		/**
		 * Instructs the editor to remeasure its container. This method should
		 * be called when the container of the editor gets resized.
2168 2169
		 *
		 * If a dimension is passed in, the passed in value will be used.
2170 2171 2172 2173 2174 2175 2176
		 */
		layout(dimension?: IDimension): void;
		/**
		 * Brings browser focus to the editor text
		 */
		focus(): void;
		/**
A
Alex Dima 已提交
2177
		 * Returns true if the text inside this editor is focused (i.e. cursor is blinking).
2178
		 */
A
Alex Dima 已提交
2179
		hasTextFocus(): boolean;
2180 2181 2182 2183 2184 2185 2186
		/**
		 * Returns all actions associated with this editor.
		 */
		getSupportedActions(): IEditorAction[];
		/**
		 * Saves current view state of the editor in a serializable object.
		 */
A
Alex Dima 已提交
2187
		saveViewState(): IEditorViewState | null;
2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198
		/**
		 * Restores the view state of the editor from a serializable object generated by `saveViewState`.
		 */
		restoreViewState(state: IEditorViewState): void;
		/**
		 * Given a position, returns a column number that takes tab-widths into account.
		 */
		getVisibleColumnFromPosition(position: IPosition): number;
		/**
		 * Returns the primary position of the cursor.
		 */
A
Alex Dima 已提交
2199
		getPosition(): Position | null;
2200 2201 2202 2203 2204 2205 2206 2207
		/**
		 * Set the primary position of the cursor. This will remove any secondary cursors.
		 * @param position New primary cursor's position
		 */
		setPosition(position: IPosition): void;
		/**
		 * Scroll vertically as necessary and reveal a line.
		 */
2208
		revealLine(lineNumber: number, scrollType?: ScrollType): void;
2209 2210 2211
		/**
		 * Scroll vertically as necessary and reveal a line centered vertically.
		 */
2212
		revealLineInCenter(lineNumber: number, scrollType?: ScrollType): void;
2213 2214 2215
		/**
		 * Scroll vertically as necessary and reveal a line centered vertically only if it lies outside the viewport.
		 */
2216
		revealLineInCenterIfOutsideViewport(lineNumber: number, scrollType?: ScrollType): void;
2217 2218 2219 2220
		/**
		 * Scroll vertically as necessary and reveal a line close to the top of the viewport,
		 * optimized for viewing a code definition.
		 */
2221
		revealLineNearTop(lineNumber: number, scrollType?: ScrollType): void;
2222 2223 2224
		/**
		 * Scroll vertically or horizontally as necessary and reveal a position.
		 */
2225
		revealPosition(position: IPosition, scrollType?: ScrollType): void;
2226 2227 2228
		/**
		 * Scroll vertically or horizontally as necessary and reveal a position centered vertically.
		 */
2229
		revealPositionInCenter(position: IPosition, scrollType?: ScrollType): void;
2230 2231 2232
		/**
		 * Scroll vertically or horizontally as necessary and reveal a position centered vertically only if it lies outside the viewport.
		 */
2233
		revealPositionInCenterIfOutsideViewport(position: IPosition, scrollType?: ScrollType): void;
2234 2235 2236 2237
		/**
		 * Scroll vertically or horizontally as necessary and reveal a position close to the top of the viewport,
		 * optimized for viewing a code definition.
		 */
2238
		revealPositionNearTop(position: IPosition, scrollType?: ScrollType): void;
2239 2240 2241
		/**
		 * Returns the primary selection of the editor.
		 */
A
Alex Dima 已提交
2242
		getSelection(): Selection | null;
2243 2244 2245
		/**
		 * Returns all the selections of the editor.
		 */
A
Alex Dima 已提交
2246
		getSelections(): Selection[] | null;
2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270
		/**
		 * Set the primary selection of the editor. This will remove any secondary cursors.
		 * @param selection The new selection
		 */
		setSelection(selection: IRange): void;
		/**
		 * Set the primary selection of the editor. This will remove any secondary cursors.
		 * @param selection The new selection
		 */
		setSelection(selection: Range): void;
		/**
		 * Set the primary selection of the editor. This will remove any secondary cursors.
		 * @param selection The new selection
		 */
		setSelection(selection: ISelection): void;
		/**
		 * Set the primary selection of the editor. This will remove any secondary cursors.
		 * @param selection The new selection
		 */
		setSelection(selection: Selection): void;
		/**
		 * Set the selections for all the cursors of the editor.
		 * Cursors will be removed or added, as necessary.
		 */
2271
		setSelections(selections: readonly ISelection[]): void;
2272 2273 2274
		/**
		 * Scroll vertically as necessary and reveal lines.
		 */
2275
		revealLines(startLineNumber: number, endLineNumber: number, scrollType?: ScrollType): void;
2276 2277 2278
		/**
		 * Scroll vertically as necessary and reveal lines centered vertically.
		 */
2279
		revealLinesInCenter(lineNumber: number, endLineNumber: number, scrollType?: ScrollType): void;
2280 2281 2282
		/**
		 * Scroll vertically as necessary and reveal lines centered vertically only if it lies outside the viewport.
		 */
2283
		revealLinesInCenterIfOutsideViewport(lineNumber: number, endLineNumber: number, scrollType?: ScrollType): void;
2284 2285 2286 2287
		/**
		 * Scroll vertically as necessary and reveal lines close to the top of the viewport,
		 * optimized for viewing a code definition.
		 */
2288
		revealLinesNearTop(lineNumber: number, endLineNumber: number, scrollType?: ScrollType): void;
2289 2290 2291
		/**
		 * Scroll vertically or horizontally as necessary and reveal a range.
		 */
2292
		revealRange(range: IRange, scrollType?: ScrollType): void;
2293 2294 2295
		/**
		 * Scroll vertically or horizontally as necessary and reveal a range centered vertically.
		 */
2296
		revealRangeInCenter(range: IRange, scrollType?: ScrollType): void;
2297 2298 2299
		/**
		 * Scroll vertically or horizontally as necessary and reveal a range at the top of the viewport.
		 */
2300
		revealRangeAtTop(range: IRange, scrollType?: ScrollType): void;
2301 2302 2303
		/**
		 * Scroll vertically or horizontally as necessary and reveal a range centered vertically only if it lies outside the viewport.
		 */
2304
		revealRangeInCenterIfOutsideViewport(range: IRange, scrollType?: ScrollType): void;
2305 2306 2307 2308
		/**
		 * Scroll vertically or horizontally as necessary and reveal a range close to the top of the viewport,
		 * optimized for viewing a code definition.
		 */
2309
		revealRangeNearTop(range: IRange, scrollType?: ScrollType): void;
2310 2311 2312 2313 2314
		/**
		 * Scroll vertically or horizontally as necessary and reveal a range close to the top of the viewport,
		 * optimized for viewing a code definition. Only if it lies outside the viewport.
		 */
		revealRangeNearTopIfOutsideViewport(range: IRange, scrollType?: ScrollType): void;
2315 2316 2317 2318 2319 2320 2321 2322 2323 2324
		/**
		 * Directly trigger a handler or an editor action.
		 * @param source The source of the call.
		 * @param handlerId The id of the handler or the id of a contribution.
		 * @param payload Extra data to be sent to the handler.
		 */
		trigger(source: string, handlerId: string, payload: any): void;
		/**
		 * Gets the current model attached to this editor.
		 */
A
Alex Dima 已提交
2325
		getModel(): IEditorModel | null;
2326 2327 2328 2329 2330 2331 2332 2333
		/**
		 * Sets the current model attached to this editor.
		 * If the previous model was created by the editor via the value key in the options
		 * literal object, it will be destroyed. Otherwise, if the previous model was set
		 * via setModel, or the model key in the options literal object, the previous model
		 * will not be destroyed.
		 * It is safe to call setModel(null) to simply detach the current model from the editor.
		 */
A
Alex Dima 已提交
2334
		setModel(model: IEditorModel | null): void;
2335 2336 2337 2338
	}

	/**
	 * An editor contribution that gets created every time a new editor gets created and gets disposed when the editor gets disposed.
A
Alex Dima 已提交
2339 2340
	 */
	export interface IEditorContribution {
2341
		/**
A
Alex Dima 已提交
2342
		 * Dispose this contribution.
2343
		 */
A
Alex Dima 已提交
2344
		dispose(): void;
2345
		/**
A
Alex Dima 已提交
2346
		 * Store view state.
2347
		 */
A
Alex Dima 已提交
2348
		saveViewState?(): any;
2349
		/**
A
Alex Dima 已提交
2350
		 * Restore view state.
2351
		 */
A
Alex Dima 已提交
2352
		restoreViewState?(state: any): void;
2353 2354 2355 2356 2357
	}

	/**
	 * The type of the `IEditor`.
	 */
2358
	export const EditorType: {
2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376
		ICodeEditor: string;
		IDiffEditor: string;
	};

	/**
	 * An event describing that the current mode associated with a model has changed.
	 */
	export interface IModelLanguageChangedEvent {
		/**
		 * Previous language
		 */
		readonly oldLanguage: string;
		/**
		 * New language
		 */
		readonly newLanguage: string;
	}

2377 2378 2379 2380 2381 2382
	/**
	 * An event describing that the language configuration associated with a model has changed.
	 */
	export interface IModelLanguageConfigurationChangedEvent {
	}

2383 2384 2385 2386 2387
	export interface IModelContentChange {
		/**
		 * The range that got replaced.
		 */
		readonly range: IRange;
2388 2389 2390 2391
		/**
		 * The offset of the range that got replaced.
		 */
		readonly rangeOffset: number;
2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 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 2433
		/**
		 * The length of the range that got replaced.
		 */
		readonly rangeLength: number;
		/**
		 * The new text for the range.
		 */
		readonly text: string;
	}

	/**
	 * An event describing a change in the text of a model.
	 */
	export interface IModelContentChangedEvent {
		readonly changes: IModelContentChange[];
		/**
		 * The (new) end-of-line character.
		 */
		readonly eol: string;
		/**
		 * The new version id the model has transitioned to.
		 */
		readonly versionId: number;
		/**
		 * Flag that indicates that this event was generated while undoing.
		 */
		readonly isUndoing: boolean;
		/**
		 * Flag that indicates that this event was generated while redoing.
		 */
		readonly isRedoing: boolean;
		/**
		 * Flag that indicates that all decorations were lost with this edit.
		 * The model has been reset to a new value.
		 */
		readonly isFlush: boolean;
	}

	/**
	 * An event describing that model decorations have changed.
	 */
	export interface IModelDecorationsChangedEvent {
2434 2435
		readonly affectsMinimap: boolean;
		readonly affectsOverviewRuler: boolean;
2436 2437 2438 2439
	}

	export interface IModelOptionsChangedEvent {
		readonly tabSize: boolean;
D
David Lechner 已提交
2440
		readonly indentSize: boolean;
2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475
		readonly insertSpaces: boolean;
		readonly trimAutoWhitespace: boolean;
	}

	/**
	 * Describes the reason the cursor has changed its position.
	 */
	export enum CursorChangeReason {
		/**
		 * Unknown or not set.
		 */
		NotSet = 0,
		/**
		 * A `model.setValue()` was called.
		 */
		ContentFlush = 1,
		/**
		 * The `model` has been changed outside of this cursor and the cursor recovers its position from associated markers.
		 */
		RecoverFromMarkers = 2,
		/**
		 * There was an explicit user gesture.
		 */
		Explicit = 3,
		/**
		 * There was a Paste.
		 */
		Paste = 4,
		/**
		 * There was an Undo.
		 */
		Undo = 5,
		/**
		 * There was a Redo.
		 */
R
Rob Lourens 已提交
2476
		Redo = 6
2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512
	}

	/**
	 * An event describing that the cursor position has changed.
	 */
	export interface ICursorPositionChangedEvent {
		/**
		 * Primary cursor's position.
		 */
		readonly position: Position;
		/**
		 * Secondary cursors' position.
		 */
		readonly secondaryPositions: Position[];
		/**
		 * Reason.
		 */
		readonly reason: CursorChangeReason;
		/**
		 * Source of the call that caused the event.
		 */
		readonly source: string;
	}

	/**
	 * An event describing that the cursor selection has changed.
	 */
	export interface ICursorSelectionChangedEvent {
		/**
		 * The primary selection.
		 */
		readonly selection: Selection;
		/**
		 * The secondary selections.
		 */
		readonly secondarySelections: Selection[];
2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524
		/**
		 * The model version id.
		 */
		readonly modelVersionId: number;
		/**
		 * The old selections.
		 */
		readonly oldSelections: Selection[] | null;
		/**
		 * The model version id the that `oldSelections` refer to.
		 */
		readonly oldModelVersionId: number;
2525 2526 2527 2528 2529 2530 2531 2532 2533 2534
		/**
		 * Source of the call that caused the event.
		 */
		readonly source: string;
		/**
		 * Reason.
		 */
		readonly reason: CursorChangeReason;
	}

A
Alex Dima 已提交
2535
	export enum AccessibilitySupport {
R
rebornix 已提交
2536
		/**
A
Alex Dima 已提交
2537
		 * This should be the browser case where it is not known if a screen reader is attached or no.
R
rebornix 已提交
2538
		 */
A
Alex Dima 已提交
2539 2540 2541
		Unknown = 0,
		Disabled = 1,
		Enabled = 2
2542 2543
	}

J
Jackson Kearl 已提交
2544
	/**
J
Jackson Kearl 已提交
2545
	 * Configuration options for auto closing quotes and brackets
J
Jackson Kearl 已提交
2546
	 */
J
Jackson Kearl 已提交
2547 2548 2549 2550 2551
	export type EditorAutoClosingStrategy = 'always' | 'languageDefined' | 'beforeWhitespace' | 'never';

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

2554
	/**
2555
	 * Configuration options for typing over closing quotes or brackets
2556
	 */
2557
	export type EditorAutoClosingOvertypeStrategy = 'always' | 'auto' | 'never';
2558

2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569
	/**
	 * Configuration options for auto indentation in the editor
	 */
	export enum EditorAutoIndentStrategy {
		None = 0,
		Keep = 1,
		Brackets = 2,
		Advanced = 3,
		Full = 4
	}

2570 2571 2572 2573
	/**
	 * Configuration options for the editor.
	 */
	export interface IEditorOptions {
2574 2575 2576 2577
		/**
		 * This editor is used inside a diff editor.
		 */
		inDiffEditor?: boolean;
2578 2579 2580 2581 2582 2583 2584 2585
		/**
		 * 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.
		 */
2586
		rulers?: (number | IRulerOption)[];
2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601
		/**
		 * 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 已提交
2602
		 * Defaults to `on`.
2603
		 */
A
Alex Dima 已提交
2604
		lineNumbers?: LineNumbersType;
P
Peng Lyu 已提交
2605
		/**
2606
		 * Controls the minimal number of visible leading and trailing lines surrounding the cursor.
P
Peng Lyu 已提交
2607 2608
		 * Defaults to 0.
		*/
2609
		cursorSurroundingLines?: number;
2610 2611 2612 2613 2614 2615
		/**
		 * 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 已提交
2616 2617
		/**
		 * Render last line number when the file ends with a newline.
A
Alex Dima 已提交
2618
		 * Defaults to true.
A
Alex Dima 已提交
2619 2620
		*/
		renderFinalNewline?: boolean;
2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654
		/**
		 * 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;
		/**
2655
		 * Class name to be added to the editor.
2656
		 */
2657
		extraEditorClassName?: string;
2658 2659 2660 2661 2662
		/**
		 * Should the editor be read only.
		 * Defaults to false.
		 */
		readOnly?: boolean;
2663 2664 2665 2666 2667
		/**
		 * Should the editor render validation decorations.
		 * Defaults to editable.
		 */
		renderValidationDecorations?: 'editable' | 'on' | 'off';
2668 2669 2670 2671 2672 2673 2674 2675
		/**
		 * Control the behavior and rendering of the scrollbars.
		 */
		scrollbar?: IEditorScrollbarOptions;
		/**
		 * Control the behavior and rendering of the minimap.
		 */
		minimap?: IEditorMinimapOptions;
2676 2677 2678 2679
		/**
		 * Control the behavior of the find widget.
		 */
		find?: IEditorFindOptions;
2680 2681 2682 2683 2684 2685 2686
		/**
		 * Display overflow widgets as `fixed`.
		 * Defaults to `false`.
		 */
		fixedOverflowWidgets?: boolean;
		/**
		 * The number of vertical lanes the overview ruler should render.
2687
		 * Defaults to 3.
2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698
		 */
		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 已提交
2699
		cursorBlinking?: 'blink' | 'smooth' | 'phase' | 'expand' | 'solid';
2700 2701 2702 2703 2704
		/**
		 * Zoom the font in the editor when using the mouse wheel in combination with holding Ctrl.
		 * Defaults to false.
		 */
		mouseWheelZoom?: boolean;
2705 2706 2707 2708 2709
		/**
		 * Control the mouse pointer style, either 'text' or 'default' or 'copy'
		 * Defaults to 'text'
		 */
		mouseStyle?: 'text' | 'default' | 'copy';
2710 2711 2712 2713 2714
		/**
		 * Enable smooth caret animation.
		 * Defaults to false.
		 */
		cursorSmoothCaretAnimation?: boolean;
2715 2716 2717 2718
		/**
		 * Control the cursor style, either 'block' or 'line'.
		 * Defaults to 'line'.
		 */
A
Alex Dima 已提交
2719
		cursorStyle?: 'line' | 'block' | 'underline' | 'line-thin' | 'block-outline' | 'underline-thin';
2720 2721 2722 2723
		/**
		 * Control the width of the cursor when cursorStyle is set to 'line'
		 */
		cursorWidth?: number;
2724 2725 2726 2727
		/**
		 * Enable font ligatures.
		 * Defaults to false.
		 */
2728
		fontLigatures?: boolean | string;
2729
		/**
2730 2731
		 * 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.
2732 2733
		 * Defaults to false.
		 */
2734
		disableLayerHinting?: boolean;
2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749
		/**
		 * 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;
2750 2751 2752 2753 2754
		/**
		 * Enable that scrolling can go beyond the last column by a number of columns.
		 * Defaults to 5.
		 */
		scrollBeyondLastColumn?: number;
2755 2756
		/**
		 * Enable that the editor animates scrolling to a position.
2757
		 * Defaults to false.
2758 2759
		 */
		smoothScrolling?: boolean;
2760 2761 2762 2763 2764 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
		/**
		 * 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;
		/**
2790
		 * Control indentation of wrapped lines. Can be: 'none', 'same', 'indent' or 'deepIndent'.
2791 2792
		 * Defaults to 'same' in vscode and to 'none' in monaco-editor.
		 */
A
Alex Dima 已提交
2793
		wrappingIndent?: 'none' | 'same' | 'indent' | 'deepIndent';
2794
		/**
2795 2796
		 * Controls the wrapping strategy to use.
		 * Defaults to 'simple'.
2797
		 */
2798
		wrappingStrategy?: 'simple' | 'advanced';
2799 2800
		/**
		 * Configure word wrapping characters. A break will be introduced before these characters.
2801
		 * Defaults to '([{‘“〈《「『【〔([{「£¥$£¥++'.
2802 2803 2804 2805
		 */
		wordWrapBreakBeforeCharacters?: string;
		/**
		 * Configure word wrapping characters. A break will be introduced after these characters.
2806
		 * Defaults to ' \t})]?|/&.,;¢°′″‰℃、。。、¢,.:;?!%・・ゝゞヽヾーァィゥェォッャュョヮヵヶぁぃぅぇぉっゃゅょゎゕゖㇰㇱㇲㇳㇴㇵㇶㇷㇸㇹㇺㇻㇼㇽㇾㇿ々〻ァィゥェォャュョッー”〉》」』】〕)]}」'.
2807 2808 2809 2810 2811 2812 2813 2814 2815
		 */
		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 已提交
2816
		 * Configure the editor's hover.
2817
		 */
A
Alex Dima 已提交
2818
		hover?: IEditorHoverOptions;
2819 2820 2821 2822 2823
		/**
		 * Enable detecting links and making them clickable.
		 * Defaults to true.
		 */
		links?: boolean;
2824
		/**
R
rebornix 已提交
2825
		 * Enable inline color decorators and color picker rendering.
2826
		 */
R
rebornix 已提交
2827
		colorDecorators?: boolean;
A
Alex Dima 已提交
2828 2829 2830 2831
		/**
		 * Control the behaviour of comments in the editor.
		 */
		comments?: IEditorCommentsOptions;
2832 2833 2834 2835 2836 2837 2838 2839 2840 2841
		/**
		 * 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 已提交
2842
		/**
2843 2844
		 * FastScrolling mulitplier speed when pressing `Alt`
		 * Defaults to 5.
T
Tiago Ribeiro 已提交
2845 2846
		 */
		fastScrollSensitivity?: number;
2847 2848 2849 2850
		/**
		 * Enable that the editor scrolls only the predominant axis. Prevents horizontal drift when scrolling vertically on a trackpad.
		 * Defaults to true.
		 */
2851
		scrollPredominantAxis?: boolean;
2852 2853 2854 2855
		/**
		 * The modifier to be used to add multiple cursors with the mouse.
		 * Defaults to 'alt'
		 */
2856
		multiCursorModifier?: 'ctrlCmd' | 'alt';
2857
		/**
A
Alex Dima 已提交
2858
		 * Merge overlapping selections.
2859 2860
		 * Defaults to true
		 */
A
Alex Dima 已提交
2861
		multiCursorMergeOverlapping?: boolean;
2862 2863 2864 2865 2866
		/**
		 * Configure the behaviour when pasting a text with the line count equal to the cursor count.
		 * Defaults to 'spread'.
		 */
		multiCursorPaste?: 'spread' | 'full';
2867 2868 2869 2870 2871
		/**
		 * Configure the editor's accessibility support.
		 * Defaults to 'auto'. It is best to leave this to 'auto'.
		 */
		accessibilitySupport?: 'auto' | 'off' | 'on';
I
isidor 已提交
2872 2873 2874
		/**
		 * Controls the number of lines in the editor that can be read out by a screen reader
		 */
I
isidor 已提交
2875
		accessibilityPageSize?: number;
2876 2877 2878 2879
		/**
		 * Suggest options.
		 */
		suggest?: ISuggestOptions;
2880 2881 2882 2883
		/**
		 *
		 */
		gotoLocation?: IGotoLocationOptions;
2884 2885 2886 2887
		/**
		 * Enable quick suggestions (shadow suggestions)
		 * Defaults to true.
		 */
A
Alex Dima 已提交
2888
		quickSuggestions?: boolean | IQuickSuggestionsOptions;
2889 2890
		/**
		 * Quick suggestions show delay (in ms)
A
Alex Dima 已提交
2891
		 * Defaults to 10 (ms)
2892 2893
		 */
		quickSuggestionsDelay?: number;
B
Bailey 已提交
2894
		/**
B
Bailey 已提交
2895
		 * Controls the spacing around the editor.
B
Bailey 已提交
2896
		 */
B
Bailey 已提交
2897
		padding?: IEditorPaddingOptions;
2898
		/**
2899
		 * Parameter hint options.
2900
		 */
2901
		parameterHints?: IEditorParameterHintOptions;
2902
		/**
2903
		 * Options for auto closing brackets.
2904
		 * Defaults to language defined behavior.
2905
		 */
J
Jackson Kearl 已提交
2906
		autoClosingBrackets?: EditorAutoClosingStrategy;
2907
		/**
2908
		 * Options for auto closing quotes.
2909
		 * Defaults to language defined behavior.
2910
		 */
J
Jackson Kearl 已提交
2911
		autoClosingQuotes?: EditorAutoClosingStrategy;
2912 2913 2914 2915
		/**
		 * Options for typing over closing quotes or brackets.
		 */
		autoClosingOvertype?: EditorAutoClosingOvertypeStrategy;
J
Jackson Kearl 已提交
2916
		/**
2917 2918
		 * Options for auto surrounding.
		 * Defaults to always allowing auto surrounding.
2919
		 */
2920
		autoSurround?: EditorAutoSurroundStrategy;
2921
		/**
R
rebornix 已提交
2922 2923
		 * Controls whether the editor should automatically adjust the indentation when users type, paste, move or indent lines.
		 * Defaults to advanced.
2924
		 */
A
wip  
Alexandru Dima 已提交
2925
		autoIndent?: 'none' | 'keep' | 'brackets' | 'advanced' | 'full';
2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947
		/**
		 * 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.
2948
		 * Defaults to 'on'.
2949
		 */
A
Alex Dima 已提交
2950
		acceptSuggestionOnEnter?: 'on' | 'smart' | 'off';
2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963
		/**
		 * 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;
2964
		/**
2965
		 * Syntax highlighting is copied.
2966
		 */
2967
		copyWithSyntaxHighlighting?: boolean;
2968 2969 2970
		/**
		 * The history mode for suggestions.
		 */
M
Martin Aeschlimann 已提交
2971
		suggestSelection?: 'first' | 'recentlyUsed' | 'recentlyUsedByPrefix';
2972 2973 2974 2975 2976 2977 2978 2979 2980 2981
		/**
		 * 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;
2982 2983 2984
		/**
		 * Enable tab completion.
		 */
A
Alex Dima 已提交
2985
		tabCompletion?: 'on' | 'off' | 'onlySnippets';
2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000
		/**
		 * 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;
3001 3002 3003 3004
		/**
		 * Control the behavior and rendering of the code action lightbulb.
		 */
		lightbulb?: IEditorLightbulbOptions;
3005 3006 3007 3008
		/**
		 * Timeout for running code actions on save.
		 */
		codeActionsOnSaveTimeout?: number;
3009
		/**
3010
		 * Enable code folding.
3011
		 * Defaults to true.
3012 3013
		 */
		folding?: boolean;
3014 3015 3016 3017 3018
		/**
		 * 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';
3019 3020 3021 3022 3023
		/**
		 * Enable highlight for folded regions.
		 * Defaults to true.
		 */
		foldingHighlight?: boolean;
3024
		/**
3025 3026
		 * Controls whether the fold actions in the gutter stay always visible or hide unless the mouse is over the gutter.
		 * Defaults to 'mouseover'.
3027
		 */
3028
		showFoldingControls?: 'always' | 'mouseover';
3029 3030
		/**
		 * Enable highlighting of matching brackets.
3031
		 * Defaults to 'always'.
3032
		 */
3033
		matchBrackets?: 'never' | 'near' | 'always';
3034 3035 3036 3037
		/**
		 * Enable rendering of whitespace.
		 * Defaults to none.
		 */
3038
		renderWhitespace?: 'none' | 'boundary' | 'selection' | 'all';
3039 3040 3041 3042 3043 3044 3045
		/**
		 * Enable rendering of control characters.
		 * Defaults to false.
		 */
		renderControlCharacters?: boolean;
		/**
		 * Enable rendering of indent guides.
3046
		 * Defaults to true.
3047 3048
		 */
		renderIndentGuides?: boolean;
3049
		/**
C
typo  
Coenraad Stijne 已提交
3050
		 * Enable highlighting of the active indent guide.
3051 3052 3053
		 * Defaults to true.
		 */
		highlightActiveIndentGuide?: boolean;
3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069
		/**
		 * Enable rendering of current line highlight.
		 * Defaults to all.
		 */
		renderLineHighlight?: 'none' | 'gutter' | 'line' | 'all';
		/**
		 * Inserting and deleting whitespace follows tab stops.
		 */
		useTabStops?: boolean;
		/**
		 * The font family
		 */
		fontFamily?: string;
		/**
		 * The font weight
		 */
3070
		fontWeight?: string;
3071 3072 3073 3074 3075 3076 3077 3078
		/**
		 * The font size
		 */
		fontSize?: number;
		/**
		 * The line height
		 */
		lineHeight?: number;
3079 3080 3081 3082
		/**
		 * The letter spacing
		 */
		letterSpacing?: number;
3083 3084 3085 3086
		/**
		 * Controls fading out of unused variables.
		 */
		showUnused?: boolean;
3087 3088 3089 3090
		/**
		 * Controls whether to focus the inline editor in the peek widget by default.
		 * Defaults to false.
		 */
3091
		peekWidgetDefaultFocus?: 'tree' | 'editor';
3092
		/**
3093
		 * Controls whether the definition link opens element in the peek widget.
3094 3095
		 * Defaults to false.
		 */
3096
		definitionLinkOpensInPeek?: boolean;
A
Alex Dima 已提交
3097 3098
	}

3099 3100 3101 3102 3103
	export interface IEditorConstructionOptions extends IEditorOptions {
		/**
		 * The initial editor dimension (to avoid measuring the container).
		 */
		dimension?: IDimension;
3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119
	}

	/**
	 * 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;
3120 3121 3122 3123
		/**
		 * Timeout in milliseconds after which diff computation is cancelled.
		 * Defaults to 5000.
		 */
3124
		maxComputationTime?: number;
3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142
		/**
		 * 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 已提交
3143
	 * An event describing that the configuration of the editor has changed.
3144
	 */
A
Alex Dima 已提交
3145
	export class ConfigurationChangedEvent {
3146
		hasChanged(id: EditorOption): boolean;
A
Alex Dima 已提交
3147 3148
	}

3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159
	/**
	 * All computed editor options.
	 */
	export interface IComputedEditorOptions {
		get<T extends EditorOption>(id: T): FindComputedEditorOptionValueById<T>;
	}

	export interface IEditorOption<K1 extends EditorOption, V> {
		readonly id: K1;
		readonly name: string;
		defaultValue: V;
3160 3161
	}

A
Alex Dima 已提交
3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174
	/**
	 * 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>>;

3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201
	/**
	 * The kind of animation in which the editor's cursor should be rendered.
	 */
	export enum TextEditorCursorBlinkingStyle {
		/**
		 * Hidden
		 */
		Hidden = 0,
		/**
		 * Blinking
		 */
		Blink = 1,
		/**
		 * Blinking with smooth fading
		 */
		Smooth = 2,
		/**
		 * Blinking with prolonged filled state and smooth fading
		 */
		Phase = 3,
		/**
		 * Expand collapse animation on the y axis
		 */
		Expand = 4,
		/**
		 * No-Blinking
		 */
R
Rob Lourens 已提交
3202
		Solid = 5
3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231
	}

	/**
	 * 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).
		 */
R
Rob Lourens 已提交
3232
		UnderlineThin = 6
3233 3234
	}

3235 3236 3237 3238 3239 3240 3241 3242 3243
	/**
	 * 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 已提交
3244
		 * Controls if Find in Selection flag is turned on in the editor.
3245
		 */
P
Peng Lyu 已提交
3246
		autoFindInSelection?: 'never' | 'always' | 'multiline';
3247
		addExtraSpaceOnTop?: boolean;
A
Alex Dima 已提交
3248 3249
	}

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

3252 3253
	export type GoToLocationValues = 'peek' | 'gotoAndPeek' | 'goto';

3254 3255 3256 3257
	/**
	 * Configuration options for go to location
	 */
	export interface IGotoLocationOptions {
3258 3259 3260 3261
		multiple?: GoToLocationValues;
		multipleDefinitions?: GoToLocationValues;
		multipleTypeDefinitions?: GoToLocationValues;
		multipleDeclarations?: GoToLocationValues;
R
rzj17 已提交
3262
		multipleImplementations?: GoToLocationValues;
3263
		multipleReferences?: GoToLocationValues;
3264 3265 3266 3267 3268
		alternativeDefinitionCommand?: string;
		alternativeTypeDefinitionCommand?: string;
		alternativeDeclarationCommand?: string;
		alternativeImplementationCommand?: string;
		alternativeReferenceCommand?: string;
3269 3270
	}

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

3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291
	/**
	 * 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;
3292 3293
	}

A
Alex Dima 已提交
3294
	export type EditorHoverOptions = Readonly<Required<IEditorHoverOptions>>;
3295 3296 3297 3298

	/**
	 * A description for the overview ruler position.
	 */
A
Alex Dima 已提交
3299
	export interface OverviewRulerPosition {
3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317
		/**
		 * 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 已提交
3318 3319
	export enum RenderMinimap {
		None = 0,
3320 3321
		Text = 1,
		Blocks = 2
A
Alex Dima 已提交
3322 3323
	}

3324 3325 3326
	/**
	 * The internal layout details of the editor.
	 */
A
Alex Dima 已提交
3327
	export interface EditorLayoutInfo {
3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367
		/**
		 * Full editor width.
		 */
		readonly width: number;
		/**
		 * Full editor height.
		 */
		readonly height: number;
		/**
		 * Left position for the glyph margin.
		 */
		readonly glyphMarginLeft: number;
		/**
		 * The width of the glyph margin.
		 */
		readonly glyphMarginWidth: number;
		/**
		 * 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;
3368 3369 3370 3371
		/**
		 * The position for the minimap
		 */
		readonly minimapLeft: number;
3372 3373 3374 3375
		/**
		 * The width of the minimap
		 */
		readonly minimapWidth: number;
A
Alex Dima 已提交
3376
		readonly minimapHeightIsEditorHeight: boolean;
3377 3378
		readonly minimapIsSampling: boolean;
		readonly minimapScale: number;
3379
		readonly minimapLineHeight: number;
3380 3381 3382 3383
		readonly minimapCanvasInnerWidth: number;
		readonly minimapCanvasInnerHeight: number;
		readonly minimapCanvasOuterWidth: number;
		readonly minimapCanvasOuterHeight: number;
3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406
		/**
		 * Minimap render type
		 */
		readonly renderMinimap: RenderMinimap;
		/**
		 * The number of columns (of typical characters) fitting on a viewport line.
		 */
		readonly viewportColumn: number;
		/**
		 * The width of the vertical scrollbar.
		 */
		readonly verticalScrollbarWidth: number;
		/**
		 * The height of the horizontal scrollbar.
		 */
		readonly horizontalScrollbarHeight: number;
		/**
		 * The position of the overview ruler.
		 */
		readonly overviewRuler: OverviewRulerPosition;
	}

	/**
3407 3408 3409 3410 3411 3412 3413 3414 3415 3416
	 * Configuration options for editor lightbulb
	 */
	export interface IEditorLightbulbOptions {
		/**
		 * Enable the lightbulb code action.
		 * Defaults to true.
		 */
		enabled?: boolean;
	}

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

3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432
	/**
	 * Configuration options for editor minimap
	 */
	export interface IEditorMinimapOptions {
		/**
		 * Enable the rendering of the minimap.
		 * Defaults to true.
		 */
		enabled?: boolean;
		/**
		 * Control the side of the minimap in editor.
		 * Defaults to 'right'.
		 */
		side?: 'right' | 'left';
A
Alex Dima 已提交
3433 3434 3435 3436 3437
		/**
		 * Control the minimap rendering mode.
		 * Defaults to 'actual'.
		 */
		mode?: 'actual' | 'cover' | 'contain';
3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452
		/**
		 * 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;
3453 3454 3455 3456
		/**
		 * Relative size of the font in the minimap. Defaults to 1.
		 */
		scale?: number;
3457 3458
	}

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

B
Bailey 已提交
3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479
	/**
	 * 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;
	}

3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495
	/**
	 * 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 已提交
3496
	export type InternalParameterHintOptions = Readonly<Required<IEditorParameterHintOptions>>;
A
Alex Dima 已提交
3497

3498 3499 3500 3501 3502 3503 3504 3505 3506
	/**
	 * Configuration options for quick suggestions
	 */
	export interface IQuickSuggestionsOptions {
		other: boolean;
		comments: boolean;
		strings: boolean;
	}

A
Alex Dima 已提交
3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523
	export type ValidQuickSuggestionsOptions = boolean | Readonly<Required<IQuickSuggestionsOptions>>;

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

	export enum RenderLineNumbersType {
		Off = 0,
		On = 1,
		Relative = 2,
		Interval = 3,
		Custom = 4
	}

	export interface InternalEditorRenderLineNumbersOptions {
		readonly renderType: RenderLineNumbersType;
		readonly renderFn: ((lineNumber: number) => string) | null;
	}

3524 3525 3526
	export interface IRulerOption {
		readonly column: number;
		readonly color: string | null;
3527 3528
	}

3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567
	/**
	 * 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;
A
Alexandru Dima 已提交
3568 3569 3570 3571 3572
		/**
		 * Always consume mouse wheel events (always call preventDefault() and stopPropagation() on the browser events).
		 * Defaults to true.
		 */
		alwaysConsumeMouseWheel?: boolean;
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594
		/**
		 * 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 已提交
3595 3596 3597 3598 3599 3600 3601 3602
	export interface InternalEditorScrollbarOptions {
		readonly arrowSize: number;
		readonly vertical: ScrollbarVisibility;
		readonly horizontal: ScrollbarVisibility;
		readonly useShadows: boolean;
		readonly verticalHasArrows: boolean;
		readonly horizontalHasArrows: boolean;
		readonly handleMouseWheel: boolean;
3603
		readonly alwaysConsumeMouseWheel: boolean;
A
Alex Dima 已提交
3604 3605 3606 3607 3608 3609
		readonly horizontalScrollbarSize: number;
		readonly horizontalSliderSize: number;
		readonly verticalScrollbarSize: number;
		readonly verticalSliderSize: number;
	}

3610 3611 3612 3613
	/**
	 * Configuration options for editor suggest widget
	 */
	export interface ISuggestOptions {
3614 3615 3616
		/**
		 * Overwrite word ends on accept. Default to false.
		 */
3617
		insertMode?: 'insert' | 'replace';
3618
		/**
3619
		 * Show a highlight when suggestion replaces or keep text after the cursor. Defaults to false.
3620 3621
		 */
		insertHighlight?: boolean;
3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646
		/**
		 * 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;
		/**
3647
		 * Show method-suggestions.
3648
		 */
3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667
		showMethods?: boolean;
		/**
		 * Show function-suggestions.
		 */
		showFunctions?: boolean;
		/**
		 * Show constructor-suggestions.
		 */
		showConstructors?: boolean;
		/**
		 * Show field-suggestions.
		 */
		showFields?: boolean;
		/**
		 * Show variable-suggestions.
		 */
		showVariables?: boolean;
		/**
		 * Show class-suggestions.
3668
		 */
3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723
		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.
3724
		 */
3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745
		showColors?: boolean;
		/**
		 * Show file-suggestions.
		 */
		showFiles?: boolean;
		/**
		 * Show reference-suggestions.
		 */
		showReferences?: boolean;
		/**
		 * Show folder-suggestions.
		 */
		showFolders?: boolean;
		/**
		 * Show typeParameter-suggestions.
		 */
		showTypeParameters?: boolean;
		/**
		 * Show snippet-suggestions.
		 */
		showSnippets?: boolean;
P
Pine Wu 已提交
3746 3747
		/**
		 * Controls the visibility of the status bar at the bottom of the suggest widget.
3748
		 */
P
Pine Wu 已提交
3749
		hideStatusBar?: boolean;
3750 3751
	}

A
Alex Dima 已提交
3752
	export type InternalSuggestOptions = Readonly<Required<ISuggestOptions>>;
A
Alex Dima 已提交
3753 3754 3755

	/**
	 * Describes how to indent wrapped lines.
3756
	 */
A
Alex Dima 已提交
3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775
	export 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
	}

A
Alex Dima 已提交
3776 3777 3778 3779 3780
	export interface EditorWrappingInfo {
		readonly isDominatedByLongLines: boolean;
		readonly isWordWrapMinified: boolean;
		readonly isViewportWrapping: boolean;
		readonly wrappingColumn: number;
3781 3782
	}

3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796
	export enum EditorOption {
		acceptSuggestionOnCommitCharacter = 0,
		acceptSuggestionOnEnter = 1,
		accessibilitySupport = 2,
		accessibilityPageSize = 3,
		ariaLabel = 4,
		autoClosingBrackets = 5,
		autoClosingOvertype = 6,
		autoClosingQuotes = 7,
		autoIndent = 8,
		automaticLayout = 9,
		autoSurround = 10,
		codeLens = 11,
		colorDecorators = 12,
A
Alex Dima 已提交
3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813
		comments = 13,
		contextmenu = 14,
		copyWithSyntaxHighlighting = 15,
		cursorBlinking = 16,
		cursorSmoothCaretAnimation = 17,
		cursorStyle = 18,
		cursorSurroundingLines = 19,
		cursorSurroundingLinesStyle = 20,
		cursorWidth = 21,
		disableLayerHinting = 22,
		disableMonospaceOptimizations = 23,
		dragAndDrop = 24,
		emptySelectionClipboard = 25,
		extraEditorClassName = 26,
		fastScrollSensitivity = 27,
		find = 28,
		fixedOverflowWidgets = 29,
3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847
		folding = 30,
		foldingStrategy = 31,
		foldingHighlight = 32,
		fontFamily = 33,
		fontInfo = 34,
		fontLigatures = 35,
		fontSize = 36,
		fontWeight = 37,
		formatOnPaste = 38,
		formatOnType = 39,
		glyphMargin = 40,
		gotoLocation = 41,
		hideCursorInOverviewRuler = 42,
		highlightActiveIndentGuide = 43,
		hover = 44,
		inDiffEditor = 45,
		letterSpacing = 46,
		lightbulb = 47,
		lineDecorationsWidth = 48,
		lineHeight = 49,
		lineNumbers = 50,
		lineNumbersMinChars = 51,
		links = 52,
		matchBrackets = 53,
		minimap = 54,
		mouseStyle = 55,
		mouseWheelScrollSensitivity = 56,
		mouseWheelZoom = 57,
		multiCursorMergeOverlapping = 58,
		multiCursorModifier = 59,
		multiCursorPaste = 60,
		occurrencesHighlight = 61,
		overviewRulerBorder = 62,
		overviewRulerLanes = 63,
B
Bailey 已提交
3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895
		padding = 64,
		parameterHints = 65,
		peekWidgetDefaultFocus = 66,
		definitionLinkOpensInPeek = 67,
		quickSuggestions = 68,
		quickSuggestionsDelay = 69,
		readOnly = 70,
		renderControlCharacters = 71,
		renderIndentGuides = 72,
		renderFinalNewline = 73,
		renderLineHighlight = 74,
		renderValidationDecorations = 75,
		renderWhitespace = 76,
		revealHorizontalRightPadding = 77,
		roundedSelection = 78,
		rulers = 79,
		scrollbar = 80,
		scrollBeyondLastColumn = 81,
		scrollBeyondLastLine = 82,
		scrollPredominantAxis = 83,
		selectionClipboard = 84,
		selectionHighlight = 85,
		selectOnLineNumbers = 86,
		showFoldingControls = 87,
		showUnused = 88,
		snippetSuggestions = 89,
		smoothScrolling = 90,
		stopRenderingLineAfter = 91,
		suggest = 92,
		suggestFontSize = 93,
		suggestLineHeight = 94,
		suggestOnTriggerCharacters = 95,
		suggestSelection = 96,
		tabCompletion = 97,
		useTabStops = 98,
		wordSeparators = 99,
		wordWrap = 100,
		wordWrapBreakAfterCharacters = 101,
		wordWrapBreakBeforeCharacters = 102,
		wordWrapColumn = 103,
		wordWrapMinified = 104,
		wrappingIndent = 105,
		wrappingStrategy = 106,
		editorClassName = 107,
		pixelRatio = 108,
		tabFocusMode = 109,
		layoutInfo = 110,
		wrappingInfo = 111
3896 3897 3898
	}
	export const EditorOptions: {
		acceptSuggestionOnCommitCharacter: IEditorOption<EditorOption.acceptSuggestionOnCommitCharacter, boolean>;
3899
		acceptSuggestionOnEnter: IEditorOption<EditorOption.acceptSuggestionOnEnter, 'on' | 'off' | 'smart'>;
3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910
		accessibilitySupport: IEditorOption<EditorOption.accessibilitySupport, AccessibilitySupport>;
		accessibilityPageSize: IEditorOption<EditorOption.accessibilityPageSize, number>;
		ariaLabel: IEditorOption<EditorOption.ariaLabel, string>;
		autoClosingBrackets: IEditorOption<EditorOption.autoClosingBrackets, EditorAutoClosingStrategy>;
		autoClosingOvertype: IEditorOption<EditorOption.autoClosingOvertype, EditorAutoClosingOvertypeStrategy>;
		autoClosingQuotes: IEditorOption<EditorOption.autoClosingQuotes, EditorAutoClosingStrategy>;
		autoIndent: IEditorOption<EditorOption.autoIndent, EditorAutoIndentStrategy>;
		automaticLayout: IEditorOption<EditorOption.automaticLayout, boolean>;
		autoSurround: IEditorOption<EditorOption.autoSurround, EditorAutoSurroundStrategy>;
		codeLens: IEditorOption<EditorOption.codeLens, boolean>;
		colorDecorators: IEditorOption<EditorOption.colorDecorators, boolean>;
A
Alex Dima 已提交
3911
		comments: IEditorOption<EditorOption.comments, EditorCommentsOptions>;
3912 3913 3914 3915 3916 3917
		contextmenu: IEditorOption<EditorOption.contextmenu, boolean>;
		copyWithSyntaxHighlighting: IEditorOption<EditorOption.copyWithSyntaxHighlighting, boolean>;
		cursorBlinking: IEditorOption<EditorOption.cursorBlinking, TextEditorCursorBlinkingStyle>;
		cursorSmoothCaretAnimation: IEditorOption<EditorOption.cursorSmoothCaretAnimation, boolean>;
		cursorStyle: IEditorOption<EditorOption.cursorStyle, TextEditorCursorStyle>;
		cursorSurroundingLines: IEditorOption<EditorOption.cursorSurroundingLines, number>;
3918
		cursorSurroundingLinesStyle: IEditorOption<EditorOption.cursorSurroundingLinesStyle, 'default' | 'all'>;
3919 3920 3921 3922 3923 3924 3925 3926 3927 3928
		cursorWidth: IEditorOption<EditorOption.cursorWidth, number>;
		disableLayerHinting: IEditorOption<EditorOption.disableLayerHinting, boolean>;
		disableMonospaceOptimizations: IEditorOption<EditorOption.disableMonospaceOptimizations, boolean>;
		dragAndDrop: IEditorOption<EditorOption.dragAndDrop, boolean>;
		emptySelectionClipboard: IEditorOption<EditorOption.emptySelectionClipboard, boolean>;
		extraEditorClassName: IEditorOption<EditorOption.extraEditorClassName, string>;
		fastScrollSensitivity: IEditorOption<EditorOption.fastScrollSensitivity, number>;
		find: IEditorOption<EditorOption.find, EditorFindOptions>;
		fixedOverflowWidgets: IEditorOption<EditorOption.fixedOverflowWidgets, boolean>;
		folding: IEditorOption<EditorOption.folding, boolean>;
3929 3930
		foldingStrategy: IEditorOption<EditorOption.foldingStrategy, 'auto' | 'indentation'>;
		foldingHighlight: IEditorOption<EditorOption.foldingHighlight, boolean>;
3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950
		fontFamily: IEditorOption<EditorOption.fontFamily, string>;
		fontInfo: IEditorOption<EditorOption.fontInfo, FontInfo>;
		fontLigatures2: IEditorOption<EditorOption.fontLigatures, string>;
		fontSize: IEditorOption<EditorOption.fontSize, number>;
		fontWeight: IEditorOption<EditorOption.fontWeight, string>;
		formatOnPaste: IEditorOption<EditorOption.formatOnPaste, boolean>;
		formatOnType: IEditorOption<EditorOption.formatOnType, boolean>;
		glyphMargin: IEditorOption<EditorOption.glyphMargin, boolean>;
		gotoLocation: IEditorOption<EditorOption.gotoLocation, GoToLocationOptions>;
		hideCursorInOverviewRuler: IEditorOption<EditorOption.hideCursorInOverviewRuler, boolean>;
		highlightActiveIndentGuide: IEditorOption<EditorOption.highlightActiveIndentGuide, boolean>;
		hover: IEditorOption<EditorOption.hover, EditorHoverOptions>;
		inDiffEditor: IEditorOption<EditorOption.inDiffEditor, boolean>;
		letterSpacing: IEditorOption<EditorOption.letterSpacing, number>;
		lightbulb: IEditorOption<EditorOption.lightbulb, EditorLightbulbOptions>;
		lineDecorationsWidth: IEditorOption<EditorOption.lineDecorationsWidth, string | number>;
		lineHeight: IEditorOption<EditorOption.lineHeight, number>;
		lineNumbers: IEditorOption<EditorOption.lineNumbers, InternalEditorRenderLineNumbersOptions>;
		lineNumbersMinChars: IEditorOption<EditorOption.lineNumbersMinChars, number>;
		links: IEditorOption<EditorOption.links, boolean>;
3951
		matchBrackets: IEditorOption<EditorOption.matchBrackets, 'always' | 'never' | 'near'>;
3952
		minimap: IEditorOption<EditorOption.minimap, EditorMinimapOptions>;
3953
		mouseStyle: IEditorOption<EditorOption.mouseStyle, 'default' | 'text' | 'copy'>;
3954 3955 3956
		mouseWheelScrollSensitivity: IEditorOption<EditorOption.mouseWheelScrollSensitivity, number>;
		mouseWheelZoom: IEditorOption<EditorOption.mouseWheelZoom, boolean>;
		multiCursorMergeOverlapping: IEditorOption<EditorOption.multiCursorMergeOverlapping, boolean>;
3957 3958
		multiCursorModifier: IEditorOption<EditorOption.multiCursorModifier, 'altKey' | 'metaKey' | 'ctrlKey'>;
		multiCursorPaste: IEditorOption<EditorOption.multiCursorPaste, 'spread' | 'full'>;
3959 3960 3961
		occurrencesHighlight: IEditorOption<EditorOption.occurrencesHighlight, boolean>;
		overviewRulerBorder: IEditorOption<EditorOption.overviewRulerBorder, boolean>;
		overviewRulerLanes: IEditorOption<EditorOption.overviewRulerLanes, number>;
B
Bailey 已提交
3962
		padding: IEditorOption<EditorOption.padding, InternalEditorPaddingOptions>;
3963
		parameterHints: IEditorOption<EditorOption.parameterHints, InternalParameterHintOptions>;
3964
		peekWidgetDefaultFocus: IEditorOption<EditorOption.peekWidgetDefaultFocus, 'tree' | 'editor'>;
3965
		definitionLinkOpensInPeek: IEditorOption<EditorOption.definitionLinkOpensInPeek, boolean>;
3966 3967 3968 3969 3970 3971
		quickSuggestions: IEditorOption<EditorOption.quickSuggestions, ValidQuickSuggestionsOptions>;
		quickSuggestionsDelay: IEditorOption<EditorOption.quickSuggestionsDelay, number>;
		readOnly: IEditorOption<EditorOption.readOnly, boolean>;
		renderControlCharacters: IEditorOption<EditorOption.renderControlCharacters, boolean>;
		renderIndentGuides: IEditorOption<EditorOption.renderIndentGuides, boolean>;
		renderFinalNewline: IEditorOption<EditorOption.renderFinalNewline, boolean>;
3972
		renderLineHighlight: IEditorOption<EditorOption.renderLineHighlight, 'all' | 'line' | 'none' | 'gutter'>;
3973
		renderValidationDecorations: IEditorOption<EditorOption.renderValidationDecorations, 'on' | 'off' | 'editable'>;
3974
		renderWhitespace: IEditorOption<EditorOption.renderWhitespace, 'all' | 'none' | 'boundary' | 'selection'>;
3975 3976 3977 3978 3979 3980
		revealHorizontalRightPadding: IEditorOption<EditorOption.revealHorizontalRightPadding, number>;
		roundedSelection: IEditorOption<EditorOption.roundedSelection, boolean>;
		rulers: IEditorOption<EditorOption.rulers, {}>;
		scrollbar: IEditorOption<EditorOption.scrollbar, InternalEditorScrollbarOptions>;
		scrollBeyondLastColumn: IEditorOption<EditorOption.scrollBeyondLastColumn, number>;
		scrollBeyondLastLine: IEditorOption<EditorOption.scrollBeyondLastLine, boolean>;
3981
		scrollPredominantAxis: IEditorOption<EditorOption.scrollPredominantAxis, boolean>;
3982 3983 3984
		selectionClipboard: IEditorOption<EditorOption.selectionClipboard, boolean>;
		selectionHighlight: IEditorOption<EditorOption.selectionHighlight, boolean>;
		selectOnLineNumbers: IEditorOption<EditorOption.selectOnLineNumbers, boolean>;
3985
		showFoldingControls: IEditorOption<EditorOption.showFoldingControls, 'always' | 'mouseover'>;
3986
		showUnused: IEditorOption<EditorOption.showUnused, boolean>;
3987
		snippetSuggestions: IEditorOption<EditorOption.snippetSuggestions, 'none' | 'top' | 'bottom' | 'inline'>;
3988 3989 3990 3991 3992 3993
		smoothScrolling: IEditorOption<EditorOption.smoothScrolling, boolean>;
		stopRenderingLineAfter: IEditorOption<EditorOption.stopRenderingLineAfter, number>;
		suggest: IEditorOption<EditorOption.suggest, InternalSuggestOptions>;
		suggestFontSize: IEditorOption<EditorOption.suggestFontSize, number>;
		suggestLineHeight: IEditorOption<EditorOption.suggestLineHeight, number>;
		suggestOnTriggerCharacters: IEditorOption<EditorOption.suggestOnTriggerCharacters, boolean>;
3994 3995
		suggestSelection: IEditorOption<EditorOption.suggestSelection, 'first' | 'recentlyUsed' | 'recentlyUsedByPrefix'>;
		tabCompletion: IEditorOption<EditorOption.tabCompletion, 'on' | 'off' | 'onlySnippets'>;
3996 3997
		useTabStops: IEditorOption<EditorOption.useTabStops, boolean>;
		wordSeparators: IEditorOption<EditorOption.wordSeparators, string>;
3998
		wordWrap: IEditorOption<EditorOption.wordWrap, 'on' | 'off' | 'wordWrapColumn' | 'bounded'>;
3999 4000 4001 4002 4003
		wordWrapBreakAfterCharacters: IEditorOption<EditorOption.wordWrapBreakAfterCharacters, string>;
		wordWrapBreakBeforeCharacters: IEditorOption<EditorOption.wordWrapBreakBeforeCharacters, string>;
		wordWrapColumn: IEditorOption<EditorOption.wordWrapColumn, number>;
		wordWrapMinified: IEditorOption<EditorOption.wordWrapMinified, boolean>;
		wrappingIndent: IEditorOption<EditorOption.wrappingIndent, WrappingIndent>;
4004
		wrappingStrategy: IEditorOption<EditorOption.wrappingStrategy, 'simple' | 'advanced'>;
4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021
		editorClassName: IEditorOption<EditorOption.editorClassName, string>;
		pixelRatio: IEditorOption<EditorOption.pixelRatio, number>;
		tabFocusMode: IEditorOption<EditorOption.tabFocusMode, boolean>;
		layoutInfo: IEditorOption<EditorOption.layoutInfo, EditorLayoutInfo>;
		wrappingInfo: IEditorOption<EditorOption.wrappingInfo, EditorWrappingInfo>;
	};

	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;

	export type FindComputedEditorOptionValueById<T extends EditorOption> = NonNullable<ComputedEditorOptionValue<EditorOptionsType[FindEditorOptionsKeyById<T>]>>;

4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054
	/**
	 * A view zone is a full horizontal rectangle that 'pushes' text down.
	 * The editor reserves space for view zones when rendering.
	 */
	export interface IViewZone {
		/**
		 * The line number after which this zone should appear.
		 * Use 0 to place a view zone before the first line number.
		 */
		afterLineNumber: number;
		/**
		 * The column after which this zone should appear.
		 * If not set, the maxLineColumn of `afterLineNumber` will be used.
		 */
		afterColumn?: number;
		/**
		 * Suppress mouse down events.
		 * If set, the editor will attach a mouse down listener to the view zone and .preventDefault on it.
		 * Defaults to false
		 */
		suppressMouseDown?: boolean;
		/**
		 * The height in lines of the view zone.
		 * If specified, `heightInPx` will be used instead of this.
		 * If neither `heightInPx` nor `heightInLines` is specified, a default of `heightInLines` = 1 will be chosen.
		 */
		heightInLines?: number;
		/**
		 * The height in px of the view zone.
		 * If this is set, the editor will give preference to it rather than `heightInLines` above.
		 * If neither `heightInPx` nor `heightInLines` is specified, a default of `heightInLines` = 1 will be chosen.
		 */
		heightInPx?: number;
4055 4056 4057 4058 4059
		/**
		 * The minimum width in px of the view zone.
		 * If this is set, the editor will ensure that the scroll width is >= than this value.
		 */
		minWidthInPx?: number;
4060 4061 4062 4063 4064 4065 4066
		/**
		 * The dom node of the view zone
		 */
		domNode: HTMLElement;
		/**
		 * An optional dom node for the view zone that will be placed in the margin area.
		 */
A
Alex Dima 已提交
4067
		marginDomNode?: HTMLElement | null;
4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086
		/**
		 * Callback which gives the relative top of the view zone as it appears (taking scrolling into account).
		 */
		onDomNodeTop?: (top: number) => void;
		/**
		 * Callback which gives the height in pixels of the view zone.
		 */
		onComputedHeight?: (height: number) => void;
	}

	/**
	 * An accessor that allows for zones to be added or removed.
	 */
	export interface IViewZoneChangeAccessor {
		/**
		 * Create a new view zone.
		 * @param zone Zone to create
		 * @return A unique identifier to the view zone.
		 */
A
Alex Dima 已提交
4087
		addZone(zone: IViewZone): string;
4088 4089 4090 4091
		/**
		 * Remove a zone
		 * @param id A unique identifier to the view zone, as returned by the `addZone` call.
		 */
A
Alex Dima 已提交
4092
		removeZone(id: string): void;
4093 4094 4095 4096
		/**
		 * Change a zone's position.
		 * The editor will rescan the `afterLineNumber` and `afterColumn` properties of a view zone.
		 */
A
Alex Dima 已提交
4097
		layoutZone(id: string): void;
4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114
	}

	/**
	 * A positioning preference for rendering content widgets.
	 */
	export enum ContentWidgetPositionPreference {
		/**
		 * Place the content widget exactly at a position
		 */
		EXACT = 0,
		/**
		 * Place the content widget above a position
		 */
		ABOVE = 1,
		/**
		 * Place the content widget below a position
		 */
R
Rob Lourens 已提交
4115
		BELOW = 2
4116 4117 4118 4119 4120 4121 4122 4123 4124 4125
	}

	/**
	 * A position for rendering content widgets.
	 */
	export interface IContentWidgetPosition {
		/**
		 * Desired position for the content widget.
		 * `preference` will also affect the placement.
		 */
A
Alex Dima 已提交
4126
		position: IPosition | null;
A
Alex Dima 已提交
4127 4128 4129 4130
		/**
		 * Optionally, a range can be provided to further
		 * define the position of the content widget.
		 */
A
Alex Dima 已提交
4131
		range?: IRange | null;
4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158
		/**
		 * Placement preference for position, in order of preference.
		 */
		preference: ContentWidgetPositionPreference[];
	}

	/**
	 * A content widget renders inline with the text and can be easily placed 'near' an editor position.
	 */
	export interface IContentWidget {
		/**
		 * Render this content widget in a location where it could overflow the editor's view dom node.
		 */
		allowEditorOverflow?: boolean;
		suppressMouseDown?: boolean;
		/**
		 * Get a unique identifier of the content widget.
		 */
		getId(): string;
		/**
		 * Get the dom node of the content widget.
		 */
		getDomNode(): HTMLElement;
		/**
		 * Get the placement of the content widget.
		 * If null is returned, the content widget will be placed off screen.
		 */
A
Alex Dima 已提交
4159
		getPosition(): IContentWidgetPosition | null;
4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176
	}

	/**
	 * A positioning preference for rendering overlay widgets.
	 */
	export enum OverlayWidgetPositionPreference {
		/**
		 * Position the overlay widget in the top right corner
		 */
		TOP_RIGHT_CORNER = 0,
		/**
		 * Position the overlay widget in the bottom right corner
		 */
		BOTTOM_RIGHT_CORNER = 1,
		/**
		 * Position the overlay widget in the top center
		 */
R
Rob Lourens 已提交
4177
		TOP_CENTER = 2
4178 4179 4180 4181 4182 4183 4184 4185 4186
	}

	/**
	 * A position for rendering overlay widgets.
	 */
	export interface IOverlayWidgetPosition {
		/**
		 * The position preference for the overlay widget.
		 */
A
Alex Dima 已提交
4187
		preference: OverlayWidgetPositionPreference | null;
4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205
	}

	/**
	 * An overlay widgets renders on top of the text.
	 */
	export interface IOverlayWidget {
		/**
		 * Get a unique identifier of the overlay widget.
		 */
		getId(): string;
		/**
		 * Get the dom node of the overlay widget.
		 */
		getDomNode(): HTMLElement;
		/**
		 * Get the placement of the overlay widget.
		 * If null is returned, the overlay widget is responsible to place itself.
		 */
A
Alex Dima 已提交
4206
		getPosition(): IOverlayWidgetPosition | null;
4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267
	}

	/**
	 * Type of hit element with the mouse in the editor.
	 */
	export enum MouseTargetType {
		/**
		 * Mouse is on top of an unknown element.
		 */
		UNKNOWN = 0,
		/**
		 * Mouse is on top of the textarea used for input.
		 */
		TEXTAREA = 1,
		/**
		 * Mouse is on top of the glyph margin
		 */
		GUTTER_GLYPH_MARGIN = 2,
		/**
		 * Mouse is on top of the line numbers
		 */
		GUTTER_LINE_NUMBERS = 3,
		/**
		 * Mouse is on top of the line decorations
		 */
		GUTTER_LINE_DECORATIONS = 4,
		/**
		 * Mouse is on top of the whitespace left in the gutter by a view zone.
		 */
		GUTTER_VIEW_ZONE = 5,
		/**
		 * Mouse is on top of text in the content.
		 */
		CONTENT_TEXT = 6,
		/**
		 * Mouse is on top of empty space in the content (e.g. after line text or below last line)
		 */
		CONTENT_EMPTY = 7,
		/**
		 * Mouse is on top of a view zone in the content.
		 */
		CONTENT_VIEW_ZONE = 8,
		/**
		 * Mouse is on top of a content widget.
		 */
		CONTENT_WIDGET = 9,
		/**
		 * Mouse is on top of the decorations overview ruler.
		 */
		OVERVIEW_RULER = 10,
		/**
		 * Mouse is on top of a scrollbar.
		 */
		SCROLLBAR = 11,
		/**
		 * Mouse is on top of an overlay widget.
		 */
		OVERLAY_WIDGET = 12,
		/**
		 * Mouse is outside of the editor.
		 */
R
Rob Lourens 已提交
4268
		OUTSIDE_EDITOR = 13
4269 4270 4271 4272 4273 4274 4275 4276 4277
	}

	/**
	 * Target hit with the mouse in the editor.
	 */
	export interface IMouseTarget {
		/**
		 * The target element
		 */
A
Alex Dima 已提交
4278
		readonly element: Element | null;
4279 4280 4281 4282 4283 4284 4285
		/**
		 * The target type
		 */
		readonly type: MouseTargetType;
		/**
		 * The 'approximate' editor position
		 */
A
Alex Dima 已提交
4286
		readonly position: Position | null;
4287 4288 4289 4290 4291 4292 4293
		/**
		 * Desired mouse column (e.g. when position.column gets clamped to text length -- clicking after text on a line).
		 */
		readonly mouseColumn: number;
		/**
		 * The 'approximate' editor range
		 */
A
Alex Dima 已提交
4294
		readonly range: Range | null;
4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308
		/**
		 * Some extra detail.
		 */
		readonly detail: any;
	}

	/**
	 * A mouse event originating from the editor.
	 */
	export interface IEditorMouseEvent {
		readonly event: IMouseEvent;
		readonly target: IMouseTarget;
	}

A
Alex Dima 已提交
4309
	export interface IPartialEditorMouseEvent {
4310
		readonly event: IMouseEvent;
A
Alex Dima 已提交
4311
		readonly target: IMouseTarget | null;
4312 4313
	}

4314 4315 4316 4317 4318 4319 4320 4321
	/**
	 * A paste event originating from the editor.
	 */
	export interface IPasteEvent {
		readonly range: Range;
		readonly mode: string | null;
	}

4322 4323 4324
	/**
	 * A rich code editor.
	 */
A
Alex Dima 已提交
4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349
	export interface ICodeEditor extends IEditor {
		/**
		 * An event emitted when the content of the current model has changed.
		 * @event
		 */
		onDidChangeModelContent(listener: (e: IModelContentChangedEvent) => void): IDisposable;
		/**
		 * An event emitted when the language of the current model has changed.
		 * @event
		 */
		onDidChangeModelLanguage(listener: (e: IModelLanguageChangedEvent) => void): IDisposable;
		/**
		 * An event emitted when the language configuration of the current model has changed.
		 * @event
		 */
		onDidChangeModelLanguageConfiguration(listener: (e: IModelLanguageConfigurationChangedEvent) => void): IDisposable;
		/**
		 * An event emitted when the options of the current model has changed.
		 * @event
		 */
		onDidChangeModelOptions(listener: (e: IModelOptionsChangedEvent) => void): IDisposable;
		/**
		 * An event emitted when the configuration of the editor has changed. (e.g. `editor.updateOptions()`)
		 * @event
		 */
4350
		onDidChangeConfiguration(listener: (e: ConfigurationChangedEvent) => void): IDisposable;
A
Alex Dima 已提交
4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371
		/**
		 * An event emitted when the cursor position has changed.
		 * @event
		 */
		onDidChangeCursorPosition(listener: (e: ICursorPositionChangedEvent) => void): IDisposable;
		/**
		 * An event emitted when the cursor selection has changed.
		 * @event
		 */
		onDidChangeCursorSelection(listener: (e: ICursorSelectionChangedEvent) => void): IDisposable;
		/**
		 * An event emitted when the model of this editor has changed (e.g. `editor.setModel()`).
		 * @event
		 */
		onDidChangeModel(listener: (e: IModelChangedEvent) => void): IDisposable;
		/**
		 * An event emitted when the decorations of the current model have changed.
		 * @event
		 */
		onDidChangeModelDecorations(listener: (e: IModelDecorationsChangedEvent) => void): IDisposable;
		/**
A
Alex Dima 已提交
4372
		 * An event emitted when the text inside this editor gained focus (i.e. cursor starts blinking).
A
Alex Dima 已提交
4373 4374 4375 4376
		 * @event
		 */
		onDidFocusEditorText(listener: () => void): IDisposable;
		/**
A
Alex Dima 已提交
4377
		 * An event emitted when the text inside this editor lost focus (i.e. cursor stops blinking).
A
Alex Dima 已提交
4378 4379 4380 4381 4382 4383 4384
		 * @event
		 */
		onDidBlurEditorText(listener: () => void): IDisposable;
		/**
		 * An event emitted when the text inside this editor or an editor widget gained focus.
		 * @event
		 */
A
Alex Dima 已提交
4385
		onDidFocusEditorWidget(listener: () => void): IDisposable;
A
Alex Dima 已提交
4386 4387 4388 4389
		/**
		 * An event emitted when the text inside this editor or an editor widget lost focus.
		 * @event
		 */
A
Alex Dima 已提交
4390
		onDidBlurEditorWidget(listener: () => void): IDisposable;
J
Johannes Rieken 已提交
4391 4392 4393
		/**
		 * An event emitted after composition has started.
		 */
4394
		onDidCompositionStart(listener: () => void): IDisposable;
J
Johannes Rieken 已提交
4395 4396 4397
		/**
		 * An event emitted after composition has ended.
		 */
4398
		onDidCompositionEnd(listener: () => void): IDisposable;
4399 4400 4401 4402
		/**
		 * An event emitted when users paste text in the editor.
		 * @event
		 */
4403
		onDidPaste(listener: (e: IPasteEvent) => void): IDisposable;
4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427
		/**
		 * An event emitted on a "mouseup".
		 * @event
		 */
		onMouseUp(listener: (e: IEditorMouseEvent) => void): IDisposable;
		/**
		 * An event emitted on a "mousedown".
		 * @event
		 */
		onMouseDown(listener: (e: IEditorMouseEvent) => void): IDisposable;
		/**
		 * An event emitted on a "contextmenu".
		 * @event
		 */
		onContextMenu(listener: (e: IEditorMouseEvent) => void): IDisposable;
		/**
		 * An event emitted on a "mousemove".
		 * @event
		 */
		onMouseMove(listener: (e: IEditorMouseEvent) => void): IDisposable;
		/**
		 * An event emitted on a "mouseleave".
		 * @event
		 */
A
Alex Dima 已提交
4428
		onMouseLeave(listener: (e: IPartialEditorMouseEvent) => void): IDisposable;
4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443
		/**
		 * An event emitted on a "keyup".
		 * @event
		 */
		onKeyUp(listener: (e: IKeyboardEvent) => void): IDisposable;
		/**
		 * An event emitted on a "keydown".
		 * @event
		 */
		onKeyDown(listener: (e: IKeyboardEvent) => void): IDisposable;
		/**
		 * An event emitted when the layout of the editor has changed.
		 * @event
		 */
		onDidLayoutChange(listener: (e: EditorLayoutInfo) => void): IDisposable;
4444 4445 4446 4447 4448
		/**
		 * An event emitted when the content width or content height in the editor has changed.
		 * @event
		 */
		onDidContentSizeChange(listener: (e: IContentSizeChangedEvent) => void): IDisposable;
4449 4450 4451 4452 4453
		/**
		 * An event emitted when the scroll in the editor has changed.
		 * @event
		 */
		onDidScrollChange(listener: (e: IScrollEvent) => void): IDisposable;
A
Alex Dima 已提交
4454 4455 4456
		/**
		 * Saves current view state of the editor in a serializable object.
		 */
A
Alex Dima 已提交
4457
		saveViewState(): ICodeEditorViewState | null;
A
Alex Dima 已提交
4458 4459 4460 4461 4462
		/**
		 * Restores the view state of the editor from a serializable object generated by `saveViewState`.
		 */
		restoreViewState(state: ICodeEditorViewState): void;
		/**
A
Alex Dima 已提交
4463
		 * Returns true if the text inside this editor or an editor widget has focus.
A
Alex Dima 已提交
4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474
		 */
		hasWidgetFocus(): boolean;
		/**
		 * Get a contribution of this editor.
		 * @id Unique identifier of the contribution.
		 * @return The contribution or null if contribution not found.
		 */
		getContribution<T extends IEditorContribution>(id: string): T;
		/**
		 * Type the getModel() of IEditor.
		 */
A
Alex Dima 已提交
4475 4476 4477 4478 4479 4480 4481 4482 4483 4484
		getModel(): ITextModel | null;
		/**
		 * Sets the current model attached to this editor.
		 * If the previous model was created by the editor via the value key in the options
		 * literal object, it will be destroyed. Otherwise, if the previous model was set
		 * via setModel, or the model key in the options literal object, the previous model
		 * will not be destroyed.
		 * It is safe to call setModel(null) to simply detach the current model from the editor.
		 */
		setModel(model: ITextModel | null): void;
4485 4486 4487 4488 4489 4490 4491 4492
		/**
		 * Gets all the editor computed options.
		 */
		getOptions(): IComputedEditorOptions;
		/**
		 * Gets a specific editor option.
		 */
		getOption<T extends EditorOption>(id: T): FindComputedEditorOptionValueById<T>;
A
Alex Dima 已提交
4493
		/**
4494
		 * Returns the editor's configuration (without any validation or defaults).
A
Alex Dima 已提交
4495
		 */
4496
		getRawOptions(): IEditorOptions;
A
Alex Dima 已提交
4497 4498
		/**
		 * Get value of the current model attached to this editor.
4499
		 * @see `ITextModel.getValue`
A
Alex Dima 已提交
4500 4501 4502 4503 4504 4505 4506
		 */
		getValue(options?: {
			preserveBOM: boolean;
			lineEnding: string;
		}): string;
		/**
		 * Set the value of the current model attached to this editor.
4507
		 * @see `ITextModel.setValue`
A
Alex Dima 已提交
4508 4509
		 */
		setValue(newValue: string): void;
4510 4511 4512 4513 4514
		/**
		 * Get the width of the editor's content.
		 * This is information that is "erased" when computing `scrollWidth = Math.max(contentWidth, width)`
		 */
		getContentWidth(): number;
A
Alex Dima 已提交
4515 4516 4517 4518 4519 4520 4521 4522
		/**
		 * Get the scrollWidth of the editor's viewport.
		 */
		getScrollWidth(): number;
		/**
		 * Get the scrollLeft of the editor's viewport.
		 */
		getScrollLeft(): number;
4523 4524 4525 4526 4527
		/**
		 * Get the height of the editor's content.
		 * This is information that is "erased" when computing `scrollHeight = Math.max(contentHeight, height)`
		 */
		getContentHeight(): number;
A
Alex Dima 已提交
4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569
		/**
		 * Get the scrollHeight of the editor's viewport.
		 */
		getScrollHeight(): number;
		/**
		 * Get the scrollTop of the editor's viewport.
		 */
		getScrollTop(): number;
		/**
		 * Change the scrollLeft of the editor's viewport.
		 */
		setScrollLeft(newScrollLeft: number): void;
		/**
		 * Change the scrollTop of the editor's viewport.
		 */
		setScrollTop(newScrollTop: number): void;
		/**
		 * Change the scroll position of the editor's viewport.
		 */
		setScrollPosition(position: INewScrollPosition): void;
		/**
		 * Get an action that is a contribution to this editor.
		 * @id Unique identifier of the contribution.
		 * @return The action or null if action not found.
		 */
		getAction(id: string): IEditorAction;
		/**
		 * Execute a command on the editor.
		 * The edits will land on the undo-redo stack, but no "undo stop" will be pushed.
		 * @param source The source of the call.
		 * @param command The command to execute
		 */
		executeCommand(source: string, command: ICommand): void;
		/**
		 * Push an "undo stop" in the undo-redo stack.
		 */
		pushUndoStop(): boolean;
		/**
		 * Execute edits on the editor.
		 * The edits will land on the undo-redo stack, but no "undo stop" will be pushed.
		 * @param source The source of the call.
		 * @param edits The edits to execute.
J
Johannes Rieken 已提交
4570
		 * @param endCursorState Cursor state after the edits were applied.
A
Alex Dima 已提交
4571
		 */
4572
		executeEdits(source: string, edits: IIdentifiedSingleEditOperation[], endCursorState?: ICursorStateComputer | Selection[]): boolean;
A
Alex Dima 已提交
4573
		/**
A
Alex Dima 已提交
4574
		 * Execute multiple (concomitant) commands on the editor.
A
Alex Dima 已提交
4575 4576 4577
		 * @param source The source of the call.
		 * @param command The commands to execute
		 */
A
Alex Dima 已提交
4578
		executeCommands(source: string, commands: (ICommand | null)[]): void;
A
Alex Dima 已提交
4579 4580 4581
		/**
		 * Get all the decorations on a line (filtering out decorations from other editors).
		 */
A
Alex Dima 已提交
4582
		getLineDecorations(lineNumber: number): IModelDecoration[] | null;
A
Alex Dima 已提交
4583 4584
		/**
		 * All decorations added through this call will get the ownerId of this editor.
4585
		 * @see `ITextModel.deltaDecorations`
A
Alex Dima 已提交
4586 4587 4588 4589 4590 4591
		 */
		deltaDecorations(oldDecorations: string[], newDecorations: IModelDeltaDecoration[]): string[];
		/**
		 * Get the layout info for the editor.
		 */
		getLayoutInfo(): EditorLayoutInfo;
4592 4593 4594 4595 4596
		/**
		 * Returns the ranges that are currently visible.
		 * Does not account for horizontal scrolling.
		 */
		getVisibleRanges(): Range[];
A
Alex Dima 已提交
4597 4598 4599 4600 4601 4602 4603 4604
		/**
		 * Get the vertical position (top offset) for the line w.r.t. to the first line.
		 */
		getTopForLineNumber(lineNumber: number): number;
		/**
		 * Get the vertical position (top offset) for the position w.r.t. to the first line.
		 */
		getTopForPosition(lineNumber: number, column: number): number;
4605 4606 4607 4608
		/**
		 * Returns the editor's container dom node
		 */
		getContainerDomNode(): HTMLElement;
4609 4610 4611
		/**
		 * Returns the editor's dom node
		 */
A
Alex Dima 已提交
4612
		getDomNode(): HTMLElement | null;
4613 4614 4615 4616 4617 4618
		/**
		 * Add a content widget. Widgets must have unique ids, otherwise they will be overwritten.
		 */
		addContentWidget(widget: IContentWidget): void;
		/**
		 * Layout/Reposition a content widget. This is a ping to the editor to call widget.getPosition()
A
Alex Dima 已提交
4619
		 * and update appropriately.
4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631
		 */
		layoutContentWidget(widget: IContentWidget): void;
		/**
		 * Remove a content widget.
		 */
		removeContentWidget(widget: IContentWidget): void;
		/**
		 * Add an overlay widget. Widgets must have unique ids, otherwise they will be overwritten.
		 */
		addOverlayWidget(widget: IOverlayWidget): void;
		/**
		 * Layout/Reposition an overlay widget. This is a ping to the editor to call widget.getPosition()
A
Alex Dima 已提交
4632
		 * and update appropriately.
4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651
		 */
		layoutOverlayWidget(widget: IOverlayWidget): void;
		/**
		 * Remove an overlay widget.
		 */
		removeOverlayWidget(widget: IOverlayWidget): void;
		/**
		 * Change the view zones. View zones are lost when a new model is attached to the editor.
		 */
		changeViewZones(callback: (accessor: IViewZoneChangeAccessor) => void): void;
		/**
		 * Get the horizontal position (left offset) for the column w.r.t to the beginning of the line.
		 * This method works only if the line `lineNumber` is currently rendered (in the editor's viewport).
		 * Use this method with caution.
		 */
		getOffsetForColumn(lineNumber: number, column: number): number;
		/**
		 * Force an editor render now.
		 */
4652
		render(forceRedraw?: boolean): void;
4653 4654 4655 4656 4657 4658
		/**
		 * Get the hit test target at coordinates `clientX` and `clientY`.
		 * The coordinates are relative to the top-left of the viewport.
		 *
		 * @returns Hit test target or null if the coordinates fall outside the editor or the editor has no model.
		 */
A
Alex Dima 已提交
4659
		getTargetAtClientPoint(clientX: number, clientY: number): IMouseTarget | null;
4660 4661 4662 4663 4664
		/**
		 * Get the visible position for `position`.
		 * The result position takes scrolling into account and is relative to the top left corner of the editor.
		 * Explanation 1: the results of this method will change for the same `position` if the user scrolls the editor.
		 * Explanation 2: the results of this method will not change if the container of the editor gets repositioned.
A
Alex Dima 已提交
4665
		 * Warning: the results of this method are inaccurate for positions that are outside the current editor viewport.
4666 4667 4668 4669 4670
		 */
		getScrolledVisiblePosition(position: IPosition): {
			top: number;
			left: number;
			height: number;
A
Alex Dima 已提交
4671
		} | null;
4672 4673 4674 4675 4676 4677
		/**
		 * Apply the same font settings as the editor to `target`.
		 */
		applyFontInfo(target: HTMLElement): void;
	}

A
Alex Dima 已提交
4678 4679 4680 4681 4682 4683 4684
	/**
	 * Information about a line in the diff editor
	 */
	export interface IDiffLineInformation {
		readonly equivalentLineNumber: number;
	}

4685 4686 4687
	/**
	 * A rich diff editor.
	 */
A
Alex Dima 已提交
4688
	export interface IDiffEditor extends IEditor {
4689 4690 4691 4692
		/**
		 * @see ICodeEditor.getDomNode
		 */
		getDomNode(): HTMLElement;
A
Alex Dima 已提交
4693 4694 4695 4696 4697 4698 4699 4700
		/**
		 * An event emitted when the diff information computed by this diff editor has been updated.
		 * @event
		 */
		onDidUpdateDiff(listener: () => void): IDisposable;
		/**
		 * Saves current view state of the editor in a serializable object.
		 */
A
Alex Dima 已提交
4701
		saveViewState(): IDiffEditorViewState | null;
A
Alex Dima 已提交
4702 4703 4704 4705 4706 4707 4708
		/**
		 * Restores the view state of the editor from a serializable object generated by `saveViewState`.
		 */
		restoreViewState(state: IDiffEditorViewState): void;
		/**
		 * Type the getModel() of IEditor.
		 */
A
Alex Dima 已提交
4709 4710 4711 4712 4713 4714 4715 4716 4717 4718
		getModel(): IDiffEditorModel | null;
		/**
		 * Sets the current model attached to this editor.
		 * If the previous model was created by the editor via the value key in the options
		 * literal object, it will be destroyed. Otherwise, if the previous model was set
		 * via setModel, or the model key in the options literal object, the previous model
		 * will not be destroyed.
		 * It is safe to call setModel(null) to simply detach the current model from the editor.
		 */
		setModel(model: IDiffEditorModel | null): void;
4719 4720 4721 4722 4723 4724 4725 4726
		/**
		 * Get the `original` editor.
		 */
		getOriginalEditor(): ICodeEditor;
		/**
		 * Get the `modified` editor.
		 */
		getModifiedEditor(): ICodeEditor;
A
Alex Dima 已提交
4727 4728 4729
		/**
		 * Get the computed diff information.
		 */
A
Alex Dima 已提交
4730
		getLineChanges(): ILineChange[] | null;
A
Alex Dima 已提交
4731 4732 4733 4734
		/**
		 * Get information based on computed diff about a line number from the original model.
		 * If the diff computation is not finished or the model is missing, will return null.
		 */
A
Alex Dima 已提交
4735
		getDiffLineInformationForOriginal(lineNumber: number): IDiffLineInformation | null;
A
Alex Dima 已提交
4736 4737 4738 4739
		/**
		 * Get information based on computed diff about a line number from the modified model.
		 * If the diff computation is not finished or the model is missing, will return null.
		 */
A
Alex Dima 已提交
4740
		getDiffLineInformationForModified(lineNumber: number): IDiffLineInformation | null;
4741 4742 4743 4744
		/**
		 * Update the editor's options after the editor has been created.
		 */
		updateOptions(newOptions: IDiffEditorOptions): void;
4745 4746 4747 4748 4749 4750 4751 4752
	}

	export class FontInfo extends BareFontInfo {
		readonly _editorStylingBrand: void;
		readonly isTrusted: boolean;
		readonly isMonospace: boolean;
		readonly typicalHalfwidthCharacterWidth: number;
		readonly typicalFullwidthCharacterWidth: number;
4753
		readonly canUseHalfwidthRightwardsArrow: boolean;
4754
		readonly spaceWidth: number;
4755
		readonly middotWidth: number;
4756
		readonly wsmiddotWidth: number;
4757 4758
		readonly maxDigitWidth: number;
	}
4759

4760 4761 4762 4763 4764 4765
	export class BareFontInfo {
		readonly _bareFontInfoBrand: void;
		readonly zoomLevel: number;
		readonly fontFamily: string;
		readonly fontWeight: string;
		readonly fontSize: number;
4766
		readonly fontFeatureSettings: string;
4767
		readonly lineHeight: number;
4768
		readonly letterSpacing: number;
4769
	}
4770 4771 4772 4773

	//compatibility:
	export type IReadOnlyModel = ITextModel;
	export type IModel = ITextModel;
4774
}
A
Alex Dima 已提交
4775

A
Alex Dima 已提交
4776
declare namespace monaco.languages {
A
Alex Dima 已提交
4777 4778


4779 4780 4781 4782 4783 4784 4785 4786 4787 4788
	/**
	 * Register information about a new language.
	 */
	export function register(language: ILanguageExtensionPoint): void;

	/**
	 * Get the information of all the registered languages.
	 */
	export function getLanguages(): ILanguageExtensionPoint[];

M
Martin Aeschlimann 已提交
4789
	export function getEncodedLanguageId(languageId: string): number;
M
Martin Aeschlimann 已提交
4790

4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824
	/**
	 * An event emitted when a language is first time needed (e.g. a model has it set).
	 * @event
	 */
	export function onLanguage(languageId: string, callback: () => void): IDisposable;

	/**
	 * Set the editing configuration for a language.
	 */
	export function setLanguageConfiguration(languageId: string, configuration: LanguageConfiguration): IDisposable;

	/**
	 * A token.
	 */
	export interface IToken {
		startIndex: number;
		scopes: string;
	}

	/**
	 * The result of a line tokenization.
	 */
	export interface ILineTokens {
		/**
		 * The list of tokens on the line.
		 */
		tokens: IToken[];
		/**
		 * The tokenization end state.
		 * A pointer will be held to this and the object should not be modified by the tokenizer after the pointer is returned.
		 */
		endState: IState;
	}

M
Martin Aeschlimann 已提交
4825 4826 4827
	/**
	 * The result of a line tokenization.
	 */
M
Martin Aeschlimann 已提交
4828
	export interface IEncodedLineTokens {
M
Martin Aeschlimann 已提交
4829
		/**
M
Martin Aeschlimann 已提交
4830
		 * The tokens on the line in a binary, encoded format. Each token occupies two array indices. For token i:
M
Martin Aeschlimann 已提交
4831 4832 4833 4834 4835 4836 4837 4838 4839
		 *  - at offset 2*i => startIndex
		 *  - at offset 2*i + 1 => metadata
		 * Meta data is in binary format:
		 * - -------------------------------------------
		 *     3322 2222 2222 1111 1111 1100 0000 0000
		 *     1098 7654 3210 9876 5432 1098 7654 3210
		 * - -------------------------------------------
		 *     bbbb bbbb bfff ffff ffFF FTTT LLLL LLLL
		 * - -------------------------------------------
M
Martin Aeschlimann 已提交
4840 4841 4842 4843 4844 4845
		 *  - L = EncodedLanguageId (8 bits): Use `getEncodedLanguageId` to get the encoded ID of a language.
		 *  - T = StandardTokenType (3 bits): Other = 0, Comment = 1, String = 2, RegEx = 4.
		 *  - F = FontStyle (3 bits): None = 0, Italic = 1, Bold = 2, Underline = 4.
		 *  - f = foreground ColorId (9 bits)
		 *  - b = background ColorId (9 bits)
		 *  - The color value for each colorId is defined in IStandaloneThemeData.customTokenColors:
4846
		 * e.g. colorId = 1 is stored in IStandaloneThemeData.customTokenColors[1]. Color id = 0 means no color,
M
Martin Aeschlimann 已提交
4847
		 * id = 1 is for the default foreground color, id = 2 for the default background.
M
Martin Aeschlimann 已提交
4848 4849 4850 4851 4852 4853 4854 4855 4856
		 */
		tokens: Uint32Array;
		/**
		 * The tokenization end state.
		 * A pointer will be held to this and the object should not be modified by the tokenizer after the pointer is returned.
		 */
		endState: IState;
	}

4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870
	/**
	 * A "manual" provider of tokens.
	 */
	export interface TokensProvider {
		/**
		 * The initial state of a language. Will be the state passed in to tokenize the first line.
		 */
		getInitialState(): IState;
		/**
		 * Tokenize a line given the state at the beginning of the line.
		 */
		tokenize(line: string, state: IState): ILineTokens;
	}

M
Martin Aeschlimann 已提交
4871 4872 4873
	/**
	 * A "manual" provider of tokens, returning tokens in a binary form.
	 */
M
Martin Aeschlimann 已提交
4874
	export interface EncodedTokensProvider {
M
Martin Aeschlimann 已提交
4875 4876 4877 4878 4879 4880 4881
		/**
		 * The initial state of a language. Will be the state passed in to tokenize the first line.
		 */
		getInitialState(): IState;
		/**
		 * Tokenize a line given the state at the beginning of the line.
		 */
M
Martin Aeschlimann 已提交
4882
		tokenizeEncoded(line: string, state: IState): IEncodedLineTokens;
M
Martin Aeschlimann 已提交
4883 4884
	}

4885 4886 4887
	/**
	 * Set the tokens provider for a language (manual implementation).
	 */
4888
	export function setTokensProvider(languageId: string, provider: TokensProvider | EncodedTokensProvider | Thenable<TokensProvider | EncodedTokensProvider>): IDisposable;
M
Martin Aeschlimann 已提交
4889

4890 4891 4892
	/**
	 * Set the tokens provider for a language (monarch implementation).
	 */
4893
	export function setMonarchTokensProvider(languageId: string, languageDef: IMonarchLanguage | Thenable<IMonarchLanguage>): IDisposable;
4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905

	/**
	 * Register a reference provider (used by e.g. reference search).
	 */
	export function registerReferenceProvider(languageId: string, provider: ReferenceProvider): IDisposable;

	/**
	 * Register a rename provider (used by e.g. rename symbol).
	 */
	export function registerRenameProvider(languageId: string, provider: RenameProvider): IDisposable;

	/**
A
Alex Dima 已提交
4906
	 * Register a signature help provider (used by e.g. parameter hints).
4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920
	 */
	export function registerSignatureHelpProvider(languageId: string, provider: SignatureHelpProvider): IDisposable;

	/**
	 * Register a hover provider (used by e.g. editor hover).
	 */
	export function registerHoverProvider(languageId: string, provider: HoverProvider): IDisposable;

	/**
	 * Register a document symbol provider (used by e.g. outline).
	 */
	export function registerDocumentSymbolProvider(languageId: string, provider: DocumentSymbolProvider): IDisposable;

	/**
4921
	 * Register a document highlight provider (used by e.g. highlight occurrences).
4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974
	 */
	export function registerDocumentHighlightProvider(languageId: string, provider: DocumentHighlightProvider): IDisposable;

	/**
	 * Register a definition provider (used by e.g. go to definition).
	 */
	export function registerDefinitionProvider(languageId: string, provider: DefinitionProvider): IDisposable;

	/**
	 * Register a implementation provider (used by e.g. go to implementation).
	 */
	export function registerImplementationProvider(languageId: string, provider: ImplementationProvider): IDisposable;

	/**
	 * Register a type definition provider (used by e.g. go to type definition).
	 */
	export function registerTypeDefinitionProvider(languageId: string, provider: TypeDefinitionProvider): IDisposable;

	/**
	 * Register a code lens provider (used by e.g. inline code lenses).
	 */
	export function registerCodeLensProvider(languageId: string, provider: CodeLensProvider): IDisposable;

	/**
	 * Register a code action provider (used by e.g. quick fix).
	 */
	export function registerCodeActionProvider(languageId: string, provider: CodeActionProvider): IDisposable;

	/**
	 * Register a formatter that can handle only entire models.
	 */
	export function registerDocumentFormattingEditProvider(languageId: string, provider: DocumentFormattingEditProvider): IDisposable;

	/**
	 * Register a formatter that can handle a range inside a model.
	 */
	export function registerDocumentRangeFormattingEditProvider(languageId: string, provider: DocumentRangeFormattingEditProvider): IDisposable;

	/**
	 * Register a formatter than can do formatting as the user types.
	 */
	export function registerOnTypeFormattingEditProvider(languageId: string, provider: OnTypeFormattingEditProvider): IDisposable;

	/**
	 * Register a link provider that can find links in text.
	 */
	export function registerLinkProvider(languageId: string, provider: LinkProvider): IDisposable;

	/**
	 * Register a completion item provider (use by e.g. suggestions).
	 */
	export function registerCompletionItemProvider(languageId: string, provider: CompletionItemProvider): IDisposable;

R
rebornix 已提交
4975 4976 4977 4978 4979
	/**
	 * Register a document color provider (used by Color Picker, Color Decorator).
	 */
	export function registerColorProvider(languageId: string, provider: DocumentColorProvider): IDisposable;

4980
	/**
4981
	 * Register a folding range provider
4982
	 */
4983 4984
	export function registerFoldingRangeProvider(languageId: string, provider: FoldingRangeProvider): IDisposable;

4985 4986 4987 4988 4989 4990 4991 4992 4993 4994
	/**
	 * Register a declaration provider
	 */
	export function registerDeclarationProvider(languageId: string, provider: DeclarationProvider): IDisposable;

	/**
	 * Register a selection range provider
	 */
	export function registerSelectionRangeProvider(languageId: string, provider: SelectionRangeProvider): IDisposable;

A
Alex Dima 已提交
4995 4996 4997 4998 4999 5000 5001 5002 5003 5004
	/**
	 * Register a document semantic tokens provider
	 */
	export function registerDocumentSemanticTokensProvider(languageId: string, provider: DocumentSemanticTokensProvider): IDisposable;

	/**
	 * Register a document range semantic tokens provider
	 */
	export function registerDocumentRangeSemanticTokensProvider(languageId: string, provider: DocumentRangeSemanticTokensProvider): IDisposable;

5005 5006 5007 5008 5009 5010 5011 5012 5013
	/**
	 * Contains additional diagnostic information about the context in which
	 * a [code action](#CodeActionProvider.provideCodeActions) is run.
	 */
	export interface CodeActionContext {
		/**
		 * An array of diagnostics.
		 */
		readonly markers: editor.IMarkerData[];
5014 5015 5016 5017
		/**
		 * Requested kind of actions to return.
		 */
		readonly only?: string;
5018 5019 5020 5021 5022 5023 5024 5025 5026 5027
	}

	/**
	 * The code action interface defines the contract between extensions and
	 * the [light bulb](https://code.visualstudio.com/docs/editor/editingevolved#_code-action) feature.
	 */
	export interface CodeActionProvider {
		/**
		 * Provide commands for the given document and range.
		 */
5028
		provideCodeActions(model: editor.ITextModel, range: Range, context: CodeActionContext, token: CancellationToken): ProviderResult<CodeActionList>;
5029 5030 5031 5032 5033 5034 5035 5036 5037
	}

	/**
	 * Describes how comments for a language work.
	 */
	export interface CommentRule {
		/**
		 * The line comment token, like `// this is a comment`
		 */
A
Alex Dima 已提交
5038
		lineComment?: string | null;
5039 5040 5041
		/**
		 * The block comment character pair, like `/* block comment *&#47;`
		 */
A
Alex Dima 已提交
5042
		blockComment?: CharacterPair | null;
5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085
	}

	/**
	 * The language configuration interface defines the contract between extensions and
	 * various editor features, like automatic bracket insertion, automatic indentation etc.
	 */
	export interface LanguageConfiguration {
		/**
		 * The language's comment settings.
		 */
		comments?: CommentRule;
		/**
		 * The language's brackets.
		 * This configuration implicitly affects pressing Enter around these brackets.
		 */
		brackets?: CharacterPair[];
		/**
		 * The language's word definition.
		 * If the language supports Unicode identifiers (e.g. JavaScript), it is preferable
		 * to provide a word definition that uses exclusion of known separators.
		 * e.g.: A regex that matches anything except known separators (and dot is allowed to occur in a floating point number):
		 *   /(-?\d*\.\d\w*)|([^\`\~\!\@\#\%\^\&\*\(\)\-\=\+\[\{\]\}\\\|\;\:\'\"\,\.\<\>\/\?\s]+)/g
		 */
		wordPattern?: RegExp;
		/**
		 * The language's indentation settings.
		 */
		indentationRules?: IndentationRule;
		/**
		 * The language's rules to be evaluated when pressing Enter.
		 */
		onEnterRules?: OnEnterRule[];
		/**
		 * The language's auto closing pairs. The 'close' character is automatically inserted with the
		 * 'open' character is typed. If not set, the configured brackets will be used.
		 */
		autoClosingPairs?: IAutoClosingPairConditional[];
		/**
		 * The language's surrounding pairs. When the 'open' character is typed on a selection, the
		 * selected string is surrounded by the open and close characters. If not set, the autoclosing pairs
		 * settings will be used.
		 */
		surroundingPairs?: IAutoClosingPair[];
J
Jackson Kearl 已提交
5086 5087 5088 5089 5090 5091
		/**
		 * Defines what characters must be after the cursor for bracket or quote autoclosing to occur when using the \'languageDefined\' autoclosing setting.
		 *
		 * This is typically the set of characters which can not start an expression, such as whitespace, closing brackets, non-unary operators, etc.
		 */
		autoCloseBefore?: string;
5092 5093 5094 5095
		/**
		 * The language's folding rules.
		 */
		folding?: FoldingRules;
5096 5097 5098 5099 5100
		/**
		 * **Deprecated** Do not use.
		 *
		 * @deprecated Will be replaced by a better API soon.
		 */
5101 5102 5103
		__electricCharacterSupport?: {
			docComment?: IDocComment;
		};
5104 5105 5106 5107 5108 5109 5110
	}

	/**
	 * Describes indentation rules for a language.
	 */
	export interface IndentationRule {
		/**
A
Alex Dima 已提交
5111
		 * If a line matches this pattern, then all the lines after it should be unindented once (until another rule matches).
5112 5113 5114 5115 5116 5117 5118 5119 5120
		 */
		decreaseIndentPattern: RegExp;
		/**
		 * If a line matches this pattern, then all the lines after it should be indented once (until another rule matches).
		 */
		increaseIndentPattern: RegExp;
		/**
		 * If a line matches this pattern, then **only the next line** after it should be indented once.
		 */
A
Alex Dima 已提交
5121
		indentNextLinePattern?: RegExp | null;
5122 5123 5124
		/**
		 * If a line matches this pattern, then its indentation should not be changed and it should not be evaluated against the other rules.
		 */
A
Alex Dima 已提交
5125
		unIndentedLinePattern?: RegExp | null;
5126 5127
	}

5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138
	/**
	 * Describes language specific folding markers such as '#region' and '#endregion'.
	 * The start and end regexes will be tested against the contents of all lines and must be designed efficiently:
	 * - the regex should start with '^'
	 * - regexp flags (i, g) are ignored
	 */
	export interface FoldingMarkers {
		start: RegExp;
		end: RegExp;
	}

5139 5140 5141 5142
	/**
	 * Describes folding rules for a language.
	 */
	export interface FoldingRules {
5143
		/**
A
Alex Dima 已提交
5144
		 * Used by the indentation based strategy to decide whether empty lines belong to the previous or the next block.
5145 5146 5147 5148 5149
		 * A language adheres to the off-side rule if blocks in that language are expressed by their indentation.
		 * See [wikipedia](https://en.wikipedia.org/wiki/Off-side_rule) for more information.
		 * If not set, `false` is used and empty lines belong to the previous block.
		 */
		offSide?: boolean;
5150 5151 5152 5153
		/**
		 * Region markers used by the language.
		 */
		markers?: FoldingMarkers;
5154 5155
	}

5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167
	/**
	 * Describes a rule to be evaluated when pressing Enter.
	 */
	export interface OnEnterRule {
		/**
		 * This rule will only execute if the text before the cursor matches this regular expression.
		 */
		beforeText: RegExp;
		/**
		 * This rule will only execute if the text after the cursor matches this regular expression.
		 */
		afterText?: RegExp;
5168 5169 5170 5171
		/**
		 * This rule will only execute if the text above the this line matches this regular expression.
		 */
		oneLineAboveText?: RegExp;
5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188
		/**
		 * The action to execute.
		 */
		action: EnterAction;
	}

	/**
	 * Definition of documentation comments (e.g. Javadoc/JSdoc)
	 */
	export interface IDocComment {
		/**
		 * The string that starts a doc comment (e.g. '/**')
		 */
		open: string;
		/**
		 * The string that appears on the last line and closes the doc comment (e.g. ' * /').
		 */
5189
		close?: string;
5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227
	}

	/**
	 * A tuple of two characters, like a pair of
	 * opening and closing brackets.
	 */
	export type CharacterPair = [string, string];

	export interface IAutoClosingPair {
		open: string;
		close: string;
	}

	export interface IAutoClosingPairConditional extends IAutoClosingPair {
		notIn?: string[];
	}

	/**
	 * Describes what to do with the indentation when pressing Enter.
	 */
	export enum IndentAction {
		/**
		 * Insert new line and copy the previous line's indentation.
		 */
		None = 0,
		/**
		 * Insert new line and indent once (relative to the previous line's indentation).
		 */
		Indent = 1,
		/**
		 * Insert two new lines:
		 *  - the first one indented which will hold the cursor
		 *  - the second one at the same indentation level
		 */
		IndentOutdent = 2,
		/**
		 * Insert new line and outdent once (relative to the previous line's indentation).
		 */
R
Rob Lourens 已提交
5228
		Outdent = 3
5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258
	}

	/**
	 * Describes what to do when pressing Enter.
	 */
	export interface EnterAction {
		/**
		 * Describe what to do with the indentation.
		 */
		indentAction: IndentAction;
		/**
		 * Describes text to be appended after the new line and after the indentation.
		 */
		appendText?: string;
		/**
		 * Describes the number of characters to remove from the new line's indentation.
		 */
		removeText?: number;
	}

	/**
	 * The state of the tokenizer between two lines.
	 * It is useful to store flags such as in multiline comment, etc.
	 * The model will clone the previous line's state and pass it in to tokenize the next line.
	 */
	export interface IState {
		clone(): IState;
		equals(other: IState): boolean;
	}

5259 5260 5261 5262 5263 5264 5265 5266
	/**
	 * A provider result represents the values a provider, like the [`HoverProvider`](#HoverProvider),
	 * may return. For once this is the actual result type `T`, like `Hover`, or a thenable that resolves
	 * to that type `T`. In addition, `null` and `undefined` can be returned - either directly or from a
	 * thenable.
	 */
	export type ProviderResult<T> = T | undefined | null | Thenable<T | undefined | null>;

5267 5268 5269 5270 5271 5272 5273 5274
	/**
	 * A hover represents additional information for a symbol or word. Hovers are
	 * rendered in a tooltip-like widget.
	 */
	export interface Hover {
		/**
		 * The contents of this hover.
		 */
5275
		contents: IMarkdownString[];
5276 5277 5278 5279 5280
		/**
		 * The range to which this hover applies. When missing, the
		 * editor will use the range at the current position or the
		 * current position itself.
		 */
A
Alex Dima 已提交
5281
		range?: IRange;
5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293
	}

	/**
	 * The hover provider interface defines the contract between extensions and
	 * the [hover](https://code.visualstudio.com/docs/editor/intellisense)-feature.
	 */
	export interface HoverProvider {
		/**
		 * Provide a hover for the given position and document. Multiple hovers at the same
		 * position will be merged by the editor. A hover can have a range which defaults
		 * to the word range at the position when omitted.
		 */
5294
		provideHover(model: editor.ITextModel, position: Position, token: CancellationToken): ProviderResult<Hover>;
5295 5296
	}

5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321
	/**
	 * An evaluatable expression represents additional information for an expression in a document. Evaluatable expression are
	 * evaluated by a debugger or runtime and their result is rendered in a tooltip-like widget.
	 */
	export interface EvaluatableExpression {
		/**
		 * The range to which this expression applies.
		 */
		range: IRange;
		expression?: string;
	}

	/**
	 * The hover provider interface defines the contract between extensions and
	 * the [hover](https://code.visualstudio.com/docs/editor/intellisense)-feature.
	 */
	export interface EvaluatableExpressionProvider {
		/**
		 * Provide a hover for the given position and document. Multiple hovers at the same
		 * position will be merged by the editor. A hover can have a range which defaults
		 * to the word range at the position when omitted.
		 */
		provideEvaluatableExpression(model: editor.ITextModel, position: Position, token: CancellationToken): ProviderResult<EvaluatableExpression>;
	}

5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340
	export enum CompletionItemKind {
		Method = 0,
		Function = 1,
		Constructor = 2,
		Field = 3,
		Variable = 4,
		Class = 5,
		Struct = 6,
		Interface = 7,
		Module = 8,
		Property = 9,
		Event = 10,
		Operator = 11,
		Unit = 12,
		Value = 13,
		Constant = 14,
		Enum = 15,
		EnumMember = 16,
		Keyword = 17,
J
Johannes Rieken 已提交
5341 5342 5343 5344 5345 5346 5347 5348
		Text = 18,
		Color = 19,
		File = 20,
		Reference = 21,
		Customcolor = 22,
		Folder = 23,
		TypeParameter = 24,
		Snippet = 25
5349 5350
	}

5351 5352
	export interface CompletionItemLabel {
		/**
P
Pine Wu 已提交
5353
		 * The function or variable. Rendered leftmost.
5354
		 */
P
Pine Wu 已提交
5355
		name: string;
5356
		/**
P
Pine Wu 已提交
5357
		 * The signature without the return type. Render after `name`.
P
Pine Wu 已提交
5358 5359 5360
		 */
		signature?: string;
		/**
P
Pine Wu 已提交
5361
		 * The fully qualified name, like package name or file path. Rendered after `signature`.
P
Pine Wu 已提交
5362 5363 5364
		 */
		qualifier?: string;
		/**
P
Pine Wu 已提交
5365
		 * The return-type of a function or type of a property/variable. Rendered rightmost.
5366
		 */
P
Pine Wu 已提交
5367
		type?: string;
5368 5369
	}

5370
	export enum CompletionItemTag {
5371 5372 5373
		Deprecated = 1
	}

5374 5375
	export enum CompletionItemInsertTextRule {
		/**
J
Johannes Rieken 已提交
5376 5377
		 * Adjust whitespace/indentation of multiline insert texts to
		 * match the current line indentation.
5378
		 */
5379
		KeepWhitespace = 1,
5380
		/**
5381
		 * `insertText` is a snippet.
5382
		 */
5383
		InsertAsSnippet = 4
5384 5385
	}

5386 5387 5388 5389 5390 5391 5392 5393 5394 5395
	/**
	 * A completion item represents a text snippet that is
	 * proposed to complete text that is being typed.
	 */
	export interface CompletionItem {
		/**
		 * The label of this completion item. By default
		 * this is also the text that is inserted when selecting
		 * this completion.
		 */
5396
		label: string | CompletionItemLabel;
5397 5398 5399 5400 5401
		/**
		 * The kind of this completion item. Based on the kind
		 * an icon is chosen by the editor.
		 */
		kind: CompletionItemKind;
5402
		/**
5403 5404
		 * A modifier to the `kind` which affect how the item
		 * is rendered, e.g. Deprecated is rendered with a strikeout
5405
		 */
5406
		tags?: ReadonlyArray<CompletionItemTag>;
5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427
		/**
		 * A human-readable string with additional information
		 * about this item, like type or symbol information.
		 */
		detail?: string;
		/**
		 * A human-readable string that represents a doc-comment.
		 */
		documentation?: string | IMarkdownString;
		/**
		 * A string that should be used when comparing this item
		 * with other items. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
		sortText?: string;
		/**
		 * A string that should be used when filtering a set of
		 * completion items. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
		filterText?: string;
J
Johannes Rieken 已提交
5428 5429 5430 5431 5432
		/**
		 * Select this item when showing. *Note* that only one completion item can be selected and
		 * that the editor decides which item that is. The rule is that the *first* item of those
		 * that match best is selected.
		 */
5433 5434 5435
		preselect?: boolean;
		/**
		 * A string or snippet that should be inserted in a document when selecting
5436
		 * this completion. When `falsy` the [label](#CompletionItem.label)
5437 5438
		 * is used.
		 */
5439
		insertText: string;
5440
		/**
5441 5442
		 * Addition rules (as bitmask) that should be applied when inserting
		 * this completion.
5443
		 */
5444
		insertTextRules?: CompletionItemInsertTextRule;
5445 5446 5447 5448 5449 5450 5451 5452 5453
		/**
		 * A range of text that should be replaced by this completion item.
		 *
		 * Defaults to a range from the start of the [current word](#TextDocument.getWordRangeAtPosition) to the
		 * current position.
		 *
		 * *Note:* The range must be a [single line](#Range.isSingleLine) and it must
		 * [contain](#Range.contains) the position at which completion has been [requested](#CompletionItemProvider.provideCompletionItems).
		 */
J
Johannes Rieken 已提交
5454 5455 5456 5457
		range: IRange | {
			insert: IRange;
			replace: IRange;
		};
5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479
		/**
		 * An optional set of characters that when pressed while this completion is active will accept it first and
		 * then type that character. *Note* that all commit characters should have `length=1` and that superfluous
		 * characters will be ignored.
		 */
		commitCharacters?: string[];
		/**
		 * An optional array of additional text edits that are applied when
		 * selecting this completion. Edits must not overlap with the main edit
		 * nor with themselves.
		 */
		additionalTextEdits?: editor.ISingleEditOperation[];
		/**
		 * A command that should be run upon acceptance of this item.
		 */
		command?: Command;
	}

	export interface CompletionList {
		suggestions: CompletionItem[];
		incomplete?: boolean;
		dispose?(): void;
5480 5481
	}

M
Matt Bierner 已提交
5482 5483 5484
	/**
	 * How a suggest provider was triggered.
	 */
5485
	export enum CompletionTriggerKind {
M
Matt Bierner 已提交
5486 5487
		Invoke = 0,
		TriggerCharacter = 1,
R
Rob Lourens 已提交
5488
		TriggerForIncompleteCompletions = 2
M
Matt Bierner 已提交
5489 5490
	}

5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533
	/**
	 * Contains additional information about the context in which
	 * [completion provider](#CompletionItemProvider.provideCompletionItems) is triggered.
	 */
	export interface CompletionContext {
		/**
		 * How the completion was triggered.
		 */
		triggerKind: CompletionTriggerKind;
		/**
		 * Character that triggered the completion item provider.
		 *
		 * `undefined` if provider was not triggered by a character.
		 */
		triggerCharacter?: string;
	}

	/**
	 * The completion item provider interface defines the contract between extensions and
	 * the [IntelliSense](https://code.visualstudio.com/docs/editor/intellisense).
	 *
	 * When computing *complete* completion items is expensive, providers can optionally implement
	 * the `resolveCompletionItem`-function. In that case it is enough to return completion
	 * items with a [label](#CompletionItem.label) from the
	 * [provideCompletionItems](#CompletionItemProvider.provideCompletionItems)-function. Subsequently,
	 * when a completion item is shown in the UI and gains focus this provider is asked to resolve
	 * the item, like adding [doc-comment](#CompletionItem.documentation) or [details](#CompletionItem.detail).
	 */
	export interface CompletionItemProvider {
		triggerCharacters?: string[];
		/**
		 * Provide completion items for the given position and document.
		 */
		provideCompletionItems(model: editor.ITextModel, position: Position, context: CompletionContext, token: CancellationToken): ProviderResult<CompletionList>;
		/**
		 * Given a completion item fill in more data, like [doc-comment](#CompletionItem.documentation)
		 * or [details](#CompletionItem.detail).
		 *
		 * The editor will only resolve a completion item once.
		 */
		resolveCompletionItem?(model: editor.ITextModel, position: Position, item: CompletionItem, token: CancellationToken): ProviderResult<CompletionItem>;
	}

5534 5535 5536
	export interface CodeAction {
		title: string;
		command?: Command;
5537
		edit?: WorkspaceEdit;
5538
		diagnostics?: editor.IMarkerData[];
5539
		kind?: string;
5540
		isPreferred?: boolean;
M
Matt Bierner 已提交
5541
		disabled?: string;
5542 5543
	}

5544 5545 5546 5547
	export interface CodeActionList extends IDisposable {
		readonly actions: ReadonlyArray<CodeAction>;
	}

5548 5549 5550 5551 5552 5553 5554 5555 5556
	/**
	 * Represents a parameter of a callable-signature. A parameter can
	 * have a label and a doc-comment.
	 */
	export interface ParameterInformation {
		/**
		 * The label of this signature. Will be shown in
		 * the UI.
		 */
5557
		label: string | [number, number];
5558 5559 5560 5561
		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
B
Benjamin Pasero 已提交
5562
		documentation?: string | IMarkdownString;
5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579
	}

	/**
	 * Represents the signature of something callable. A signature
	 * can have a label, like a function-name, a doc-comment, and
	 * a set of parameters.
	 */
	export interface SignatureInformation {
		/**
		 * The label of this signature. Will be shown in
		 * the UI.
		 */
		label: string;
		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
B
Benjamin Pasero 已提交
5580
		documentation?: string | IMarkdownString;
5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606
		/**
		 * The parameters of this signature.
		 */
		parameters: ParameterInformation[];
	}

	/**
	 * Signature help represents the signature of something
	 * callable. There can be multiple signatures but only one
	 * active and only one active parameter.
	 */
	export interface SignatureHelp {
		/**
		 * One or more signatures.
		 */
		signatures: SignatureInformation[];
		/**
		 * The active signature.
		 */
		activeSignature: number;
		/**
		 * The active parameter of the active signature.
		 */
		activeParameter: number;
	}

5607 5608 5609 5610
	export interface SignatureHelpResult extends IDisposable {
		value: SignatureHelp;
	}

M
Matt Bierner 已提交
5611
	export enum SignatureHelpTriggerKind {
5612 5613
		Invoke = 1,
		TriggerCharacter = 2,
5614
		ContentChange = 3
5615 5616 5617
	}

	export interface SignatureHelpContext {
5618
		readonly triggerKind: SignatureHelpTriggerKind;
5619 5620
		readonly triggerCharacter?: string;
		readonly isRetrigger: boolean;
5621
		readonly activeSignatureHelp?: SignatureHelp;
5622 5623
	}

5624 5625 5626 5627 5628
	/**
	 * The signature help provider interface defines the contract between extensions and
	 * the [parameter hints](https://code.visualstudio.com/docs/editor/intellisense)-feature.
	 */
	export interface SignatureHelpProvider {
A
Alex Dima 已提交
5629 5630
		readonly signatureHelpTriggerCharacters?: ReadonlyArray<string>;
		readonly signatureHelpRetriggerCharacters?: ReadonlyArray<string>;
5631 5632 5633
		/**
		 * Provide help for the signature at the given position and document.
		 */
5634
		provideSignatureHelp(model: editor.ITextModel, position: Position, token: CancellationToken, context: SignatureHelpContext): ProviderResult<SignatureHelpResult>;
5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651
	}

	/**
	 * A document highlight kind.
	 */
	export enum DocumentHighlightKind {
		/**
		 * A textual occurrence.
		 */
		Text = 0,
		/**
		 * Read-access of a symbol, like reading a variable.
		 */
		Read = 1,
		/**
		 * Write-access of a symbol, like writing to a variable.
		 */
R
Rob Lourens 已提交
5652
		Write = 2
5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667
	}

	/**
	 * A document highlight is a range inside a text document which deserves
	 * special attention. Usually a document highlight is visualized by changing
	 * the background color of its range.
	 */
	export interface DocumentHighlight {
		/**
		 * The range this highlight applies to.
		 */
		range: IRange;
		/**
		 * The highlight kind, default is [text](#DocumentHighlightKind.Text).
		 */
5668
		kind?: DocumentHighlightKind;
5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679
	}

	/**
	 * The document highlight provider interface defines the contract between extensions and
	 * the word-highlight-feature.
	 */
	export interface DocumentHighlightProvider {
		/**
		 * Provide a set of document highlights, like all occurrences of a variable or
		 * all exit-points of a function.
		 */
5680
		provideDocumentHighlights(model: editor.ITextModel, position: Position, token: CancellationToken): ProviderResult<DocumentHighlight[]>;
5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701
	}

	/**
	 * Value-object that contains additional information when
	 * requesting references.
	 */
	export interface ReferenceContext {
		/**
		 * Include the declaration of the current symbol.
		 */
		includeDeclaration: boolean;
	}

	/**
	 * The reference provider interface defines the contract between extensions and
	 * the [find references](https://code.visualstudio.com/docs/editor/editingevolved#_peek)-feature.
	 */
	export interface ReferenceProvider {
		/**
		 * Provide a set of project-wide references for the given position and document.
		 */
5702
		provideReferences(model: editor.ITextModel, position: Position, context: ReferenceContext, token: CancellationToken): ProviderResult<Location[]>;
5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719
	}

	/**
	 * Represents a location inside a resource, such as a line
	 * inside a text file.
	 */
	export interface Location {
		/**
		 * The resource identifier of this location.
		 */
		uri: Uri;
		/**
		 * The document range of this locations.
		 */
		range: IRange;
	}

J
Johannes Rieken 已提交
5720 5721 5722 5723 5724 5725 5726 5727
	export interface LocationLink {
		/**
		 * A range to select where this link originates from.
		 */
		originSelectionRange?: IRange;
		/**
		 * The target uri this link points to.
		 */
M
Matt Bierner 已提交
5728
		uri: Uri;
J
Johannes Rieken 已提交
5729 5730 5731
		/**
		 * The full range this link points to.
		 */
M
Matt Bierner 已提交
5732
		range: IRange;
J
Johannes Rieken 已提交
5733 5734 5735 5736 5737
		/**
		 * A range to select this link points to. Must be contained
		 * in `LocationLink.range`.
		 */
		targetSelectionRange?: IRange;
M
Matt Bierner 已提交
5738 5739
	}

J
Johannes Rieken 已提交
5740 5741
	export type Definition = Location | Location[] | LocationLink[];

5742 5743 5744 5745 5746 5747 5748 5749 5750
	/**
	 * The definition provider interface defines the contract between extensions and
	 * the [go to definition](https://code.visualstudio.com/docs/editor/editingevolved#_go-to-definition)
	 * and peek definition features.
	 */
	export interface DefinitionProvider {
		/**
		 * Provide the definition of the symbol at the given position and document.
		 */
J
Johannes Rieken 已提交
5751
		provideDefinition(model: editor.ITextModel, position: Position, token: CancellationToken): ProviderResult<Definition | LocationLink[]>;
5752 5753
	}

J
Johannes Rieken 已提交
5754 5755 5756 5757 5758 5759 5760 5761 5762
	/**
	 * The definition provider interface defines the contract between extensions and
	 * the [go to definition](https://code.visualstudio.com/docs/editor/editingevolved#_go-to-definition)
	 * and peek definition features.
	 */
	export interface DeclarationProvider {
		/**
		 * Provide the declaration of the symbol at the given position and document.
		 */
J
Johannes Rieken 已提交
5763
		provideDeclaration(model: editor.ITextModel, position: Position, token: CancellationToken): ProviderResult<Definition | LocationLink[]>;
J
Johannes Rieken 已提交
5764 5765
	}

5766 5767 5768 5769 5770 5771 5772 5773
	/**
	 * The implementation provider interface defines the contract between extensions and
	 * the go to implementation feature.
	 */
	export interface ImplementationProvider {
		/**
		 * Provide the implementation of the symbol at the given position and document.
		 */
J
Johannes Rieken 已提交
5774
		provideImplementation(model: editor.ITextModel, position: Position, token: CancellationToken): ProviderResult<Definition | LocationLink[]>;
5775 5776 5777 5778 5779 5780 5781 5782 5783 5784
	}

	/**
	 * The type definition provider interface defines the contract between extensions and
	 * the go to type definition feature.
	 */
	export interface TypeDefinitionProvider {
		/**
		 * Provide the type definition of the symbol at the given position and document.
		 */
J
Johannes Rieken 已提交
5785
		provideTypeDefinition(model: editor.ITextModel, position: Position, token: CancellationToken): ProviderResult<Definition | LocationLink[]>;
5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816
	}

	/**
	 * A symbol kind.
	 */
	export enum SymbolKind {
		File = 0,
		Module = 1,
		Namespace = 2,
		Package = 3,
		Class = 4,
		Method = 5,
		Property = 6,
		Field = 7,
		Constructor = 8,
		Enum = 9,
		Interface = 10,
		Function = 11,
		Variable = 12,
		Constant = 13,
		String = 14,
		Number = 15,
		Boolean = 16,
		Array = 17,
		Object = 18,
		Key = 19,
		Null = 20,
		EnumMember = 21,
		Struct = 22,
		Event = 23,
		Operator = 24,
R
Rob Lourens 已提交
5817
		TypeParameter = 25
5818 5819
	}

5820
	export enum SymbolTag {
5821 5822 5823
		Deprecated = 1
	}

5824
	export interface DocumentSymbol {
5825
		name: string;
5826
		detail: string;
5827
		kind: SymbolKind;
5828
		tags: ReadonlyArray<SymbolTag>;
5829
		containerName?: string;
5830 5831
		range: IRange;
		selectionRange: IRange;
5832
		children?: DocumentSymbol[];
5833 5834 5835 5836
	}

	/**
	 * The document symbol provider interface defines the contract between extensions and
L
Lars Hvam 已提交
5837
	 * the [go to symbol](https://code.visualstudio.com/docs/editor/editingevolved#_go-to-symbol)-feature.
5838 5839
	 */
	export interface DocumentSymbolProvider {
5840
		displayName?: string;
5841 5842 5843
		/**
		 * Provide symbol information for the given document.
		 */
5844
		provideDocumentSymbols(model: editor.ITextModel, token: CancellationToken): ProviderResult<DocumentSymbol[]>;
5845 5846
	}

A
Alex Dima 已提交
5847
	export type TextEdit = {
5848 5849 5850
		range: IRange;
		text: string;
		eol?: editor.EndOfLineSequence;
A
Alex Dima 已提交
5851
	};
5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871

	/**
	 * Interface used to format a model
	 */
	export interface FormattingOptions {
		/**
		 * Size of a tab in spaces.
		 */
		tabSize: number;
		/**
		 * Prefer spaces over tabs.
		 */
		insertSpaces: boolean;
	}

	/**
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
	 */
	export interface DocumentFormattingEditProvider {
J
Johannes Rieken 已提交
5872
		readonly displayName?: string;
5873 5874 5875
		/**
		 * Provide formatting edits for a whole document.
		 */
5876
		provideDocumentFormattingEdits(model: editor.ITextModel, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
5877 5878 5879 5880 5881 5882 5883
	}

	/**
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
	 */
	export interface DocumentRangeFormattingEditProvider {
J
Johannes Rieken 已提交
5884
		readonly displayName?: string;
5885 5886 5887 5888 5889 5890 5891
		/**
		 * Provide formatting edits for a range in a document.
		 *
		 * The given range is a hint and providers can decide to format a smaller
		 * or larger range. Often this is done by adjusting the start and end
		 * of the range to full syntax nodes.
		 */
5892
		provideDocumentRangeFormattingEdits(model: editor.ITextModel, range: Range, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907
	}

	/**
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
	 */
	export interface OnTypeFormattingEditProvider {
		autoFormatTriggerCharacters: string[];
		/**
		 * Provide formatting edits after a character has been typed.
		 *
		 * The given position and character should hint to the provider
		 * what range the position to expand to, like find the matching `{`
		 * when `}` has been entered.
		 */
5908
		provideOnTypeFormattingEdits(model: editor.ITextModel, position: Position, ch: string, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
5909 5910 5911 5912 5913 5914 5915
	}

	/**
	 * A link inside the editor.
	 */
	export interface ILink {
		range: IRange;
M
Martin Aeschlimann 已提交
5916
		url?: Uri | string;
5917
		tooltip?: string;
5918 5919
	}

5920 5921 5922
	export interface ILinksList {
		links: ILink[];
		dispose?(): void;
5923 5924 5925 5926 5927 5928
	}

	/**
	 * A provider of links.
	 */
	export interface LinkProvider {
5929
		provideLinks(model: editor.ITextModel, token: CancellationToken): ProviderResult<ILinksList>;
5930
		resolveLink?: (link: ILink, token: CancellationToken) => ProviderResult<ILink>;
5931 5932
	}

R
rebornix 已提交
5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955
	/**
	 * A color in RGBA format.
	 */
	export interface IColor {
		/**
		 * The red component in the range [0-1].
		 */
		readonly red: number;
		/**
		 * The green component in the range [0-1].
		 */
		readonly green: number;
		/**
		 * The blue component in the range [0-1].
		 */
		readonly blue: number;
		/**
		 * The alpha component in the range [0-1].
		 */
		readonly alpha: number;
	}

	/**
5956
	 * String representations for a color
R
rebornix 已提交
5957
	 */
5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974
	export interface IColorPresentation {
		/**
		 * The label of this color presentation. It will be shown on the color
		 * picker header. By default this is also the text that is inserted when selecting
		 * this color presentation.
		 */
		label: string;
		/**
		 * An [edit](#TextEdit) which is applied to a document when selecting
		 * this presentation for the color.
		 */
		textEdit?: TextEdit;
		/**
		 * An optional array of additional [text edits](#TextEdit) that are applied when
		 * selecting this color presentation.
		 */
		additionalTextEdits?: TextEdit[];
R
rebornix 已提交
5975 5976 5977 5978 5979
	}

	/**
	 * A color range is a range in a text model which represents a color.
	 */
5980
	export interface IColorInformation {
R
rebornix 已提交
5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997
		/**
		 * The range within the model.
		 */
		range: IRange;
		/**
		 * The color represented in this range.
		 */
		color: IColor;
	}

	/**
	 * A provider of colors for editor models.
	 */
	export interface DocumentColorProvider {
		/**
		 * Provides the color ranges for a specific model.
		 */
5998
		provideDocumentColors(model: editor.ITextModel, token: CancellationToken): ProviderResult<IColorInformation[]>;
B
Benjamin Pasero 已提交
5999
		/**
6000
		 * Provide the string representations for a color.
B
Benjamin Pasero 已提交
6001
		 */
6002
		provideColorPresentations(model: editor.ITextModel, colorInfo: IColorInformation, token: CancellationToken): ProviderResult<IColorPresentation[]>;
6003 6004
	}

6005 6006 6007 6008
	export interface SelectionRange {
		range: IRange;
	}

6009 6010 6011 6012
	export interface SelectionRangeProvider {
		/**
		 * Provide ranges that should be selected from the given position.
		 */
6013
		provideSelectionRanges(model: editor.ITextModel, positions: Position[], token: CancellationToken): ProviderResult<SelectionRange[][]>;
6014 6015
	}

6016 6017 6018 6019 6020 6021 6022 6023 6024 6025
	export interface FoldingContext {
	}

	/**
	 * A provider of colors for editor models.
	 */
	export interface FoldingRangeProvider {
		/**
		 * Provides the color ranges for a specific model.
		 */
6026
		provideFoldingRanges(model: editor.ITextModel, context: FoldingContext, token: CancellationToken): ProviderResult<FoldingRange[]>;
6027 6028 6029 6030
	}

	export interface FoldingRange {
		/**
6031
		 * The one-based start line of the range to fold. The folded area starts after the line's last character.
6032 6033 6034
		 */
		start: number;
		/**
6035
		 * The one-based end line of the range to fold. The folded area ends with the line's last character.
6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069
		 */
		end: number;
		/**
		 * Describes the [Kind](#FoldingRangeKind) of the folding range such as [Comment](#FoldingRangeKind.Comment) or
		 * [Region](#FoldingRangeKind.Region). The kind is used to categorize folding ranges and used by commands
		 * like 'Fold all comments'. See
		 * [FoldingRangeKind](#FoldingRangeKind) for an enumeration of standardized kinds.
		 */
		kind?: FoldingRangeKind;
	}

	export class FoldingRangeKind {
		value: string;
		/**
		 * Kind for folding range representing a comment. The value of the kind is 'comment'.
		 */
		static readonly Comment: FoldingRangeKind;
		/**
		 * Kind for folding range representing a import. The value of the kind is 'imports'.
		 */
		static readonly Imports: FoldingRangeKind;
		/**
		 * Kind for folding range representing regions (for example marked by `#region`, `#endregion`).
		 * The value of the kind is 'region'.
		 */
		static readonly Region: FoldingRangeKind;
		/**
		 * Creates a new [FoldingRangeKind](#FoldingRangeKind).
		 *
		 * @param value of the kind.
		 */
		constructor(value: string);
	}

6070 6071 6072 6073
	export interface WorkspaceEditMetadata {
		needsConfirmation: boolean;
		label: string;
		description?: string;
6074
		iconPath?: {
J
Johannes Rieken 已提交
6075
			id: string;
6076
		} | Uri | {
J
Johannes Rieken 已提交
6077 6078
			light: Uri;
			dark: Uri;
6079
		};
R
rebornix 已提交
6080 6081
	}

6082 6083 6084 6085 6086 6087 6088
	export interface WorkspaceFileEditOptions {
		overwrite?: boolean;
		ignoreIfNotExists?: boolean;
		ignoreIfExists?: boolean;
		recursive?: boolean;
	}

6089
	export interface WorkspaceFileEdit {
6090 6091
		oldUri?: Uri;
		newUri?: Uri;
6092 6093
		options?: WorkspaceFileEditOptions;
		metadata?: WorkspaceEditMetadata;
R
rebornix 已提交
6094 6095
	}

6096
	export interface WorkspaceTextEdit {
6097
		resource: Uri;
6098
		edit: TextEdit;
6099
		modelVersionId?: number;
6100
		metadata?: WorkspaceEditMetadata;
6101 6102 6103
	}

	export interface WorkspaceEdit {
6104
		edits: Array<WorkspaceTextEdit | WorkspaceFileEdit>;
6105 6106 6107
	}

	export interface Rejection {
6108 6109 6110
		rejectReason?: string;
	}

6111 6112 6113 6114 6115
	export interface RenameLocation {
		range: IRange;
		text: string;
	}

6116
	export interface RenameProvider {
6117
		provideRenameEdits(model: editor.ITextModel, position: Position, newName: string, token: CancellationToken): ProviderResult<WorkspaceEdit & Rejection>;
6118
		resolveRenameLocation?(model: editor.ITextModel, position: Position, token: CancellationToken): ProviderResult<RenameLocation & Rejection>;
6119 6120 6121 6122 6123 6124 6125 6126 6127
	}

	export interface Command {
		id: string;
		title: string;
		tooltip?: string;
		arguments?: any[];
	}

6128
	export interface CodeLens {
6129 6130 6131 6132 6133
		range: IRange;
		id?: string;
		command?: Command;
	}

6134 6135 6136 6137 6138
	export interface CodeLensList {
		lenses: CodeLens[];
		dispose(): void;
	}

6139 6140
	export interface CodeLensProvider {
		onDidChange?: IEvent<this>;
6141 6142
		provideCodeLenses(model: editor.ITextModel, token: CancellationToken): ProviderResult<CodeLensList>;
		resolveCodeLens?(model: editor.ITextModel, codeLens: CodeLens, token: CancellationToken): ProviderResult<CodeLens>;
6143 6144
	}

6145
	export interface SemanticTokensLegend {
A
wip  
Alexandru Dima 已提交
6146 6147 6148 6149
		readonly tokenTypes: string[];
		readonly tokenModifiers: string[];
	}

6150 6151
	export interface SemanticTokens {
		readonly resultId?: string;
A
wip  
Alexandru Dima 已提交
6152 6153 6154
		readonly data: Uint32Array;
	}

6155 6156 6157 6158 6159 6160 6161 6162 6163
	export interface SemanticTokensEdit {
		readonly start: number;
		readonly deleteCount: number;
		readonly data?: Uint32Array;
	}

	export interface SemanticTokensEdits {
		readonly resultId?: string;
		readonly edits: SemanticTokensEdit[];
A
wip  
Alexandru Dima 已提交
6164 6165
	}

6166
	export interface DocumentSemanticTokensProvider {
6167
		getLegend(): SemanticTokensLegend;
6168 6169 6170 6171 6172
		provideDocumentSemanticTokens(model: editor.ITextModel, lastResultId: string | null, token: CancellationToken): ProviderResult<SemanticTokens | SemanticTokensEdits>;
		releaseDocumentSemanticTokens(resultId: string | undefined): void;
	}

	export interface DocumentRangeSemanticTokensProvider {
6173
		getLegend(): SemanticTokensLegend;
6174
		provideDocumentRangeSemanticTokens(model: editor.ITextModel, range: Range, token: CancellationToken): ProviderResult<SemanticTokens>;
A
wip  
Alexandru Dima 已提交
6175 6176
	}

6177 6178 6179 6180 6181 6182 6183 6184
	export interface ILanguageExtensionPoint {
		id: string;
		extensions?: string[];
		filenames?: string[];
		filenamePatterns?: string[];
		firstLine?: string;
		aliases?: string[];
		mimetypes?: string[];
6185
		configuration?: Uri;
6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215
	}
	/**
	 * A Monarch language definition
	 */
	export interface IMonarchLanguage {
		/**
		 * map from string to ILanguageRule[]
		 */
		tokenizer: {
			[name: string]: IMonarchLanguageRule[];
		};
		/**
		 * is the language case insensitive?
		 */
		ignoreCase?: boolean;
		/**
		 * if no match in the tokenizer assign this token class (default 'source')
		 */
		defaultToken?: string;
		/**
		 * for example [['{','}','delimiter.curly']]
		 */
		brackets?: IMonarchLanguageBracket[];
		/**
		 * start symbol in the tokenizer (by default the first entry is used)
		 */
		start?: string;
		/**
		 * attach this to every token class (by default '.' + name)
		 */
A
Alex Dima 已提交
6216
		tokenPostfix?: string;
6217 6218 6219 6220 6221 6222 6223
	}

	/**
	 * A rule is either a regular expression and an action
	 * 		shorthands: [reg,act] == { regex: reg, action: act}
	 *		and       : [reg,act,nxt] == { regex: reg, action: act{ next: nxt }}
	 */
6224 6225 6226 6227
	export type IShortMonarchLanguageRule1 = [RegExp, IMonarchLanguageAction];

	export type IShortMonarchLanguageRule2 = [RegExp, IMonarchLanguageAction, string];

A
Alex Dima 已提交
6228
	export interface IExpandedMonarchLanguageRule {
6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242
		/**
		 * match tokens
		 */
		regex?: string | RegExp;
		/**
		 * action to take on match
		 */
		action?: IMonarchLanguageAction;
		/**
		 * or an include rule. include all rules from the included state
		 */
		include?: string;
	}

A
Alex Dima 已提交
6243 6244
	export type IMonarchLanguageRule = IShortMonarchLanguageRule1 | IShortMonarchLanguageRule2 | IExpandedMonarchLanguageRule;

6245 6246 6247 6248 6249
	/**
	 * An action is either an array of actions...
	 * ... or a case statement with guards...
	 * ... or a basic action with a token value.
	 */
6250 6251 6252
	export type IShortMonarchLanguageAction = string;

	export interface IExpandedMonarchLanguageAction {
6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281
		/**
		 * array of actions for each parenthesized match group
		 */
		group?: IMonarchLanguageAction[];
		/**
		 * map from string to ILanguageAction
		 */
		cases?: Object;
		/**
		 * token class (ie. css class) (or "@brackets" or "@rematch")
		 */
		token?: string;
		/**
		 * the next state to push, or "@push", "@pop", "@popall"
		 */
		next?: string;
		/**
		 * switch to this state
		 */
		switchTo?: string;
		/**
		 * go back n characters in the stream
		 */
		goBack?: number;
		/**
		 * @open or @close
		 */
		bracket?: string;
		/**
A
Alex Dima 已提交
6282
		 * switch to embedded language (using the mimetype) or get out using "@pop"
6283 6284 6285 6286 6287 6288 6289 6290
		 */
		nextEmbedded?: string;
		/**
		 * log a message to the browser console window
		 */
		log?: string;
	}

6291 6292
	export type IMonarchLanguageAction = IShortMonarchLanguageAction | IExpandedMonarchLanguageAction | IShortMonarchLanguageAction[] | IExpandedMonarchLanguageAction[];

6293 6294 6295 6296 6297 6298 6299 6300 6301
	/**
	 * This interface can be shortened as an array, ie. ['{','}','delimiter.curly']
	 */
	export interface IMonarchLanguageBracket {
		/**
		 * open bracket
		 */
		open: string;
		/**
A
Alex Dima 已提交
6302
		 * closing bracket
6303 6304 6305 6306 6307 6308 6309
		 */
		close: string;
		/**
		 * token class
		 */
		token: string;
	}
6310 6311 6312

}

A
Alex Dima 已提交
6313
declare namespace monaco.worker {
6314

6315

6316 6317 6318 6319 6320
	export interface IMirrorModel {
		readonly uri: Uri;
		readonly version: number;
		getValue(): string;
	}
6321

6322 6323 6324 6325 6326
	export interface IWorkerContext<H = undefined> {
		/**
		 * A proxy to the main thread host object.
		 */
		host: H;
6327 6328 6329 6330 6331
		/**
		 * Get all available mirror models in this worker.
		 */
		getMirrorModels(): IMirrorModel[];
	}
6332

6333
}
6334

6335
//dtsv=3