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

6
declare module 'vscode' {
E
Erich Gamma 已提交
7 8

	/**
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
		 */
		command: string;

31 32 33 34 35
		/**
		 * A tooltip for for command, when represented in the UI.
		 */
		tooltip?: string;

E
Erich Gamma 已提交
36
		/**
A
Andre Weinand 已提交
37
		 * Arguments that the command handler should be
A
Alex Dima 已提交
38
		 * invoked with.
E
Erich Gamma 已提交
39 40 41 42 43
		 */
		arguments?: any[];
	}

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

		/**
A
Alex Dima 已提交
52
		 * The zero-based line number.
E
Erich Gamma 已提交
53
		 */
Y
Yuki Ueda 已提交
54
		readonly lineNumber: number;
E
Erich Gamma 已提交
55 56

		/**
J
Johannes Rieken 已提交
57
		 * The text of this line without the line separator characters.
E
Erich Gamma 已提交
58
		 */
Y
Yuki Ueda 已提交
59
		readonly text: string;
E
Erich Gamma 已提交
60 61

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

		/**
J
Johannes Rieken 已提交
67
		 * The range this line covers with the line separator characters.
E
Erich Gamma 已提交
68
		 */
Y
Yuki Ueda 已提交
69
		readonly rangeIncludingLineBreak: Range;
E
Erich Gamma 已提交
70 71

		/**
J
Johannes Rieken 已提交
72
		 * The offset of the first character which is not a whitespace character as defined
73
		 * by `/\s/`. **Note** that if a line is all whitespaces the length of the line is returned.
E
Erich Gamma 已提交
74
		 */
Y
Yuki Ueda 已提交
75
		readonly firstNonWhitespaceCharacterIndex: number;
E
Erich Gamma 已提交
76 77 78

		/**
		 * Whether this line is whitespace only, shorthand
79
		 * for [TextLine.firstNonWhitespaceCharacterIndex](#TextLine.firstNonWhitespaceCharacterIndex) === [TextLine.text.length](#TextLine.text).
E
Erich Gamma 已提交
80
		 */
Y
Yuki Ueda 已提交
81
		readonly isEmptyOrWhitespace: boolean;
E
Erich Gamma 已提交
82 83 84 85 86 87 88 89 90
	}

	/**
	 * 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 已提交
91 92 93
		 * 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 已提交
94
		 */
Y
Yuki Ueda 已提交
95
		readonly uri: Uri;
E
Erich Gamma 已提交
96 97

		/**
J
Johannes Rieken 已提交
98
		 * The file system path of the associated resource. Shorthand
99
		 * notation for [TextDocument.uri.fsPath](#TextDocument.uri). Independent of the uri scheme.
E
Erich Gamma 已提交
100
		 */
Y
Yuki Ueda 已提交
101
		readonly fileName: string;
E
Erich Gamma 已提交
102 103 104 105

		/**
		 * Is this document representing an untitled file.
		 */
Y
Yuki Ueda 已提交
106
		readonly isUntitled: boolean;
E
Erich Gamma 已提交
107 108

		/**
J
Johannes Rieken 已提交
109
		 * The identifier of the language associated with this document.
E
Erich Gamma 已提交
110
		 */
Y
Yuki Ueda 已提交
111
		readonly languageId: string;
E
Erich Gamma 已提交
112 113 114 115 116

		/**
		 * The version number of this document (it will strictly increase after each
		 * change, including undo/redo).
		 */
Y
Yuki Ueda 已提交
117
		readonly version: number;
E
Erich Gamma 已提交
118 119

		/**
120
		 * `true` if there are unpersisted changes.
E
Erich Gamma 已提交
121
		 */
Y
Yuki Ueda 已提交
122
		readonly isDirty: boolean;
E
Erich Gamma 已提交
123

124 125 126 127 128 129
		/**
		 * `true` if the document have been closed. A closed document isn't synchronized anymore
		 * and won't be re-used when the same resource is opened again.
		 */
		readonly isClosed: boolean;

E
Erich Gamma 已提交
130 131 132 133
		/**
		 * Save the underlying file.
		 *
		 * @return A promise that will resolve to true when the file
134 135
		 * has been saved. If the file was not dirty or the save failed,
		 * will return false.
E
Erich Gamma 已提交
136 137 138
		 */
		save(): Thenable<boolean>;

J
Johannes Rieken 已提交
139 140 141 142 143 144
		/**
		 * The [end of line](#EndOfLine) sequence that is predominately
		 * used in this document.
		 */
		readonly eol: EndOfLine;

E
Erich Gamma 已提交
145 146 147
		/**
		 * The number of lines in this document.
		 */
Y
Yuki Ueda 已提交
148
		readonly lineCount: number;
E
Erich Gamma 已提交
149 150 151 152 153 154

		/**
		 * 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 已提交
155 156
		 * @param line A line number in [0, lineCount).
		 * @return A [line](#TextLine).
E
Erich Gamma 已提交
157 158 159 160 161 162 163 164
		 */
		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 已提交
165 166
		 * The position will be [adjusted](#TextDocument.validatePosition).
		 *
J
Johannes Rieken 已提交
167
		 * @see [TextDocument.lineAt](#TextDocument.lineAt)
A
Alex Dima 已提交
168 169
		 * @param position A position.
		 * @return A [line](#TextLine).
E
Erich Gamma 已提交
170 171 172 173 174
		 */
		lineAt(position: Position): TextLine;

		/**
		 * Converts the position to a zero-based offset.
A
Alex Dima 已提交
175 176 177 178 179
		 *
		 * The position will be [adjusted](#TextDocument.validatePosition).
		 *
		 * @param position A position.
		 * @return A valid zero-based offset.
E
Erich Gamma 已提交
180 181 182 183 184
		 */
		offsetAt(position: Position): number;

		/**
		 * Converts a zero-based offset to a position.
A
Alex Dima 已提交
185 186 187
		 *
		 * @param offset A zero-based offset.
		 * @return A valid [position](#Position).
E
Erich Gamma 已提交
188 189 190 191
		 */
		positionAt(offset: number): Position;

		/**
J
Johannes Rieken 已提交
192 193 194 195
		 * 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 已提交
196
		 * @return The text inside the provided range or the entire text.
E
Erich Gamma 已提交
197 198 199 200
		 */
		getText(range?: Range): string;

		/**
J
Johannes Rieken 已提交
201 202
		 * Get a word-range at the given position. By default words are defined by
		 * common separators, like space, -, _, etc. In addition, per languge custom
203 204
		 * [word definitions](#LanguageConfiguration.wordPattern) can be defined. It
		 * is also possible to provide a custom regular expression.
J
Johannes Rieken 已提交
205
		 *
A
Alex Dima 已提交
206 207
		 * The position will be [adjusted](#TextDocument.validatePosition).
		 *
J
Johannes Rieken 已提交
208
		 * @param position A position.
209
		 * @param regex Optional regular expression that describes what a word is.
J
Johannes Rieken 已提交
210
		 * @return A range spanning a word, or `undefined`.
E
Erich Gamma 已提交
211
		 */
212
		getWordRangeAtPosition(position: Position, regex?: RegExp): Range | undefined;
E
Erich Gamma 已提交
213 214

		/**
J
Johannes Rieken 已提交
215 216 217 218
		 * 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 已提交
219 220 221 222
		 */
		validateRange(range: Range): Range;

		/**
A
Andre Weinand 已提交
223
		 * Ensure a position is contained in the range of this document.
J
Johannes Rieken 已提交
224 225 226
		 *
		 * @param position A position.
		 * @return The given position or a new, adjusted position.
E
Erich Gamma 已提交
227 228 229 230 231 232
		 */
		validatePosition(position: Position): Position;
	}

	/**
	 * Represents a line and character position, such as
A
Alex Dima 已提交
233
	 * the position of the cursor.
E
Erich Gamma 已提交
234 235 236 237 238 239 240 241 242 243
	 *
	 * 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.
		 */
Y
Yuki Ueda 已提交
244
		readonly line: number;
E
Erich Gamma 已提交
245 246 247 248

		/**
		 * The zero-based character value.
		 */
Y
Yuki Ueda 已提交
249
		readonly character: number;
E
Erich Gamma 已提交
250 251

		/**
A
Alex Dima 已提交
252 253
		 * @param line A zero-based line value.
		 * @param character A zero-based character value.
E
Erich Gamma 已提交
254 255 256 257
		 */
		constructor(line: number, character: number);

		/**
A
Alex Dima 已提交
258 259 260
		 * Check if `other` is before this position.
		 *
		 * @param other A position.
E
Erich Gamma 已提交
261
		 * @return `true` if position is on a smaller line
A
Alex Dima 已提交
262
		 * or on the same line on a smaller character.
E
Erich Gamma 已提交
263 264 265 266
		 */
		isBefore(other: Position): boolean;

		/**
A
Alex Dima 已提交
267 268 269 270 271
		 * 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 已提交
272 273 274 275
		 */
		isBeforeOrEqual(other: Position): boolean;

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

		/**
A
Alex Dima 已提交
285 286 287 288 289
		 * 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 已提交
290 291 292 293
		 */
		isAfterOrEqual(other: Position): boolean;

		/**
A
Alex Dima 已提交
294 295 296
		 * Check if `other` equals this position.
		 *
		 * @param other A position.
E
Erich Gamma 已提交
297 298 299 300 301 302
		 * @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 已提交
303 304 305 306 307
		 * 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 已提交
308 309 310 311 312
		 * this and the given position are equal.
		 */
		compareTo(other: Position): number;

		/**
A
Alex Dima 已提交
313
		 * Create a new position relative to this position.
E
Erich Gamma 已提交
314 315 316 317 318 319 320 321
		 *
		 * @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;

322 323 324 325 326 327 328 329 330
		/**
		 * Derived a new position relative to this position.
		 *
		 * @param change An object that describes a delta to this position.
		 * @return A position that reflects the given delta. Will return `this` position if the change
		 * is not changing anything.
		 */
		translate(change: { lineDelta?: number; characterDelta?: number; }): Position;

E
Erich Gamma 已提交
331
		/**
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
		 */
		with(line?: number, character?: number): Position;
339 340 341 342 343 344 345 346 347

		/**
		 * Derived a new position from this position.
		 *
		 * @param change An object that describes a change to this position.
		 * @return A position that reflects the given change. Will return `this` position if the change
		 * is not changing anything.
		 */
		with(change: { line?: number; character?: number; }): Position;
E
Erich Gamma 已提交
348 349 350 351
	}

	/**
	 * A range represents an ordered pair of two positions.
A
Alex Dima 已提交
352
	 * It is guaranteed that [start](#Range.start).isBeforeOrEqual([end](#Range.end))
E
Erich Gamma 已提交
353 354 355 356 357 358 359 360
	 *
	 * 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 已提交
361
		 * The start position. It is before or equal to [end](#Range.end).
E
Erich Gamma 已提交
362
		 */
Y
Yuki Ueda 已提交
363
		readonly start: Position;
E
Erich Gamma 已提交
364 365

		/**
A
Andre Weinand 已提交
366
		 * The end position. It is after or equal to [start](#Range.start).
E
Erich Gamma 已提交
367
		 */
Y
Yuki Ueda 已提交
368
		readonly end: Position;
E
Erich Gamma 已提交
369 370

		/**
S
Steven Clarke 已提交
371
		 * Create a new range from two positions. If `start` is not
A
Alex Dima 已提交
372
		 * before or equal to `end`, the values will be swapped.
E
Erich Gamma 已提交
373
		 *
J
Johannes Rieken 已提交
374 375
		 * @param start A position.
		 * @param end A position.
E
Erich Gamma 已提交
376 377 378 379
		 */
		constructor(start: Position, end: Position);

		/**
A
Alex Dima 已提交
380 381
		 * 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 已提交
382
		 *
A
Alex Dima 已提交
383 384 385 386
		 * @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 已提交
387
		 */
J
Johannes Rieken 已提交
388
		constructor(startLine: number, startCharacter: number, endLine: number, endCharacter: number);
E
Erich Gamma 已提交
389 390

		/**
G
Gama11 已提交
391
		 * `true` if `start` and `end` are equal.
E
Erich Gamma 已提交
392 393 394 395
		 */
		isEmpty: boolean;

		/**
G
Gama11 已提交
396
		 * `true` if `start.line` and `end.line` are equal.
E
Erich Gamma 已提交
397 398 399 400
		 */
		isSingleLine: boolean;

		/**
A
Alex Dima 已提交
401 402 403
		 * Check if a position or a range is contained in this range.
		 *
		 * @param positionOrRange A position or a range.
G
Gama11 已提交
404
		 * @return `true` if the position or range is inside or equal
E
Erich Gamma 已提交
405 406 407 408 409
		 * to this range.
		 */
		contains(positionOrRange: Position | Range): boolean;

		/**
A
Alex Dima 已提交
410 411 412
		 * Check if `other` equals this range.
		 *
		 * @param other A range.
E
Erich Gamma 已提交
413
		 * @return `true` when start and end are [equal](#Position.isEqual) to
A
Andre Weinand 已提交
414
		 * start and end of this range.
E
Erich Gamma 已提交
415 416 417 418
		 */
		isEqual(other: Range): boolean;

		/**
A
Alex Dima 已提交
419 420 421 422
		 * 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 已提交
423 424 425
		 * @return A range of the greater start and smaller end positions. Will
		 * return undefined when there is no overlap.
		 */
426
		intersection(range: Range): Range | undefined;
E
Erich Gamma 已提交
427 428

		/**
A
Alex Dima 已提交
429 430 431
		 * Compute the union of `other` with this range.
		 *
		 * @param other A range.
E
Erich Gamma 已提交
432 433 434 435 436
		 * @return A range of smaller start position and the greater end position.
		 */
		union(other: Range): Range;

		/**
437
		 * Derived a new range from this range.
A
Alex Dima 已提交
438
		 *
E
Erich Gamma 已提交
439 440 441
		 * @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.
442
		 * If start and end are not different `this` range will be returned.
E
Erich Gamma 已提交
443 444
		 */
		with(start?: Position, end?: Position): Range;
445 446 447 448 449 450 451 452

		/**
		 * Derived a new range from this range.
		 *
		 * @param change An object that describes a change to this range.
		 * @return A range that reflects the given change. Will return `this` range if the change
		 * is not changing anything.
		 */
J
Johannes Rieken 已提交
453
		with(change: { start?: Position, end?: Position }): Range;
E
Erich Gamma 已提交
454 455 456 457 458 459 460 461 462
	}

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

		/**
		 * The position at which the selection starts.
A
Andre Weinand 已提交
463
		 * This position might be before or after [active](#Selection.active).
E
Erich Gamma 已提交
464
		 */
A
Alex Dima 已提交
465
		anchor: Position;
E
Erich Gamma 已提交
466 467 468

		/**
		 * The position of the cursor.
A
Andre Weinand 已提交
469
		 * This position might be before or after [anchor](#Selection.anchor).
E
Erich Gamma 已提交
470
		 */
A
Alex Dima 已提交
471
		active: Position;
E
Erich Gamma 已提交
472 473 474

		/**
		 * Create a selection from two postions.
J
Johannes Rieken 已提交
475 476 477
		 *
		 * @param anchor A position.
		 * @param active A position.
E
Erich Gamma 已提交
478 479 480 481
		 */
		constructor(anchor: Position, active: Position);

		/**
A
Alex Dima 已提交
482
		 * Create a selection from four coordinates.
J
Johannes Rieken 已提交
483
		 *
A
Alex Dima 已提交
484 485 486 487
		 * @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 已提交
488
		 */
J
Johannes Rieken 已提交
489
		constructor(anchorLine: number, anchorCharacter: number, activeLine: number, activeCharacter: number);
A
Alex Dima 已提交
490

E
Erich Gamma 已提交
491
		/**
A
Andre Weinand 已提交
492
		 * A selection is reversed if [active](#Selection.active).isBefore([anchor](#Selection.anchor)).
E
Erich Gamma 已提交
493 494 495 496
		 */
		isReversed: boolean;
	}

497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
	/**
	 * Represents sources that can cause [selection change events](#window.onDidChangeTextEditorSelection).
	*/
	export enum TextEditorSelectionChangeKind {
		/**
		 * Selection changed due to typing in the editor.
		 */
		Keyboard = 1,
		/**
		 * Selection change due to clicking in the editor.
		 */
		Mouse = 2,
		/**
		 * Selection changed because a command ran.
		 */
		Command = 3
	}

A
Alex Dima 已提交
515 516 517
	/**
	 * Represents an event describing the change in a [text editor's selections](#TextEditor.selections).
	 */
J
Johannes Rieken 已提交
518
	export interface TextEditorSelectionChangeEvent {
A
Alex Dima 已提交
519 520 521
		/**
		 * The [text editor](#TextEditor) for which the selections have changed.
		 */
J
Johannes Rieken 已提交
522
		textEditor: TextEditor;
A
Alex Dima 已提交
523 524 525
		/**
		 * The new value for the [text editor's selections](#TextEditor.selections).
		 */
J
Johannes Rieken 已提交
526
		selections: Selection[];
527 528 529 530 531
		/**
		 * The [change kind](#TextEditorSelectionChangeKind) which has triggered this
		 * event. Can be `undefined`.
		 */
		kind?: TextEditorSelectionChangeKind;
J
Johannes Rieken 已提交
532 533
	}

A
Alex Dima 已提交
534 535 536
	/**
	 * Represents an event describing the change in a [text editor's options](#TextEditor.options).
	 */
J
Johannes Rieken 已提交
537
	export interface TextEditorOptionsChangeEvent {
A
Alex Dima 已提交
538 539 540
		/**
		 * The [text editor](#TextEditor) for which the options have changed.
		 */
J
Johannes Rieken 已提交
541
		textEditor: TextEditor;
A
Alex Dima 已提交
542 543 544
		/**
		 * The new value for the [text editor's options](#TextEditor.options).
		 */
J
Johannes Rieken 已提交
545 546 547
		options: TextEditorOptions;
	}

548 549 550 551 552 553 554 555 556 557 558 559 560 561
	/**
	 * 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 已提交
562 563 564 565 566
	/**
	 * Rendering style of the cursor.
	 */
	export enum TextEditorCursorStyle {
		/**
567
		 * Render the cursor as a vertical thick line.
A
Alex Dima 已提交
568 569 570
		 */
		Line = 1,
		/**
571
		 * Render the cursor as a block filled.
A
Alex Dima 已提交
572
		 */
A
Alex Dima 已提交
573 574
		Block = 2,
		/**
575
		 * Render the cursor as a thick horizontal line.
A
Alex Dima 已提交
576
		 */
577
		Underline = 3,
578
		/**
579
		 * Render the cursor as a vertical thin line.
580
		 */
581
		LineThin = 4,
582
		/**
583
		 * Render the cursor as a block outlined.
584
		 */
585
		BlockOutline = 5,
586 587 588 589
		/**
		 * Render the cursor as a thin horizontal line.
		 */
		UnderlineThin = 6
A
Alex Dima 已提交
590 591
	}

592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
	/**
	 * Rendering style of the line numbers.
	 */
	export enum TextEditorLineNumbersStyle {
		/**
		 * Do not render the line numbers.
		 */
		Off = 0,
		/**
		 * Render the line numbers.
		 */
		On = 1,
		/**
		 * Render the line numbers with values relative to the primary cursor location.
		 */
		Relative = 2
	}

E
Erich Gamma 已提交
610
	/**
A
Alex Dima 已提交
611
	 * Represents a [text editor](#TextEditor)'s [options](#TextEditor.options).
E
Erich Gamma 已提交
612 613 614 615
	 */
	export interface TextEditorOptions {

		/**
A
Alex Dima 已提交
616 617 618
		 * 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.
J
Johannes Rieken 已提交
619
		 *
620 621
		 * 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 已提交
622
		 */
623
		tabSize?: number | string;
E
Erich Gamma 已提交
624 625 626

		/**
		 * When pressing Tab insert [n](#TextEditorOptions.tabSize) spaces.
627 628
		 * 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 已提交
629
		 */
630
		insertSpaces?: boolean | string;
A
Alex Dima 已提交
631 632 633 634 635 636 637

		/**
		 * 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;
638 639 640 641 642 643

		/**
		 * Render relative line numbers w.r.t. the current line number.
		 * When getting a text editor's options, this property will always be present.
		 * When setting a text editor's options, this property is optional.
		 */
644
		lineNumbers?: TextEditorLineNumbersStyle;
E
Erich Gamma 已提交
645 646
	}

J
Johannes Rieken 已提交
647
	/**
A
Alex Dima 已提交
648 649
	 * Represents a handle to a set of decorations
	 * sharing the same [styling options](#DecorationRenderOptions) in a [text editor](#TextEditor).
J
Johannes Rieken 已提交
650 651 652 653
	 *
	 * To get an instance of a `TextEditorDecorationType` use
	 * [createTextEditorDecorationType](#window.createTextEditorDecorationType).
	 */
E
Erich Gamma 已提交
654 655 656
	export interface TextEditorDecorationType {

		/**
A
Alex Dima 已提交
657
		 * Internal representation of the handle.
E
Erich Gamma 已提交
658
		 */
Y
Yuki Ueda 已提交
659
		readonly key: string;
E
Erich Gamma 已提交
660

A
Alex Dima 已提交
661 662 663
		/**
		 * Remove this decoration type and all decorations on all text editors using it.
		 */
E
Erich Gamma 已提交
664 665 666
		dispose(): void;
	}

A
Alex Dima 已提交
667 668 669
	/**
	 * Represents different [reveal](#TextEditor.revealRange) strategies in a text editor.
	 */
E
Erich Gamma 已提交
670
	export enum TextEditorRevealType {
A
Alex Dima 已提交
671 672 673
		/**
		 * The range will be revealed with as little scrolling as possible.
		 */
674
		Default = 0,
A
Alex Dima 已提交
675 676 677
		/**
		 * The range will always be revealed in the center of the viewport.
		 */
678
		InCenter = 1,
A
Alex Dima 已提交
679 680 681 682
		/**
		 * 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.
		 */
683 684 685 686 687
		InCenterIfOutsideViewport = 2,
		/**
		 * The range will always be revealed at the top of the viewport.
		 */
		AtTop = 3
E
Erich Gamma 已提交
688 689
	}

A
Alex Dima 已提交
690
	/**
S
Sofian Hnaide 已提交
691
	 * Represents different positions for rendering a decoration in an [overview ruler](#DecorationRenderOptions.overviewRulerLane).
A
Alex Dima 已提交
692 693
	 * The overview ruler supports three lanes.
	 */
E
Erich Gamma 已提交
694 695 696 697 698 699 700
	export enum OverviewRulerLane {
		Left = 1,
		Center = 2,
		Right = 4,
		Full = 7
	}

701 702 703
	/**
	 * Represents options to configure the behavior of showing a [document](#TextDocument) in an [editor](#TextEditor).
	 */
704
	export interface TextDocumentShowOptions {
705
		/**
706 707 708
		 * An optional view column in which the [editor](#TextEditor) should be shown.
		 * The default is the [one](#ViewColumn.One), other values are adjusted to
		 * be __Min(column, columnCount + 1)__.
709
		 */
J
Johannes Rieken 已提交
710
		viewColumn?: ViewColumn;
711 712 713 714

		/**
		 * An optional flag that when `true` will stop the [editor](#TextEditor) from taking focus.
		 */
J
Johannes Rieken 已提交
715
		preserveFocus?: boolean;
716 717

		/**
J
Johannes Rieken 已提交
718 719
		 * An optional flag that controls if an [editor](#TextEditor)-tab will be replaced
		 * with the next editor or if it will be kept.
720
		 */
J
Johannes Rieken 已提交
721
		preview?: boolean;
722 723
	}

A
Alex Dima 已提交
724 725 726
	/**
	 * Represents theme specific rendering styles for a [text editor decoration](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
727 728 729 730 731 732 733 734 735
	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.
		 */
736 737 738 739 740 741
		outline?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 * Better use 'outline' for setting one or more of the individual outline properties.
		 */
E
Erich Gamma 已提交
742 743 744 745
		outlineColor?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
746
		 * Better use 'outline' for setting one or more of the individual outline properties.
E
Erich Gamma 已提交
747 748 749 750 751
		 */
		outlineStyle?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
752
		 * Better use 'outline' for setting one or more of the individual outline properties.
E
Erich Gamma 已提交
753 754 755 756 757 758
		 */
		outlineWidth?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
759 760 761 762 763 764
		border?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 * Better use 'border' for setting one or more of the individual border properties.
		 */
E
Erich Gamma 已提交
765 766 767 768
		borderColor?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
769
		 * Better use 'border' for setting one or more of the individual border properties.
E
Erich Gamma 已提交
770 771 772 773 774
		 */
		borderRadius?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
775
		 * Better use 'border' for setting one or more of the individual border properties.
E
Erich Gamma 已提交
776 777 778 779 780
		 */
		borderSpacing?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
781
		 * Better use 'border' for setting one or more of the individual border properties.
E
Erich Gamma 已提交
782 783 784 785 786
		 */
		borderStyle?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
787
		 * Better use 'border' for setting one or more of the individual border properties.
E
Erich Gamma 已提交
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
		 */
		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;

806 807 808 809 810
		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		letterSpacing?: string;

E
Erich Gamma 已提交
811
		/**
812
		 * An **absolute path** or an URI to an image to be rendered in the gutter.
E
Erich Gamma 已提交
813
		 */
814
		gutterIconPath?: string | Uri;
E
Erich Gamma 已提交
815

816 817 818 819 820 821 822
		/**
		 * Specifies the size of the gutter icon.
		 * Available values are 'auto', 'contain', 'cover' and any percentage value.
		 * For further information: https://msdn.microsoft.com/en-us/library/jj127316(v=vs.85).aspx
		 */
		gutterIconSize?: string;

E
Erich Gamma 已提交
823 824 825 826
		/**
		 * The color of the decoration in the overview ruler. Use rgba() and define transparent colors to play well with other decorations.
		 */
		overviewRulerColor?: string;
M
Martin Aeschlimann 已提交
827 828 829 830 831 832 833 834 835 836 837 838 839

		/**
		 * Defines the rendering options of the attachment that is inserted before the decorated text
		 */
		before?: ThemableDecorationAttachmentRenderOptions;

		/**
		 * Defines the rendering options of the attachment that is inserted after the decorated text
		 */
		after?: ThemableDecorationAttachmentRenderOptions;
	}

	export interface ThemableDecorationAttachmentRenderOptions {
840 841 842 843 844
		/**
		 * Defines a text content that is shown in the attachment. Either an icon or a text can be shown, but not both.
		 */
		contentText?: string;
		/**
845 846
		 * An **absolute path** or an URI to an image to be rendered in the attachment. Either an icon
		 * or a text can be shown, but not both.
847
		 */
848
		contentIconPath?: string | Uri;
849 850 851 852 853 854 855
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
		border?: string;
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
M
Martin Aeschlimann 已提交
856
		textDecoration?: string;
857 858 859
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
M
Martin Aeschlimann 已提交
860
		color?: string;
861 862 863
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
M
Martin Aeschlimann 已提交
864
		backgroundColor?: string;
865 866 867
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
M
Martin Aeschlimann 已提交
868
		margin?: string;
869 870 871
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
M
Martin Aeschlimann 已提交
872
		width?: string;
873 874 875
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
M
Martin Aeschlimann 已提交
876
		height?: string;
E
Erich Gamma 已提交
877 878
	}

A
Alex Dima 已提交
879 880 881
	/**
	 * Represents rendering styles for a [text editor decoration](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
	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 已提交
905 906 907
	/**
	 * Represents options for a specific decoration in a [decoration set](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
908 909 910
	export interface DecorationOptions {

		/**
911
		 * Range to which this decoration is applied. The range must not be empty.
E
Erich Gamma 已提交
912 913 914 915 916 917
		 */
		range: Range;

		/**
		 * A message that should be rendered when hovering over the decoration.
		 */
918
		hoverMessage?: MarkedString | MarkedString[];
M
Martin Aeschlimann 已提交
919 920 921 922 923 924 925 926 927 928 929 930

		/**
		 * Render options applied to the current decoration. For performance reasons, keep the
		 * number of decoration specific options small, and use decoration types whereever possible.
		 */
		renderOptions?: DecorationInstanceRenderOptions;
	}

	export interface ThemableDecorationInstanceRenderOptions {
		/**
		 * Defines the rendering options of the attachment that is inserted before the decorated text
		 */
931
		before?: ThemableDecorationAttachmentRenderOptions;
M
Martin Aeschlimann 已提交
932 933 934 935

		/**
		 * Defines the rendering options of the attachment that is inserted after the decorated text
		 */
936
		after?: ThemableDecorationAttachmentRenderOptions;
M
Martin Aeschlimann 已提交
937 938 939 940 941 942 943 944 945 946 947
	}

	export interface DecorationInstanceRenderOptions extends ThemableDecorationInstanceRenderOptions {
		/**
		 * Overwrite options for light themes.
		 */
		light?: ThemableDecorationInstanceRenderOptions;

		/**
		 * Overwrite options for dark themes.
		 */
J
Johannes Rieken 已提交
948
		dark?: ThemableDecorationInstanceRenderOptions;
E
Erich Gamma 已提交
949 950
	}

A
Alex Dima 已提交
951 952 953
	/**
	 * Represents an editor that is attached to a [document](#TextDocument).
	 */
E
Erich Gamma 已提交
954 955 956 957 958 959 960 961
	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 已提交
962
		 * The primary selection on this text editor. Shorthand for `TextEditor.selections[0]`.
E
Erich Gamma 已提交
963 964 965 966
		 */
		selection: Selection;

		/**
J
Johannes Rieken 已提交
967
		 * The selections in this text editor. The primary selection is always at index 0.
E
Erich Gamma 已提交
968 969 970 971 972 973 974 975
		 */
		selections: Selection[];

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

976 977 978 979
		/**
		 * 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.
		 */
980
		viewColumn?: ViewColumn;
981

E
Erich Gamma 已提交
982 983
		/**
		 * Perform an edit on the document associated with this text editor.
J
Johannes Rieken 已提交
984 985
		 *
		 * The given callback-function is invoked with an [edit-builder](#TextEditorEdit) which must
A
Andre Weinand 已提交
986
		 * be used to make edits. Note that the edit-builder is only valid while the
J
Johannes Rieken 已提交
987 988
		 * callback executes.
		 *
989 990
		 * @param callback A function which can create edits using an [edit-builder](#TextEditorEdit).
		 * @param options The undo/redo behaviour around this edit. By default, undo stops will be created before and after this edit.
A
Alex Dima 已提交
991
		 * @return A promise that resolves with a value indicating if the edits could be applied.
E
Erich Gamma 已提交
992
		 */
J
Johannes Rieken 已提交
993
		edit(callback: (editBuilder: TextEditorEdit) => void, options?: { undoStopBefore: boolean; undoStopAfter: boolean; }): Thenable<boolean>;
E
Erich Gamma 已提交
994

J
Joel Day 已提交
995
		/**
J
Johannes Rieken 已提交
996 997 998
		 * Insert a [snippet](#SnippetString) and put the editor into snippet mode. "Snippet mode"
		 * means the editor adds placeholders and additionals cursors so that the user can complete
		 * or accept the snippet.
J
Joel Day 已提交
999
		 *
1000
		 * @param snippet The snippet to insert in this edit.
J
Johannes Rieken 已提交
1001
		 * @param location Position or range at which to insert the snippet, defaults to the current editor selection or selections.
J
Joel Day 已提交
1002
		 * @param options The undo/redo behaviour around this edit. By default, undo stops will be created before and after this edit.
J
Johannes Rieken 已提交
1003 1004
		 * @return A promise that resolves with a value indicating if the snippet could be inserted. Note that the promise does not signal
		 * that the snippet is completely filled-in or accepted.
J
Joel Day 已提交
1005
		 */
J
Johannes Rieken 已提交
1006
		insertSnippet(snippet: SnippetString, location?: Position | Range | Position[] | Range[], options?: { undoStopBefore: boolean; undoStopAfter: boolean; }): Thenable<boolean>;
E
Erich Gamma 已提交
1007 1008

		/**
J
Johannes Rieken 已提交
1009 1010 1011
		 * 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 已提交
1012
		 * @see [createTextEditorDecorationType](#window.createTextEditorDecorationType).
A
Alex Dima 已提交
1013
		 *
J
Johannes Rieken 已提交
1014 1015
		 * @param decorationType A decoration type.
		 * @param rangesOrOptions Either [ranges](#Range) or more detailed [options](#DecorationOptions).
E
Erich Gamma 已提交
1016
		 */
J
Johannes Rieken 已提交
1017
		setDecorations(decorationType: TextEditorDecorationType, rangesOrOptions: Range[] | DecorationOptions[]): void;
E
Erich Gamma 已提交
1018 1019

		/**
A
Alex Dima 已提交
1020 1021 1022 1023
		 * 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 已提交
1024 1025 1026 1027
		 */
		revealRange(range: Range, revealType?: TextEditorRevealType): void;

		/**
J
Johannes Rieken 已提交
1028 1029 1030
		 * Show the text editor.
		 *
		 * @deprecated **This method is deprecated.** Use [window.showTextDocument](#window.showTextDocument)
S
Steven Clarke 已提交
1031
		 * instead. This method shows unexpected behavior and will be removed in the next major update.
E
Erich Gamma 已提交
1032
		 *
J
Johannes Rieken 已提交
1033
		 * @param column The [column](#ViewColumn) in which to show this editor.
E
Erich Gamma 已提交
1034 1035 1036 1037 1038
		 */
		show(column?: ViewColumn): void;

		/**
		 * Hide the text editor.
J
Johannes Rieken 已提交
1039 1040
		 *
		 * @deprecated **This method is deprecated.** Use the command 'workbench.action.closeActiveEditor' instead.
S
Steven Clarke 已提交
1041
		 * This method shows unexpected behavior and will be removed in the next major update.
E
Erich Gamma 已提交
1042 1043 1044 1045
		 */
		hide(): void;
	}

1046
	/**
1047
	 * Represents an end of line character sequence in a [document](#TextDocument).
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
	 */
	export enum EndOfLine {
		/**
		 * The line feed `\n` character.
		 */
		LF = 1,
		/**
		 * The carriage return line feed `\r\n` sequence.
		 */
		CRLF = 2
	}

E
Erich Gamma 已提交
1060
	/**
A
Alex Dima 已提交
1061 1062
	 * 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.)
1063
	 * they can be applied on a [document](#TextDocument) associated with a [text editor](#TextEditor).
E
Erich Gamma 已提交
1064 1065 1066 1067
	 *
	 */
	export interface TextEditorEdit {
		/**
A
Alex Dima 已提交
1068
		 * Replace a certain text region with a new value.
1069
		 * You can use \r\n or \n in `value` and they will be normalized to the current [document](#TextDocument).
A
Alex Dima 已提交
1070 1071 1072
		 *
		 * @param location The range this operation should remove.
		 * @param value The new text this operation should insert after removing `location`.
E
Erich Gamma 已提交
1073 1074 1075 1076
		 */
		replace(location: Position | Range | Selection, value: string): void;

		/**
A
Alex Dima 已提交
1077
		 * Insert text at a location.
1078
		 * You can use \r\n or \n in `value` and they will be normalized to the current [document](#TextDocument).
A
Alex Dima 已提交
1079 1080 1081 1082
		 * 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 已提交
1083 1084 1085 1086 1087
		 */
		insert(location: Position, value: string): void;

		/**
		 * Delete a certain text region.
A
Alex Dima 已提交
1088 1089
		 *
		 * @param location The range this operation should remove.
E
Erich Gamma 已提交
1090 1091
		 */
		delete(location: Range | Selection): void;
1092 1093 1094 1095

		/**
		 * Set the end of line sequence.
		 *
1096
		 * @param endOfLine The new end of line for the [document](#TextDocument).
1097
		 */
A
Format  
Alex Dima 已提交
1098
		setEndOfLine(endOfLine: EndOfLine): void;
E
Erich Gamma 已提交
1099 1100 1101
	}

	/**
S
Steven Clarke 已提交
1102
	 * A universal resource identifier representing either a file on disk
J
Johannes Rieken 已提交
1103
	 * or another resource, like untitled resources.
E
Erich Gamma 已提交
1104 1105 1106 1107
	 */
	export class Uri {

		/**
J
Johannes Rieken 已提交
1108 1109 1110 1111 1112
		 * 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 已提交
1113 1114 1115 1116
		 */
		static file(path: string): Uri;

		/**
J
Johannes Rieken 已提交
1117 1118
		 * Create an URI from a string. Will throw if the given value is not
		 * valid.
E
Erich Gamma 已提交
1119
		 *
J
Johannes Rieken 已提交
1120
		 * @param value The string value of an Uri.
J
Johannes Rieken 已提交
1121
		 * @return A new Uri instance.
E
Erich Gamma 已提交
1122 1123 1124 1125
		 */
		static parse(value: string): Uri;

		/**
J
Johannes Rieken 已提交
1126
		 * Scheme is the `http` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1127 1128
		 * The part before the first colon.
		 */
J
Johannes Rieken 已提交
1129
		readonly scheme: string;
E
Erich Gamma 已提交
1130 1131

		/**
J
Johannes Rieken 已提交
1132
		 * Authority is the `www.msft.com` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1133 1134
		 * The part between the first double slashes and the next slash.
		 */
J
Johannes Rieken 已提交
1135
		readonly authority: string;
E
Erich Gamma 已提交
1136 1137

		/**
J
Johannes Rieken 已提交
1138
		 * Path is the `/some/path` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1139
		 */
J
Johannes Rieken 已提交
1140
		readonly path: string;
E
Erich Gamma 已提交
1141 1142

		/**
J
Johannes Rieken 已提交
1143
		 * Query is the `query` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1144
		 */
J
Johannes Rieken 已提交
1145
		readonly query: string;
E
Erich Gamma 已提交
1146 1147

		/**
J
Johannes Rieken 已提交
1148
		 * Fragment is the `fragment` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1149
		 */
J
Johannes Rieken 已提交
1150
		readonly fragment: string;
E
Erich Gamma 已提交
1151 1152

		/**
1153
		 * The string representing the corresponding file system path of this Uri.
J
Johannes Rieken 已提交
1154
		 *
E
Erich Gamma 已提交
1155 1156
		 * 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
1157
		 * invalid characters and semantics. Will *not* look at the scheme of this Uri.
E
Erich Gamma 已提交
1158
		 */
J
Johannes Rieken 已提交
1159
		readonly fsPath: string;
E
Erich Gamma 已提交
1160

1161 1162 1163
		/**
		 * Derive a new Uri from this Uri.
		 *
1164 1165 1166 1167 1168 1169
		 * ```ts
		 * let file = Uri.parse('before:some/file/path');
		 * let other = file.with({ scheme: 'after' });
		 * assert.ok(other.toString() === 'after:some/file/path');
		 * ```
		 *
1170 1171
		 * @param change An object that describes a change to this Uri. To unset components use `null` or
		 *  the empty string.
1172
		 * @return A new Uri that reflects the given change. Will return `this` Uri if the change
1173 1174 1175 1176
		 *  is not changing anything.
		 */
		with(change: { scheme?: string; authority?: string; path?: string; query?: string; fragment?: string }): Uri;

E
Erich Gamma 已提交
1177
		/**
1178 1179 1180
		 * 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 已提交
1181
		 *
1182 1183 1184
		 * @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 已提交
1185
		 */
1186
		toString(skipEncoding?: boolean): string;
E
Erich Gamma 已提交
1187

J
Johannes Rieken 已提交
1188 1189 1190 1191 1192
		/**
		 * Returns a JSON representation of this Uri.
		 *
		 * @return An object.
		 */
E
Erich Gamma 已提交
1193 1194 1195 1196
		toJSON(): any;
	}

	/**
S
Steven Clarke 已提交
1197
	 * A cancellation token is passed to an asynchronous or long running
E
Erich Gamma 已提交
1198 1199
	 * operation to request cancellation, like cancelling a request
	 * for completion items because the user continued to type.
1200 1201 1202
	 *
	 * To get an instance of a `CancellationToken` use a
	 * [CancellationTokenSource](#CancellationTokenSource).
E
Erich Gamma 已提交
1203 1204 1205 1206
	 */
	export interface CancellationToken {

		/**
J
Johannes Rieken 已提交
1207
		 * Is `true` when the token has been cancelled, `false` otherwise.
E
Erich Gamma 已提交
1208 1209 1210 1211
		 */
		isCancellationRequested: boolean;

		/**
J
Johannes Rieken 已提交
1212
		 * An [event](#Event) which fires upon cancellation.
E
Erich Gamma 已提交
1213 1214 1215 1216 1217
		 */
		onCancellationRequested: Event<any>;
	}

	/**
J
Johannes Rieken 已提交
1218
	 * A cancellation source creates and controls a [cancellation token](#CancellationToken).
E
Erich Gamma 已提交
1219 1220 1221 1222
	 */
	export class CancellationTokenSource {

		/**
J
Johannes Rieken 已提交
1223
		 * The cancellation token of this source.
E
Erich Gamma 已提交
1224 1225 1226 1227 1228 1229 1230 1231 1232
		 */
		token: CancellationToken;

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

		/**
J
Johannes Rieken 已提交
1233
		 * Dispose object and free resources. Will call [cancel](#CancellationTokenSource.cancel).
E
Erich Gamma 已提交
1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248
		 */
		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 已提交
1249
		 * @param disposableLikes Objects that have at least a `dispose`-function member.
E
Erich Gamma 已提交
1250 1251 1252 1253 1254 1255 1256 1257
		 * @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 已提交
1258
		 * @param callOnDispose Function that disposes something.
E
Erich Gamma 已提交
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269
		 */
		constructor(callOnDispose: Function);

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

	/**
	 * Represents a typed event.
J
Johannes Rieken 已提交
1270 1271 1272 1273 1274
	 *
	 * 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 已提交
1275 1276 1277 1278
	 */
	export interface Event<T> {

		/**
J
Johannes Rieken 已提交
1279 1280
		 * A function that represents an event to which you subscribe by calling it with
		 * a listener function as argument.
E
Erich Gamma 已提交
1281 1282
		 *
		 * @param listener The listener function will be called when the event happens.
J
Johannes Rieken 已提交
1283
		 * @param thisArgs The `this`-argument which will be used when calling the event listener.
D
Daniel Imms 已提交
1284
		 * @param disposables An array to which a [disposable](#Disposable) will be added.
A
Andre Weinand 已提交
1285
		 * @return A disposable which unsubscribes the event listener.
E
Erich Gamma 已提交
1286 1287 1288 1289
		 */
		(listener: (e: T) => any, thisArgs?: any, disposables?: Disposable[]): Disposable;
	}

1290 1291 1292 1293 1294
	/**
	 * 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 已提交
1295
	 * inside a [TextDocumentContentProvider](#TextDocumentContentProvider) or when providing
1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
	 * 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 已提交
1319 1320
	/**
	 * A file system watcher notifies about changes to files and folders
J
Johannes Rieken 已提交
1321 1322 1323
	 * on disk.
	 *
	 * To get an instance of a `FileSystemWatcher` use
J
Johannes Rieken 已提交
1324
	 * [createFileSystemWatcher](#workspace.createFileSystemWatcher).
E
Erich Gamma 已提交
1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
	 */
	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 已提交
1344
		ignoreDeleteEvents: boolean;
E
Erich Gamma 已提交
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361

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

1362 1363 1364 1365
	/**
	 * A text document content provider allows to add readonly documents
	 * to the editor, such as source from a dll or generated html from md.
	 *
1366
	 * Content providers are [registered](#workspace.registerTextDocumentContentProvider)
1367
	 * for a [uri-scheme](#Uri.scheme). When a uri with that scheme is to
1368
	 * be [loaded](#workspace.openTextDocument) the content provider is
1369 1370
	 * asked.
	 */
J
Johannes Rieken 已提交
1371 1372
	export interface TextDocumentContentProvider {

1373 1374 1375 1376
		/**
		 * An event to signal a resource has changed.
		 */
		onDidChange?: Event<Uri>;
J
Johannes Rieken 已提交
1377

1378
		/**
1379
		 * Provide textual content for a given uri.
1380
		 *
1381
		 * The editor will use the returned string-content to create a readonly
J
Johannes Rieken 已提交
1382
		 * [document](#TextDocument). Resources allocated should be released when
1383
		 * the corresponding document has been [closed](#workspace.onDidCloseTextDocument).
1384
		 *
1385 1386 1387
		 * @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.
1388
		 */
1389
		provideTextDocumentContent(uri: Uri, token: CancellationToken): ProviderResult<string>;
J
Johannes Rieken 已提交
1390 1391
	}

E
Erich Gamma 已提交
1392 1393
	/**
	 * Represents an item that can be selected from
A
Andre Weinand 已提交
1394
	 * a list of items.
E
Erich Gamma 已提交
1395 1396 1397 1398
	 */
	export interface QuickPickItem {

		/**
J
Johannes Rieken 已提交
1399
		 * A human readable string which is rendered prominent.
E
Erich Gamma 已提交
1400 1401 1402 1403
		 */
		label: string;

		/**
J
Johannes Rieken 已提交
1404
		 * A human readable string which is rendered less prominent.
E
Erich Gamma 已提交
1405 1406
		 */
		description: string;
J
Johannes Rieken 已提交
1407 1408 1409 1410 1411

		/**
		 * A human readable string which is rendered less prominent.
		 */
		detail?: string;
E
Erich Gamma 已提交
1412 1413 1414
	}

	/**
J
Johannes Rieken 已提交
1415
	 * Options to configure the behavior of the quick pick UI.
E
Erich Gamma 已提交
1416 1417 1418
	 */
	export interface QuickPickOptions {
		/**
J
Johannes Rieken 已提交
1419 1420
		 * An optional flag to include the description when filtering the picks.
		 */
E
Erich Gamma 已提交
1421 1422
		matchOnDescription?: boolean;

J
Johannes Rieken 已提交
1423 1424 1425 1426 1427
		/**
		 * An optional flag to include the detail when filtering the picks.
		 */
		matchOnDetail?: boolean;

E
Erich Gamma 已提交
1428
		/**
S
Steven Clarke 已提交
1429
		 * An optional string to show as place holder in the input box to guide the user what to pick on.
J
Johannes Rieken 已提交
1430
		 */
E
Erich Gamma 已提交
1431
		placeHolder?: string;
1432

1433 1434 1435 1436 1437
		/**
		 * Set to `true` to keep the picker open when focus moves to another part of the editor or to another window.
		 */
		ignoreFocusOut?: boolean;

1438 1439 1440
		/**
		 * An optional function that is invoked whenever an item is selected.
		 */
1441
		onDidSelectItem?<T extends QuickPickItem>(item: T | string): any;
E
Erich Gamma 已提交
1442 1443 1444
	}

	/**
J
Johannes Rieken 已提交
1445
	 * Represents an action that is shown with an information, warning, or
A
Andre Weinand 已提交
1446
	 * error message.
E
Erich Gamma 已提交
1447
	 *
S
Sofian Hnaide 已提交
1448 1449 1450
	 * @see [showInformationMessage](#window.showInformationMessage)
	 * @see [showWarningMessage](#window.showWarningMessage)
	 * @see [showErrorMessage](#window.showErrorMessage)
E
Erich Gamma 已提交
1451 1452 1453 1454
	 */
	export interface MessageItem {

		/**
A
Andre Weinand 已提交
1455
		 * A short title like 'Retry', 'Open Log' etc.
E
Erich Gamma 已提交
1456 1457
		 */
		title: string;
1458 1459 1460 1461 1462 1463

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

J
Joao Moreno 已提交
1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480
	/**
	 * Options to configure the behavior of the message.
	 *
	 * @see [showInformationMessage](#window.showInformationMessage)
	 * @see [showWarningMessage](#window.showWarningMessage)
	 * @see [showErrorMessage](#window.showErrorMessage)
	 */
	export interface MessageOptions {

		/**
		 * Indicates that this message should be modal.
		 */
		modal?: boolean;
	}

E
Erich Gamma 已提交
1481
	/**
J
Johannes Rieken 已提交
1482
	 * Options to configure the behavior of the input box UI.
E
Erich Gamma 已提交
1483 1484
	 */
	export interface InputBoxOptions {
J
Johannes Rieken 已提交
1485

E
Erich Gamma 已提交
1486
		/**
J
Johannes Rieken 已提交
1487 1488
		 * The value to prefill in the input box.
		 */
E
Erich Gamma 已提交
1489 1490
		value?: string;

1491
		/**
1492 1493 1494 1495
		 * Selection of the prefilled [`value`](#InputBoxOptions.value). Defined as tuple of two number where the
		 * first is the inclusive start index and the second the exclusive end index. When `undefined` the whole
		 * word will be selected, when empty (start equals end) only the cursor will be set,
		 * otherwise the defined range will be selected.
1496
		 */
1497
		valueSelection?: [number, number];
1498

E
Erich Gamma 已提交
1499
		/**
J
Johannes Rieken 已提交
1500 1501
		 * The text to display underneath the input box.
		 */
E
Erich Gamma 已提交
1502 1503 1504
		prompt?: string;

		/**
J
Johannes Rieken 已提交
1505 1506
		 * An optional string to show as place holder in the input box to guide the user what to type.
		 */
E
Erich Gamma 已提交
1507 1508 1509
		placeHolder?: string;

		/**
1510
		 * Set to `true` to show a password prompt that will not show the typed value.
J
Johannes Rieken 已提交
1511
		 */
E
Erich Gamma 已提交
1512
		password?: boolean;
1513

1514 1515 1516 1517 1518
		/**
		 * Set to `true` to keep the input box open when focus moves to another part of the editor or to another window.
		 */
		ignoreFocusOut?: boolean;

1519
		/**
P
Pine 已提交
1520
		 * An optional function that will be called to validate input and to give a hint
1521 1522 1523 1524 1525 1526
		 * 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.
		 */
1527
		validateInput?(value: string): string | undefined | null;
E
Erich Gamma 已提交
1528 1529 1530 1531
	}

	/**
	 * A document filter denotes a document by different properties like
A
Alex Dima 已提交
1532
	 * the [language](#TextDocument.languageId), the [scheme](#Uri.scheme) of
A
Andre Weinand 已提交
1533
	 * its resource, or a glob-pattern that is applied to the [path](#TextDocument.fileName).
E
Erich Gamma 已提交
1534
	 *
J
Johannes Rieken 已提交
1535
	 * @sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
M
Matan Kushner 已提交
1536
	 * @sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**∕package.json' }`
E
Erich Gamma 已提交
1537 1538 1539 1540 1541 1542 1543 1544 1545
	 */
	export interface DocumentFilter {

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

		/**
J
Johannes Rieken 已提交
1546
		 * A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
E
Erich Gamma 已提交
1547 1548 1549 1550
		 */
		scheme?: string;

		/**
J
Johannes Rieken 已提交
1551
		 * A glob pattern, like `*.{ts,js}`.
E
Erich Gamma 已提交
1552 1553 1554 1555 1556 1557
		 */
		pattern?: string;
	}

	/**
	 * A language selector is the combination of one or many language identifiers
1558
	 * and [language filters](#DocumentFilter).
J
Johannes Rieken 已提交
1559 1560
	 *
	 * @sample `let sel:DocumentSelector = 'typescript'`;
1561
	 * @sample `let sel:DocumentSelector = ['typescript', { language: 'json', pattern: '**∕tsconfig.json' }]`;
E
Erich Gamma 已提交
1562 1563 1564
	 */
	export type DocumentSelector = string | DocumentFilter | (string | DocumentFilter)[];

1565 1566 1567 1568 1569 1570 1571 1572 1573 1574

	/**
	 * A provider result represents the values a provider, like the [`HoverProvider`](#HoverProvider),
	 * may return. For once this is the actual result type `T`, like `Hover`, or a thenable that resolves
	 * to that type `T`. In addition, `null` and `undefined` can be returned - either directly or from a
	 * thenable.
	 *
	 * The snippets below are all valid implementions of the [`HoverProvider`](#HoverProvider):
	 *
	 * ```ts
1575 1576 1577 1578 1579
	 * let a: HoverProvider = {
	 * 	provideHover(doc, pos, token): ProviderResult<Hover> {
	 * 		return new Hover('Hello World');
	 * 	}
	 * }
1580
	 *
1581 1582 1583 1584 1585 1586 1587
	 * let b: HoverProvider = {
	 * 	provideHover(doc, pos, token): ProviderResult<Hover> {
	 * 		return new Promise(resolve => {
	 * 			resolve(new Hover('Hello World'));
	 * 	 	});
	 * 	}
	 * }
1588
	 *
1589 1590 1591 1592 1593 1594
	 * let c: HoverProvider = {
	 * 	provideHover(doc, pos, token): ProviderResult<Hover> {
	 * 		return; // undefined
	 * 	}
	 * }
	 * ```
1595
	 */
J
Johannes Rieken 已提交
1596
	export type ProviderResult<T> = T | undefined | null | Thenable<T | undefined | null>;
1597

E
Erich Gamma 已提交
1598 1599
	/**
	 * Contains additional diagnostic information about the context in which
J
Johannes Rieken 已提交
1600
	 * a [code action](#CodeActionProvider.provideCodeActions) is run.
E
Erich Gamma 已提交
1601 1602
	 */
	export interface CodeActionContext {
J
Johannes Rieken 已提交
1603 1604 1605 1606

		/**
		 * An array of diagnostics.
		 */
Y
Yuki Ueda 已提交
1607
		readonly diagnostics: Diagnostic[];
E
Erich Gamma 已提交
1608 1609 1610
	}

	/**
J
Johannes Rieken 已提交
1611 1612 1613 1614
	 * 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 已提交
1615 1616 1617 1618 1619 1620
	 */
	export interface CodeActionProvider {

		/**
		 * Provide commands for the given document and range.
		 *
J
Johannes Rieken 已提交
1621 1622
		 * @param document The document in which the command was invoked.
		 * @param range The range for which the command was invoked.
J
Johannes Rieken 已提交
1623 1624
		 * @param context Context carrying additional information.
		 * @param token A cancellation token.
J
Johannes Rieken 已提交
1625
		 * @return An array of commands or a thenable of such. The lack of a result can be
A
Andre Weinand 已提交
1626
		 * signaled by returning `undefined`, `null`, or an empty array.
E
Erich Gamma 已提交
1627
		 */
1628
		provideCodeActions(document: TextDocument, range: Range, context: CodeActionContext, token: CancellationToken): ProviderResult<Command[]>;
E
Erich Gamma 已提交
1629 1630 1631 1632 1633
	}

	/**
	 * 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 已提交
1634 1635 1636
	 *
	 * 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 已提交
1637 1638 1639
	 *
	 * @see [CodeLensProvider.provideCodeLenses](#CodeLensProvider.provideCodeLenses)
	 * @see [CodeLensProvider.resolveCodeLens](#CodeLensProvider.resolveCodeLens)
E
Erich Gamma 已提交
1640 1641 1642 1643 1644 1645 1646 1647 1648
	 */
	export class CodeLens {

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

		/**
J
Johannes Rieken 已提交
1649
		 * The command this code lens represents.
E
Erich Gamma 已提交
1650
		 */
1651
		command?: Command;
E
Erich Gamma 已提交
1652 1653

		/**
J
Johannes Rieken 已提交
1654
		 * `true` when there is a command associated.
E
Erich Gamma 已提交
1655
		 */
Y
Yuki Ueda 已提交
1656
		readonly isResolved: boolean;
J
Johannes Rieken 已提交
1657 1658 1659 1660 1661 1662 1663 1664

		/**
		 * 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 已提交
1665 1666 1667 1668 1669 1670 1671 1672
	}

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

1673 1674 1675
		/**
		 * An optional event to signal that the code lenses from this provider have changed.
		 */
1676
		onDidChangeCodeLenses?: Event<void>;
1677

E
Erich Gamma 已提交
1678 1679
		/**
		 * Compute a list of [lenses](#CodeLens). This call should return as fast as possible and if
A
Andre Weinand 已提交
1680
		 * computing the commands is expensive implementors should only return code lens objects with the
E
Erich Gamma 已提交
1681
		 * range set and implement [resolve](#CodeLensProvider.resolveCodeLens).
J
Johannes Rieken 已提交
1682 1683 1684
		 *
		 * @param document The document in which the command was invoked.
		 * @param token A cancellation token.
A
Andre Weinand 已提交
1685 1686
		 * @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 已提交
1687
		 */
1688
		provideCodeLenses(document: TextDocument, token: CancellationToken): ProviderResult<CodeLens[]>;
E
Erich Gamma 已提交
1689 1690 1691 1692

		/**
		 * This function will be called for each visible code lens, usually when scrolling and after
		 * calls to [compute](#CodeLensProvider.provideCodeLenses)-lenses.
J
Johannes Rieken 已提交
1693
		 *
A
Andre Weinand 已提交
1694
		 * @param codeLens code lens that must be resolved.
J
Johannes Rieken 已提交
1695
		 * @param token A cancellation token.
S
Steven Clarke 已提交
1696
		 * @return The given, resolved code lens or thenable that resolves to such.
E
Erich Gamma 已提交
1697
		 */
1698
		resolveCodeLens?(codeLens: CodeLens, token: CancellationToken): ProviderResult<CodeLens>;
E
Erich Gamma 已提交
1699 1700 1701
	}

	/**
J
Johannes Rieken 已提交
1702 1703 1704
	 * 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 已提交
1705 1706 1707
	 */
	export type Definition = Location | Location[];

J
Johannes Rieken 已提交
1708 1709 1710 1711 1712
	/**
	 * 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 已提交
1713
	export interface DefinitionProvider {
J
Johannes Rieken 已提交
1714 1715 1716 1717 1718 1719 1720

		/**
		 * 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 已提交
1721
		 * @return A definition or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
1722
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
1723
		 */
1724
		provideDefinition(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Definition>;
E
Erich Gamma 已提交
1725 1726
	}

1727
	/**
1728
	 * The implemenetation provider interface defines the contract between extensions and
1729 1730
	 * the go to implementation feature.
	 */
M
Matt Bierner 已提交
1731
	export interface ImplementationProvider {
1732 1733 1734 1735 1736 1737 1738 1739 1740 1741

		/**
		 * Provide the implementations 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.
		 * @return A definition or a thenable that resolves to such. The lack of a result can be
		 * signaled by returning `undefined` or `null`.
		 */
M
Matt Bierner 已提交
1742
		provideImplementation(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Definition>;
1743 1744
	}

1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762
	/**
	 * The type definition provider defines the contract between extensions and
	 * the go to type definition feature.
	 */
	export interface TypeDefinitionProvider {

		/**
		 * Provide the type definition of the symbol at the given position and document.
		 *
		 * @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 definition or a thenable that resolves to such. The lack of a result can be
		 * signaled by returning `undefined` or `null`.
		 */
		provideTypeDefinition(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Definition>;
	}

E
Erich Gamma 已提交
1763
	/**
J
Johannes Rieken 已提交
1764 1765 1766
	 * 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 已提交
1767 1768 1769
	 */
	export type MarkedString = string | { language: string; value: string };

J
Johannes Rieken 已提交
1770 1771 1772 1773
	/**
	 * A hover represents additional information for a symbol or word. Hovers are
	 * rendered in a tooltip-like widget.
	 */
E
Erich Gamma 已提交
1774 1775
	export class Hover {

J
Johannes Rieken 已提交
1776 1777 1778
		/**
		 * The contents of this hover.
		 */
E
Erich Gamma 已提交
1779 1780
		contents: MarkedString[];

J
Johannes Rieken 已提交
1781
		/**
A
Andre Weinand 已提交
1782
		 * The range to which this hover applies. When missing, the
J
Johannes Rieken 已提交
1783
		 * editor will use the range at the current position or the
A
Andre Weinand 已提交
1784
		 * current position itself.
J
Johannes Rieken 已提交
1785
		 */
1786
		range?: Range;
E
Erich Gamma 已提交
1787

J
Johannes Rieken 已提交
1788 1789 1790 1791
		/**
		 * Creates a new hover object.
		 *
		 * @param contents The contents of the hover.
A
Andre Weinand 已提交
1792
		 * @param range The range to which the hover applies.
J
Johannes Rieken 已提交
1793
		 */
E
Erich Gamma 已提交
1794 1795 1796
		constructor(contents: MarkedString | MarkedString[], range?: Range);
	}

J
Johannes Rieken 已提交
1797 1798
	/**
	 * The hover provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
1799
	 * the [hover](https://code.visualstudio.com/docs/editor/intellisense)-feature.
J
Johannes Rieken 已提交
1800
	 */
E
Erich Gamma 已提交
1801
	export interface HoverProvider {
J
Johannes Rieken 已提交
1802 1803 1804

		/**
		 * Provide a hover for the given position and document. Multiple hovers at the same
A
Andre Weinand 已提交
1805 1806
		 * 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 已提交
1807 1808 1809 1810 1811
		 *
		 * @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 已提交
1812
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
1813
		 */
1814
		provideHover(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Hover>;
E
Erich Gamma 已提交
1815 1816
	}

J
Johannes Rieken 已提交
1817 1818 1819
	/**
	 * A document highlight kind.
	 */
E
Erich Gamma 已提交
1820
	export enum DocumentHighlightKind {
J
Johannes Rieken 已提交
1821 1822

		/**
A
Andre Weinand 已提交
1823
		 * A textual occurrence.
J
Johannes Rieken 已提交
1824
		 */
1825
		Text = 0,
J
Johannes Rieken 已提交
1826 1827 1828 1829

		/**
		 * Read-access of a symbol, like reading a variable.
		 */
1830
		Read = 1,
J
Johannes Rieken 已提交
1831 1832 1833 1834

		/**
		 * Write-access of a symbol, like writing to a variable.
		 */
1835
		Write = 2
E
Erich Gamma 已提交
1836 1837
	}

J
Johannes Rieken 已提交
1838 1839 1840 1841 1842
	/**
	 * 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 已提交
1843
	export class DocumentHighlight {
J
Johannes Rieken 已提交
1844 1845 1846 1847

		/**
		 * The range this highlight applies to.
		 */
E
Erich Gamma 已提交
1848
		range: Range;
J
Johannes Rieken 已提交
1849 1850 1851 1852

		/**
		 * The highlight kind, default is [text](#DocumentHighlightKind.Text).
		 */
1853
		kind?: DocumentHighlightKind;
J
Johannes Rieken 已提交
1854 1855 1856 1857 1858 1859 1860 1861

		/**
		 * 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 已提交
1862 1863
	}

J
Johannes Rieken 已提交
1864 1865 1866 1867
	/**
	 * The document highlight provider interface defines the contract between extensions and
	 * the word-highlight-feature.
	 */
E
Erich Gamma 已提交
1868
	export interface DocumentHighlightProvider {
J
Johannes Rieken 已提交
1869 1870

		/**
S
Steven Clarke 已提交
1871
		 * Provide a set of document highlights, like all occurrences of a variable or
J
Johannes Rieken 已提交
1872 1873 1874 1875 1876 1877
		 * 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 已提交
1878
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1879
		 */
1880
		provideDocumentHighlights(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<DocumentHighlight[]>;
E
Erich Gamma 已提交
1881 1882
	}

J
Johannes Rieken 已提交
1883 1884 1885
	/**
	 * A symbol kind.
	 */
E
Erich Gamma 已提交
1886
	export enum SymbolKind {
1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906
		File = 0,
		Module = 1,
		Namespace = 2,
		Package = 3,
		Class = 4,
		Method = 5,
		Property = 6,
		Field = 7,
		Constructor = 8,
		Enum = 9,
		Interface = 10,
		Function = 11,
		Variable = 12,
		Constant = 13,
		String = 14,
		Number = 15,
		Boolean = 16,
		Array = 17,
		Object = 18,
		Key = 19,
1907 1908 1909 1910
		Null = 20,
		EnumMember = 21,
		Struct = 22,
		Event = 23,
1911 1912
		Operator = 24,
		TypeParameter = 25
E
Erich Gamma 已提交
1913 1914
	}

J
Johannes Rieken 已提交
1915 1916 1917 1918
	/**
	 * Represents information about programming constructs like variables, classes,
	 * interfaces etc.
	 */
E
Erich Gamma 已提交
1919
	export class SymbolInformation {
J
Johannes Rieken 已提交
1920 1921 1922 1923

		/**
		 * The name of this symbol.
		 */
E
Erich Gamma 已提交
1924
		name: string;
J
Johannes Rieken 已提交
1925 1926 1927 1928

		/**
		 * The name of the symbol containing this symbol.
		 */
E
Erich Gamma 已提交
1929
		containerName: string;
J
Johannes Rieken 已提交
1930 1931 1932 1933

		/**
		 * The kind of this symbol.
		 */
E
Erich Gamma 已提交
1934
		kind: SymbolKind;
J
Johannes Rieken 已提交
1935 1936 1937 1938

		/**
		 * The location of this symbol.
		 */
E
Erich Gamma 已提交
1939
		location: Location;
J
Johannes Rieken 已提交
1940

1941 1942 1943 1944 1945 1946 1947 1948 1949 1950
		/**
		 * Creates a new symbol information object.
		 *
		 * @param name The name of the symbol.
		 * @param kind The kind of the symbol.
		 * @param containerName The name of the symbol containing the symbol.
		 * @param location The the location of the symbol.
		 */
		constructor(name: string, kind: SymbolKind, containerName: string, location: Location);

J
Johannes Rieken 已提交
1951
		/**
1952 1953
		 * @deprecated Please use the constructor taking a [location](#Location) object.
		 *
J
Johannes Rieken 已提交
1954 1955 1956 1957 1958 1959
		 * 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 已提交
1960
		 * @param containerName The name of the symbol containing the symbol.
J
Johannes Rieken 已提交
1961 1962
		 */
		constructor(name: string, kind: SymbolKind, range: Range, uri?: Uri, containerName?: string);
E
Erich Gamma 已提交
1963 1964
	}

J
Johannes Rieken 已提交
1965 1966
	/**
	 * The document symbol provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
1967
	 * the [go to symbol](https://code.visualstudio.com/docs/editor/editingevolved#_go-to-symbol)-feature.
J
Johannes Rieken 已提交
1968
	 */
E
Erich Gamma 已提交
1969
	export interface DocumentSymbolProvider {
J
Johannes Rieken 已提交
1970 1971 1972 1973 1974 1975 1976

		/**
		 * 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 已提交
1977
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1978
		 */
1979
		provideDocumentSymbols(document: TextDocument, token: CancellationToken): ProviderResult<SymbolInformation[]>;
E
Erich Gamma 已提交
1980 1981
	}

J
Johannes Rieken 已提交
1982 1983 1984 1985
	/**
	 * 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 已提交
1986
	export interface WorkspaceSymbolProvider {
J
Johannes Rieken 已提交
1987 1988 1989

		/**
		 * Project-wide search for a symbol matching the given query string. It is up to the provider
1990 1991 1992
		 * how to search given the query string, like substring, indexOf etc. To improve performance implementors can
		 * skip the [location](#SymbolInformation.location) of symbols and implement `resolveWorkspaceSymbol` to do that
		 * later.
J
Johannes Rieken 已提交
1993 1994 1995 1996
		 *
		 * @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 已提交
1997
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1998
		 */
1999
		provideWorkspaceSymbols(query: string, token: CancellationToken): ProviderResult<SymbolInformation[]>;
2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012

		/**
		 * Given a symbol fill in its [location](#SymbolInformation.location). This method is called whenever a symbol
		 * is selected in the UI. Providers can implement this method and return incomplete symbols from
		 * [`provideWorkspaceSymbols`](#WorkspaceSymbolProvider.provideWorkspaceSymbols) which often helps to improve
		 * performance.
		 *
		 * @param symbol The symbol that is to be resolved. Guaranteed to be an instance of an object returned from an
		 * earlier call to `provideWorkspaceSymbols`.
		 * @param token A cancellation token.
		 * @return The resolved symbol or a thenable that resolves to that. When no result is returned,
		 * the given `symbol` is used.
		 */
2013
		resolveWorkspaceSymbol?(symbol: SymbolInformation, token: CancellationToken): ProviderResult<SymbolInformation>;
E
Erich Gamma 已提交
2014 2015
	}

J
Johannes Rieken 已提交
2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031
	/**
	 * 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 已提交
2032
	export interface ReferenceProvider {
J
Johannes Rieken 已提交
2033 2034 2035 2036 2037 2038 2039 2040 2041

		/**
		 * 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 已提交
2042
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2043
		 */
2044
		provideReferences(document: TextDocument, position: Position, context: ReferenceContext, token: CancellationToken): ProviderResult<Location[]>;
E
Erich Gamma 已提交
2045 2046
	}

J
Johannes Rieken 已提交
2047
	/**
S
Steven Clarke 已提交
2048
	 * A text edit represents edits that should be applied
J
Johannes Rieken 已提交
2049
	 * to a document.
J
Johannes Rieken 已提交
2050
	 */
E
Erich Gamma 已提交
2051
	export class TextEdit {
J
Johannes Rieken 已提交
2052 2053 2054 2055 2056 2057 2058 2059

		/**
		 * Utility to create a replace edit.
		 *
		 * @param range A range.
		 * @param newText A string.
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
2060
		static replace(range: Range, newText: string): TextEdit;
J
Johannes Rieken 已提交
2061 2062 2063 2064

		/**
		 * Utility to create an insert edit.
		 *
S
Steven Clarke 已提交
2065
		 * @param position A position, will become an empty range.
J
Johannes Rieken 已提交
2066 2067 2068
		 * @param newText A string.
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
2069
		static insert(position: Position, newText: string): TextEdit;
J
Johannes Rieken 已提交
2070 2071 2072 2073

		/**
		 * Utility to create a delete edit.
		 *
J
Johannes Rieken 已提交
2074
		 * @param range A range.
J
Johannes Rieken 已提交
2075 2076
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
2077
		static delete(range: Range): TextEdit;
J
Johannes Rieken 已提交
2078

2079 2080 2081 2082 2083 2084 2085 2086
		/**
		 * Utility to create an eol-edit.
		 *
		 * @param eol An eol-sequence
		 * @return A new text edit object.
		 */
		static setEndOfLine(eol: EndOfLine): TextEdit;

J
Johannes Rieken 已提交
2087 2088 2089
		/**
		 * The range this edit applies to.
		 */
E
Erich Gamma 已提交
2090
		range: Range;
J
Johannes Rieken 已提交
2091 2092 2093 2094

		/**
		 * The string this edit will insert.
		 */
E
Erich Gamma 已提交
2095
		newText: string;
J
Johannes Rieken 已提交
2096

2097 2098
		/**
		 * The eol-sequence used in the document.
J
Johannes Rieken 已提交
2099 2100 2101
		 *
		 * *Note* that the eol-sequence will be applied to the
		 * whole document.
2102 2103 2104
		 */
		newEol: EndOfLine;

J
Johannes Rieken 已提交
2105 2106 2107 2108 2109 2110 2111
		/**
		 * Create a new TextEdit.
		 *
		 * @param range A range.
		 * @param newText A string.
		 */
		constructor(range: Range, newText: string);
E
Erich Gamma 已提交
2112 2113 2114
	}

	/**
J
Johannes Rieken 已提交
2115
	 * A workspace edit represents textual changes for many documents.
E
Erich Gamma 已提交
2116 2117 2118 2119 2120 2121
	 */
	export class WorkspaceEdit {

		/**
		 * The number of affected resources.
		 */
Y
Yuki Ueda 已提交
2122
		readonly size: number;
E
Erich Gamma 已提交
2123

J
Johannes Rieken 已提交
2124 2125 2126 2127 2128 2129 2130 2131
		/**
		 * 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 已提交
2132

J
Johannes Rieken 已提交
2133 2134 2135 2136 2137 2138 2139 2140
		/**
		 * 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 已提交
2141

J
Johannes Rieken 已提交
2142
		/**
S
Steven Clarke 已提交
2143
		 * Delete the text at the given range.
J
Johannes Rieken 已提交
2144 2145 2146
		 *
		 * @param uri A resource identifier.
		 * @param range A range.
J
Johannes Rieken 已提交
2147 2148
		 */
		delete(uri: Uri, range: Range): void;
E
Erich Gamma 已提交
2149

J
Johannes Rieken 已提交
2150 2151 2152
		/**
		 * Check if this edit affects the given resource.
		 * @param uri A resource identifier.
A
Andre Weinand 已提交
2153
		 * @return `true` if the given resource will be touched by this edit.
J
Johannes Rieken 已提交
2154
		 */
E
Erich Gamma 已提交
2155 2156
		has(uri: Uri): boolean;

J
Johannes Rieken 已提交
2157 2158 2159 2160 2161 2162
		/**
		 * Set (and replace) text edits for a resource.
		 *
		 * @param uri A resource identifier.
		 * @param edits An array of text edits.
		 */
E
Erich Gamma 已提交
2163 2164
		set(uri: Uri, edits: TextEdit[]): void;

J
Johannes Rieken 已提交
2165 2166 2167 2168 2169 2170
		/**
		 * Get the text edits for a resource.
		 *
		 * @param uri A resource identifier.
		 * @return An array of text edits.
		 */
E
Erich Gamma 已提交
2171 2172
		get(uri: Uri): TextEdit[];

J
Johannes Rieken 已提交
2173 2174 2175 2176 2177
		/**
		 * Get all text edits grouped by resource.
		 *
		 * @return An array of `[Uri, TextEdit[]]`-tuples.
		 */
E
Erich Gamma 已提交
2178 2179 2180
		entries(): [Uri, TextEdit[]][];
	}

2181 2182 2183 2184 2185 2186
	/**
	 * A snippet string is a template which allows to insert text
	 * and to control the editor cursor when insertion happens.
	 *
	 * A snippet can define tab stops and placeholders with `$1`, `$2`
	 * and `${3:foo}`. `$0` defines the final tab stop, it defaults to
2187 2188
	 * the end of the snippet. Variables are defined with `$name` and
	 * `${name:default value}`. The full snippet syntax is documented
G
Greg Van Liew 已提交
2189
	 * [here](http://code.visualstudio.com/docs/editor/userdefinedsnippets#_creating-your-own-snippets).
2190 2191 2192 2193 2194 2195 2196 2197
	 */
	export class SnippetString {

		/**
		 * The snippet string.
		 */
		value: string;

2198 2199 2200 2201 2202 2203 2204
		constructor(value?: string);

		/**
		 * Builder-function that appends the given string to
		 * the [`value`](#SnippetString.value) of this snippet string.
		 *
		 * @param string A value to append 'as given'. The string will be escaped.
2205
		 * @return This snippet string.
2206 2207 2208 2209 2210 2211 2212 2213 2214
		 */
		appendText(string: string): SnippetString;

		/**
		 * Builder-function that appends a tabstop (`$1`, `$2` etc) to
		 * the [`value`](#SnippetString.value) of this snippet string.
		 *
		 * @param number The number of this tabstop, defaults to an auto-incremet
		 * value starting at 1.
2215
		 * @return This snippet string.
2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226
		 */
		appendTabstop(number?: number): SnippetString;

		/**
		 * Builder-function that appends a placeholder (`${1:value}`) to
		 * the [`value`](#SnippetString.value) of this snippet string.
		 *
		 * @param value The value of this placeholder - either a string or a function
		 * with which a nested snippet can be created.
		 * @param number The number of this tabstop, defaults to an auto-incremet
		 * value starting at 1.
2227
		 * @return This snippet string.
2228 2229
		 */
		appendPlaceholder(value: string | ((snippet: SnippetString) => any), number?: number): SnippetString;
2230 2231

		/**
J
Johannes Rieken 已提交
2232
		 * Builder-function that appends a variable (`${VAR}`) to
2233 2234 2235 2236 2237 2238 2239 2240
		 * the [`value`](#SnippetString.value) of this snippet string.
		 *
		 * @param name The name of the variable - excluding the `$`.
		 * @param defaultValue The default value which is used when the variable name cannot
		 * be resolved - either a string or a function with which a nested snippet can be created.
		 * @return This snippet string.
		 */
		appendVariable(name: string, defaultValue: string | ((snippet: SnippetString) => any)): SnippetString;
2241 2242
	}

E
Erich Gamma 已提交
2243
	/**
J
Johannes Rieken 已提交
2244 2245
	 * 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 已提交
2246 2247
	 */
	export interface RenameProvider {
J
Johannes Rieken 已提交
2248 2249 2250 2251 2252 2253 2254 2255 2256 2257

		/**
		 * 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 已提交
2258
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
2259
		 */
2260
		provideRenameEdits(document: TextDocument, position: Position, newName: string, token: CancellationToken): ProviderResult<WorkspaceEdit>;
E
Erich Gamma 已提交
2261 2262
	}

J
Johannes Rieken 已提交
2263 2264 2265
	/**
	 * Value-object describing what options formatting should use.
	 */
E
Erich Gamma 已提交
2266
	export interface FormattingOptions {
J
Johannes Rieken 已提交
2267 2268 2269 2270

		/**
		 * Size of a tab in spaces.
		 */
E
Erich Gamma 已提交
2271
		tabSize: number;
J
Johannes Rieken 已提交
2272 2273 2274 2275

		/**
		 * Prefer spaces over tabs.
		 */
E
Erich Gamma 已提交
2276
		insertSpaces: boolean;
J
Johannes Rieken 已提交
2277 2278 2279 2280 2281

		/**
		 * Signature for further properties.
		 */
		[key: string]: boolean | number | string;
E
Erich Gamma 已提交
2282 2283 2284
	}

	/**
J
Johannes Rieken 已提交
2285 2286
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
2287 2288
	 */
	export interface DocumentFormattingEditProvider {
J
Johannes Rieken 已提交
2289 2290 2291 2292 2293 2294 2295 2296

		/**
		 * 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 已提交
2297
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2298
		 */
2299
		provideDocumentFormattingEdits(document: TextDocument, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
2300 2301 2302
	}

	/**
J
Johannes Rieken 已提交
2303 2304
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
2305 2306
	 */
	export interface DocumentRangeFormattingEditProvider {
J
Johannes Rieken 已提交
2307 2308 2309 2310 2311

		/**
		 * 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 已提交
2312 2313
		 * or larger range. Often this is done by adjusting the start and end
		 * of the range to full syntax nodes.
J
Johannes Rieken 已提交
2314 2315 2316 2317 2318 2319
		 *
		 * @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 已提交
2320
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2321
		 */
2322
		provideDocumentRangeFormattingEdits(document: TextDocument, range: Range, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
2323 2324 2325
	}

	/**
J
Johannes Rieken 已提交
2326 2327
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
2328 2329
	 */
	export interface OnTypeFormattingEditProvider {
J
Johannes Rieken 已提交
2330 2331 2332 2333 2334 2335 2336 2337 2338 2339

		/**
		 * 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 已提交
2340
		 * @param ch The character that has been typed.
J
Johannes Rieken 已提交
2341 2342 2343
		 * @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 已提交
2344
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2345
		 */
2346
		provideOnTypeFormattingEdits(document: TextDocument, position: Position, ch: string, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
2347 2348
	}

J
Johannes Rieken 已提交
2349 2350 2351 2352
	/**
	 * Represents a parameter of a callable-signature. A parameter can
	 * have a label and a doc-comment.
	 */
E
Erich Gamma 已提交
2353
	export class ParameterInformation {
J
Johannes Rieken 已提交
2354 2355 2356 2357 2358

		/**
		 * The label of this signature. Will be shown in
		 * the UI.
		 */
E
Erich Gamma 已提交
2359
		label: string;
J
Johannes Rieken 已提交
2360 2361 2362 2363 2364

		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
2365
		documentation?: string;
J
Johannes Rieken 已提交
2366 2367 2368 2369 2370 2371 2372

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

J
Johannes Rieken 已提交
2376 2377 2378 2379 2380
	/**
	 * 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 已提交
2381
	export class SignatureInformation {
J
Johannes Rieken 已提交
2382 2383 2384 2385 2386

		/**
		 * The label of this signature. Will be shown in
		 * the UI.
		 */
E
Erich Gamma 已提交
2387
		label: string;
J
Johannes Rieken 已提交
2388 2389 2390 2391 2392

		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
2393
		documentation?: string;
J
Johannes Rieken 已提交
2394 2395 2396 2397

		/**
		 * The parameters of this signature.
		 */
E
Erich Gamma 已提交
2398
		parameters: ParameterInformation[];
J
Johannes Rieken 已提交
2399 2400 2401 2402 2403

		/**
		 * Creates a new signature information object.
		 *
		 * @param label A label string.
J
Johannes Rieken 已提交
2404
		 * @param documentation A doc string.
J
Johannes Rieken 已提交
2405
		 */
E
Erich Gamma 已提交
2406 2407 2408
		constructor(label: string, documentation?: string);
	}

J
Johannes Rieken 已提交
2409 2410
	/**
	 * Signature help represents the signature of something
S
Steven Clarke 已提交
2411
	 * callable. There can be multiple signatures but only one
J
Johannes Rieken 已提交
2412 2413
	 * active and only one active parameter.
	 */
E
Erich Gamma 已提交
2414
	export class SignatureHelp {
J
Johannes Rieken 已提交
2415 2416 2417 2418

		/**
		 * One or more signatures.
		 */
E
Erich Gamma 已提交
2419
		signatures: SignatureInformation[];
J
Johannes Rieken 已提交
2420 2421 2422 2423

		/**
		 * The active signature.
		 */
E
Erich Gamma 已提交
2424
		activeSignature: number;
J
Johannes Rieken 已提交
2425 2426 2427 2428

		/**
		 * The active parameter of the active signature.
		 */
E
Erich Gamma 已提交
2429 2430 2431
		activeParameter: number;
	}

J
Johannes Rieken 已提交
2432 2433
	/**
	 * The signature help provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
2434
	 * the [parameter hints](https://code.visualstudio.com/docs/editor/intellisense)-feature.
J
Johannes Rieken 已提交
2435
	 */
E
Erich Gamma 已提交
2436
	export interface SignatureHelpProvider {
J
Johannes Rieken 已提交
2437 2438 2439 2440 2441 2442 2443 2444

		/**
		 * 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 已提交
2445
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
2446
		 */
2447
		provideSignatureHelp(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<SignatureHelp>;
E
Erich Gamma 已提交
2448 2449
	}

J
Johannes Rieken 已提交
2450 2451 2452
	/**
	 * Completion item kinds.
	 */
E
Erich Gamma 已提交
2453
	export enum CompletionItemKind {
2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469
		Text = 0,
		Method = 1,
		Function = 2,
		Constructor = 3,
		Field = 4,
		Variable = 5,
		Class = 6,
		Interface = 7,
		Module = 8,
		Property = 9,
		Unit = 10,
		Value = 11,
		Enum = 12,
		Keyword = 13,
		Snippet = 14,
		Color = 15,
2470
		Reference = 17,
2471
		File = 16,
2472 2473 2474 2475 2476
		Folder = 18,
		EnumMember = 19,
		Constant = 20,
		Struct = 21,
		Event = 22,
2477 2478
		Operator = 23,
		TypeParameter = 24
E
Erich Gamma 已提交
2479 2480
	}

J
Johannes Rieken 已提交
2481
	/**
2482
	 * A completion item represents a text snippet that is proposed to complete text that is being typed.
J
Johannes Rieken 已提交
2483
	 *
2484 2485 2486 2487
	 * 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 or [insertText](#CompletionItem.insertText). Otherwise the
	 * the given [edit](#CompletionItem.textEdit) is used.
2488
	 *
2489 2490 2491
	 * When selecting a completion item in the editor its defined or synthesized text edit will be applied
	 * to *all* cursors/selections whereas [additionalTextEdits](CompletionItem.additionalTextEdits) will be
	 * applied as provided.
2492
	 *
J
Johannes Rieken 已提交
2493 2494
	 * @see [CompletionItemProvider.provideCompletionItems](#CompletionItemProvider.provideCompletionItems)
	 * @see [CompletionItemProvider.resolveCompletionItem](#CompletionItemProvider.resolveCompletionItem)
J
Johannes Rieken 已提交
2495
	 */
E
Erich Gamma 已提交
2496
	export class CompletionItem {
J
Johannes Rieken 已提交
2497 2498 2499

		/**
		 * The label of this completion item. By default
A
Andre Weinand 已提交
2500
		 * this is also the text that is inserted when selecting
J
Johannes Rieken 已提交
2501 2502
		 * this completion.
		 */
E
Erich Gamma 已提交
2503
		label: string;
J
Johannes Rieken 已提交
2504 2505

		/**
S
Steven Clarke 已提交
2506
		 * The kind of this completion item. Based on the kind
J
Johannes Rieken 已提交
2507 2508
		 * an icon is chosen by the editor.
		 */
2509
		kind?: CompletionItemKind;
J
Johannes Rieken 已提交
2510 2511 2512 2513 2514

		/**
		 * A human-readable string with additional information
		 * about this item, like type or symbol information.
		 */
2515
		detail?: string;
J
Johannes Rieken 已提交
2516 2517 2518 2519

		/**
		 * A human-readable string that represents a doc-comment.
		 */
2520
		documentation?: string;
J
Johannes Rieken 已提交
2521 2522

		/**
A
Andre Weinand 已提交
2523
		 * A string that should be used when comparing this item
J
Johannes Rieken 已提交
2524 2525 2526
		 * with other items. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
2527
		sortText?: string;
J
Johannes Rieken 已提交
2528 2529 2530 2531 2532 2533

		/**
		 * A string that should be used when filtering a set of
		 * completion items. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
2534
		filterText?: string;
J
Johannes Rieken 已提交
2535 2536

		/**
2537
		 * A string or snippet that should be inserted in a document when selecting
J
Johannes Rieken 已提交
2538 2539 2540
		 * this completion. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
2541
		insertText?: string | SnippetString;
2542 2543 2544 2545 2546 2547 2548 2549 2550 2551

		/**
		 * A range of text that should be replaced by this completion item.
		 *
		 * Defaults to a range from the start of the [current word](#TextDocument.getWordRangeAtPosition) to the
		 * current position.
		 *
		 * *Note:* The range must be a [single line](#Range.isSingleLine) and it must
		 * [contain](#Range.contains) the position at which completion has been [requested](#CompletionItemProvider.provideCompletionItems).
		 */
2552
		range?: Range;
J
Johannes Rieken 已提交
2553

2554 2555
		/**
		 * An optional set of characters that when pressed while this completion is active will accept it first and
J
Johannes Rieken 已提交
2556
		 * then type that character. *Note* that all commit characters should have `length=1` and that superfluous
2557 2558 2559 2560
		 * characters will be ignored.
		 */
		commitCharacters?: string[];

J
Johannes Rieken 已提交
2561
		/**
2562 2563 2564
		 * @deprecated **Deprecated** in favor of `CompletionItem.insertText` and `CompletionItem.range`.
		 *
		 * ~~An [edit](#TextEdit) which is applied to a document when selecting
J
Johannes Rieken 已提交
2565
		 * this completion. When an edit is provided the value of
2566
		 * [insertText](#CompletionItem.insertText) is ignored.~~
2567
		 *
2568 2569
		 * ~~The [range](#Range) of the edit must be single-line and on the same
		 * line completions were [requested](#CompletionItemProvider.provideCompletionItems) at.~~
J
Johannes Rieken 已提交
2570
		 */
2571
		textEdit?: TextEdit;
J
Johannes Rieken 已提交
2572

2573 2574 2575 2576 2577
		/**
		 * An optional array of additional [text edits](#TextEdit) that are applied when
		 * selecting this completion. Edits must not overlap with the main [edit](#CompletionItem.textEdit)
		 * nor with themselves.
		 */
2578
		additionalTextEdits?: TextEdit[];
2579 2580

		/**
2581 2582
		 * An optional [command](#Command) that is executed *after* inserting this completion. *Note* that
		 * additional modifications to the current document should be described with the
2583 2584
		 * [additionalTextEdits](#CompletionItem.additionalTextEdits)-property.
		 */
2585
		command?: Command;
2586

J
Johannes Rieken 已提交
2587 2588 2589 2590 2591 2592 2593
		/**
		 * 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.
2594
		 * @param kind The [kind](#CompletionItemKind) of the completion.
J
Johannes Rieken 已提交
2595
		 */
2596
		constructor(label: string, kind?: CompletionItemKind);
E
Erich Gamma 已提交
2597 2598
	}

2599 2600 2601 2602
	/**
	 * Represents a collection of [completion items](#CompletionItem) to be presented
	 * in the editor.
	 */
J
Johannes Rieken 已提交
2603
	export class CompletionList {
2604 2605 2606 2607 2608

		/**
		 * This list it not complete. Further typing should result in recomputing
		 * this list.
		 */
2609
		isIncomplete?: boolean;
2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624

		/**
		 * 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 已提交
2625 2626
	/**
	 * The completion item provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
2627
	 * [IntelliSense](https://code.visualstudio.com/docs/editor/intellisense).
J
Johannes Rieken 已提交
2628 2629 2630 2631
	 *
	 * 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 已提交
2632
	 * [provideCompletionItems](#CompletionItemProvider.provideCompletionItems)-function. Subsequently,
S
Steven Clarke 已提交
2633
	 * when a completion item is shown in the UI and gains focus this provider is asked to resolve
J
Johannes Rieken 已提交
2634
	 * the item, like adding [doc-comment](#CompletionItem.documentation) or [details](#CompletionItem.detail).
2635 2636 2637
	 *
	 * Providers are asked for completions either explicitly by a user gesture or -depending on the configuration-
	 * implicitly when typing words or trigger characters.
J
Johannes Rieken 已提交
2638
	 */
E
Erich Gamma 已提交
2639
	export interface CompletionItemProvider {
J
Johannes Rieken 已提交
2640 2641

		/**
J
Johannes Rieken 已提交
2642
		 * Provide completion items for the given position and document.
J
Johannes Rieken 已提交
2643
		 *
J
Johannes Rieken 已提交
2644 2645 2646
		 * @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.
2647 2648
		 * @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 已提交
2649
		 */
2650
		provideCompletionItems(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<CompletionItem[] | CompletionList>;
J
Johannes Rieken 已提交
2651 2652

		/**
J
Johannes Rieken 已提交
2653 2654 2655 2656
		 * 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 已提交
2657
		 *
J
Johannes Rieken 已提交
2658 2659
		 * @param item A completion item currently active in the UI.
		 * @param token A cancellation token.
S
Steven Clarke 已提交
2660
		 * @return The resolved completion item or a thenable that resolves to of such. It is OK to return the given
J
Johannes Rieken 已提交
2661
		 * `item`. When no result is returned, the given `item` will be used.
J
Johannes Rieken 已提交
2662
		 */
2663
		resolveCompletionItem?(item: CompletionItem, token: CancellationToken): ProviderResult<CompletionItem>;
E
Erich Gamma 已提交
2664 2665
	}

J
Johannes Rieken 已提交
2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680

	/**
	 * A document link is a range in a text document that links to an internal or external resource, like another
	 * text document or a web site.
	 */
	export class DocumentLink {

		/**
		 * The range this link applies to.
		 */
		range: Range;

		/**
		 * The uri this link points to.
		 */
2681
		target?: Uri;
J
Johannes Rieken 已提交
2682 2683 2684 2685 2686 2687 2688

		/**
		 * Creates a new document link.
		 *
		 * @param range The range the document link applies to. Must not be empty.
		 * @param target The uri the document link points to.
		 */
2689
		constructor(range: Range, target?: Uri);
J
Johannes Rieken 已提交
2690 2691 2692 2693 2694 2695 2696 2697 2698
	}

	/**
	 * The document link provider defines the contract between extensions and feature of showing
	 * links in the editor.
	 */
	export interface DocumentLinkProvider {

		/**
2699 2700 2701
		 * Provide links for the given document. Note that the editor ships with a default provider that detects
		 * `http(s)` and `file` links.
		 *
J
Johannes Rieken 已提交
2702 2703 2704
		 * @param document The document in which the command was invoked.
		 * @param token A cancellation token.
		 * @return An array of [document links](#DocumentLink) or a thenable that resolves to such. The lack of a result
2705
		 * can be signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2706
		 */
2707
		provideDocumentLinks(document: TextDocument, token: CancellationToken): ProviderResult<DocumentLink[]>;
2708 2709 2710 2711 2712 2713 2714 2715 2716 2717

		/**
		 * Given a link fill in its [target](#DocumentLink.target). This method is called when an incomplete
		 * link is selected in the UI. Providers can implement this method and return incomple links
		 * (without target) from the [`provideDocumentLinks`](#DocumentLinkProvider.provideDocumentLinks) method which
		 * often helps to improve performance.
		 *
		 * @param link The link that is to be resolved.
		 * @param token A cancellation token.
		 */
2718
		resolveDocumentLink?(link: DocumentLink, token: CancellationToken): ProviderResult<DocumentLink>;
J
Johannes Rieken 已提交
2719 2720
	}

J
Johannes Rieken 已提交
2721 2722 2723 2724
	/**
	 * A tuple of two characters, like a pair of
	 * opening and closing brackets.
	 */
E
Erich Gamma 已提交
2725 2726
	export type CharacterPair = [string, string];

J
Johannes Rieken 已提交
2727 2728 2729
	/**
	 * Describes how comments for a language work.
	 */
E
Erich Gamma 已提交
2730
	export interface CommentRule {
J
Johannes Rieken 已提交
2731 2732 2733 2734

		/**
		 * The line comment token, like `// this is a comment`
		 */
E
Erich Gamma 已提交
2735
		lineComment?: string;
J
Johannes Rieken 已提交
2736 2737 2738 2739 2740

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

A
Alex Dima 已提交
2743 2744 2745
	/**
	 * Describes indentation rules for a language.
	 */
E
Erich Gamma 已提交
2746
	export interface IndentationRule {
A
Alex Dima 已提交
2747 2748 2749
		/**
		 * If a line matches this pattern, then all the lines after it should be unindendented once (until another rule matches).
		 */
E
Erich Gamma 已提交
2750
		decreaseIndentPattern: RegExp;
A
Alex Dima 已提交
2751 2752 2753
		/**
		 * If a line matches this pattern, then all the lines after it should be indented once (until another rule matches).
		 */
E
Erich Gamma 已提交
2754
		increaseIndentPattern: RegExp;
A
Alex Dima 已提交
2755 2756 2757
		/**
		 * If a line matches this pattern, then **only the next line** after it should be indented once.
		 */
E
Erich Gamma 已提交
2758
		indentNextLinePattern?: RegExp;
A
Alex Dima 已提交
2759 2760 2761
		/**
		 * 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 已提交
2762 2763 2764
		unIndentedLinePattern?: RegExp;
	}

A
Alex Dima 已提交
2765 2766 2767
	/**
	 * Describes what to do with the indentation when pressing Enter.
	 */
E
Erich Gamma 已提交
2768
	export enum IndentAction {
A
Alex Dima 已提交
2769 2770 2771
		/**
		 * Insert new line and copy the previous line's indentation.
		 */
2772
		None = 0,
A
Alex Dima 已提交
2773 2774 2775
		/**
		 * Insert new line and indent once (relative to the previous line's indentation).
		 */
2776
		Indent = 1,
A
Alex Dima 已提交
2777 2778 2779 2780 2781
		/**
		 * Insert two new lines:
		 *  - the first one indented which will hold the cursor
		 *  - the second one at the same indentation level
		 */
2782
		IndentOutdent = 2,
A
Alex Dima 已提交
2783 2784 2785
		/**
		 * Insert new line and outdent once (relative to the previous line's indentation).
		 */
2786
		Outdent = 3
E
Erich Gamma 已提交
2787 2788
	}

A
Alex Dima 已提交
2789 2790 2791
	/**
	 * Describes what to do when pressing Enter.
	 */
E
Erich Gamma 已提交
2792
	export interface EnterAction {
A
Alex Dima 已提交
2793 2794 2795 2796 2797 2798 2799
		/**
		 * 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 已提交
2800
		appendText?: string;
A
Alex Dima 已提交
2801 2802 2803 2804
		/**
		 * Describes the number of characters to remove from the new line's indentation.
		 */
		removeText?: number;
E
Erich Gamma 已提交
2805 2806
	}

A
Alex Dima 已提交
2807 2808 2809
	/**
	 * Describes a rule to be evaluated when pressing Enter.
	 */
E
Erich Gamma 已提交
2810
	export interface OnEnterRule {
A
Alex Dima 已提交
2811 2812 2813
		/**
		 * This rule will only execute if the text before the cursor matches this regular expression.
		 */
E
Erich Gamma 已提交
2814
		beforeText: RegExp;
A
Alex Dima 已提交
2815 2816 2817
		/**
		 * This rule will only execute if the text after the cursor matches this regular expression.
		 */
E
Erich Gamma 已提交
2818
		afterText?: RegExp;
A
Alex Dima 已提交
2819 2820 2821
		/**
		 * The action to execute.
		 */
E
Erich Gamma 已提交
2822 2823 2824
		action: EnterAction;
	}

J
Johannes Rieken 已提交
2825
	/**
A
Andre Weinand 已提交
2826
	 * The language configuration interfaces defines the contract between extensions
S
Steven Clarke 已提交
2827
	 * and various editor features, like automatic bracket insertion, automatic indentation etc.
J
Johannes Rieken 已提交
2828
	 */
E
Erich Gamma 已提交
2829
	export interface LanguageConfiguration {
A
Alex Dima 已提交
2830 2831 2832
		/**
		 * The language's comment settings.
		 */
E
Erich Gamma 已提交
2833
		comments?: CommentRule;
A
Alex Dima 已提交
2834 2835 2836 2837
		/**
		 * The language's brackets.
		 * This configuration implicitly affects pressing Enter around these brackets.
		 */
E
Erich Gamma 已提交
2838
		brackets?: CharacterPair[];
A
Alex Dima 已提交
2839 2840 2841 2842 2843 2844 2845
		/**
		 * 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 已提交
2846
		wordPattern?: RegExp;
A
Alex Dima 已提交
2847 2848 2849
		/**
		 * The language's indentation settings.
		 */
E
Erich Gamma 已提交
2850
		indentationRules?: IndentationRule;
A
Alex Dima 已提交
2851 2852 2853
		/**
		 * The language's rules to be evaluated when pressing Enter.
		 */
E
Erich Gamma 已提交
2854 2855 2856
		onEnterRules?: OnEnterRule[];

		/**
A
Alex Dima 已提交
2857
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
2858 2859
		 *
		 * @deprecated Will be replaced by a better API soon.
E
Erich Gamma 已提交
2860 2861
		 */
		__electricCharacterSupport?: {
2862 2863 2864 2865 2866 2867
			/**
			 * This property is deprecated and will be **ignored** from
			 * the editor.
			 * @deprecated
			 */
			brackets?: any;
2868 2869 2870 2871 2872 2873
			/**
			 * This property is deprecated and not fully supported anymore by
			 * the editor (scope and lineStart are ignored).
			 * Use the the autoClosingPairs property in the language configuration file instead.
			 * @deprecated
			 */
E
Erich Gamma 已提交
2874
			docComment?: {
A
Alex Dima 已提交
2875 2876 2877 2878
				scope: string;
				open: string;
				lineStart: string;
				close?: string;
E
Erich Gamma 已提交
2879 2880 2881 2882
			};
		};

		/**
A
Alex Dima 已提交
2883
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
2884
		 *
2885
		 * @deprecated * Use the the autoClosingPairs property in the language configuration file instead.
E
Erich Gamma 已提交
2886 2887 2888 2889 2890 2891 2892 2893 2894 2895
		 */
		__characterPairSupport?: {
			autoClosingPairs: {
				open: string;
				close: string;
				notIn?: string[];
			}[];
		};
	}

J
Johannes Rieken 已提交
2896
	/**
2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907
	 * Represents the workspace configuration.
	 *
	 * The workspace configuration is a merged view: Configurations of the current [workspace](#workspace.rootPath)
	 * (if available), files like `launch.json`, and the installation-wide configuration. Workspace specific values
	 * shadow installation-wide values.
	 *
	 * *Note:* The merged configuration of the current [workspace](#workspace.rootPath)
	 * also contains settings from files like `launch.json` and `tasks.json`. Their basename will be
	 * part of the section identifier. The following snippets shows how to retrieve all configurations
	 * from `launch.json`:
	 *
2908
	 * ```ts
D
Daniel Imms 已提交
2909 2910
	 * // launch.json configuration
	 * const config = workspace.getConfiguration('launch');
2911 2912
	 *
	 * // retrieve values
D
Daniel Imms 已提交
2913 2914
	 * const values = config.get('configurations');
	 * ```
J
Johannes Rieken 已提交
2915
	 */
E
Erich Gamma 已提交
2916 2917
	export interface WorkspaceConfiguration {

2918 2919 2920 2921 2922 2923 2924 2925
		/**
		 * Return a value from this configuration.
		 *
		 * @param section Configuration name, supports _dotted_ names.
		 * @return The value `section` denotes or `undefined`.
		 */
		get<T>(section: string): T | undefined;

E
Erich Gamma 已提交
2926
		/**
J
Johannes Rieken 已提交
2927 2928 2929
		 * Return a value from this configuration.
		 *
		 * @param section Configuration name, supports _dotted_ names.
J
Johannes Rieken 已提交
2930
		 * @param defaultValue A value should be returned when no value could be found, is `undefined`.
J
Johannes Rieken 已提交
2931
		 * @return The value `section` denotes or the default.
E
Erich Gamma 已提交
2932
		 */
2933 2934
		get<T>(section: string, defaultValue: T): T;

E
Erich Gamma 已提交
2935 2936

		/**
J
Johannes Rieken 已提交
2937 2938
		 * Check if this configuration has a certain value.
		 *
2939
		 * @param section Configuration name, supports _dotted_ names.
G
Gama11 已提交
2940
		 * @return `true` if the section doesn't resolve to `undefined`.
E
Erich Gamma 已提交
2941 2942 2943
		 */
		has(section: string): boolean;

2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956
		/**
		 * Retrieve all information about a configuration setting. A configuration value
		 * often consists of a *default* value, a global or installation-wide value, and
		 * a workspace-specific value. The *effective* value (returned by [`get`](#WorkspaceConfiguration.get))
		 * is computed like this: `defaultValue` overwritten by `globalValue`,
		 * `globalValue` overwritten by `workspaceValue`.
		 *
		 * *Note:* The configuration name must denote a leaf in the configuration tree
		 * (`editor.fontSize` vs `editor`) otherwise no result is returned.
		 *
		 * @param section Configuration name, supports _dotted_ names.
		 * @return Information about a configuration setting or `undefined`.
		 */
2957
		inspect<T>(section: string): { key: string; defaultValue?: T; globalValue?: T; workspaceValue?: T } | undefined;
2958

2959 2960
		/**
		 * Update a configuration value. A value can be changed for the current
2961
		 * [workspace](#workspace.rootPath) only, or globally for all instances of the
2962 2963
		 * editor. The updated configuration values are persisted.
		 *
2964
		 * *Note 1:* Setting an installation-wide value (`global: true`) in the presence of
2965 2966 2967
		 * a more specific workspace value has no observable effect in that workspace, but
		 * in others.
		 *
2968 2969
		 * *Note 2:* To remove a configuration value use `undefined`, like so: `config.update('somekey', undefined)`
		 *
2970 2971 2972 2973
		 * @param section Configuration name, supports _dotted_ names.
		 * @param value The new value.
		 * @param global When `true` changes the configuration value for all instances of the editor.
		 */
2974
		update(section: string, value: any, global?: boolean): Thenable<void>;
2975

E
Erich Gamma 已提交
2976 2977 2978
		/**
		 * Readable dictionary that backs this configuration.
		 */
2979
		readonly [key: string]: any;
E
Erich Gamma 已提交
2980 2981
	}

J
Johannes Rieken 已提交
2982 2983 2984 2985 2986
	/**
	 * Represents a location inside a resource, such as a line
	 * inside a text file.
	 */
	export class Location {
J
Johannes Rieken 已提交
2987 2988 2989 2990

		/**
		 * The resource identifier of this location.
		 */
J
Johannes Rieken 已提交
2991
		uri: Uri;
J
Johannes Rieken 已提交
2992 2993 2994 2995

		/**
		 * The document range of this locations.
		 */
J
Johannes Rieken 已提交
2996
		range: Range;
J
Johannes Rieken 已提交
2997 2998 2999 3000 3001 3002 3003 3004

		/**
		 * 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 已提交
3005 3006
	}

E
Erich Gamma 已提交
3007 3008 3009 3010
	/**
	 * Represents the severity of diagnostics.
	 */
	export enum DiagnosticSeverity {
J
Johannes Rieken 已提交
3011 3012

		/**
S
Steven Clarke 已提交
3013
		 * Something not allowed by the rules of a language or other means.
J
Johannes Rieken 已提交
3014 3015 3016 3017 3018 3019
		 */
		Error = 0,

		/**
		 * Something suspicious but allowed.
		 */
E
Erich Gamma 已提交
3020
		Warning = 1,
J
Johannes Rieken 已提交
3021 3022 3023 3024 3025 3026 3027

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

		/**
A
Andre Weinand 已提交
3028
		 * Something to hint to a better way of doing it, like proposing
J
Johannes Rieken 已提交
3029 3030 3031
		 * a refactoring.
		 */
		Hint = 3
E
Erich Gamma 已提交
3032 3033 3034
	}

	/**
J
Johannes Rieken 已提交
3035 3036
	 * Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
	 * are only valid in the scope of a file.
E
Erich Gamma 已提交
3037
	 */
J
Johannes Rieken 已提交
3038 3039 3040 3041 3042
	export class Diagnostic {

		/**
		 * The range to which this diagnostic applies.
		 */
E
Erich Gamma 已提交
3043
		range: Range;
J
Johannes Rieken 已提交
3044 3045 3046 3047 3048 3049

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

3050 3051 3052 3053 3054 3055
		/**
		 * A human-readable string describing the source of this
		 * diagnostic, e.g. 'typescript' or 'super lint'.
		 */
		source: string;

J
Johannes Rieken 已提交
3056 3057 3058 3059 3060 3061
		/**
		 * The severity, default is [error](#DiagnosticSeverity.Error).
		 */
		severity: DiagnosticSeverity;

		/**
S
Steven Clarke 已提交
3062
		 * A code or identifier for this diagnostics. Will not be surfaced
A
Andre Weinand 已提交
3063
		 * to the user, but should be used for later processing, e.g. when
J
Johannes Rieken 已提交
3064 3065 3066 3067 3068
		 * providing [code actions](#CodeActionContext).
		 */
		code: string | number;

		/**
A
Andre Weinand 已提交
3069
		 * Creates a new diagnostic object.
J
Johannes Rieken 已提交
3070 3071 3072
		 *
		 * @param range The range to which this diagnostic applies.
		 * @param message The human-readable message.
A
Andre Weinand 已提交
3073
		 * @param severity The severity, default is [error](#DiagnosticSeverity.Error).
J
Johannes Rieken 已提交
3074 3075
		 */
		constructor(range: Range, message: string, severity?: DiagnosticSeverity);
E
Erich Gamma 已提交
3076 3077
	}

J
Johannes Rieken 已提交
3078 3079 3080
	/**
	 * A diagnostics collection is a container that manages a set of
	 * [diagnostics](#Diagnostic). Diagnostics are always scopes to a
3081
	 * diagnostics collection and a resource.
J
Johannes Rieken 已提交
3082 3083 3084 3085
	 *
	 * To get an instance of a `DiagnosticCollection` use
	 * [createDiagnosticCollection](#languages.createDiagnosticCollection).
	 */
E
Erich Gamma 已提交
3086 3087 3088
	export interface DiagnosticCollection {

		/**
J
Johannes Rieken 已提交
3089 3090 3091
		 * 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 已提交
3092
		 */
Y
Yuki Ueda 已提交
3093
		readonly name: string;
E
Erich Gamma 已提交
3094 3095 3096

		/**
		 * Assign diagnostics for given resource. Will replace
J
Johannes Rieken 已提交
3097 3098 3099 3100
		 * existing diagnostics for that resource.
		 *
		 * @param uri A resource identifier.
		 * @param diagnostics Array of diagnostics or `undefined`
E
Erich Gamma 已提交
3101
		 */
3102
		set(uri: Uri, diagnostics: Diagnostic[] | undefined): void;
E
Erich Gamma 已提交
3103 3104

		/**
3105
		 * Replace all entries in this collection.
J
Johannes Rieken 已提交
3106
		 *
3107 3108 3109 3110 3111 3112
		 * Diagnostics of multiple tuples of the same uri will be merged, e.g
		 * `[[file1, [d1]], [file1, [d2]]]` is equivalent to `[[file1, [d1, d2]]]`.
		 * If a diagnostics item is `undefined` as in `[file1, undefined]`
		 * all previous but not subsequent diagnostics are removed.
		 *
		 * @param entries An array of tuples, like `[[file1, [d1, d2]], [file2, [d3, d4, d5]]]`, or `undefined`.
E
Erich Gamma 已提交
3113
		 */
3114
		set(entries: [Uri, Diagnostic[] | undefined][]): void;
E
Erich Gamma 已提交
3115 3116

		/**
3117 3118
		 * Remove all diagnostics from this collection that belong
		 * to the provided `uri`. The same as `#set(uri, undefined)`.
J
Johannes Rieken 已提交
3119
		 *
3120
		 * @param uri A resource identifier.
E
Erich Gamma 已提交
3121
		 */
3122
		delete(uri: Uri): void;
E
Erich Gamma 已提交
3123 3124 3125 3126 3127 3128 3129

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

3130 3131 3132 3133 3134 3135 3136 3137
		/**
		 * 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;

3138 3139 3140 3141 3142 3143 3144
		/**
		 * 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`.
		 */
3145
		get(uri: Uri): Diagnostic[] | undefined;
3146 3147 3148 3149 3150 3151 3152 3153 3154 3155

		/**
		 * 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 已提交
3156 3157 3158 3159
		/**
		 * Dispose and free associated resources. Calls
		 * [clear](#DiagnosticCollection.clear).
		 */
E
Erich Gamma 已提交
3160 3161 3162
		dispose(): void;
	}

J
Johannes Rieken 已提交
3163
	/**
J
Johannes Rieken 已提交
3164 3165
	 * Denotes a column in the VS Code window. Columns are
	 * used to show editors side by side.
J
Johannes Rieken 已提交
3166 3167 3168 3169 3170 3171 3172
	 */
	export enum ViewColumn {
		One = 1,
		Two = 2,
		Three = 3
	}

E
Erich Gamma 已提交
3173
	/**
J
Johannes Rieken 已提交
3174 3175 3176 3177
	 * An output channel is a container for readonly textual information.
	 *
	 * To get an instance of an `OutputChannel` use
	 * [createOutputChannel](#window.createOutputChannel).
E
Erich Gamma 已提交
3178
	 */
J
Johannes Rieken 已提交
3179
	export interface OutputChannel {
E
Erich Gamma 已提交
3180

J
Johannes Rieken 已提交
3181 3182 3183
		/**
		 * The human-readable name of this output channel.
		 */
Y
Yuki Ueda 已提交
3184
		readonly name: string;
E
Erich Gamma 已提交
3185 3186

		/**
J
Johannes Rieken 已提交
3187
		 * Append the given value to the channel.
E
Erich Gamma 已提交
3188
		 *
J
Johannes Rieken 已提交
3189
		 * @param value A string, falsy values will not be printed.
E
Erich Gamma 已提交
3190
		 */
J
Johannes Rieken 已提交
3191
		append(value: string): void;
E
Erich Gamma 已提交
3192 3193

		/**
J
Johannes Rieken 已提交
3194 3195
		 * Append the given value and a line feed character
		 * to the channel.
E
Erich Gamma 已提交
3196
		 *
J
Johannes Rieken 已提交
3197
		 * @param value A string, falsy values will be printed.
E
Erich Gamma 已提交
3198 3199 3200
		 */
		appendLine(value: string): void;

J
Johannes Rieken 已提交
3201 3202 3203
		/**
		 * Removes all output from the channel.
		 */
E
Erich Gamma 已提交
3204 3205
		clear(): void;

J
Johannes Rieken 已提交
3206 3207
		/**
		 * Reveal this channel in the UI.
3208
		 *
3209
		 * @param preserveFocus When `true` the channel will not take focus.
J
Johannes Rieken 已提交
3210
		 */
J
Johannes Rieken 已提交
3211
		show(preserveFocus?: boolean): void;
E
Erich Gamma 已提交
3212

3213 3214 3215
		/**
		 * Reveal this channel in the UI.
		 *
J
Johannes Rieken 已提交
3216 3217 3218 3219
		 * @deprecated This method is **deprecated** and the overload with
		 * just one parameter should be used (`show(preserveFocus?: boolean): void`).
		 *
		 * @param column This argument is **deprecated** and will be ignored.
3220 3221
		 * @param preserveFocus When `true` the channel will not take focus.
		 */
J
Johannes Rieken 已提交
3222
		show(column?: ViewColumn, preserveFocus?: boolean): void;
3223

J
Johannes Rieken 已提交
3224 3225 3226
		/**
		 * Hide this channel from the UI.
		 */
E
Erich Gamma 已提交
3227 3228
		hide(): void;

J
Johannes Rieken 已提交
3229 3230 3231
		/**
		 * Dispose and free associated resources.
		 */
E
Erich Gamma 已提交
3232 3233 3234 3235
		dispose(): void;
	}

	/**
J
Johannes Rieken 已提交
3236
	 * Represents the alignment of status bar items.
E
Erich Gamma 已提交
3237 3238
	 */
	export enum StatusBarAlignment {
J
Johannes Rieken 已提交
3239 3240 3241 3242

		/**
		 * Aligned to the left side.
		 */
3243
		Left = 1,
J
Johannes Rieken 已提交
3244 3245 3246 3247

		/**
		 * Aligned to the right side.
		 */
3248
		Right = 2
E
Erich Gamma 已提交
3249 3250 3251 3252 3253 3254 3255 3256 3257
	}

	/**
	 * 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 已提交
3258
		 * The alignment of this item.
E
Erich Gamma 已提交
3259
		 */
Y
Yuki Ueda 已提交
3260
		readonly alignment: StatusBarAlignment;
E
Erich Gamma 已提交
3261 3262

		/**
J
Johannes Rieken 已提交
3263 3264
		 * The priority of this item. Higher value means the item should
		 * be shown more to the left.
E
Erich Gamma 已提交
3265
		 */
Y
Yuki Ueda 已提交
3266
		readonly priority: number;
E
Erich Gamma 已提交
3267 3268

		/**
J
Johannes Rieken 已提交
3269 3270
		 * The text to show for the entry. You can embed icons in the text by leveraging the syntax:
		 *
3271
		 * `My text $(icon-name) contains icons like $(icon'name) this one.`
J
Johannes Rieken 已提交
3272
		 *
3273 3274
		 * 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 已提交
3275
		 */
E
Erich Gamma 已提交
3276 3277 3278
		text: string;

		/**
J
Johannes Rieken 已提交
3279 3280
		 * The tooltip text when you hover over this entry.
		 */
3281
		tooltip: string | undefined;
E
Erich Gamma 已提交
3282 3283

		/**
J
Johannes Rieken 已提交
3284 3285
		 * The foreground color for this entry.
		 */
3286
		color: string | undefined;
E
Erich Gamma 已提交
3287 3288

		/**
J
Johannes Rieken 已提交
3289 3290 3291
		 * The identifier of a command to run on click. The command must be
		 * [known](#commands.getCommands).
		 */
3292
		command: string | undefined;
E
Erich Gamma 已提交
3293 3294 3295 3296 3297 3298 3299

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

		/**
J
Johannes Rieken 已提交
3300
		 * Hide the entry in the status bar.
E
Erich Gamma 已提交
3301 3302 3303 3304
		 */
		hide(): void;

		/**
J
Johannes Rieken 已提交
3305 3306
		 * Dispose and free associated resources. Call
		 * [hide](#StatusBarItem.hide).
E
Erich Gamma 已提交
3307 3308 3309 3310
		 */
		dispose(): void;
	}

3311 3312 3313 3314 3315 3316 3317 3318 3319
	/**
	 * Defines a generalized way of reporting progress updates.
	 */
	export interface Progress<T> {

		/**
		 * Report a progress update.
		 * @param value A progress item, like a message or an updated percentage value
		 */
J
Johannes Rieken 已提交
3320
		report(value: T): void;
3321 3322
	}

D
Daniel Imms 已提交
3323 3324 3325
	/**
	 * An individual terminal instance within the integrated terminal.
	 */
D
Daniel Imms 已提交
3326
	export interface Terminal {
D
Daniel Imms 已提交
3327

3328 3329 3330
		/**
		 * The name of the terminal.
		 */
Y
Yuki Ueda 已提交
3331
		readonly name: string;
3332

3333 3334 3335
		/**
		 * The process ID of the shell process.
		 */
Y
Yuki Ueda 已提交
3336
		readonly processId: Thenable<number>;
3337

D
Daniel Imms 已提交
3338
		/**
D
Daniel Imms 已提交
3339
		 * Send text to the terminal. The text is written to the stdin of the underlying pty process
3340
		 * (shell) of the terminal.
D
Daniel Imms 已提交
3341
		 *
D
Daniel Imms 已提交
3342
		 * @param text The text to send.
D
Daniel Imms 已提交
3343
		 * @param addNewLine Whether to add a new line to the text being sent, this is normally
3344 3345
		 * required to run a command in the terminal. The character(s) added are \n or \r\n
		 * depending on the platform. This defaults to `true`.
D
Daniel Imms 已提交
3346
		 */
3347
		sendText(text: string, addNewLine?: boolean): void;
D
Daniel Imms 已提交
3348 3349

		/**
D
Daniel Imms 已提交
3350
		 * Show the terminal panel and reveal this terminal in the UI.
D
Daniel Imms 已提交
3351
		 *
D
Daniel Imms 已提交
3352
		 * @param preserveFocus When `true` the terminal will not take focus.
D
Daniel Imms 已提交
3353
		 */
D
Daniel Imms 已提交
3354
		show(preserveFocus?: boolean): void;
D
Daniel Imms 已提交
3355 3356

		/**
D
Daniel Imms 已提交
3357
		 * Hide the terminal panel if this terminal is currently showing.
D
Daniel Imms 已提交
3358 3359 3360 3361 3362 3363 3364
		 */
		hide(): void;

		/**
		 * Dispose and free associated resources.
		 */
		dispose(): void;
D
Daniel Imms 已提交
3365 3366
	}

J
Johannes Rieken 已提交
3367 3368 3369
	/**
	 * Represents an extension.
	 *
A
Alex Dima 已提交
3370
	 * To get an instance of an `Extension` use [getExtension](#extensions.getExtension).
J
Johannes Rieken 已提交
3371
	 */
E
Erich Gamma 已提交
3372
	export interface Extension<T> {
J
Johannes Rieken 已提交
3373

E
Erich Gamma 已提交
3374
		/**
J
Johannes Rieken 已提交
3375
		 * The canonical extension identifier in the form of: `publisher.name`.
E
Erich Gamma 已提交
3376
		 */
Y
Yuki Ueda 已提交
3377
		readonly id: string;
E
Erich Gamma 已提交
3378 3379

		/**
J
Johannes Rieken 已提交
3380
		 * The absolute file path of the directory containing this extension.
E
Erich Gamma 已提交
3381
		 */
Y
Yuki Ueda 已提交
3382
		readonly extensionPath: string;
E
Erich Gamma 已提交
3383 3384

		/**
3385
		 * `true` if the extension has been activated.
E
Erich Gamma 已提交
3386
		 */
Y
Yuki Ueda 已提交
3387
		readonly isActive: boolean;
E
Erich Gamma 已提交
3388 3389 3390 3391

		/**
		 * The parsed contents of the extension's package.json.
		 */
Y
Yuki Ueda 已提交
3392
		readonly packageJSON: any;
E
Erich Gamma 已提交
3393 3394

		/**
A
Alex Dima 已提交
3395
		 * The public API exported by this extension. It is an invalid action
J
Johannes Rieken 已提交
3396
		 * to access this field before this extension has been activated.
E
Erich Gamma 已提交
3397
		 */
Y
Yuki Ueda 已提交
3398
		readonly exports: T;
E
Erich Gamma 已提交
3399 3400 3401

		/**
		 * Activates this extension and returns its public API.
J
Johannes Rieken 已提交
3402
		 *
S
Steven Clarke 已提交
3403
		 * @return A promise that will resolve when this extension has been activated.
E
Erich Gamma 已提交
3404 3405 3406 3407
		 */
		activate(): Thenable<T>;
	}

J
Johannes Rieken 已提交
3408
	/**
S
Steven Clarke 已提交
3409 3410
	 * An extension context is a collection of utilities private to an
	 * extension.
J
Johannes Rieken 已提交
3411
	 *
S
Steven Clarke 已提交
3412
	 * An instance of an `ExtensionContext` is provided as the first
J
Johannes Rieken 已提交
3413 3414
	 * parameter to the `activate`-call of an extension.
	 */
E
Erich Gamma 已提交
3415 3416 3417 3418
	export interface ExtensionContext {

		/**
		 * An array to which disposables can be added. When this
J
Johannes Rieken 已提交
3419
		 * extension is deactivated the disposables will be disposed.
E
Erich Gamma 已提交
3420 3421 3422 3423 3424
		 */
		subscriptions: { dispose(): any }[];

		/**
		 * A memento object that stores state in the context
3425
		 * of the currently opened [workspace](#workspace.rootPath).
E
Erich Gamma 已提交
3426 3427 3428 3429 3430
		 */
		workspaceState: Memento;

		/**
		 * A memento object that stores state independent
3431
		 * of the current opened [workspace](#workspace.rootPath).
E
Erich Gamma 已提交
3432 3433 3434 3435
		 */
		globalState: Memento;

		/**
J
Johannes Rieken 已提交
3436
		 * The absolute file path of the directory containing the extension.
E
Erich Gamma 已提交
3437 3438 3439 3440
		 */
		extensionPath: string;

		/**
A
Alex Dima 已提交
3441 3442 3443 3444
		 * 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 已提交
3445 3446
		 */
		asAbsolutePath(relativePath: string): string;
D
Dirk Baeumer 已提交
3447 3448

		/**
J
Johannes Rieken 已提交
3449 3450 3451
		 * An absolute file path of a workspace specific directory in which the extension
		 * can store private state. The directory might not exist on disk and creation is
		 * up to the extension. However, the parent directory is guaranteed to be existent.
D
Dirk Baeumer 已提交
3452
		 *
3453 3454
		 * Use [`workspaceState`](#ExtensionContext.workspaceState) or
		 * [`globalState`](#ExtensionContext.globalState) to store key value data.
D
Dirk Baeumer 已提交
3455
		 */
3456
		storagePath: string | undefined;
E
Erich Gamma 已提交
3457 3458 3459 3460 3461 3462 3463 3464
	}

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

3465 3466 3467 3468 3469 3470 3471 3472
		/**
		 * Return a value.
		 *
		 * @param key A string.
		 * @return The stored value or `undefined`.
		 */
		get<T>(key: string): T | undefined;

E
Erich Gamma 已提交
3473
		/**
J
Johannes Rieken 已提交
3474 3475 3476 3477 3478
		 * 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.
3479
		 * @return The stored value or the defaultValue.
E
Erich Gamma 已提交
3480
		 */
3481
		get<T>(key: string, defaultValue: T): T;
E
Erich Gamma 已提交
3482 3483

		/**
S
Steven Clarke 已提交
3484
		 * Store a value. The value must be JSON-stringifyable.
J
Johannes Rieken 已提交
3485 3486 3487
		 *
		 * @param key A string.
		 * @param value A value. MUST not contain cyclic references.
E
Erich Gamma 已提交
3488 3489 3490 3491
		 */
		update(key: string, value: any): Thenable<void>;
	}

3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 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 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 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 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011
	/**
	 * Defines a problem pattern
	 */
	export interface ProblemPattern {

		/**
		 * The regular expression to find a problem in the console output of an
		 * executed task.
		 */
		regexp: RegExp;

		/**
		 * The match group index of the filename.
		 *
		 * Defaults to 1 if omitted.
		 */
		file?: number;

		/**
		 * The match group index of the problems's location. Valid location
		 * patterns are: (line), (line,column) and (startLine,startColumn,endLine,endColumn).
		 * If omitted the line and colum properties are used.
		 */
		location?: number;

		/**
		 * The match group index of the problem's line in the source file.
		 *
		 * Defaults to 2 if omitted.
		 */
		line?: number;

		/**
		 * The match group index of the problem's character in the source file.
		 *
		 * Defaults to 3 if omitted.
		 */
		character?: number;

		/**
		 * The match group index of the problem's end line in the source file.
		 *
		 * Defaults to undefined. No end line is captured.
		 */
		endLine?: number;

		/**
		 * The match group index of the problem's end character in the source file.
		 *
		 * Defaults to undefined. No end column is captured.
		 */
		endCharacter?: number;

		/**
		 * The match group index of the problem's severity.
		 *
		 * Defaults to undefined. In this case the problem matcher's severity
		 * is used.
		*/
		severity?: number;

		/**
		 * The match group index of the problems's code.
		 *
		 * Defaults to undefined. No code is captured.
		 */
		code?: number;

		/**
		 * The match group index of the message. If omitted it defaults
		 * to 4 if location is specified. Otherwise it defaults to 5.
		 */
		message?: number;

		/**
		 * Specifies if the last pattern in a multi line problem matcher should
		 * loop as long as it does match a line consequently. Only valid on the
		 * last problem pattern in a multi line problem matcher.
		 */
		loop?: boolean;
	}

	/**
	 * A multi line problem pattern.
	 */
	export type MultiLineProblemPattern = ProblemPattern[];

	/**
	 * The way how the file location is interpreted
	 */
	export enum FileLocationKind {
		/**
		 * VS Code should decide based on whether the file path found in the
		 * output is absolute or relative. A relative file path will be treated
		 * relative to the workspace root.
		 */
		Auto = 1,

		/**
		 * Always treat the file path relative.
		 */
		Relative = 2,

		/**
		 * Always treat the file path absolute.
		 */
		Absolute = 3
	}

	/**
	 * Controls to which kind of documents problems are applied.
	 */
	export enum ApplyToKind {
		/**
		 * Problems are applied to all documents.
		 */
		AllDocuments = 1,

		/**
		 * Problems are applied to open documents only.
		 */
		OpenDocuments = 2,


		/**
		 * Problems are applied to closed documents only.
		 */
		ClosedDocuments = 3
	}


	/**
	 * A background monitor pattern
	 */
	export interface BackgroundPattern {
		/**
		 * The actual regular expression
		 */
		regexp: RegExp;

		/**
		 * The match group index of the filename. If provided the expression
		 * is matched for that file only.
		 */
		file?: number;
	}

	/**
	 * A description to control the activity of a problem matcher
	 * watching a background task.
	 */
	export interface BackgroundMonitor {
		/**
		 * If set to true the monitor is in active mode when the task
		 * starts. This is equals of issuing a line that matches the
		 * beginPattern.
		 */
		activeOnStart?: boolean;

		/**
		 * If matched in the output the start of a background activity is signaled.
		 */
		beginsPattern: RegExp | BackgroundPattern;

		/**
		 * If matched in the output the end of a background activity is signaled.
		 */
		endsPattern: RegExp | BackgroundPattern;
	}

	/**
	 * Defines a problem matcher
	 */
	export interface ProblemMatcher {
		/**
		 * The owner of a problem. Defaults to a generated id
		 * if omitted.
		 */
		owner?: string;

		/**
		 * The type of documents problems detected by this matcher
		 * apply to. Default to `ApplyToKind.AllDocuments` if omitted.
		 */
		applyTo?: ApplyToKind;

		/**
		 * How a file location recognized by a matcher should be interpreted. If omitted the file location
		 * if `FileLocationKind.Auto`.
		 */
		fileLocation?: FileLocationKind | string;

		/**
		 * The actual pattern used by the problem matcher.
		 */
		pattern: ProblemPattern | MultiLineProblemPattern;

		/**
		 * The default severity of a detected problem in the output. Used
		 * if the `ProblemPattern` doesn't define a severity match group.
		 */
		severity?: DiagnosticSeverity;

		/**
		 * A background monitor for tasks that are running in the background.
		 */
		backgound?: BackgroundMonitor;
	}

	/**
	 * Controls the behaviour of the terminal's visibility.
	 */
	export enum RevealKind {
		/**
		 * Always brings the terminal to front if the task is executed.
		 */
		Always = 1,

		/**
		 * Only brings the terminal to front if a problem is detected executing the task
		 * (e.g. the task couldn't be started because).
		 */
		Silent = 2,

		/**
		 * The terminal never comes to front when the task is executed.
		 */
		Never = 3
	}

	/**
	 * Controls terminal specific behaviour.
	 */
	export interface TerminalBehaviour {
		/**
		 * Controls whether the terminal executing a task is brought to front or not.
		 * Defaults to `RevealKind.Always`.
		 */
		reveal?: RevealKind;

		/**
		 * Controls whether the command is echoed in the terminal or not.
		 */
		echo?: boolean;
	}

	export interface ProcessOptions {
		/**
		 * The current working directory of the executed program or shell.
		 * If omitted VSCode's current workspace root is used.
		 */
		cwd?: string;

		/**
		 * The additional environment of the executed program or shell. If omitted
		 * the parent process' environment is used. If provided it is merged with
		 * the parent process' environment.
		 */
		env?: { [key: string]: string };
	}

	export namespace TaskGroup {
		/**
		 * The clean task group
		 */
		export const Clean: 'clean';
		/**
		 * The build task group
		 */
		export const Build: 'build';
		/**
		 * The rebuild all task group
		 */
		export const RebuildAll: 'rebuildAll';
		/**
		 * The test task group
		 */
		export const Test: 'test';
	}

	/**
	 * The supported task groups.
	 */
	export type TaskGroup = 'clean' | 'build' | 'rebuildAll' | 'test';

	/**
	 * The ProblemMatchers type definition.
	 */
	export type ProblemMatchers = string | ProblemMatcher | (string | ProblemMatcher)[];

	/**
	 * A task that starts an external process.
	 */
	export class ProcessTask {

		/**
		 * Creates a process task.
		 *
		 * @param name the task's name. Is presented in the user interface.
		 * @param process the process to start.
		 * @param problemMatchers the problem matchers to use.
		 */
		constructor(name: string, process: string, problemMatchers?: ProblemMatchers);

		/**
		 * Creates a process task.
		 *
		 * @param name the task's name. Is presented in the user interface.
		 * @param process the process to start.
		 * @param args arguments to be passed to the process.
		 * @param problemMatchers the problem matchers to use.
		 */
		constructor(name: string, process: string, args: string[], problemMatchers?: ProblemMatchers);

		/**
		 * Creates a process task.
		 *
		 * @param name the task's name. Is presented in the user interface.
		 * @param process the process to start.
		 * @param args arguments to be passed to the process.
		 * @param options additional options for the started process.
		 * @param problemMatchers the problem matchers to use.
		 */
		constructor(name: string, process: string, args: string[], options: ProcessOptions, problemMatchers?: ProblemMatchers);

		/**
		 * The task's name
		 */
		readonly name: string;

		/**
		 * The task's identifier. If omitted the name is
		 * used as an identifier.
		 */
		identifier: string;

		/**
		 * Whether the task is a background task or not.
		 */
		isBackground: boolean;

		/**
		 * The process to be executed.
		 */
		readonly process: string;

		/**
		 * The arguments passed to the process. Defaults to an empty array.
		 */
		args: string[];

		/**
		 * The task group this tasks belongs to. Defaults to undefined meaning
		 * that the task doesn't belong to any special group.
		 */
		group?: TaskGroup;

		/**
		 * The process options used when the process is executed.
		 * Defaults to an empty object literal.
		 */
		options: ProcessOptions;

		/**
		 * The terminal options. Defaults to an empty object literal.
		 */
		terminal: TerminalBehaviour;

		/**
		 * The problem matchers attached to the task. Defaults to an empty
		 * array.
		 */
		problemMatchers: (string | ProblemMatcher)[];
	}

	export type ShellOptions = {
		/**
		 * The shell executable.
		 */
		executable: string;

		/**
		 * The arguments to be passed to the shell executable used to run the task.
		 */
		shellArgs?: string[];

		/**
		 * The current working directory of the executed shell.
		 * If omitted VSCode's current workspace root is used.
		 */
		cwd?: string;

		/**
		 * The additional environment of the executed shell. If omitted
		 * the parent process' environment is used. If provided it is merged with
		 * the parent process' environment.
		 */
		env?: { [key: string]: string };
	} | {
			/**
			 * The current working directory of the executed shell.
			 * If omitted VSCode's current workspace root is used.
			 */
			cwd: string;

			/**
			 * The additional environment of the executed shell. If omitted
			 * the parent process' environment is used. If provided it is merged with
			 * the parent process' environment.
			 */
			env?: { [key: string]: string };
		} | {
			/**
			 * The current working directory of the executed shell.
			 * If omitted VSCode's current workspace root is used.
			 */
			cwd?: string;

			/**
			 * The additional environment of the executed shell. If omitted
			 * the parent process' environment is used. If provided it is merged with
			 * the parent process' environment.
			 */
			env: { [key: string]: string };
		};

	/**
	 * A task that executes a shell command.
	 */
	export class ShellTask {

		/**
		 * Creates a shell task.
		 *
		 * @param name the task's name. Is presented in the user interface.
		 * @param commandLine the command line to execute.
		 * @param problemMatchers the problem matchers to use.
		 */
		constructor(name: string, commandLine: string, problemMatchers?: ProblemMatchers);

		/**
		 * Creates a shell task.
		 *
		 * @param name the task's name. Is presented in the user interface.
		 * @param commandLine the command line to execute.
		 * @param options additional options used when creating the shell.
		 * @param problemMatchers the problem matchers to use.
		 */
		constructor(name: string, commandLine: string, options: ShellOptions, problemMatchers?: ProblemMatchers);

		/**
		 * The task's name
		 */
		readonly name: string;

		/**
		 * The task's identifier. If omitted the name is
		 * used as an identifier.
		 */
		identifier: string;

		/**
		 * Whether the task is a background task or not.
		 */
		isBackground: boolean;

		/**
		 * The command line to execute.
		 */
		readonly commandLine: string;

		/**
		 * The task group this tasks belongs to. Defaults to undefined meaning
		 * that the task doesn't belong to any special group.
		 */
		group?: TaskGroup;

		/**
		 * The shell options used when the shell is executed. Defaults to an
		 * empty object literal.
		 */
		options: ShellOptions;

		/**
		 * The terminal options. Defaults to an empty object literal.
		 */
		terminal: TerminalBehaviour;

		/**
		 * The problem matchers attached to the task. Defaults to an empty
		 * array.
		 */
		problemMatchers: (string | ProblemMatcher)[];
	}

	export type Task = ProcessTask | ShellTask;

	/**
	 * A task provider allows to add tasks to the task service.
	 * A task provider is registerd via #workspace.registerTaskProvider.
	 */
	export interface TaskProvider {
		/**
		 * Provides additional tasks.
		 * @param token A cancellation token.
		 * @return a #TaskSet
		 */
		provideTasks(token: CancellationToken): ProviderResult<Task[]>;
	}

	export namespace workspace {
		/**
		 * Register a task provider.
		 *
		 * @param provider A task provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerTaskProvider(provider: TaskProvider): Disposable;
	}

4012 4013 4014 4015 4016
	/**
	 * Namespace describing the environment the editor runs in.
	 */
	export namespace env {

4017 4018 4019 4020 4021 4022 4023
		/**
		 * The application name of the editor, like 'VS Code'.
		 *
		 * @readonly
		 */
		export let appName: string;

J
Johannes Rieken 已提交
4024 4025 4026 4027 4028 4029 4030
		/**
		 * Represents the preferred user-language, like `de-CH`, `fr`, or `en-US`.
		 *
		 * @readonly
		 */
		export let language: string;

4031 4032
		/**
		 * A unique identifier for the computer.
J
Johannes Rieken 已提交
4033 4034
		 *
		 * @readonly
4035 4036 4037 4038 4039 4040
		 */
		export let machineId: string;

		/**
		 * A unique identifier for the current session.
		 * Changes each time the editor is started.
J
Johannes Rieken 已提交
4041 4042
		 *
		 * @readonly
4043 4044 4045 4046
		 */
		export let sessionId: string;
	}

E
Erich Gamma 已提交
4047
	/**
4048 4049 4050 4051 4052 4053 4054 4055
	 * 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
G
Greg Van Liew 已提交
4056
	 * the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette).
4057
	 * * keybinding - Use the `keybindings`-section in `package.json` to enable
G
Greg Van Liew 已提交
4058
	 * [keybindings](https://code.visualstudio.com/docs/getstarted/keybindings#_customizing-shortcuts)
4059 4060
	 * for your extension.
	 *
S
Steven Clarke 已提交
4061
	 * Commands from other extensions and from the editor itself are accessible to an extension. However,
4062 4063 4064
	 * 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
G
Gama11 已提交
4065
	 * register a command handler with the identifier `extension.sayHello`.
4066 4067
	 * ```javascript
	 * commands.registerCommand('extension.sayHello', () => {
4068
	 * 	window.showInformationMessage('Hello World!');
4069 4070
	 * });
	 * ```
G
Gama11 已提交
4071
	 * Second, bind the command identifier to a title under which it will show in the palette (`package.json`).
4072 4073
	 * ```json
	 * {
4074 4075 4076 4077 4078 4079
	 * 	"contributes": {
	 * 		"commands": [{
	 * 			"command": "extension.sayHello",
	 * 			"title": "Hello World"
	 * 		}]
	 * 	}
4080 4081
	 * }
	 * ```
E
Erich Gamma 已提交
4082 4083 4084 4085 4086
	 */
	export namespace commands {

		/**
		 * Registers a command that can be invoked via a keyboard shortcut,
S
Steven Clarke 已提交
4087
		 * a menu item, an action, or directly.
E
Erich Gamma 已提交
4088
		 *
J
Johannes Rieken 已提交
4089 4090 4091 4092 4093
		 * 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 已提交
4094
		 * @param thisArg The `this` context used when invoking the handler function.
J
Johannes Rieken 已提交
4095
		 * @return Disposable which unregisters this command on disposal.
E
Erich Gamma 已提交
4096 4097 4098 4099
		 */
		export function registerCommand(command: string, callback: (...args: any[]) => any, thisArg?: any): Disposable;

		/**
J
Johannes Rieken 已提交
4100
		 * Registers a text editor command that can be invoked via a keyboard shortcut,
S
Steven Clarke 已提交
4101
		 * a menu item, an action, or directly.
E
Erich Gamma 已提交
4102
		 *
J
Johannes Rieken 已提交
4103
		 * Text editor commands are different from ordinary [commands](#commands.registerCommand) as
S
Steven Clarke 已提交
4104
		 * they only execute when there is an active editor when the command is called. Also, the
J
Johannes Rieken 已提交
4105 4106 4107 4108 4109
		 * 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 已提交
4110
		 * @param thisArg The `this` context used when invoking the handler function.
J
Johannes Rieken 已提交
4111
		 * @return Disposable which unregisters this command on disposal.
E
Erich Gamma 已提交
4112
		 */
J
Johannes Rieken 已提交
4113
		export function registerTextEditorCommand(command: string, callback: (textEditor: TextEditor, edit: TextEditorEdit, ...args: any[]) => void, thisArg?: any): Disposable;
E
Erich Gamma 已提交
4114 4115

		/**
J
Johannes Rieken 已提交
4116 4117 4118
		 * Executes the command denoted by the given command identifier.
		 *
		 * When executing an editor command not all types are allowed to
4119
		 * be passed as arguments. Allowed are the primitive types `string`, `boolean`,
J
Johannes Rieken 已提交
4120
		 * `number`, `undefined`, and `null`, as well as classes defined in this API.
S
Steven Clarke 已提交
4121
		 * There are no restrictions when executing commands that have been contributed
J
Johannes Rieken 已提交
4122
		 * by extensions.
E
Erich Gamma 已提交
4123
		 *
J
Johannes Rieken 已提交
4124
		 * @param command Identifier of the command to execute.
J
Johannes Rieken 已提交
4125 4126 4127
		 * @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 已提交
4128
		 */
4129
		export function executeCommand<T>(command: string, ...rest: any[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
4130 4131

		/**
4132 4133
		 * Retrieve the list of all available commands. Commands starting an underscore are
		 * treated as internal commands.
E
Erich Gamma 已提交
4134
		 *
4135
		 * @param filterInternal Set `true` to not see internal commands (starting with an underscore)
E
Erich Gamma 已提交
4136 4137
		 * @return Thenable that resolves to a list of command ids.
		 */
4138
		export function getCommands(filterInternal?: boolean): Thenable<string[]>;
E
Erich Gamma 已提交
4139 4140 4141
	}

	/**
4142 4143 4144
	 * 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 已提交
4145 4146 4147 4148
	 */
	export namespace window {

		/**
4149
		 * The currently active editor or `undefined`. The active editor is the one
S
Steven Clarke 已提交
4150
		 * that currently has focus or, when none has focus, the one that has changed
E
Erich Gamma 已提交
4151 4152
		 * input most recently.
		 */
4153
		export let activeTextEditor: TextEditor | undefined;
E
Erich Gamma 已提交
4154 4155

		/**
4156
		 * The currently visible editors or an empty array.
E
Erich Gamma 已提交
4157 4158 4159 4160
		 */
		export let visibleTextEditors: TextEditor[];

		/**
4161
		 * An [event](#Event) which fires when the [active editor](#window.activeTextEditor)
J
Johannes Rieken 已提交
4162
		 * has changed. *Note* that the event also fires when the active editor changes
4163
		 * to `undefined`.
E
Erich Gamma 已提交
4164 4165 4166
		 */
		export const onDidChangeActiveTextEditor: Event<TextEditor>;

4167 4168 4169 4170 4171 4172
		/**
		 * An [event](#Event) which fires when the array of [visible editors](#window.visibleTextEditors)
		 * has changed.
		 */
		export const onDidChangeVisibleTextEditors: Event<TextEditor[]>;

E
Erich Gamma 已提交
4173
		/**
A
Andre Weinand 已提交
4174
		 * An [event](#Event) which fires when the selection in an editor has changed.
E
Erich Gamma 已提交
4175 4176 4177 4178 4179 4180 4181 4182
		 */
		export const onDidChangeTextEditorSelection: Event<TextEditorSelectionChangeEvent>;

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

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

4188
		/**
4189
		 * An [event](#Event) which fires when a terminal is disposed.
4190 4191 4192
		 */
		export const onDidCloseTerminal: Event<Terminal>;

E
Erich Gamma 已提交
4193 4194 4195 4196 4197 4198 4199
		/**
		 * 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)__.
4200
		 * @param preserveFocus When `true` the editor will not take focus.
E
Erich Gamma 已提交
4201 4202
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
4203
		export function showTextDocument(document: TextDocument, column?: ViewColumn, preserveFocus?: boolean): Thenable<TextEditor>;
E
Erich Gamma 已提交
4204

4205 4206 4207 4208 4209
		/**
		 * 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.
4210
		 * @param options [Editor options](#ShowTextDocumentOptions) to configure the behavior of showing the [editor](#TextEditor).
4211 4212
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
4213
		export function showTextDocument(document: TextDocument, options?: TextDocumentShowOptions): Thenable<TextEditor>;
4214

E
Erich Gamma 已提交
4215
		/**
J
Johannes Rieken 已提交
4216 4217 4218 4219
		 * 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 已提交
4220 4221 4222 4223 4224 4225 4226
		 */
		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 已提交
4227 4228
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
4229
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
4230
		 */
4231
		export function showInformationMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
4232

J
Joao Moreno 已提交
4233 4234 4235 4236 4237 4238 4239 4240 4241
		/**
		 * Show an information message to users. Optionally provide an array of items which will be presented as
		 * clickable buttons.
		 *
		 * @param message The message to show.
		 * @param options Configures the behaviour of the message.
		 * @param items A set of items that will be rendered as actions in the message.
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
		 */
J
Joao Moreno 已提交
4242
		export function showInformationMessage(message: string, options: MessageOptions, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
4243 4244

		/**
J
Johannes Rieken 已提交
4245
		 * Show an information message.
J
Johannes Rieken 已提交
4246
		 *
E
Erich Gamma 已提交
4247
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
4248 4249 4250
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
4251
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
4252
		 */
4253
		export function showInformationMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
4254

J
Joao Moreno 已提交
4255 4256 4257 4258 4259 4260 4261 4262 4263 4264
		/**
		 * Show an information message.
		 *
		 * @see [showInformationMessage](#window.showInformationMessage)
		 *
		 * @param message The message to show.
		 * @param options Configures the behaviour of the message.
		 * @param items A set of items that will be rendered as actions in the message.
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
		 */
J
Joao Moreno 已提交
4265
		export function showInformationMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
4266 4267

		/**
J
Johannes Rieken 已提交
4268
		 * Show a warning message.
J
Johannes Rieken 已提交
4269
		 *
E
Erich Gamma 已提交
4270
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
4271 4272 4273
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
4274
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
4275
		 */
4276
		export function showWarningMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
4277

J
Joao Moreno 已提交
4278 4279 4280 4281 4282 4283 4284 4285 4286 4287
		/**
		 * Show a warning message.
		 *
		 * @see [showInformationMessage](#window.showInformationMessage)
		 *
		 * @param message The message to show.
		 * @param options Configures the behaviour of the message.
		 * @param items A set of items that will be rendered as actions in the message.
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
		 */
J
Joao Moreno 已提交
4288
		export function showWarningMessage(message: string, options: MessageOptions, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
4289 4290

		/**
J
Johannes Rieken 已提交
4291
		 * Show a warning message.
J
Johannes Rieken 已提交
4292
		 *
E
Erich Gamma 已提交
4293
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
4294 4295 4296
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
4297
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
4298
		 */
4299
		export function showWarningMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
4300

J
Joao Moreno 已提交
4301 4302 4303 4304 4305 4306 4307 4308 4309 4310
		/**
		 * Show a warning message.
		 *
		 * @see [showInformationMessage](#window.showInformationMessage)
		 *
		 * @param message The message to show.
		 * @param options Configures the behaviour of the message.
		 * @param items A set of items that will be rendered as actions in the message.
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
		 */
J
Joao Moreno 已提交
4311
		export function showWarningMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
4312 4313

		/**
J
Johannes Rieken 已提交
4314
		 * Show an error message.
J
Johannes Rieken 已提交
4315
		 *
E
Erich Gamma 已提交
4316
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
4317 4318 4319
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
4320
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
4321
		 */
4322
		export function showErrorMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
4323

J
Joao Moreno 已提交
4324 4325 4326 4327 4328 4329 4330 4331 4332 4333
		/**
		 * Show an error message.
		 *
		 * @see [showInformationMessage](#window.showInformationMessage)
		 *
		 * @param message The message to show.
		 * @param options Configures the behaviour of the message.
		 * @param items A set of items that will be rendered as actions in the message.
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
		 */
J
Joao Moreno 已提交
4334
		export function showErrorMessage(message: string, options: MessageOptions, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
4335 4336

		/**
J
Johannes Rieken 已提交
4337
		 * Show an error message.
J
Johannes Rieken 已提交
4338
		 *
E
Erich Gamma 已提交
4339
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
4340 4341 4342
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
4343
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
4344
		 */
4345
		export function showErrorMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
4346

J
Joao Moreno 已提交
4347 4348 4349 4350 4351 4352 4353 4354 4355 4356
		/**
		 * Show an error message.
		 *
		 * @see [showInformationMessage](#window.showInformationMessage)
		 *
		 * @param message The message to show.
		 * @param options Configures the behaviour of the message.
		 * @param items A set of items that will be rendered as actions in the message.
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
		 */
J
Joao Moreno 已提交
4357
		export function showErrorMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
4358 4359 4360 4361

		/**
		 * Shows a selection list.
		 *
J
Johannes Rieken 已提交
4362 4363
		 * @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.
4364
		 * @param token A token that can be used to signal cancellation.
4365
		 * @return A promise that resolves to the selection or `undefined`.
E
Erich Gamma 已提交
4366
		 */
4367
		export function showQuickPick(items: string[] | Thenable<string[]>, options?: QuickPickOptions, token?: CancellationToken): Thenable<string | undefined>;
E
Erich Gamma 已提交
4368 4369 4370 4371

		/**
		 * Shows a selection list.
		 *
J
Johannes Rieken 已提交
4372 4373
		 * @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.
4374
		 * @param token A token that can be used to signal cancellation.
4375
		 * @return A promise that resolves to the selected item or `undefined`.
E
Erich Gamma 已提交
4376
		 */
4377
		export function showQuickPick<T extends QuickPickItem>(items: T[] | Thenable<T[]>, options?: QuickPickOptions, token?: CancellationToken): Thenable<T | undefined>;
E
Erich Gamma 已提交
4378 4379 4380 4381

		/**
		 * Opens an input box to ask the user for input.
		 *
4382
		 * The returned value will be `undefined` if the input box was canceled (e.g. pressing ESC). Otherwise the
A
Andre Weinand 已提交
4383
		 * returned value will be the string typed by the user or an empty string if the user did not type
S
Steven Clarke 已提交
4384
		 * anything but dismissed the input box with OK.
E
Erich Gamma 已提交
4385
		 *
J
Johannes Rieken 已提交
4386
		 * @param options Configures the behavior of the input box.
4387
		 * @param token A token that can be used to signal cancellation.
J
Johannes Rieken 已提交
4388
		 * @return A promise that resolves to a string the user provided or to `undefined` in case of dismissal.
E
Erich Gamma 已提交
4389
		 */
4390
		export function showInputBox(options?: InputBoxOptions, token?: CancellationToken): Thenable<string | undefined>;
E
Erich Gamma 已提交
4391 4392

		/**
J
Johannes Rieken 已提交
4393 4394
		 * Create a new [output channel](#OutputChannel) with the given name.
		 *
4395
		 * @param name Human-readable string which will be used to represent the channel in the UI.
E
Erich Gamma 已提交
4396
		 */
4397
		export function createOutputChannel(name: string): OutputChannel;
E
Erich Gamma 已提交
4398 4399

		/**
S
Steven Clarke 已提交
4400
		 * Set a message to the status bar. This is a short hand for the more powerful
E
Erich Gamma 已提交
4401
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
4402
		 *
G
Gama11 已提交
4403
		 * @param text The message to show, supports icon substitution as in status bar [items](#StatusBarItem.text).
4404
		 * @param hideAfterTimeout Timeout in milliseconds after which the message will be disposed.
J
Johannes Rieken 已提交
4405
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
4406
		 */
4407
		export function setStatusBarMessage(text: string, hideAfterTimeout: number): Disposable;
E
Erich Gamma 已提交
4408 4409

		/**
S
Steven Clarke 已提交
4410
		 * Set a message to the status bar. This is a short hand for the more powerful
J
Johannes Rieken 已提交
4411
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
4412
		 *
G
Gama11 已提交
4413
		 * @param text The message to show, supports icon substitution as in status bar [items](#StatusBarItem.text).
4414
		 * @param hideWhenDone Thenable on which completion (resolve or reject) the message will be disposed.
J
Johannes Rieken 已提交
4415
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
4416
		 */
4417
		export function setStatusBarMessage(text: string, hideWhenDone: Thenable<any>): Disposable;
E
Erich Gamma 已提交
4418 4419

		/**
S
Steven Clarke 已提交
4420
		 * Set a message to the status bar. This is a short hand for the more powerful
J
Johannes Rieken 已提交
4421
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
4422
		 *
4423 4424 4425
		 * *Note* that status bar messages stack and that they must be disposed when no
		 * longer used.
		 *
G
Gama11 已提交
4426
		 * @param text The message to show, supports icon substitution as in status bar [items](#StatusBarItem.text).
J
Johannes Rieken 已提交
4427
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
4428
		 */
4429
		export function setStatusBarMessage(text: string): Disposable;
E
Erich Gamma 已提交
4430

4431
		/**
4432 4433
		 * @deprecated This function **deprecated**. Use `withProgress` instead.
		 *
J
Johannes Rieken 已提交
4434 4435
		 * ~~Show progress in the Source Control viewlet while running the given callback and while
		 * its returned promise isn't resolve or rejected.~~
4436 4437 4438
		 *
		 * @param task A callback returning a promise. Progress increments can be reported with
		 * the provided [progress](#Progress)-object.
J
Johannes Rieken 已提交
4439
		 * @return The thenable the task did rseturn.
4440 4441 4442
		 */
		export function withScmProgress<R>(task: (progress: Progress<number>) => Thenable<R>): Thenable<R>;

J
Johannes Rieken 已提交
4443 4444 4445 4446 4447 4448 4449 4450 4451
		/**
		 * Show progress in the editor. Progress is shown while running the given callback
		 * and while the promise it returned isn't resolved nor rejected. The location at which
		 * progress should show (and other details) is defined via the passed [`ProgressOptions`](#ProgressOptions).
		 *
		 * @param task A callback returning a promise. Progress state can be reported with
		 * the provided [progress](#Progress)-object.
		 * @return The thenable the task-callback returned.
		 */
4452
		export function withProgress<R>(options: ProgressOptions, task: (progress: Progress<{ message?: string; }>) => Thenable<R>): Thenable<R>;
4453

E
Erich Gamma 已提交
4454
		/**
J
Johannes Rieken 已提交
4455 4456
		 * Creates a status bar [item](#StatusBarItem).
		 *
J
Johannes Rieken 已提交
4457
		 * @param alignment The alignment of the item.
J
Johannes Rieken 已提交
4458
		 * @param priority The priority of the item. Higher values mean the item should be shown more to the left.
J
Johannes Rieken 已提交
4459 4460
		 * @return A new status bar item.
		 */
E
Erich Gamma 已提交
4461
		export function createStatusBarItem(alignment?: StatusBarAlignment, priority?: number): StatusBarItem;
D
Daniel Imms 已提交
4462

D
Daniel Imms 已提交
4463
		/**
4464 4465
		 * Creates a [Terminal](#Terminal). The cwd of the terminal will be the workspace directory
		 * if it exists, regardless of whether an explicit customStartPath setting exists.
D
Daniel Imms 已提交
4466
		 *
4467
		 * @param name Optional human-readable string which will be used to represent the terminal in the UI.
4468
		 * @param shellPath Optional path to a custom shell executable to be used in the terminal.
D
Daniel Imms 已提交
4469
		 * @param shellArgs Optional args for the custom shell executable, this does not work on Windows (see #8429)
D
Daniel Imms 已提交
4470 4471
		 * @return A new Terminal.
		 */
P
Pine Wu 已提交
4472
		export function createTerminal(name?: string, shellPath?: string, shellArgs?: string[]): Terminal;
4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484

		/**
		 * Creates a [Terminal](#Terminal). The cwd of the terminal will be the workspace directory
		 * if it exists, regardless of whether an explicit customStartPath setting exists.
		 *
		 * @param options A TerminalOptions object describing the characteristics of the new terminal.
		 * @return A new Terminal.
		 */
		export function createTerminal(options: TerminalOptions): Terminal;
	}

	/**
J
Johannes Rieken 已提交
4485
	 * Value-object describing what options a terminal should use.
4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501
	 */
	export interface TerminalOptions {
		/**
		 * A human-readable string which will be used to represent the terminal in the UI.
		 */
		name?: string;

		/**
		 * A path to a custom shell executable to be used in the terminal.
		 */
		shellPath?: string;

		/**
		 * Args for the custom shell executable, this does not work on Windows (see #8429)
		 */
		shellArgs?: string[];
E
Erich Gamma 已提交
4502 4503
	}

J
Johannes Rieken 已提交
4504 4505 4506 4507 4508 4509 4510
	/**
	 * A location in the editor at which progress information can be shown. It depends on the
	 * location how progress is visually represented.
	 */
	export enum ProgressLocation {

		/**
4511
		 * Show progress for the source control viewlet, as overlay for the icon and as progress bar
J
Johannes Rieken 已提交
4512 4513
		 * inside the viewlet (when visible).
		 */
4514
		SourceControl = 1,
J
Johannes Rieken 已提交
4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538

		/**
		 * Show progress in the status bar of the editor.
		 */
		Window = 10
	}

	/**
	 * Value-object describing where and how progress should show.
	 */
	export interface ProgressOptions {

		/**
		 * The location at which progress should show.
		 */
		location: ProgressLocation;

		/**
		 * A human-readable string which will be used to describe the
		 * operation.
		 */
		title?: string;
	}

E
Erich Gamma 已提交
4539
	/**
A
Alex Dima 已提交
4540
	 * An event describing an individual change in the text of a [document](#TextDocument).
E
Erich Gamma 已提交
4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557
	 */
	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 已提交
4558
	 * An event describing a transactional [document](#TextDocument) change.
E
Erich Gamma 已提交
4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572
	 */
	export interface TextDocumentChangeEvent {

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

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

4573 4574 4575 4576 4577 4578
	/**
	 * Represents reasons why a text document is saved.
	 */
	export enum TextDocumentSaveReason {

		/**
4579 4580
		 * Manually triggered, e.g. by the user pressing save, by starting debugging,
		 * or by an API call.
4581
		 */
4582
		Manual = 1,
4583 4584 4585 4586

		/**
		 * Automatic after a delay.
		 */
4587
		AfterDelay = 2,
4588 4589 4590 4591 4592 4593 4594

		/**
		 * When the editor lost focus.
		 */
		FocusOut = 3
	}

4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606
	/**
	 * An event that is fired when a [document](#TextDocument) will be saved.
	 *
	 * To make modifications to the document before it is being saved, call the
	 * [`waitUntil`](#TextDocumentWillSaveEvent.waitUntil)-function with a thenable
	 * that resolves to an array of [text edits](#TextEdit).
	 */
	export interface TextDocumentWillSaveEvent {

		/**
		 * The document that will be saved.
		 */
4607
		document: TextDocument;
4608

4609 4610 4611 4612 4613
		/**
		 * The reason why save was triggered.
		 */
		reason: TextDocumentSaveReason;

4614 4615 4616 4617 4618 4619 4620 4621 4622 4623
		/**
		 * Allows to pause the event loop and to apply [pre-save-edits](#TextEdit).
		 * Edits of subsequent calls to this function will be applied in order. The
		 * edits will be *ignored* if concurrent modifications of the document happened.
		 *
		 * *Note:* This function can only be called during event dispatch and not
		 * in an asynchronous manner:
		 *
		 * ```ts
		 * workspace.onWillSaveTextDocument(event => {
4624 4625 4626 4627 4628
		 * 	// async, will *throw* an error
		 * 	setTimeout(() => event.waitUntil(promise));
		 *
		 * 	// sync, OK
		 * 	event.waitUntil(promise);
4629 4630 4631 4632 4633
		 * })
		 * ```
		 *
		 * @param thenable A thenable that resolves to [pre-save-edits](#TextEdit).
		 */
4634
		waitUntil(thenable: Thenable<TextEdit[]>): void;
4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645

		/**
		 * Allows to pause the event loop until the provided thenable resolved.
		 *
		 * *Note:* This function can only be called during event dispatch.
		 *
		 * @param thenable A thenable that delays saving.
		 */
		waitUntil(thenable: Thenable<any>): void;
	}

E
Erich Gamma 已提交
4646
	/**
4647 4648 4649 4650 4651
	 * 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
4652
	 * events and for [finding](#workspace.findFiles) files. Both perform well and run _outside_
S
Steven Clarke 已提交
4653
	 * the editor-process so that they should be always used instead of nodejs-equivalents.
E
Erich Gamma 已提交
4654 4655 4656 4657
	 */
	export namespace workspace {

		/**
J
Johannes Rieken 已提交
4658 4659 4660
		 * Creates a file system watcher.
		 *
		 * A glob pattern that filters the file events must be provided. Optionally, flags to ignore certain
S
Steven Clarke 已提交
4661
		 * kinds of events can be provided. To stop listening to events the watcher must be disposed.
E
Erich Gamma 已提交
4662
		 *
A
Andre Weinand 已提交
4663
		 * @param globPattern A glob pattern that is applied to the names of created, changed, and deleted files.
J
Johannes Rieken 已提交
4664 4665 4666 4667
		 * @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 已提交
4668 4669 4670 4671
		 */
		export function createFileSystemWatcher(globPattern: string, ignoreCreateEvents?: boolean, ignoreChangeEvents?: boolean, ignoreDeleteEvents?: boolean): FileSystemWatcher;

		/**
J
Johannes Rieken 已提交
4672 4673
		 * The folder that is open in VS Code. `undefined` when no folder
		 * has been opened.
Y
Yuki Ueda 已提交
4674 4675
		 *
		 * @readonly
E
Erich Gamma 已提交
4676
		 */
4677
		export let rootPath: string | undefined;
E
Erich Gamma 已提交
4678 4679

		/**
J
Johannes Rieken 已提交
4680 4681 4682 4683 4684 4685 4686
		 * 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 已提交
4687 4688 4689
		 */
		export function asRelativePath(pathOrUri: string | Uri): string;

J
Johannes Rieken 已提交
4690 4691 4692
		/**
		 * Find files in the workspace.
		 *
4693
		 * @sample `findFiles('**∕*.js', '**∕node_modules∕**', 10)`
J
Johannes Rieken 已提交
4694
		 * @param include A glob pattern that defines the files to search for.
S
Steven Clarke 已提交
4695
		 * @param exclude A glob pattern that defines files and folders to exclude.
J
Johannes Rieken 已提交
4696
		 * @param maxResults An upper-bound for the result.
4697
		 * @param token A token that can be used to signal cancellation to the underlying search engine.
J
Johannes Rieken 已提交
4698 4699
		 * @return A thenable that resolves to an array of resource identifiers.
		 */
4700
		export function findFiles(include: string, exclude?: string, maxResults?: number, token?: CancellationToken): Thenable<Uri[]>;
E
Erich Gamma 已提交
4701 4702

		/**
J
Johannes Rieken 已提交
4703 4704 4705
		 * Save all dirty files.
		 *
		 * @param includeUntitled Also save files that have been created during this session.
S
Steven Clarke 已提交
4706
		 * @return A thenable that resolves when the files have been saved.
E
Erich Gamma 已提交
4707 4708 4709 4710
		 */
		export function saveAll(includeUntitled?: boolean): Thenable<boolean>;

		/**
J
Johannes Rieken 已提交
4711 4712 4713
		 * Make changes to one or many resources as defined by the given
		 * [workspace edit](#WorkspaceEdit).
		 *
S
Steven Clarke 已提交
4714 4715 4716
		 * 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 已提交
4717 4718 4719
		 *
		 * @param edit A workspace edit.
		 * @return A thenable that resolves when the edit could be applied.
E
Erich Gamma 已提交
4720 4721 4722 4723 4724
		 */
		export function applyEdit(edit: WorkspaceEdit): Thenable<boolean>;

		/**
		 * All text documents currently known to the system.
J
Johannes Rieken 已提交
4725 4726
		 *
		 * @readonly
E
Erich Gamma 已提交
4727 4728 4729 4730
		 */
		export let textDocuments: TextDocument[];

		/**
4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742
		 * Opens a document. Will return early if this document is already open. Otherwise
		 * the document is loaded and the [didOpen](#workspace.onDidOpenTextDocument)-event fires.
		 *
		 * The document is denoted by an [uri](#Uri). Depending on the [scheme](#Uri.scheme) the
		 * following rules apply:
		 * * `file`-scheme: Open a file on disk, will be rejected if the file does not exist or cannot be loaded.
		 * * `untitled`-scheme: 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.
		 * * For all other schemes the registered text document content [providers](#TextDocumentContentProvider) are consulted.
		 *
		 * *Note* that the lifecycle of the returned document is owned by the editor and not by the extension. That means an
		 * [`onDidClose`](#workspace.onDidCloseTextDocument)-event can occur at any time after opening it.
E
Erich Gamma 已提交
4743 4744 4745 4746 4747 4748 4749
		 *
		 * @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 已提交
4750 4751 4752
		 * A short-hand for `openTextDocument(Uri.file(fileName))`.
		 *
		 * @see [openTextDocument](#openTextDocument)
A
Andre Weinand 已提交
4753 4754
		 * @param fileName A name of a file on disk.
		 * @return A promise that resolves to a [document](#TextDocument).
E
Erich Gamma 已提交
4755 4756 4757
		 */
		export function openTextDocument(fileName: string): Thenable<TextDocument>;

B
Benjamin Pasero 已提交
4758
		/**
J
Johannes Rieken 已提交
4759 4760
		 * Opens an untitled text document. The editor will prompt the user for a file
		 * path when the document is to be saved. The `options` parameter allows to
4761
		 * specify the *language* and/or the *content* of the document.
B
Benjamin Pasero 已提交
4762
		 *
J
Johannes Rieken 已提交
4763
		 * @param options Options to control how the document will be created.
B
Benjamin Pasero 已提交
4764 4765
		 * @return A promise that resolves to a [document](#TextDocument).
		 */
4766
		export function openTextDocument(options?: { language?: string; content?: string; }): Thenable<TextDocument>;
B
Benjamin Pasero 已提交
4767

J
Johannes Rieken 已提交
4768
		/**
4769 4770 4771
		 * Register a text document content provider.
		 *
		 * Only one provider can be registered per scheme.
J
Johannes Rieken 已提交
4772
		 *
4773 4774 4775
		 * @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 已提交
4776 4777 4778
		 */
		export function registerTextDocumentContentProvider(scheme: string, provider: TextDocumentContentProvider): Disposable;

A
Alex Dima 已提交
4779
		/**
J
Johannes Rieken 已提交
4780
		 * An event that is emitted when a [text document](#TextDocument) is opened.
A
Alex Dima 已提交
4781
		 */
E
Erich Gamma 已提交
4782 4783
		export const onDidOpenTextDocument: Event<TextDocument>;

A
Alex Dima 已提交
4784 4785 4786
		/**
		 * An event that is emitted when a [text document](#TextDocument) is disposed.
		 */
E
Erich Gamma 已提交
4787 4788
		export const onDidCloseTextDocument: Event<TextDocument>;

A
Alex Dima 已提交
4789 4790 4791
		/**
		 * An event that is emitted when a [text document](#TextDocument) is changed.
		 */
E
Erich Gamma 已提交
4792 4793
		export const onDidChangeTextDocument: Event<TextDocumentChangeEvent>;

4794 4795
		/**
		 * An event that is emitted when a [text document](#TextDocument) will be saved to disk.
4796
		 *
J
Johannes Rieken 已提交
4797
		 * *Note 1:* Subscribers can delay saving by registering asynchronous work. For the sake of data integrity the editor
4798 4799 4800 4801 4802 4803 4804 4805
		 * might save without firing this event. For instance when shutting down with dirty files.
		 *
		 * *Note 2:* Subscribers are called sequentially and they can [delay](#TextDocumentWillSaveEvent.waitUntil) saving
		 * by registering asynchronous work. Protection against misbehaving listeners is implemented as such:
		 *  * there is an overall time budget that all listeners share and if that is exhausted no further listener is called
		 *  * listeners that take a long time or produce errors frequently will not be called anymore
		 *
		 * The current thresholds are 1.5 seconds as overall time budget and a listener can misbehave 3 times before being ignored.
4806 4807 4808
		 */
		export const onWillSaveTextDocument: Event<TextDocumentWillSaveEvent>;

A
Alex Dima 已提交
4809 4810 4811
		/**
		 * An event that is emitted when a [text document](#TextDocument) is saved to disk.
		 */
E
Erich Gamma 已提交
4812 4813 4814
		export const onDidSaveTextDocument: Event<TextDocument>;

		/**
J
Johannes Rieken 已提交
4815 4816 4817
		 * Get a configuration object.
		 *
		 * When a section-identifier is provided only that part of the configuration
A
Andre Weinand 已提交
4818
		 * is returned. Dots in the section-identifier are interpreted as child-access,
J
Johannes Rieken 已提交
4819
		 * like `{ myExt: { setting: { doIt: true }}}` and `getConfiguration('myExt.setting').get('doIt') === true`.
J
Johannes Rieken 已提交
4820 4821 4822
		 *
		 * @param section A dot-separated identifier.
		 * @return The full workspace configuration or a subset.
E
Erich Gamma 已提交
4823 4824 4825
		 */
		export function getConfiguration(section?: string): WorkspaceConfiguration;

J
Johannes Rieken 已提交
4826 4827 4828
		/**
		 * An event that is emitted when the [configuration](#WorkspaceConfiguration) changed.
		 */
E
Erich Gamma 已提交
4829 4830 4831
		export const onDidChangeConfiguration: Event<void>;
	}

J
Johannes Rieken 已提交
4832
	/**
4833 4834 4835 4836 4837 4838 4839
	 * 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 已提交
4840
	 * The editor provides an API that makes it simple to provide such common features by having all UI and actions already in place and
4841 4842 4843 4844 4845 4846
	 * 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', {
4847 4848 4849
	 * 	provideHover(document, position, token) {
	 * 		return new Hover('I am a hover!');
	 * 	}
4850 4851
	 * });
	 * ```
4852 4853 4854
	 *
	 * 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 已提交
4855
	 * a selector will result in a [score](#languages.match) that is used to determine if and how a provider shall be used. When
4856 4857 4858
	 * 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 已提交
4859
	 */
E
Erich Gamma 已提交
4860 4861 4862 4863 4864 4865 4866 4867 4868
	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 已提交
4869
		 * Compute the match between a document [selector](#DocumentSelector) and a document. Values
4870 4871 4872
		 * greater than zero mean the selector matches the document.
		 *
		 * A match is computed according to these rules:
4873 4874
		 * 1. When [`DocumentSelector`](#DocumentSelector) is an array, compute the match for each contained `DocumentFilter` or language identifier and take the maximum value.
		 * 2. A string will be desugared to become the `language`-part of a [`DocumentFilter`](#DocumentFilter), so `"fooLang"` is like `{ language: "fooLang" }`.
4875 4876
		 * 3. A [`DocumentFilter`](#DocumentFilter) will be matched against the document by comparing its parts with the document. The following rules apply:
		 *  1. When the `DocumentFilter` is empty (`{}`) the result is `0`
4877 4878 4879
		 *  2. When `scheme`, `language`, or `pattern` are defined but one doesn’t match, the result is `0`
		 *  3. Matching against `*` gives a score of `5`, matching via equality or via a glob-pattern gives a score of `10`
		 *  4. The result is the maximun value of each match
4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895
		 *
		 * Samples:
		 * ```js
		 * // default document from disk (file-scheme)
		 * doc.uri; //'file:///my/file.js'
		 * doc.languageId; // 'javascript'
		 * match('javascript', doc); // 10;
		 * match({language: 'javascript'}, doc); // 10;
		 * match({language: 'javascript', scheme: 'file'}, doc); // 10;
		 * match('*', doc); // 5
		 * match('fooLang', doc); // 0
		 * match(['fooLang', '*'], doc); // 5
		 *
		 * // virtual document, e.g. from git-index
		 * doc.uri; // 'git:/my/file.js'
		 * doc.languageId; // 'javascript'
4896
		 * match('javascript', doc); // 10;
4897 4898
		 * match({language: 'javascript', scheme: 'git'}, doc); // 10;
		 * match('*', doc); // 5
4899
		 * ```
J
Johannes Rieken 已提交
4900 4901 4902
		 *
		 * @param selector A document selector.
		 * @param document A text document.
J
Johannes Rieken 已提交
4903
		 * @return A number `>0` when the selector matches and `0` when the selector does not match.
E
Erich Gamma 已提交
4904 4905 4906 4907
		 */
		export function match(selector: DocumentSelector, document: TextDocument): number;

		/**
S
Steven Clarke 已提交
4908
		 * Create a diagnostics collection.
J
Johannes Rieken 已提交
4909 4910 4911
		 *
		 * @param name The [name](#DiagnosticCollection.name) of the collection.
		 * @return A new diagnostic collection.
E
Erich Gamma 已提交
4912 4913 4914 4915
		 */
		export function createDiagnosticCollection(name?: string): DiagnosticCollection;

		/**
J
Johannes Rieken 已提交
4916 4917 4918
		 * Register a completion provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
4919
		 * by their [score](#languages.match) and groups of equal score are sequentially asked for
J
Johannes Rieken 已提交
4920
		 * completion items. The process stops when one or many providers of a group return a
4921 4922
		 * result. A failing provider (rejected promise or exception) will not fail the whole
		 * operation.
E
Erich Gamma 已提交
4923
		 *
J
Johannes Rieken 已提交
4924 4925 4926 4927 4928 4929 4930 4931
		 * @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 已提交
4932 4933 4934
		 * Register a code action provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
4935 4936
		 * 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 已提交
4937 4938
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
J
Johannes Rieken 已提交
4939
		 * @param provider A code action provider.
J
Johannes Rieken 已提交
4940
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
4941
		 */
J
Johannes Rieken 已提交
4942
		export function registerCodeActionsProvider(selector: DocumentSelector, provider: CodeActionProvider): Disposable;
E
Erich Gamma 已提交
4943 4944

		/**
J
Johannes Rieken 已提交
4945 4946 4947
		 * Register a code lens provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
4948 4949
		 * 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 已提交
4950
		 *
J
Johannes Rieken 已提交
4951 4952 4953
		 * @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 已提交
4954
		 */
J
Johannes Rieken 已提交
4955
		export function registerCodeLensProvider(selector: DocumentSelector, provider: CodeLensProvider): Disposable;
E
Erich Gamma 已提交
4956 4957

		/**
J
Johannes Rieken 已提交
4958 4959 4960
		 * Register a definition provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
4961 4962
		 * 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 已提交
4963
		 *
J
Johannes Rieken 已提交
4964 4965 4966
		 * @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 已提交
4967 4968 4969
		 */
		export function registerDefinitionProvider(selector: DocumentSelector, provider: DefinitionProvider): Disposable;

4970
		/**
4971
		 * Register an implementation provider.
4972
		 *
4973 4974 4975
		 * Multiple providers can be registered for a language. In that case providers are asked in
		 * parallel and the results are merged. A failing provider (rejected promise or exception) will
		 * not cause a failure of the whole operation.
4976 4977 4978 4979 4980
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider An implementation provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
M
Matt Bierner 已提交
4981
		export function registerImplementationProvider(selector: DocumentSelector, provider: ImplementationProvider): Disposable;
4982

4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995
		/**
		 * Register a type definition provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
		 * parallel and the results are merged. A failing provider (rejected promise or exception) will
		 * not cause a failure of the whole operation.
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A type definition provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerTypeDefinitionProvider(selector: DocumentSelector, provider: TypeDefinitionProvider): Disposable;

E
Erich Gamma 已提交
4996
		/**
J
Johannes Rieken 已提交
4997 4998 4999
		 * Register a hover provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
5000 5001
		 * 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 已提交
5002
		 *
J
Johannes Rieken 已提交
5003 5004 5005
		 * @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 已提交
5006 5007 5008 5009
		 */
		export function registerHoverProvider(selector: DocumentSelector, provider: HoverProvider): Disposable;

		/**
J
Johannes Rieken 已提交
5010 5011 5012 5013
		 * 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.
5014
		 * The process stops when a provider returns a `non-falsy` or `non-failure` result.
E
Erich Gamma 已提交
5015
		 *
J
Johannes Rieken 已提交
5016 5017 5018
		 * @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 已提交
5019 5020 5021 5022
		 */
		export function registerDocumentHighlightProvider(selector: DocumentSelector, provider: DocumentHighlightProvider): Disposable;

		/**
J
Johannes Rieken 已提交
5023 5024 5025
		 * Register a document symbol provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
5026 5027
		 * 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 已提交
5028
		 *
J
Johannes Rieken 已提交
5029 5030 5031
		 * @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 已提交
5032 5033 5034 5035
		 */
		export function registerDocumentSymbolProvider(selector: DocumentSelector, provider: DocumentSymbolProvider): Disposable;

		/**
J
Johannes Rieken 已提交
5036 5037
		 * Register a workspace symbol provider.
		 *
5038 5039 5040
		 * Multiple providers can be registered. In that case providers are asked in 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 已提交
5041
		 *
J
Johannes Rieken 已提交
5042 5043
		 * @param provider A workspace symbol provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
5044 5045 5046 5047
		 */
		export function registerWorkspaceSymbolProvider(provider: WorkspaceSymbolProvider): Disposable;

		/**
J
Johannes Rieken 已提交
5048 5049 5050
		 * Register a reference provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
5051 5052
		 * 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 已提交
5053
		 *
J
Johannes Rieken 已提交
5054 5055 5056
		 * @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 已提交
5057 5058 5059 5060
		 */
		export function registerReferenceProvider(selector: DocumentSelector, provider: ReferenceProvider): Disposable;

		/**
J
Johannes Rieken 已提交
5061 5062 5063
		 * Register a reference provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
5064
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
5065
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
5066
		 *
J
Johannes Rieken 已提交
5067 5068 5069
		 * @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 已提交
5070 5071 5072 5073
		 */
		export function registerRenameProvider(selector: DocumentSelector, provider: RenameProvider): Disposable;

		/**
A
Andre Weinand 已提交
5074
		 * Register a formatting provider for a document.
J
Johannes Rieken 已提交
5075 5076
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
5077
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
5078
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
5079
		 *
J
Johannes Rieken 已提交
5080 5081 5082
		 * @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 已提交
5083 5084 5085 5086
		 */
		export function registerDocumentFormattingEditProvider(selector: DocumentSelector, provider: DocumentFormattingEditProvider): Disposable;

		/**
J
Johannes Rieken 已提交
5087 5088
		 * Register a formatting provider for a document range.
		 *
5089 5090 5091 5092
		 * *Note:* A document range provider is also a [document formatter](#DocumentFormattingEditProvider)
		 * which means there is no need to [register](registerDocumentFormattingEditProvider) a document
		 * formatter when also registering a range provider.
		 *
J
Johannes Rieken 已提交
5093
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
5094
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
5095
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
5096
		 *
J
Johannes Rieken 已提交
5097 5098 5099
		 * @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 已提交
5100 5101 5102 5103
		 */
		export function registerDocumentRangeFormattingEditProvider(selector: DocumentSelector, provider: DocumentRangeFormattingEditProvider): Disposable;

		/**
E
Erich Gamma 已提交
5104
		 * Register a formatting provider that works on type. The provider is active when the user enables the setting `editor.formatOnType`.
J
Johannes Rieken 已提交
5105 5106
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
5107
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
5108
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
5109
		 *
J
Johannes Rieken 已提交
5110 5111 5112
		 * @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 已提交
5113
		 * @param moreTriggerCharacter More trigger characters.
J
Johannes Rieken 已提交
5114
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
5115 5116 5117 5118
		 */
		export function registerOnTypeFormattingEditProvider(selector: DocumentSelector, provider: OnTypeFormattingEditProvider, firstTriggerCharacter: string, ...moreTriggerCharacter: string[]): Disposable;

		/**
J
Johannes Rieken 已提交
5119 5120 5121
		 * Register a signature help provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
5122 5123
		 * by their [score](#languages.match) and called sequentially until a provider returns a
		 * valid result.
E
Erich Gamma 已提交
5124
		 *
J
Johannes Rieken 已提交
5125 5126 5127 5128
		 * @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 已提交
5129 5130 5131
		 */
		export function registerSignatureHelpProvider(selector: DocumentSelector, provider: SignatureHelpProvider, ...triggerCharacters: string[]): Disposable;

J
Johannes Rieken 已提交
5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144
		/**
		 * Register a document link provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
		 * parallel and the results are merged. A failing provider (rejected promise or exception) will
		 * not cause a failure of the whole operation.
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A document link provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerDocumentLinkProvider(selector: DocumentSelector, provider: DocumentLinkProvider): Disposable;

E
Erich Gamma 已提交
5145
		/**
J
Johannes Rieken 已提交
5146
		 * Set a [language configuration](#LanguageConfiguration) for a language.
E
Erich Gamma 已提交
5147
		 *
A
Andre Weinand 已提交
5148
		 * @param language A language identifier like `typescript`.
J
Johannes Rieken 已提交
5149 5150
		 * @param configuration Language configuration.
		 * @return A [disposable](#Disposable) that unsets this configuration.
E
Erich Gamma 已提交
5151 5152 5153 5154
		 */
		export function setLanguageConfiguration(language: string, configuration: LanguageConfiguration): Disposable;
	}

J
Joao Moreno 已提交
5155
	/**
J
Joao Moreno 已提交
5156
	 * Represents the input box in the Source Control viewlet.
J
Joao Moreno 已提交
5157
	 */
J
Joao Moreno 已提交
5158
	export interface SourceControlInputBox {
J
Joao Moreno 已提交
5159 5160

		/**
J
Joao Moreno 已提交
5161
		 * Setter and getter for the contents of the input box.
J
Joao Moreno 已提交
5162
		 */
J
Joao Moreno 已提交
5163
		value: string;
J
Joao Moreno 已提交
5164 5165
	}

J
Joao Moreno 已提交
5166
	interface QuickDiffProvider {
J
Joao Moreno 已提交
5167 5168

		/**
J
Joao Moreno 已提交
5169 5170 5171 5172 5173
		 * Provide a [uri](#Uri) to the original resource of any given resource uri.
		 *
		 * @param uri The uri of the resource open in a text editor.
		 * @param token A cancellation token.
		 * @return A thenable that resolves to uri of the matching original resource.
J
Joao Moreno 已提交
5174
		 */
J
Joao Moreno 已提交
5175 5176
		provideOriginalResource?(uri: Uri, token: CancellationToken): ProviderResult<Uri>;
	}
J
Joao Moreno 已提交
5177

J
Joao Moreno 已提交
5178 5179 5180 5181 5182
	/**
	 * The theme-aware decorations for a
	 * [source control resource state](#SourceControlResourceState).
	 */
	export interface SourceControlResourceThemableDecorations {
J
Joao Moreno 已提交
5183 5184

		/**
J
Joao Moreno 已提交
5185 5186
		 * The icon path for a specific
		 * [source control resource state](#SourceControlResourceState).
J
Joao Moreno 已提交
5187
		 */
J
Joao Moreno 已提交
5188
		readonly iconPath?: string | Uri;
J
Joao Moreno 已提交
5189 5190 5191
	}

	/**
J
Joao Moreno 已提交
5192 5193
	 * The decorations for a [source control resource state](#SourceControlResourceState).
	 * Can be independently specified for light and dark themes.
J
Joao Moreno 已提交
5194
	 */
J
Joao Moreno 已提交
5195
	export interface SourceControlResourceDecorations extends SourceControlResourceThemableDecorations {
J
Joao Moreno 已提交
5196 5197

		/**
J
Joao Moreno 已提交
5198 5199
		 * Whether the [source control resource state](#SourceControlResourceState) should
		 * be striked-through in the UI.
J
Joao Moreno 已提交
5200
		 */
J
Joao Moreno 已提交
5201
		readonly strikeThrough?: boolean;
J
Joao Moreno 已提交
5202

5203 5204
		/**
		 * Whether the [source control resource state](#SourceControlResourceState) should
I
Ilie Halip 已提交
5205
		 * be faded in the UI.
5206 5207 5208
		 */
		readonly faded?: boolean;

J
Joao Moreno 已提交
5209
		/**
J
Joao Moreno 已提交
5210
		 * The light theme decorations.
J
Joao Moreno 已提交
5211
		 */
J
Joao Moreno 已提交
5212
		readonly light?: SourceControlResourceThemableDecorations;
J
Joao Moreno 已提交
5213 5214

		/**
J
Joao Moreno 已提交
5215
		 * The dark theme decorations.
J
Joao Moreno 已提交
5216
		 */
J
Joao Moreno 已提交
5217
		readonly dark?: SourceControlResourceThemableDecorations;
J
Joao Moreno 已提交
5218 5219 5220
	}

	/**
J
Joao Moreno 已提交
5221 5222
	 * An source control resource state represents the state of an underlying workspace
	 * resource within a certain [source control group](#SourceControlResourceGroup).
J
Joao Moreno 已提交
5223
	 */
J
Joao Moreno 已提交
5224
	export interface SourceControlResourceState {
J
Joao Moreno 已提交
5225 5226

		/**
J
Joao Moreno 已提交
5227
		 * The [uri](#Uri) of the underlying resource inside the workspace.
J
Joao Moreno 已提交
5228
		 */
J
Joao Moreno 已提交
5229
		readonly resourceUri: Uri;
J
Joao Moreno 已提交
5230 5231

		/**
J
Joao Moreno 已提交
5232 5233
		 * The [command](#Command) which should be run when the resource
		 * state is open in the Source Control viewlet.
J
Joao Moreno 已提交
5234
		 */
5235
		readonly command?: Command;
J
Joao Moreno 已提交
5236 5237

		/**
J
Joao Moreno 已提交
5238 5239
		 * The [decorations](#SourceControlResourceDecorations) for this source control
		 * resource state.
J
Joao Moreno 已提交
5240
		 */
J
Joao Moreno 已提交
5241
		readonly decorations?: SourceControlResourceDecorations;
J
Joao Moreno 已提交
5242 5243 5244
	}

	/**
J
Joao Moreno 已提交
5245 5246
	 * A source control resource group is a collection of
	 * [source control resource states](#SourceControlResourceState).
J
Joao Moreno 已提交
5247
	 */
J
Joao Moreno 已提交
5248 5249 5250 5251 5252 5253
	export interface SourceControlResourceGroup {

		/**
		 * The id of this source control resource group.
		 */
		readonly id: string;
J
Joao Moreno 已提交
5254 5255

		/**
J
Joao Moreno 已提交
5256
		 * The label of this source control resource group.
J
Joao Moreno 已提交
5257
		 */
5258
		label: string;
J
Joao Moreno 已提交
5259 5260

		/**
J
Joao Moreno 已提交
5261 5262
		 * Whether this source control resource group is hidden when it contains
		 * no [source control resource states](#SourceControlResourceState).
J
Joao Moreno 已提交
5263
		 */
J
Joao Moreno 已提交
5264
		hideWhenEmpty?: boolean;
J
Joao Moreno 已提交
5265 5266

		/**
J
Joao Moreno 已提交
5267 5268
		 * This group's collection of
		 * [source control resource states](#SourceControlResourceState).
J
Joao Moreno 已提交
5269
		 */
J
Joao Moreno 已提交
5270
		resourceStates: SourceControlResourceState[];
J
Joao Moreno 已提交
5271 5272

		/**
J
Joao Moreno 已提交
5273
		 * Dispose this source control resource group.
J
Joao Moreno 已提交
5274
		 */
J
Joao Moreno 已提交
5275 5276 5277 5278 5279 5280 5281 5282
		dispose(): void;
	}

	/**
	 * An source control is able to provide [resource states](#SourceControlResourceState)
	 * to the editor and interact with the editor in several source control related ways.
	 */
	export interface SourceControl {
J
Joao Moreno 已提交
5283 5284

		/**
J
Joao Moreno 已提交
5285
		 * The id of this source control.
J
Joao Moreno 已提交
5286
		 */
J
Joao Moreno 已提交
5287
		readonly id: string;
J
Joao Moreno 已提交
5288 5289

		/**
J
Joao Moreno 已提交
5290
		 * The human-readable label of this source control.
J
Joao Moreno 已提交
5291
		 */
J
Joao Moreno 已提交
5292
		readonly label: string;
J
Joao Moreno 已提交
5293 5294

		/**
J
Joao Moreno 已提交
5295 5296
		 * The UI-visible count of [resource states](#SourceControlResourceState) of
		 * this source control.
J
Joao Moreno 已提交
5297
		 *
J
Joao Moreno 已提交
5298 5299
		 * Equals to the total number of [resource state](#SourceControlResourceState)
		 * of this source control, if undefined.
J
Joao Moreno 已提交
5300
		 */
J
Joao Moreno 已提交
5301
		count?: number;
J
Joao Moreno 已提交
5302 5303

		/**
J
Joao Moreno 已提交
5304
		 * An optional [quick diff provider](#QuickDiffProvider).
J
Joao Moreno 已提交
5305
		 */
J
Joao Moreno 已提交
5306
		quickDiffProvider?: QuickDiffProvider;
J
Joao Moreno 已提交
5307

J
Joao Moreno 已提交
5308
		/**
5309 5310 5311 5312
		 * Optional commit template string.
		 *
		 * The Source Control viewlet will populate the Source Control
		 * input with this value when appropriate.
J
Joao Moreno 已提交
5313
		 */
5314
		commitTemplate?: string;
J
Joao Moreno 已提交
5315 5316

		/**
5317 5318 5319 5320
		 * Optional accept input command.
		 *
		 * This command will be invoked when the user accepts the value
		 * in the Source Control input.
J
Joao Moreno 已提交
5321
		 */
5322
		acceptInputCommand?: Command;
J
Joao Moreno 已提交
5323 5324

		/**
5325 5326 5327
		 * Optional status bar commands.
		 *
		 * These commands will be displayed in the editor's status bar.
J
Joao Moreno 已提交
5328
		 */
5329
		statusBarCommands?: Command[];
J
Joao Moreno 已提交
5330 5331

		/**
5332
		 * Create a new [resource group](#SourceControlResourceGroup).
J
Joao Moreno 已提交
5333
		 */
5334
		createResourceGroup(id: string, label: string): SourceControlResourceGroup;
J
Joao Moreno 已提交
5335 5336

		/**
5337
		 * Dispose this source control.
J
Joao Moreno 已提交
5338
		 */
5339 5340 5341 5342
		dispose(): void;
	}

	export namespace scm {
J
Joao Moreno 已提交
5343 5344

		/**
5345
		 * The [input box](#SourceControlInputBox) in the Source Control viewlet.
J
Joao Moreno 已提交
5346
		 */
5347
		export const inputBox: SourceControlInputBox;
J
Joao Moreno 已提交
5348 5349

		/**
J
Joao Moreno 已提交
5350
		 * Creates a new [source control](#SourceControl) instance.
J
Joao Moreno 已提交
5351
		 *
J
Joao Moreno 已提交
5352 5353 5354
		 * @param id A unique `id` for the source control. Something short, eg: `git`.
		 * @param label A human-readable string for the source control. Eg: `Git`.
		 * @return An instance of [source control](#SourceControl).
J
Joao Moreno 已提交
5355
		 */
J
Joao Moreno 已提交
5356
		export function createSourceControl(id: string, label: string): SourceControl;
J
Joao Moreno 已提交
5357 5358
	}

J
Johannes Rieken 已提交
5359
	/**
5360 5361 5362
	 * Namespace for dealing with installed extensions. Extensions are represented
	 * by an [extension](#Extension)-interface which allows to reflect on them.
	 *
S
Steven Clarke 已提交
5363
	 * Extension writers can provide APIs to other extensions by returning their API public
5364 5365 5366 5367
	 * surface from the `activate`-call.
	 *
	 * ```javascript
	 * export function activate(context: vscode.ExtensionContext) {
5368 5369 5370 5371 5372 5373 5374 5375 5376 5377
	 * 	let api = {
	 * 		sum(a, b) {
	 * 			return a + b;
	 * 		},
	 * 		mul(a, b) {
	 * 			return a * b;
	 * 		}
	 * 	};
	 * 	// 'export' public api-surface
	 * 	return api;
5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389
	 * }
	 * ```
	 * 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 已提交
5390
	 */
E
Erich Gamma 已提交
5391 5392
	export namespace extensions {

J
Johannes Rieken 已提交
5393
		/**
5394
		 * Get an extension by its full identifier in the form of: `publisher.name`.
J
Johannes Rieken 已提交
5395
		 *
J
Johannes Rieken 已提交
5396
		 * @param extensionId An extension identifier.
J
Johannes Rieken 已提交
5397 5398
		 * @return An extension or `undefined`.
		 */
5399
		export function getExtension(extensionId: string): Extension<any> | undefined;
E
Erich Gamma 已提交
5400

J
Johannes Rieken 已提交
5401
		/**
A
Andre Weinand 已提交
5402
		 * Get an extension its full identifier in the form of: `publisher.name`.
J
Johannes Rieken 已提交
5403 5404 5405
		 *
		 * @param extensionId An extension identifier.
		 * @return An extension or `undefined`.
J
Johannes Rieken 已提交
5406
		 */
5407
		export function getExtension<T>(extensionId: string): Extension<T> | undefined;
E
Erich Gamma 已提交
5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419

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

/**
 * 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 已提交
5420
 * we recommend the use of native promises which are available in VS Code.
E
Erich Gamma 已提交
5421
 */
5422
interface Thenable<T> {
E
Erich Gamma 已提交
5423 5424 5425 5426 5427 5428
	/**
	* 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.
	*/
5429 5430
	then<TResult>(onfulfilled?: (value: T) => TResult | Thenable<TResult>, onrejected?: (reason: any) => TResult | Thenable<TResult>): Thenable<TResult>;
	then<TResult>(onfulfilled?: (value: T) => TResult | Thenable<TResult>, onrejected?: (reason: any) => void): Thenable<TResult>;
E
Erich Gamma 已提交
5431
}