monaco.d.ts 161.4 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.
 *--------------------------------------------------------------------------------------------*/

A
Alex Dima 已提交
6
declare namespace monaco {
7

K
Kamran Ayub 已提交
8 9
	// THIS IS A GENERATED FILE. DO NOT EDIT DIRECTLY.

A
Alex Dima 已提交
10
	export type Thenable<T> = PromiseLike<T>;
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

	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>;
26
		fire(event: T): void;
27 28 29 30
		dispose(): void;
	}


31
	export enum MarkerTag {
32 33
		Unnecessary = 1,
		Deprecated = 2
34 35
	}

J
Johannes Rieken 已提交
36 37 38 39
	export enum MarkerSeverity {
		Hint = 1,
		Info = 2,
		Warning = 4,
40
		Error = 8
J
Johannes Rieken 已提交
41 42
	}

43
	export class CancellationTokenSource {
44
		constructor(parent?: CancellationToken);
M
Matt Bierner 已提交
45
		get token(): CancellationToken;
46
		cancel(): void;
47
		dispose(cancel?: boolean): void;
48 49 50 51 52 53 54 55 56 57 58 59
	}

	export interface CancellationToken {
		readonly isCancellationRequested: boolean;
		/**
		 * An event emitted when cancellation is requested
		 * @event
		 */
		readonly onCancellationRequested: IEvent<any>;
	}
	/**
	 * Uniform Resource Identifier (Uri) http://tools.ietf.org/html/rfc3986.
60
	 * This class is a simple parser which creates the basic component parts
61 62 63 64 65 66 67 68 69 70 71
	 * (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 已提交
72
	export class Uri implements UriComponents {
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
		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.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
		 * 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).
119
		 */
M
Matt Bierner 已提交
120
		get fsPath(): string;
121 122
		with(change: {
			scheme?: string;
123 124 125 126
			authority?: string | null;
			path?: string | null;
			query?: string | null;
			fragment?: string | null;
127
		}): Uri;
128 129 130 131 132 133
		/**
		 * 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 已提交
134
		static parse(value: string, _strict?: boolean): Uri;
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
		/**
		 * 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`)
		 */
156 157
		static file(path: string): Uri;
		static from(components: {
158
			scheme: string;
159 160 161 162 163 164
			authority?: string;
			path?: string;
			query?: string;
			fragment?: string;
		}): Uri;
		/**
J
Johannes Rieken 已提交
165
		 * Creates a string representation for this Uri. It's guaranteed that calling
166 167 168 169 170 171
		 * `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.
172 173 174 175
		 *
		 * @param skipEncoding Do not encode the result, default is `false`
		 */
		toString(skipEncoding?: boolean): string;
J
Johannes Rieken 已提交
176
		toJSON(): UriComponents;
J
Johannes Rieken 已提交
177
		static revive(data: UriComponents | Uri): Uri;
178 179 180
		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 已提交
181 182 183 184 185 186 187 188
	}

	export interface UriComponents {
		scheme: string;
		authority: string;
		path: string;
		query: string;
		fragment: string;
189 190 191 192 193 194 195 196 197 198 199 200 201 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
	}

	/**
	 * 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,
363 364
		ABNT_C1 = 110,
		ABNT_C2 = 111,
365 366 367 368
		/**
		 * Placed last to cover the length of the enum.
		 * Please do not depend on this value!
		 */
R
Rob Lourens 已提交
369
		MAX_VALUE = 112
370
	}
371

372 373 374 375 376 377 378
	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 已提交
379

380
	export interface IMarkdownString {
381 382
		readonly value: string;
		readonly isTrusted?: boolean;
J
Johannes Rieken 已提交
383 384 385
		uris?: {
			[href: string]: UriComponents;
		};
386
	}
387 388

	export interface IKeyboardEvent {
389
		readonly _standardKeyboardEventBrand: true;
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
		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;
		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);
457
		/**
J
Julien Brianceau 已提交
458
		 * Create a new position from this position.
459 460 461 462 463 464 465 466 467 468 469 470
		 *
		 * @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;
471 472 473 474 475 476 477
		/**
		 * Test if this position equals other position
		 */
		equals(other: IPosition): boolean;
		/**
		 * Test if position `a` equals position `b`
		 */
A
Alex Dima 已提交
478
		static equals(a: IPosition | null, b: IPosition | null): boolean;
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 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
		/**
		 * 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;
588 589 590 591 592 593 594 595
		/**
		 * 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;
596 597 598 599 600 601 602 603 604 605 606 607 608
		/**
		 * 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.
		 */
609
		intersectRanges(range: IRange): Range | null;
610 611 612
		/**
		 * A intersection of the two ranges.
		 */
613
		static intersectRanges(a: IRange, b: IRange): Range | null;
614 615 616
		/**
		 * Test if this range equals other.
		 */
A
Alex Dima 已提交
617
		equalsRange(other: IRange | null): boolean;
618 619 620
		/**
		 * Test if range `a` equals `b`.
		 */
A
Alex Dima 已提交
621
		static equalsRange(a: IRange | null, b: IRange | null): boolean;
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
		/**
		 * Return the end position (which will be after or equal to the start position)
		 */
		getEndPosition(): Position;
		/**
		 * Return the start position (which will be before or equal to the end position)
		 */
		getStartPosition(): Position;
		/**
		 * 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 已提交
650
		static fromPositions(start: IPosition, end?: IPosition): Range;
651 652 653
		/**
		 * Create a `Range` from an `IRange`.
		 */
654
		static lift(range: undefined | null): null;
655 656 657 658 659 660 661 662 663
		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;
664 665 666 667
		/**
		 * Test if the two ranges are intersecting. If the ranges are touching it returns true.
		 */
		static areIntersecting(a: IRange, b: IRange): boolean;
668 669 670 671
		/**
		 * 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 已提交
672
		static compareRangesUsingStarts(a: IRange | null | undefined, b: IRange | null | undefined): number;
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 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
		/**
		 * 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;
749 750 751 752
		/**
		 * Get the position at `positionLineNumber` and `positionColumn`.
		 */
		getPosition(): Position;
753 754 755 756
		/**
		 * Create a new selection with a different `selectionStartLineNumber` and `selectionStartColumn`.
		 */
		setStartPosition(startLineNumber: number, startColumn: number): Selection;
757 758 759 760
		/**
		 * Create a `Selection` from one or two positions
		 */
		static fromPositions(start: IPosition, end?: IPosition): Selection;
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
		/**
		 * 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 已提交
790
		RTL = 1
791 792 793 794 795 796 797 798 799 800
	}

	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 已提交
801
}
802

A
Alex Dima 已提交
803
declare namespace monaco.editor {
804

805 806 807 808 809 810
	export interface IDiffNavigator {
		canNavigate(): boolean;
		next(): void;
		previous(): void;
		dispose(): void;
	}
811

812 813 814 815 816
	/**
	 * Create a new editor under `domElement`.
	 * `domElement` should be empty (not contain other dom nodes).
	 * The editor will read the size of `domElement`.
	 */
817
	export function create(domElement: HTMLElement, options?: IStandaloneEditorConstructionOptions, override?: IEditorOverrideServices): IStandaloneCodeEditor;
818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844

	/**
	 * 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`.
	 */
845
	export function createModel(value: string, language?: string, uri?: Uri): ITextModel;
846 847 848 849

	/**
	 * Change the language for a model.
	 */
M
Martin Aeschlimann 已提交
850
	export function setModelLanguage(model: ITextModel, languageId: string): void;
851 852 853 854

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

R
Roman Safronov 已提交
857
	/**
R
rebornix 已提交
858
	 * Get markers for owner and/or resource
859 860
	 *
	 * @returns list of markers
R
Roman Safronov 已提交
861 862 863 864 865
	 */
	export function getModelMarkers(filter: {
		owner?: string;
		resource?: Uri;
		take?: number;
R
rsafronov 已提交
866
	}): IMarker[];
R
Roman Safronov 已提交
867

868 869 870
	/**
	 * Get the model that has `uri` if it exists.
	 */
A
Alex Dima 已提交
871
	export function getModel(uri: Uri): ITextModel | null;
872 873 874 875

	/**
	 * Get all the created models.
	 */
876
	export function getModels(): ITextModel[];
877 878 879 880 881

	/**
	 * Emitted when a model is created.
	 * @event
	 */
882
	export function onDidCreateModel(listener: (model: ITextModel) => void): IDisposable;
883 884 885 886 887

	/**
	 * Emitted right before a model is disposed.
	 * @event
	 */
888
	export function onWillDisposeModel(listener: (model: ITextModel) => void): IDisposable;
889 890 891 892 893 894

	/**
	 * Emitted when a different language is set to a model.
	 * @event
	 */
	export function onDidChangeModelLanguage(listener: (e: {
895
		readonly model: ITextModel;
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917
		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.
	 */
918
	export function colorizeModelLine(model: ITextModel, lineNumber: number, tabSize?: number): string;
919 920 921 922 923 924 925

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

	/**
A
Alex Dima 已提交
926
	 * Define a new theme or update an existing theme.
927 928 929
	 */
	export function defineTheme(themeName: string, themeData: IStandaloneThemeData): void;

930 931 932 933 934
	/**
	 * Switches to a theme.
	 */
	export function setTheme(themeName: string): void;

935 936 937 938 939
	/**
	 * Clears all cached font measurements and triggers re-measurement.
	 */
	export function remeasureFonts(): void;

940 941 942 943 944 945
	export type BuiltinTheme = 'vs' | 'vs-dark' | 'hc-black';

	export interface IStandaloneThemeData {
		base: BuiltinTheme;
		inherit: boolean;
		rules: ITokenThemeRule[];
M
Martin Aeschlimann 已提交
946
		encodedTokensColors?: string[];
947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993
		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;
994 995 996
		/**
		 * An object that can be used by the web worker to make calls back to the main thread.
		 */
997
		host?: any;
998 999
	}

A
Alex Dima 已提交
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
	/**
	 * 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 已提交
1040
		 * @param editor The editor instance is passed in as a convenience
A
Alex Dima 已提交
1041 1042 1043 1044
		 */
		run(editor: ICodeEditor): void | Promise<void>;
	}

1045 1046 1047
	/**
	 * The options to create an editor.
	 */
1048
	export interface IStandaloneEditorConstructionOptions extends IEditorConstructionOptions {
1049 1050 1051
		/**
		 * The initial model associated with this code editor.
		 */
A
Alex Dima 已提交
1052
		model?: ITextModel | null;
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
		/**
		 * 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;
1063 1064 1065 1066 1067 1068 1069
		/**
		 * 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;
1070 1071 1072 1073 1074 1075 1076
		/**
		 * 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;
1077 1078 1079 1080 1081 1082
	}

	/**
	 * The options to create a diff editor.
	 */
	export interface IDiffEditorConstructionOptions extends IDiffEditorOptions {
1083 1084 1085 1086 1087 1088 1089
		/**
		 * 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;
1090 1091 1092
	}

	export interface IStandaloneCodeEditor extends ICodeEditor {
1093
		addCommand(keybinding: number, handler: ICommandHandler, context?: string): string | null;
1094 1095 1096 1097 1098
		createContextKey<T>(key: string, defaultValue: T): IContextKey<T>;
		addAction(descriptor: IActionDescriptor): IDisposable;
	}

	export interface IStandaloneDiffEditor extends IDiffEditor {
1099
		addCommand(keybinding: number, handler: ICommandHandler, context?: string): string | null;
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
		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 已提交
1112
		get(): T | undefined;
1113 1114 1115 1116 1117 1118
	}

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

R
rsafronov 已提交
1119 1120 1121
	export interface IMarker {
		owner: string;
		resource: Uri;
1122
		severity: MarkerSeverity;
R
rsafronov 已提交
1123 1124 1125 1126 1127 1128 1129
		code?: string;
		message: string;
		source?: string;
		startLineNumber: number;
		startColumn: number;
		endLineNumber: number;
		endColumn: number;
1130
		relatedInformation?: IRelatedInformation[];
1131
		tags?: MarkerTag[];
R
rsafronov 已提交
1132 1133
	}

1134 1135 1136 1137 1138
	/**
	 * A structure defining a problem/warning/etc.
	 */
	export interface IMarkerData {
		code?: string;
1139
		severity: MarkerSeverity;
1140 1141 1142 1143 1144 1145
		message: string;
		source?: string;
		startLineNumber: number;
		startColumn: number;
		endLineNumber: number;
		endColumn: number;
1146
		relatedInformation?: IRelatedInformation[];
1147
		tags?: MarkerTag[];
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
	}

	/**
	 *
	 */
	export interface IRelatedInformation {
		resource: Uri;
		message: string;
		startLineNumber: number;
		startColumn: number;
		endLineNumber: number;
		endColumn: number;
1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
	}

	export interface IColorizerOptions {
		tabSize?: number;
	}

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

	export enum ScrollbarVisibility {
		Auto = 1,
		Hidden = 2,
R
Rob Lourens 已提交
1174
		Visible = 3
1175 1176
	}

1177 1178 1179 1180
	export interface ThemeColor {
		id: string;
	}

1181 1182 1183 1184 1185 1186 1187
	/**
	 * Vertical Lane in the overview ruler of the editor.
	 */
	export enum OverviewRulerLane {
		Left = 1,
		Center = 2,
		Right = 4,
R
Rob Lourens 已提交
1188
		Full = 7
1189 1190 1191
	}

	/**
1192
	 * Position in the minimap to render the decoration.
1193
	 */
1194
	export enum MinimapPosition {
1195 1196
		Inline = 1,
		Gutter = 2
1197 1198 1199
	}

	export interface IDecorationOptions {
1200
		/**
1201
		 * CSS color to render.
1202
		 * e.g.: rgba(100, 100, 100, 0.5) or a color from the color registry
1203
		 */
A
Alex Dima 已提交
1204
		color: string | ThemeColor | undefined;
1205
		/**
1206
		 * CSS color to render.
1207
		 * e.g.: rgba(100, 100, 100, 0.5) or a color from the color registry
1208
		 */
1209
		darkColor?: string | ThemeColor;
1210 1211 1212 1213 1214 1215
	}

	/**
	 * Options for rendering a model decoration in the overview ruler.
	 */
	export interface IModelDecorationOverviewRulerOptions extends IDecorationOptions {
1216 1217 1218 1219 1220 1221
		/**
		 * The position in the overview ruler.
		 */
		position: OverviewRulerLane;
	}

1222 1223 1224 1225 1226 1227 1228 1229 1230 1231
	/**
	 * Options for rendering a model decoration in the overview ruler.
	 */
	export interface IModelDecorationMinimapOptions extends IDecorationOptions {
		/**
		 * The position in the overview ruler.
		 */
		position: MinimapPosition;
	}

1232 1233 1234 1235 1236
	/**
	 * Options for a model decoration.
	 */
	export interface IModelDecorationOptions {
		/**
A
Alex Dima 已提交
1237
		 * Customize the growing behavior of the decoration when typing at the edges of the decoration.
1238 1239 1240 1241 1242 1243
		 * Defaults to TrackedRangeStickiness.AlwaysGrowsWhenTypingAtEdges
		 */
		stickiness?: TrackedRangeStickiness;
		/**
		 * CSS class name describing the decoration.
		 */
A
Alex Dima 已提交
1244
		className?: string | null;
1245 1246 1247
		/**
		 * Message to be rendered when hovering over the glyph margin decoration.
		 */
A
Alex Dima 已提交
1248
		glyphMarginHoverMessage?: IMarkdownString | IMarkdownString[] | null;
1249
		/**
1250
		 * Array of MarkdownString to render as the decoration message.
1251
		 */
A
Alex Dima 已提交
1252
		hoverMessage?: IMarkdownString | IMarkdownString[] | null;
1253 1254 1255 1256
		/**
		 * Should the decoration expand to encompass a whole line.
		 */
		isWholeLine?: boolean;
1257 1258 1259 1260 1261
		/**
		 * 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;
1262 1263 1264
		/**
		 * If set, render this decoration in the overview ruler.
		 */
A
Alex Dima 已提交
1265
		overviewRuler?: IModelDecorationOverviewRulerOptions | null;
1266 1267 1268 1269
		/**
		 * If set, render this decoration in the minimap.
		 */
		minimap?: IModelDecorationMinimapOptions | null;
1270 1271 1272
		/**
		 * If set, the decoration will be rendered in the glyph margin with this CSS class name.
		 */
A
Alex Dima 已提交
1273
		glyphMarginClassName?: string | null;
1274 1275 1276
		/**
		 * If set, the decoration will be rendered in the lines decorations with this CSS class name.
		 */
A
Alex Dima 已提交
1277
		linesDecorationsClassName?: string | null;
1278 1279 1280
		/**
		 * If set, the decoration will be rendered in the margin (covering its full width) with this CSS class name.
		 */
A
Alex Dima 已提交
1281
		marginClassName?: string | null;
1282 1283 1284 1285 1286
		/**
		 * 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 已提交
1287
		inlineClassName?: string | null;
A
Alex Dima 已提交
1288 1289 1290 1291
		/**
		 * If there is an `inlineClassName` which affects letter spacing.
		 */
		inlineClassNameAffectsLetterSpacing?: boolean;
1292 1293 1294
		/**
		 * If set, the decoration will be rendered before the text with this CSS class name.
		 */
A
Alex Dima 已提交
1295
		beforeContentClassName?: string | null;
1296 1297 1298
		/**
		 * If set, the decoration will be rendered after the text with this CSS class name.
		 */
A
Alex Dima 已提交
1299
		afterContentClassName?: string | null;
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324
	}

	/**
	 * 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 已提交
1325
		 * Identifier for a decoration's owner.
1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370
		 */
		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 已提交
1371
		CRLF = 2
1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384
	}

	/**
	 * 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 已提交
1385
		CRLF = 2
1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398
	}

	/**
	 * 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 已提交
1399
		CRLF = 1
1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427
	}

	/**
	 * An identifier for a single edit operation.
	 */
	export interface ISingleEditOperationIdentifier {
		/**
		 * Identifier major
		 */
		major: number;
		/**
		 * Identifier minor
		 */
		minor: number;
	}

	/**
	 * 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 已提交
1428
		text: string | null;
1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446
		/**
		 * 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.
		 */
		range: Range;
		/**
		 * The text to replace with. This can be null to emulate a simple delete.
		 */
A
Alex Dima 已提交
1447
		text: string | null;
1448 1449 1450 1451
		/**
		 * This indicates that this operation has "insert" semantics.
		 * i.e. forceMoveMarkers = true => if `range` is collapsed, all markers at the position will be moved.
		 */
1452
		forceMoveMarkers?: boolean;
1453 1454 1455 1456 1457 1458 1459 1460 1461
	}

	/**
	 * 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.
		 */
A
Alex Dima 已提交
1462
		(inverseEditOperations: IIdentifiedSingleEditOperation[]): Selection[] | null;
1463 1464 1465 1466 1467
	}

	export class TextModelResolvedOptions {
		_textModelResolvedOptionsBrand: void;
		readonly tabSize: number;
D
David Lechner 已提交
1468
		readonly indentSize: number;
1469 1470 1471 1472 1473 1474 1475
		readonly insertSpaces: boolean;
		readonly defaultEOL: DefaultEndOfLine;
		readonly trimAutoWhitespace: boolean;
	}

	export interface ITextModelUpdateOptions {
		tabSize?: number;
D
David Lechner 已提交
1476
		indentSize?: number;
1477 1478 1479 1480
		insertSpaces?: boolean;
		trimAutoWhitespace?: boolean;
	}

1481 1482 1483
	export class FindMatch {
		_findMatchBrand: void;
		readonly range: Range;
A
Alex Dima 已提交
1484
		readonly matches: string[] | null;
1485
	}
1486

1487
	/**
1488 1489 1490 1491 1492 1493 1494
	 * 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 已提交
1495
		GrowsOnlyWhenTypingAfter = 3
1496
	}
1497

1498 1499
	/**
	 * A model.
1500 1501 1502
	 */
	export interface ITextModel {
		/**
1503
		 * Gets the resource associated with this editor model.
1504
		 */
1505
		readonly uri: Uri;
1506
		/**
1507
		 * A unique identifier associated with this model.
1508
		 */
1509
		readonly id: string;
1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553
		/**
		 * 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;
1554 1555 1556 1557 1558
		/**
		 * Get the character count of text in a certain range.
		 * @param range The range describing what text length to get.
		 */
		getCharacterCountInRange(range: IRange): number;
1559 1560 1561 1562 1563 1564 1565 1566
		/**
		 * Get the number of lines in the model.
		 */
		getLineCount(): number;
		/**
		 * Get the text for a certain line.
		 */
		getLineContent(lineNumber: number): string;
A
Alex Dima 已提交
1567 1568 1569 1570
		/**
		 * Get the text length for a certain line.
		 */
		getLineLength(lineNumber: number): number;
1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602
		/**
		 * 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 已提交
1603
		 * Advances the given position by the given offset (negative offsets are also accepted)
1604 1605 1606 1607 1608
		 * 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 已提交
1609
		 * If the offset is such that the new position would be in the middle of a multi-byte
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
		 * 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;
		/**
1638
		 * Returns if the model was disposed or not.
1639 1640 1641 1642 1643 1644 1645 1646
		 */
		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.
1647
		 * @param wordSeparators Force the matching to match entire words only. Pass null otherwise.
1648 1649 1650 1651
		 * @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.
		 */
1652
		findMatches(searchString: string, searchOnlyEditableRange: boolean, isRegex: boolean, matchCase: boolean, wordSeparators: string | null, captureMatches: boolean, limitResultCount?: number): FindMatch[];
1653 1654 1655 1656 1657 1658
		/**
		 * 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.
1659
		 * @param wordSeparators Force the matching to match entire words only. Pass null otherwise.
1660 1661 1662 1663
		 * @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.
		 */
1664
		findMatches(searchString: string, searchScope: IRange, isRegex: boolean, matchCase: boolean, wordSeparators: string | null, captureMatches: boolean, limitResultCount?: number): FindMatch[];
1665 1666 1667 1668 1669 1670
		/**
		 * 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.
1671
		 * @param wordSeparators Force the matching to match entire words only. Pass null otherwise.
1672 1673 1674
		 * @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 已提交
1675
		findNextMatch(searchString: string, searchStart: IPosition, isRegex: boolean, matchCase: boolean, wordSeparators: string | null, captureMatches: boolean): FindMatch | null;
1676 1677 1678 1679 1680 1681
		/**
		 * 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.
1682
		 * @param wordSeparators Force the matching to match entire words only. Pass null otherwise.
1683 1684 1685
		 * @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 已提交
1686
		findPreviousMatch(searchString: string, searchStart: IPosition, isRegex: boolean, matchCase: boolean, wordSeparators: string | null, captureMatches: boolean): FindMatch | null;
1687 1688 1689 1690 1691 1692 1693 1694 1695
		/**
		 * 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 已提交
1696
		getWordAtPosition(position: IPosition): IWordAtPosition | null;
1697 1698 1699 1700 1701 1702 1703
		/**
		 * 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 已提交
1704
		 * Perform a minimum amount of operations, in order to transform the decorations
1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718
		 * 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 已提交
1719
		getDecorationOptions(id: string): IModelDecorationOptions | null;
1720 1721 1722 1723 1724
		/**
		 * 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 已提交
1725
		getDecorationRange(id: string): Range | null;
1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743
		/**
		 * 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 已提交
1744
		 * Gets all the decorations in a range as an array. Only `startLineNumber` and `endLineNumber` from `range` are used for filtering.
1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757
		 * 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[];
1758 1759 1760 1761 1762 1763
		/**
		 * 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[];
1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784
		/**
		 * 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 已提交
1785
		 * @param beforeCursorState The cursor state before the edit operations. This cursor state will be returned when `undo` or `redo` are invoked.
1786 1787 1788 1789
		 * @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 已提交
1790
		pushEditOperations(beforeCursorState: Selection[], editOperations: IIdentifiedSingleEditOperation[], cursorStateComputer: ICursorStateComputer): Selection[] | null;
A
Alex Dima 已提交
1791 1792 1793 1794 1795
		/**
		 * 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;
1796 1797 1798 1799 1800 1801 1802
		/**
		 * 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.
		 */
		applyEdits(operations: IIdentifiedSingleEditOperation[]): IIdentifiedSingleEditOperation[];
A
Alex Dima 已提交
1803 1804 1805 1806 1807
		/**
		 * 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;
1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827
		/**
		 * 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;
1828 1829 1830 1831 1832
		/**
		 * An event emitted when the language configuration associated with the model has changed.
		 * @event
		 */
		onDidChangeLanguageConfiguration(listener: (e: IModelLanguageConfigurationChangedEvent) => void): IDisposable;
1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844
		/**
		 * 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;
	}

1845 1846 1847 1848 1849 1850 1851 1852 1853
	/**
	 * 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.
		 */
A
Alex Dima 已提交
1854
		addEditOperation(range: Range, text: string | null): void;
1855 1856 1857 1858 1859 1860
		/**
		 * 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.
		 */
A
Alex Dima 已提交
1861
		addTrackedEditOperation(range: Range, text: string | null): void;
1862 1863 1864 1865 1866 1867 1868
		/**
		 * 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 已提交
1869
		 * @return A unique identifier.
1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901
		 */
		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.
		 */
		getInverseEditOperations(): IIdentifiedSingleEditOperation[];
		/**
		 * 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 已提交
1902
		 * @param model The model the command has executed on.
1903 1904 1905 1906 1907 1908
		 * @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;
	}

1909 1910 1911 1912 1913 1914 1915
	/**
	 * A model for the diff editor.
	 */
	export interface IDiffEditorModel {
		/**
		 * Original model.
		 */
1916
		original: ITextModel;
1917 1918 1919
		/**
		 * Modified model.
		 */
1920
		modified: ITextModel;
1921 1922 1923 1924 1925 1926 1927 1928 1929
	}

	/**
	 * 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 已提交
1930
		readonly oldModelUrl: Uri | null;
1931 1932 1933
		/**
		 * The `uri` of the new model or null.
		 */
A
Alex Dima 已提交
1934
		readonly newModelUrl: Uri | null;
1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965
	}

	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 已提交
1966
		readonly charChanges: ICharChange[] | undefined;
1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981
	}

	export interface INewScrollPosition {
		scrollLeft?: number;
		scrollTop?: number;
	}

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

1982
	export type IEditorModel = ITextModel | IDiffEditorModel;
1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996

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

	/**
	 * A (serializable) state of the view.
	 */
	export interface IViewState {
1997 1998 1999 2000
		/** written by previous versions */
		scrollTop?: number;
		/** written by previous versions */
		scrollTopWithoutViewZones?: number;
2001
		scrollLeft: number;
2002 2003
		firstPosition: IPosition;
		firstPositionDeltaTop: number;
2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020
	}

	/**
	 * 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 已提交
2021 2022
		original: ICodeEditorViewState | null;
		modified: ICodeEditorViewState | null;
2023 2024 2025 2026 2027 2028 2029
	}

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

2030
	export enum ScrollType {
2031
		Smooth = 0,
R
Rob Lourens 已提交
2032
		Immediate = 1
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 2063
	/**
	 * 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.
2064 2065
		 *
		 * If a dimension is passed in, the passed in value will be used.
2066 2067 2068 2069 2070 2071 2072
		 */
		layout(dimension?: IDimension): void;
		/**
		 * Brings browser focus to the editor text
		 */
		focus(): void;
		/**
A
Alex Dima 已提交
2073
		 * Returns true if the text inside this editor is focused (i.e. cursor is blinking).
2074
		 */
A
Alex Dima 已提交
2075
		hasTextFocus(): boolean;
2076 2077 2078 2079 2080 2081 2082
		/**
		 * Returns all actions associated with this editor.
		 */
		getSupportedActions(): IEditorAction[];
		/**
		 * Saves current view state of the editor in a serializable object.
		 */
A
Alex Dima 已提交
2083
		saveViewState(): IEditorViewState | null;
2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094
		/**
		 * 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 已提交
2095
		getPosition(): Position | null;
2096 2097 2098 2099 2100 2101 2102 2103
		/**
		 * 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.
		 */
2104
		revealLine(lineNumber: number, scrollType?: ScrollType): void;
2105 2106 2107
		/**
		 * Scroll vertically as necessary and reveal a line centered vertically.
		 */
2108
		revealLineInCenter(lineNumber: number, scrollType?: ScrollType): void;
2109 2110 2111
		/**
		 * Scroll vertically as necessary and reveal a line centered vertically only if it lies outside the viewport.
		 */
2112
		revealLineInCenterIfOutsideViewport(lineNumber: number, scrollType?: ScrollType): void;
2113 2114 2115
		/**
		 * Scroll vertically or horizontally as necessary and reveal a position.
		 */
2116
		revealPosition(position: IPosition, scrollType?: ScrollType): void;
2117 2118 2119
		/**
		 * Scroll vertically or horizontally as necessary and reveal a position centered vertically.
		 */
2120
		revealPositionInCenter(position: IPosition, scrollType?: ScrollType): void;
2121 2122 2123
		/**
		 * Scroll vertically or horizontally as necessary and reveal a position centered vertically only if it lies outside the viewport.
		 */
2124
		revealPositionInCenterIfOutsideViewport(position: IPosition, scrollType?: ScrollType): void;
2125 2126 2127
		/**
		 * Returns the primary selection of the editor.
		 */
A
Alex Dima 已提交
2128
		getSelection(): Selection | null;
2129 2130 2131
		/**
		 * Returns all the selections of the editor.
		 */
A
Alex Dima 已提交
2132
		getSelections(): Selection[] | null;
2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156
		/**
		 * 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.
		 */
2157
		setSelections(selections: readonly ISelection[]): void;
2158 2159 2160
		/**
		 * Scroll vertically as necessary and reveal lines.
		 */
2161
		revealLines(startLineNumber: number, endLineNumber: number, scrollType?: ScrollType): void;
2162 2163 2164
		/**
		 * Scroll vertically as necessary and reveal lines centered vertically.
		 */
2165
		revealLinesInCenter(lineNumber: number, endLineNumber: number, scrollType?: ScrollType): void;
2166 2167 2168
		/**
		 * Scroll vertically as necessary and reveal lines centered vertically only if it lies outside the viewport.
		 */
2169
		revealLinesInCenterIfOutsideViewport(lineNumber: number, endLineNumber: number, scrollType?: ScrollType): void;
2170 2171 2172
		/**
		 * Scroll vertically or horizontally as necessary and reveal a range.
		 */
2173
		revealRange(range: IRange, scrollType?: ScrollType): void;
2174 2175 2176
		/**
		 * Scroll vertically or horizontally as necessary and reveal a range centered vertically.
		 */
2177
		revealRangeInCenter(range: IRange, scrollType?: ScrollType): void;
2178 2179 2180
		/**
		 * Scroll vertically or horizontally as necessary and reveal a range at the top of the viewport.
		 */
2181
		revealRangeAtTop(range: IRange, scrollType?: ScrollType): void;
2182 2183 2184
		/**
		 * Scroll vertically or horizontally as necessary and reveal a range centered vertically only if it lies outside the viewport.
		 */
2185
		revealRangeInCenterIfOutsideViewport(range: IRange, scrollType?: ScrollType): void;
2186 2187 2188 2189 2190 2191 2192 2193 2194 2195
		/**
		 * 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 已提交
2196
		getModel(): IEditorModel | null;
2197 2198 2199 2200 2201 2202 2203 2204
		/**
		 * 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 已提交
2205
		setModel(model: IEditorModel | null): void;
2206 2207 2208 2209
	}

	/**
	 * An editor contribution that gets created every time a new editor gets created and gets disposed when the editor gets disposed.
A
Alex Dima 已提交
2210 2211
	 */
	export interface IEditorContribution {
2212
		/**
A
Alex Dima 已提交
2213
		 * Dispose this contribution.
2214
		 */
A
Alex Dima 已提交
2215
		dispose(): void;
2216
		/**
A
Alex Dima 已提交
2217
		 * Store view state.
2218
		 */
A
Alex Dima 已提交
2219
		saveViewState?(): any;
2220
		/**
A
Alex Dima 已提交
2221
		 * Restore view state.
2222
		 */
A
Alex Dima 已提交
2223
		restoreViewState?(state: any): void;
2224 2225 2226 2227 2228
	}

	/**
	 * The type of the `IEditor`.
	 */
2229
	export const EditorType: {
2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247
		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;
	}

2248 2249 2250 2251 2252 2253
	/**
	 * An event describing that the language configuration associated with a model has changed.
	 */
	export interface IModelLanguageConfigurationChangedEvent {
	}

2254 2255 2256 2257 2258
	export interface IModelContentChange {
		/**
		 * The range that got replaced.
		 */
		readonly range: IRange;
2259 2260 2261 2262
		/**
		 * The offset of the range that got replaced.
		 */
		readonly rangeOffset: number;
2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310
		/**
		 * 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 {
	}

	/**
	 * An event describing that some ranges of lines have been tokenized (their tokens have changed).
	 */
	export interface IModelTokensChangedEvent {
2311
		readonly tokenizationSupportChanged: boolean;
2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325
		readonly ranges: {
			/**
			 * The start of the range (inclusive)
			 */
			readonly fromLineNumber: number;
			/**
			 * The end of the range (inclusive)
			 */
			readonly toLineNumber: number;
		}[];
	}

	export interface IModelOptionsChangedEvent {
		readonly tabSize: boolean;
D
David Lechner 已提交
2326
		readonly indentSize: boolean;
2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361
		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 已提交
2362
		Redo = 6
2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398
	}

	/**
	 * 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[];
2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410
		/**
		 * 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;
2411 2412 2413 2414 2415 2416 2417 2418 2419 2420
		/**
		 * Source of the call that caused the event.
		 */
		readonly source: string;
		/**
		 * Reason.
		 */
		readonly reason: CursorChangeReason;
	}

A
Alex Dima 已提交
2421 2422 2423 2424 2425 2426 2427 2428 2429
	export enum AccessibilitySupport {
		/**
		 * This should be the browser case where it is not known if a screen reader is attached or no.
		 */
		Unknown = 0,
		Disabled = 1,
		Enabled = 2
	}

J
Jackson Kearl 已提交
2430
	/**
J
Jackson Kearl 已提交
2431
	 * Configuration options for auto closing quotes and brackets
J
Jackson Kearl 已提交
2432
	 */
J
Jackson Kearl 已提交
2433 2434 2435 2436 2437
	export type EditorAutoClosingStrategy = 'always' | 'languageDefined' | 'beforeWhitespace' | 'never';

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

2440 2441 2442 2443 2444
	/**
	 * Configuration options for typing over closing quotes or brackets
	 */
	export type EditorAutoClosingOvertypeStrategy = 'always' | 'auto' | 'never';

2445 2446 2447 2448
	/**
	 * Configuration options for the editor.
	 */
	export interface IEditorOptions {
2449 2450 2451 2452
		/**
		 * This editor is used inside a diff editor.
		 */
		inDiffEditor?: boolean;
2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478
		/**
		 * The aria label for the editor's textarea (when it is focused).
		 */
		ariaLabel?: string;
		/**
		 * Render vertical lines at the specified columns.
		 * Defaults to empty array.
		 */
		rulers?: number[];
		/**
		 * A string containing the word separators used when doing word navigation.
		 * Defaults to `~!@#$%^&*()-=+[{]}\\|;:\'",.<>/?
		 */
		wordSeparators?: string;
		/**
		 * Enable Linux primary clipboard.
		 * Defaults to true.
		 */
		selectionClipboard?: boolean;
		/**
		 * Control the rendering of line numbers.
		 * If it is a function, it will be invoked when rendering a line number and the return value will be rendered.
		 * Otherwise, if it is a truey, line numbers will be rendered normally (equivalent of using an identity function).
		 * Otherwise, line numbers will not be rendered.
		 * Defaults to true.
		 */
A
Alex Dima 已提交
2479
		lineNumbers?: LineNumbersType;
P
Peng Lyu 已提交
2480
		/**
2481
		 * Controls the minimal number of visible leading and trailing lines surrounding the cursor.
P
Peng Lyu 已提交
2482 2483
		 * Defaults to 0.
		*/
2484
		cursorSurroundingLines?: number;
2485 2486 2487 2488 2489 2490
		/**
		 * 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 已提交
2491 2492
		/**
		 * Render last line number when the file ends with a newline.
A
Alex Dima 已提交
2493
		 * Defaults to true.
A
Alex Dima 已提交
2494 2495
		*/
		renderFinalNewline?: boolean;
2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529
		/**
		 * 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;
		/**
2530
		 * Class name to be added to the editor.
2531
		 */
2532
		extraEditorClassName?: string;
2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545
		/**
		 * Should the editor be read only.
		 * Defaults to false.
		 */
		readOnly?: boolean;
		/**
		 * Control the behavior and rendering of the scrollbars.
		 */
		scrollbar?: IEditorScrollbarOptions;
		/**
		 * Control the behavior and rendering of the minimap.
		 */
		minimap?: IEditorMinimapOptions;
2546 2547 2548 2549
		/**
		 * Control the behavior of the find widget.
		 */
		find?: IEditorFindOptions;
2550 2551 2552 2553 2554 2555 2556
		/**
		 * Display overflow widgets as `fixed`.
		 * Defaults to `false`.
		 */
		fixedOverflowWidgets?: boolean;
		/**
		 * The number of vertical lanes the overview ruler should render.
2557
		 * Defaults to 3.
2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568
		 */
		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 已提交
2569
		cursorBlinking?: 'blink' | 'smooth' | 'phase' | 'expand' | 'solid';
2570 2571 2572 2573 2574
		/**
		 * Zoom the font in the editor when using the mouse wheel in combination with holding Ctrl.
		 * Defaults to false.
		 */
		mouseWheelZoom?: boolean;
2575 2576 2577 2578 2579
		/**
		 * Control the mouse pointer style, either 'text' or 'default' or 'copy'
		 * Defaults to 'text'
		 */
		mouseStyle?: 'text' | 'default' | 'copy';
2580 2581 2582 2583 2584
		/**
		 * Enable smooth caret animation.
		 * Defaults to false.
		 */
		cursorSmoothCaretAnimation?: boolean;
2585 2586 2587 2588
		/**
		 * Control the cursor style, either 'block' or 'line'.
		 * Defaults to 'line'.
		 */
A
Alex Dima 已提交
2589
		cursorStyle?: 'line' | 'block' | 'underline' | 'line-thin' | 'block-outline' | 'underline-thin';
2590 2591 2592 2593
		/**
		 * Control the width of the cursor when cursorStyle is set to 'line'
		 */
		cursorWidth?: number;
2594 2595 2596 2597
		/**
		 * Enable font ligatures.
		 * Defaults to false.
		 */
2598
		fontLigatures?: boolean | string;
2599
		/**
2600 2601
		 * 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.
2602 2603
		 * Defaults to false.
		 */
2604
		disableLayerHinting?: boolean;
2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619
		/**
		 * 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;
2620 2621 2622 2623 2624
		/**
		 * Enable that scrolling can go beyond the last column by a number of columns.
		 * Defaults to 5.
		 */
		scrollBeyondLastColumn?: number;
2625 2626
		/**
		 * Enable that the editor animates scrolling to a position.
2627
		 * Defaults to false.
2628 2629
		 */
		smoothScrolling?: boolean;
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 2655 2656 2657 2658 2659
		/**
		 * 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;
		/**
2660
		 * Control indentation of wrapped lines. Can be: 'none', 'same', 'indent' or 'deepIndent'.
2661 2662
		 * Defaults to 'same' in vscode and to 'none' in monaco-editor.
		 */
A
Alex Dima 已提交
2663
		wrappingIndent?: 'none' | 'same' | 'indent' | 'deepIndent';
2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685
		/**
		 * Configure word wrapping characters. A break will be introduced before these characters.
		 * Defaults to '{([+'.
		 */
		wordWrapBreakBeforeCharacters?: string;
		/**
		 * Configure word wrapping characters. A break will be introduced after these characters.
		 * Defaults to ' \t})]?|&,;'.
		 */
		wordWrapBreakAfterCharacters?: string;
		/**
		 * Configure word wrapping characters. A break will be introduced after these characters only if no `wordWrapBreakBeforeCharacters` or `wordWrapBreakAfterCharacters` were found.
		 * Defaults to '.'.
		 */
		wordWrapBreakObtrusiveCharacters?: string;
		/**
		 * Performance guard: Stop rendering a line after x characters.
		 * Defaults to 10000.
		 * Use -1 to never stop rendering
		 */
		stopRenderingLineAfter?: number;
		/**
A
Alex Dima 已提交
2686
		 * Configure the editor's hover.
2687
		 */
A
Alex Dima 已提交
2688
		hover?: IEditorHoverOptions;
2689 2690 2691 2692 2693
		/**
		 * Enable detecting links and making them clickable.
		 * Defaults to true.
		 */
		links?: boolean;
2694
		/**
R
rebornix 已提交
2695
		 * Enable inline color decorators and color picker rendering.
2696
		 */
R
rebornix 已提交
2697
		colorDecorators?: boolean;
2698 2699 2700 2701 2702 2703 2704 2705 2706 2707
		/**
		 * 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 已提交
2708
		/**
2709 2710
		 * FastScrolling mulitplier speed when pressing `Alt`
		 * Defaults to 5.
T
Tiago Ribeiro 已提交
2711 2712
		 */
		fastScrollSensitivity?: number;
2713 2714 2715 2716
		/**
		 * The modifier to be used to add multiple cursors with the mouse.
		 * Defaults to 'alt'
		 */
2717
		multiCursorModifier?: 'ctrlCmd' | 'alt';
2718
		/**
A
Alex Dima 已提交
2719
		 * Merge overlapping selections.
2720 2721
		 * Defaults to true
		 */
A
Alex Dima 已提交
2722
		multiCursorMergeOverlapping?: boolean;
2723 2724 2725 2726 2727
		/**
		 * Configure the behaviour when pasting a text with the line count equal to the cursor count.
		 * Defaults to 'spread'.
		 */
		multiCursorPaste?: 'spread' | 'full';
2728 2729 2730 2731 2732
		/**
		 * Configure the editor's accessibility support.
		 * Defaults to 'auto'. It is best to leave this to 'auto'.
		 */
		accessibilitySupport?: 'auto' | 'off' | 'on';
2733 2734 2735 2736
		/**
		 * Suggest options.
		 */
		suggest?: ISuggestOptions;
2737 2738 2739 2740
		/**
		 *
		 */
		gotoLocation?: IGotoLocationOptions;
2741 2742 2743 2744
		/**
		 * Enable quick suggestions (shadow suggestions)
		 * Defaults to true.
		 */
A
Alex Dima 已提交
2745
		quickSuggestions?: boolean | IQuickSuggestionsOptions;
2746 2747
		/**
		 * Quick suggestions show delay (in ms)
A
Alex Dima 已提交
2748
		 * Defaults to 10 (ms)
2749 2750 2751
		 */
		quickSuggestionsDelay?: number;
		/**
2752
		 * Parameter hint options.
2753
		 */
2754
		parameterHints?: IEditorParameterHintOptions;
2755
		/**
2756
		 * Options for auto closing brackets.
2757
		 * Defaults to language defined behavior.
2758
		 */
J
Jackson Kearl 已提交
2759
		autoClosingBrackets?: EditorAutoClosingStrategy;
2760
		/**
2761
		 * Options for auto closing quotes.
2762
		 * Defaults to language defined behavior.
2763
		 */
J
Jackson Kearl 已提交
2764
		autoClosingQuotes?: EditorAutoClosingStrategy;
2765 2766 2767 2768
		/**
		 * Options for typing over closing quotes or brackets.
		 */
		autoClosingOvertype?: EditorAutoClosingOvertypeStrategy;
J
Jackson Kearl 已提交
2769
		/**
2770 2771
		 * Options for auto surrounding.
		 * Defaults to always allowing auto surrounding.
2772
		 */
2773
		autoSurround?: EditorAutoSurroundStrategy;
2774 2775 2776 2777 2778
		/**
		 * Enable auto indentation adjustment.
		 * Defaults to false.
		 */
		autoIndent?: boolean;
2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800
		/**
		 * 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.
2801
		 * Defaults to 'on'.
2802
		 */
A
Alex Dima 已提交
2803
		acceptSuggestionOnEnter?: 'on' | 'smart' | 'off';
2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816
		/**
		 * 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;
2817
		/**
2818
		 * Syntax highlighting is copied.
2819
		 */
2820
		copyWithSyntaxHighlighting?: boolean;
2821 2822 2823
		/**
		 * The history mode for suggestions.
		 */
M
Martin Aeschlimann 已提交
2824
		suggestSelection?: 'first' | 'recentlyUsed' | 'recentlyUsedByPrefix';
2825 2826 2827 2828 2829 2830 2831 2832 2833 2834
		/**
		 * 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;
2835 2836 2837
		/**
		 * Enable tab completion.
		 */
A
Alex Dima 已提交
2838
		tabCompletion?: 'on' | 'off' | 'onlySnippets';
2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853
		/**
		 * 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;
2854 2855 2856 2857
		/**
		 * Control the behavior and rendering of the code action lightbulb.
		 */
		lightbulb?: IEditorLightbulbOptions;
2858 2859 2860 2861
		/**
		 * Timeout for running code actions on save.
		 */
		codeActionsOnSaveTimeout?: number;
2862 2863
		/**
		 * Enable code folding
2864
		 * Defaults to true.
2865 2866
		 */
		folding?: boolean;
2867 2868 2869 2870 2871
		/**
		 * 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';
2872
		/**
2873 2874
		 * Controls whether the fold actions in the gutter stay always visible or hide unless the mouse is over the gutter.
		 * Defaults to 'mouseover'.
2875
		 */
2876
		showFoldingControls?: 'always' | 'mouseover';
2877 2878 2879 2880 2881 2882 2883 2884 2885
		/**
		 * Enable highlighting of matching brackets.
		 * Defaults to true.
		 */
		matchBrackets?: boolean;
		/**
		 * Enable rendering of whitespace.
		 * Defaults to none.
		 */
2886
		renderWhitespace?: 'none' | 'boundary' | 'selection' | 'all';
2887 2888 2889 2890 2891 2892 2893
		/**
		 * Enable rendering of control characters.
		 * Defaults to false.
		 */
		renderControlCharacters?: boolean;
		/**
		 * Enable rendering of indent guides.
2894
		 * Defaults to true.
2895 2896
		 */
		renderIndentGuides?: boolean;
2897
		/**
C
typo  
Coenraad Stijne 已提交
2898
		 * Enable highlighting of the active indent guide.
2899 2900 2901
		 * Defaults to true.
		 */
		highlightActiveIndentGuide?: boolean;
2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917
		/**
		 * 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
		 */
2918
		fontWeight?: string;
2919 2920 2921 2922 2923 2924 2925 2926
		/**
		 * The font size
		 */
		fontSize?: number;
		/**
		 * The line height
		 */
		lineHeight?: number;
2927 2928 2929 2930
		/**
		 * The letter spacing
		 */
		letterSpacing?: number;
2931 2932 2933 2934
		/**
		 * Controls fading out of unused variables.
		 */
		showUnused?: boolean;
A
Alex Dima 已提交
2935 2936
	}

2937 2938 2939 2940 2941 2942 2943
	export interface IEditorConstructionOptions extends IEditorOptions {
		/**
		 * The initial editor dimension (to avoid measuring the container).
		 */
		dimension?: IDimension;
	}

2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957
	/**
	 * 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;
2958 2959 2960 2961
		/**
		 * Timeout in milliseconds after which diff computation is cancelled.
		 * Defaults to 5000.
		 */
2962
		maxComputationTime?: number;
2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979
		/**
		 * 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 已提交
2980 2981 2982 2983 2984 2985
	/**
	 * An event describing that the configuration of the editor has changed.
	 */
	export class ConfigurationChangedEvent {
	}

2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012
	/**
	 * 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 已提交
3013
		Solid = 5
3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042
	}

	/**
	 * 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 已提交
3043
		UnderlineThin = 6
3044 3045
	}

3046 3047 3048 3049 3050 3051 3052 3053 3054
	/**
	 * 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 已提交
3055
		 * Controls if Find in Selection flag is turned on in the editor.
3056
		 */
P
Peng Lyu 已提交
3057
		autoFindInSelection?: 'never' | 'always' | 'multiline';
3058 3059 3060
		addExtraSpaceOnTop?: boolean;
	}

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

3063 3064
	export type GoToLocationValues = 'peek' | 'gotoAndPeek' | 'goto';

3065 3066 3067 3068 3069 3070 3071
	/**
	 * Configuration options for go to location
	 */
	export interface IGotoLocationOptions {
		/**
		 * Control how goto-command work when having multiple results.
		 */
3072 3073 3074 3075
		multiple?: GoToLocationValues;
		multipleDefinitions?: GoToLocationValues;
		multipleTypeDefinitions?: GoToLocationValues;
		multipleDeclarations?: GoToLocationValues;
R
rzj17 已提交
3076
		multipleImplementations?: GoToLocationValues;
3077
		multipleReferences?: GoToLocationValues;
3078 3079
	}

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

3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102
	/**
	 * Configuration options for editor hover
	 */
	export interface IEditorHoverOptions {
		/**
		 * Enable the hover.
		 * Defaults to true.
		 */
		enabled?: boolean;
		/**
		 * Delay for showing the hover.
		 * Defaults to 300.
		 */
		delay?: number;
		/**
		 * Is the hover sticky such that it can be clicked and its contents selected?
		 * Defaults to true.
		 */
		sticky?: boolean;
	}

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

3105 3106 3107
	/**
	 * A description for the overview ruler position.
	 */
A
Alex Dima 已提交
3108
	export interface OverviewRulerPosition {
3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126
		/**
		 * 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 已提交
3127 3128
	export enum RenderMinimap {
		None = 0,
3129 3130
		Text = 1,
		Blocks = 2
A
Alex Dima 已提交
3131 3132
	}

3133 3134 3135
	/**
	 * The internal layout details of the editor.
	 */
A
Alex Dima 已提交
3136
	export interface EditorLayoutInfo {
3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192
		/**
		 * Full editor width.
		 */
		readonly width: number;
		/**
		 * Full editor height.
		 */
		readonly height: number;
		/**
		 * Left position for the glyph margin.
		 */
		readonly glyphMarginLeft: number;
		/**
		 * The width of the glyph margin.
		 */
		readonly glyphMarginWidth: number;
		/**
		 * The height of the glyph margin.
		 */
		readonly glyphMarginHeight: number;
		/**
		 * Left position for the line numbers.
		 */
		readonly lineNumbersLeft: number;
		/**
		 * The width of the line numbers.
		 */
		readonly lineNumbersWidth: number;
		/**
		 * The height of the line numbers.
		 */
		readonly lineNumbersHeight: number;
		/**
		 * Left position for the line decorations.
		 */
		readonly decorationsLeft: number;
		/**
		 * The width of the line decorations.
		 */
		readonly decorationsWidth: number;
		/**
		 * The height of the line decorations.
		 */
		readonly decorationsHeight: number;
		/**
		 * Left position for the content (actual text)
		 */
		readonly contentLeft: number;
		/**
		 * The width of the content (actual text)
		 */
		readonly contentWidth: number;
		/**
		 * The height of the content (actual height)
		 */
		readonly contentHeight: number;
3193 3194 3195 3196
		/**
		 * The position for the minimap
		 */
		readonly minimapLeft: number;
3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222
		/**
		 * The width of the minimap
		 */
		readonly minimapWidth: number;
		/**
		 * Minimap render type
		 */
		readonly renderMinimap: RenderMinimap;
		/**
		 * The number of columns (of typical characters) fitting on a viewport line.
		 */
		readonly viewportColumn: number;
		/**
		 * The width of the vertical scrollbar.
		 */
		readonly verticalScrollbarWidth: number;
		/**
		 * The height of the horizontal scrollbar.
		 */
		readonly horizontalScrollbarHeight: number;
		/**
		 * The position of the overview ruler.
		 */
		readonly overviewRuler: OverviewRulerPosition;
	}

3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233
	/**
	 * Configuration options for editor lightbulb
	 */
	export interface IEditorLightbulbOptions {
		/**
		 * Enable the lightbulb code action.
		 * Defaults to true.
		 */
		enabled?: boolean;
	}

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

3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264
	/**
	 * 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';
		/**
		 * 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;
3265 3266 3267 3268
		/**
		 * Relative size of the font in the minimap. Defaults to 1.
		 */
		scale?: number;
3269 3270
	}

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

3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288
	/**
	 * 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 已提交
3289
	export type InternalParameterHintOptions = Readonly<Required<IEditorParameterHintOptions>>;
A
Alex Dima 已提交
3290

3291 3292 3293 3294 3295 3296 3297 3298 3299
	/**
	 * Configuration options for quick suggestions
	 */
	export interface IQuickSuggestionsOptions {
		other: boolean;
		comments: boolean;
		strings: boolean;
	}

A
Alex Dima 已提交
3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316
	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;
	}

3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377
	/**
	 * 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;
		/**
		 * 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 已提交
3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391
	export interface InternalEditorScrollbarOptions {
		readonly arrowSize: number;
		readonly vertical: ScrollbarVisibility;
		readonly horizontal: ScrollbarVisibility;
		readonly useShadows: boolean;
		readonly verticalHasArrows: boolean;
		readonly horizontalHasArrows: boolean;
		readonly handleMouseWheel: boolean;
		readonly horizontalScrollbarSize: number;
		readonly horizontalSliderSize: number;
		readonly verticalScrollbarSize: number;
		readonly verticalSliderSize: number;
	}

3392 3393 3394 3395
	/**
	 * Configuration options for editor suggest widget
	 */
	export interface ISuggestOptions {
3396 3397 3398 3399
		/**
		 * Overwrite word ends on accept. Default to false.
		 */
		overwriteOnAccept?: boolean;
3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424
		/**
		 * 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;
		/**
3425
		 * Show method-suggestions.
3426
		 */
3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445
		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.
3446
		 */
3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523
		showClasses?: boolean;
		/**
		 * Show struct-suggestions.
		 */
		showStructs?: boolean;
		/**
		 * Show interface-suggestions.
		 */
		showInterfaces?: boolean;
		/**
		 * Show module-suggestions.
		 */
		showModules?: boolean;
		/**
		 * Show property-suggestions.
		 */
		showProperties?: boolean;
		/**
		 * Show event-suggestions.
		 */
		showEvents?: boolean;
		/**
		 * Show operator-suggestions.
		 */
		showOperators?: boolean;
		/**
		 * Show unit-suggestions.
		 */
		showUnits?: boolean;
		/**
		 * Show value-suggestions.
		 */
		showValues?: boolean;
		/**
		 * Show constant-suggestions.
		 */
		showConstants?: boolean;
		/**
		 * Show enum-suggestions.
		 */
		showEnums?: boolean;
		/**
		 * Show enumMember-suggestions.
		 */
		showEnumMembers?: boolean;
		/**
		 * Show keyword-suggestions.
		 */
		showKeywords?: boolean;
		/**
		 * Show text-suggestions.
		 */
		showWords?: boolean;
		/**
		 * Show color-suggestions.
		 */
		showColors?: boolean;
		/**
		 * Show file-suggestions.
		 */
		showFiles?: boolean;
		/**
		 * Show reference-suggestions.
		 */
		showReferences?: boolean;
		/**
		 * Show folder-suggestions.
		 */
		showFolders?: boolean;
		/**
		 * Show typeParameter-suggestions.
		 */
		showTypeParameters?: boolean;
		/**
		 * Show snippet-suggestions.
		 */
		showSnippets?: boolean;
3524 3525
	}

A
Alex Dima 已提交
3526
	export type InternalSuggestOptions = Readonly<Required<ISuggestOptions>>;
A
Alex Dima 已提交
3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549

	/**
	 * Describes how to indent wrapped lines.
	 */
	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 已提交
3550 3551 3552 3553 3554
	export interface EditorWrappingInfo {
		readonly isDominatedByLongLines: boolean;
		readonly isWordWrapMinified: boolean;
		readonly isViewportWrapping: boolean;
		readonly wrappingColumn: number;
3555 3556
	}

3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589
	/**
	 * 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;
3590 3591 3592 3593 3594
		/**
		 * 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;
3595 3596 3597 3598 3599 3600 3601
		/**
		 * 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 已提交
3602
		marginDomNode?: HTMLElement | null;
3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621
		/**
		 * 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 已提交
3622
		addZone(zone: IViewZone): string;
3623 3624 3625 3626
		/**
		 * Remove a zone
		 * @param id A unique identifier to the view zone, as returned by the `addZone` call.
		 */
A
Alex Dima 已提交
3627
		removeZone(id: string): void;
3628 3629 3630 3631
		/**
		 * Change a zone's position.
		 * The editor will rescan the `afterLineNumber` and `afterColumn` properties of a view zone.
		 */
A
Alex Dima 已提交
3632
		layoutZone(id: string): void;
3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649
	}

	/**
	 * 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 已提交
3650
		BELOW = 2
3651 3652 3653 3654 3655 3656 3657 3658 3659 3660
	}

	/**
	 * A position for rendering content widgets.
	 */
	export interface IContentWidgetPosition {
		/**
		 * Desired position for the content widget.
		 * `preference` will also affect the placement.
		 */
A
Alex Dima 已提交
3661
		position: IPosition | null;
A
Alex Dima 已提交
3662 3663 3664 3665
		/**
		 * Optionally, a range can be provided to further
		 * define the position of the content widget.
		 */
A
Alex Dima 已提交
3666
		range?: IRange | null;
3667 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
		/**
		 * 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 已提交
3694
		getPosition(): IContentWidgetPosition | null;
3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711
	}

	/**
	 * 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 已提交
3712
		TOP_CENTER = 2
3713 3714 3715 3716 3717 3718 3719 3720 3721
	}

	/**
	 * A position for rendering overlay widgets.
	 */
	export interface IOverlayWidgetPosition {
		/**
		 * The position preference for the overlay widget.
		 */
A
Alex Dima 已提交
3722
		preference: OverlayWidgetPositionPreference | null;
3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740
	}

	/**
	 * 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 已提交
3741
		getPosition(): IOverlayWidgetPosition | null;
3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802
	}

	/**
	 * 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 已提交
3803
		OUTSIDE_EDITOR = 13
3804 3805 3806 3807 3808 3809 3810 3811 3812
	}

	/**
	 * Target hit with the mouse in the editor.
	 */
	export interface IMouseTarget {
		/**
		 * The target element
		 */
A
Alex Dima 已提交
3813
		readonly element: Element | null;
3814 3815 3816 3817 3818 3819 3820
		/**
		 * The target type
		 */
		readonly type: MouseTargetType;
		/**
		 * The 'approximate' editor position
		 */
A
Alex Dima 已提交
3821
		readonly position: Position | null;
3822 3823 3824 3825 3826 3827 3828
		/**
		 * 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 已提交
3829
		readonly range: Range | null;
3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843
		/**
		 * 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 已提交
3844
	export interface IPartialEditorMouseEvent {
3845
		readonly event: IMouseEvent;
A
Alex Dima 已提交
3846
		readonly target: IMouseTarget | null;
3847 3848 3849 3850 3851
	}

	/**
	 * A rich code editor.
	 */
A
Alex Dima 已提交
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
	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
		 */
3877
		onDidChangeConfiguration(listener: (e: ConfigurationChangedEvent) => void): IDisposable;
A
Alex Dima 已提交
3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898
		/**
		 * 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 已提交
3899
		 * An event emitted when the text inside this editor gained focus (i.e. cursor starts blinking).
A
Alex Dima 已提交
3900 3901 3902 3903
		 * @event
		 */
		onDidFocusEditorText(listener: () => void): IDisposable;
		/**
A
Alex Dima 已提交
3904
		 * An event emitted when the text inside this editor lost focus (i.e. cursor stops blinking).
A
Alex Dima 已提交
3905 3906 3907 3908 3909 3910 3911
		 * @event
		 */
		onDidBlurEditorText(listener: () => void): IDisposable;
		/**
		 * An event emitted when the text inside this editor or an editor widget gained focus.
		 * @event
		 */
A
Alex Dima 已提交
3912
		onDidFocusEditorWidget(listener: () => void): IDisposable;
A
Alex Dima 已提交
3913 3914 3915 3916
		/**
		 * An event emitted when the text inside this editor or an editor widget lost focus.
		 * @event
		 */
A
Alex Dima 已提交
3917
		onDidBlurEditorWidget(listener: () => void): IDisposable;
J
Johannes Rieken 已提交
3918 3919 3920 3921 3922 3923 3924 3925
		/**
		 * An event emitted after composition has started.
		 */
		onCompositionStart(listener: () => void): IDisposable;
		/**
		 * An event emitted after composition has ended.
		 */
		onCompositionEnd(listener: () => void): IDisposable;
3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949
		/**
		 * 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 已提交
3950
		onMouseLeave(listener: (e: IPartialEditorMouseEvent) => void): IDisposable;
3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970
		/**
		 * 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;
		/**
		 * An event emitted when the scroll in the editor has changed.
		 * @event
		 */
		onDidScrollChange(listener: (e: IScrollEvent) => void): IDisposable;
A
Alex Dima 已提交
3971 3972 3973
		/**
		 * Saves current view state of the editor in a serializable object.
		 */
A
Alex Dima 已提交
3974
		saveViewState(): ICodeEditorViewState | null;
A
Alex Dima 已提交
3975 3976 3977 3978 3979
		/**
		 * Restores the view state of the editor from a serializable object generated by `saveViewState`.
		 */
		restoreViewState(state: ICodeEditorViewState): void;
		/**
A
Alex Dima 已提交
3980
		 * Returns true if the text inside this editor or an editor widget has focus.
A
Alex Dima 已提交
3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991
		 */
		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 已提交
3992 3993 3994 3995 3996 3997 3998 3999 4000 4001
		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;
A
Alex Dima 已提交
4002
		/**
4003
		 * Returns the editor's configuration (without any validation or defaults).
A
Alex Dima 已提交
4004
		 */
4005
		getRawOptions(): IEditorOptions;
A
Alex Dima 已提交
4006 4007
		/**
		 * Get value of the current model attached to this editor.
4008
		 * @see `ITextModel.getValue`
A
Alex Dima 已提交
4009 4010 4011 4012 4013 4014 4015
		 */
		getValue(options?: {
			preserveBOM: boolean;
			lineEnding: string;
		}): string;
		/**
		 * Set the value of the current model attached to this editor.
4016
		 * @see `ITextModel.setValue`
A
Alex Dima 已提交
4017 4018 4019 4020 4021 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 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068
		 */
		setValue(newValue: string): void;
		/**
		 * Get the scrollWidth of the editor's viewport.
		 */
		getScrollWidth(): number;
		/**
		 * Get the scrollLeft of the editor's viewport.
		 */
		getScrollLeft(): number;
		/**
		 * 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 已提交
4069
		 * @param endCursorState Cursor state after the edits were applied.
A
Alex Dima 已提交
4070
		 */
4071
		executeEdits(source: string, edits: IIdentifiedSingleEditOperation[], endCursorState?: ICursorStateComputer | Selection[]): boolean;
A
Alex Dima 已提交
4072
		/**
A
Alex Dima 已提交
4073
		 * Execute multiple (concomitant) commands on the editor.
A
Alex Dima 已提交
4074 4075 4076
		 * @param source The source of the call.
		 * @param command The commands to execute
		 */
A
Alex Dima 已提交
4077
		executeCommands(source: string, commands: (ICommand | null)[]): void;
A
Alex Dima 已提交
4078 4079 4080
		/**
		 * Get all the decorations on a line (filtering out decorations from other editors).
		 */
A
Alex Dima 已提交
4081
		getLineDecorations(lineNumber: number): IModelDecoration[] | null;
A
Alex Dima 已提交
4082 4083
		/**
		 * All decorations added through this call will get the ownerId of this editor.
4084
		 * @see `ITextModel.deltaDecorations`
A
Alex Dima 已提交
4085 4086 4087 4088 4089 4090
		 */
		deltaDecorations(oldDecorations: string[], newDecorations: IModelDeltaDecoration[]): string[];
		/**
		 * Get the layout info for the editor.
		 */
		getLayoutInfo(): EditorLayoutInfo;
4091 4092 4093 4094 4095
		/**
		 * Returns the ranges that are currently visible.
		 * Does not account for horizontal scrolling.
		 */
		getVisibleRanges(): Range[];
A
Alex Dima 已提交
4096 4097 4098 4099 4100 4101 4102 4103
		/**
		 * 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;
4104 4105 4106
		/**
		 * Returns the editor's dom node
		 */
A
Alex Dima 已提交
4107
		getDomNode(): HTMLElement | null;
4108 4109 4110 4111 4112 4113
		/**
		 * 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 已提交
4114
		 * and update appropriately.
4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126
		 */
		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 已提交
4127
		 * and update appropriately.
4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146
		 */
		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.
		 */
4147
		render(forceRedraw?: boolean): void;
4148 4149 4150 4151 4152 4153
		/**
		 * 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 已提交
4154
		getTargetAtClientPoint(clientX: number, clientY: number): IMouseTarget | null;
4155 4156 4157 4158 4159
		/**
		 * 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 已提交
4160
		 * Warning: the results of this method are inaccurate for positions that are outside the current editor viewport.
4161 4162 4163 4164 4165
		 */
		getScrolledVisiblePosition(position: IPosition): {
			top: number;
			left: number;
			height: number;
A
Alex Dima 已提交
4166
		} | null;
4167 4168 4169 4170 4171 4172
		/**
		 * Apply the same font settings as the editor to `target`.
		 */
		applyFontInfo(target: HTMLElement): void;
	}

A
Alex Dima 已提交
4173 4174 4175 4176 4177 4178 4179
	/**
	 * Information about a line in the diff editor
	 */
	export interface IDiffLineInformation {
		readonly equivalentLineNumber: number;
	}

4180 4181 4182
	/**
	 * A rich diff editor.
	 */
A
Alex Dima 已提交
4183
	export interface IDiffEditor extends IEditor {
4184 4185 4186 4187
		/**
		 * @see ICodeEditor.getDomNode
		 */
		getDomNode(): HTMLElement;
A
Alex Dima 已提交
4188 4189 4190 4191 4192 4193 4194 4195
		/**
		 * 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 已提交
4196
		saveViewState(): IDiffEditorViewState | null;
A
Alex Dima 已提交
4197 4198 4199 4200 4201 4202 4203
		/**
		 * 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 已提交
4204 4205 4206 4207 4208 4209 4210 4211 4212 4213
		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;
4214 4215 4216 4217 4218 4219 4220 4221
		/**
		 * Get the `original` editor.
		 */
		getOriginalEditor(): ICodeEditor;
		/**
		 * Get the `modified` editor.
		 */
		getModifiedEditor(): ICodeEditor;
A
Alex Dima 已提交
4222 4223 4224
		/**
		 * Get the computed diff information.
		 */
A
Alex Dima 已提交
4225
		getLineChanges(): ILineChange[] | null;
A
Alex Dima 已提交
4226 4227 4228 4229
		/**
		 * 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 已提交
4230
		getDiffLineInformationForOriginal(lineNumber: number): IDiffLineInformation | null;
A
Alex Dima 已提交
4231 4232 4233 4234
		/**
		 * 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 已提交
4235
		getDiffLineInformationForModified(lineNumber: number): IDiffLineInformation | null;
4236 4237 4238 4239
		/**
		 * Update the editor's options after the editor has been created.
		 */
		updateOptions(newOptions: IDiffEditorOptions): void;
4240 4241 4242 4243 4244 4245 4246 4247
	}

	export class FontInfo extends BareFontInfo {
		readonly _editorStylingBrand: void;
		readonly isTrusted: boolean;
		readonly isMonospace: boolean;
		readonly typicalHalfwidthCharacterWidth: number;
		readonly typicalFullwidthCharacterWidth: number;
4248
		readonly canUseHalfwidthRightwardsArrow: boolean;
4249 4250 4251
		readonly spaceWidth: number;
		readonly maxDigitWidth: number;
	}
4252

4253 4254 4255 4256 4257 4258
	export class BareFontInfo {
		readonly _bareFontInfoBrand: void;
		readonly zoomLevel: number;
		readonly fontFamily: string;
		readonly fontWeight: string;
		readonly fontSize: number;
4259
		readonly fontFeatureSettings: string;
4260
		readonly lineHeight: number;
4261
		readonly letterSpacing: number;
4262
	}
4263 4264 4265 4266

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

A
Alex Dima 已提交
4269
declare namespace monaco.languages {
A
Alex Dima 已提交
4270 4271


4272 4273 4274 4275 4276 4277 4278 4279 4280 4281
	/**
	 * 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 已提交
4282
	export function getEncodedLanguageId(languageId: string): number;
M
Martin Aeschlimann 已提交
4283

4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317
	/**
	 * 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 已提交
4318 4319 4320
	/**
	 * The result of a line tokenization.
	 */
M
Martin Aeschlimann 已提交
4321
	export interface IEncodedLineTokens {
M
Martin Aeschlimann 已提交
4322
		/**
M
Martin Aeschlimann 已提交
4323
		 * The tokens on the line in a binary, encoded format. Each token occupies two array indices. For token i:
M
Martin Aeschlimann 已提交
4324 4325 4326 4327 4328 4329 4330 4331 4332
		 *  - 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 已提交
4333 4334 4335 4336 4337 4338
		 *  - 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:
4339
		 * e.g. colorId = 1 is stored in IStandaloneThemeData.customTokenColors[1]. Color id = 0 means no color,
M
Martin Aeschlimann 已提交
4340
		 * id = 1 is for the default foreground color, id = 2 for the default background.
M
Martin Aeschlimann 已提交
4341 4342 4343 4344 4345 4346 4347 4348 4349
		 */
		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;
	}

4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363
	/**
	 * 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 已提交
4364 4365 4366
	/**
	 * A "manual" provider of tokens, returning tokens in a binary form.
	 */
M
Martin Aeschlimann 已提交
4367
	export interface EncodedTokensProvider {
M
Martin Aeschlimann 已提交
4368 4369 4370 4371 4372 4373 4374
		/**
		 * 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 已提交
4375
		tokenizeEncoded(line: string, state: IState): IEncodedLineTokens;
M
Martin Aeschlimann 已提交
4376 4377
	}

4378 4379 4380
	/**
	 * Set the tokens provider for a language (manual implementation).
	 */
4381
	export function setTokensProvider(languageId: string, provider: TokensProvider | EncodedTokensProvider | Thenable<TokensProvider | EncodedTokensProvider>): IDisposable;
M
Martin Aeschlimann 已提交
4382

4383 4384 4385
	/**
	 * Set the tokens provider for a language (monarch implementation).
	 */
4386
	export function setMonarchTokensProvider(languageId: string, languageDef: IMonarchLanguage | Thenable<IMonarchLanguage>): IDisposable;
4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398

	/**
	 * 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 已提交
4399
	 * Register a signature help provider (used by e.g. parameter hints).
4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413
	 */
	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;

	/**
4414
	 * Register a document highlight provider (used by e.g. highlight occurrences).
4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467
	 */
	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 已提交
4468 4469 4470 4471 4472
	/**
	 * Register a document color provider (used by Color Picker, Color Decorator).
	 */
	export function registerColorProvider(languageId: string, provider: DocumentColorProvider): IDisposable;

4473
	/**
4474
	 * Register a folding range provider
4475
	 */
4476 4477
	export function registerFoldingRangeProvider(languageId: string, provider: FoldingRangeProvider): IDisposable;

4478 4479 4480 4481 4482 4483 4484 4485 4486 4487
	/**
	 * 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;

4488 4489 4490 4491 4492 4493 4494 4495 4496
	/**
	 * 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[];
4497 4498 4499 4500
		/**
		 * Requested kind of actions to return.
		 */
		readonly only?: string;
4501 4502 4503 4504 4505 4506 4507 4508 4509 4510
	}

	/**
	 * 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.
		 */
4511
		provideCodeActions(model: editor.ITextModel, range: Range, context: CodeActionContext, token: CancellationToken): CodeActionList | Promise<CodeActionList>;
4512 4513 4514 4515 4516 4517 4518 4519 4520
	}

	/**
	 * Describes how comments for a language work.
	 */
	export interface CommentRule {
		/**
		 * The line comment token, like `// this is a comment`
		 */
A
Alex Dima 已提交
4521
		lineComment?: string | null;
4522 4523 4524
		/**
		 * The block comment character pair, like `/* block comment *&#47;`
		 */
A
Alex Dima 已提交
4525
		blockComment?: CharacterPair | null;
4526 4527 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
	}

	/**
	 * 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 已提交
4569 4570 4571 4572 4573 4574
		/**
		 * 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;
4575 4576 4577 4578
		/**
		 * The language's folding rules.
		 */
		folding?: FoldingRules;
4579 4580 4581 4582 4583
		/**
		 * **Deprecated** Do not use.
		 *
		 * @deprecated Will be replaced by a better API soon.
		 */
4584 4585 4586
		__electricCharacterSupport?: {
			docComment?: IDocComment;
		};
4587 4588 4589 4590 4591 4592 4593
	}

	/**
	 * Describes indentation rules for a language.
	 */
	export interface IndentationRule {
		/**
A
Alex Dima 已提交
4594
		 * If a line matches this pattern, then all the lines after it should be unindented once (until another rule matches).
4595 4596 4597 4598 4599 4600 4601 4602 4603
		 */
		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 已提交
4604
		indentNextLinePattern?: RegExp | null;
4605 4606 4607
		/**
		 * 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 已提交
4608
		unIndentedLinePattern?: RegExp | null;
4609 4610
	}

4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621
	/**
	 * 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;
	}

4622 4623 4624 4625
	/**
	 * Describes folding rules for a language.
	 */
	export interface FoldingRules {
4626
		/**
A
Alex Dima 已提交
4627
		 * Used by the indentation based strategy to decide whether empty lines belong to the previous or the next block.
4628 4629 4630 4631 4632
		 * 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;
4633 4634 4635 4636
		/**
		 * Region markers used by the language.
		 */
		markers?: FoldingMarkers;
4637 4638
	}

4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650
	/**
	 * 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;
4651 4652 4653 4654
		/**
		 * This rule will only execute if the text above the this line matches this regular expression.
		 */
		oneLineAboveText?: RegExp;
4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671
		/**
		 * 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. ' * /').
		 */
4672
		close?: string;
4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710
	}

	/**
	 * 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 已提交
4711
		Outdent = 3
4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741
	}

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

4742 4743 4744 4745 4746 4747 4748 4749
	/**
	 * 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>;

4750 4751 4752 4753 4754 4755 4756 4757
	/**
	 * 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.
		 */
4758
		contents: IMarkdownString[];
4759 4760 4761 4762 4763
		/**
		 * 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 已提交
4764
		range?: IRange;
4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776
	}

	/**
	 * 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.
		 */
4777
		provideHover(model: editor.ITextModel, position: Position, token: CancellationToken): ProviderResult<Hover>;
4778 4779
	}

4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798
	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 已提交
4799 4800 4801 4802 4803 4804 4805 4806
		Text = 18,
		Color = 19,
		File = 20,
		Reference = 21,
		Customcolor = 22,
		Folder = 23,
		TypeParameter = 24,
		Snippet = 25
4807 4808
	}

4809
	export enum CompletionItemTag {
4810 4811 4812
		Deprecated = 1
	}

4813 4814
	export enum CompletionItemInsertTextRule {
		/**
J
Johannes Rieken 已提交
4815 4816
		 * Adjust whitespace/indentation of multiline insert texts to
		 * match the current line indentation.
4817
		 */
4818
		KeepWhitespace = 1,
4819
		/**
4820
		 * `insertText` is a snippet.
4821
		 */
4822
		InsertAsSnippet = 4
4823 4824
	}

4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840
	/**
	 * 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.
		 */
		label: string;
		/**
		 * The kind of this completion item. Based on the kind
		 * an icon is chosen by the editor.
		 */
		kind: CompletionItemKind;
4841
		/**
4842 4843
		 * A modifier to the `kind` which affect how the item
		 * is rendered, e.g. Deprecated is rendered with a strikeout
4844
		 */
4845
		tags?: ReadonlyArray<CompletionItemTag>;
4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866
		/**
		 * 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 已提交
4867 4868 4869 4870 4871
		/**
		 * 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.
		 */
4872 4873 4874
		preselect?: boolean;
		/**
		 * A string or snippet that should be inserted in a document when selecting
4875
		 * this completion.
4876 4877
		 * is used.
		 */
4878
		insertText: string;
4879
		/**
4880 4881
		 * Addition rules (as bitmask) that should be applied when inserting
		 * this completion.
4882
		 */
4883
		insertTextRules?: CompletionItemInsertTextRule;
4884 4885 4886 4887 4888 4889 4890 4891 4892
		/**
		 * 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 已提交
4893 4894 4895 4896
		range: IRange | {
			insert: IRange;
			replace: IRange;
		};
4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918
		/**
		 * 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;
4919 4920
	}

M
Matt Bierner 已提交
4921 4922 4923
	/**
	 * How a suggest provider was triggered.
	 */
4924
	export enum CompletionTriggerKind {
M
Matt Bierner 已提交
4925 4926
		Invoke = 0,
		TriggerCharacter = 1,
R
Rob Lourens 已提交
4927
		TriggerForIncompleteCompletions = 2
M
Matt Bierner 已提交
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
	/**
	 * 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>;
	}

4973 4974 4975
	export interface CodeAction {
		title: string;
		command?: Command;
4976
		edit?: WorkspaceEdit;
4977
		diagnostics?: editor.IMarkerData[];
4978
		kind?: string;
4979
		isPreferred?: boolean;
4980 4981
	}

4982 4983 4984 4985
	export interface CodeActionList extends IDisposable {
		readonly actions: ReadonlyArray<CodeAction>;
	}

4986 4987 4988 4989 4990 4991 4992 4993 4994
	/**
	 * 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.
		 */
4995
		label: string | [number, number];
4996 4997 4998 4999
		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
B
Benjamin Pasero 已提交
5000
		documentation?: string | IMarkdownString;
5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017
	}

	/**
	 * 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 已提交
5018
		documentation?: string | IMarkdownString;
5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044
		/**
		 * 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;
	}

5045 5046 5047 5048
	export interface SignatureHelpResult extends IDisposable {
		value: SignatureHelp;
	}

M
Matt Bierner 已提交
5049
	export enum SignatureHelpTriggerKind {
5050 5051
		Invoke = 1,
		TriggerCharacter = 2,
5052
		ContentChange = 3
5053 5054 5055
	}

	export interface SignatureHelpContext {
5056
		readonly triggerKind: SignatureHelpTriggerKind;
5057 5058
		readonly triggerCharacter?: string;
		readonly isRetrigger: boolean;
5059
		readonly activeSignatureHelp?: SignatureHelp;
5060 5061
	}

5062 5063 5064 5065 5066
	/**
	 * 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 已提交
5067 5068
		readonly signatureHelpTriggerCharacters?: ReadonlyArray<string>;
		readonly signatureHelpRetriggerCharacters?: ReadonlyArray<string>;
5069 5070 5071
		/**
		 * Provide help for the signature at the given position and document.
		 */
5072
		provideSignatureHelp(model: editor.ITextModel, position: Position, token: CancellationToken, context: SignatureHelpContext): ProviderResult<SignatureHelpResult>;
5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089
	}

	/**
	 * 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 已提交
5090
		Write = 2
5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105
	}

	/**
	 * 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).
		 */
5106
		kind?: DocumentHighlightKind;
5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117
	}

	/**
	 * 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.
		 */
5118
		provideDocumentHighlights(model: editor.ITextModel, position: Position, token: CancellationToken): ProviderResult<DocumentHighlight[]>;
5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139
	}

	/**
	 * 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.
		 */
5140
		provideReferences(model: editor.ITextModel, position: Position, context: ReferenceContext, token: CancellationToken): ProviderResult<Location[]>;
5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157
	}

	/**
	 * 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 已提交
5158 5159 5160 5161 5162 5163 5164 5165
	export interface LocationLink {
		/**
		 * A range to select where this link originates from.
		 */
		originSelectionRange?: IRange;
		/**
		 * The target uri this link points to.
		 */
M
Matt Bierner 已提交
5166
		uri: Uri;
J
Johannes Rieken 已提交
5167 5168 5169
		/**
		 * The full range this link points to.
		 */
M
Matt Bierner 已提交
5170
		range: IRange;
J
Johannes Rieken 已提交
5171 5172 5173 5174 5175
		/**
		 * A range to select this link points to. Must be contained
		 * in `LocationLink.range`.
		 */
		targetSelectionRange?: IRange;
M
Matt Bierner 已提交
5176 5177
	}

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

5180 5181 5182 5183 5184 5185 5186 5187 5188
	/**
	 * 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 已提交
5189
		provideDefinition(model: editor.ITextModel, position: Position, token: CancellationToken): ProviderResult<Definition | LocationLink[]>;
5190 5191
	}

J
Johannes Rieken 已提交
5192 5193 5194 5195 5196 5197 5198 5199 5200
	/**
	 * 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 已提交
5201
		provideDeclaration(model: editor.ITextModel, position: Position, token: CancellationToken): ProviderResult<Definition | LocationLink[]>;
J
Johannes Rieken 已提交
5202 5203
	}

5204 5205 5206 5207 5208 5209 5210 5211
	/**
	 * 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 已提交
5212
		provideImplementation(model: editor.ITextModel, position: Position, token: CancellationToken): ProviderResult<Definition | LocationLink[]>;
5213 5214 5215 5216 5217 5218 5219 5220 5221 5222
	}

	/**
	 * 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 已提交
5223
		provideTypeDefinition(model: editor.ITextModel, position: Position, token: CancellationToken): ProviderResult<Definition | LocationLink[]>;
5224 5225 5226 5227 5228 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
	}

	/**
	 * 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 已提交
5255
		TypeParameter = 25
5256 5257
	}

5258
	export enum SymbolTag {
5259 5260 5261
		Deprecated = 1
	}

5262
	export interface DocumentSymbol {
5263
		name: string;
5264
		detail: string;
5265
		kind: SymbolKind;
5266
		tags: ReadonlyArray<SymbolTag>;
5267
		containerName?: string;
5268 5269
		range: IRange;
		selectionRange: IRange;
5270
		children?: DocumentSymbol[];
5271 5272 5273 5274
	}

	/**
	 * The document symbol provider interface defines the contract between extensions and
L
Lars Hvam 已提交
5275
	 * the [go to symbol](https://code.visualstudio.com/docs/editor/editingevolved#_go-to-symbol)-feature.
5276 5277
	 */
	export interface DocumentSymbolProvider {
5278
		displayName?: string;
5279 5280 5281
		/**
		 * Provide symbol information for the given document.
		 */
5282
		provideDocumentSymbols(model: editor.ITextModel, token: CancellationToken): ProviderResult<DocumentSymbol[]>;
5283 5284
	}

A
Alex Dima 已提交
5285
	export type TextEdit = {
5286 5287 5288
		range: IRange;
		text: string;
		eol?: editor.EndOfLineSequence;
A
Alex Dima 已提交
5289
	};
5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309

	/**
	 * 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 已提交
5310
		readonly displayName?: string;
5311 5312 5313
		/**
		 * Provide formatting edits for a whole document.
		 */
5314
		provideDocumentFormattingEdits(model: editor.ITextModel, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
5315 5316 5317 5318 5319 5320 5321
	}

	/**
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
	 */
	export interface DocumentRangeFormattingEditProvider {
J
Johannes Rieken 已提交
5322
		readonly displayName?: string;
5323 5324 5325 5326 5327 5328 5329
		/**
		 * 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.
		 */
5330
		provideDocumentRangeFormattingEdits(model: editor.ITextModel, range: Range, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345
	}

	/**
	 * 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.
		 */
5346
		provideOnTypeFormattingEdits(model: editor.ITextModel, position: Position, ch: string, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
5347 5348 5349 5350 5351 5352 5353
	}

	/**
	 * A link inside the editor.
	 */
	export interface ILink {
		range: IRange;
M
Martin Aeschlimann 已提交
5354
		url?: Uri | string;
5355
		tooltip?: string;
5356 5357
	}

5358 5359 5360 5361 5362
	export interface ILinksList {
		links: ILink[];
		dispose?(): void;
	}

5363 5364 5365 5366
	/**
	 * A provider of links.
	 */
	export interface LinkProvider {
5367
		provideLinks(model: editor.ITextModel, token: CancellationToken): ProviderResult<ILinksList>;
5368
		resolveLink?: (link: ILink, token: CancellationToken) => ProviderResult<ILink>;
5369 5370
	}

R
rebornix 已提交
5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393
	/**
	 * 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;
	}

	/**
5394
	 * String representations for a color
R
rebornix 已提交
5395
	 */
5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412
	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 已提交
5413 5414 5415 5416 5417
	}

	/**
	 * A color range is a range in a text model which represents a color.
	 */
5418
	export interface IColorInformation {
R
rebornix 已提交
5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435
		/**
		 * 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.
		 */
5436
		provideDocumentColors(model: editor.ITextModel, token: CancellationToken): ProviderResult<IColorInformation[]>;
B
Benjamin Pasero 已提交
5437
		/**
5438
		 * Provide the string representations for a color.
B
Benjamin Pasero 已提交
5439
		 */
5440
		provideColorPresentations(model: editor.ITextModel, colorInfo: IColorInformation, token: CancellationToken): ProviderResult<IColorPresentation[]>;
5441 5442
	}

5443 5444 5445 5446
	export interface SelectionRange {
		range: IRange;
	}

5447 5448 5449 5450
	export interface SelectionRangeProvider {
		/**
		 * Provide ranges that should be selected from the given position.
		 */
5451
		provideSelectionRanges(model: editor.ITextModel, positions: Position[], token: CancellationToken): ProviderResult<SelectionRange[][]>;
5452 5453
	}

5454 5455 5456 5457 5458 5459 5460 5461 5462 5463
	export interface FoldingContext {
	}

	/**
	 * A provider of colors for editor models.
	 */
	export interface FoldingRangeProvider {
		/**
		 * Provides the color ranges for a specific model.
		 */
5464
		provideFoldingRanges(model: editor.ITextModel, context: FoldingContext, token: CancellationToken): ProviderResult<FoldingRange[]>;
5465 5466 5467 5468
	}

	export interface FoldingRange {
		/**
5469
		 * The one-based start line of the range to fold. The folded area starts after the line's last character.
5470 5471 5472
		 */
		start: number;
		/**
5473
		 * The one-based end line of the range to fold. The folded area ends with the line's last character.
5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507
		 */
		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);
	}

5508 5509 5510
	export interface ResourceFileEdit {
		oldUri: Uri;
		newUri: Uri;
5511
		options: {
5512
			overwrite?: boolean;
J
Johannes Rieken 已提交
5513
			ignoreIfNotExists?: boolean;
5514
			ignoreIfExists?: boolean;
5515
			recursive?: boolean;
5516
		};
R
rebornix 已提交
5517 5518
	}

5519
	export interface ResourceTextEdit {
5520
		resource: Uri;
5521 5522
		modelVersionId?: number;
		edits: TextEdit[];
5523 5524 5525
	}

	export interface WorkspaceEdit {
M
Matt Bierner 已提交
5526
		edits: Array<ResourceTextEdit | ResourceFileEdit>;
5527 5528 5529
	}

	export interface Rejection {
5530 5531 5532
		rejectReason?: string;
	}

5533 5534 5535 5536 5537
	export interface RenameLocation {
		range: IRange;
		text: string;
	}

5538
	export interface RenameProvider {
5539
		provideRenameEdits(model: editor.ITextModel, position: Position, newName: string, token: CancellationToken): ProviderResult<WorkspaceEdit & Rejection>;
5540
		resolveRenameLocation?(model: editor.ITextModel, position: Position, token: CancellationToken): ProviderResult<RenameLocation & Rejection>;
5541 5542 5543 5544 5545 5546 5547 5548 5549
	}

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

5550
	export interface CodeLens {
5551 5552 5553 5554 5555
		range: IRange;
		id?: string;
		command?: Command;
	}

5556 5557 5558 5559 5560
	export interface CodeLensList {
		lenses: CodeLens[];
		dispose(): void;
	}

5561 5562
	export interface CodeLensProvider {
		onDidChange?: IEvent<this>;
5563 5564
		provideCodeLenses(model: editor.ITextModel, token: CancellationToken): ProviderResult<CodeLensList>;
		resolveCodeLens?(model: editor.ITextModel, codeLens: CodeLens, token: CancellationToken): ProviderResult<CodeLens>;
5565 5566
	}

A
wip  
Alexandru Dima 已提交
5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592
	export interface SemanticColoringLegend {
		readonly tokenTypes: string[];
		readonly tokenModifiers: string[];
	}

	export interface SemanticColoringArea {
		/**
		 * The zero-based line value where this token block begins.
		 */
		readonly line: number;
		/**
		 * The actual token block encoded data.
		 */
		readonly data: Uint32Array;
	}

	export interface SemanticColoring {
		readonly areas: SemanticColoringArea[];
		dispose(): void;
	}

	export interface SemanticColoringProvider {
		getLegend(): SemanticColoringLegend;
		provideSemanticColoring(model: editor.ITextModel, token: CancellationToken): ProviderResult<SemanticColoring>;
	}

5593 5594 5595 5596 5597 5598 5599 5600
	export interface ILanguageExtensionPoint {
		id: string;
		extensions?: string[];
		filenames?: string[];
		filenamePatterns?: string[];
		firstLine?: string;
		aliases?: string[];
		mimetypes?: string[];
5601
		configuration?: Uri;
5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631
	}
	/**
	 * 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 已提交
5632
		tokenPostfix?: string;
5633 5634 5635 5636 5637 5638 5639
	}

	/**
	 * 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 }}
	 */
5640 5641 5642 5643
	export type IShortMonarchLanguageRule1 = [RegExp, IMonarchLanguageAction];

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

A
Alex Dima 已提交
5644
	export interface IExpandedMonarchLanguageRule {
5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658
		/**
		 * 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 已提交
5659 5660
	export type IMonarchLanguageRule = IShortMonarchLanguageRule1 | IShortMonarchLanguageRule2 | IExpandedMonarchLanguageRule;

5661 5662 5663 5664 5665
	/**
	 * An action is either an array of actions...
	 * ... or a case statement with guards...
	 * ... or a basic action with a token value.
	 */
5666 5667 5668
	export type IShortMonarchLanguageAction = string;

	export interface IExpandedMonarchLanguageAction {
5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697
		/**
		 * 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 已提交
5698
		 * switch to embedded language (using the mimetype) or get out using "@pop"
5699 5700 5701 5702 5703 5704 5705 5706
		 */
		nextEmbedded?: string;
		/**
		 * log a message to the browser console window
		 */
		log?: string;
	}

5707 5708
	export type IMonarchLanguageAction = IShortMonarchLanguageAction | IExpandedMonarchLanguageAction | IShortMonarchLanguageAction[] | IExpandedMonarchLanguageAction[];

5709 5710 5711 5712 5713 5714 5715 5716 5717
	/**
	 * This interface can be shortened as an array, ie. ['{','}','delimiter.curly']
	 */
	export interface IMonarchLanguageBracket {
		/**
		 * open bracket
		 */
		open: string;
		/**
A
Alex Dima 已提交
5718
		 * closing bracket
5719 5720 5721 5722 5723 5724 5725
		 */
		close: string;
		/**
		 * token class
		 */
		token: string;
	}
5726 5727 5728

}

A
Alex Dima 已提交
5729
declare namespace monaco.worker {
5730

5731

5732 5733 5734 5735 5736
	export interface IMirrorModel {
		readonly uri: Uri;
		readonly version: number;
		getValue(): string;
	}
5737

5738 5739 5740 5741 5742
	export interface IWorkerContext<H = undefined> {
		/**
		 * A proxy to the main thread host object.
		 */
		host: H;
5743 5744 5745 5746 5747
		/**
		 * Get all available mirror models in this worker.
		 */
		getMirrorModels(): IMirrorModel[];
	}
5748

5749
}
5750

5751
//dtsv=2