vscode.d.ts 116.5 KB
Newer Older
E
Erich Gamma 已提交
1 2 3 4 5 6 7 8
/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

declare namespace vscode {

	/**
9
	 * The version of the editor.
E
Erich Gamma 已提交
10
	 */
11
	export const version: string;
E
Erich Gamma 已提交
12 13 14 15

	/**
	 * Represents a reference to a command. Provides a title which
	 * will be used to represent a command in the UI and, optionally,
S
Steven Clarke 已提交
16
	 * an array of arguments which will be passed to the command handler
E
Erich Gamma 已提交
17 18 19 20
	 * function when invoked.
	 */
	export interface Command {
		/**
J
Johannes Rieken 已提交
21
		 * Title of the command, like `save`.
E
Erich Gamma 已提交
22 23 24 25
		 */
		title: string;

		/**
A
Alex Dima 已提交
26
		 * The identifier of the actual command handler.
J
Johannes Rieken 已提交
27
		 * @see [commands.registerCommand](#commands.registerCommand).
E
Erich Gamma 已提交
28 29 30 31
		 */
		command: string;

		/**
A
Andre Weinand 已提交
32
		 * Arguments that the command handler should be
A
Alex Dima 已提交
33
		 * invoked with.
E
Erich Gamma 已提交
34 35 36 37 38
		 */
		arguments?: any[];
	}

	/**
A
Andre Weinand 已提交
39
	 * Represents a line of text, such as a line of source code.
J
Johannes Rieken 已提交
40
	 *
A
Alex Dima 已提交
41
	 * TextLine objects are __immutable__. When a [document](#TextDocument) changes,
S
Typo  
Steven Clarke 已提交
42
	 * previously retrieved lines will not represent the latest state.
E
Erich Gamma 已提交
43 44 45 46
	 */
	export interface TextLine {

		/**
A
Alex Dima 已提交
47
		 * The zero-based line number.
E
Erich Gamma 已提交
48 49 50 51 52 53
		 *
		 * @readonly
		 */
		lineNumber: number;

		/**
J
Johannes Rieken 已提交
54
		 * The text of this line without the line separator characters.
E
Erich Gamma 已提交
55 56 57 58 59 60
		 *
		 * @readonly
		 */
		text: string;

		/**
J
Johannes Rieken 已提交
61
		 * The range this line covers without the line separator characters.
E
Erich Gamma 已提交
62 63 64 65 66 67
		 *
		 * @readonly
		 */
		range: Range;

		/**
J
Johannes Rieken 已提交
68
		 * The range this line covers with the line separator characters.
E
Erich Gamma 已提交
69 70 71 72 73 74
		 *
		 * @readonly
		 */
		rangeIncludingLineBreak: Range;

		/**
J
Johannes Rieken 已提交
75 76
		 * The offset of the first character which is not a whitespace character as defined
		 * by `/\s/`.
E
Erich Gamma 已提交
77 78 79 80 81 82 83
		 *
		 * @readonly
		 */
		firstNonWhitespaceCharacterIndex: number;

		/**
		 * Whether this line is whitespace only, shorthand
J
Johannes Rieken 已提交
84
		 * for [TextLine.firstNonWhitespaceCharacterIndex](#TextLine.firstNonWhitespaceCharacterIndex]) === [TextLine.text.length](#TextLine.text.length).
E
Erich Gamma 已提交
85 86 87 88 89 90 91 92 93 94 95 96 97
		 *
		 * @readonly
		 */
		isEmptyOrWhitespace: boolean;
	}

	/**
	 * Represents a text document, such as a source file. Text documents have
	 * [lines](#TextLine) and knowledge about an underlying resource like a file.
	 */
	export interface TextDocument {

		/**
J
Johannes Rieken 已提交
98 99 100
		 * The associated URI for this document. Most documents have the __file__-scheme, indicating that they
		 * represent files on disk. However, some documents may have other schemes indicating that they are not
		 * available on disk.
E
Erich Gamma 已提交
101 102 103 104 105 106
		 *
		 * @readonly
		 */
		uri: Uri;

		/**
J
Johannes Rieken 已提交
107
		 * The file system path of the associated resource. Shorthand
J
Johannes Rieken 已提交
108
		 * notation for [TextDocument.uri.fsPath](#TextDocument.uri.fsPath). Independent of the uri scheme.
E
Erich Gamma 已提交
109 110 111 112 113 114 115 116 117 118 119 120 121
		 *
		 * @readonly
		 */
		fileName: string;

		/**
		 * Is this document representing an untitled file.
		 *
		 * @readonly
		 */
		isUntitled: boolean;

		/**
J
Johannes Rieken 已提交
122
		 * The identifier of the language associated with this document.
E
Erich Gamma 已提交
123 124 125 126 127 128 129 130 131 132 133 134 135 136
		 *
		 * @readonly
		 */
		languageId: string;

		/**
		 * The version number of this document (it will strictly increase after each
		 * change, including undo/redo).
		 *
		 * @readonly
		 */
		version: number;

		/**
A
Andre Weinand 已提交
137
		 * true if there are unpersisted changes.
E
Erich Gamma 已提交
138 139 140 141 142 143 144 145 146
		 *
		 * @readonly
		 */
		isDirty: boolean;

		/**
		 * Save the underlying file.
		 *
		 * @return A promise that will resolve to true when the file
147 148
		 * has been saved. If the file was not dirty or the save failed,
		 * will return false.
E
Erich Gamma 已提交
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
		 */
		save(): Thenable<boolean>;

		/**
		 * The number of lines in this document.
		 *
		 * @readonly
		 */
		lineCount: number;

		/**
		 * Returns a text line denoted by the line number. Note
		 * that the returned object is *not* live and changes to the
		 * document are not reflected.
		 *
A
Alex Dima 已提交
164 165
		 * @param line A line number in [0, lineCount).
		 * @return A [line](#TextLine).
E
Erich Gamma 已提交
166 167 168 169 170 171 172 173
		 */
		lineAt(line: number): TextLine;

		/**
		 * Returns a text line denoted by the position. Note
		 * that the returned object is *not* live and changes to the
		 * document are not reflected.
		 *
A
Alex Dima 已提交
174 175
		 * The position will be [adjusted](#TextDocument.validatePosition).
		 *
J
Johannes Rieken 已提交
176
		 * @see [TextDocument.lineAt](#TextDocument.lineAt)
A
Alex Dima 已提交
177 178
		 * @param position A position.
		 * @return A [line](#TextLine).
E
Erich Gamma 已提交
179 180 181 182 183
		 */
		lineAt(position: Position): TextLine;

		/**
		 * Converts the position to a zero-based offset.
A
Alex Dima 已提交
184 185 186 187 188
		 *
		 * The position will be [adjusted](#TextDocument.validatePosition).
		 *
		 * @param position A position.
		 * @return A valid zero-based offset.
E
Erich Gamma 已提交
189 190 191 192 193
		 */
		offsetAt(position: Position): number;

		/**
		 * Converts a zero-based offset to a position.
A
Alex Dima 已提交
194 195 196
		 *
		 * @param offset A zero-based offset.
		 * @return A valid [position](#Position).
E
Erich Gamma 已提交
197 198 199 200
		 */
		positionAt(offset: number): Position;

		/**
J
Johannes Rieken 已提交
201 202 203 204
		 * Get the text of this document. A substring can be retrieved by providing
		 * a range. The range will be [adjusted](#TextDocument.validateRange).
		 *
		 * @param range Include only the text included by the range.
A
Alex Dima 已提交
205
		 * @return The text inside the provided range or the entire text.
E
Erich Gamma 已提交
206 207 208 209
		 */
		getText(range?: Range): string;

		/**
J
Johannes Rieken 已提交
210 211 212 213
		 * Get a word-range at the given position. By default words are defined by
		 * common separators, like space, -, _, etc. In addition, per languge custom
		 * [word definitions](#LanguageConfiguration.wordPattern) can be defined.
		 *
A
Alex Dima 已提交
214 215
		 * The position will be [adjusted](#TextDocument.validatePosition).
		 *
J
Johannes Rieken 已提交
216 217
		 * @param position A position.
		 * @return A range spanning a word, or `undefined`.
E
Erich Gamma 已提交
218 219 220 221
		 */
		getWordRangeAtPosition(position: Position): Range;

		/**
J
Johannes Rieken 已提交
222 223 224 225
		 * Ensure a range is completely contained in this document.
		 *
		 * @param range A range.
		 * @return The given range or a new, adjusted range.
E
Erich Gamma 已提交
226 227 228 229
		 */
		validateRange(range: Range): Range;

		/**
A
Andre Weinand 已提交
230
		 * Ensure a position is contained in the range of this document.
J
Johannes Rieken 已提交
231 232 233
		 *
		 * @param position A position.
		 * @return The given position or a new, adjusted position.
E
Erich Gamma 已提交
234 235 236 237 238 239
		 */
		validatePosition(position: Position): Position;
	}

	/**
	 * Represents a line and character position, such as
A
Alex Dima 已提交
240
	 * the position of the cursor.
E
Erich Gamma 已提交
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
	 *
	 * Position objects are __immutable__. Use the [with](#Position.with) or
	 * [translate](#Position.translate) methods to derive new positions
	 * from an existing position.
	 */
	export class Position {

		/**
		 * The zero-based line value.
		 * @readonly
		 */
		line: number;

		/**
		 * The zero-based character value.
		 * @readonly
		 */
		character: number;

		/**
A
Alex Dima 已提交
261 262
		 * @param line A zero-based line value.
		 * @param character A zero-based character value.
E
Erich Gamma 已提交
263 264 265 266
		 */
		constructor(line: number, character: number);

		/**
A
Alex Dima 已提交
267 268 269
		 * Check if `other` is before this position.
		 *
		 * @param other A position.
E
Erich Gamma 已提交
270
		 * @return `true` if position is on a smaller line
A
Alex Dima 已提交
271
		 * or on the same line on a smaller character.
E
Erich Gamma 已提交
272 273 274 275
		 */
		isBefore(other: Position): boolean;

		/**
A
Alex Dima 已提交
276 277 278 279 280
		 * Check if `other` is before or equal to this position.
		 *
		 * @param other A position.
		 * @return `true` if position is on a smaller line
		 * or on the same line on a smaller or equal character.
E
Erich Gamma 已提交
281 282 283 284
		 */
		isBeforeOrEqual(other: Position): boolean;

		/**
A
Alex Dima 已提交
285 286 287
		 * Check if `other` is after this position.
		 *
		 * @param other A position.
E
Erich Gamma 已提交
288
		 * @return `true` if position is on a greater line
A
Alex Dima 已提交
289
		 * or on the same line on a greater character.
E
Erich Gamma 已提交
290 291 292 293
		 */
		isAfter(other: Position): boolean;

		/**
A
Alex Dima 已提交
294 295 296 297 298
		 * Check if `other` is after or equal to this position.
		 *
		 * @param other A position.
		 * @return `true` if position is on a greater line
		 * or on the same line on a greater or equal character.
E
Erich Gamma 已提交
299 300 301 302
		 */
		isAfterOrEqual(other: Position): boolean;

		/**
A
Alex Dima 已提交
303 304 305
		 * Check if `other` equals this position.
		 *
		 * @param other A position.
E
Erich Gamma 已提交
306 307 308 309 310 311
		 * @return `true` if the line and character of the given position are equal to
		 * the line and character of this position.
		 */
		isEqual(other: Position): boolean;

		/**
A
Alex Dima 已提交
312 313 314 315 316
		 * Compare this to `other`.
		 *
		 * @param other A position.
		 * @return A number smaller than zero if this position is before the given position,
		 * a number greater than zero if this position is after the given position, or zero when
E
Erich Gamma 已提交
317 318 319 320 321
		 * this and the given position are equal.
		 */
		compareTo(other: Position): number;

		/**
A
Alex Dima 已提交
322
		 * Create a new position relative to this position.
E
Erich Gamma 已提交
323 324 325 326 327 328 329 330 331
		 *
		 * @param lineDelta Delta value for the line value, default is `0`.
		 * @param characterDelta Delta value for the character value, default is `0`.
		 * @return A position which line and character is the sum of the current line and
		 * character and the corresponding deltas.
		 */
		translate(lineDelta?: number, characterDelta?: number): Position;

		/**
A
Alex Dima 已提交
332 333
		 * Create a new position derived from this position.
		 *
E
Erich Gamma 已提交
334 335
		 * @param line Value that should be used as line value, default is the [existing value](#Position.line)
		 * @param character Value that should be used as character value, default is the [existing value](#Position.character)
A
Alex Dima 已提交
336
		 * @return A position where line and character are replaced by the given values.
E
Erich Gamma 已提交
337 338 339 340 341 342
		 */
		with(line?: number, character?: number): Position;
	}

	/**
	 * A range represents an ordered pair of two positions.
A
Alex Dima 已提交
343
	 * It is guaranteed that [start](#Range.start).isBeforeOrEqual([end](#Range.end))
E
Erich Gamma 已提交
344 345 346 347 348 349 350 351
	 *
	 * Range objects are __immutable__. Use the [with](#Range.with),
	 * [intersection](#Range.intersection), or [union](#Range.union) methods
	 * to derive new ranges from an existing range.
	 */
	export class Range {

		/**
A
Alex Dima 已提交
352
		 * The start position. It is before or equal to [end](#Range.end).
E
Erich Gamma 已提交
353 354 355 356 357
		 * @readonly
		 */
		start: Position;

		/**
A
Andre Weinand 已提交
358
		 * The end position. It is after or equal to [start](#Range.start).
E
Erich Gamma 已提交
359 360 361 362 363
		 * @readonly
		 */
		end: Position;

		/**
S
Steven Clarke 已提交
364
		 * Create a new range from two positions. If `start` is not
A
Alex Dima 已提交
365
		 * before or equal to `end`, the values will be swapped.
E
Erich Gamma 已提交
366
		 *
J
Johannes Rieken 已提交
367 368
		 * @param start A position.
		 * @param end A position.
E
Erich Gamma 已提交
369 370 371 372
		 */
		constructor(start: Position, end: Position);

		/**
A
Alex Dima 已提交
373 374
		 * Create a new range from number coordinates. It is a shorter equivalent of
		 * using `new Range(new Position(startLine, startCharacter), new Position(endLine, endCharacter))`
J
Johannes Rieken 已提交
375
		 *
A
Alex Dima 已提交
376 377 378 379
		 * @param startLine A zero-based line value.
		 * @param startCharacter A zero-based character value.
		 * @param endLine A zero-based line value.
		 * @param endCharacter A zero-based character value.
E
Erich Gamma 已提交
380
		 */
J
Johannes Rieken 已提交
381
		constructor(startLine: number, startCharacter: number, endLine: number, endCharacter: number);
E
Erich Gamma 已提交
382 383 384 385 386 387 388

		/**
		 * `true` iff `start` and `end` are equal.
		 */
		isEmpty: boolean;

		/**
A
Alex Dima 已提交
389
		 * `true` iff `start.line` and `end.line` are equal.
E
Erich Gamma 已提交
390 391 392 393
		 */
		isSingleLine: boolean;

		/**
A
Alex Dima 已提交
394 395 396
		 * Check if a position or a range is contained in this range.
		 *
		 * @param positionOrRange A position or a range.
E
Erich Gamma 已提交
397 398 399 400 401 402
		 * @return `true` iff the position or range is inside or equal
		 * to this range.
		 */
		contains(positionOrRange: Position | Range): boolean;

		/**
A
Alex Dima 已提交
403 404 405
		 * Check if `other` equals this range.
		 *
		 * @param other A range.
E
Erich Gamma 已提交
406
		 * @return `true` when start and end are [equal](#Position.isEqual) to
A
Andre Weinand 已提交
407
		 * start and end of this range.
E
Erich Gamma 已提交
408 409 410 411
		 */
		isEqual(other: Range): boolean;

		/**
A
Alex Dima 已提交
412 413 414 415
		 * Intersect `range` with this range and returns a new range or `undefined`
		 * if the ranges have no overlap.
		 *
		 * @param range A range.
E
Erich Gamma 已提交
416 417 418 419 420 421
		 * @return A range of the greater start and smaller end positions. Will
		 * return undefined when there is no overlap.
		 */
		intersection(range: Range): Range;

		/**
A
Alex Dima 已提交
422 423 424
		 * Compute the union of `other` with this range.
		 *
		 * @param other A range.
E
Erich Gamma 已提交
425 426 427 428 429
		 * @return A range of smaller start position and the greater end position.
		 */
		union(other: Range): Range;

		/**
A
Alex Dima 已提交
430 431
		 * Create a new range derived from this range.
		 *
E
Erich Gamma 已提交
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
		 * @param start A position that should be used as start. The default value is the [current start](#Range.start).
		 * @param end A position that should be used as end. The default value is the [current end](#Range.end).
		 * @return A range derived from this range with the given start and end position.
		 * If start and end are not different this range will be returned.
		 */
		with(start?: Position, end?: Position): Range;
	}

	/**
	 * Represents a text selection in an editor.
	 */
	export class Selection extends Range {

		/**
		 * The position at which the selection starts.
A
Andre Weinand 已提交
447
		 * This position might be before or after [active](#Selection.active).
E
Erich Gamma 已提交
448
		 */
A
Alex Dima 已提交
449
		anchor: Position;
E
Erich Gamma 已提交
450 451 452

		/**
		 * The position of the cursor.
A
Andre Weinand 已提交
453
		 * This position might be before or after [anchor](#Selection.anchor).
E
Erich Gamma 已提交
454
		 */
A
Alex Dima 已提交
455
		active: Position;
E
Erich Gamma 已提交
456 457 458

		/**
		 * Create a selection from two postions.
J
Johannes Rieken 已提交
459 460 461
		 *
		 * @param anchor A position.
		 * @param active A position.
E
Erich Gamma 已提交
462 463 464 465
		 */
		constructor(anchor: Position, active: Position);

		/**
A
Alex Dima 已提交
466
		 * Create a selection from four coordinates.
J
Johannes Rieken 已提交
467
		 *
A
Alex Dima 已提交
468 469 470 471
		 * @param anchorLine A zero-based line value.
		 * @param anchorCharacter A zero-based character value.
		 * @param activeLine A zero-based line value.
		 * @param activeCharacter A zero-based character value.
E
Erich Gamma 已提交
472
		 */
J
Johannes Rieken 已提交
473
		constructor(anchorLine: number, anchorCharacter: number, activeLine: number, activeCharacter: number);
A
Alex Dima 已提交
474

E
Erich Gamma 已提交
475
		/**
A
Andre Weinand 已提交
476
		 * A selection is reversed if [active](#Selection.active).isBefore([anchor](#Selection.anchor)).
E
Erich Gamma 已提交
477 478 479 480
		 */
		isReversed: boolean;
	}

A
Alex Dima 已提交
481 482 483
	/**
	 * Represents an event describing the change in a [text editor's selections](#TextEditor.selections).
	 */
J
Johannes Rieken 已提交
484
	export interface TextEditorSelectionChangeEvent {
A
Alex Dima 已提交
485 486 487
		/**
		 * The [text editor](#TextEditor) for which the selections have changed.
		 */
J
Johannes Rieken 已提交
488
		textEditor: TextEditor;
A
Alex Dima 已提交
489 490 491
		/**
		 * The new value for the [text editor's selections](#TextEditor.selections).
		 */
J
Johannes Rieken 已提交
492 493 494
		selections: Selection[];
	}

A
Alex Dima 已提交
495 496 497
	/**
	 * Represents an event describing the change in a [text editor's options](#TextEditor.options).
	 */
J
Johannes Rieken 已提交
498
	export interface TextEditorOptionsChangeEvent {
A
Alex Dima 已提交
499 500 501
		/**
		 * The [text editor](#TextEditor) for which the options have changed.
		 */
J
Johannes Rieken 已提交
502
		textEditor: TextEditor;
A
Alex Dima 已提交
503 504 505
		/**
		 * The new value for the [text editor's options](#TextEditor.options).
		 */
J
Johannes Rieken 已提交
506 507 508
		options: TextEditorOptions;
	}

509 510 511 512 513 514 515 516 517 518 519 520 521 522
	/**
	 * Represents an event describing the change of a [text editor's view column](#TextEditor.viewColumn).
	 */
	export interface TextEditorViewColumnChangeEvent {
		/**
		 * The [text editor](#TextEditor) for which the options have changed.
		 */
		textEditor: TextEditor;
		/**
		 * The new value for the [text editor's view column](#TextEditor.viewColumn).
		 */
		viewColumn: ViewColumn;
	}

A
Alex Dima 已提交
523 524 525 526 527 528 529 530 531 532 533
	/**
	 * Rendering style of the cursor.
	 */
	export enum TextEditorCursorStyle {
		/**
		 * Render the cursor as a vertical line.
		 */
		Line = 1,
		/**
		 * Render the cursor as a block.
		 */
A
Alex Dima 已提交
534 535 536 537 538
		Block = 2,
		/**
		 * Render the cursor as a horizontal line under the character.
		 */
		Underline = 3
A
Alex Dima 已提交
539 540
	}

E
Erich Gamma 已提交
541
	/**
A
Alex Dima 已提交
542
	 * Represents a [text editor](#TextEditor)'s [options](#TextEditor.options).
E
Erich Gamma 已提交
543 544 545 546
	 */
	export interface TextEditorOptions {

		/**
A
Alex Dima 已提交
547 548 549
		 * The size in spaces a tab takes. This is used for two purposes:
		 *  - the rendering width of a tab character;
		 *  - the number of spaces to insert when [insertSpaces](#TextEditorOptions.insertSpaces) is true.
550 551
		 * When getting a text editor's options, this property will always be a number (resolved).
		 * When setting a text editor's options, this property is optional and it can be a number or `"auto"`.
E
Erich Gamma 已提交
552
		 */
553
		tabSize?: number | string;
E
Erich Gamma 已提交
554 555 556

		/**
		 * When pressing Tab insert [n](#TextEditorOptions.tabSize) spaces.
557 558
		 * When getting a text editor's options, this property will always be a boolean (resolved).
		 * When setting a text editor's options, this property is optional and it can be a boolean or `"auto"`.
E
Erich Gamma 已提交
559
		 */
560
		insertSpaces?: boolean | string;
A
Alex Dima 已提交
561 562 563 564 565 566 567

		/**
		 * The rendering style of the cursor in this editor.
		 * When getting a text editor's options, this property will always be present.
		 * When setting a text editor's options, this property is optional.
		 */
		cursorStyle?: TextEditorCursorStyle;
E
Erich Gamma 已提交
568 569
	}

J
Johannes Rieken 已提交
570
	/**
A
Alex Dima 已提交
571 572
	 * Represents a handle to a set of decorations
	 * sharing the same [styling options](#DecorationRenderOptions) in a [text editor](#TextEditor).
J
Johannes Rieken 已提交
573 574 575 576
	 *
	 * To get an instance of a `TextEditorDecorationType` use
	 * [createTextEditorDecorationType](#window.createTextEditorDecorationType).
	 */
E
Erich Gamma 已提交
577 578 579
	export interface TextEditorDecorationType {

		/**
A
Alex Dima 已提交
580
		 * Internal representation of the handle.
E
Erich Gamma 已提交
581 582 583 584
		 * @readonly
		 */
		key: string;

A
Alex Dima 已提交
585 586 587
		/**
		 * Remove this decoration type and all decorations on all text editors using it.
		 */
E
Erich Gamma 已提交
588 589 590
		dispose(): void;
	}

A
Alex Dima 已提交
591 592 593
	/**
	 * Represents different [reveal](#TextEditor.revealRange) strategies in a text editor.
	 */
E
Erich Gamma 已提交
594
	export enum TextEditorRevealType {
A
Alex Dima 已提交
595 596 597 598 599 600 601
		/**
		 * The range will be revealed with as little scrolling as possible.
		 */
		Default,
		/**
		 * The range will always be revealed in the center of the viewport.
		 */
E
Erich Gamma 已提交
602
		InCenter,
A
Alex Dima 已提交
603 604 605 606
		/**
		 * If the range is outside the viewport, it will be revealed in the center of the viewport.
		 * Otherwise, it will be revealed with as little scrolling as possible.
		 */
E
Erich Gamma 已提交
607 608 609
		InCenterIfOutsideViewport
	}

A
Alex Dima 已提交
610
	/**
S
Sofian Hnaide 已提交
611
	 * Represents different positions for rendering a decoration in an [overview ruler](#DecorationRenderOptions.overviewRulerLane).
A
Alex Dima 已提交
612 613
	 * The overview ruler supports three lanes.
	 */
E
Erich Gamma 已提交
614 615 616 617 618 619 620
	export enum OverviewRulerLane {
		Left = 1,
		Center = 2,
		Right = 4,
		Full = 7
	}

A
Alex Dima 已提交
621 622 623
	/**
	 * Represents theme specific rendering styles for a [text editor decoration](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
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 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
	export interface ThemableDecorationRenderOptions {
		/**
		 * Background color of the decoration. Use rgba() and define transparent background colors to play well with other decorations.
		 */
		backgroundColor?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		outlineColor?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		outlineStyle?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		outlineWidth?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		borderColor?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		borderRadius?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		borderSpacing?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		borderStyle?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		borderWidth?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		textDecoration?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		cursor?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		color?: string;

685 686 687 688 689
		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		letterSpacing?: string;

E
Erich Gamma 已提交
690
		/**
A
Alex Dima 已提交
691
		 * An **absolute path** to an image to be rendered in the gutterIconPath.
E
Erich Gamma 已提交
692 693 694 695 696 697 698 699 700
		 */
		gutterIconPath?: string;

		/**
		 * The color of the decoration in the overview ruler. Use rgba() and define transparent colors to play well with other decorations.
		 */
		overviewRulerColor?: string;
	}

A
Alex Dima 已提交
701 702 703
	/**
	 * Represents rendering styles for a [text editor decoration](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
	export interface DecorationRenderOptions extends ThemableDecorationRenderOptions {
		/**
		 * Should the decoration be rendered also on the whitespace after the line text.
		 * Defaults to `false`.
		 */
		isWholeLine?: boolean;

		/**
		 * The position in the overview ruler where the decoration should be rendered.
		 */
		overviewRulerLane?: OverviewRulerLane;

		/**
		 * Overwrite options for light themes.
		 */
		light?: ThemableDecorationRenderOptions;

		/**
		 * Overwrite options for dark themes.
		 */
		dark?: ThemableDecorationRenderOptions;
	}

A
Alex Dima 已提交
727 728 729
	/**
	 * Represents options for a specific decoration in a [decoration set](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
730 731 732 733 734 735 736 737 738 739 740 741 742
	export interface DecorationOptions {

		/**
		 * Range to which this decoration is applied.
		 */
		range: Range;

		/**
		 * A message that should be rendered when hovering over the decoration.
		 */
		hoverMessage: MarkedString | MarkedString[];
	}

A
Alex Dima 已提交
743 744 745
	/**
	 * Represents an editor that is attached to a [document](#TextDocument).
	 */
E
Erich Gamma 已提交
746 747 748 749 750 751 752 753
	export interface TextEditor {

		/**
		 * The document associated with this text editor. The document will be the same for the entire lifetime of this text editor.
		 */
		document: TextDocument;

		/**
J
Johannes Rieken 已提交
754
		 * The primary selection on this text editor. Shorthand for `TextEditor.selections[0]`.
E
Erich Gamma 已提交
755 756 757 758
		 */
		selection: Selection;

		/**
J
Johannes Rieken 已提交
759
		 * The selections in this text editor. The primary selection is always at index 0.
E
Erich Gamma 已提交
760 761 762 763 764 765 766 767
		 */
		selections: Selection[];

		/**
		 * Text editor options.
		 */
		options: TextEditorOptions;

768 769 770 771 772 773
		/**
		 * The column in which this editor shows. Will be `undefined` in case this
		 * isn't one of the three main editors, e.g an embedded editor.
		 */
		viewColumn: ViewColumn;

E
Erich Gamma 已提交
774 775
		/**
		 * Perform an edit on the document associated with this text editor.
J
Johannes Rieken 已提交
776 777
		 *
		 * The given callback-function is invoked with an [edit-builder](#TextEditorEdit) which must
A
Andre Weinand 已提交
778
		 * be used to make edits. Note that the edit-builder is only valid while the
J
Johannes Rieken 已提交
779 780 781
		 * callback executes.
		 *
		 * @param callback A function which can make edits using an [edit-builder](#TextEditorEdit).
A
Alex Dima 已提交
782
		 * @return A promise that resolves with a value indicating if the edits could be applied.
E
Erich Gamma 已提交
783 784 785 786
		 */
		edit(callback: (editBuilder: TextEditorEdit) => void): Thenable<boolean>;

		/**
J
Johannes Rieken 已提交
787 788 789
		 * Adds a set of decorations to the text editor. If a set of decorations already exists with
		 * the given [decoration type](#TextEditorDecorationType), they will be replaced.
		 *
S
Sofian Hnaide 已提交
790
		 * @see [createTextEditorDecorationType](#window.createTextEditorDecorationType).
A
Alex Dima 已提交
791
		 *
J
Johannes Rieken 已提交
792 793
		 * @param decorationType A decoration type.
		 * @param rangesOrOptions Either [ranges](#Range) or more detailed [options](#DecorationOptions).
E
Erich Gamma 已提交
794
		 */
J
Johannes Rieken 已提交
795
		setDecorations(decorationType: TextEditorDecorationType, rangesOrOptions: Range[] | DecorationOptions[]): void;
E
Erich Gamma 已提交
796 797

		/**
A
Alex Dima 已提交
798 799 800 801
		 * Scroll as indicated by `revealType` in order to reveal the given range.
		 *
		 * @param range A range.
		 * @param revealType The scrolling strategy for revealing `range`.
E
Erich Gamma 已提交
802 803 804 805
		 */
		revealRange(range: Range, revealType?: TextEditorRevealType): void;

		/**
J
Johannes Rieken 已提交
806 807 808
		 * Show the text editor.
		 *
		 * @deprecated **This method is deprecated.** Use [window.showTextDocument](#window.showTextDocument)
S
Steven Clarke 已提交
809
		 * instead. This method shows unexpected behavior and will be removed in the next major update.
E
Erich Gamma 已提交
810
		 *
J
Johannes Rieken 已提交
811
		 * @param column The [column](#ViewColumn) in which to show this editor.
E
Erich Gamma 已提交
812 813 814 815 816
		 */
		show(column?: ViewColumn): void;

		/**
		 * Hide the text editor.
J
Johannes Rieken 已提交
817 818
		 *
		 * @deprecated **This method is deprecated.** Use the command 'workbench.action.closeActiveEditor' instead.
S
Steven Clarke 已提交
819
		 * This method shows unexpected behavior and will be removed in the next major update.
E
Erich Gamma 已提交
820 821 822 823
		 */
		hide(): void;
	}

824 825 826 827 828 829 830 831 832 833 834 835 836 837
	/**
	 * Represents an end of line character sequence in a [document](#Document).
	 */
	export enum EndOfLine {
		/**
		 * The line feed `\n` character.
		 */
		LF = 1,
		/**
		 * The carriage return line feed `\r\n` sequence.
		 */
		CRLF = 2
	}

E
Erich Gamma 已提交
838
	/**
A
Alex Dima 已提交
839 840 841
	 * A complex edit that will be applied in one transaction on a TextEditor.
	 * This holds a description of the edits and if the edits are valid (i.e. no overlapping regions, document was not changed in the meantime, etc.)
	 * they can be applied on a [document](#Document) associated with a [text editor](#TextEditor).
E
Erich Gamma 已提交
842 843 844 845
	 *
	 */
	export interface TextEditorEdit {
		/**
A
Alex Dima 已提交
846 847 848 849 850
		 * Replace a certain text region with a new value.
		 * You can use \r\n or \n in `value` and they will be normalized to the current [document](#Document).
		 *
		 * @param location The range this operation should remove.
		 * @param value The new text this operation should insert after removing `location`.
E
Erich Gamma 已提交
851 852 853 854
		 */
		replace(location: Position | Range | Selection, value: string): void;

		/**
A
Alex Dima 已提交
855 856 857 858 859 860
		 * Insert text at a location.
		 * You can use \r\n or \n in `value` and they will be normalized to the current [document](#Document).
		 * Although the equivalent text edit can be made with [replace](#TextEditorEdit.replace), `insert` will produce a different resulting selection (it will get moved).
		 *
		 * @param location The position where the new text should be inserted.
		 * @param value The new text this operation should insert.
E
Erich Gamma 已提交
861 862 863 864 865
		 */
		insert(location: Position, value: string): void;

		/**
		 * Delete a certain text region.
A
Alex Dima 已提交
866 867
		 *
		 * @param location The range this operation should remove.
E
Erich Gamma 已提交
868 869
		 */
		delete(location: Range | Selection): void;
870 871 872 873 874 875

		/**
		 * Set the end of line sequence.
		 *
		 * @param endOfLine The new end of line for the [document](#Document).
		 */
A
Format  
Alex Dima 已提交
876
		setEndOfLine(endOfLine: EndOfLine): void;
E
Erich Gamma 已提交
877 878 879
	}

	/**
S
Steven Clarke 已提交
880
	 * A universal resource identifier representing either a file on disk
J
Johannes Rieken 已提交
881
	 * or another resource, like untitled resources.
E
Erich Gamma 已提交
882 883 884 885
	 */
	export class Uri {

		/**
J
Johannes Rieken 已提交
886 887 888 889 890
		 * Create an URI from a file system path. The [scheme](#Uri.scheme)
		 * will be `file`.
		 *
		 * @param path A file system or UNC path.
		 * @return A new Uri instance.
E
Erich Gamma 已提交
891 892 893 894
		 */
		static file(path: string): Uri;

		/**
J
Johannes Rieken 已提交
895 896
		 * Create an URI from a string. Will throw if the given value is not
		 * valid.
E
Erich Gamma 已提交
897
		 *
J
Johannes Rieken 已提交
898
		 * @param value The string value of an Uri.
J
Johannes Rieken 已提交
899
		 * @return A new Uri instance.
E
Erich Gamma 已提交
900 901 902 903
		 */
		static parse(value: string): Uri;

		/**
J
Johannes Rieken 已提交
904
		 * Scheme is the `http` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
905 906 907 908 909
		 * The part before the first colon.
		 */
		scheme: string;

		/**
J
Johannes Rieken 已提交
910
		 * Authority is the `www.msft.com` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
911 912 913 914 915
		 * The part between the first double slashes and the next slash.
		 */
		authority: string;

		/**
J
Johannes Rieken 已提交
916
		 * Path is the `/some/path` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
917 918 919 920
		 */
		path: string;

		/**
J
Johannes Rieken 已提交
921
		 * Query is the `query` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
922 923 924 925
		 */
		query: string;

		/**
J
Johannes Rieken 已提交
926
		 * Fragment is the `fragment` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
927 928 929 930
		 */
		fragment: string;

		/**
931
		 * The string representing the corresponding file system path of this Uri.
J
Johannes Rieken 已提交
932
		 *
E
Erich Gamma 已提交
933 934
		 * Will handle UNC paths and normalize windows drive letters to lower-case. Also
		 * uses the platform specific path separator. Will *not* validate the path for
935
		 * invalid characters and semantics. Will *not* look at the scheme of this Uri.
E
Erich Gamma 已提交
936 937 938 939
		 */
		fsPath: string;

		/**
940 941 942
		 * Returns a string representation of this Uri. The representation and normalization
		 * of a URI depends on the scheme. The resulting string can be safely used with
		 * [Uri.parse](#Uri.parse).
J
Johannes Rieken 已提交
943
		 *
944 945 946
		 * @param skipEncoding Do not percentage-encode the result, defaults to `false`. Note that
		 *	the `#` and `?` characters occuring in the path will always be encoded.
		 * @returns A string representation of this Uri.
E
Erich Gamma 已提交
947
		 */
948
		toString(skipEncoding?: boolean): string;
E
Erich Gamma 已提交
949

J
Johannes Rieken 已提交
950 951 952 953 954
		/**
		 * Returns a JSON representation of this Uri.
		 *
		 * @return An object.
		 */
E
Erich Gamma 已提交
955 956 957 958
		toJSON(): any;
	}

	/**
S
Steven Clarke 已提交
959
	 * A cancellation token is passed to an asynchronous or long running
E
Erich Gamma 已提交
960 961
	 * operation to request cancellation, like cancelling a request
	 * for completion items because the user continued to type.
962 963 964
	 *
	 * To get an instance of a `CancellationToken` use a
	 * [CancellationTokenSource](#CancellationTokenSource).
E
Erich Gamma 已提交
965 966 967 968
	 */
	export interface CancellationToken {

		/**
J
Johannes Rieken 已提交
969
		 * Is `true` when the token has been cancelled, `false` otherwise.
E
Erich Gamma 已提交
970 971 972 973
		 */
		isCancellationRequested: boolean;

		/**
J
Johannes Rieken 已提交
974
		 * An [event](#Event) which fires upon cancellation.
E
Erich Gamma 已提交
975 976 977 978 979
		 */
		onCancellationRequested: Event<any>;
	}

	/**
J
Johannes Rieken 已提交
980
	 * A cancellation source creates and controls a [cancellation token](#CancellationToken).
E
Erich Gamma 已提交
981 982 983 984
	 */
	export class CancellationTokenSource {

		/**
J
Johannes Rieken 已提交
985
		 * The cancellation token of this source.
E
Erich Gamma 已提交
986 987 988 989 990 991 992 993 994
		 */
		token: CancellationToken;

		/**
		 * Signal cancellation on the token.
		 */
		cancel(): void;

		/**
J
Johannes Rieken 已提交
995
		 * Dispose object and free resources. Will call [cancel](#CancellationTokenSource.cancel).
E
Erich Gamma 已提交
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
		 */
		dispose(): void;
	}

	/**
	 * Represents a type which can release resources, such
	 * as event listening or a timer.
	 */
	export class Disposable {

		/**
		 * Combine many disposable-likes into one. Use this method
		 * when having objects with a dispose function which are not
		 * instances of Disposable.
		 *
S
Steven Clarke 已提交
1011
		 * @param disposableLikes Objects that have at least a `dispose`-function member.
E
Erich Gamma 已提交
1012 1013 1014 1015 1016 1017 1018 1019
		 * @return Returns a new disposable which, upon dispose, will
		 * dispose all provided disposables.
		 */
		static from(...disposableLikes: { dispose: () => any }[]): Disposable;

		/**
		 * Creates a new Disposable calling the provided function
		 * on dispose.
A
Andre Weinand 已提交
1020
		 * @param callOnDispose Function that disposes something.
E
Erich Gamma 已提交
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
		 */
		constructor(callOnDispose: Function);

		/**
		 * Dispose this object.
		 */
		dispose(): any;
	}

	/**
	 * Represents a typed event.
J
Johannes Rieken 已提交
1032 1033 1034 1035 1036
	 *
	 * A function that represents an event to which you subscribe by calling it with
	 * a listener function as argument.
	 *
	 * @sample `item.onDidChange(function(event) { console.log("Event happened: " + event); });`
E
Erich Gamma 已提交
1037 1038 1039 1040
	 */
	export interface Event<T> {

		/**
J
Johannes Rieken 已提交
1041 1042
		 * A function that represents an event to which you subscribe by calling it with
		 * a listener function as argument.
E
Erich Gamma 已提交
1043 1044
		 *
		 * @param listener The listener function will be called when the event happens.
J
Johannes Rieken 已提交
1045 1046
		 * @param thisArgs The `this`-argument which will be used when calling the event listener.
		 * @param disposables An array to which a [disposeable](#Disposable) will be added.
A
Andre Weinand 已提交
1047
		 * @return A disposable which unsubscribes the event listener.
E
Erich Gamma 已提交
1048 1049 1050 1051
		 */
		(listener: (e: T) => any, thisArgs?: any, disposables?: Disposable[]): Disposable;
	}

1052 1053 1054 1055 1056
	/**
	 * An event emitter can be used to create and manage an [event](#Event) for others
	 * to subscribe to. One emitter always owns one event.
	 *
	 * Use this class if you want to provide event from within your extension, for instance
J
Johannes Rieken 已提交
1057
	 * inside a [TextDocumentContentProvider](#TextDocumentContentProvider) or when providing
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
	 * API to other extensions.
	 */
	export class EventEmitter<T> {

		/**
		 * The event listeners can subscribe to.
		 */
		event: Event<T>;

		/**
		 * Notify all subscribers of the [event](EventEmitter#event). Failure
		 * of one or more listener will not fail this function call.
		 *
		 * @param data The event object.
		 */
		fire(data?: T): void;

		/**
		 * Dispose this object and free resources.
		 */
		dispose(): void;
	}

E
Erich Gamma 已提交
1081 1082
	/**
	 * A file system watcher notifies about changes to files and folders
J
Johannes Rieken 已提交
1083 1084 1085
	 * on disk.
	 *
	 * To get an instance of a `FileSystemWatcher` use
J
Johannes Rieken 已提交
1086
	 * [createFileSystemWatcher](#workspace.createFileSystemWatcher).
E
Erich Gamma 已提交
1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
	 */
	export interface FileSystemWatcher extends Disposable {

		/**
		 * true if this file system watcher has been created such that
		 * it ignores creation file system events.
		 */
		ignoreCreateEvents: boolean;

		/**
		 * true if this file system watcher has been created such that
		 * it ignores change file system events.
		 */
		ignoreChangeEvents: boolean;

		/**
		 * true if this file system watcher has been created such that
		 * it ignores delete file system events.
		 */
J
Johannes Rieken 已提交
1106
		ignoreDeleteEvents: boolean;
E
Erich Gamma 已提交
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123

		/**
		 * An event which fires on file/folder creation.
		 */
		onDidCreate: Event<Uri>;

		/**
		 * An event which fires on file/folder change.
		 */
		onDidChange: Event<Uri>;

		/**
		 * An event which fires on file/folder deletion.
		 */
		onDidDelete: Event<Uri>;
	}

1124 1125 1126 1127 1128 1129 1130 1131 1132
	/**
	 * A text document content provider allows to add readonly documents
	 * to the editor, such as source from a dll or generated html from md.
	 *
	 * Content providers are [registered](#workbench.registerTextDocumentContentProvider)
	 * for a [uri-scheme](#Uri.scheme). When a uri with that scheme is to
	 * be [loaded](#workbench.openTextDocument) the content provider is
	 * asked.
	 */
J
Johannes Rieken 已提交
1133 1134
	export interface TextDocumentContentProvider {

1135 1136 1137 1138
		/**
		 * An event to signal a resource has changed.
		 */
		onDidChange?: Event<Uri>;
J
Johannes Rieken 已提交
1139

1140
		/**
1141
		 * Provide textual content for a given uri.
1142
		 *
1143 1144 1145 1146
		 * The editor will use the returned string-content to create a readonly
		 * [document](TextDocument). Resources allocated should be released when
		 * the corresponding document has been [closed](#workbench.onDidCloseTextDocument).
		 *
1147 1148 1149
		 * @param uri An uri which scheme matches the scheme this provider was [registered](#workspace.registerTextDocumentContentProvider) for.
		 * @param token A cancellation token.
		 * @return A string or a thenable that resolves to such.
1150
		 */
1151
		provideTextDocumentContent(uri: Uri, token: CancellationToken): string | Thenable<string>;
J
Johannes Rieken 已提交
1152 1153
	}

E
Erich Gamma 已提交
1154 1155
	/**
	 * Represents an item that can be selected from
A
Andre Weinand 已提交
1156
	 * a list of items.
E
Erich Gamma 已提交
1157 1158 1159 1160
	 */
	export interface QuickPickItem {

		/**
J
Johannes Rieken 已提交
1161
		 * A human readable string which is rendered prominent.
E
Erich Gamma 已提交
1162 1163 1164 1165
		 */
		label: string;

		/**
J
Johannes Rieken 已提交
1166
		 * A human readable string which is rendered less prominent.
E
Erich Gamma 已提交
1167 1168
		 */
		description: string;
J
Johannes Rieken 已提交
1169 1170 1171 1172 1173

		/**
		 * A human readable string which is rendered less prominent.
		 */
		detail?: string;
E
Erich Gamma 已提交
1174 1175 1176
	}

	/**
J
Johannes Rieken 已提交
1177
	 * Options to configure the behavior of the quick pick UI.
E
Erich Gamma 已提交
1178 1179 1180
	 */
	export interface QuickPickOptions {
		/**
J
Johannes Rieken 已提交
1181 1182
		 * An optional flag to include the description when filtering the picks.
		 */
E
Erich Gamma 已提交
1183 1184
		matchOnDescription?: boolean;

J
Johannes Rieken 已提交
1185 1186 1187 1188 1189
		/**
		 * An optional flag to include the detail when filtering the picks.
		 */
		matchOnDetail?: boolean;

E
Erich Gamma 已提交
1190
		/**
S
Steven Clarke 已提交
1191
		 * An optional string to show as place holder in the input box to guide the user what to pick on.
J
Johannes Rieken 已提交
1192
		 */
E
Erich Gamma 已提交
1193
		placeHolder?: string;
1194 1195 1196 1197 1198

		/**
		 * An optional function that is invoked whenever an item is selected.
		 */
		onDidSelectItem?: <T extends QuickPickItem>(item: T | string) => any;
E
Erich Gamma 已提交
1199 1200 1201
	}

	/**
J
Johannes Rieken 已提交
1202
	 * Represents an action that is shown with an information, warning, or
A
Andre Weinand 已提交
1203
	 * error message.
E
Erich Gamma 已提交
1204
	 *
S
Sofian Hnaide 已提交
1205 1206 1207
	 * @see [showInformationMessage](#window.showInformationMessage)
	 * @see [showWarningMessage](#window.showWarningMessage)
	 * @see [showErrorMessage](#window.showErrorMessage)
E
Erich Gamma 已提交
1208 1209 1210 1211
	 */
	export interface MessageItem {

		/**
A
Andre Weinand 已提交
1212
		 * A short title like 'Retry', 'Open Log' etc.
E
Erich Gamma 已提交
1213 1214
		 */
		title: string;
1215 1216 1217 1218 1219 1220

		/**
		 * Indicates that this item replaces the default
		 * 'Close' action.
		 */
		isCloseAffordance?: boolean;
E
Erich Gamma 已提交
1221 1222 1223
	}

	/**
J
Johannes Rieken 已提交
1224
	 * Options to configure the behavior of the input box UI.
E
Erich Gamma 已提交
1225 1226
	 */
	export interface InputBoxOptions {
J
Johannes Rieken 已提交
1227

E
Erich Gamma 已提交
1228
		/**
J
Johannes Rieken 已提交
1229 1230
		 * The value to prefill in the input box.
		 */
E
Erich Gamma 已提交
1231 1232 1233
		value?: string;

		/**
J
Johannes Rieken 已提交
1234 1235
		 * The text to display underneath the input box.
		 */
E
Erich Gamma 已提交
1236 1237 1238
		prompt?: string;

		/**
J
Johannes Rieken 已提交
1239 1240
		 * An optional string to show as place holder in the input box to guide the user what to type.
		 */
E
Erich Gamma 已提交
1241 1242 1243
		placeHolder?: string;

		/**
J
Johannes Rieken 已提交
1244 1245
		 * Set to true to show a password prompt that will not show the typed value.
		 */
E
Erich Gamma 已提交
1246
		password?: boolean;
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256

		/**
		 * An optional function that will be called to valide input and to give a hint
		 * to the user.
		 *
		 * @param value The current value of the input box.
		 * @return A human readable string which is presented as diagnostic message.
		 * Return `undefined`, `null`, or the empty string when 'value' is valid.
		 */
		validateInput?: (value: string) => string;
E
Erich Gamma 已提交
1257 1258 1259 1260
	}

	/**
	 * A document filter denotes a document by different properties like
A
Alex Dima 已提交
1261
	 * the [language](#TextDocument.languageId), the [scheme](#Uri.scheme) of
A
Andre Weinand 已提交
1262
	 * its resource, or a glob-pattern that is applied to the [path](#TextDocument.fileName).
E
Erich Gamma 已提交
1263
	 *
J
Johannes Rieken 已提交
1264
	 * @sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
1265
	 * @sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**∕project.json' }`
E
Erich Gamma 已提交
1266 1267 1268 1269 1270 1271 1272 1273 1274
	 */
	export interface DocumentFilter {

		/**
		 * A language id, like `typescript`.
		 */
		language?: string;

		/**
J
Johannes Rieken 已提交
1275
		 * A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
E
Erich Gamma 已提交
1276 1277 1278 1279
		 */
		scheme?: string;

		/**
J
Johannes Rieken 已提交
1280
		 * A glob pattern, like `*.{ts,js}`.
E
Erich Gamma 已提交
1281 1282 1283 1284 1285 1286
		 */
		pattern?: string;
	}

	/**
	 * A language selector is the combination of one or many language identifiers
J
Johannes Rieken 已提交
1287 1288 1289
	 * and [language filters](#LanguageFilter).
	 *
	 * @sample `let sel:DocumentSelector = 'typescript'`;
1290
	 * @sample `let sel:DocumentSelector = ['typescript', { language: 'json', pattern: '**∕tsconfig.json' }]`;
E
Erich Gamma 已提交
1291 1292 1293 1294 1295
	 */
	export type DocumentSelector = string | DocumentFilter | (string | DocumentFilter)[];

	/**
	 * Contains additional diagnostic information about the context in which
J
Johannes Rieken 已提交
1296
	 * a [code action](#CodeActionProvider.provideCodeActions) is run.
E
Erich Gamma 已提交
1297 1298
	 */
	export interface CodeActionContext {
J
Johannes Rieken 已提交
1299 1300 1301

		/**
		 * An array of diagnostics.
J
Johannes Rieken 已提交
1302 1303
		 *
		 * @readonly
J
Johannes Rieken 已提交
1304
		 */
E
Erich Gamma 已提交
1305 1306 1307 1308
		diagnostics: Diagnostic[];
	}

	/**
J
Johannes Rieken 已提交
1309 1310 1311 1312
	 * The code action interface defines the contract between extensions and
	 * the [light bulb](https://code.visualstudio.com/docs/editor/editingevolved#_code-action) feature.
	 *
	 * A code action can be any command that is [known](#commands.getCommands) to the system.
E
Erich Gamma 已提交
1313 1314 1315 1316 1317 1318
	 */
	export interface CodeActionProvider {

		/**
		 * Provide commands for the given document and range.
		 *
J
Johannes Rieken 已提交
1319 1320
		 * @param document The document in which the command was invoked.
		 * @param range The range for which the command was invoked.
J
Johannes Rieken 已提交
1321 1322
		 * @param context Context carrying additional information.
		 * @param token A cancellation token.
J
Johannes Rieken 已提交
1323
		 * @return An array of commands or a thenable of such. The lack of a result can be
A
Andre Weinand 已提交
1324
		 * signaled by returning `undefined`, `null`, or an empty array.
E
Erich Gamma 已提交
1325 1326 1327 1328 1329 1330 1331
		 */
		provideCodeActions(document: TextDocument, range: Range, context: CodeActionContext, token: CancellationToken): Command[] | Thenable<Command[]>;
	}

	/**
	 * A code lens represents a [command](#Command) that should be shown along with
	 * source text, like the number of references, a way to run tests, etc.
J
Johannes Rieken 已提交
1332 1333 1334
	 *
	 * A code lens is _unresolved_ when no command is associated to it. For performance
	 * reasons the creation of a code lens and resolving should be done to two stages.
J
Johannes Rieken 已提交
1335 1336 1337
	 *
	 * @see [CodeLensProvider.provideCodeLenses](#CodeLensProvider.provideCodeLenses)
	 * @see [CodeLensProvider.resolveCodeLens](#CodeLensProvider.resolveCodeLens)
E
Erich Gamma 已提交
1338 1339 1340 1341 1342 1343 1344 1345 1346
	 */
	export class CodeLens {

		/**
		 * The range in which this code lens is valid. Should only span a single line.
		 */
		range: Range;

		/**
J
Johannes Rieken 已提交
1347
		 * The command this code lens represents.
E
Erich Gamma 已提交
1348 1349 1350 1351
		 */
		command: Command;

		/**
J
Johannes Rieken 已提交
1352
		 * `true` when there is a command associated.
E
Erich Gamma 已提交
1353 1354
		 */
		isResolved: boolean;
J
Johannes Rieken 已提交
1355 1356 1357 1358 1359 1360 1361 1362

		/**
		 * Creates a new code lens object.
		 *
		 * @param range The range to which this code lens applies.
		 * @param command The command associated to this code lens.
		 */
		constructor(range: Range, command?: Command);
E
Erich Gamma 已提交
1363 1364 1365 1366 1367 1368 1369 1370 1371 1372
	}

	/**
	 * A code lens provider adds [commands](#Command) to source text. The commands will be shown
	 * as dedicated horizontal lines in between the source text.
	 */
	export interface CodeLensProvider {

		/**
		 * Compute a list of [lenses](#CodeLens). This call should return as fast as possible and if
A
Andre Weinand 已提交
1373
		 * computing the commands is expensive implementors should only return code lens objects with the
E
Erich Gamma 已提交
1374
		 * range set and implement [resolve](#CodeLensProvider.resolveCodeLens).
J
Johannes Rieken 已提交
1375 1376 1377
		 *
		 * @param document The document in which the command was invoked.
		 * @param token A cancellation token.
A
Andre Weinand 已提交
1378 1379
		 * @return An array of code lenses or a thenable that resolves to such. The lack of a result can be
		 * signaled by returning `undefined`, `null`, or an empty array.
E
Erich Gamma 已提交
1380 1381 1382 1383 1384 1385
		 */
		provideCodeLenses(document: TextDocument, token: CancellationToken): CodeLens[] | Thenable<CodeLens[]>;

		/**
		 * This function will be called for each visible code lens, usually when scrolling and after
		 * calls to [compute](#CodeLensProvider.provideCodeLenses)-lenses.
J
Johannes Rieken 已提交
1386
		 *
A
Andre Weinand 已提交
1387
		 * @param codeLens code lens that must be resolved.
J
Johannes Rieken 已提交
1388
		 * @param token A cancellation token.
S
Steven Clarke 已提交
1389
		 * @return The given, resolved code lens or thenable that resolves to such.
E
Erich Gamma 已提交
1390 1391 1392 1393 1394
		 */
		resolveCodeLens?(codeLens: CodeLens, token: CancellationToken): CodeLens | Thenable<CodeLens>;
	}

	/**
J
Johannes Rieken 已提交
1395 1396 1397
	 * The definition of a symbol represented as one or many [locations](#Location).
	 * For most programming languages there is only one location at which a symbol is
	 * defined.
E
Erich Gamma 已提交
1398 1399 1400
	 */
	export type Definition = Location | Location[];

J
Johannes Rieken 已提交
1401 1402 1403 1404 1405
	/**
	 * 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.
	 */
E
Erich Gamma 已提交
1406
	export interface DefinitionProvider {
J
Johannes Rieken 已提交
1407 1408 1409 1410 1411 1412 1413

		/**
		 * Provide the definition of the symbol at the given position and document.
		 *
		 * @param document The document in which the command was invoked.
		 * @param position The position at which the command was invoked.
		 * @param token A cancellation token.
S
Steven Clarke 已提交
1414
		 * @return A definition or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
1415
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
1416 1417
		 */
		provideDefinition(document: TextDocument, position: Position, token: CancellationToken): Definition | Thenable<Definition>;
E
Erich Gamma 已提交
1418 1419 1420
	}

	/**
J
Johannes Rieken 已提交
1421 1422 1423
	 * MarkedString can be used to render human readable text. It is either a markdown string
	 * or a code-block that provides a language and a code snippet. Note that
	 * markdown strings will be sanitized - that means html will be escaped.
E
Erich Gamma 已提交
1424 1425 1426
	 */
	export type MarkedString = string | { language: string; value: string };

J
Johannes Rieken 已提交
1427 1428 1429 1430
	/**
	 * A hover represents additional information for a symbol or word. Hovers are
	 * rendered in a tooltip-like widget.
	 */
E
Erich Gamma 已提交
1431 1432
	export class Hover {

J
Johannes Rieken 已提交
1433 1434 1435
		/**
		 * The contents of this hover.
		 */
E
Erich Gamma 已提交
1436 1437
		contents: MarkedString[];

J
Johannes Rieken 已提交
1438
		/**
A
Andre Weinand 已提交
1439
		 * The range to which this hover applies. When missing, the
J
Johannes Rieken 已提交
1440
		 * editor will use the range at the current position or the
A
Andre Weinand 已提交
1441
		 * current position itself.
J
Johannes Rieken 已提交
1442
		 */
E
Erich Gamma 已提交
1443 1444
		range: Range;

J
Johannes Rieken 已提交
1445 1446 1447 1448
		/**
		 * Creates a new hover object.
		 *
		 * @param contents The contents of the hover.
A
Andre Weinand 已提交
1449
		 * @param range The range to which the hover applies.
J
Johannes Rieken 已提交
1450
		 */
E
Erich Gamma 已提交
1451 1452 1453
		constructor(contents: MarkedString | MarkedString[], range?: Range);
	}

J
Johannes Rieken 已提交
1454 1455 1456 1457
	/**
	 * The hover provider interface defines the contract between extensions and
	 * the [hover](https://code.visualstudio.com/docs/editor/editingevolved#_hover)-feature.
	 */
E
Erich Gamma 已提交
1458
	export interface HoverProvider {
J
Johannes Rieken 已提交
1459 1460 1461

		/**
		 * Provide a hover for the given position and document. Multiple hovers at the same
A
Andre Weinand 已提交
1462 1463
		 * position will be merged by the editor. A hover can have a range which defaults
		 * to the word range at the position when omitted.
J
Johannes Rieken 已提交
1464 1465 1466 1467 1468
		 *
		 * @param document The document in which the command was invoked.
		 * @param position The position at which the command was invoked.
		 * @param token A cancellation token.
		 * @return A hover or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
1469
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
1470
		 */
E
Erich Gamma 已提交
1471 1472 1473
		provideHover(document: TextDocument, position: Position, token: CancellationToken): Hover | Thenable<Hover>;
	}

J
Johannes Rieken 已提交
1474 1475 1476
	/**
	 * A document highlight kind.
	 */
E
Erich Gamma 已提交
1477
	export enum DocumentHighlightKind {
J
Johannes Rieken 已提交
1478 1479

		/**
A
Andre Weinand 已提交
1480
		 * A textual occurrence.
J
Johannes Rieken 已提交
1481
		 */
E
Erich Gamma 已提交
1482
		Text,
J
Johannes Rieken 已提交
1483 1484 1485 1486

		/**
		 * Read-access of a symbol, like reading a variable.
		 */
E
Erich Gamma 已提交
1487
		Read,
J
Johannes Rieken 已提交
1488 1489 1490 1491

		/**
		 * Write-access of a symbol, like writing to a variable.
		 */
E
Erich Gamma 已提交
1492 1493 1494
		Write
	}

J
Johannes Rieken 已提交
1495 1496 1497 1498 1499
	/**
	 * 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.
	 */
E
Erich Gamma 已提交
1500
	export class DocumentHighlight {
J
Johannes Rieken 已提交
1501 1502 1503 1504

		/**
		 * The range this highlight applies to.
		 */
E
Erich Gamma 已提交
1505
		range: Range;
J
Johannes Rieken 已提交
1506 1507 1508 1509

		/**
		 * The highlight kind, default is [text](#DocumentHighlightKind.Text).
		 */
E
Erich Gamma 已提交
1510
		kind: DocumentHighlightKind;
J
Johannes Rieken 已提交
1511 1512 1513 1514 1515 1516 1517 1518

		/**
		 * Creates a new document highlight object.
		 *
		 * @param range The range the highlight applies to.
		 * @param kind The highlight kind, default is [text](#DocumentHighlightKind.Text).
		 */
		constructor(range: Range, kind?: DocumentHighlightKind);
E
Erich Gamma 已提交
1519 1520
	}

J
Johannes Rieken 已提交
1521 1522 1523 1524
	/**
	 * The document highlight provider interface defines the contract between extensions and
	 * the word-highlight-feature.
	 */
E
Erich Gamma 已提交
1525
	export interface DocumentHighlightProvider {
J
Johannes Rieken 已提交
1526 1527

		/**
S
Steven Clarke 已提交
1528
		 * Provide a set of document highlights, like all occurrences of a variable or
J
Johannes Rieken 已提交
1529 1530 1531 1532 1533 1534
		 * all exit-points of a function.
		 *
		 * @param document The document in which the command was invoked.
		 * @param position The position at which the command was invoked.
		 * @param token A cancellation token.
		 * @return An array of document highlights or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
1535
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1536
		 */
E
Erich Gamma 已提交
1537 1538 1539
		provideDocumentHighlights(document: TextDocument, position: Position, token: CancellationToken): DocumentHighlight[] | Thenable<DocumentHighlight[]>;
	}

J
Johannes Rieken 已提交
1540 1541 1542
	/**
	 * A symbol kind.
	 */
E
Erich Gamma 已提交
1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560
	export enum SymbolKind {
		File,
		Module,
		Namespace,
		Package,
		Class,
		Method,
		Property,
		Field,
		Constructor,
		Enum,
		Interface,
		Function,
		Variable,
		Constant,
		String,
		Number,
		Boolean,
1561 1562 1563 1564
		Array,
		Object,
		Key,
		Null
E
Erich Gamma 已提交
1565 1566
	}

J
Johannes Rieken 已提交
1567 1568 1569 1570
	/**
	 * Represents information about programming constructs like variables, classes,
	 * interfaces etc.
	 */
E
Erich Gamma 已提交
1571
	export class SymbolInformation {
J
Johannes Rieken 已提交
1572 1573 1574 1575

		/**
		 * The name of this symbol.
		 */
E
Erich Gamma 已提交
1576
		name: string;
J
Johannes Rieken 已提交
1577 1578 1579 1580

		/**
		 * The name of the symbol containing this symbol.
		 */
E
Erich Gamma 已提交
1581
		containerName: string;
J
Johannes Rieken 已提交
1582 1583 1584 1585

		/**
		 * The kind of this symbol.
		 */
E
Erich Gamma 已提交
1586
		kind: SymbolKind;
J
Johannes Rieken 已提交
1587 1588 1589 1590

		/**
		 * The location of this symbol.
		 */
E
Erich Gamma 已提交
1591
		location: Location;
J
Johannes Rieken 已提交
1592 1593 1594 1595 1596 1597 1598 1599

		/**
		 * Creates a new symbol information object.
		 *
		 * @param name The name of the symbol.
		 * @param kind The kind of the symbol.
		 * @param range The range of the location of the symbol.
		 * @param uri The resource of the location of symbol, defaults to the current document.
A
Andre Weinand 已提交
1600
		 * @param containerName The name of the symbol containing the symbol.
J
Johannes Rieken 已提交
1601 1602
		 */
		constructor(name: string, kind: SymbolKind, range: Range, uri?: Uri, containerName?: string);
E
Erich Gamma 已提交
1603 1604
	}

J
Johannes Rieken 已提交
1605 1606 1607 1608
	/**
	 * The document symbol provider interface defines the contract between extensions and
	 * the [go to symbol](https://code.visualstudio.com/docs/editor/editingevolved#_goto-symbol)-feature.
	 */
E
Erich Gamma 已提交
1609
	export interface DocumentSymbolProvider {
J
Johannes Rieken 已提交
1610 1611 1612 1613 1614 1615 1616

		/**
		 * Provide symbol information for the given document.
		 *
		 * @param document The document in which the command was invoked.
		 * @param token A cancellation token.
		 * @return An array of document highlights or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
1617
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1618
		 */
E
Erich Gamma 已提交
1619 1620 1621
		provideDocumentSymbols(document: TextDocument, token: CancellationToken): SymbolInformation[] | Thenable<SymbolInformation[]>;
	}

J
Johannes Rieken 已提交
1622 1623 1624 1625
	/**
	 * The workspace symbol provider interface defines the contract between extensions and
	 * the [symbol search](https://code.visualstudio.com/docs/editor/editingevolved#_open-symbol-by-name)-feature.
	 */
E
Erich Gamma 已提交
1626
	export interface WorkspaceSymbolProvider {
J
Johannes Rieken 已提交
1627 1628 1629 1630 1631 1632 1633 1634

		/**
		 * Project-wide search for a symbol matching the given query string. It is up to the provider
		 * how to search given the query string, like substring, indexOf etc.
		 *
		 * @param query A non-empty query string.
		 * @param token A cancellation token.
		 * @return An array of document highlights or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
1635
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1636
		 */
E
Erich Gamma 已提交
1637 1638 1639
		provideWorkspaceSymbols(query: string, token: CancellationToken): SymbolInformation[] | Thenable<SymbolInformation[]>;
	}

J
Johannes Rieken 已提交
1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655
	/**
	 * 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.
	 */
E
Erich Gamma 已提交
1656
	export interface ReferenceProvider {
J
Johannes Rieken 已提交
1657 1658 1659 1660 1661 1662 1663 1664 1665

		/**
		 * Provide a set of project-wide references for the given position and document.
		 *
		 * @param document The document in which the command was invoked.
		 * @param position The position at which the command was invoked.
		 * @param context
		 * @param token A cancellation token.
		 * @return An array of locations or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
1666
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1667 1668
		 */
		provideReferences(document: TextDocument, position: Position, context: ReferenceContext, token: CancellationToken): Location[] | Thenable<Location[]>;
E
Erich Gamma 已提交
1669 1670
	}

J
Johannes Rieken 已提交
1671
	/**
S
Steven Clarke 已提交
1672
	 * A text edit represents edits that should be applied
J
Johannes Rieken 已提交
1673
	 * to a document.
J
Johannes Rieken 已提交
1674
	 */
E
Erich Gamma 已提交
1675
	export class TextEdit {
J
Johannes Rieken 已提交
1676 1677 1678 1679 1680 1681 1682 1683

		/**
		 * Utility to create a replace edit.
		 *
		 * @param range A range.
		 * @param newText A string.
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
1684
		static replace(range: Range, newText: string): TextEdit;
J
Johannes Rieken 已提交
1685 1686 1687 1688

		/**
		 * Utility to create an insert edit.
		 *
S
Steven Clarke 已提交
1689
		 * @param position A position, will become an empty range.
J
Johannes Rieken 已提交
1690 1691 1692
		 * @param newText A string.
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
1693
		static insert(position: Position, newText: string): TextEdit;
J
Johannes Rieken 已提交
1694 1695 1696 1697

		/**
		 * Utility to create a delete edit.
		 *
J
Johannes Rieken 已提交
1698
		 * @param range A range.
J
Johannes Rieken 已提交
1699 1700
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
1701
		static delete(range: Range): TextEdit;
J
Johannes Rieken 已提交
1702 1703 1704 1705

		/**
		 * The range this edit applies to.
		 */
E
Erich Gamma 已提交
1706
		range: Range;
J
Johannes Rieken 已提交
1707 1708 1709 1710

		/**
		 * The string this edit will insert.
		 */
E
Erich Gamma 已提交
1711
		newText: string;
J
Johannes Rieken 已提交
1712 1713 1714 1715 1716 1717 1718 1719

		/**
		 * Create a new TextEdit.
		 *
		 * @param range A range.
		 * @param newText A string.
		 */
		constructor(range: Range, newText: string);
E
Erich Gamma 已提交
1720 1721 1722
	}

	/**
J
Johannes Rieken 已提交
1723
	 * A workspace edit represents textual changes for many documents.
E
Erich Gamma 已提交
1724 1725 1726 1727 1728 1729 1730 1731 1732 1733
	 */
	export class WorkspaceEdit {

		/**
		 * The number of affected resources.
		 *
		 * @readonly
		 */
		size: number;

J
Johannes Rieken 已提交
1734 1735 1736 1737 1738 1739 1740 1741
		/**
		 * Replace the given range with given text for the given resource.
		 *
		 * @param uri A resource identifier.
		 * @param range A range.
		 * @param newText A string.
		 */
		replace(uri: Uri, range: Range, newText: string): void;
E
Erich Gamma 已提交
1742

J
Johannes Rieken 已提交
1743 1744 1745 1746 1747 1748 1749 1750
		/**
		 * Insert the given text at the given position.
		 *
		 * @param uri A resource identifier.
		 * @param position A position.
		 * @param newText A string.
		 */
		insert(uri: Uri, position: Position, newText: string): void;
E
Erich Gamma 已提交
1751

J
Johannes Rieken 已提交
1752
		/**
S
Steven Clarke 已提交
1753
		 * Delete the text at the given range.
J
Johannes Rieken 已提交
1754 1755 1756
		 *
		 * @param uri A resource identifier.
		 * @param range A range.
J
Johannes Rieken 已提交
1757 1758
		 */
		delete(uri: Uri, range: Range): void;
E
Erich Gamma 已提交
1759

J
Johannes Rieken 已提交
1760 1761 1762
		/**
		 * Check if this edit affects the given resource.
		 * @param uri A resource identifier.
A
Andre Weinand 已提交
1763
		 * @return `true` if the given resource will be touched by this edit.
J
Johannes Rieken 已提交
1764
		 */
E
Erich Gamma 已提交
1765 1766
		has(uri: Uri): boolean;

J
Johannes Rieken 已提交
1767 1768 1769 1770 1771 1772
		/**
		 * Set (and replace) text edits for a resource.
		 *
		 * @param uri A resource identifier.
		 * @param edits An array of text edits.
		 */
E
Erich Gamma 已提交
1773 1774
		set(uri: Uri, edits: TextEdit[]): void;

J
Johannes Rieken 已提交
1775 1776 1777 1778 1779 1780
		/**
		 * Get the text edits for a resource.
		 *
		 * @param uri A resource identifier.
		 * @return An array of text edits.
		 */
E
Erich Gamma 已提交
1781 1782
		get(uri: Uri): TextEdit[];

J
Johannes Rieken 已提交
1783 1784 1785 1786 1787
		/**
		 * Get all text edits grouped by resource.
		 *
		 * @return An array of `[Uri, TextEdit[]]`-tuples.
		 */
E
Erich Gamma 已提交
1788 1789 1790 1791
		entries(): [Uri, TextEdit[]][];
	}

	/**
J
Johannes Rieken 已提交
1792 1793
	 * The rename provider interface defines the contract between extensions and
	 * the [rename](https://code.visualstudio.com/docs/editor/editingevolved#_rename-symbol)-feature.
E
Erich Gamma 已提交
1794 1795
	 */
	export interface RenameProvider {
J
Johannes Rieken 已提交
1796 1797 1798 1799 1800 1801 1802 1803 1804 1805

		/**
		 * Provide an edit that describes changes that have to be made to one
		 * or many resources to rename a symbol to a different name.
		 *
		 * @param document The document in which the command was invoked.
		 * @param position The position at which the command was invoked.
		 * @param newName The new name of the symbol. If the given name is not valid, the provider must return a rejected promise.
		 * @param token A cancellation token.
		 * @return A workspace edit or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
1806
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
1807
		 */
E
Erich Gamma 已提交
1808 1809 1810
		provideRenameEdits(document: TextDocument, position: Position, newName: string, token: CancellationToken): WorkspaceEdit | Thenable<WorkspaceEdit>;
	}

J
Johannes Rieken 已提交
1811 1812 1813
	/**
	 * Value-object describing what options formatting should use.
	 */
E
Erich Gamma 已提交
1814
	export interface FormattingOptions {
J
Johannes Rieken 已提交
1815 1816 1817 1818

		/**
		 * Size of a tab in spaces.
		 */
E
Erich Gamma 已提交
1819
		tabSize: number;
J
Johannes Rieken 已提交
1820 1821 1822 1823

		/**
		 * Prefer spaces over tabs.
		 */
E
Erich Gamma 已提交
1824
		insertSpaces: boolean;
J
Johannes Rieken 已提交
1825 1826 1827 1828 1829

		/**
		 * Signature for further properties.
		 */
		[key: string]: boolean | number | string;
E
Erich Gamma 已提交
1830 1831 1832
	}

	/**
J
Johannes Rieken 已提交
1833 1834
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
1835 1836
	 */
	export interface DocumentFormattingEditProvider {
J
Johannes Rieken 已提交
1837 1838 1839 1840 1841 1842 1843 1844

		/**
		 * Provide formatting edits for a whole document.
		 *
		 * @param document The document in which the command was invoked.
		 * @param options Options controlling formatting.
		 * @param token A cancellation token.
		 * @return A set of text edits or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
1845
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1846
		 */
E
Erich Gamma 已提交
1847 1848 1849 1850
		provideDocumentFormattingEdits(document: TextDocument, options: FormattingOptions, token: CancellationToken): TextEdit[] | Thenable<TextEdit[]>;
	}

	/**
J
Johannes Rieken 已提交
1851 1852
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
1853 1854
	 */
	export interface DocumentRangeFormattingEditProvider {
J
Johannes Rieken 已提交
1855 1856 1857 1858 1859

		/**
		 * Provide formatting edits for a range in a document.
		 *
		 * The given range is a hint and providers can decide to format a smaller
A
Andre Weinand 已提交
1860 1861
		 * or larger range. Often this is done by adjusting the start and end
		 * of the range to full syntax nodes.
J
Johannes Rieken 已提交
1862 1863 1864 1865 1866 1867
		 *
		 * @param document The document in which the command was invoked.
		 * @param range The range which should be formatted.
		 * @param options Options controlling formatting.
		 * @param token A cancellation token.
		 * @return A set of text edits or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
1868
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1869
		 */
E
Erich Gamma 已提交
1870 1871 1872 1873
		provideDocumentRangeFormattingEdits(document: TextDocument, range: Range, options: FormattingOptions, token: CancellationToken): TextEdit[] | Thenable<TextEdit[]>;
	}

	/**
J
Johannes Rieken 已提交
1874 1875
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
1876 1877
	 */
	export interface OnTypeFormattingEditProvider {
J
Johannes Rieken 已提交
1878 1879 1880 1881 1882 1883 1884 1885 1886 1887

		/**
		 * 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.
		 *
		 * @param document The document in which the command was invoked.
		 * @param position The position at which the command was invoked.
J
Johannes Rieken 已提交
1888
		 * @param ch The character that has been typed.
J
Johannes Rieken 已提交
1889 1890 1891
		 * @param options Options controlling formatting.
		 * @param token A cancellation token.
		 * @return A set of text edits or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
1892
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1893
		 */
E
Erich Gamma 已提交
1894 1895 1896
		provideOnTypeFormattingEdits(document: TextDocument, position: Position, ch: string, options: FormattingOptions, token: CancellationToken): TextEdit[] | Thenable<TextEdit[]>;
	}

J
Johannes Rieken 已提交
1897 1898 1899 1900
	/**
	 * Represents a parameter of a callable-signature. A parameter can
	 * have a label and a doc-comment.
	 */
E
Erich Gamma 已提交
1901
	export class ParameterInformation {
J
Johannes Rieken 已提交
1902 1903 1904 1905 1906

		/**
		 * The label of this signature. Will be shown in
		 * the UI.
		 */
E
Erich Gamma 已提交
1907
		label: string;
J
Johannes Rieken 已提交
1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920

		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
		documentation: string;

		/**
		 * Creates a new parameter information object.
		 *
		 * @param label A label string.
		 * @param documentation A doc string.
		 */
E
Erich Gamma 已提交
1921 1922 1923
		constructor(label: string, documentation?: string);
	}

J
Johannes Rieken 已提交
1924 1925 1926 1927 1928
	/**
	 * Represents the signature of something callable. A signature
	 * can have a label, like a function-name, a doc-comment, and
	 * a set of parameters.
	 */
E
Erich Gamma 已提交
1929
	export class SignatureInformation {
J
Johannes Rieken 已提交
1930 1931 1932 1933 1934

		/**
		 * The label of this signature. Will be shown in
		 * the UI.
		 */
E
Erich Gamma 已提交
1935
		label: string;
J
Johannes Rieken 已提交
1936 1937 1938 1939 1940 1941 1942 1943 1944 1945

		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
		documentation: string;

		/**
		 * The parameters of this signature.
		 */
E
Erich Gamma 已提交
1946
		parameters: ParameterInformation[];
J
Johannes Rieken 已提交
1947 1948 1949 1950 1951

		/**
		 * Creates a new signature information object.
		 *
		 * @param label A label string.
J
Johannes Rieken 已提交
1952
		 * @param documentation A doc string.
J
Johannes Rieken 已提交
1953
		 */
E
Erich Gamma 已提交
1954 1955 1956
		constructor(label: string, documentation?: string);
	}

J
Johannes Rieken 已提交
1957 1958
	/**
	 * Signature help represents the signature of something
S
Steven Clarke 已提交
1959
	 * callable. There can be multiple signatures but only one
J
Johannes Rieken 已提交
1960 1961
	 * active and only one active parameter.
	 */
E
Erich Gamma 已提交
1962
	export class SignatureHelp {
J
Johannes Rieken 已提交
1963 1964 1965 1966

		/**
		 * One or more signatures.
		 */
E
Erich Gamma 已提交
1967
		signatures: SignatureInformation[];
J
Johannes Rieken 已提交
1968 1969 1970 1971

		/**
		 * The active signature.
		 */
E
Erich Gamma 已提交
1972
		activeSignature: number;
J
Johannes Rieken 已提交
1973 1974 1975 1976

		/**
		 * The active parameter of the active signature.
		 */
E
Erich Gamma 已提交
1977 1978 1979
		activeParameter: number;
	}

J
Johannes Rieken 已提交
1980 1981 1982 1983
	/**
	 * The signature help provider interface defines the contract between extensions and
	 * the [parameter hints](https://code.visualstudio.com/docs/editor/editingevolved#_parameter-hints)-feature.
	 */
E
Erich Gamma 已提交
1984
	export interface SignatureHelpProvider {
J
Johannes Rieken 已提交
1985 1986 1987 1988 1989 1990 1991 1992

		/**
		 * Provide help for the signature at the given position and document.
		 *
		 * @param document The document in which the command was invoked.
		 * @param position The position at which the command was invoked.
		 * @param token A cancellation token.
		 * @return Signature help or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
1993
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
1994
		 */
E
Erich Gamma 已提交
1995 1996 1997
		provideSignatureHelp(document: TextDocument, position: Position, token: CancellationToken): SignatureHelp | Thenable<SignatureHelp>;
	}

J
Johannes Rieken 已提交
1998 1999 2000
	/**
	 * Completion item kinds.
	 */
E
Erich Gamma 已提交
2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021
	export enum CompletionItemKind {
		Text,
		Method,
		Function,
		Constructor,
		Field,
		Variable,
		Class,
		Interface,
		Module,
		Property,
		Unit,
		Value,
		Enum,
		Keyword,
		Snippet,
		Color,
		File,
		Reference
	}

J
Johannes Rieken 已提交
2022 2023 2024
	/**
	 * A completion item represents a text snippet that is
	 * proposed to complete text that is being typed.
J
Johannes Rieken 已提交
2025
	 *
2026 2027 2028 2029 2030 2031
	 * It is suffient to create a completion item from just
	 * a [label](#CompletionItem.label). In that case the completion
	 * item will replace the [word](#TextDocument.getWordRangeAtPosition)
	 * until the cursor with the given label.
	 *
	 *
J
Johannes Rieken 已提交
2032 2033
	 * @see [CompletionItemProvider.provideCompletionItems](#CompletionItemProvider.provideCompletionItems)
	 * @see [CompletionItemProvider.resolveCompletionItem](#CompletionItemProvider.resolveCompletionItem)
J
Johannes Rieken 已提交
2034
	 */
E
Erich Gamma 已提交
2035
	export class CompletionItem {
J
Johannes Rieken 已提交
2036 2037 2038

		/**
		 * The label of this completion item. By default
A
Andre Weinand 已提交
2039
		 * this is also the text that is inserted when selecting
J
Johannes Rieken 已提交
2040 2041
		 * this completion.
		 */
E
Erich Gamma 已提交
2042
		label: string;
J
Johannes Rieken 已提交
2043 2044

		/**
S
Steven Clarke 已提交
2045
		 * The kind of this completion item. Based on the kind
J
Johannes Rieken 已提交
2046 2047
		 * an icon is chosen by the editor.
		 */
E
Erich Gamma 已提交
2048
		kind: CompletionItemKind;
J
Johannes Rieken 已提交
2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061

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

		/**
A
Andre Weinand 已提交
2062
		 * A string that should be used when comparing this item
J
Johannes Rieken 已提交
2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075
		 * 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;

		/**
S
Steven Clarke 已提交
2076
		 * A string that should be inserted in a document when selecting
J
Johannes Rieken 已提交
2077 2078 2079
		 * this completion. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
E
Erich Gamma 已提交
2080
		insertText: string;
J
Johannes Rieken 已提交
2081 2082 2083 2084 2085

		/**
		 * An [edit](#TextEdit) which is applied to a document when selecting
		 * this completion. When an edit is provided the value of
		 * [insertText](#CompletionItem.insertText) is ignored.
2086 2087 2088
		 *
		 * The [range](#Range) of the edit must be single-line and one the same
		 * line completions where [requested](#CompletionItemProvider.provideCompletionItems) at.
J
Johannes Rieken 已提交
2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099
		 */
		textEdit: TextEdit;

		/**
		 * Creates a new completion item.
		 *
		 * Completion items must have at least a [label](#CompletionItem.label) which then
		 * will be used as insert text as well as for sorting and filtering.
		 *
		 * @param label The label of the completion.
		 */
E
Erich Gamma 已提交
2100 2101 2102
		constructor(label: string);
	}

2103 2104 2105 2106
	/**
	 * Represents a collection of [completion items](#CompletionItem) to be presented
	 * in the editor.
	 */
J
Johannes Rieken 已提交
2107
	export class CompletionList {
2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128

		/**
		 * This list it not complete. Further typing should result in recomputing
		 * this list.
		 */
		isIncomplete: boolean;

		/**
		 * The completion items.
		 */
		items: CompletionItem[];

		/**
		 * Creates a new completion list.
		 *
		 * @param items The completion items.
		 * @param isIncomplete The list is not complete.
		 */
		constructor(items?: CompletionItem[], isIncomplete?: boolean);
	}

J
Johannes Rieken 已提交
2129 2130 2131
	/**
	 * The completion item provider interface defines the contract between extensions and
	 * the [IntelliSense](https://code.visualstudio.com/docs/editor/editingevolved#_intellisense).
J
Johannes Rieken 已提交
2132 2133 2134 2135
	 *
	 * 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
J
Johannes Rieken 已提交
2136
	 * [provideCompletionItems](#CompletionItemProvider.provideCompletionItems)-function. Subsequently,
S
Steven Clarke 已提交
2137
	 * when a completion item is shown in the UI and gains focus this provider is asked to resolve
J
Johannes Rieken 已提交
2138
	 * the item, like adding [doc-comment](#CompletionItem.documentation) or [details](#CompletionItem.detail).
J
Johannes Rieken 已提交
2139
	 */
E
Erich Gamma 已提交
2140
	export interface CompletionItemProvider {
J
Johannes Rieken 已提交
2141 2142

		/**
J
Johannes Rieken 已提交
2143
		 * Provide completion items for the given position and document.
J
Johannes Rieken 已提交
2144
		 *
J
Johannes Rieken 已提交
2145 2146 2147
		 * @param document The document in which the command was invoked.
		 * @param position The position at which the command was invoked.
		 * @param token A cancellation token.
2148 2149
		 * @return An array of completions, a [completion list](#CompletionList), or a thenable that resolves to either.
		 * The lack of a result can be signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2150
		 */
2151
		provideCompletionItems(document: TextDocument, position: Position, token: CancellationToken): CompletionItem[] | Thenable<CompletionItem[]> | CompletionList | Thenable<CompletionList>;
J
Johannes Rieken 已提交
2152 2153

		/**
J
Johannes Rieken 已提交
2154 2155 2156 2157
		 * 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.
J
Johannes Rieken 已提交
2158
		 *
J
Johannes Rieken 已提交
2159 2160
		 * @param item A completion item currently active in the UI.
		 * @param token A cancellation token.
S
Steven Clarke 已提交
2161
		 * @return The resolved completion item or a thenable that resolves to of such. It is OK to return the given
J
Johannes Rieken 已提交
2162
		 * `item`. When no result is returned, the given `item` will be used.
J
Johannes Rieken 已提交
2163
		 */
E
Erich Gamma 已提交
2164 2165 2166
		resolveCompletionItem?(item: CompletionItem, token: CancellationToken): CompletionItem | Thenable<CompletionItem>;
	}

J
Johannes Rieken 已提交
2167 2168 2169 2170
	/**
	 * A tuple of two characters, like a pair of
	 * opening and closing brackets.
	 */
E
Erich Gamma 已提交
2171 2172
	export type CharacterPair = [string, string];

J
Johannes Rieken 已提交
2173 2174 2175
	/**
	 * Describes how comments for a language work.
	 */
E
Erich Gamma 已提交
2176
	export interface CommentRule {
J
Johannes Rieken 已提交
2177 2178 2179 2180

		/**
		 * The line comment token, like `// this is a comment`
		 */
E
Erich Gamma 已提交
2181
		lineComment?: string;
J
Johannes Rieken 已提交
2182 2183 2184 2185 2186

		/**
		 * The block comment character pair, like `/* block comment *&#47;`
		 */
		blockComment?: CharacterPair;
E
Erich Gamma 已提交
2187 2188
	}

A
Alex Dima 已提交
2189 2190 2191
	/**
	 * Describes indentation rules for a language.
	 */
E
Erich Gamma 已提交
2192
	export interface IndentationRule {
A
Alex Dima 已提交
2193 2194 2195
		/**
		 * If a line matches this pattern, then all the lines after it should be unindendented once (until another rule matches).
		 */
E
Erich Gamma 已提交
2196
		decreaseIndentPattern: RegExp;
A
Alex Dima 已提交
2197 2198 2199
		/**
		 * If a line matches this pattern, then all the lines after it should be indented once (until another rule matches).
		 */
E
Erich Gamma 已提交
2200
		increaseIndentPattern: RegExp;
A
Alex Dima 已提交
2201 2202 2203
		/**
		 * If a line matches this pattern, then **only the next line** after it should be indented once.
		 */
E
Erich Gamma 已提交
2204
		indentNextLinePattern?: RegExp;
A
Alex Dima 已提交
2205 2206 2207
		/**
		 * If a line matches this pattern, then its indentation should not be changed and it should not be evaluated against the other rules.
		 */
E
Erich Gamma 已提交
2208 2209 2210
		unIndentedLinePattern?: RegExp;
	}

A
Alex Dima 已提交
2211 2212 2213
	/**
	 * Describes what to do with the indentation when pressing Enter.
	 */
E
Erich Gamma 已提交
2214
	export enum IndentAction {
A
Alex Dima 已提交
2215 2216 2217
		/**
		 * Insert new line and copy the previous line's indentation.
		 */
E
Erich Gamma 已提交
2218
		None,
A
Alex Dima 已提交
2219 2220 2221
		/**
		 * Insert new line and indent once (relative to the previous line's indentation).
		 */
E
Erich Gamma 已提交
2222
		Indent,
A
Alex Dima 已提交
2223 2224 2225 2226 2227
		/**
		 * Insert two new lines:
		 *  - the first one indented which will hold the cursor
		 *  - the second one at the same indentation level
		 */
E
Erich Gamma 已提交
2228
		IndentOutdent,
A
Alex Dima 已提交
2229 2230 2231
		/**
		 * Insert new line and outdent once (relative to the previous line's indentation).
		 */
E
Erich Gamma 已提交
2232 2233 2234
		Outdent
	}

A
Alex Dima 已提交
2235 2236 2237
	/**
	 * Describes what to do when pressing Enter.
	 */
E
Erich Gamma 已提交
2238
	export interface EnterAction {
A
Alex Dima 已提交
2239 2240 2241 2242 2243 2244 2245
		/**
		 * Describe what to do with the indentation.
		 */
		indentAction: IndentAction;
		/**
		 * Describes text to be appended after the new line and after the indentation.
		 */
E
Erich Gamma 已提交
2246
		appendText?: string;
A
Alex Dima 已提交
2247 2248 2249 2250
		/**
		 * Describes the number of characters to remove from the new line's indentation.
		 */
		removeText?: number;
E
Erich Gamma 已提交
2251 2252
	}

A
Alex Dima 已提交
2253 2254 2255
	/**
	 * Describes a rule to be evaluated when pressing Enter.
	 */
E
Erich Gamma 已提交
2256
	export interface OnEnterRule {
A
Alex Dima 已提交
2257 2258 2259
		/**
		 * This rule will only execute if the text before the cursor matches this regular expression.
		 */
E
Erich Gamma 已提交
2260
		beforeText: RegExp;
A
Alex Dima 已提交
2261 2262 2263
		/**
		 * This rule will only execute if the text after the cursor matches this regular expression.
		 */
E
Erich Gamma 已提交
2264
		afterText?: RegExp;
A
Alex Dima 已提交
2265 2266 2267
		/**
		 * The action to execute.
		 */
E
Erich Gamma 已提交
2268 2269 2270
		action: EnterAction;
	}

J
Johannes Rieken 已提交
2271
	/**
A
Andre Weinand 已提交
2272
	 * The language configuration interfaces defines the contract between extensions
S
Steven Clarke 已提交
2273
	 * and various editor features, like automatic bracket insertion, automatic indentation etc.
J
Johannes Rieken 已提交
2274
	 */
E
Erich Gamma 已提交
2275
	export interface LanguageConfiguration {
A
Alex Dima 已提交
2276 2277 2278
		/**
		 * The language's comment settings.
		 */
E
Erich Gamma 已提交
2279
		comments?: CommentRule;
A
Alex Dima 已提交
2280 2281 2282 2283
		/**
		 * The language's brackets.
		 * This configuration implicitly affects pressing Enter around these brackets.
		 */
E
Erich Gamma 已提交
2284
		brackets?: CharacterPair[];
A
Alex Dima 已提交
2285 2286 2287 2288 2289 2290 2291
		/**
		 * 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
		 */
E
Erich Gamma 已提交
2292
		wordPattern?: RegExp;
A
Alex Dima 已提交
2293 2294 2295
		/**
		 * The language's indentation settings.
		 */
E
Erich Gamma 已提交
2296
		indentationRules?: IndentationRule;
A
Alex Dima 已提交
2297 2298 2299
		/**
		 * The language's rules to be evaluated when pressing Enter.
		 */
E
Erich Gamma 已提交
2300 2301 2302
		onEnterRules?: OnEnterRule[];

		/**
A
Alex Dima 已提交
2303
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
2304 2305
		 *
		 * @deprecated Will be replaced by a better API soon.
E
Erich Gamma 已提交
2306 2307
		 */
		__electricCharacterSupport?: {
2308 2309 2310 2311 2312 2313
			/**
			 * This property is deprecated and will be **ignored** from
			 * the editor.
			 * @deprecated
			 */
			brackets?: any;
E
Erich Gamma 已提交
2314
			docComment?: {
A
Alex Dima 已提交
2315 2316 2317 2318
				scope: string;
				open: string;
				lineStart: string;
				close?: string;
E
Erich Gamma 已提交
2319 2320 2321 2322
			};
		};

		/**
A
Alex Dima 已提交
2323
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
2324
		 *
J
Johannes Rieken 已提交
2325
		 * @deprecated Will be replaced by a better API soon.
E
Erich Gamma 已提交
2326 2327 2328 2329 2330 2331 2332 2333 2334 2335
		 */
		__characterPairSupport?: {
			autoClosingPairs: {
				open: string;
				close: string;
				notIn?: string[];
			}[];
		};
	}

J
Johannes Rieken 已提交
2336 2337 2338 2339 2340
	/**
	 * Represents the workspace configuration. The workspace configuration
	 * is always a merged view of the configuration of the current [workspace](#workspace.rootPath)
	 * and the installation-wide configuration.
	 */
E
Erich Gamma 已提交
2341 2342 2343
	export interface WorkspaceConfiguration {

		/**
J
Johannes Rieken 已提交
2344 2345 2346
		 * Return a value from this configuration.
		 *
		 * @param section Configuration name, supports _dotted_ names.
J
Johannes Rieken 已提交
2347
		 * @param defaultValue A value should be returned when no value could be found, is `undefined`.
J
Johannes Rieken 已提交
2348
		 * @return The value `section` denotes or the default.
E
Erich Gamma 已提交
2349 2350 2351 2352
		 */
		get<T>(section: string, defaultValue?: T): T;

		/**
J
Johannes Rieken 已提交
2353 2354
		 * Check if this configuration has a certain value.
		 *
A
Andre Weinand 已提交
2355 2356
		 * @param section configuration name, supports _dotted_ names.
		 * @return `true` iff the section doesn't resolve to `undefined`.
E
Erich Gamma 已提交
2357 2358 2359 2360 2361 2362 2363 2364 2365 2366
		 */
		has(section: string): boolean;

		/**
		 * Readable dictionary that backs this configuration.
		 * @readonly
		 */
		[key: string]: any;
	}

J
Johannes Rieken 已提交
2367 2368 2369 2370 2371
	/**
	 * Represents a location inside a resource, such as a line
	 * inside a text file.
	 */
	export class Location {
J
Johannes Rieken 已提交
2372 2373 2374 2375

		/**
		 * The resource identifier of this location.
		 */
J
Johannes Rieken 已提交
2376
		uri: Uri;
J
Johannes Rieken 已提交
2377 2378 2379 2380

		/**
		 * The document range of this locations.
		 */
J
Johannes Rieken 已提交
2381
		range: Range;
J
Johannes Rieken 已提交
2382 2383 2384 2385 2386 2387 2388 2389

		/**
		 * Creates a new location object.
		 *
		 * @param uri The resource identifier.
		 * @param rangeOrPosition The range or position. Positions will be converted to an empty range.
		 */
		constructor(uri: Uri, rangeOrPosition: Range | Position);
J
Johannes Rieken 已提交
2390 2391
	}

E
Erich Gamma 已提交
2392 2393 2394 2395
	/**
	 * Represents the severity of diagnostics.
	 */
	export enum DiagnosticSeverity {
J
Johannes Rieken 已提交
2396 2397

		/**
S
Steven Clarke 已提交
2398
		 * Something not allowed by the rules of a language or other means.
J
Johannes Rieken 已提交
2399 2400 2401 2402 2403 2404
		 */
		Error = 0,

		/**
		 * Something suspicious but allowed.
		 */
E
Erich Gamma 已提交
2405
		Warning = 1,
J
Johannes Rieken 已提交
2406 2407 2408 2409 2410 2411 2412

		/**
		 * Something to inform about but not a problem.
		 */
		Information = 2,

		/**
A
Andre Weinand 已提交
2413
		 * Something to hint to a better way of doing it, like proposing
J
Johannes Rieken 已提交
2414 2415 2416
		 * a refactoring.
		 */
		Hint = 3
E
Erich Gamma 已提交
2417 2418 2419
	}

	/**
J
Johannes Rieken 已提交
2420 2421
	 * Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
	 * are only valid in the scope of a file.
E
Erich Gamma 已提交
2422
	 */
J
Johannes Rieken 已提交
2423 2424 2425 2426 2427
	export class Diagnostic {

		/**
		 * The range to which this diagnostic applies.
		 */
E
Erich Gamma 已提交
2428
		range: Range;
J
Johannes Rieken 已提交
2429 2430 2431 2432 2433 2434

		/**
		 * The human-readable message.
		 */
		message: string;

2435 2436 2437 2438 2439 2440
		/**
		 * A human-readable string describing the source of this
		 * diagnostic, e.g. 'typescript' or 'super lint'.
		 */
		source: string;

J
Johannes Rieken 已提交
2441 2442 2443 2444 2445 2446
		/**
		 * The severity, default is [error](#DiagnosticSeverity.Error).
		 */
		severity: DiagnosticSeverity;

		/**
S
Steven Clarke 已提交
2447
		 * A code or identifier for this diagnostics. Will not be surfaced
A
Andre Weinand 已提交
2448
		 * to the user, but should be used for later processing, e.g. when
J
Johannes Rieken 已提交
2449 2450 2451 2452 2453
		 * providing [code actions](#CodeActionContext).
		 */
		code: string | number;

		/**
A
Andre Weinand 已提交
2454
		 * Creates a new diagnostic object.
J
Johannes Rieken 已提交
2455 2456 2457
		 *
		 * @param range The range to which this diagnostic applies.
		 * @param message The human-readable message.
A
Andre Weinand 已提交
2458
		 * @param severity The severity, default is [error](#DiagnosticSeverity.Error).
J
Johannes Rieken 已提交
2459 2460
		 */
		constructor(range: Range, message: string, severity?: DiagnosticSeverity);
E
Erich Gamma 已提交
2461 2462
	}

J
Johannes Rieken 已提交
2463 2464 2465 2466 2467 2468 2469 2470
	/**
	 * A diagnostics collection is a container that manages a set of
	 * [diagnostics](#Diagnostic). Diagnostics are always scopes to a
	 * a diagnostics collection and a resource.
	 *
	 * To get an instance of a `DiagnosticCollection` use
	 * [createDiagnosticCollection](#languages.createDiagnosticCollection).
	 */
E
Erich Gamma 已提交
2471 2472 2473
	export interface DiagnosticCollection {

		/**
J
Johannes Rieken 已提交
2474 2475 2476
		 * The name of this diagnostic collection, for instance `typescript`. Every diagnostic
		 * from this collection will be associated with this name. Also, the task framework uses this
		 * name when defining [problem matchers](https://code.visualstudio.com/docs/editor/tasks#_defining-a-problem-matcher).
E
Erich Gamma 已提交
2477 2478 2479 2480 2481
		 */
		name: string;

		/**
		 * Assign diagnostics for given resource. Will replace
J
Johannes Rieken 已提交
2482 2483 2484 2485
		 * existing diagnostics for that resource.
		 *
		 * @param uri A resource identifier.
		 * @param diagnostics Array of diagnostics or `undefined`
E
Erich Gamma 已提交
2486 2487 2488 2489 2490
		 */
		set(uri: Uri, diagnostics: Diagnostic[]): void;

		/**
		 * Remove all diagnostics from this collection that belong
J
Johannes Rieken 已提交
2491 2492 2493
		 * to the provided `uri`. The same as `#set(uri, undefined)`.
		 *
		 * @param uri A resource identifier.
E
Erich Gamma 已提交
2494 2495 2496 2497
		 */
		delete(uri: Uri): void;

		/**
A
Andre Weinand 已提交
2498
		 * Replace all entries in this collection.
J
Johannes Rieken 已提交
2499
		 *
A
Andre Weinand 已提交
2500
		 * @param entries An array of tuples, like `[[file1, [d1, d2]], [file2, [d3, d4, d5]]]`, or `undefined`.
E
Erich Gamma 已提交
2501 2502 2503 2504 2505 2506 2507 2508 2509
		 */
		set(entries: [Uri, Diagnostic[]][]): void;

		/**
		 * Remove all diagnostics from this collection. The same
		 * as calling `#set(undefined)`;
		 */
		clear(): void;

2510 2511 2512 2513 2514 2515 2516 2517
		/**
		 * Iterate over each entry in this collection.
		 *
		 * @param callback Function to execute for each entry.
		 * @param thisArg The `this` context used when invoking the handler function.
		 */
		forEach(callback: (uri: Uri, diagnostics: Diagnostic[], collection: DiagnosticCollection) => any, thisArg?: any): void;

2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535
		/**
		 * Get the diagnostics for a given resource. *Note* that you cannot
		 * modify the diagnostics-array returned from this call.
		 *
		 * @param uri A resource identifier.
		 * @returns An immutable array of [diagnostics](#Diagnostic) or `undefined`.
		 */
		get(uri: Uri): Diagnostic[];

		/**
		 * Check if this collection contains diagnostics for a
		 * given resource.
		 *
		 * @param uri A resource identifier.
		 * @returns `true` if this collection has diagnostic for the given resource.
		 */
		has(uri: Uri): boolean;

J
Johannes Rieken 已提交
2536 2537 2538 2539
		/**
		 * Dispose and free associated resources. Calls
		 * [clear](#DiagnosticCollection.clear).
		 */
E
Erich Gamma 已提交
2540 2541 2542
		dispose(): void;
	}

J
Johannes Rieken 已提交
2543
	/**
J
Johannes Rieken 已提交
2544 2545
	 * Denotes a column in the VS Code window. Columns are
	 * used to show editors side by side.
J
Johannes Rieken 已提交
2546 2547 2548 2549 2550 2551 2552
	 */
	export enum ViewColumn {
		One = 1,
		Two = 2,
		Three = 3
	}

E
Erich Gamma 已提交
2553
	/**
J
Johannes Rieken 已提交
2554 2555 2556 2557
	 * An output channel is a container for readonly textual information.
	 *
	 * To get an instance of an `OutputChannel` use
	 * [createOutputChannel](#window.createOutputChannel).
E
Erich Gamma 已提交
2558
	 */
J
Johannes Rieken 已提交
2559
	export interface OutputChannel {
E
Erich Gamma 已提交
2560

J
Johannes Rieken 已提交
2561 2562 2563 2564 2565
		/**
		 * The human-readable name of this output channel.
		 * @readonly
		 */
		name: string;
E
Erich Gamma 已提交
2566 2567

		/**
J
Johannes Rieken 已提交
2568
		 * Append the given value to the channel.
E
Erich Gamma 已提交
2569
		 *
J
Johannes Rieken 已提交
2570
		 * @param value A string, falsy values will not be printed.
E
Erich Gamma 已提交
2571
		 */
J
Johannes Rieken 已提交
2572
		append(value: string): void;
E
Erich Gamma 已提交
2573 2574

		/**
J
Johannes Rieken 已提交
2575 2576
		 * Append the given value and a line feed character
		 * to the channel.
E
Erich Gamma 已提交
2577
		 *
J
Johannes Rieken 已提交
2578
		 * @param value A string, falsy values will be printed.
E
Erich Gamma 已提交
2579 2580 2581
		 */
		appendLine(value: string): void;

J
Johannes Rieken 已提交
2582 2583 2584
		/**
		 * Removes all output from the channel.
		 */
E
Erich Gamma 已提交
2585 2586
		clear(): void;

J
Johannes Rieken 已提交
2587 2588
		/**
		 * Reveal this channel in the UI.
2589
		 *
J
Johannes Rieken 已提交
2590 2591 2592 2593
		 * @deprecated This method is **deprecated** and the overload with
		 * just one parameter should be used (`show(preservceFocus?: boolean): void`).
		 *
		 * @param column This argument is **deprecated** and will be ignored.
2594
		 * @param preserveFocus When `true` the channel will not take focus.
J
Johannes Rieken 已提交
2595
		 */
2596
		show(column?: ViewColumn, preserveFocus?: boolean): void;
E
Erich Gamma 已提交
2597

2598 2599 2600 2601 2602 2603 2604
		/**
		 * Reveal this channel in the UI.
		 *
		 * @param preserveFocus When `true` the channel will not take focus.
		 */
		show(preservceFocus?: boolean): void;

J
Johannes Rieken 已提交
2605 2606 2607
		/**
		 * Hide this channel from the UI.
		 */
E
Erich Gamma 已提交
2608 2609
		hide(): void;

J
Johannes Rieken 已提交
2610 2611 2612
		/**
		 * Dispose and free associated resources.
		 */
E
Erich Gamma 已提交
2613 2614 2615 2616
		dispose(): void;
	}

	/**
J
Johannes Rieken 已提交
2617
	 * Represents the alignment of status bar items.
E
Erich Gamma 已提交
2618 2619
	 */
	export enum StatusBarAlignment {
J
Johannes Rieken 已提交
2620 2621 2622 2623

		/**
		 * Aligned to the left side.
		 */
E
Erich Gamma 已提交
2624
		Left,
J
Johannes Rieken 已提交
2625 2626 2627 2628

		/**
		 * Aligned to the right side.
		 */
E
Erich Gamma 已提交
2629 2630 2631 2632 2633 2634 2635 2636 2637 2638
		Right
	}

	/**
	 * A status bar item is a status bar contribution that can
	 * show text and icons and run a command on click.
	 */
	export interface StatusBarItem {

		/**
J
Johannes Rieken 已提交
2639 2640
		 * The alignment of this item.
		 *
E
Erich Gamma 已提交
2641 2642 2643 2644 2645
		 * @readonly
		 */
		alignment: StatusBarAlignment;

		/**
J
Johannes Rieken 已提交
2646 2647 2648
		 * The priority of this item. Higher value means the item should
		 * be shown more to the left.
		 *
E
Erich Gamma 已提交
2649 2650 2651 2652 2653
		 * @readonly
		 */
		priority: number;

		/**
J
Johannes Rieken 已提交
2654 2655
		 * The text to show for the entry. You can embed icons in the text by leveraging the syntax:
		 *
2656
		 * `My text $(icon-name) contains icons like $(icon'name) this one.`
J
Johannes Rieken 已提交
2657
		 *
2658 2659
		 * Where the icon-name is taken from the [octicon](https://octicons.github.com) icon set, e.g.
		 * `light-bulb`, `thumbsup`, `zap` etc.
J
Johannes Rieken 已提交
2660
		 */
E
Erich Gamma 已提交
2661 2662 2663
		text: string;

		/**
J
Johannes Rieken 已提交
2664 2665
		 * The tooltip text when you hover over this entry.
		 */
E
Erich Gamma 已提交
2666 2667 2668
		tooltip: string;

		/**
J
Johannes Rieken 已提交
2669 2670
		 * The foreground color for this entry.
		 */
E
Erich Gamma 已提交
2671 2672 2673
		color: string;

		/**
J
Johannes Rieken 已提交
2674 2675 2676
		 * The identifier of a command to run on click. The command must be
		 * [known](#commands.getCommands).
		 */
E
Erich Gamma 已提交
2677 2678 2679 2680 2681 2682 2683 2684
		command: string;

		/**
		 * Shows the entry in the status bar.
		 */
		show(): void;

		/**
J
Johannes Rieken 已提交
2685
		 * Hide the entry in the status bar.
E
Erich Gamma 已提交
2686 2687 2688 2689
		 */
		hide(): void;

		/**
J
Johannes Rieken 已提交
2690 2691
		 * Dispose and free associated resources. Call
		 * [hide](#StatusBarItem.hide).
E
Erich Gamma 已提交
2692 2693 2694 2695
		 */
		dispose(): void;
	}

J
Johannes Rieken 已提交
2696 2697 2698
	/**
	 * Represents an extension.
	 *
A
Alex Dima 已提交
2699
	 * To get an instance of an `Extension` use [getExtension](#extensions.getExtension).
J
Johannes Rieken 已提交
2700
	 */
E
Erich Gamma 已提交
2701
	export interface Extension<T> {
J
Johannes Rieken 已提交
2702

E
Erich Gamma 已提交
2703
		/**
J
Johannes Rieken 已提交
2704
		 * The canonical extension identifier in the form of: `publisher.name`.
2705 2706
		 *
		 * @readonly
E
Erich Gamma 已提交
2707 2708 2709 2710
		 */
		id: string;

		/**
J
Johannes Rieken 已提交
2711
		 * The absolute file path of the directory containing this extension.
2712 2713
		 *
		 * @readonly
E
Erich Gamma 已提交
2714 2715 2716 2717
		 */
		extensionPath: string;

		/**
2718 2719 2720
		 * `true` if the extension has been activated.
		 *
		 * @readonly
E
Erich Gamma 已提交
2721 2722 2723 2724 2725
		 */
		isActive: boolean;

		/**
		 * The parsed contents of the extension's package.json.
2726 2727
		 *
		 * @readonly
E
Erich Gamma 已提交
2728 2729 2730 2731
		 */
		packageJSON: any;

		/**
A
Alex Dima 已提交
2732
		 * The public API exported by this extension. It is an invalid action
J
Johannes Rieken 已提交
2733
		 * to access this field before this extension has been activated.
2734 2735
		 *
		 * @readonly
E
Erich Gamma 已提交
2736 2737 2738 2739 2740
		 */
		exports: T;

		/**
		 * Activates this extension and returns its public API.
J
Johannes Rieken 已提交
2741
		 *
S
Steven Clarke 已提交
2742
		 * @return A promise that will resolve when this extension has been activated.
E
Erich Gamma 已提交
2743 2744 2745 2746
		 */
		activate(): Thenable<T>;
	}

J
Johannes Rieken 已提交
2747
	/**
S
Steven Clarke 已提交
2748 2749
	 * An extension context is a collection of utilities private to an
	 * extension.
J
Johannes Rieken 已提交
2750
	 *
S
Steven Clarke 已提交
2751
	 * An instance of an `ExtensionContext` is provided as the first
J
Johannes Rieken 已提交
2752 2753
	 * parameter to the `activate`-call of an extension.
	 */
E
Erich Gamma 已提交
2754 2755 2756 2757
	export interface ExtensionContext {

		/**
		 * An array to which disposables can be added. When this
J
Johannes Rieken 已提交
2758
		 * extension is deactivated the disposables will be disposed.
E
Erich Gamma 已提交
2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769
		 */
		subscriptions: { dispose(): any }[];

		/**
		 * A memento object that stores state in the context
		 * of the currently opened [workspace](#workspace.path).
		 */
		workspaceState: Memento;

		/**
		 * A memento object that stores state independent
A
Andre Weinand 已提交
2770
		 * of the current opened [workspace](#workspace.path).
E
Erich Gamma 已提交
2771 2772 2773 2774
		 */
		globalState: Memento;

		/**
J
Johannes Rieken 已提交
2775
		 * The absolute file path of the directory containing the extension.
E
Erich Gamma 已提交
2776 2777 2778 2779
		 */
		extensionPath: string;

		/**
A
Alex Dima 已提交
2780 2781 2782 2783
		 * Get the absolute path of a resource contained in the extension.
		 *
		 * @param relativePath A relative path to a resource contained in the extension.
		 * @return The absolute path of the resource.
E
Erich Gamma 已提交
2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794
		 */
		asAbsolutePath(relativePath: string): string;
	}

	/**
	 * A memento represents a storage utility. It can store and retrieve
	 * values.
	 */
	export interface Memento {

		/**
J
Johannes Rieken 已提交
2795 2796 2797 2798 2799
		 * Return a value.
		 *
		 * @param key A string.
		 * @param defaultValue A value that should be returned when there is no
		 * value (`undefined`) with the given key.
A
Andre Weinand 已提交
2800
		 * @return The stored value, `undefined`, or the defaultValue.
E
Erich Gamma 已提交
2801 2802 2803 2804
		 */
		get<T>(key: string, defaultValue?: T): T;

		/**
S
Steven Clarke 已提交
2805
		 * Store a value. The value must be JSON-stringifyable.
J
Johannes Rieken 已提交
2806 2807 2808
		 *
		 * @param key A string.
		 * @param value A value. MUST not contain cyclic references.
E
Erich Gamma 已提交
2809 2810 2811 2812
		 */
		update(key: string, value: any): Thenable<void>;
	}

2813 2814 2815 2816 2817
	/**
	 * Namespace describing the environment the editor runs in.
	 */
	export namespace env {

2818 2819 2820 2821 2822 2823 2824
		/**
		 * The application name of the editor, like 'VS Code'.
		 *
		 * @readonly
		 */
		export let appName: string;

J
Johannes Rieken 已提交
2825 2826 2827 2828 2829 2830 2831
		/**
		 * Represents the preferred user-language, like `de-CH`, `fr`, or `en-US`.
		 *
		 * @readonly
		 */
		export let language: string;

2832 2833
		/**
		 * A unique identifier for the computer.
J
Johannes Rieken 已提交
2834 2835
		 *
		 * @readonly
2836 2837 2838 2839 2840 2841
		 */
		export let machineId: string;

		/**
		 * A unique identifier for the current session.
		 * Changes each time the editor is started.
J
Johannes Rieken 已提交
2842 2843
		 *
		 * @readonly
2844 2845 2846 2847
		 */
		export let sessionId: string;
	}

E
Erich Gamma 已提交
2848
	/**
2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861
	 * Namespace for dealing with commands. In short, a command is a function with a
	 * unique identifier. The function is sometimes also called _command handler_.
	 *
	 * Commands can be added to the editor using the [registerCommand](#commands.registerCommand)
	 * and [registerTextEditorCommand](#commands.registerTextEditorCommand) functions. Commands
	 * can be executed [manually](#commands.executeCommand) or from a UI gesture. Those are:
	 *
	 * * palette - Use the `commands`-section in `package.json` to make a command show in
	 * the [command palette](https://code.visualstudio.com/docs/editor/codebasics#_command-palette).
	 * * keybinding - Use the `keybindings`-section in `package.json` to enable
	 * [keybindings](https://code.visualstudio.com/docs/customization/keybindings#_customizing-shortcuts)
	 * for your extension.
	 *
S
Steven Clarke 已提交
2862
	 * Commands from other extensions and from the editor itself are accessible to an extension. However,
2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881
	 * when invoking an editor command not all argument types are supported.
	 *
	 * This is a sample that registers a command handler and adds an entry for that command to the palette. First
	 * register a command handler with the identfier `extension.sayHello`.
	 * ```javascript
	 * commands.registerCommand('extension.sayHello', () => {
	 * 		window.showInformationMessage('Hello World!');
	 * });
	 * ```
	 * Second, bind the command identfier to a title under which it will show in the palette (`package.json`).
	 * ```json
	 * {
	 * "contributes": {
	 * 		"commands": [{
	 * 		"command": "extension.sayHello",
	 * 		"title": "Hello World"
	 * 	}]
	 * }
	 * ```
E
Erich Gamma 已提交
2882 2883 2884 2885 2886
	 */
	export namespace commands {

		/**
		 * Registers a command that can be invoked via a keyboard shortcut,
S
Steven Clarke 已提交
2887
		 * a menu item, an action, or directly.
E
Erich Gamma 已提交
2888
		 *
J
Johannes Rieken 已提交
2889 2890 2891 2892 2893
		 * Registering a command with an existing command identifier twice
		 * will cause an error.
		 *
		 * @param command A unique identifier for the command.
		 * @param callback A command handler function.
J
Johannes Rieken 已提交
2894
		 * @param thisArg The `this` context used when invoking the handler function.
J
Johannes Rieken 已提交
2895
		 * @return Disposable which unregisters this command on disposal.
E
Erich Gamma 已提交
2896 2897 2898 2899
		 */
		export function registerCommand(command: string, callback: (...args: any[]) => any, thisArg?: any): Disposable;

		/**
J
Johannes Rieken 已提交
2900
		 * Registers a text editor command that can be invoked via a keyboard shortcut,
S
Steven Clarke 已提交
2901
		 * a menu item, an action, or directly.
E
Erich Gamma 已提交
2902
		 *
J
Johannes Rieken 已提交
2903
		 * Text editor commands are different from ordinary [commands](#commands.registerCommand) as
S
Steven Clarke 已提交
2904
		 * they only execute when there is an active editor when the command is called. Also, the
J
Johannes Rieken 已提交
2905 2906 2907 2908 2909
		 * command handler of an editor command has access to the active editor and to an
		 * [edit](#TextEditorEdit)-builder.
		 *
		 * @param command A unique identifier for the command.
		 * @param callback A command handler function with access to an [editor](#TextEditor) and an [edit](#TextEditorEdit).
J
Johannes Rieken 已提交
2910
		 * @param thisArg The `this` context used when invoking the handler function.
J
Johannes Rieken 已提交
2911
		 * @return Disposable which unregisters this command on disposal.
E
Erich Gamma 已提交
2912
		 */
J
Johannes Rieken 已提交
2913
		export function registerTextEditorCommand(command: string, callback: (textEditor: TextEditor, edit: TextEditorEdit, ...args: any[]) => void, thisArg?: any): Disposable;
E
Erich Gamma 已提交
2914 2915

		/**
J
Johannes Rieken 已提交
2916 2917 2918
		 * Executes the command denoted by the given command identifier.
		 *
		 * When executing an editor command not all types are allowed to
2919
		 * be passed as arguments. Allowed are the primitive types `string`, `boolean`,
J
Johannes Rieken 已提交
2920
		 * `number`, `undefined`, and `null`, as well as classes defined in this API.
S
Steven Clarke 已提交
2921
		 * There are no restrictions when executing commands that have been contributed
J
Johannes Rieken 已提交
2922
		 * by extensions.
E
Erich Gamma 已提交
2923
		 *
J
Johannes Rieken 已提交
2924
		 * @param command Identifier of the command to execute.
J
Johannes Rieken 已提交
2925 2926 2927
		 * @param rest Parameters passed to the command function.
		 * @return A thenable that resolves to the returned value of the given command. `undefined` when
		 * the command handler function doesn't return anything.
E
Erich Gamma 已提交
2928 2929 2930 2931
		 */
		export function executeCommand<T>(command: string, ...rest: any[]): Thenable<T>;

		/**
2932 2933
		 * Retrieve the list of all available commands. Commands starting an underscore are
		 * treated as internal commands.
E
Erich Gamma 已提交
2934
		 *
2935
		 * @param filterInternal Set `true` to not see internal commands (starting with an underscore)
E
Erich Gamma 已提交
2936 2937
		 * @return Thenable that resolves to a list of command ids.
		 */
2938
		export function getCommands(filterInternal?: boolean): Thenable<string[]>;
E
Erich Gamma 已提交
2939 2940 2941
	}

	/**
2942 2943 2944
	 * Namespace for dealing with the current window of the editor. That is visible
	 * and active editors, as well as, UI elements to show messages, selections, and
	 * asking for user input.
E
Erich Gamma 已提交
2945 2946 2947 2948
	 */
	export namespace window {

		/**
2949
		 * The currently active editor or `undefined`. The active editor is the one
S
Steven Clarke 已提交
2950
		 * that currently has focus or, when none has focus, the one that has changed
E
Erich Gamma 已提交
2951 2952 2953 2954 2955
		 * input most recently.
		 */
		export let activeTextEditor: TextEditor;

		/**
2956
		 * The currently visible editors or an empty array.
E
Erich Gamma 已提交
2957 2958 2959 2960
		 */
		export let visibleTextEditors: TextEditor[];

		/**
2961
		 * An [event](#Event) which fires when the [active editor](#window.activeTextEditor)
J
Johannes Rieken 已提交
2962
		 * has changed. *Note* that the event also fires when the active editor changes
2963
		 * to `undefined`.
E
Erich Gamma 已提交
2964 2965 2966 2967
		 */
		export const onDidChangeActiveTextEditor: Event<TextEditor>;

		/**
A
Andre Weinand 已提交
2968
		 * An [event](#Event) which fires when the selection in an editor has changed.
E
Erich Gamma 已提交
2969 2970 2971 2972 2973 2974 2975 2976
		 */
		export const onDidChangeTextEditorSelection: Event<TextEditorSelectionChangeEvent>;

		/**
		 * An [event](#Event) which fires when the options of an editor have changed.
		 */
		export const onDidChangeTextEditorOptions: Event<TextEditorOptionsChangeEvent>;

2977
		/**
G
Greg Van Liew 已提交
2978
		 * An [event](#Event) which fires when the view column of an editor has changed.
2979
		 */
J
Johannes Rieken 已提交
2980
		export const onDidChangeTextEditorViewColumn: Event<TextEditorViewColumnChangeEvent>;
2981

E
Erich Gamma 已提交
2982 2983 2984 2985 2986 2987 2988
		/**
		 * Show the given document in a text editor. A [column](#ViewColumn) can be provided
		 * to control where the editor is being shown. Might change the [active editor](#window.activeTextEditor).
		 *
		 * @param document A text document to be shown.
		 * @param column A view column in which the editor should be shown. The default is the [one](#ViewColumn.One), other values
		 * are adjusted to be __Min(column, columnCount + 1)__.
2989
		 * @param preserveFocus When `true` the editor will not take focus.
E
Erich Gamma 已提交
2990 2991
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
2992
		export function showTextDocument(document: TextDocument, column?: ViewColumn, preserveFocus?: boolean): Thenable<TextEditor>;
E
Erich Gamma 已提交
2993 2994

		/**
J
Johannes Rieken 已提交
2995 2996 2997 2998
		 * Create a TextEditorDecorationType that can be used to add decorations to text editors.
		 *
		 * @param options Rendering options for the decoration type.
		 * @return A new decoration type instance.
E
Erich Gamma 已提交
2999 3000 3001 3002 3003 3004 3005
		 */
		export function createTextEditorDecorationType(options: DecorationRenderOptions): TextEditorDecorationType;

		/**
		 * Show an information message to users. Optionally provide an array of items which will be presented as
		 * clickable buttons.
		 *
J
Johannes Rieken 已提交
3006 3007
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
3008
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
3009 3010 3011 3012
		 */
		export function showInformationMessage(message: string, ...items: string[]): Thenable<string>;

		/**
J
Johannes Rieken 已提交
3013
		 * Show an information message.
J
Johannes Rieken 已提交
3014
		 *
E
Erich Gamma 已提交
3015
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
3016 3017 3018
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
3019
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
3020 3021 3022 3023
		 */
		export function showInformationMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T>;

		/**
J
Johannes Rieken 已提交
3024
		 * Show a warning message.
J
Johannes Rieken 已提交
3025
		 *
E
Erich Gamma 已提交
3026
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
3027 3028 3029
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
3030
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
3031 3032 3033 3034
		 */
		export function showWarningMessage(message: string, ...items: string[]): Thenable<string>;

		/**
J
Johannes Rieken 已提交
3035
		 * Show a warning message.
J
Johannes Rieken 已提交
3036
		 *
E
Erich Gamma 已提交
3037
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
3038 3039 3040
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
3041
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
3042 3043 3044 3045
		 */
		export function showWarningMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T>;

		/**
J
Johannes Rieken 已提交
3046
		 * Show an error message.
J
Johannes Rieken 已提交
3047
		 *
E
Erich Gamma 已提交
3048
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
3049 3050 3051
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
3052
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
3053 3054 3055 3056
		 */
		export function showErrorMessage(message: string, ...items: string[]): Thenable<string>;

		/**
J
Johannes Rieken 已提交
3057
		 * Show an error message.
J
Johannes Rieken 已提交
3058
		 *
E
Erich Gamma 已提交
3059
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
3060 3061 3062
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
3063
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
3064 3065 3066 3067 3068 3069
		 */
		export function showErrorMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T>;

		/**
		 * Shows a selection list.
		 *
J
Johannes Rieken 已提交
3070 3071 3072
		 * @param items An array of strings, or a promise that resolves to an array of strings.
		 * @param options Configures the behavior of the selection list.
		 * @return A promise that resolves to the selection or undefined.
E
Erich Gamma 已提交
3073 3074 3075 3076 3077 3078
		 */
		export function showQuickPick(items: string[] | Thenable<string[]>, options?: QuickPickOptions): Thenable<string>;

		/**
		 * Shows a selection list.
		 *
J
Johannes Rieken 已提交
3079 3080 3081
		 * @param items An array of items, or a promise that resolves to an array of items.
		 * @param options Configures the behavior of the selection list.
		 * @return A promise that resolves to the selected item or undefined.
E
Erich Gamma 已提交
3082 3083 3084 3085 3086 3087
		 */
		export function showQuickPick<T extends QuickPickItem>(items: T[] | Thenable<T[]>, options?: QuickPickOptions): Thenable<T>;

		/**
		 * Opens an input box to ask the user for input.
		 *
S
Steven Clarke 已提交
3088
		 * The returned value will be undefined if the input box was canceled (e.g. pressing ESC). Otherwise the
A
Andre Weinand 已提交
3089
		 * returned value will be the string typed by the user or an empty string if the user did not type
S
Steven Clarke 已提交
3090
		 * anything but dismissed the input box with OK.
E
Erich Gamma 已提交
3091
		 *
J
Johannes Rieken 已提交
3092 3093
		 * @param options Configures the behavior of the input box.
		 * @return A promise that resolves to a string the user provided or to `undefined` in case of dismissal.
E
Erich Gamma 已提交
3094 3095 3096 3097
		 */
		export function showInputBox(options?: InputBoxOptions): Thenable<string>;

		/**
J
Johannes Rieken 已提交
3098 3099
		 * Create a new [output channel](#OutputChannel) with the given name.
		 *
3100
		 * @param name Human-readable string which will be used to represent the channel in the UI.
E
Erich Gamma 已提交
3101
		 */
3102
		export function createOutputChannel(name: string): OutputChannel;
E
Erich Gamma 已提交
3103 3104

		/**
S
Steven Clarke 已提交
3105
		 * Set a message to the status bar. This is a short hand for the more powerful
E
Erich Gamma 已提交
3106
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
3107
		 *
A
Andre Weinand 已提交
3108
		 * @param text The message to show, support icon subtitution as in status bar [items](#StatusBarItem.text).
J
Johannes Rieken 已提交
3109
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
3110 3111 3112 3113
		 */
		export function setStatusBarMessage(text: string): Disposable;

		/**
S
Steven Clarke 已提交
3114
		 * Set a message to the status bar. This is a short hand for the more powerful
J
Johannes Rieken 已提交
3115
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
3116
		 *
A
Andre Weinand 已提交
3117
		 * @param text The message to show, support icon subtitution as in status bar [items](#StatusBarItem.text).
E
Erich Gamma 已提交
3118
		 * @param hideAfterTimeout Timeout in milliseconds after which the message will be disposed.
J
Johannes Rieken 已提交
3119
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
3120 3121 3122 3123
		 */
		export function setStatusBarMessage(text: string, hideAfterTimeout: number): Disposable;

		/**
S
Steven Clarke 已提交
3124
		 * Set a message to the status bar. This is a short hand for the more powerful
J
Johannes Rieken 已提交
3125
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
3126
		 *
A
Andre Weinand 已提交
3127
		 * @param text The message to show, support icon subtitution as in status bar [items](#StatusBarItem.text).
E
Erich Gamma 已提交
3128
		 * @param hideWhenDone Thenable on which completion (resolve or reject) the message will be disposed.
J
Johannes Rieken 已提交
3129
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
3130 3131 3132 3133
		 */
		export function setStatusBarMessage(text: string, hideWhenDone: Thenable<any>): Disposable;

		/**
J
Johannes Rieken 已提交
3134 3135
		 * Creates a status bar [item](#StatusBarItem).
		 *
J
Johannes Rieken 已提交
3136
		 * @param alignment The alignment of the item.
J
Johannes Rieken 已提交
3137
		 * @param priority The priority of the item. Higher values mean the item should be shown more to the left.
J
Johannes Rieken 已提交
3138 3139
		 * @return A new status bar item.
		 */
E
Erich Gamma 已提交
3140 3141 3142 3143
		export function createStatusBarItem(alignment?: StatusBarAlignment, priority?: number): StatusBarItem;
	}

	/**
A
Alex Dima 已提交
3144
	 * An event describing an individual change in the text of a [document](#TextDocument).
E
Erich Gamma 已提交
3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161
	 */
	export interface TextDocumentContentChangeEvent {
		/**
		 * The range that got replaced.
		 */
		range: Range;
		/**
		 * The length of the range that got replaced.
		 */
		rangeLength: number;
		/**
		 * The new text for the range.
		 */
		text: string;
	}

	/**
A
Alex Dima 已提交
3162
	 * An event describing a transactional [document](#TextDocument) change.
E
Erich Gamma 已提交
3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177
	 */
	export interface TextDocumentChangeEvent {

		/**
		 * The affected document.
		 */
		document: TextDocument;

		/**
		 * An array of content changes.
		 */
		contentChanges: TextDocumentContentChangeEvent[];
	}

	/**
3178 3179 3180 3181 3182 3183
	 * Namespace for dealing with the current workspace. A workspace is the representation
	 * of the folder that has been opened. There is no workspace when just a file but not a
	 * folder has been opened.
	 *
	 * The workspace offers support for [listening](#workspace.createFileSystemWatcher) to fs
	 * events and for [finding](#workspace#findFiles) files. Both perform well and run _outside_
S
Steven Clarke 已提交
3184
	 * the editor-process so that they should be always used instead of nodejs-equivalents.
E
Erich Gamma 已提交
3185 3186 3187 3188
	 */
	export namespace workspace {

		/**
J
Johannes Rieken 已提交
3189 3190 3191
		 * Creates a file system watcher.
		 *
		 * A glob pattern that filters the file events must be provided. Optionally, flags to ignore certain
S
Steven Clarke 已提交
3192
		 * kinds of events can be provided. To stop listening to events the watcher must be disposed.
E
Erich Gamma 已提交
3193
		 *
A
Andre Weinand 已提交
3194
		 * @param globPattern A glob pattern that is applied to the names of created, changed, and deleted files.
J
Johannes Rieken 已提交
3195 3196 3197 3198
		 * @param ignoreCreateEvents Ignore when files have been created.
		 * @param ignoreChangeEvents Ignore when files have been changed.
		 * @param ignoreDeleteEvents Ignore when files have been deleted.
		 * @return A new file system watcher instance.
E
Erich Gamma 已提交
3199 3200 3201 3202
		 */
		export function createFileSystemWatcher(globPattern: string, ignoreCreateEvents?: boolean, ignoreChangeEvents?: boolean, ignoreDeleteEvents?: boolean): FileSystemWatcher;

		/**
J
Johannes Rieken 已提交
3203 3204
		 * The folder that is open in VS Code. `undefined` when no folder
		 * has been opened.
3205
		 *
S
Steve Baker 已提交
3206
		 * @readonly
E
Erich Gamma 已提交
3207 3208 3209 3210
		 */
		export let rootPath: string;

		/**
J
Johannes Rieken 已提交
3211 3212 3213 3214 3215 3216 3217
		 * Returns a path that is relative to the workspace root.
		 *
		 * When there is no [workspace root](#workspace.rootPath) or when the path
		 * is not a child of that folder, the input is returned.
		 *
		 * @param pathOrUri A path or uri. When a uri is given its [fsPath](#Uri.fsPath) is used.
		 * @return A path relative to the root or the input.
E
Erich Gamma 已提交
3218 3219 3220
		 */
		export function asRelativePath(pathOrUri: string | Uri): string;

J
Johannes Rieken 已提交
3221 3222 3223
		/**
		 * Find files in the workspace.
		 *
3224
		 * @sample `findFiles('**∕*.js', '**∕node_modules∕**', 10)`
J
Johannes Rieken 已提交
3225
		 * @param include A glob pattern that defines the files to search for.
S
Steven Clarke 已提交
3226
		 * @param exclude A glob pattern that defines files and folders to exclude.
J
Johannes Rieken 已提交
3227
		 * @param maxResults An upper-bound for the result.
3228
		 * @param token A token that can be used to signal cancellation to the underlying search engine.
J
Johannes Rieken 已提交
3229 3230
		 * @return A thenable that resolves to an array of resource identifiers.
		 */
3231
		export function findFiles(include: string, exclude: string, maxResults?: number, token?: CancellationToken): Thenable<Uri[]>;
E
Erich Gamma 已提交
3232 3233

		/**
J
Johannes Rieken 已提交
3234 3235 3236
		 * Save all dirty files.
		 *
		 * @param includeUntitled Also save files that have been created during this session.
S
Steven Clarke 已提交
3237
		 * @return A thenable that resolves when the files have been saved.
E
Erich Gamma 已提交
3238 3239 3240 3241
		 */
		export function saveAll(includeUntitled?: boolean): Thenable<boolean>;

		/**
J
Johannes Rieken 已提交
3242 3243 3244
		 * Make changes to one or many resources as defined by the given
		 * [workspace edit](#WorkspaceEdit).
		 *
S
Steven Clarke 已提交
3245 3246 3247
		 * When applying a workspace edit, the editor implements an 'all-or-nothing'-strategy,
		 * that means failure to load one document or make changes to one document will cause
		 * the edit to be rejected.
J
Johannes Rieken 已提交
3248 3249 3250
		 *
		 * @param edit A workspace edit.
		 * @return A thenable that resolves when the edit could be applied.
E
Erich Gamma 已提交
3251 3252 3253 3254 3255
		 */
		export function applyEdit(edit: WorkspaceEdit): Thenable<boolean>;

		/**
		 * All text documents currently known to the system.
J
Johannes Rieken 已提交
3256 3257
		 *
		 * @readonly
E
Erich Gamma 已提交
3258 3259 3260 3261 3262 3263 3264 3265
		 */
		export let textDocuments: TextDocument[];

		/**
		 * Opens the denoted document from disk. Will return early if the
		 * document is already open, otherwise the document is loaded and the
		 * [open document](#workspace.onDidOpenTextDocument)-event fires.
		 * The document to open is denoted by the [uri](#Uri). Two schemes are supported:
J
Johannes Rieken 已提交
3266
		 *
3267 3268
		 * file: A file on disk, will be rejected if the file does not exist or cannot be loaded, e.g. `file:///Users/frodo/r.ini`.
		 * untitled: A new file that should be saved on disk, e.g. `untitled:c:\frodo\new.js`. The language will be derived from the file name.
J
Johannes Rieken 已提交
3269
		 *
A
Andre Weinand 已提交
3270
		 * Uris with other schemes will make this method return a rejected promise.
E
Erich Gamma 已提交
3271 3272 3273 3274 3275 3276 3277
		 *
		 * @param uri Identifies the resource to open.
		 * @return A promise that resolves to a [document](#TextDocument).
		 */
		export function openTextDocument(uri: Uri): Thenable<TextDocument>;

		/**
J
Johannes Rieken 已提交
3278 3279 3280
		 * A short-hand for `openTextDocument(Uri.file(fileName))`.
		 *
		 * @see [openTextDocument](#openTextDocument)
A
Andre Weinand 已提交
3281 3282
		 * @param fileName A name of a file on disk.
		 * @return A promise that resolves to a [document](#TextDocument).
E
Erich Gamma 已提交
3283 3284 3285
		 */
		export function openTextDocument(fileName: string): Thenable<TextDocument>;

J
Johannes Rieken 已提交
3286
		/**
3287 3288 3289
		 * Register a text document content provider.
		 *
		 * Only one provider can be registered per scheme.
J
Johannes Rieken 已提交
3290
		 *
3291 3292 3293
		 * @param scheme The uri-scheme to register for.
		 * @param provider A content provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
J
Johannes Rieken 已提交
3294 3295 3296
		 */
		export function registerTextDocumentContentProvider(scheme: string, provider: TextDocumentContentProvider): Disposable;

A
Alex Dima 已提交
3297
		/**
J
Johannes Rieken 已提交
3298
		 * An event that is emitted when a [text document](#TextDocument) is opened.
A
Alex Dima 已提交
3299
		 */
E
Erich Gamma 已提交
3300 3301
		export const onDidOpenTextDocument: Event<TextDocument>;

A
Alex Dima 已提交
3302 3303 3304
		/**
		 * An event that is emitted when a [text document](#TextDocument) is disposed.
		 */
E
Erich Gamma 已提交
3305 3306
		export const onDidCloseTextDocument: Event<TextDocument>;

A
Alex Dima 已提交
3307 3308 3309
		/**
		 * An event that is emitted when a [text document](#TextDocument) is changed.
		 */
E
Erich Gamma 已提交
3310 3311
		export const onDidChangeTextDocument: Event<TextDocumentChangeEvent>;

A
Alex Dima 已提交
3312 3313 3314
		/**
		 * An event that is emitted when a [text document](#TextDocument) is saved to disk.
		 */
E
Erich Gamma 已提交
3315 3316 3317
		export const onDidSaveTextDocument: Event<TextDocument>;

		/**
J
Johannes Rieken 已提交
3318 3319 3320
		 * Get a configuration object.
		 *
		 * When a section-identifier is provided only that part of the configuration
A
Andre Weinand 已提交
3321
		 * is returned. Dots in the section-identifier are interpreted as child-access,
J
Johannes Rieken 已提交
3322
		 * like `{ myExt: { setting: { doIt: true }}}` and `getConfiguration('myExt.setting.doIt') === true`.
E
Erich Gamma 已提交
3323
		 *
J
Johannes Rieken 已提交
3324 3325 3326
		 *
		 * @param section A dot-separated identifier.
		 * @return The full workspace configuration or a subset.
E
Erich Gamma 已提交
3327 3328 3329
		 */
		export function getConfiguration(section?: string): WorkspaceConfiguration;

J
Johannes Rieken 已提交
3330 3331 3332
		/**
		 * An event that is emitted when the [configuration](#WorkspaceConfiguration) changed.
		 */
E
Erich Gamma 已提交
3333 3334 3335
		export const onDidChangeConfiguration: Event<void>;
	}

J
Johannes Rieken 已提交
3336
	/**
3337 3338 3339 3340 3341 3342 3343
	 * Namespace for participating in language-specific editor [features](https://code.visualstudio.com/docs/editor/editingevolved),
	 * like IntelliSense, code actions, diagnostics etc.
	 *
	 * Many programming languages exist and there is huge variety in syntaxes, semantics, and paradigms. Despite that, features
	 * like automatic word-completion, code navigation, or code checking have become popular across different tools for different
	 * programming languages.
	 *
S
Steven Clarke 已提交
3344
	 * The editor provides an API that makes it simple to provide such common features by having all UI and actions already in place and
3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355
	 * by allowing you to participate by providing data only. For instance, to contribute a hover all you have to do is provide a function
	 * that can be called with a [TextDocument](#TextDocument) and a [Position](#Position) returning hover info. The rest, like tracking the
	 * mouse, positioning the hover, keeping the hover stable etc. is taken care of by the editor.
	 *
	 * ```javascript
	 * languages.registerHoverProvider('javascript', {
	 * 		provideHover(document, position, token) {
	 * 			return new Hover('I am a hover!');
	 * 		}
	 * });
	 * ```
3356 3357 3358
	 *
	 * Registration is done using a [document selector](#DocumentSelector) which is either a language id, like `javascript` or
	 * a more complex [filter](#DocumentFilter) like `{ language: 'typescript', scheme: 'file' }`. Matching a document against such
S
Steven Clarke 已提交
3359
	 * a selector will result in a [score](#languages.match) that is used to determine if and how a provider shall be used. When
3360 3361 3362
	 * scores are equal the provider that came last wins. For features that allow full arity, like [hover](#languages.registerHoverProvider),
	 * the score is only checked to be `>0`, for other features, like [IntelliSense](#languages.registerCompletionItemProvider) the
	 * score is used for determining the order in which providers are asked to participate.
J
Johannes Rieken 已提交
3363
	 */
E
Erich Gamma 已提交
3364 3365 3366 3367 3368 3369 3370 3371 3372
	export namespace languages {

		/**
		 * Return the identifiers of all known languages.
		 * @return Promise resolving to an array of identifier strings.
		 */
		export function getLanguages(): Thenable<string[]>;

		/**
J
Johannes Rieken 已提交
3373
		 * Compute the match between a document [selector](#DocumentSelector) and a document. Values
S
Steven Clarke 已提交
3374
		 * greater than zero mean the selector matches the document. The more individual matches a selector
3375 3376 3377
		 * and a document have, the higher the score is. These are the abstract rules given a `selector`:
		 *
		 * ```
S
Steven Clarke 已提交
3378
		 * (1) When selector is an array, return the maximum individual result.
3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390
		 * (2) When selector is a string match that against the [languageId](#TextDocument.languageId).
		 * 	(2.1) When both are equal score is `10`,
		 * 	(2.2) When the selector is `*` score is `5`,
		 * 	(2.3) Else score is `0`.
		 * (3) When selector is a [filter](#DocumentFilter) every property must score higher `0`. Iff the score is the sum of the following:
		 *	(3.1) When [language](#DocumentFilter.language) is set apply rules from #2, when `0` the total score is `0`.
		 *	(3.2) When [scheme](#Document.scheme) is set and equals the [uri](#TextDocument.uri)-scheme add `10` to the score, else the total score is `0`.
		 *	(3.3) When [pattern](#Document.pattern) is set
		 * 		(3.3.1) pattern eqauls the [uri](#TextDocument.uri)-fsPath add `10` to the score,
		 *		(3.3.1) if the pattern matches as glob-pattern add `5` to the score,
		 *		(3.3.1) the total score is `0`
		 * ```
J
Johannes Rieken 已提交
3391 3392 3393
		 *
		 * @param selector A document selector.
		 * @param document A text document.
J
Johannes Rieken 已提交
3394
		 * @return A number `>0` when the selector matches and `0` when the selector does not match.
E
Erich Gamma 已提交
3395 3396 3397 3398
		 */
		export function match(selector: DocumentSelector, document: TextDocument): number;

		/**
S
Steven Clarke 已提交
3399
		 * Create a diagnostics collection.
J
Johannes Rieken 已提交
3400 3401 3402
		 *
		 * @param name The [name](#DiagnosticCollection.name) of the collection.
		 * @return A new diagnostic collection.
E
Erich Gamma 已提交
3403 3404 3405 3406
		 */
		export function createDiagnosticCollection(name?: string): DiagnosticCollection;

		/**
J
Johannes Rieken 已提交
3407 3408 3409
		 * Register a completion provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
3410
		 * by their [score](#languages.match) and groups of equal score are sequentially asked for
J
Johannes Rieken 已提交
3411
		 * completion items. The process stops when one or many providers of a group return a
3412 3413
		 * result. A failing provider (rejected promise or exception) will not fail the whole
		 * operation.
E
Erich Gamma 已提交
3414
		 *
J
Johannes Rieken 已提交
3415 3416 3417 3418 3419 3420 3421 3422
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A completion provider.
		 * @param triggerCharacters Trigger completion when the user types one of the characters, like `.` or `:`.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerCompletionItemProvider(selector: DocumentSelector, provider: CompletionItemProvider, ...triggerCharacters: string[]): Disposable;

		/**
J
Johannes Rieken 已提交
3423 3424 3425
		 * Register a code action provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
3426 3427
		 * parallel and the results are merged. A failing provider (rejected promise or exception) will
		 * not cause a failure of the whole operation.
J
Johannes Rieken 已提交
3428 3429
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
J
Johannes Rieken 已提交
3430
		 * @param provider A code action provider.
J
Johannes Rieken 已提交
3431
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
3432
		 */
J
Johannes Rieken 已提交
3433
		export function registerCodeActionsProvider(selector: DocumentSelector, provider: CodeActionProvider): Disposable;
E
Erich Gamma 已提交
3434 3435

		/**
J
Johannes Rieken 已提交
3436 3437 3438
		 * Register a code lens provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
3439 3440
		 * parallel and the results are merged. A failing provider (rejected promise or exception) will
		 * not cause a failure of the whole operation.
E
Erich Gamma 已提交
3441
		 *
J
Johannes Rieken 已提交
3442 3443 3444
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A code lens provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
3445
		 */
J
Johannes Rieken 已提交
3446
		export function registerCodeLensProvider(selector: DocumentSelector, provider: CodeLensProvider): Disposable;
E
Erich Gamma 已提交
3447 3448

		/**
J
Johannes Rieken 已提交
3449 3450 3451
		 * Register a definition provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
3452 3453
		 * parallel and the results are merged. A failing provider (rejected promise or exception) will
		 * not cause a failure of the whole operation.
E
Erich Gamma 已提交
3454
		 *
J
Johannes Rieken 已提交
3455 3456 3457
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A definition provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
3458 3459 3460 3461
		 */
		export function registerDefinitionProvider(selector: DocumentSelector, provider: DefinitionProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3462 3463 3464
		 * Register a hover provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
3465 3466
		 * parallel and the results are merged. A failing provider (rejected promise or exception) will
		 * not cause a failure of the whole operation.
E
Erich Gamma 已提交
3467
		 *
J
Johannes Rieken 已提交
3468 3469 3470
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A hover provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
3471 3472 3473 3474
		 */
		export function registerHoverProvider(selector: DocumentSelector, provider: HoverProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3475 3476 3477 3478
		 * Register a document highlight provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
		 * by their [score](#languages.match) and groups sequentially asked for document highlights.
3479
		 * The process stops when a provider returns a `non-falsy` or `non-failure` result.
E
Erich Gamma 已提交
3480
		 *
J
Johannes Rieken 已提交
3481 3482 3483
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A document highlight provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
3484 3485 3486 3487
		 */
		export function registerDocumentHighlightProvider(selector: DocumentSelector, provider: DocumentHighlightProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3488 3489 3490
		 * Register a document symbol provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
3491 3492
		 * parallel and the results are merged. A failing provider (rejected promise or exception) will
		 * not cause a failure of the whole operation.
E
Erich Gamma 已提交
3493
		 *
J
Johannes Rieken 已提交
3494 3495 3496
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A document symbol provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
3497 3498 3499 3500
		 */
		export function registerDocumentSymbolProvider(selector: DocumentSelector, provider: DocumentSymbolProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3501 3502 3503
		 * Register a workspace symbol provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
3504 3505
		 * parallel and the results are merged. A failing provider (rejected promise or exception) will
		 * not cause a failure of the whole operation.
E
Erich Gamma 已提交
3506
		 *
J
Johannes Rieken 已提交
3507 3508
		 * @param provider A workspace symbol provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
3509 3510 3511 3512
		 */
		export function registerWorkspaceSymbolProvider(provider: WorkspaceSymbolProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3513 3514 3515
		 * Register a reference provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
3516 3517
		 * parallel and the results are merged. A failing provider (rejected promise or exception) will
		 * not cause a failure of the whole operation.
E
Erich Gamma 已提交
3518
		 *
J
Johannes Rieken 已提交
3519 3520 3521
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A reference provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
3522 3523 3524 3525
		 */
		export function registerReferenceProvider(selector: DocumentSelector, provider: ReferenceProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3526 3527 3528
		 * Register a reference provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
3529
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
3530
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
3531
		 *
J
Johannes Rieken 已提交
3532 3533 3534
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A rename provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
3535 3536 3537 3538
		 */
		export function registerRenameProvider(selector: DocumentSelector, provider: RenameProvider): Disposable;

		/**
A
Andre Weinand 已提交
3539
		 * Register a formatting provider for a document.
J
Johannes Rieken 已提交
3540 3541
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
3542
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
3543
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
3544
		 *
J
Johannes Rieken 已提交
3545 3546 3547
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A document formatting edit provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
3548 3549 3550 3551
		 */
		export function registerDocumentFormattingEditProvider(selector: DocumentSelector, provider: DocumentFormattingEditProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3552 3553 3554
		 * Register a formatting provider for a document range.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
3555
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
3556
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
3557
		 *
J
Johannes Rieken 已提交
3558 3559 3560
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A document range formatting edit provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
3561 3562 3563 3564
		 */
		export function registerDocumentRangeFormattingEditProvider(selector: DocumentSelector, provider: DocumentRangeFormattingEditProvider): Disposable;

		/**
E
Erich Gamma 已提交
3565
		 * Register a formatting provider that works on type. The provider is active when the user enables the setting `editor.formatOnType`.
J
Johannes Rieken 已提交
3566 3567
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
3568
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
3569
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
3570
		 *
J
Johannes Rieken 已提交
3571 3572 3573
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider An on type formatting edit provider.
		 * @param firstTriggerCharacter A character on which formatting should be triggered, like `}`.
J
Johannes Rieken 已提交
3574
		 * @param moreTriggerCharacter More trigger characters.
J
Johannes Rieken 已提交
3575
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
3576 3577 3578 3579
		 */
		export function registerOnTypeFormattingEditProvider(selector: DocumentSelector, provider: OnTypeFormattingEditProvider, firstTriggerCharacter: string, ...moreTriggerCharacter: string[]): Disposable;

		/**
J
Johannes Rieken 已提交
3580 3581 3582
		 * Register a signature help provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
3583
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
3584
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
3585
		 *
J
Johannes Rieken 已提交
3586 3587 3588 3589
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A signature help provider.
		 * @param triggerCharacters Trigger signature help when the user types one of the characters, like `,` or `(`.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
3590 3591 3592 3593
		 */
		export function registerSignatureHelpProvider(selector: DocumentSelector, provider: SignatureHelpProvider, ...triggerCharacters: string[]): Disposable;

		/**
J
Johannes Rieken 已提交
3594
		 * Set a [language configuration](#LanguageConfiguration) for a language.
E
Erich Gamma 已提交
3595
		 *
A
Andre Weinand 已提交
3596
		 * @param language A language identifier like `typescript`.
J
Johannes Rieken 已提交
3597 3598
		 * @param configuration Language configuration.
		 * @return A [disposable](#Disposable) that unsets this configuration.
E
Erich Gamma 已提交
3599 3600 3601 3602
		 */
		export function setLanguageConfiguration(language: string, configuration: LanguageConfiguration): Disposable;
	}

J
Johannes Rieken 已提交
3603
	/**
3604 3605 3606
	 * Namespace for dealing with installed extensions. Extensions are represented
	 * by an [extension](#Extension)-interface which allows to reflect on them.
	 *
S
Steven Clarke 已提交
3607
	 * Extension writers can provide APIs to other extensions by returning their API public
3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633
	 * surface from the `activate`-call.
	 *
	 * ```javascript
	 * export function activate(context: vscode.ExtensionContext) {
	 * 		let api = {
	 * 			sum(a, b) {
	 * 				return a + b;
	 * 			},
	 * 			mul(a, b) {
	 * 				return a * b;
	 * 			}
	 * 		};
	 * 		// 'export' public api-surface
	 *		return api;
	 * }
	 * ```
	 * When depending on the API of another extension add an `extensionDependency`-entry
	 * to `package.json`, and use the [getExtension](#extensions.getExtension)-function
	 * and the [exports](#Extension.exports)-property, like below:
	 *
	 * ```javascript
	 * let mathExt = extensions.getExtension('genius.math');
	 * let importedApi = mathExt.exports;
	 *
	 * console.log(importedApi.mul(42, 1));
	 * ```
J
Johannes Rieken 已提交
3634
	 */
E
Erich Gamma 已提交
3635 3636
	export namespace extensions {

J
Johannes Rieken 已提交
3637
		/**
3638
		 * Get an extension by its full identifier in the form of: `publisher.name`.
J
Johannes Rieken 已提交
3639
		 *
J
Johannes Rieken 已提交
3640
		 * @param extensionId An extension identifier.
J
Johannes Rieken 已提交
3641 3642
		 * @return An extension or `undefined`.
		 */
E
Erich Gamma 已提交
3643 3644
		export function getExtension(extensionId: string): Extension<any>;

J
Johannes Rieken 已提交
3645
		/**
A
Andre Weinand 已提交
3646
		 * Get an extension its full identifier in the form of: `publisher.name`.
J
Johannes Rieken 已提交
3647 3648 3649
		 *
		 * @param extensionId An extension identifier.
		 * @return An extension or `undefined`.
J
Johannes Rieken 已提交
3650
		 */
E
Erich Gamma 已提交
3651 3652 3653 3654 3655 3656 3657 3658 3659
		export function getExtension<T>(extensionId: string): Extension<T>;

		/**
		 * All extensions currently known to the system.
		 */
		export let all: Extension<any>[];
	}
}

3660 3661
// TS 1.6 & node_module
// export = vscode;
J
Johannes Rieken 已提交
3662 3663

// when used for JS*
B
Benjamin Pasero 已提交
3664
// !!! DO NOT MODIFY ABOVE COMMENT ("when used for JS*") IT IS BEING USED TO DETECT JS* ONLY CHANGES !!!
J
Johannes Rieken 已提交
3665 3666 3667
declare module 'vscode' {
	export = vscode;
}
J
Johannes Rieken 已提交
3668

E
Erich Gamma 已提交
3669 3670 3671 3672
/**
 * Thenable is a common denominator between ES6 promises, Q, jquery.Deferred, WinJS.Promise,
 * and others. This API makes no assumption about what promise libary is being used which
 * enables reusing existing code without migrating to a specific promise implementation. Still,
A
Andre Weinand 已提交
3673
 * we recommend the use of native promises which are available in VS Code.
E
Erich Gamma 已提交
3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688
 */
interface Thenable<R> {
	/**
	* Attaches callbacks for the resolution and/or rejection of the Promise.
	* @param onfulfilled The callback to execute when the Promise is resolved.
	* @param onrejected The callback to execute when the Promise is rejected.
	* @returns A Promise for the completion of which ever callback is executed.
	*/
	then<TResult>(onfulfilled?: (value: R) => TResult | Thenable<TResult>, onrejected?: (reason: any) => TResult | Thenable<TResult>): Thenable<TResult>;
	then<TResult>(onfulfilled?: (value: R) => TResult | Thenable<TResult>, onrejected?: (reason: any) => void): Thenable<TResult>;
}

// ---- ES6 promise ------------------------------------------------------

/**
A
Andre Weinand 已提交
3689
 * Represents the completion of an asynchronous operation.
E
Erich Gamma 已提交
3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719
 */
interface Promise<T> extends Thenable<T> {
	/**
	* Attaches callbacks for the resolution and/or rejection of the Promise.
	* @param onfulfilled The callback to execute when the Promise is resolved.
	* @param onrejected The callback to execute when the Promise is rejected.
	* @returns A Promise for the completion of which ever callback is executed.
	*/
	then<TResult>(onfulfilled?: (value: T) => TResult | Thenable<TResult>, onrejected?: (reason: any) => TResult | Thenable<TResult>): Promise<TResult>;
	then<TResult>(onfulfilled?: (value: T) => TResult | Thenable<TResult>, onrejected?: (reason: any) => void): Promise<TResult>;

	/**
	 * Attaches a callback for only the rejection of the Promise.
	 * @param onrejected The callback to execute when the Promise is rejected.
	 * @returns A Promise for the completion of the callback.
	 */
	catch(onrejected?: (reason: any) => T | Thenable<T>): Promise<T>;

	// [Symbol.toStringTag]: string;
}

interface PromiseConstructor {
	// /**
	//   * A reference to the prototype.
	//   */
	// prototype: Promise<any>;

	/**
	 * Creates a new Promise.
	 * @param executor A callback used to initialize the promise. This callback is passed two arguments:
A
Andre Weinand 已提交
3720
	 * a resolve callback used to resolve the promise with a value or the result of another promise,
E
Erich Gamma 已提交
3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755
	 * and a reject callback used to reject the promise with a provided reason or error.
	 */
	new <T>(executor: (resolve: (value?: T | Thenable<T>) => void, reject: (reason?: any) => void) => void): Promise<T>;

	/**
	 * Creates a Promise that is resolved with an array of results when all of the provided Promises
	 * resolve, or rejected when any Promise is rejected.
	 * @param values An array of Promises.
	 * @returns A new Promise.
	 */
	all<T>(values: Array<T | Thenable<T>>): Promise<T[]>;

	/**
	 * Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
	 * or rejected.
	 * @param values An array of Promises.
	 * @returns A new Promise.
	 */
	race<T>(values: Array<T | Thenable<T>>): Promise<T>;

	/**
	 * Creates a new rejected promise for the provided reason.
	 * @param reason The reason the promise was rejected.
	 * @returns A new rejected Promise.
	 */
	reject(reason: any): Promise<void>;

	/**
	 * Creates a new rejected promise for the provided reason.
	 * @param reason The reason the promise was rejected.
	 * @returns A new rejected Promise.
	 */
	reject<T>(reason: any): Promise<T>;

	/**
A
Alex Dima 已提交
3756 3757 3758 3759
	 * Creates a new resolved promise for the provided value.
	 * @param value A promise.
	 * @returns A promise whose internal state matches the provided promise.
	 */
E
Erich Gamma 已提交
3760 3761 3762
	resolve<T>(value: T | Thenable<T>): Promise<T>;

	/**
A
Andre Weinand 已提交
3763
	 * Creates a new resolved promise.
E
Erich Gamma 已提交
3764 3765 3766 3767 3768 3769 3770 3771
	 * @returns A resolved promise.
	 */
	resolve(): Promise<void>;

	// [Symbol.species]: Function;
}

declare var Promise: PromiseConstructor;