vscode.d.ts 191.6 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
		 * [word definitions](#LanguageConfiguration.wordPattern) can be defined. It
204 205 206 207 208 209 210
		 * is also possible to provide a custom regular expression.
		 *
		 * * *Note 1:* A custom regular expression must not match the empty string and
		 * if it does, it will be ignored.
		 * * *Note 2:* A custom regular expression will fail to match multiline strings
		 * and in the name of speed regular expressions should not match words with
		 * spaces. Use [`TextLine.text`](#TextLine.text) for more complex, non-wordy, scenarios.
J
Johannes Rieken 已提交
211
		 *
A
Alex Dima 已提交
212 213
		 * The position will be [adjusted](#TextDocument.validatePosition).
		 *
J
Johannes Rieken 已提交
214
		 * @param position A position.
215
		 * @param regex Optional regular expression that describes what a word is.
J
Johannes Rieken 已提交
216
		 * @return A range spanning a word, or `undefined`.
E
Erich Gamma 已提交
217
		 */
218
		getWordRangeAtPosition(position: Position, regex?: RegExp): Range | undefined;
E
Erich Gamma 已提交
219 220

		/**
J
Johannes Rieken 已提交
221 222 223 224
		 * 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 已提交
225 226 227 228
		 */
		validateRange(range: Range): Range;

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

	/**
	 * Represents a line and character position, such as
A
Alex Dima 已提交
239
	 * the position of the cursor.
E
Erich Gamma 已提交
240 241 242 243 244 245 246 247 248 249
	 *
	 * 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 已提交
250
		readonly line: number;
E
Erich Gamma 已提交
251 252 253 254

		/**
		 * The zero-based character value.
		 */
Y
Yuki Ueda 已提交
255
		readonly character: number;
E
Erich Gamma 已提交
256 257

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

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

		/**
A
Alex Dima 已提交
273 274 275 276 277
		 * 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 已提交
278 279 280 281
		 */
		isBeforeOrEqual(other: Position): boolean;

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

		/**
A
Alex Dima 已提交
291 292 293 294 295
		 * 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 已提交
296 297 298 299
		 */
		isAfterOrEqual(other: Position): boolean;

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

		/**
A
Alex Dima 已提交
319
		 * Create a new position relative to this position.
E
Erich Gamma 已提交
320 321 322 323 324 325 326 327
		 *
		 * @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;

328 329 330 331 332 333 334 335 336
		/**
		 * 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 已提交
337
		/**
A
Alex Dima 已提交
338 339
		 * Create a new position derived from this position.
		 *
E
Erich Gamma 已提交
340 341
		 * @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 已提交
342
		 * @return A position where line and character are replaced by the given values.
E
Erich Gamma 已提交
343 344
		 */
		with(line?: number, character?: number): Position;
345 346 347 348 349 350 351 352 353

		/**
		 * 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 已提交
354 355 356 357
	}

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

		/**
A
Andre Weinand 已提交
372
		 * The end position. It is after or equal to [start](#Range.start).
E
Erich Gamma 已提交
373
		 */
Y
Yuki Ueda 已提交
374
		readonly end: Position;
E
Erich Gamma 已提交
375 376

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

		/**
A
Alex Dima 已提交
386 387
		 * 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 已提交
388
		 *
A
Alex Dima 已提交
389 390 391 392
		 * @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 已提交
393
		 */
J
Johannes Rieken 已提交
394
		constructor(startLine: number, startCharacter: number, endLine: number, endCharacter: number);
E
Erich Gamma 已提交
395 396

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

		/**
G
Gama11 已提交
402
		 * `true` if `start.line` and `end.line` are equal.
E
Erich Gamma 已提交
403 404 405 406
		 */
		isSingleLine: boolean;

		/**
A
Alex Dima 已提交
407 408 409
		 * Check if a position or a range is contained in this range.
		 *
		 * @param positionOrRange A position or a range.
G
Gama11 已提交
410
		 * @return `true` if the position or range is inside or equal
E
Erich Gamma 已提交
411 412 413 414 415
		 * to this range.
		 */
		contains(positionOrRange: Position | Range): boolean;

		/**
A
Alex Dima 已提交
416 417 418
		 * Check if `other` equals this range.
		 *
		 * @param other A range.
E
Erich Gamma 已提交
419
		 * @return `true` when start and end are [equal](#Position.isEqual) to
A
Andre Weinand 已提交
420
		 * start and end of this range.
E
Erich Gamma 已提交
421 422 423 424
		 */
		isEqual(other: Range): boolean;

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

		/**
A
Alex Dima 已提交
435 436 437
		 * Compute the union of `other` with this range.
		 *
		 * @param other A range.
E
Erich Gamma 已提交
438 439 440 441 442
		 * @return A range of smaller start position and the greater end position.
		 */
		union(other: Range): Range;

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

		/**
		 * 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 已提交
459
		with(change: { start?: Position, end?: Position }): Range;
E
Erich Gamma 已提交
460 461 462 463 464 465 466 467 468
	}

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

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

		/**
		 * The position of the cursor.
A
Andre Weinand 已提交
475
		 * This position might be before or after [anchor](#Selection.anchor).
E
Erich Gamma 已提交
476
		 */
A
Alex Dima 已提交
477
		active: Position;
E
Erich Gamma 已提交
478 479 480

		/**
		 * Create a selection from two postions.
J
Johannes Rieken 已提交
481 482 483
		 *
		 * @param anchor A position.
		 * @param active A position.
E
Erich Gamma 已提交
484 485 486 487
		 */
		constructor(anchor: Position, active: Position);

		/**
A
Alex Dima 已提交
488
		 * Create a selection from four coordinates.
J
Johannes Rieken 已提交
489
		 *
A
Alex Dima 已提交
490 491 492 493
		 * @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 已提交
494
		 */
J
Johannes Rieken 已提交
495
		constructor(anchorLine: number, anchorCharacter: number, activeLine: number, activeCharacter: number);
A
Alex Dima 已提交
496

E
Erich Gamma 已提交
497
		/**
A
Andre Weinand 已提交
498
		 * A selection is reversed if [active](#Selection.active).isBefore([anchor](#Selection.anchor)).
E
Erich Gamma 已提交
499 500 501 502
		 */
		isReversed: boolean;
	}

503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
	/**
	 * 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 已提交
521 522 523
	/**
	 * Represents an event describing the change in a [text editor's selections](#TextEditor.selections).
	 */
J
Johannes Rieken 已提交
524
	export interface TextEditorSelectionChangeEvent {
A
Alex Dima 已提交
525 526 527
		/**
		 * The [text editor](#TextEditor) for which the selections have changed.
		 */
J
Johannes Rieken 已提交
528
		textEditor: TextEditor;
A
Alex Dima 已提交
529 530 531
		/**
		 * The new value for the [text editor's selections](#TextEditor.selections).
		 */
J
Johannes Rieken 已提交
532
		selections: Selection[];
533 534 535 536 537
		/**
		 * The [change kind](#TextEditorSelectionChangeKind) which has triggered this
		 * event. Can be `undefined`.
		 */
		kind?: TextEditorSelectionChangeKind;
J
Johannes Rieken 已提交
538 539
	}

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

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

598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
	/**
	 * 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 已提交
616
	/**
A
Alex Dima 已提交
617
	 * Represents a [text editor](#TextEditor)'s [options](#TextEditor.options).
E
Erich Gamma 已提交
618 619 620 621
	 */
	export interface TextEditorOptions {

		/**
A
Alex Dima 已提交
622 623 624
		 * 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 已提交
625
		 *
626 627
		 * 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 已提交
628
		 */
629
		tabSize?: number | string;
E
Erich Gamma 已提交
630 631 632

		/**
		 * When pressing Tab insert [n](#TextEditorOptions.tabSize) spaces.
633 634
		 * 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 已提交
635
		 */
636
		insertSpaces?: boolean | string;
A
Alex Dima 已提交
637 638 639 640 641 642 643

		/**
		 * 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;
644 645 646 647 648 649

		/**
		 * 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.
		 */
650
		lineNumbers?: TextEditorLineNumbersStyle;
E
Erich Gamma 已提交
651 652
	}

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

		/**
A
Alex Dima 已提交
663
		 * Internal representation of the handle.
E
Erich Gamma 已提交
664
		 */
Y
Yuki Ueda 已提交
665
		readonly key: string;
E
Erich Gamma 已提交
666

A
Alex Dima 已提交
667 668 669
		/**
		 * Remove this decoration type and all decorations on all text editors using it.
		 */
E
Erich Gamma 已提交
670 671 672
		dispose(): void;
	}

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

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

707
	/**
708
	 * Describes the behavior of decorations when typing/editing at their edges.
709
	 */
710
	export enum DecorationRangeBehavior {
A
Alex Dima 已提交
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
		/**
		 * The decoration's range will widen when edits occur at the start or end.
		 */
		OpenOpen = 0,
		/**
		 * The decoration's range will not widen when edits occur at the start of end.
		 */
		ClosedClosed = 1,
		/**
		 * The decoration's range will widen when edits occur at the start, but not at the end.
		 */
		OpenClosed = 2,
		/**
		 * The decoration's range will widen when edits occur at the end, but not at the start.
		 */
		ClosedOpen = 3
727 728
	}

729 730 731
	/**
	 * Represents options to configure the behavior of showing a [document](#TextDocument) in an [editor](#TextEditor).
	 */
732
	export interface TextDocumentShowOptions {
733
		/**
734 735 736
		 * 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)__.
737
		 */
J
Johannes Rieken 已提交
738
		viewColumn?: ViewColumn;
739 740 741 742

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

		/**
J
Johannes Rieken 已提交
746 747
		 * An optional flag that controls if an [editor](#TextEditor)-tab will be replaced
		 * with the next editor or if it will be kept.
748
		 */
J
Johannes Rieken 已提交
749
		preview?: boolean;
750 751 752 753 754

		/**
		 * An optional selection to apply for the document in the [editor](#TextEditor).
		 */
		selection?: Range;
755 756
	}

757 758 759 760 761 762 763 764 765 766 767 768 769
	/**
	 * A reference to one of the workbench colors as defined in https://code.visualstudio.com/docs/getstarted/theme-color-reference.
	 * Using a theme color is preferred over a custom color as it gives theme authors and users the possibility to change the color.
	 */
	export class ThemeColor {

		/**
		 * Creates a reference to a theme color.
		 * @param id of the color. The available colors are listed in https://code.visualstudio.com/docs/getstarted/theme-color-reference.
		 */
		constructor(id: string);
	}

A
Alex Dima 已提交
770 771 772
	/**
	 * Represents theme specific rendering styles for a [text editor decoration](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
773 774 775
	export interface ThemableDecorationRenderOptions {
		/**
		 * Background color of the decoration. Use rgba() and define transparent background colors to play well with other decorations.
G
Greg Van Liew 已提交
776
		 * Alternatively a color from the color registry can be [referenced](#ThemeColor).
E
Erich Gamma 已提交
777
		 */
778
		backgroundColor?: string | ThemeColor;
E
Erich Gamma 已提交
779 780 781 782

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
783 784 785 786 787 788
		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.
		 */
789
		outlineColor?: string | ThemeColor;
E
Erich Gamma 已提交
790 791 792

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
793
		 * Better use 'outline' for setting one or more of the individual outline properties.
E
Erich Gamma 已提交
794 795 796 797 798
		 */
		outlineStyle?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
799
		 * Better use 'outline' for setting one or more of the individual outline properties.
E
Erich Gamma 已提交
800 801 802 803 804 805
		 */
		outlineWidth?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
806 807 808 809 810 811
		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.
		 */
812
		borderColor?: string | ThemeColor;
E
Erich Gamma 已提交
813 814 815

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
816
		 * Better use 'border' for setting one or more of the individual border properties.
E
Erich Gamma 已提交
817 818 819 820 821
		 */
		borderRadius?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
822
		 * Better use 'border' for setting one or more of the individual border properties.
E
Erich Gamma 已提交
823 824 825 826 827
		 */
		borderSpacing?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
828
		 * Better use 'border' for setting one or more of the individual border properties.
E
Erich Gamma 已提交
829 830 831 832 833
		 */
		borderStyle?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
834
		 * Better use 'border' for setting one or more of the individual border properties.
E
Erich Gamma 已提交
835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
		 */
		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.
		 */
851
		color?: string | ThemeColor;
E
Erich Gamma 已提交
852

853 854 855 856 857
		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		letterSpacing?: string;

E
Erich Gamma 已提交
858
		/**
859
		 * An **absolute path** or an URI to an image to be rendered in the gutter.
E
Erich Gamma 已提交
860
		 */
861
		gutterIconPath?: string | Uri;
E
Erich Gamma 已提交
862

863 864 865 866 867 868 869
		/**
		 * 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 已提交
870 871 872
		/**
		 * The color of the decoration in the overview ruler. Use rgba() and define transparent colors to play well with other decorations.
		 */
873
		overviewRulerColor?: string | ThemeColor;
M
Martin Aeschlimann 已提交
874 875 876 877 878 879 880 881 882 883 884 885 886

		/**
		 * 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 {
887 888 889 890 891
		/**
		 * Defines a text content that is shown in the attachment. Either an icon or a text can be shown, but not both.
		 */
		contentText?: string;
		/**
892 893
		 * 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.
894
		 */
895
		contentIconPath?: string | Uri;
896 897 898 899
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
		border?: string;
900 901 902 903
		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		borderColor?: string | ThemeColor;
904 905 906
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
M
Martin Aeschlimann 已提交
907
		textDecoration?: string;
908 909 910
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
911
		color?: string | ThemeColor;
912 913 914
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
915
		backgroundColor?: string | ThemeColor;
916 917 918
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
M
Martin Aeschlimann 已提交
919
		margin?: string;
920 921 922
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
M
Martin Aeschlimann 已提交
923
		width?: string;
924 925 926
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
M
Martin Aeschlimann 已提交
927
		height?: string;
E
Erich Gamma 已提交
928 929
	}

A
Alex Dima 已提交
930 931 932
	/**
	 * Represents rendering styles for a [text editor decoration](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
933 934 935 936 937 938 939
	export interface DecorationRenderOptions extends ThemableDecorationRenderOptions {
		/**
		 * Should the decoration be rendered also on the whitespace after the line text.
		 * Defaults to `false`.
		 */
		isWholeLine?: boolean;

940
		/**
941 942
		 * Customize the growing behavior of the decoration when edits occur at the edges of the decoration's range.
		 * Defaults to `DecorationRangeBehavior.OpenOpen`.
943
		 */
944
		rangeBehavior?: DecorationRangeBehavior;
945

E
Erich Gamma 已提交
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961
		/**
		 * 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 已提交
962 963 964
	/**
	 * Represents options for a specific decoration in a [decoration set](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
965 966 967
	export interface DecorationOptions {

		/**
968
		 * Range to which this decoration is applied. The range must not be empty.
E
Erich Gamma 已提交
969 970 971 972 973 974
		 */
		range: Range;

		/**
		 * A message that should be rendered when hovering over the decoration.
		 */
975
		hoverMessage?: MarkedString | MarkedString[];
M
Martin Aeschlimann 已提交
976 977 978 979 980 981 982 983 984 985 986 987

		/**
		 * 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
		 */
988
		before?: ThemableDecorationAttachmentRenderOptions;
M
Martin Aeschlimann 已提交
989 990 991 992

		/**
		 * Defines the rendering options of the attachment that is inserted after the decorated text
		 */
993
		after?: ThemableDecorationAttachmentRenderOptions;
M
Martin Aeschlimann 已提交
994 995 996 997 998 999 1000 1001 1002 1003 1004
	}

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

		/**
		 * Overwrite options for dark themes.
		 */
J
Johannes Rieken 已提交
1005
		dark?: ThemableDecorationInstanceRenderOptions;
E
Erich Gamma 已提交
1006 1007
	}

A
Alex Dima 已提交
1008 1009 1010
	/**
	 * Represents an editor that is attached to a [document](#TextDocument).
	 */
E
Erich Gamma 已提交
1011 1012 1013 1014 1015 1016 1017 1018
	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 已提交
1019
		 * The primary selection on this text editor. Shorthand for `TextEditor.selections[0]`.
E
Erich Gamma 已提交
1020 1021 1022 1023
		 */
		selection: Selection;

		/**
J
Johannes Rieken 已提交
1024
		 * The selections in this text editor. The primary selection is always at index 0.
E
Erich Gamma 已提交
1025 1026 1027 1028 1029 1030 1031 1032
		 */
		selections: Selection[];

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

1033 1034 1035 1036
		/**
		 * 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.
		 */
1037
		viewColumn?: ViewColumn;
1038

E
Erich Gamma 已提交
1039 1040
		/**
		 * Perform an edit on the document associated with this text editor.
J
Johannes Rieken 已提交
1041 1042
		 *
		 * The given callback-function is invoked with an [edit-builder](#TextEditorEdit) which must
A
Andre Weinand 已提交
1043
		 * be used to make edits. Note that the edit-builder is only valid while the
J
Johannes Rieken 已提交
1044 1045
		 * callback executes.
		 *
1046
		 * @param callback A function which can create edits using an [edit-builder](#TextEditorEdit).
1047
		 * @param options The undo/redo behavior around this edit. By default, undo stops will be created before and after this edit.
A
Alex Dima 已提交
1048
		 * @return A promise that resolves with a value indicating if the edits could be applied.
E
Erich Gamma 已提交
1049
		 */
J
Johannes Rieken 已提交
1050
		edit(callback: (editBuilder: TextEditorEdit) => void, options?: { undoStopBefore: boolean; undoStopAfter: boolean; }): Thenable<boolean>;
E
Erich Gamma 已提交
1051

J
Joel Day 已提交
1052
		/**
J
Johannes Rieken 已提交
1053 1054 1055
		 * 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 已提交
1056
		 *
1057
		 * @param snippet The snippet to insert in this edit.
J
Johannes Rieken 已提交
1058
		 * @param location Position or range at which to insert the snippet, defaults to the current editor selection or selections.
1059
		 * @param options The undo/redo behavior around this edit. By default, undo stops will be created before and after this edit.
J
Johannes Rieken 已提交
1060 1061
		 * @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 已提交
1062
		 */
J
Johannes Rieken 已提交
1063
		insertSnippet(snippet: SnippetString, location?: Position | Range | Position[] | Range[], options?: { undoStopBefore: boolean; undoStopAfter: boolean; }): Thenable<boolean>;
E
Erich Gamma 已提交
1064 1065

		/**
J
Johannes Rieken 已提交
1066 1067 1068
		 * 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 已提交
1069
		 * @see [createTextEditorDecorationType](#window.createTextEditorDecorationType).
A
Alex Dima 已提交
1070
		 *
J
Johannes Rieken 已提交
1071 1072
		 * @param decorationType A decoration type.
		 * @param rangesOrOptions Either [ranges](#Range) or more detailed [options](#DecorationOptions).
E
Erich Gamma 已提交
1073
		 */
J
Johannes Rieken 已提交
1074
		setDecorations(decorationType: TextEditorDecorationType, rangesOrOptions: Range[] | DecorationOptions[]): void;
E
Erich Gamma 已提交
1075 1076

		/**
A
Alex Dima 已提交
1077 1078 1079 1080
		 * 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 已提交
1081 1082 1083 1084
		 */
		revealRange(range: Range, revealType?: TextEditorRevealType): void;

		/**
1085
		 * ~~Show the text editor.~~
J
Johannes Rieken 已提交
1086
		 *
1087
		 * @deprecated Use [window.showTextDocument](#window.showTextDocument)
E
Erich Gamma 已提交
1088
		 *
J
Johannes Rieken 已提交
1089
		 * @param column The [column](#ViewColumn) in which to show this editor.
1090
		 * instead. This method shows unexpected behavior and will be removed in the next major update.
E
Erich Gamma 已提交
1091 1092 1093 1094
		 */
		show(column?: ViewColumn): void;

		/**
1095
		 * ~~Hide the text editor.~~
J
Johannes Rieken 已提交
1096
		 *
1097
		 * @deprecated Use the command `workbench.action.closeActiveEditor` instead.
S
Steven Clarke 已提交
1098
		 * This method shows unexpected behavior and will be removed in the next major update.
E
Erich Gamma 已提交
1099 1100 1101 1102
		 */
		hide(): void;
	}

1103
	/**
1104
	 * Represents an end of line character sequence in a [document](#TextDocument).
1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
	 */
	export enum EndOfLine {
		/**
		 * The line feed `\n` character.
		 */
		LF = 1,
		/**
		 * The carriage return line feed `\r\n` sequence.
		 */
		CRLF = 2
	}

E
Erich Gamma 已提交
1117
	/**
A
Alex Dima 已提交
1118 1119
	 * 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.)
1120
	 * they can be applied on a [document](#TextDocument) associated with a [text editor](#TextEditor).
E
Erich Gamma 已提交
1121 1122 1123 1124
	 *
	 */
	export interface TextEditorEdit {
		/**
A
Alex Dima 已提交
1125
		 * Replace a certain text region with a new value.
1126
		 * You can use \r\n or \n in `value` and they will be normalized to the current [document](#TextDocument).
A
Alex Dima 已提交
1127 1128 1129
		 *
		 * @param location The range this operation should remove.
		 * @param value The new text this operation should insert after removing `location`.
E
Erich Gamma 已提交
1130 1131 1132 1133
		 */
		replace(location: Position | Range | Selection, value: string): void;

		/**
A
Alex Dima 已提交
1134
		 * Insert text at a location.
1135
		 * You can use \r\n or \n in `value` and they will be normalized to the current [document](#TextDocument).
A
Alex Dima 已提交
1136 1137 1138 1139
		 * 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 已提交
1140 1141 1142 1143 1144
		 */
		insert(location: Position, value: string): void;

		/**
		 * Delete a certain text region.
A
Alex Dima 已提交
1145 1146
		 *
		 * @param location The range this operation should remove.
E
Erich Gamma 已提交
1147 1148
		 */
		delete(location: Range | Selection): void;
1149 1150 1151 1152

		/**
		 * Set the end of line sequence.
		 *
1153
		 * @param endOfLine The new end of line for the [document](#TextDocument).
1154
		 */
A
Format  
Alex Dima 已提交
1155
		setEndOfLine(endOfLine: EndOfLine): void;
E
Erich Gamma 已提交
1156 1157 1158
	}

	/**
S
Steven Clarke 已提交
1159
	 * A universal resource identifier representing either a file on disk
J
Johannes Rieken 已提交
1160
	 * or another resource, like untitled resources.
E
Erich Gamma 已提交
1161 1162 1163 1164
	 */
	export class Uri {

		/**
J
Johannes Rieken 已提交
1165 1166 1167 1168 1169
		 * 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 已提交
1170 1171 1172 1173
		 */
		static file(path: string): Uri;

		/**
J
Johannes Rieken 已提交
1174 1175
		 * Create an URI from a string. Will throw if the given value is not
		 * valid.
E
Erich Gamma 已提交
1176
		 *
J
Johannes Rieken 已提交
1177
		 * @param value The string value of an Uri.
J
Johannes Rieken 已提交
1178
		 * @return A new Uri instance.
E
Erich Gamma 已提交
1179 1180 1181
		 */
		static parse(value: string): Uri;

1182 1183 1184 1185 1186
		/**
		 * Use the `file` and `parse` factory functions to create new `Uri` objects.
		 */
		private constructor(scheme: string, authority: string, path: string, query: string, fragment: string);

E
Erich Gamma 已提交
1187
		/**
J
Johannes Rieken 已提交
1188
		 * Scheme is the `http` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1189 1190
		 * The part before the first colon.
		 */
J
Johannes Rieken 已提交
1191
		readonly scheme: string;
E
Erich Gamma 已提交
1192 1193

		/**
J
Johannes Rieken 已提交
1194
		 * Authority is the `www.msft.com` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1195 1196
		 * The part between the first double slashes and the next slash.
		 */
J
Johannes Rieken 已提交
1197
		readonly authority: string;
E
Erich Gamma 已提交
1198 1199

		/**
J
Johannes Rieken 已提交
1200
		 * Path is the `/some/path` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1201
		 */
J
Johannes Rieken 已提交
1202
		readonly path: string;
E
Erich Gamma 已提交
1203 1204

		/**
J
Johannes Rieken 已提交
1205
		 * Query is the `query` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1206
		 */
J
Johannes Rieken 已提交
1207
		readonly query: string;
E
Erich Gamma 已提交
1208 1209

		/**
J
Johannes Rieken 已提交
1210
		 * Fragment is the `fragment` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1211
		 */
J
Johannes Rieken 已提交
1212
		readonly fragment: string;
E
Erich Gamma 已提交
1213 1214

		/**
1215
		 * The string representing the corresponding file system path of this Uri.
J
Johannes Rieken 已提交
1216
		 *
E
Erich Gamma 已提交
1217 1218
		 * 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
1219
		 * invalid characters and semantics. Will *not* look at the scheme of this Uri.
E
Erich Gamma 已提交
1220
		 */
J
Johannes Rieken 已提交
1221
		readonly fsPath: string;
E
Erich Gamma 已提交
1222

1223 1224 1225
		/**
		 * Derive a new Uri from this Uri.
		 *
1226 1227 1228 1229 1230 1231
		 * ```ts
		 * let file = Uri.parse('before:some/file/path');
		 * let other = file.with({ scheme: 'after' });
		 * assert.ok(other.toString() === 'after:some/file/path');
		 * ```
		 *
1232 1233
		 * @param change An object that describes a change to this Uri. To unset components use `null` or
		 *  the empty string.
1234
		 * @return A new Uri that reflects the given change. Will return `this` Uri if the change
1235 1236 1237 1238
		 *  is not changing anything.
		 */
		with(change: { scheme?: string; authority?: string; path?: string; query?: string; fragment?: string }): Uri;

E
Erich Gamma 已提交
1239
		/**
1240 1241 1242
		 * 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 已提交
1243
		 *
1244 1245 1246
		 * @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 已提交
1247
		 */
1248
		toString(skipEncoding?: boolean): string;
E
Erich Gamma 已提交
1249

J
Johannes Rieken 已提交
1250 1251 1252 1253 1254
		/**
		 * Returns a JSON representation of this Uri.
		 *
		 * @return An object.
		 */
E
Erich Gamma 已提交
1255 1256 1257 1258
		toJSON(): any;
	}

	/**
S
Steven Clarke 已提交
1259
	 * A cancellation token is passed to an asynchronous or long running
E
Erich Gamma 已提交
1260 1261
	 * operation to request cancellation, like cancelling a request
	 * for completion items because the user continued to type.
1262 1263 1264
	 *
	 * To get an instance of a `CancellationToken` use a
	 * [CancellationTokenSource](#CancellationTokenSource).
E
Erich Gamma 已提交
1265 1266 1267 1268
	 */
	export interface CancellationToken {

		/**
J
Johannes Rieken 已提交
1269
		 * Is `true` when the token has been cancelled, `false` otherwise.
E
Erich Gamma 已提交
1270 1271 1272 1273
		 */
		isCancellationRequested: boolean;

		/**
J
Johannes Rieken 已提交
1274
		 * An [event](#Event) which fires upon cancellation.
E
Erich Gamma 已提交
1275 1276 1277 1278 1279
		 */
		onCancellationRequested: Event<any>;
	}

	/**
J
Johannes Rieken 已提交
1280
	 * A cancellation source creates and controls a [cancellation token](#CancellationToken).
E
Erich Gamma 已提交
1281 1282 1283 1284
	 */
	export class CancellationTokenSource {

		/**
J
Johannes Rieken 已提交
1285
		 * The cancellation token of this source.
E
Erich Gamma 已提交
1286 1287 1288 1289 1290 1291 1292 1293 1294
		 */
		token: CancellationToken;

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

		/**
J
Johannes Rieken 已提交
1295
		 * Dispose object and free resources. Will call [cancel](#CancellationTokenSource.cancel).
E
Erich Gamma 已提交
1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310
		 */
		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 已提交
1311
		 * @param disposableLikes Objects that have at least a `dispose`-function member.
E
Erich Gamma 已提交
1312 1313 1314 1315 1316 1317 1318 1319
		 * @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 已提交
1320
		 * @param callOnDispose Function that disposes something.
E
Erich Gamma 已提交
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
		 */
		constructor(callOnDispose: Function);

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

	/**
	 * Represents a typed event.
J
Johannes Rieken 已提交
1332 1333 1334 1335 1336
	 *
	 * 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 已提交
1337 1338 1339 1340
	 */
	export interface Event<T> {

		/**
J
Johannes Rieken 已提交
1341 1342
		 * A function that represents an event to which you subscribe by calling it with
		 * a listener function as argument.
E
Erich Gamma 已提交
1343 1344
		 *
		 * @param listener The listener function will be called when the event happens.
J
Johannes Rieken 已提交
1345
		 * @param thisArgs The `this`-argument which will be used when calling the event listener.
D
Daniel Imms 已提交
1346
		 * @param disposables An array to which a [disposable](#Disposable) will be added.
A
Andre Weinand 已提交
1347
		 * @return A disposable which unsubscribes the event listener.
E
Erich Gamma 已提交
1348 1349 1350 1351
		 */
		(listener: (e: T) => any, thisArgs?: any, disposables?: Disposable[]): Disposable;
	}

1352 1353 1354 1355 1356
	/**
	 * 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 已提交
1357
	 * inside a [TextDocumentContentProvider](#TextDocumentContentProvider) or when providing
1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380
	 * 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 已提交
1381 1382
	/**
	 * A file system watcher notifies about changes to files and folders
J
Johannes Rieken 已提交
1383 1384 1385
	 * on disk.
	 *
	 * To get an instance of a `FileSystemWatcher` use
J
Johannes Rieken 已提交
1386
	 * [createFileSystemWatcher](#workspace.createFileSystemWatcher).
E
Erich Gamma 已提交
1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405
	 */
	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 已提交
1406
		ignoreDeleteEvents: boolean;
E
Erich Gamma 已提交
1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423

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

1424 1425 1426 1427
	/**
	 * A text document content provider allows to add readonly documents
	 * to the editor, such as source from a dll or generated html from md.
	 *
1428
	 * Content providers are [registered](#workspace.registerTextDocumentContentProvider)
1429
	 * for a [uri-scheme](#Uri.scheme). When a uri with that scheme is to
1430
	 * be [loaded](#workspace.openTextDocument) the content provider is
1431 1432
	 * asked.
	 */
J
Johannes Rieken 已提交
1433 1434
	export interface TextDocumentContentProvider {

1435 1436 1437 1438
		/**
		 * An event to signal a resource has changed.
		 */
		onDidChange?: Event<Uri>;
J
Johannes Rieken 已提交
1439

1440
		/**
1441
		 * Provide textual content for a given uri.
1442
		 *
1443
		 * The editor will use the returned string-content to create a readonly
J
Johannes Rieken 已提交
1444
		 * [document](#TextDocument). Resources allocated should be released when
1445
		 * the corresponding document has been [closed](#workspace.onDidCloseTextDocument).
1446
		 *
1447 1448 1449
		 * @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.
1450
		 */
1451
		provideTextDocumentContent(uri: Uri, token: CancellationToken): ProviderResult<string>;
J
Johannes Rieken 已提交
1452 1453
	}

E
Erich Gamma 已提交
1454 1455
	/**
	 * Represents an item that can be selected from
A
Andre Weinand 已提交
1456
	 * a list of items.
E
Erich Gamma 已提交
1457 1458 1459 1460
	 */
	export interface QuickPickItem {

		/**
J
Johannes Rieken 已提交
1461
		 * A human readable string which is rendered prominent.
E
Erich Gamma 已提交
1462 1463 1464 1465
		 */
		label: string;

		/**
J
Johannes Rieken 已提交
1466
		 * A human readable string which is rendered less prominent.
E
Erich Gamma 已提交
1467 1468
		 */
		description: string;
J
Johannes Rieken 已提交
1469 1470 1471 1472 1473

		/**
		 * A human readable string which is rendered less prominent.
		 */
		detail?: string;
E
Erich Gamma 已提交
1474 1475 1476
	}

	/**
J
Johannes Rieken 已提交
1477
	 * Options to configure the behavior of the quick pick UI.
E
Erich Gamma 已提交
1478 1479 1480
	 */
	export interface QuickPickOptions {
		/**
J
Johannes Rieken 已提交
1481 1482
		 * An optional flag to include the description when filtering the picks.
		 */
E
Erich Gamma 已提交
1483 1484
		matchOnDescription?: boolean;

J
Johannes Rieken 已提交
1485 1486 1487 1488 1489
		/**
		 * An optional flag to include the detail when filtering the picks.
		 */
		matchOnDetail?: boolean;

E
Erich Gamma 已提交
1490
		/**
S
Steven Clarke 已提交
1491
		 * An optional string to show as place holder in the input box to guide the user what to pick on.
J
Johannes Rieken 已提交
1492
		 */
E
Erich Gamma 已提交
1493
		placeHolder?: string;
1494

1495 1496 1497 1498 1499
		/**
		 * Set to `true` to keep the picker open when focus moves to another part of the editor or to another window.
		 */
		ignoreFocusOut?: boolean;

1500 1501 1502
		/**
		 * An optional function that is invoked whenever an item is selected.
		 */
A
Amadare42 已提交
1503
		onDidSelectItem?(item: QuickPickItem | string): any;
E
Erich Gamma 已提交
1504 1505
	}

1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545
	/**
 * Options to configure the behaviour of a file open dialog.
 */
	export interface OpenDialogOptions {
		/**
		 * The resource the dialog shows when opened.
		 */
		defaultUri?: Uri;

		/**
		 * A human-readable string for the open button.
		 */
		openLabel?: string;

		/**
		 * Only allow to select files. *Note* that not all operating systems support
		 * to select files and folders in one dialog instance.
		 */
		openFiles?: boolean;

		/**
		 * Only allow to select folders. *Note* that not all operating systems support
		 * to select files and folders in one dialog instance.
		 */
		openFolders?: boolean;

		/**
		 * Allow to select many files or folders.
		 */
		openMany?: boolean;

		/**
		 * A set of file filters that are shown in the dialog, e.g.
		 * ```ts
		 * {
		 * 	['Images']: ['*.png', '*.jpg']
		 * 	['TypeScript']: ['*.ts', '*.tsx']
		 * }
		 * ```
		 */
J
Johannes Rieken 已提交
1546
		filters?: { [name: string]: string[] };
1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571
	}

	/**
	 * Options to configure the behaviour of a file save dialog.
	 */
	export interface SaveDialogOptions {
		/**
		 * The resource the dialog shows when opened.
		 */
		defaultUri?: Uri;

		/**
		 * A human-readable string for the save button.
		 */
		saveLabel?: string;

		/**
		 * A set of file filters that are shown in the dialog, e.g.
		 * ```ts
		 * {
		 * 	['Images']: ['*.png', '*.jpg']
		 * 	['TypeScript']: ['*.ts', '*.tsx']
		 * }
		 * ```
		 */
J
Johannes Rieken 已提交
1572
		filters?: { [name: string]: string[] };
1573 1574
	}

E
Erich Gamma 已提交
1575
	/**
J
Johannes Rieken 已提交
1576
	 * Represents an action that is shown with an information, warning, or
A
Andre Weinand 已提交
1577
	 * error message.
E
Erich Gamma 已提交
1578
	 *
S
Sofian Hnaide 已提交
1579 1580 1581
	 * @see [showInformationMessage](#window.showInformationMessage)
	 * @see [showWarningMessage](#window.showWarningMessage)
	 * @see [showErrorMessage](#window.showErrorMessage)
E
Erich Gamma 已提交
1582 1583 1584 1585
	 */
	export interface MessageItem {

		/**
A
Andre Weinand 已提交
1586
		 * A short title like 'Retry', 'Open Log' etc.
E
Erich Gamma 已提交
1587 1588
		 */
		title: string;
1589 1590 1591 1592 1593 1594

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

J
Joao Moreno 已提交
1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611
	/**
	 * 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 已提交
1612
	/**
J
Johannes Rieken 已提交
1613
	 * Options to configure the behavior of the input box UI.
E
Erich Gamma 已提交
1614 1615
	 */
	export interface InputBoxOptions {
J
Johannes Rieken 已提交
1616

E
Erich Gamma 已提交
1617
		/**
J
Johannes Rieken 已提交
1618 1619
		 * The value to prefill in the input box.
		 */
E
Erich Gamma 已提交
1620 1621
		value?: string;

1622
		/**
1623 1624 1625 1626
		 * 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.
1627
		 */
1628
		valueSelection?: [number, number];
1629

E
Erich Gamma 已提交
1630
		/**
J
Johannes Rieken 已提交
1631 1632
		 * The text to display underneath the input box.
		 */
E
Erich Gamma 已提交
1633 1634 1635
		prompt?: string;

		/**
J
Johannes Rieken 已提交
1636 1637
		 * An optional string to show as place holder in the input box to guide the user what to type.
		 */
E
Erich Gamma 已提交
1638 1639 1640
		placeHolder?: string;

		/**
1641
		 * Set to `true` to show a password prompt that will not show the typed value.
J
Johannes Rieken 已提交
1642
		 */
E
Erich Gamma 已提交
1643
		password?: boolean;
1644

1645 1646 1647 1648 1649
		/**
		 * Set to `true` to keep the input box open when focus moves to another part of the editor or to another window.
		 */
		ignoreFocusOut?: boolean;

1650
		/**
P
Pine 已提交
1651
		 * An optional function that will be called to validate input and to give a hint
1652 1653 1654 1655 1656 1657
		 * 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.
		 */
1658
		validateInput?(value: string): string | undefined | null;
E
Erich Gamma 已提交
1659 1660
	}

B
Benjamin Pasero 已提交
1661 1662 1663 1664 1665
	/**
	 * A relative pattern is a helper to construct glob patterns that are matched
	 * relatively to a base path. The base path can either be an absolute file path
	 * or a [workspace folder](#WorkspaceFolder).
	 */
1666 1667 1668
	class RelativePattern {

		/**
B
Benjamin Pasero 已提交
1669
		 * A base file path to which this pattern will be matched against relatively.
1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681
		 */
		base: string;

		/**
		 * A file glob pattern like `*.{ts,js}` that will be matched on file paths
		 * relative to the base path.
		 *
		 * Example: Given a base of `/home/work/folder` and a file path of `/home/work/folder/index.js`,
		 * the file glob pattern will match on `index.js`.
		 */
		pattern: string;

B
Benjamin Pasero 已提交
1682
		/**
B
Benjamin Pasero 已提交
1683 1684
		 * Creates a new relative pattern object with a base path and pattern to match. This pattern
		 * will be matched on file paths relative to the base path.
B
Benjamin Pasero 已提交
1685
		 *
B
Benjamin Pasero 已提交
1686
		 * @param base A base file path to which this pattern will be matched against relatively.
B
Benjamin Pasero 已提交
1687 1688 1689
		 * @param pattern A file glob pattern like `*.{ts,js}` that will be matched on file paths
		 * relative to the base path.
		 */
1690
		constructor(base: WorkspaceFolder | string, pattern: string)
1691 1692 1693 1694 1695 1696 1697 1698
	}

	/**
	 * A file glob pattern to match file paths against. This can either be a glob pattern string
	 * (like `**∕*.{ts,js}` or `*.{ts,js}`) or a [relative pattern](#RelativePattern).
	 */
	export type GlobPattern = string | RelativePattern;

E
Erich Gamma 已提交
1699 1700
	/**
	 * A document filter denotes a document by different properties like
A
Alex Dima 已提交
1701
	 * the [language](#TextDocument.languageId), the [scheme](#Uri.scheme) of
A
Andre Weinand 已提交
1702
	 * its resource, or a glob-pattern that is applied to the [path](#TextDocument.fileName).
E
Erich Gamma 已提交
1703
	 *
J
Johannes Rieken 已提交
1704
	 * @sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
M
Matan Kushner 已提交
1705
	 * @sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**∕package.json' }`
E
Erich Gamma 已提交
1706 1707 1708 1709 1710 1711 1712 1713 1714
	 */
	export interface DocumentFilter {

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

		/**
J
Johannes Rieken 已提交
1715
		 * A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
E
Erich Gamma 已提交
1716 1717 1718 1719
		 */
		scheme?: string;

		/**
B
Benjamin Pasero 已提交
1720 1721
		 * A [glob pattern](#GlobPattern) that is matched on the absolute path of the document. Use a [relative pattern](#RelativePattern)
		 * to filter documents to a [workspace folder](#WorkspaceFolder).
E
Erich Gamma 已提交
1722
		 */
1723
		pattern?: GlobPattern;
E
Erich Gamma 已提交
1724 1725 1726 1727
	}

	/**
	 * A language selector is the combination of one or many language identifiers
1728
	 * and [language filters](#DocumentFilter).
J
Johannes Rieken 已提交
1729 1730
	 *
	 * @sample `let sel:DocumentSelector = 'typescript'`;
1731
	 * @sample `let sel:DocumentSelector = ['typescript', { language: 'json', pattern: '**∕tsconfig.json' }]`;
E
Erich Gamma 已提交
1732 1733 1734
	 */
	export type DocumentSelector = string | DocumentFilter | (string | DocumentFilter)[];

1735 1736 1737 1738 1739 1740 1741 1742 1743
	/**
	 * 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
1744 1745 1746 1747 1748
	 * let a: HoverProvider = {
	 * 	provideHover(doc, pos, token): ProviderResult<Hover> {
	 * 		return new Hover('Hello World');
	 * 	}
	 * }
1749
	 *
1750 1751 1752 1753 1754 1755 1756
	 * let b: HoverProvider = {
	 * 	provideHover(doc, pos, token): ProviderResult<Hover> {
	 * 		return new Promise(resolve => {
	 * 			resolve(new Hover('Hello World'));
	 * 	 	});
	 * 	}
	 * }
1757
	 *
1758 1759 1760 1761 1762 1763
	 * let c: HoverProvider = {
	 * 	provideHover(doc, pos, token): ProviderResult<Hover> {
	 * 		return; // undefined
	 * 	}
	 * }
	 * ```
1764
	 */
J
Johannes Rieken 已提交
1765
	export type ProviderResult<T> = T | undefined | null | Thenable<T | undefined | null>;
1766

E
Erich Gamma 已提交
1767 1768
	/**
	 * Contains additional diagnostic information about the context in which
J
Johannes Rieken 已提交
1769
	 * a [code action](#CodeActionProvider.provideCodeActions) is run.
E
Erich Gamma 已提交
1770 1771
	 */
	export interface CodeActionContext {
J
Johannes Rieken 已提交
1772 1773 1774 1775

		/**
		 * An array of diagnostics.
		 */
Y
Yuki Ueda 已提交
1776
		readonly diagnostics: Diagnostic[];
E
Erich Gamma 已提交
1777 1778 1779
	}

	/**
J
Johannes Rieken 已提交
1780 1781 1782 1783
	 * 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 已提交
1784 1785 1786 1787 1788 1789
	 */
	export interface CodeActionProvider {

		/**
		 * Provide commands for the given document and range.
		 *
J
Johannes Rieken 已提交
1790 1791
		 * @param document The document in which the command was invoked.
		 * @param range The range for which the command was invoked.
J
Johannes Rieken 已提交
1792 1793
		 * @param context Context carrying additional information.
		 * @param token A cancellation token.
J
Johannes Rieken 已提交
1794
		 * @return An array of commands or a thenable of such. The lack of a result can be
A
Andre Weinand 已提交
1795
		 * signaled by returning `undefined`, `null`, or an empty array.
E
Erich Gamma 已提交
1796
		 */
1797
		provideCodeActions(document: TextDocument, range: Range, context: CodeActionContext, token: CancellationToken): ProviderResult<Command[]>;
E
Erich Gamma 已提交
1798 1799 1800 1801 1802
	}

	/**
	 * 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 已提交
1803 1804 1805
	 *
	 * 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 已提交
1806 1807 1808
	 *
	 * @see [CodeLensProvider.provideCodeLenses](#CodeLensProvider.provideCodeLenses)
	 * @see [CodeLensProvider.resolveCodeLens](#CodeLensProvider.resolveCodeLens)
E
Erich Gamma 已提交
1809 1810 1811 1812 1813 1814 1815 1816 1817
	 */
	export class CodeLens {

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

		/**
J
Johannes Rieken 已提交
1818
		 * The command this code lens represents.
E
Erich Gamma 已提交
1819
		 */
1820
		command?: Command;
E
Erich Gamma 已提交
1821 1822

		/**
J
Johannes Rieken 已提交
1823
		 * `true` when there is a command associated.
E
Erich Gamma 已提交
1824
		 */
Y
Yuki Ueda 已提交
1825
		readonly isResolved: boolean;
J
Johannes Rieken 已提交
1826 1827 1828 1829 1830 1831 1832 1833

		/**
		 * 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 已提交
1834 1835 1836 1837 1838 1839 1840 1841
	}

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

1842 1843 1844
		/**
		 * An optional event to signal that the code lenses from this provider have changed.
		 */
1845
		onDidChangeCodeLenses?: Event<void>;
1846

E
Erich Gamma 已提交
1847 1848
		/**
		 * Compute a list of [lenses](#CodeLens). This call should return as fast as possible and if
A
Andre Weinand 已提交
1849
		 * computing the commands is expensive implementors should only return code lens objects with the
E
Erich Gamma 已提交
1850
		 * range set and implement [resolve](#CodeLensProvider.resolveCodeLens).
J
Johannes Rieken 已提交
1851 1852 1853
		 *
		 * @param document The document in which the command was invoked.
		 * @param token A cancellation token.
A
Andre Weinand 已提交
1854 1855
		 * @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 已提交
1856
		 */
1857
		provideCodeLenses(document: TextDocument, token: CancellationToken): ProviderResult<CodeLens[]>;
E
Erich Gamma 已提交
1858 1859 1860 1861

		/**
		 * This function will be called for each visible code lens, usually when scrolling and after
		 * calls to [compute](#CodeLensProvider.provideCodeLenses)-lenses.
J
Johannes Rieken 已提交
1862
		 *
A
Andre Weinand 已提交
1863
		 * @param codeLens code lens that must be resolved.
J
Johannes Rieken 已提交
1864
		 * @param token A cancellation token.
S
Steven Clarke 已提交
1865
		 * @return The given, resolved code lens or thenable that resolves to such.
E
Erich Gamma 已提交
1866
		 */
1867
		resolveCodeLens?(codeLens: CodeLens, token: CancellationToken): ProviderResult<CodeLens>;
E
Erich Gamma 已提交
1868 1869 1870
	}

	/**
J
Johannes Rieken 已提交
1871 1872 1873
	 * 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 已提交
1874 1875 1876
	 */
	export type Definition = Location | Location[];

J
Johannes Rieken 已提交
1877 1878 1879 1880 1881
	/**
	 * 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 已提交
1882
	export interface DefinitionProvider {
J
Johannes Rieken 已提交
1883 1884 1885 1886 1887 1888 1889

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

1896
	/**
1897
	 * The implemenetation provider interface defines the contract between extensions and
1898 1899
	 * the go to implementation feature.
	 */
M
Matt Bierner 已提交
1900
	export interface ImplementationProvider {
1901 1902 1903 1904 1905 1906 1907 1908 1909 1910

		/**
		 * 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 已提交
1911
		provideImplementation(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Definition>;
1912 1913
	}

1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931
	/**
	 * 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 已提交
1932
	/**
1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970
	 * The MarkdownString represents human readable text that supports formatting via the
	 * markdown syntax. Standard markdown is supported, also tables, but no embedded html.
	 */
	export class MarkdownString {

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

		/**
		 * Indicates that this markdown string is from a trusted source. Only *trusted*
		 * markdown supports links that execute commands, e.g. `[Run it](command:myCommandId)`.
		 */
		isTrusted?: boolean;

		/**
		 * Creates a new markdown string with the given value.
		 *
		 * @param value Optional, initial value.
		 */
		constructor(value?: string);

		/**
		 * Appends and escapes the given string to this markdown string.
		 * @param value Plain text.
		 */
		appendText(value: string): MarkdownString;

		/**
		 * Appends the given string 'as is' to this markdown string.
		 * @param value Markdown string.
		 */
		appendMarkdown(value: string): MarkdownString;
	}

	/**
	 * ~~MarkedString can be used to render human readable text. It is either a markdown string
J
Johannes Rieken 已提交
1971
	 * or a code-block that provides a language and a code snippet. Note that
1972 1973 1974
	 * markdown strings will be sanitized - that means html will be escaped.~~
	 *
	 * @deprecated This type is deprecated, please use [`MarkdownString`](#MarkdownString) instead.
E
Erich Gamma 已提交
1975
	 */
1976
	export type MarkedString = MarkdownString | string | { language: string; value: string };
E
Erich Gamma 已提交
1977

J
Johannes Rieken 已提交
1978 1979 1980 1981
	/**
	 * A hover represents additional information for a symbol or word. Hovers are
	 * rendered in a tooltip-like widget.
	 */
E
Erich Gamma 已提交
1982 1983
	export class Hover {

J
Johannes Rieken 已提交
1984 1985 1986
		/**
		 * The contents of this hover.
		 */
E
Erich Gamma 已提交
1987 1988
		contents: MarkedString[];

J
Johannes Rieken 已提交
1989
		/**
A
Andre Weinand 已提交
1990
		 * The range to which this hover applies. When missing, the
J
Johannes Rieken 已提交
1991
		 * editor will use the range at the current position or the
A
Andre Weinand 已提交
1992
		 * current position itself.
J
Johannes Rieken 已提交
1993
		 */
1994
		range?: Range;
E
Erich Gamma 已提交
1995

J
Johannes Rieken 已提交
1996 1997 1998 1999
		/**
		 * Creates a new hover object.
		 *
		 * @param contents The contents of the hover.
A
Andre Weinand 已提交
2000
		 * @param range The range to which the hover applies.
J
Johannes Rieken 已提交
2001
		 */
E
Erich Gamma 已提交
2002 2003 2004
		constructor(contents: MarkedString | MarkedString[], range?: Range);
	}

J
Johannes Rieken 已提交
2005 2006
	/**
	 * The hover provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
2007
	 * the [hover](https://code.visualstudio.com/docs/editor/intellisense)-feature.
J
Johannes Rieken 已提交
2008
	 */
E
Erich Gamma 已提交
2009
	export interface HoverProvider {
J
Johannes Rieken 已提交
2010 2011 2012

		/**
		 * Provide a hover for the given position and document. Multiple hovers at the same
A
Andre Weinand 已提交
2013 2014
		 * 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 已提交
2015 2016 2017 2018 2019
		 *
		 * @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 已提交
2020
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
2021
		 */
2022
		provideHover(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Hover>;
E
Erich Gamma 已提交
2023 2024
	}

J
Johannes Rieken 已提交
2025 2026 2027
	/**
	 * A document highlight kind.
	 */
E
Erich Gamma 已提交
2028
	export enum DocumentHighlightKind {
J
Johannes Rieken 已提交
2029 2030

		/**
A
Andre Weinand 已提交
2031
		 * A textual occurrence.
J
Johannes Rieken 已提交
2032
		 */
2033
		Text = 0,
J
Johannes Rieken 已提交
2034 2035 2036 2037

		/**
		 * Read-access of a symbol, like reading a variable.
		 */
2038
		Read = 1,
J
Johannes Rieken 已提交
2039 2040 2041 2042

		/**
		 * Write-access of a symbol, like writing to a variable.
		 */
2043
		Write = 2
E
Erich Gamma 已提交
2044 2045
	}

J
Johannes Rieken 已提交
2046 2047 2048 2049 2050
	/**
	 * 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 已提交
2051
	export class DocumentHighlight {
J
Johannes Rieken 已提交
2052 2053 2054 2055

		/**
		 * The range this highlight applies to.
		 */
E
Erich Gamma 已提交
2056
		range: Range;
J
Johannes Rieken 已提交
2057 2058 2059 2060

		/**
		 * The highlight kind, default is [text](#DocumentHighlightKind.Text).
		 */
2061
		kind?: DocumentHighlightKind;
J
Johannes Rieken 已提交
2062 2063 2064 2065 2066 2067 2068 2069

		/**
		 * 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 已提交
2070 2071
	}

J
Johannes Rieken 已提交
2072 2073 2074 2075
	/**
	 * The document highlight provider interface defines the contract between extensions and
	 * the word-highlight-feature.
	 */
E
Erich Gamma 已提交
2076
	export interface DocumentHighlightProvider {
J
Johannes Rieken 已提交
2077 2078

		/**
S
Steven Clarke 已提交
2079
		 * Provide a set of document highlights, like all occurrences of a variable or
J
Johannes Rieken 已提交
2080 2081 2082 2083 2084 2085
		 * 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 已提交
2086
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2087
		 */
2088
		provideDocumentHighlights(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<DocumentHighlight[]>;
E
Erich Gamma 已提交
2089 2090
	}

J
Johannes Rieken 已提交
2091 2092 2093
	/**
	 * A symbol kind.
	 */
E
Erich Gamma 已提交
2094
	export enum SymbolKind {
2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114
		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,
2115 2116 2117 2118
		Null = 20,
		EnumMember = 21,
		Struct = 22,
		Event = 23,
2119 2120
		Operator = 24,
		TypeParameter = 25
E
Erich Gamma 已提交
2121 2122
	}

J
Johannes Rieken 已提交
2123 2124 2125 2126
	/**
	 * Represents information about programming constructs like variables, classes,
	 * interfaces etc.
	 */
E
Erich Gamma 已提交
2127
	export class SymbolInformation {
J
Johannes Rieken 已提交
2128 2129 2130 2131

		/**
		 * The name of this symbol.
		 */
E
Erich Gamma 已提交
2132
		name: string;
J
Johannes Rieken 已提交
2133 2134 2135 2136

		/**
		 * The name of the symbol containing this symbol.
		 */
E
Erich Gamma 已提交
2137
		containerName: string;
J
Johannes Rieken 已提交
2138 2139 2140 2141

		/**
		 * The kind of this symbol.
		 */
E
Erich Gamma 已提交
2142
		kind: SymbolKind;
J
Johannes Rieken 已提交
2143 2144 2145 2146

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

2149 2150 2151 2152 2153 2154 2155 2156 2157 2158
		/**
		 * 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 已提交
2159
		/**
2160
		 * ~~Creates a new symbol information object.~~
2161
		 *
2162
		 * @deprecated Please use the constructor taking a [location](#Location) object.
J
Johannes Rieken 已提交
2163 2164 2165 2166 2167
		 *
		 * @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 已提交
2168
		 * @param containerName The name of the symbol containing the symbol.
J
Johannes Rieken 已提交
2169 2170
		 */
		constructor(name: string, kind: SymbolKind, range: Range, uri?: Uri, containerName?: string);
E
Erich Gamma 已提交
2171 2172
	}

J
Johannes Rieken 已提交
2173 2174
	/**
	 * The document symbol provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
2175
	 * the [go to symbol](https://code.visualstudio.com/docs/editor/editingevolved#_go-to-symbol)-feature.
J
Johannes Rieken 已提交
2176
	 */
E
Erich Gamma 已提交
2177
	export interface DocumentSymbolProvider {
J
Johannes Rieken 已提交
2178 2179 2180 2181 2182 2183 2184

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

J
Johannes Rieken 已提交
2190 2191 2192 2193
	/**
	 * 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 已提交
2194
	export interface WorkspaceSymbolProvider {
J
Johannes Rieken 已提交
2195 2196 2197

		/**
		 * Project-wide search for a symbol matching the given query string. It is up to the provider
2198 2199 2200
		 * 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 已提交
2201
		 *
2202 2203 2204 2205 2206
		 * The `query`-parameter should be interpreted in a *relaxed way* as the editor will apply its own highlighting
		 * and scoring on the results. A good rule of thumb is to match case-insensitive and to simply check that the
		 * characters of *query* appear in their order in a candidate symbol. Don't use prefix, substring, or similar
		 * strict matching.
		 *
J
Johannes Rieken 已提交
2207 2208 2209
		 * @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 已提交
2210
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2211
		 */
2212
		provideWorkspaceSymbols(query: string, token: CancellationToken): ProviderResult<SymbolInformation[]>;
2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225

		/**
		 * 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.
		 */
2226
		resolveWorkspaceSymbol?(symbol: SymbolInformation, token: CancellationToken): ProviderResult<SymbolInformation>;
E
Erich Gamma 已提交
2227 2228
	}

J
Johannes Rieken 已提交
2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244
	/**
	 * 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 已提交
2245
	export interface ReferenceProvider {
J
Johannes Rieken 已提交
2246 2247 2248 2249 2250 2251 2252 2253 2254

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

J
Johannes Rieken 已提交
2260
	/**
S
Steven Clarke 已提交
2261
	 * A text edit represents edits that should be applied
J
Johannes Rieken 已提交
2262
	 * to a document.
J
Johannes Rieken 已提交
2263
	 */
E
Erich Gamma 已提交
2264
	export class TextEdit {
J
Johannes Rieken 已提交
2265 2266 2267 2268 2269 2270 2271 2272

		/**
		 * Utility to create a replace edit.
		 *
		 * @param range A range.
		 * @param newText A string.
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
2273
		static replace(range: Range, newText: string): TextEdit;
J
Johannes Rieken 已提交
2274 2275 2276 2277

		/**
		 * Utility to create an insert edit.
		 *
S
Steven Clarke 已提交
2278
		 * @param position A position, will become an empty range.
J
Johannes Rieken 已提交
2279 2280 2281
		 * @param newText A string.
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
2282
		static insert(position: Position, newText: string): TextEdit;
J
Johannes Rieken 已提交
2283 2284 2285 2286

		/**
		 * Utility to create a delete edit.
		 *
J
Johannes Rieken 已提交
2287
		 * @param range A range.
J
Johannes Rieken 已提交
2288 2289
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
2290
		static delete(range: Range): TextEdit;
J
Johannes Rieken 已提交
2291

2292 2293 2294 2295 2296 2297 2298 2299
		/**
		 * 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 已提交
2300 2301 2302
		/**
		 * The range this edit applies to.
		 */
E
Erich Gamma 已提交
2303
		range: Range;
J
Johannes Rieken 已提交
2304 2305 2306 2307

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

2310 2311
		/**
		 * The eol-sequence used in the document.
J
Johannes Rieken 已提交
2312 2313 2314
		 *
		 * *Note* that the eol-sequence will be applied to the
		 * whole document.
2315 2316 2317
		 */
		newEol: EndOfLine;

J
Johannes Rieken 已提交
2318 2319 2320 2321 2322 2323 2324
		/**
		 * Create a new TextEdit.
		 *
		 * @param range A range.
		 * @param newText A string.
		 */
		constructor(range: Range, newText: string);
E
Erich Gamma 已提交
2325 2326 2327
	}

	/**
J
Johannes Rieken 已提交
2328
	 * A workspace edit represents textual changes for many documents.
E
Erich Gamma 已提交
2329 2330 2331 2332 2333 2334
	 */
	export class WorkspaceEdit {

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

J
Johannes Rieken 已提交
2337 2338 2339 2340 2341 2342 2343 2344
		/**
		 * 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 已提交
2345

J
Johannes Rieken 已提交
2346 2347 2348 2349 2350 2351 2352 2353
		/**
		 * 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 已提交
2354

J
Johannes Rieken 已提交
2355
		/**
S
Steven Clarke 已提交
2356
		 * Delete the text at the given range.
J
Johannes Rieken 已提交
2357 2358 2359
		 *
		 * @param uri A resource identifier.
		 * @param range A range.
J
Johannes Rieken 已提交
2360 2361
		 */
		delete(uri: Uri, range: Range): void;
E
Erich Gamma 已提交
2362

J
Johannes Rieken 已提交
2363 2364 2365
		/**
		 * Check if this edit affects the given resource.
		 * @param uri A resource identifier.
A
Andre Weinand 已提交
2366
		 * @return `true` if the given resource will be touched by this edit.
J
Johannes Rieken 已提交
2367
		 */
E
Erich Gamma 已提交
2368 2369
		has(uri: Uri): boolean;

J
Johannes Rieken 已提交
2370 2371 2372 2373 2374 2375
		/**
		 * Set (and replace) text edits for a resource.
		 *
		 * @param uri A resource identifier.
		 * @param edits An array of text edits.
		 */
E
Erich Gamma 已提交
2376 2377
		set(uri: Uri, edits: TextEdit[]): void;

J
Johannes Rieken 已提交
2378 2379 2380 2381 2382 2383
		/**
		 * Get the text edits for a resource.
		 *
		 * @param uri A resource identifier.
		 * @return An array of text edits.
		 */
E
Erich Gamma 已提交
2384 2385
		get(uri: Uri): TextEdit[];

J
Johannes Rieken 已提交
2386 2387 2388 2389 2390
		/**
		 * Get all text edits grouped by resource.
		 *
		 * @return An array of `[Uri, TextEdit[]]`-tuples.
		 */
E
Erich Gamma 已提交
2391 2392 2393
		entries(): [Uri, TextEdit[]][];
	}

2394 2395 2396 2397 2398 2399
	/**
	 * 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
2400 2401
	 * the end of the snippet. Variables are defined with `$name` and
	 * `${name:default value}`. The full snippet syntax is documented
G
Greg Van Liew 已提交
2402
	 * [here](http://code.visualstudio.com/docs/editor/userdefinedsnippets#_creating-your-own-snippets).
2403 2404 2405 2406 2407 2408 2409 2410
	 */
	export class SnippetString {

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

2411 2412 2413 2414 2415 2416 2417
		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.
2418
		 * @return This snippet string.
2419 2420 2421 2422 2423 2424 2425 2426 2427
		 */
		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.
2428
		 * @return This snippet string.
2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439
		 */
		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.
2440
		 * @return This snippet string.
2441 2442
		 */
		appendPlaceholder(value: string | ((snippet: SnippetString) => any), number?: number): SnippetString;
2443 2444

		/**
J
Johannes Rieken 已提交
2445
		 * Builder-function that appends a variable (`${VAR}`) to
2446 2447 2448 2449 2450 2451 2452 2453
		 * 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;
2454 2455
	}

E
Erich Gamma 已提交
2456
	/**
J
Johannes Rieken 已提交
2457 2458
	 * 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 已提交
2459 2460
	 */
	export interface RenameProvider {
J
Johannes Rieken 已提交
2461 2462 2463 2464 2465 2466 2467 2468 2469 2470

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

J
Johannes Rieken 已提交
2476 2477 2478
	/**
	 * Value-object describing what options formatting should use.
	 */
E
Erich Gamma 已提交
2479
	export interface FormattingOptions {
J
Johannes Rieken 已提交
2480 2481 2482 2483

		/**
		 * Size of a tab in spaces.
		 */
E
Erich Gamma 已提交
2484
		tabSize: number;
J
Johannes Rieken 已提交
2485 2486 2487 2488

		/**
		 * Prefer spaces over tabs.
		 */
E
Erich Gamma 已提交
2489
		insertSpaces: boolean;
J
Johannes Rieken 已提交
2490 2491 2492 2493 2494

		/**
		 * Signature for further properties.
		 */
		[key: string]: boolean | number | string;
E
Erich Gamma 已提交
2495 2496 2497
	}

	/**
J
Johannes Rieken 已提交
2498 2499
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
2500 2501
	 */
	export interface DocumentFormattingEditProvider {
J
Johannes Rieken 已提交
2502 2503 2504 2505 2506 2507 2508 2509

		/**
		 * 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 已提交
2510
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2511
		 */
2512
		provideDocumentFormattingEdits(document: TextDocument, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
2513 2514 2515
	}

	/**
J
Johannes Rieken 已提交
2516 2517
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
2518 2519
	 */
	export interface DocumentRangeFormattingEditProvider {
J
Johannes Rieken 已提交
2520 2521 2522 2523 2524

		/**
		 * 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 已提交
2525 2526
		 * or larger range. Often this is done by adjusting the start and end
		 * of the range to full syntax nodes.
J
Johannes Rieken 已提交
2527 2528 2529 2530 2531 2532
		 *
		 * @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 已提交
2533
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2534
		 */
2535
		provideDocumentRangeFormattingEdits(document: TextDocument, range: Range, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
2536 2537 2538
	}

	/**
J
Johannes Rieken 已提交
2539 2540
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
2541 2542
	 */
	export interface OnTypeFormattingEditProvider {
J
Johannes Rieken 已提交
2543 2544 2545 2546 2547 2548 2549 2550 2551 2552

		/**
		 * 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 已提交
2553
		 * @param ch The character that has been typed.
J
Johannes Rieken 已提交
2554 2555 2556
		 * @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 已提交
2557
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2558
		 */
2559
		provideOnTypeFormattingEdits(document: TextDocument, position: Position, ch: string, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
2560 2561
	}

J
Johannes Rieken 已提交
2562 2563 2564 2565
	/**
	 * Represents a parameter of a callable-signature. A parameter can
	 * have a label and a doc-comment.
	 */
E
Erich Gamma 已提交
2566
	export class ParameterInformation {
J
Johannes Rieken 已提交
2567 2568 2569 2570 2571

		/**
		 * The label of this signature. Will be shown in
		 * the UI.
		 */
E
Erich Gamma 已提交
2572
		label: string;
J
Johannes Rieken 已提交
2573 2574 2575 2576 2577

		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
2578
		documentation?: string | MarkdownString;
J
Johannes Rieken 已提交
2579 2580 2581 2582 2583 2584 2585

		/**
		 * Creates a new parameter information object.
		 *
		 * @param label A label string.
		 * @param documentation A doc string.
		 */
2586
		constructor(label: string, documentation?: string | MarkdownString);
E
Erich Gamma 已提交
2587 2588
	}

J
Johannes Rieken 已提交
2589 2590 2591 2592 2593
	/**
	 * 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 已提交
2594
	export class SignatureInformation {
J
Johannes Rieken 已提交
2595 2596 2597 2598 2599

		/**
		 * The label of this signature. Will be shown in
		 * the UI.
		 */
E
Erich Gamma 已提交
2600
		label: string;
J
Johannes Rieken 已提交
2601 2602 2603 2604 2605

		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
2606
		documentation?: string | MarkdownString;
J
Johannes Rieken 已提交
2607 2608 2609 2610

		/**
		 * The parameters of this signature.
		 */
E
Erich Gamma 已提交
2611
		parameters: ParameterInformation[];
J
Johannes Rieken 已提交
2612 2613 2614 2615 2616

		/**
		 * Creates a new signature information object.
		 *
		 * @param label A label string.
J
Johannes Rieken 已提交
2617
		 * @param documentation A doc string.
J
Johannes Rieken 已提交
2618
		 */
2619
		constructor(label: string, documentation?: string | MarkdownString);
E
Erich Gamma 已提交
2620 2621
	}

J
Johannes Rieken 已提交
2622 2623
	/**
	 * Signature help represents the signature of something
S
Steven Clarke 已提交
2624
	 * callable. There can be multiple signatures but only one
J
Johannes Rieken 已提交
2625 2626
	 * active and only one active parameter.
	 */
E
Erich Gamma 已提交
2627
	export class SignatureHelp {
J
Johannes Rieken 已提交
2628 2629 2630 2631

		/**
		 * One or more signatures.
		 */
E
Erich Gamma 已提交
2632
		signatures: SignatureInformation[];
J
Johannes Rieken 已提交
2633 2634 2635 2636

		/**
		 * The active signature.
		 */
E
Erich Gamma 已提交
2637
		activeSignature: number;
J
Johannes Rieken 已提交
2638 2639 2640 2641

		/**
		 * The active parameter of the active signature.
		 */
E
Erich Gamma 已提交
2642 2643 2644
		activeParameter: number;
	}

J
Johannes Rieken 已提交
2645 2646
	/**
	 * The signature help provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
2647
	 * the [parameter hints](https://code.visualstudio.com/docs/editor/intellisense)-feature.
J
Johannes Rieken 已提交
2648
	 */
E
Erich Gamma 已提交
2649
	export interface SignatureHelpProvider {
J
Johannes Rieken 已提交
2650 2651 2652 2653 2654 2655 2656 2657

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

J
Johannes Rieken 已提交
2663 2664 2665
	/**
	 * Completion item kinds.
	 */
E
Erich Gamma 已提交
2666
	export enum CompletionItemKind {
2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682
		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,
2683
		Reference = 17,
2684
		File = 16,
2685 2686 2687 2688 2689
		Folder = 18,
		EnumMember = 19,
		Constant = 20,
		Struct = 21,
		Event = 22,
2690 2691
		Operator = 23,
		TypeParameter = 24
E
Erich Gamma 已提交
2692 2693
	}

J
Johannes Rieken 已提交
2694
	/**
2695
	 * A completion item represents a text snippet that is proposed to complete text that is being typed.
J
Johannes Rieken 已提交
2696
	 *
2697 2698 2699 2700
	 * 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.
2701
	 *
2702 2703 2704
	 * 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.
2705
	 *
J
Johannes Rieken 已提交
2706 2707
	 * @see [CompletionItemProvider.provideCompletionItems](#CompletionItemProvider.provideCompletionItems)
	 * @see [CompletionItemProvider.resolveCompletionItem](#CompletionItemProvider.resolveCompletionItem)
J
Johannes Rieken 已提交
2708
	 */
E
Erich Gamma 已提交
2709
	export class CompletionItem {
J
Johannes Rieken 已提交
2710 2711 2712

		/**
		 * The label of this completion item. By default
A
Andre Weinand 已提交
2713
		 * this is also the text that is inserted when selecting
J
Johannes Rieken 已提交
2714 2715
		 * this completion.
		 */
E
Erich Gamma 已提交
2716
		label: string;
J
Johannes Rieken 已提交
2717 2718

		/**
S
Steven Clarke 已提交
2719
		 * The kind of this completion item. Based on the kind
J
Johannes Rieken 已提交
2720 2721
		 * an icon is chosen by the editor.
		 */
2722
		kind?: CompletionItemKind;
J
Johannes Rieken 已提交
2723 2724 2725 2726 2727

		/**
		 * A human-readable string with additional information
		 * about this item, like type or symbol information.
		 */
2728
		detail?: string;
J
Johannes Rieken 已提交
2729 2730 2731 2732

		/**
		 * A human-readable string that represents a doc-comment.
		 */
2733
		documentation?: string | MarkdownString;
J
Johannes Rieken 已提交
2734 2735

		/**
A
Andre Weinand 已提交
2736
		 * A string that should be used when comparing this item
J
Johannes Rieken 已提交
2737 2738 2739
		 * with other items. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
2740
		sortText?: string;
J
Johannes Rieken 已提交
2741 2742 2743 2744 2745 2746

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

		/**
2750
		 * A string or snippet that should be inserted in a document when selecting
J
Johannes Rieken 已提交
2751 2752 2753
		 * this completion. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
2754
		insertText?: string | SnippetString;
2755 2756 2757 2758 2759 2760 2761 2762 2763 2764

		/**
		 * 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).
		 */
2765
		range?: Range;
J
Johannes Rieken 已提交
2766

2767 2768
		/**
		 * An optional set of characters that when pressed while this completion is active will accept it first and
J
Johannes Rieken 已提交
2769
		 * then type that character. *Note* that all commit characters should have `length=1` and that superfluous
2770 2771 2772 2773
		 * characters will be ignored.
		 */
		commitCharacters?: string[];

J
Johannes Rieken 已提交
2774
		/**
2775
		 * @deprecated Use `CompletionItem.insertText` and `CompletionItem.range` instead.
2776 2777
		 *
		 * ~~An [edit](#TextEdit) which is applied to a document when selecting
J
Johannes Rieken 已提交
2778
		 * this completion. When an edit is provided the value of
2779
		 * [insertText](#CompletionItem.insertText) is ignored.~~
2780
		 *
2781 2782
		 * ~~The [range](#Range) of the edit must be single-line and on the same
		 * line completions were [requested](#CompletionItemProvider.provideCompletionItems) at.~~
J
Johannes Rieken 已提交
2783
		 */
2784
		textEdit?: TextEdit;
J
Johannes Rieken 已提交
2785

2786 2787 2788 2789 2790
		/**
		 * 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.
		 */
2791
		additionalTextEdits?: TextEdit[];
2792 2793

		/**
2794 2795
		 * An optional [command](#Command) that is executed *after* inserting this completion. *Note* that
		 * additional modifications to the current document should be described with the
2796 2797
		 * [additionalTextEdits](#CompletionItem.additionalTextEdits)-property.
		 */
2798
		command?: Command;
2799

J
Johannes Rieken 已提交
2800 2801 2802 2803 2804 2805 2806
		/**
		 * 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.
2807
		 * @param kind The [kind](#CompletionItemKind) of the completion.
J
Johannes Rieken 已提交
2808
		 */
2809
		constructor(label: string, kind?: CompletionItemKind);
E
Erich Gamma 已提交
2810 2811
	}

2812 2813 2814 2815
	/**
	 * Represents a collection of [completion items](#CompletionItem) to be presented
	 * in the editor.
	 */
J
Johannes Rieken 已提交
2816
	export class CompletionList {
2817 2818 2819 2820 2821

		/**
		 * This list it not complete. Further typing should result in recomputing
		 * this list.
		 */
2822
		isIncomplete?: boolean;
2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837

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

M
Matt Bierner 已提交
2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851
	/**
	 * How a [completion provider](#CompletionItemProvider) was triggered
	 */
	export enum CompletionTriggerKind {
		/**
		 * Completion was triggered normally.
		 */
		Invoke = 0,
		/**
		 * Completion was triggered by a trigger character.
		 */
		TriggerCharacter = 1
	}

2852 2853 2854 2855 2856
	/**
	 * Contains additional information about the context in which
	 * [completion provider](#CompletionItemProvider.provideCompletionItems) is triggered.
	 */
	export interface CompletionContext {
2857 2858 2859
		/**
		 * How the completion was triggered.
		 */
M
Matt Bierner 已提交
2860
		readonly triggerKind: CompletionTriggerKind;
2861

2862 2863 2864
		/**
		 * Character that triggered the completion item provider.
		 *
M
Matt Bierner 已提交
2865
		 * `undefined` if provider was not triggered by a character.
M
Matt Bierner 已提交
2866 2867
		 *
		 * The trigger character is already in the document when the completion provider is triggered.
2868 2869 2870 2871
		 */
		readonly triggerCharacter?: string;
	}

J
Johannes Rieken 已提交
2872 2873
	/**
	 * The completion item provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
2874
	 * [IntelliSense](https://code.visualstudio.com/docs/editor/intellisense).
J
Johannes Rieken 已提交
2875 2876 2877 2878
	 *
	 * 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 已提交
2879
	 * [provideCompletionItems](#CompletionItemProvider.provideCompletionItems)-function. Subsequently,
S
Steven Clarke 已提交
2880
	 * when a completion item is shown in the UI and gains focus this provider is asked to resolve
J
Johannes Rieken 已提交
2881
	 * the item, like adding [doc-comment](#CompletionItem.documentation) or [details](#CompletionItem.detail).
2882 2883 2884
	 *
	 * 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 已提交
2885
	 */
E
Erich Gamma 已提交
2886
	export interface CompletionItemProvider {
J
Johannes Rieken 已提交
2887 2888

		/**
J
Johannes Rieken 已提交
2889
		 * Provide completion items for the given position and document.
J
Johannes Rieken 已提交
2890
		 *
J
Johannes Rieken 已提交
2891 2892 2893
		 * @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.
M
Matt Bierner 已提交
2894 2895
		 * @param context How the completion was triggered.
		 *
2896 2897
		 * @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 已提交
2898
		 */
M
Matt Bierner 已提交
2899
		provideCompletionItems(document: TextDocument, position: Position, token: CancellationToken, context: CompletionContext): ProviderResult<CompletionItem[] | CompletionList>;
J
Johannes Rieken 已提交
2900 2901

		/**
J
Johannes Rieken 已提交
2902 2903 2904 2905
		 * 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 已提交
2906
		 *
J
Johannes Rieken 已提交
2907 2908
		 * @param item A completion item currently active in the UI.
		 * @param token A cancellation token.
S
Steven Clarke 已提交
2909
		 * @return The resolved completion item or a thenable that resolves to of such. It is OK to return the given
J
Johannes Rieken 已提交
2910
		 * `item`. When no result is returned, the given `item` will be used.
J
Johannes Rieken 已提交
2911
		 */
2912
		resolveCompletionItem?(item: CompletionItem, token: CancellationToken): ProviderResult<CompletionItem>;
E
Erich Gamma 已提交
2913 2914
	}

J
Johannes Rieken 已提交
2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929

	/**
	 * 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.
		 */
2930
		target?: Uri;
J
Johannes Rieken 已提交
2931 2932 2933 2934 2935 2936 2937

		/**
		 * 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.
		 */
2938
		constructor(range: Range, target?: Uri);
J
Johannes Rieken 已提交
2939 2940 2941 2942 2943 2944 2945 2946 2947
	}

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

		/**
2948 2949 2950
		 * 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 已提交
2951 2952 2953
		 * @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
2954
		 * can be signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2955
		 */
2956
		provideDocumentLinks(document: TextDocument, token: CancellationToken): ProviderResult<DocumentLink[]>;
2957 2958 2959 2960 2961 2962 2963 2964 2965 2966

		/**
		 * 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.
		 */
2967
		resolveDocumentLink?(link: DocumentLink, token: CancellationToken): ProviderResult<DocumentLink>;
J
Johannes Rieken 已提交
2968 2969
	}

J
Johannes Rieken 已提交
2970 2971 2972 2973
	/**
	 * A tuple of two characters, like a pair of
	 * opening and closing brackets.
	 */
E
Erich Gamma 已提交
2974 2975
	export type CharacterPair = [string, string];

J
Johannes Rieken 已提交
2976 2977 2978
	/**
	 * Describes how comments for a language work.
	 */
E
Erich Gamma 已提交
2979
	export interface CommentRule {
J
Johannes Rieken 已提交
2980 2981 2982 2983

		/**
		 * The line comment token, like `// this is a comment`
		 */
E
Erich Gamma 已提交
2984
		lineComment?: string;
J
Johannes Rieken 已提交
2985 2986 2987 2988 2989

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

A
Alex Dima 已提交
2992 2993 2994
	/**
	 * Describes indentation rules for a language.
	 */
E
Erich Gamma 已提交
2995
	export interface IndentationRule {
A
Alex Dima 已提交
2996 2997 2998
		/**
		 * If a line matches this pattern, then all the lines after it should be unindendented once (until another rule matches).
		 */
E
Erich Gamma 已提交
2999
		decreaseIndentPattern: RegExp;
A
Alex Dima 已提交
3000 3001 3002
		/**
		 * If a line matches this pattern, then all the lines after it should be indented once (until another rule matches).
		 */
E
Erich Gamma 已提交
3003
		increaseIndentPattern: RegExp;
A
Alex Dima 已提交
3004 3005 3006
		/**
		 * If a line matches this pattern, then **only the next line** after it should be indented once.
		 */
E
Erich Gamma 已提交
3007
		indentNextLinePattern?: RegExp;
A
Alex Dima 已提交
3008 3009 3010
		/**
		 * 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 已提交
3011 3012 3013
		unIndentedLinePattern?: RegExp;
	}

A
Alex Dima 已提交
3014 3015 3016
	/**
	 * Describes what to do with the indentation when pressing Enter.
	 */
E
Erich Gamma 已提交
3017
	export enum IndentAction {
A
Alex Dima 已提交
3018 3019 3020
		/**
		 * Insert new line and copy the previous line's indentation.
		 */
3021
		None = 0,
A
Alex Dima 已提交
3022 3023 3024
		/**
		 * Insert new line and indent once (relative to the previous line's indentation).
		 */
3025
		Indent = 1,
A
Alex Dima 已提交
3026 3027 3028 3029 3030
		/**
		 * Insert two new lines:
		 *  - the first one indented which will hold the cursor
		 *  - the second one at the same indentation level
		 */
3031
		IndentOutdent = 2,
A
Alex Dima 已提交
3032 3033 3034
		/**
		 * Insert new line and outdent once (relative to the previous line's indentation).
		 */
3035
		Outdent = 3
E
Erich Gamma 已提交
3036 3037
	}

A
Alex Dima 已提交
3038 3039 3040
	/**
	 * Describes what to do when pressing Enter.
	 */
E
Erich Gamma 已提交
3041
	export interface EnterAction {
A
Alex Dima 已提交
3042 3043 3044 3045 3046 3047 3048
		/**
		 * 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 已提交
3049
		appendText?: string;
A
Alex Dima 已提交
3050 3051 3052 3053
		/**
		 * Describes the number of characters to remove from the new line's indentation.
		 */
		removeText?: number;
E
Erich Gamma 已提交
3054 3055
	}

A
Alex Dima 已提交
3056 3057 3058
	/**
	 * Describes a rule to be evaluated when pressing Enter.
	 */
E
Erich Gamma 已提交
3059
	export interface OnEnterRule {
A
Alex Dima 已提交
3060 3061 3062
		/**
		 * This rule will only execute if the text before the cursor matches this regular expression.
		 */
E
Erich Gamma 已提交
3063
		beforeText: RegExp;
A
Alex Dima 已提交
3064 3065 3066
		/**
		 * This rule will only execute if the text after the cursor matches this regular expression.
		 */
E
Erich Gamma 已提交
3067
		afterText?: RegExp;
A
Alex Dima 已提交
3068 3069 3070
		/**
		 * The action to execute.
		 */
E
Erich Gamma 已提交
3071 3072 3073
		action: EnterAction;
	}

J
Johannes Rieken 已提交
3074
	/**
A
Andre Weinand 已提交
3075
	 * The language configuration interfaces defines the contract between extensions
S
Steven Clarke 已提交
3076
	 * and various editor features, like automatic bracket insertion, automatic indentation etc.
J
Johannes Rieken 已提交
3077
	 */
E
Erich Gamma 已提交
3078
	export interface LanguageConfiguration {
A
Alex Dima 已提交
3079 3080 3081
		/**
		 * The language's comment settings.
		 */
E
Erich Gamma 已提交
3082
		comments?: CommentRule;
A
Alex Dima 已提交
3083 3084 3085 3086
		/**
		 * The language's brackets.
		 * This configuration implicitly affects pressing Enter around these brackets.
		 */
E
Erich Gamma 已提交
3087
		brackets?: CharacterPair[];
A
Alex Dima 已提交
3088 3089 3090 3091 3092 3093 3094
		/**
		 * 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 已提交
3095
		wordPattern?: RegExp;
A
Alex Dima 已提交
3096 3097 3098
		/**
		 * The language's indentation settings.
		 */
E
Erich Gamma 已提交
3099
		indentationRules?: IndentationRule;
A
Alex Dima 已提交
3100 3101 3102
		/**
		 * The language's rules to be evaluated when pressing Enter.
		 */
E
Erich Gamma 已提交
3103 3104 3105
		onEnterRules?: OnEnterRule[];

		/**
A
Alex Dima 已提交
3106
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
3107 3108
		 *
		 * @deprecated Will be replaced by a better API soon.
E
Erich Gamma 已提交
3109 3110
		 */
		__electricCharacterSupport?: {
3111 3112 3113 3114 3115 3116
			/**
			 * This property is deprecated and will be **ignored** from
			 * the editor.
			 * @deprecated
			 */
			brackets?: any;
3117 3118 3119 3120 3121 3122
			/**
			 * 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 已提交
3123
			docComment?: {
A
Alex Dima 已提交
3124 3125 3126 3127
				scope: string;
				open: string;
				lineStart: string;
				close?: string;
E
Erich Gamma 已提交
3128 3129 3130 3131
			};
		};

		/**
A
Alex Dima 已提交
3132
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
3133
		 *
3134
		 * @deprecated * Use the the autoClosingPairs property in the language configuration file instead.
E
Erich Gamma 已提交
3135 3136 3137 3138 3139 3140 3141 3142 3143 3144
		 */
		__characterPairSupport?: {
			autoClosingPairs: {
				open: string;
				close: string;
				notIn?: string[];
			}[];
		};
	}

J
Johannes Rieken 已提交
3145
	/**
S
Sandeep Somavarapu 已提交
3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166
	 * The configuration target
	 */
	export enum ConfigurationTarget {
		/**
		 * Global configuration
		*/
		Global = 1,

		/**
		 * Workspace configuration
		 */
		Workspace = 2,

		/**
		 * Workspace folder configuration
		 */
		WorkspaceFolder = 3
	}

	/**
	 * Represents the configuration. It is a merged view of
3167
	 *
S
Sandeep Somavarapu 已提交
3168 3169 3170 3171
	 * - Default configuration
	 * - Global configuration
	 * - Workspace configuration (if available)
	 * - Workspace folder configuration of the requested resource (if available)
3172
	 *
S
Sandeep Somavarapu 已提交
3173
	 * *Global configuration* comes from User Settings and shadows Defaults.
S
Sandeep Somavarapu 已提交
3174
	 *
S
Sandeep Somavarapu 已提交
3175
	 * *Workspace configuration* comes from Workspace Settings and shadows Global configuration.
S
Sandeep Somavarapu 已提交
3176
	 *
S
Sandeep Somavarapu 已提交
3177
	 * *Workspace Folder configuration* comes from `.vscode` folder under one of the [workspace folders](#workspace.workspaceFolders).
S
Sandeep Somavarapu 已提交
3178 3179
	 *
	 * *Note:* Workspace and Workspace Folder configurations contains `launch` and `tasks` settings. Their basename will be
3180 3181 3182
	 * part of the section identifier. The following snippets shows how to retrieve all configurations
	 * from `launch.json`:
	 *
3183
	 * ```ts
D
Daniel Imms 已提交
3184
	 * // launch.json configuration
S
Sandeep Somavarapu 已提交
3185
	 * const config = workspace.getConfiguration('launch', vscode.window.activeTextEditor.document.uri);
3186 3187
	 *
	 * // retrieve values
D
Daniel Imms 已提交
3188 3189
	 * const values = config.get('configurations');
	 * ```
S
Sandeep Somavarapu 已提交
3190 3191
	 *
	 * Refer to [Settings](https://code.visualstudio.com/docs/getstarted/settings) for more information.
J
Johannes Rieken 已提交
3192
	 */
E
Erich Gamma 已提交
3193 3194
	export interface WorkspaceConfiguration {

3195 3196 3197 3198 3199 3200 3201 3202
		/**
		 * 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 已提交
3203
		/**
J
Johannes Rieken 已提交
3204 3205 3206
		 * Return a value from this configuration.
		 *
		 * @param section Configuration name, supports _dotted_ names.
J
Johannes Rieken 已提交
3207
		 * @param defaultValue A value should be returned when no value could be found, is `undefined`.
J
Johannes Rieken 已提交
3208
		 * @return The value `section` denotes or the default.
E
Erich Gamma 已提交
3209
		 */
3210 3211
		get<T>(section: string, defaultValue: T): T;

E
Erich Gamma 已提交
3212
		/**
J
Johannes Rieken 已提交
3213 3214
		 * Check if this configuration has a certain value.
		 *
3215
		 * @param section Configuration name, supports _dotted_ names.
G
Gama11 已提交
3216
		 * @return `true` if the section doesn't resolve to `undefined`.
E
Erich Gamma 已提交
3217 3218 3219
		 */
		has(section: string): boolean;

3220 3221
		/**
		 * Retrieve all information about a configuration setting. A configuration value
S
Sandeep Somavarapu 已提交
3222 3223 3224 3225
		 * often consists of a *default* value, a global or installation-wide value,
		 * a workspace-specific value and a folder-specific value.
		 *
		 * The *effective* value (returned by [`get`](#WorkspaceConfiguration.get))
3226
		 * is computed like this: `defaultValue` overwritten by `globalValue`,
S
Sandeep Somavarapu 已提交
3227
		 * `globalValue` overwritten by `workspaceValue`. `workspaceValue` overwritten by `workspaceFolderValue`.
S
Sandeep Somavarapu 已提交
3228
		 * Refer to [Settings Inheritence](https://code.visualstudio.com/docs/getstarted/settings)
S
Sandeep Somavarapu 已提交
3229
		 * for more information.
3230 3231 3232 3233 3234 3235 3236
		 *
		 * *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`.
		 */
S
Sandeep Somavarapu 已提交
3237
		inspect<T>(section: string): { key: string; defaultValue?: T; globalValue?: T; workspaceValue?: T, workspaceFolderValue?: T } | undefined;
S
Sandeep Somavarapu 已提交
3238 3239

		/**
S
Sandeep Somavarapu 已提交
3240
		 * Update a configuration value. The updated configuration values are persisted.
S
Sandeep Somavarapu 已提交
3241
		 *
S
Sandeep Somavarapu 已提交
3242
		 * A value can be changed in
S
Sandeep Somavarapu 已提交
3243
		 *
S
Sandeep Somavarapu 已提交
3244 3245 3246 3247
		 * - [Global configuration](#ConfigurationTarget.Global): Changes the value for all instances of the editor.
		 * - [Workspace configuration](#ConfigurationTarget.Workspace): Changes the value for current workspace, if available.
		 * - [Workspace folder configuration](#ConfigurationTarget.WorkspaceFolder): Changes the value for the
		 * [Workspace folder](#workspace.workspaceFolders) to which the current [configuration](#WorkspaceConfiguration) is scoped to.
S
Sandeep Somavarapu 已提交
3248
		 *
S
Sandeep Somavarapu 已提交
3249 3250 3251 3252 3253
		 * *Note 1:* Setting a global value in the presence of a more specific workspace value
		 * has no observable effect in that workspace, but in others. Setting a workspace value
		 * in the presence of a more specific folder value has no observable effect for the resources
		 * under respective [folder](#workspace.workspaceFolders), but in others. Refer to
		 * [Settings Inheritence](https://code.visualstudio.com/docs/getstarted/settings) for more information.
3254
		 *
3255 3256
		 * *Note 2:* To remove a configuration value use `undefined`, like so: `config.update('somekey', undefined)`
		 *
S
Sandeep Somavarapu 已提交
3257 3258 3259
		 * Will throw error when
		 * - Writing a configuration which is not registered.
		 * - Writing a configuration to workspace or folder target when no workspace is opened
S
Sandeep Somavarapu 已提交
3260
		 * - Writing a configuration to folder target when there is no folder settings
S
Sandeep Somavarapu 已提交
3261 3262 3263
		 * - Writing to folder target without passing a resource when getting the configuration (`workspace.getConfiguration(section, resource)`)
		 * - Writing a window configuration to folder target
		 *
3264 3265
		 * @param section Configuration name, supports _dotted_ names.
		 * @param value The new value.
S
Sandeep Somavarapu 已提交
3266
		 * @param configurationTarget The [configuration target](#ConfigurationTarget) or a boolean value.
S
Sandeep Somavarapu 已提交
3267 3268 3269 3270 3271
		 *	- If `true` configuration target is `ConfigurationTarget.Global`.
		 *	- If `false` configuration target is `ConfigurationTarget.Workspace`.
		 *	- If `undefined` or `null` configuration target is
		 *	`ConfigurationTarget.WorkspaceFolder` when configuration is resource specific
		 *	`ConfigurationTarget.Workspace` otherwise.
3272
		 */
S
Sandeep Somavarapu 已提交
3273
		update(section: string, value: any, configurationTarget?: ConfigurationTarget | boolean): Thenable<void>;
3274

E
Erich Gamma 已提交
3275 3276 3277
		/**
		 * Readable dictionary that backs this configuration.
		 */
3278
		readonly [key: string]: any;
E
Erich Gamma 已提交
3279 3280
	}

J
Johannes Rieken 已提交
3281 3282 3283 3284 3285
	/**
	 * Represents a location inside a resource, such as a line
	 * inside a text file.
	 */
	export class Location {
J
Johannes Rieken 已提交
3286 3287 3288 3289

		/**
		 * The resource identifier of this location.
		 */
J
Johannes Rieken 已提交
3290
		uri: Uri;
J
Johannes Rieken 已提交
3291 3292 3293 3294

		/**
		 * The document range of this locations.
		 */
J
Johannes Rieken 已提交
3295
		range: Range;
J
Johannes Rieken 已提交
3296 3297 3298 3299 3300 3301 3302 3303

		/**
		 * 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 已提交
3304 3305
	}

E
Erich Gamma 已提交
3306 3307 3308 3309
	/**
	 * Represents the severity of diagnostics.
	 */
	export enum DiagnosticSeverity {
J
Johannes Rieken 已提交
3310 3311

		/**
S
Steven Clarke 已提交
3312
		 * Something not allowed by the rules of a language or other means.
J
Johannes Rieken 已提交
3313 3314 3315 3316 3317 3318
		 */
		Error = 0,

		/**
		 * Something suspicious but allowed.
		 */
E
Erich Gamma 已提交
3319
		Warning = 1,
J
Johannes Rieken 已提交
3320 3321 3322 3323 3324 3325 3326

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

		/**
A
Andre Weinand 已提交
3327
		 * Something to hint to a better way of doing it, like proposing
J
Johannes Rieken 已提交
3328 3329 3330
		 * a refactoring.
		 */
		Hint = 3
E
Erich Gamma 已提交
3331 3332 3333
	}

	/**
J
Johannes Rieken 已提交
3334 3335
	 * Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
	 * are only valid in the scope of a file.
E
Erich Gamma 已提交
3336
	 */
J
Johannes Rieken 已提交
3337 3338 3339 3340 3341
	export class Diagnostic {

		/**
		 * The range to which this diagnostic applies.
		 */
E
Erich Gamma 已提交
3342
		range: Range;
J
Johannes Rieken 已提交
3343 3344 3345 3346 3347 3348

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

3349 3350 3351 3352 3353 3354
		/**
		 * A human-readable string describing the source of this
		 * diagnostic, e.g. 'typescript' or 'super lint'.
		 */
		source: string;

J
Johannes Rieken 已提交
3355 3356 3357 3358 3359 3360
		/**
		 * The severity, default is [error](#DiagnosticSeverity.Error).
		 */
		severity: DiagnosticSeverity;

		/**
S
Steven Clarke 已提交
3361
		 * A code or identifier for this diagnostics. Will not be surfaced
A
Andre Weinand 已提交
3362
		 * to the user, but should be used for later processing, e.g. when
J
Johannes Rieken 已提交
3363 3364 3365 3366 3367
		 * providing [code actions](#CodeActionContext).
		 */
		code: string | number;

		/**
A
Andre Weinand 已提交
3368
		 * Creates a new diagnostic object.
J
Johannes Rieken 已提交
3369 3370 3371
		 *
		 * @param range The range to which this diagnostic applies.
		 * @param message The human-readable message.
A
Andre Weinand 已提交
3372
		 * @param severity The severity, default is [error](#DiagnosticSeverity.Error).
J
Johannes Rieken 已提交
3373 3374
		 */
		constructor(range: Range, message: string, severity?: DiagnosticSeverity);
E
Erich Gamma 已提交
3375 3376
	}

J
Johannes Rieken 已提交
3377 3378 3379
	/**
	 * A diagnostics collection is a container that manages a set of
	 * [diagnostics](#Diagnostic). Diagnostics are always scopes to a
3380
	 * diagnostics collection and a resource.
J
Johannes Rieken 已提交
3381 3382 3383 3384
	 *
	 * To get an instance of a `DiagnosticCollection` use
	 * [createDiagnosticCollection](#languages.createDiagnosticCollection).
	 */
E
Erich Gamma 已提交
3385 3386 3387
	export interface DiagnosticCollection {

		/**
J
Johannes Rieken 已提交
3388 3389 3390
		 * 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 已提交
3391
		 */
Y
Yuki Ueda 已提交
3392
		readonly name: string;
E
Erich Gamma 已提交
3393 3394 3395

		/**
		 * Assign diagnostics for given resource. Will replace
J
Johannes Rieken 已提交
3396 3397 3398 3399
		 * existing diagnostics for that resource.
		 *
		 * @param uri A resource identifier.
		 * @param diagnostics Array of diagnostics or `undefined`
E
Erich Gamma 已提交
3400
		 */
3401
		set(uri: Uri, diagnostics: Diagnostic[] | undefined): void;
E
Erich Gamma 已提交
3402 3403

		/**
3404
		 * Replace all entries in this collection.
J
Johannes Rieken 已提交
3405
		 *
3406 3407 3408 3409 3410 3411
		 * 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 已提交
3412
		 */
3413
		set(entries: [Uri, Diagnostic[] | undefined][]): void;
E
Erich Gamma 已提交
3414 3415

		/**
3416 3417
		 * Remove all diagnostics from this collection that belong
		 * to the provided `uri`. The same as `#set(uri, undefined)`.
J
Johannes Rieken 已提交
3418
		 *
3419
		 * @param uri A resource identifier.
E
Erich Gamma 已提交
3420
		 */
3421
		delete(uri: Uri): void;
E
Erich Gamma 已提交
3422 3423 3424 3425 3426 3427 3428

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

3429 3430 3431 3432 3433 3434 3435 3436
		/**
		 * 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;

3437 3438 3439 3440 3441 3442 3443
		/**
		 * 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`.
		 */
3444
		get(uri: Uri): Diagnostic[] | undefined;
3445 3446 3447 3448 3449 3450 3451 3452 3453 3454

		/**
		 * 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 已提交
3455 3456 3457 3458
		/**
		 * Dispose and free associated resources. Calls
		 * [clear](#DiagnosticCollection.clear).
		 */
E
Erich Gamma 已提交
3459 3460 3461
		dispose(): void;
	}

J
Johannes Rieken 已提交
3462
	/**
J
Johannes Rieken 已提交
3463
	 * Denotes a column in the editor window. Columns are
J
Johannes Rieken 已提交
3464
	 * used to show editors side by side.
J
Johannes Rieken 已提交
3465 3466
	 */
	export enum ViewColumn {
3467
		Active = -1,
J
Johannes Rieken 已提交
3468 3469 3470 3471 3472
		One = 1,
		Two = 2,
		Three = 3
	}

E
Erich Gamma 已提交
3473
	/**
J
Johannes Rieken 已提交
3474 3475 3476 3477
	 * An output channel is a container for readonly textual information.
	 *
	 * To get an instance of an `OutputChannel` use
	 * [createOutputChannel](#window.createOutputChannel).
E
Erich Gamma 已提交
3478
	 */
J
Johannes Rieken 已提交
3479
	export interface OutputChannel {
E
Erich Gamma 已提交
3480

J
Johannes Rieken 已提交
3481 3482 3483
		/**
		 * The human-readable name of this output channel.
		 */
Y
Yuki Ueda 已提交
3484
		readonly name: string;
E
Erich Gamma 已提交
3485 3486

		/**
J
Johannes Rieken 已提交
3487
		 * Append the given value to the channel.
E
Erich Gamma 已提交
3488
		 *
J
Johannes Rieken 已提交
3489
		 * @param value A string, falsy values will not be printed.
E
Erich Gamma 已提交
3490
		 */
J
Johannes Rieken 已提交
3491
		append(value: string): void;
E
Erich Gamma 已提交
3492 3493

		/**
J
Johannes Rieken 已提交
3494 3495
		 * Append the given value and a line feed character
		 * to the channel.
E
Erich Gamma 已提交
3496
		 *
J
Johannes Rieken 已提交
3497
		 * @param value A string, falsy values will be printed.
E
Erich Gamma 已提交
3498 3499 3500
		 */
		appendLine(value: string): void;

J
Johannes Rieken 已提交
3501 3502 3503
		/**
		 * Removes all output from the channel.
		 */
E
Erich Gamma 已提交
3504 3505
		clear(): void;

J
Johannes Rieken 已提交
3506 3507
		/**
		 * Reveal this channel in the UI.
3508
		 *
3509
		 * @param preserveFocus When `true` the channel will not take focus.
J
Johannes Rieken 已提交
3510
		 */
J
Johannes Rieken 已提交
3511
		show(preserveFocus?: boolean): void;
E
Erich Gamma 已提交
3512

3513
		/**
3514
		 * ~~Reveal this channel in the UI.~~
3515
		 *
3516
		 * @deprecated Use the overload with just one parameter (`show(preserveFocus?: boolean): void`).
J
Johannes Rieken 已提交
3517 3518
		 *
		 * @param column This argument is **deprecated** and will be ignored.
3519 3520
		 * @param preserveFocus When `true` the channel will not take focus.
		 */
J
Johannes Rieken 已提交
3521
		show(column?: ViewColumn, preserveFocus?: boolean): void;
3522

J
Johannes Rieken 已提交
3523 3524 3525
		/**
		 * Hide this channel from the UI.
		 */
E
Erich Gamma 已提交
3526 3527
		hide(): void;

J
Johannes Rieken 已提交
3528 3529 3530
		/**
		 * Dispose and free associated resources.
		 */
E
Erich Gamma 已提交
3531 3532 3533 3534
		dispose(): void;
	}

	/**
J
Johannes Rieken 已提交
3535
	 * Represents the alignment of status bar items.
E
Erich Gamma 已提交
3536 3537
	 */
	export enum StatusBarAlignment {
J
Johannes Rieken 已提交
3538 3539 3540 3541

		/**
		 * Aligned to the left side.
		 */
3542
		Left = 1,
J
Johannes Rieken 已提交
3543 3544 3545 3546

		/**
		 * Aligned to the right side.
		 */
3547
		Right = 2
E
Erich Gamma 已提交
3548 3549 3550 3551 3552 3553 3554 3555 3556
	}

	/**
	 * 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 已提交
3557
		 * The alignment of this item.
E
Erich Gamma 已提交
3558
		 */
Y
Yuki Ueda 已提交
3559
		readonly alignment: StatusBarAlignment;
E
Erich Gamma 已提交
3560 3561

		/**
J
Johannes Rieken 已提交
3562 3563
		 * The priority of this item. Higher value means the item should
		 * be shown more to the left.
E
Erich Gamma 已提交
3564
		 */
Y
Yuki Ueda 已提交
3565
		readonly priority: number;
E
Erich Gamma 已提交
3566 3567

		/**
J
Johannes Rieken 已提交
3568 3569
		 * The text to show for the entry. You can embed icons in the text by leveraging the syntax:
		 *
3570
		 * `My text $(icon-name) contains icons like $(icon'name) this one.`
J
Johannes Rieken 已提交
3571
		 *
3572 3573
		 * 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 已提交
3574
		 */
E
Erich Gamma 已提交
3575 3576 3577
		text: string;

		/**
J
Johannes Rieken 已提交
3578 3579
		 * The tooltip text when you hover over this entry.
		 */
3580
		tooltip: string | undefined;
E
Erich Gamma 已提交
3581 3582

		/**
J
Johannes Rieken 已提交
3583 3584
		 * The foreground color for this entry.
		 */
3585
		color: string | ThemeColor | undefined;
E
Erich Gamma 已提交
3586 3587

		/**
J
Johannes Rieken 已提交
3588 3589 3590
		 * The identifier of a command to run on click. The command must be
		 * [known](#commands.getCommands).
		 */
3591
		command: string | undefined;
E
Erich Gamma 已提交
3592 3593 3594 3595 3596 3597 3598

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

		/**
J
Johannes Rieken 已提交
3599
		 * Hide the entry in the status bar.
E
Erich Gamma 已提交
3600 3601 3602 3603
		 */
		hide(): void;

		/**
J
Johannes Rieken 已提交
3604 3605
		 * Dispose and free associated resources. Call
		 * [hide](#StatusBarItem.hide).
E
Erich Gamma 已提交
3606 3607 3608 3609
		 */
		dispose(): void;
	}

3610 3611 3612 3613 3614 3615 3616 3617 3618
	/**
	 * 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 已提交
3619
		report(value: T): void;
3620 3621
	}

D
Daniel Imms 已提交
3622 3623 3624
	/**
	 * An individual terminal instance within the integrated terminal.
	 */
D
Daniel Imms 已提交
3625
	export interface Terminal {
D
Daniel Imms 已提交
3626

3627 3628 3629
		/**
		 * The name of the terminal.
		 */
Y
Yuki Ueda 已提交
3630
		readonly name: string;
3631

3632 3633 3634
		/**
		 * The process ID of the shell process.
		 */
Y
Yuki Ueda 已提交
3635
		readonly processId: Thenable<number>;
3636

D
Daniel Imms 已提交
3637
		/**
D
Daniel Imms 已提交
3638
		 * Send text to the terminal. The text is written to the stdin of the underlying pty process
3639
		 * (shell) of the terminal.
D
Daniel Imms 已提交
3640
		 *
D
Daniel Imms 已提交
3641
		 * @param text The text to send.
D
Daniel Imms 已提交
3642
		 * @param addNewLine Whether to add a new line to the text being sent, this is normally
3643 3644
		 * 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 已提交
3645
		 */
3646
		sendText(text: string, addNewLine?: boolean): void;
D
Daniel Imms 已提交
3647 3648

		/**
D
Daniel Imms 已提交
3649
		 * Show the terminal panel and reveal this terminal in the UI.
D
Daniel Imms 已提交
3650
		 *
D
Daniel Imms 已提交
3651
		 * @param preserveFocus When `true` the terminal will not take focus.
D
Daniel Imms 已提交
3652
		 */
D
Daniel Imms 已提交
3653
		show(preserveFocus?: boolean): void;
D
Daniel Imms 已提交
3654 3655

		/**
D
Daniel Imms 已提交
3656
		 * Hide the terminal panel if this terminal is currently showing.
D
Daniel Imms 已提交
3657 3658 3659 3660 3661 3662 3663
		 */
		hide(): void;

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

J
Johannes Rieken 已提交
3666 3667 3668
	/**
	 * Represents an extension.
	 *
A
Alex Dima 已提交
3669
	 * To get an instance of an `Extension` use [getExtension](#extensions.getExtension).
J
Johannes Rieken 已提交
3670
	 */
E
Erich Gamma 已提交
3671
	export interface Extension<T> {
J
Johannes Rieken 已提交
3672

E
Erich Gamma 已提交
3673
		/**
J
Johannes Rieken 已提交
3674
		 * The canonical extension identifier in the form of: `publisher.name`.
E
Erich Gamma 已提交
3675
		 */
Y
Yuki Ueda 已提交
3676
		readonly id: string;
E
Erich Gamma 已提交
3677 3678

		/**
J
Johannes Rieken 已提交
3679
		 * The absolute file path of the directory containing this extension.
E
Erich Gamma 已提交
3680
		 */
Y
Yuki Ueda 已提交
3681
		readonly extensionPath: string;
E
Erich Gamma 已提交
3682 3683

		/**
3684
		 * `true` if the extension has been activated.
E
Erich Gamma 已提交
3685
		 */
Y
Yuki Ueda 已提交
3686
		readonly isActive: boolean;
E
Erich Gamma 已提交
3687 3688 3689 3690

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

		/**
A
Alex Dima 已提交
3694
		 * The public API exported by this extension. It is an invalid action
J
Johannes Rieken 已提交
3695
		 * to access this field before this extension has been activated.
E
Erich Gamma 已提交
3696
		 */
Y
Yuki Ueda 已提交
3697
		readonly exports: T;
E
Erich Gamma 已提交
3698 3699 3700

		/**
		 * Activates this extension and returns its public API.
J
Johannes Rieken 已提交
3701
		 *
S
Steven Clarke 已提交
3702
		 * @return A promise that will resolve when this extension has been activated.
E
Erich Gamma 已提交
3703 3704 3705 3706
		 */
		activate(): Thenable<T>;
	}

J
Johannes Rieken 已提交
3707
	/**
S
Steven Clarke 已提交
3708 3709
	 * An extension context is a collection of utilities private to an
	 * extension.
J
Johannes Rieken 已提交
3710
	 *
S
Steven Clarke 已提交
3711
	 * An instance of an `ExtensionContext` is provided as the first
J
Johannes Rieken 已提交
3712 3713
	 * parameter to the `activate`-call of an extension.
	 */
E
Erich Gamma 已提交
3714 3715 3716 3717
	export interface ExtensionContext {

		/**
		 * An array to which disposables can be added. When this
J
Johannes Rieken 已提交
3718
		 * extension is deactivated the disposables will be disposed.
E
Erich Gamma 已提交
3719 3720 3721 3722 3723
		 */
		subscriptions: { dispose(): any }[];

		/**
		 * A memento object that stores state in the context
3724
		 * of the currently opened [workspace](#workspace.workspaceFolders).
E
Erich Gamma 已提交
3725 3726 3727 3728 3729
		 */
		workspaceState: Memento;

		/**
		 * A memento object that stores state independent
3730
		 * of the current opened [workspace](#workspace.workspaceFolders).
E
Erich Gamma 已提交
3731 3732 3733 3734
		 */
		globalState: Memento;

		/**
J
Johannes Rieken 已提交
3735
		 * The absolute file path of the directory containing the extension.
E
Erich Gamma 已提交
3736 3737 3738 3739
		 */
		extensionPath: string;

		/**
A
Alex Dima 已提交
3740 3741 3742 3743
		 * 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 已提交
3744 3745
		 */
		asAbsolutePath(relativePath: string): string;
D
Dirk Baeumer 已提交
3746 3747

		/**
J
Johannes Rieken 已提交
3748 3749 3750
		 * 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 已提交
3751
		 *
3752 3753
		 * Use [`workspaceState`](#ExtensionContext.workspaceState) or
		 * [`globalState`](#ExtensionContext.globalState) to store key value data.
D
Dirk Baeumer 已提交
3754
		 */
3755
		storagePath: string | undefined;
E
Erich Gamma 已提交
3756 3757 3758 3759 3760 3761 3762 3763
	}

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

3764 3765 3766 3767 3768 3769 3770 3771
		/**
		 * Return a value.
		 *
		 * @param key A string.
		 * @return The stored value or `undefined`.
		 */
		get<T>(key: string): T | undefined;

E
Erich Gamma 已提交
3772
		/**
J
Johannes Rieken 已提交
3773 3774 3775 3776 3777
		 * 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.
3778
		 * @return The stored value or the defaultValue.
E
Erich Gamma 已提交
3779
		 */
3780
		get<T>(key: string, defaultValue: T): T;
E
Erich Gamma 已提交
3781 3782

		/**
S
Steven Clarke 已提交
3783
		 * Store a value. The value must be JSON-stringifyable.
J
Johannes Rieken 已提交
3784 3785 3786
		 *
		 * @param key A string.
		 * @param value A value. MUST not contain cyclic references.
E
Erich Gamma 已提交
3787 3788 3789 3790
		 */
		update(key: string, value: any): Thenable<void>;
	}

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
	/**
	 * Controls the behaviour of the terminal's visibility.
	 */
	export enum TaskRevealKind {
		/**
		 * 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 how the task channel is used between tasks
	 */
	export enum TaskPanelKind {

		/**
		 * Shares a panel with other tasks. This is the default.
		 */
		Shared = 1,

		/**
		 * Uses a dedicated panel for this tasks. The panel is not
		 * shared with other tasks.
		 */
		Dedicated = 2,

		/**
		 * Creates a new panel whenever this task is executed.
		 */
		New = 3
	}

	/**
	 * Controls how the task is presented in the UI.
	 */
	export interface TaskPresentationOptions {
		/**
		 * Controls whether the task output is reveal in the user interface.
		 * Defaults to `RevealKind.Always`.
		 */
		reveal?: TaskRevealKind;

		/**
		 * Controls whether the command associated with the task is echoed
		 * in the user interface.
		 */
		echo?: boolean;

		/**
		 * Controls whether the panel showing the task output is taking focus.
		 */
		focus?: boolean;

		/**
		 * Controls if the task panel is used for this task only (dedicated),
		 * shared between tasks (shared) or if a new panel is created on
		 * every task execution (new). Defaults to `TaskInstanceKind.Shared`
		 */
		panel?: TaskPanelKind;
	}

	/**
	 * A grouping for tasks. The editor by default supports the
	 * 'Clean', 'Build', 'RebuildAll' and 'Test' group.
	 */
	export class TaskGroup {

		/**
		 * The clean task group;
		 */
		public static Clean: TaskGroup;

		/**
		 * The build task group;
		 */
		public static Build: TaskGroup;

		/**
		 * The rebuild all task group;
		 */
		public static Rebuild: TaskGroup;

		/**
		 * The test all task group;
		 */
		public static Test: TaskGroup;

		private constructor(id: string, label: string);
	}


	/**
	 * A structure that defines a task kind in the system.
	 * The value must be JSON-stringifyable.
	 */
	export interface TaskDefinition {
		/**
3899
		 * The task definition describing the task provided by an extension.
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
		 * Usually a task provider defines more properties to identify
		 * a task. They need to be defined in the package.json of the
		 * extension under the 'taskDefinitions' extension point. The npm
		 * task definition for example looks like this
		 * ```typescript
		 * interface NpmTaskDefinition extends TaskDefinition {
		 *     script: string;
		 * }
		 * ```
		 */
		readonly type: string;

		/**
		 * Additional attributes of a concrete task definition.
		 */
		[name: string]: any;
	}

	/**
	 * Options for a process execution
	 */
	export interface ProcessExecutionOptions {
		/**
		 * The current working directory of the executed program or shell.
		 * If omitted the tools 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 };
	}

	/**
3937
	 * The execution of a task happens as an external process
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 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025
	 * without shell interaction.
	 */
	export class ProcessExecution {

		/**
		 * Creates a process execution.
		 *
		 * @param process The process to start.
		 * @param options Optional options for the started process.
		 */
		constructor(process: string, options?: ProcessExecutionOptions);

		/**
		 * Creates a process execution.
		 *
		 * @param process The process to start.
		 * @param args Arguments to be passed to the process.
		 * @param options Optional options for the started process.
		 */
		constructor(process: string, args: string[], options?: ProcessExecutionOptions);

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

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

		/**
		 * The process options used when the process is executed.
		 * Defaults to undefined.
		 */
		options?: ProcessExecutionOptions;
	}

	/**
	 * Options for a shell execution
	 */
	export interface ShellExecutionOptions {
		/**
		 * 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 the tools 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 };
	}


	export class ShellExecution {
		/**
		 * Creates a process execution.
		 *
		 * @param commandLine The command line to execute.
		 * @param options Optional options for the started the shell.
		 */
		constructor(commandLine: string, options?: ShellExecutionOptions);

		/**
		 * The shell command line
		 */
		commandLine: string;

		/**
		 * The shell options used when the command line is executed in a shell.
		 * Defaults to undefined.
		 */
		options?: ShellExecutionOptions;
	}

D
Dirk Baeumer 已提交
4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040
	/**
	 * The scope of a task.
	 */
	export enum TaskScope {
		/**
		 * The task is a global task
		 */
		Global = 1,

		/**
		 * The task is a workspace task
		 */
		Workspace = 2
	}

4041 4042 4043 4044 4045 4046
	/**
	 * A task to execute
	 */
	export class Task {

		/**
J
Johannes Rieken 已提交
4047
		 * ~~Creates a new task.~~
4048
		 *
J
Johannes Rieken 已提交
4049
		 * @deprecated Use the new constructors that allow specifying a target for the task.
D
Dirk Baeumer 已提交
4050
		 *
4051
		 * @param definition The task definition as defined in the taskDefinitions extension point.
D
Dirk Baeumer 已提交
4052
		 * @param scope The task's name. Is presented in the user interface.
4053 4054 4055 4056 4057 4058 4059 4060
		 * @param source The task's source (e.g. 'gulp', 'npm', ...). Is presented in the user interface.
		 * @param execution The process or shell execution.
		 * @param problemMatchers the names of problem matchers to use, like '$tsc'
		 *  or '$eslint'. Problem matchers can be contributed by an extension using
		 *  the `problemMatchers` extension point.
		 */
		constructor(taskDefinition: TaskDefinition, name: string, source: string, execution?: ProcessExecution | ShellExecution, problemMatchers?: string | string[]);

D
Dirk Baeumer 已提交
4061 4062 4063 4064
		/**
		 * Creates a new task.
		 *
		 * @param definition The task definition as defined in the taskDefinitions extension point.
D
Dirk Baeumer 已提交
4065
		 * @param scope Specifies the task's scope. It is either a global or a workspace task or a task for a specific workspace folder.
D
Dirk Baeumer 已提交
4066 4067 4068 4069 4070 4071 4072 4073
		 * @param workspaceFolder The workspace folder this task is created for.
		 * @param name The task's name. Is presented in the user interface.
		 * @param source The task's source (e.g. 'gulp', 'npm', ...). Is presented in the user interface.
		 * @param execution The process or shell execution.
		 * @param problemMatchers the names of problem matchers to use, like '$tsc'
		 *  or '$eslint'. Problem matchers can be contributed by an extension using
		 *  the `problemMatchers` extension point.
		 */
4074
		constructor(taskDefinition: TaskDefinition, target: WorkspaceFolder | TaskScope.Global | TaskScope.Workspace, name: string, source: string, execution?: ProcessExecution | ShellExecution, problemMatchers?: string | string[]);
D
Dirk Baeumer 已提交
4075

4076 4077 4078 4079 4080
		/**
		 * The task's definition.
		 */
		definition: TaskDefinition;

D
Dirk Baeumer 已提交
4081
		/**
D
Dirk Baeumer 已提交
4082
		 * The task's scope.
D
Dirk Baeumer 已提交
4083
		 */
D
Dirk Baeumer 已提交
4084
		scope?: TaskScope.Global | TaskScope.Workspace | WorkspaceFolder;
D
Dirk Baeumer 已提交
4085

4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128
		/**
		 * The task's name
		 */
		name: string;

		/**
		 * The task's execution engine
		 */
		execution: ProcessExecution | ShellExecution;

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

		/**
		 * A human-readable string describing the source of this
		 * shell task, e.g. 'gulp' or 'npm'.
		 */
		source: string;

		/**
		 * The task group this tasks belongs to. See TaskGroup
		 * for a predefined set of available groups.
		 * Defaults to undefined meaning that the task doesn't
		 * belong to any special group.
		 */
		group?: TaskGroup;

		/**
		 * The presentation options. Defaults to an empty literal.
		 */
		presentationOptions: TaskPresentationOptions;

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

	/**
	 * A task provider allows to add tasks to the task service.
D
David Lechner 已提交
4129
	 * A task provider is registered via #workspace.registerTaskProvider.
4130 4131 4132 4133 4134 4135 4136 4137 4138 4139
	 */
	export interface TaskProvider {
		/**
		 * Provides tasks.
		 * @param token A cancellation token.
		 * @return an array of tasks
		 */
		provideTasks(token?: CancellationToken): ProviderResult<Task[]>;

		/**
4140 4141 4142 4143 4144
		 * Resolves a task that has no [`execution`](#Task.execution) set. Tasks are
		 * often created from information found in the `task.json`-file. Such tasks miss
		 * the information on how to execute them and a task provider must fill in
		 * the missing information in the `resolveTask`-method.
		 *
4145 4146
		 * @param task The task to resolve.
		 * @param token A cancellation token.
4147
		 * @return The resolved task
4148 4149 4150 4151
		 */
		resolveTask(task: Task, token?: CancellationToken): ProviderResult<Task>;
	}

4152 4153 4154 4155 4156
	/**
	 * Namespace describing the environment the editor runs in.
	 */
	export namespace env {

4157 4158 4159 4160 4161 4162 4163
		/**
		 * The application name of the editor, like 'VS Code'.
		 *
		 * @readonly
		 */
		export let appName: string;

J
Johannes Rieken 已提交
4164 4165 4166 4167 4168 4169 4170
		/**
		 * The application root folder from which the editor is running.
		 *
		 * @readonly
		 */
		export let appRoot: string;

J
Johannes Rieken 已提交
4171 4172 4173 4174 4175 4176 4177
		/**
		 * Represents the preferred user-language, like `de-CH`, `fr`, or `en-US`.
		 *
		 * @readonly
		 */
		export let language: string;

4178 4179
		/**
		 * A unique identifier for the computer.
J
Johannes Rieken 已提交
4180 4181
		 *
		 * @readonly
4182 4183 4184 4185 4186 4187
		 */
		export let machineId: string;

		/**
		 * A unique identifier for the current session.
		 * Changes each time the editor is started.
J
Johannes Rieken 已提交
4188 4189
		 *
		 * @readonly
4190 4191 4192 4193
		 */
		export let sessionId: string;
	}

E
Erich Gamma 已提交
4194
	/**
4195 4196 4197 4198 4199 4200 4201 4202
	 * 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 已提交
4203
	 * the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette).
4204
	 * * keybinding - Use the `keybindings`-section in `package.json` to enable
G
Greg Van Liew 已提交
4205
	 * [keybindings](https://code.visualstudio.com/docs/getstarted/keybindings#_customizing-shortcuts)
4206 4207
	 * for your extension.
	 *
S
Steven Clarke 已提交
4208
	 * Commands from other extensions and from the editor itself are accessible to an extension. However,
4209 4210 4211
	 * 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 已提交
4212
	 * register a command handler with the identifier `extension.sayHello`.
4213 4214
	 * ```javascript
	 * commands.registerCommand('extension.sayHello', () => {
4215
	 * 	window.showInformationMessage('Hello World!');
4216 4217
	 * });
	 * ```
G
Gama11 已提交
4218
	 * Second, bind the command identifier to a title under which it will show in the palette (`package.json`).
4219 4220
	 * ```json
	 * {
4221 4222 4223 4224 4225 4226
	 * 	"contributes": {
	 * 		"commands": [{
	 * 			"command": "extension.sayHello",
	 * 			"title": "Hello World"
	 * 		}]
	 * 	}
4227 4228
	 * }
	 * ```
E
Erich Gamma 已提交
4229 4230 4231 4232 4233
	 */
	export namespace commands {

		/**
		 * Registers a command that can be invoked via a keyboard shortcut,
S
Steven Clarke 已提交
4234
		 * a menu item, an action, or directly.
E
Erich Gamma 已提交
4235
		 *
J
Johannes Rieken 已提交
4236 4237 4238 4239 4240
		 * 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 已提交
4241
		 * @param thisArg The `this` context used when invoking the handler function.
J
Johannes Rieken 已提交
4242
		 * @return Disposable which unregisters this command on disposal.
E
Erich Gamma 已提交
4243 4244 4245 4246
		 */
		export function registerCommand(command: string, callback: (...args: any[]) => any, thisArg?: any): Disposable;

		/**
J
Johannes Rieken 已提交
4247
		 * Registers a text editor command that can be invoked via a keyboard shortcut,
S
Steven Clarke 已提交
4248
		 * a menu item, an action, or directly.
E
Erich Gamma 已提交
4249
		 *
J
Johannes Rieken 已提交
4250
		 * Text editor commands are different from ordinary [commands](#commands.registerCommand) as
S
Steven Clarke 已提交
4251
		 * they only execute when there is an active editor when the command is called. Also, the
J
Johannes Rieken 已提交
4252 4253 4254 4255 4256
		 * 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 已提交
4257
		 * @param thisArg The `this` context used when invoking the handler function.
J
Johannes Rieken 已提交
4258
		 * @return Disposable which unregisters this command on disposal.
E
Erich Gamma 已提交
4259
		 */
J
Johannes Rieken 已提交
4260
		export function registerTextEditorCommand(command: string, callback: (textEditor: TextEditor, edit: TextEditorEdit, ...args: any[]) => void, thisArg?: any): Disposable;
E
Erich Gamma 已提交
4261 4262

		/**
J
Johannes Rieken 已提交
4263 4264
		 * Executes the command denoted by the given command identifier.
		 *
J
Johannes Rieken 已提交
4265
		 * * *Note 1:* When executing an editor command not all types are allowed to
4266
		 * be passed as arguments. Allowed are the primitive types `string`, `boolean`,
J
Johannes Rieken 已提交
4267 4268
		 * `number`, `undefined`, and `null`, as well as [`Position`](#Position), [`Range`](#Range), [`Uri`](#Uri) and [`Location`](#Location).
		 * * *Note 2:* There are no restrictions when executing commands that have been contributed
J
Johannes Rieken 已提交
4269
		 * by extensions.
E
Erich Gamma 已提交
4270
		 *
J
Johannes Rieken 已提交
4271
		 * @param command Identifier of the command to execute.
J
Johannes Rieken 已提交
4272 4273 4274
		 * @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 已提交
4275
		 */
4276
		export function executeCommand<T>(command: string, ...rest: any[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
4277 4278

		/**
4279 4280
		 * Retrieve the list of all available commands. Commands starting an underscore are
		 * treated as internal commands.
E
Erich Gamma 已提交
4281
		 *
4282
		 * @param filterInternal Set `true` to not see internal commands (starting with an underscore)
E
Erich Gamma 已提交
4283 4284
		 * @return Thenable that resolves to a list of command ids.
		 */
4285
		export function getCommands(filterInternal?: boolean): Thenable<string[]>;
E
Erich Gamma 已提交
4286 4287
	}

J
Joao 已提交
4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298
	/**
	 * Represents the state of a window.
	 */
	export interface WindowState {

		/**
		 * Whether the current window is focused.
		 */
		readonly focused: boolean;
	}

E
Erich Gamma 已提交
4299
	/**
4300 4301 4302
	 * 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 已提交
4303 4304 4305 4306
	 */
	export namespace window {

		/**
4307
		 * The currently active editor or `undefined`. The active editor is the one
S
Steven Clarke 已提交
4308
		 * that currently has focus or, when none has focus, the one that has changed
E
Erich Gamma 已提交
4309 4310
		 * input most recently.
		 */
4311
		export let activeTextEditor: TextEditor | undefined;
E
Erich Gamma 已提交
4312 4313

		/**
4314
		 * The currently visible editors or an empty array.
E
Erich Gamma 已提交
4315 4316 4317 4318
		 */
		export let visibleTextEditors: TextEditor[];

		/**
4319
		 * An [event](#Event) which fires when the [active editor](#window.activeTextEditor)
J
Johannes Rieken 已提交
4320
		 * has changed. *Note* that the event also fires when the active editor changes
4321
		 * to `undefined`.
E
Erich Gamma 已提交
4322 4323 4324
		 */
		export const onDidChangeActiveTextEditor: Event<TextEditor>;

4325 4326 4327 4328 4329 4330
		/**
		 * An [event](#Event) which fires when the array of [visible editors](#window.visibleTextEditors)
		 * has changed.
		 */
		export const onDidChangeVisibleTextEditors: Event<TextEditor[]>;

E
Erich Gamma 已提交
4331
		/**
A
Andre Weinand 已提交
4332
		 * An [event](#Event) which fires when the selection in an editor has changed.
E
Erich Gamma 已提交
4333 4334 4335 4336 4337 4338 4339 4340
		 */
		export const onDidChangeTextEditorSelection: Event<TextEditorSelectionChangeEvent>;

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

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

4346
		/**
4347
		 * An [event](#Event) which fires when a terminal is disposed.
4348 4349 4350
		 */
		export const onDidCloseTerminal: Event<Terminal>;

J
Joao 已提交
4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363
		/**
		 * Represents the current window's state.
		 *
		 * @readonly
		 */
		export let state: WindowState;

		/**
		 * An [event](#Event) which fires when the focus state of the current window
		 * changes. The value of the event represents whether the window is focused.
		 */
		export const onDidChangeWindowState: Event<WindowState>;

E
Erich Gamma 已提交
4364 4365 4366 4367 4368 4369 4370
		/**
		 * 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)__.
4371
		 * @param preserveFocus When `true` the editor will not take focus.
E
Erich Gamma 已提交
4372 4373
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
4374
		export function showTextDocument(document: TextDocument, column?: ViewColumn, preserveFocus?: boolean): Thenable<TextEditor>;
E
Erich Gamma 已提交
4375

4376
		/**
B
Benjamin Pasero 已提交
4377 4378
		 * Show the given document in a text editor. [Options](#TextDocumentShowOptions) can be provided
		 * to control options of the editor is being shown. Might change the [active editor](#window.activeTextEditor).
4379 4380
		 *
		 * @param document A text document to be shown.
B
Benjamin Pasero 已提交
4381
		 * @param options [Editor options](#TextDocumentShowOptions) to configure the behavior of showing the [editor](#TextEditor).
4382 4383
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
4384
		export function showTextDocument(document: TextDocument, options?: TextDocumentShowOptions): Thenable<TextEditor>;
4385

B
Benjamin Pasero 已提交
4386
		/**
J
Johannes Rieken 已提交
4387
		 * A short-hand for `openTextDocument(uri).then(document => showTextDocument(document, options))`.
B
Benjamin Pasero 已提交
4388
		 *
J
Johannes Rieken 已提交
4389
		 * @see [openTextDocument](#openTextDocument)
B
Benjamin Pasero 已提交
4390 4391
		 *
		 * @param uri A resource identifier.
B
Benjamin Pasero 已提交
4392
		 * @param options [Editor options](#TextDocumentShowOptions) to configure the behavior of showing the [editor](#TextEditor).
B
Benjamin Pasero 已提交
4393 4394 4395 4396
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
		export function showTextDocument(uri: Uri, options?: TextDocumentShowOptions): Thenable<TextEditor>;

E
Erich Gamma 已提交
4397
		/**
J
Johannes Rieken 已提交
4398 4399 4400 4401
		 * 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 已提交
4402 4403 4404 4405 4406 4407 4408
		 */
		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 已提交
4409 4410
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
4411
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
4412
		 */
4413
		export function showInformationMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
4414

J
Joao Moreno 已提交
4415 4416 4417 4418 4419 4420 4421 4422 4423
		/**
		 * 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 已提交
4424
		export function showInformationMessage(message: string, options: MessageOptions, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
4425 4426

		/**
J
Johannes Rieken 已提交
4427
		 * Show an information message.
J
Johannes Rieken 已提交
4428
		 *
E
Erich Gamma 已提交
4429
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
4430 4431 4432
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
4433
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
4434
		 */
4435
		export function showInformationMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
4436

J
Joao Moreno 已提交
4437 4438 4439 4440 4441 4442 4443 4444 4445 4446
		/**
		 * 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 已提交
4447
		export function showInformationMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
4448 4449

		/**
J
Johannes Rieken 已提交
4450
		 * Show a warning message.
J
Johannes Rieken 已提交
4451
		 *
E
Erich Gamma 已提交
4452
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
4453 4454 4455
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
4456
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
4457
		 */
4458
		export function showWarningMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
4459

J
Joao Moreno 已提交
4460 4461 4462 4463 4464 4465 4466 4467 4468 4469
		/**
		 * 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 已提交
4470
		export function showWarningMessage(message: string, options: MessageOptions, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
4471 4472

		/**
J
Johannes Rieken 已提交
4473
		 * Show a warning message.
J
Johannes Rieken 已提交
4474
		 *
E
Erich Gamma 已提交
4475
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
4476 4477 4478
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
4479
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
4480
		 */
4481
		export function showWarningMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
4482

J
Joao Moreno 已提交
4483 4484 4485 4486 4487 4488 4489 4490 4491 4492
		/**
		 * 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 已提交
4493
		export function showWarningMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
4494 4495

		/**
J
Johannes Rieken 已提交
4496
		 * Show an error message.
J
Johannes Rieken 已提交
4497
		 *
E
Erich Gamma 已提交
4498
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
4499 4500 4501
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
4502
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
4503
		 */
4504
		export function showErrorMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
4505

J
Joao Moreno 已提交
4506 4507 4508 4509 4510 4511 4512 4513 4514 4515
		/**
		 * 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 已提交
4516
		export function showErrorMessage(message: string, options: MessageOptions, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
4517 4518

		/**
J
Johannes Rieken 已提交
4519
		 * Show an error message.
J
Johannes Rieken 已提交
4520
		 *
E
Erich Gamma 已提交
4521
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
4522 4523 4524
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
4525
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
4526
		 */
4527
		export function showErrorMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
4528

J
Joao Moreno 已提交
4529 4530 4531 4532 4533 4534 4535 4536 4537 4538
		/**
		 * 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 已提交
4539
		export function showErrorMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
4540 4541 4542 4543

		/**
		 * Shows a selection list.
		 *
J
Johannes Rieken 已提交
4544 4545
		 * @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.
4546
		 * @param token A token that can be used to signal cancellation.
4547
		 * @return A promise that resolves to the selection or `undefined`.
E
Erich Gamma 已提交
4548
		 */
4549
		export function showQuickPick(items: string[] | Thenable<string[]>, options?: QuickPickOptions, token?: CancellationToken): Thenable<string | undefined>;
E
Erich Gamma 已提交
4550 4551 4552 4553

		/**
		 * Shows a selection list.
		 *
J
Johannes Rieken 已提交
4554 4555
		 * @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.
4556
		 * @param token A token that can be used to signal cancellation.
4557
		 * @return A promise that resolves to the selected item or `undefined`.
E
Erich Gamma 已提交
4558
		 */
4559
		export function showQuickPick<T extends QuickPickItem>(items: T[] | Thenable<T[]>, options?: QuickPickOptions, token?: CancellationToken): Thenable<T | undefined>;
E
Erich Gamma 已提交
4560

4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576
		/**
		 * Shows a file open dialog to the user.
		 *
		 * @param options Options that control the dialog.
		 * @returns A promise that resolves to the selected resources or `undefined`.
		 */
		export function showOpenDialog(options: OpenDialogOptions): Thenable<Uri[] | undefined>;

		/**
		 * Shows a file save dialog to the user.
		 *
		 * @param options Options that control the dialog.
		 * @returns A promise that resolves to the selected resource or `undefined`.
		 */
		export function showSaveDialog(options: SaveDialogOptions): Thenable<Uri | undefined>;

E
Erich Gamma 已提交
4577 4578 4579
		/**
		 * Opens an input box to ask the user for input.
		 *
4580
		 * The returned value will be `undefined` if the input box was canceled (e.g. pressing ESC). Otherwise the
A
Andre Weinand 已提交
4581
		 * returned value will be the string typed by the user or an empty string if the user did not type
S
Steven Clarke 已提交
4582
		 * anything but dismissed the input box with OK.
E
Erich Gamma 已提交
4583
		 *
J
Johannes Rieken 已提交
4584
		 * @param options Configures the behavior of the input box.
4585
		 * @param token A token that can be used to signal cancellation.
J
Johannes Rieken 已提交
4586
		 * @return A promise that resolves to a string the user provided or to `undefined` in case of dismissal.
E
Erich Gamma 已提交
4587
		 */
4588
		export function showInputBox(options?: InputBoxOptions, token?: CancellationToken): Thenable<string | undefined>;
E
Erich Gamma 已提交
4589 4590

		/**
J
Johannes Rieken 已提交
4591 4592
		 * Create a new [output channel](#OutputChannel) with the given name.
		 *
4593
		 * @param name Human-readable string which will be used to represent the channel in the UI.
E
Erich Gamma 已提交
4594
		 */
4595
		export function createOutputChannel(name: string): OutputChannel;
E
Erich Gamma 已提交
4596 4597

		/**
S
Steven Clarke 已提交
4598
		 * Set a message to the status bar. This is a short hand for the more powerful
E
Erich Gamma 已提交
4599
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
4600
		 *
G
Gama11 已提交
4601
		 * @param text The message to show, supports icon substitution as in status bar [items](#StatusBarItem.text).
4602
		 * @param hideAfterTimeout Timeout in milliseconds after which the message will be disposed.
J
Johannes Rieken 已提交
4603
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
4604
		 */
4605
		export function setStatusBarMessage(text: string, hideAfterTimeout: number): Disposable;
E
Erich Gamma 已提交
4606 4607

		/**
S
Steven Clarke 已提交
4608
		 * Set a message to the status bar. This is a short hand for the more powerful
J
Johannes Rieken 已提交
4609
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
4610
		 *
G
Gama11 已提交
4611
		 * @param text The message to show, supports icon substitution as in status bar [items](#StatusBarItem.text).
4612
		 * @param hideWhenDone Thenable on which completion (resolve or reject) the message will be disposed.
J
Johannes Rieken 已提交
4613
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
4614
		 */
4615
		export function setStatusBarMessage(text: string, hideWhenDone: Thenable<any>): Disposable;
E
Erich Gamma 已提交
4616 4617

		/**
S
Steven Clarke 已提交
4618
		 * Set a message to the status bar. This is a short hand for the more powerful
J
Johannes Rieken 已提交
4619
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
4620
		 *
4621 4622 4623
		 * *Note* that status bar messages stack and that they must be disposed when no
		 * longer used.
		 *
G
Gama11 已提交
4624
		 * @param text The message to show, supports icon substitution as in status bar [items](#StatusBarItem.text).
J
Johannes Rieken 已提交
4625
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
4626
		 */
4627
		export function setStatusBarMessage(text: string): Disposable;
E
Erich Gamma 已提交
4628

4629
		/**
J
Johannes Rieken 已提交
4630 4631
		 * ~~Show progress in the Source Control viewlet while running the given callback and while
		 * its returned promise isn't resolve or rejected.~~
4632
		 *
4633 4634
		 * @deprecated Use `withProgress` instead.
		 *
4635 4636
		 * @param task A callback returning a promise. Progress increments can be reported with
		 * the provided [progress](#Progress)-object.
J
Johannes Rieken 已提交
4637
		 * @return The thenable the task did rseturn.
4638 4639 4640
		 */
		export function withScmProgress<R>(task: (progress: Progress<number>) => Thenable<R>): Thenable<R>;

J
Johannes Rieken 已提交
4641 4642 4643 4644 4645 4646 4647 4648 4649
		/**
		 * 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.
		 */
4650
		export function withProgress<R>(options: ProgressOptions, task: (progress: Progress<{ message?: string; }>) => Thenable<R>): Thenable<R>;
4651

E
Erich Gamma 已提交
4652
		/**
J
Johannes Rieken 已提交
4653 4654
		 * Creates a status bar [item](#StatusBarItem).
		 *
J
Johannes Rieken 已提交
4655
		 * @param alignment The alignment of the item.
J
Johannes Rieken 已提交
4656
		 * @param priority The priority of the item. Higher values mean the item should be shown more to the left.
J
Johannes Rieken 已提交
4657 4658
		 * @return A new status bar item.
		 */
E
Erich Gamma 已提交
4659
		export function createStatusBarItem(alignment?: StatusBarAlignment, priority?: number): StatusBarItem;
D
Daniel Imms 已提交
4660

D
Daniel Imms 已提交
4661
		/**
4662 4663
		 * 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 已提交
4664
		 *
4665
		 * @param name Optional human-readable string which will be used to represent the terminal in the UI.
4666
		 * @param shellPath Optional path to a custom shell executable to be used in the terminal.
D
Daniel Imms 已提交
4667
		 * @param shellArgs Optional args for the custom shell executable, this does not work on Windows (see #8429)
D
Daniel Imms 已提交
4668 4669
		 * @return A new Terminal.
		 */
P
Pine Wu 已提交
4670
		export function createTerminal(name?: string, shellPath?: string, shellArgs?: string[]): Terminal;
4671 4672 4673 4674 4675 4676 4677 4678 4679

		/**
		 * 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;
S
Sandeep Somavarapu 已提交
4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779

		/**
		 * Register a [TreeDataProvider](#TreeDataProvider) for the view contributed using the extension point `views`.
		 * @param viewId Id of the view contributed using the extension point `views`.
		 * @param treeDataProvider A [TreeDataProvider](#TreeDataProvider) that provides tree data for the view
		 */
		export function registerTreeDataProvider<T>(viewId: string, treeDataProvider: TreeDataProvider<T>): Disposable;
	}

	/**
	 * A data provider that provides tree data
	 */
	export interface TreeDataProvider<T> {
		/**
		 * An optional event to signal that an element or root has changed.
		 * To signal that root has changed, do not pass any argument or pass `undefined` or `null`.
		 */
		onDidChangeTreeData?: Event<T | undefined | null>;

		/**
		 * Get [TreeItem](#TreeItem) representation of the `element`
		 *
		 * @param element The element for which [TreeItem](#TreeItem) representation is asked for.
		 * @return [TreeItem](#TreeItem) representation of the element
		 */
		getTreeItem(element: T): TreeItem | Thenable<TreeItem>;

		/**
		 * Get the children of `element` or root if no element is passed.
		 *
		 * @param element The element from which the provider gets children. Can be `undefined`.
		 * @return Children of `element` or root if no element is passed.
		 */
		getChildren(element?: T): ProviderResult<T[]>;
	}

	export class TreeItem {
		/**
		 * A human-readable string describing this item
		 */
		label: string;

		/**
		 * The icon path for the tree item
		 */
		iconPath?: string | Uri | { light: string | Uri; dark: string | Uri };

		/**
		 * The [command](#Command) which should be run when the tree item is selected.
		 */
		command?: Command;

		/**
		 * [TreeItemCollapsibleState](#TreeItemCollapsibleState) of the tree item.
		 */
		collapsibleState?: TreeItemCollapsibleState;

		/**
		 * Context value of the tree item. This can be used to contribute item specific actions in the tree.
		 * For example, a tree item is given a context value as `folder`. When contributing actions to `view/item/context`
		 * using `menus` extension point, you can specify context value for key `viewItem` in `when` expression like `viewItem == folder`.
		 * ```
		 *	"contributes": {
		 *		"menus": {
		 *			"view/item/context": [
		 *				{
		 *					"command": "extension.deleteFolder",
		 *					"when": "viewItem == folder"
		 *				}
		 *			]
		 *		}
		 *	}
		 * ```
		 * This will show action `extension.deleteFolder` only for items with `contextValue` is `folder`.
		 */
		contextValue?: string;

		/**
		 * @param label A human-readable string describing this item
		 * @param collapsibleState [TreeItemCollapsibleState](#TreeItemCollapsibleState) of the tree item. Default is [TreeItemCollapsibleState.None](#TreeItemCollapsibleState.None)
		 */
		constructor(label: string, collapsibleState?: TreeItemCollapsibleState);
	}

	/**
	 * Collapsible state of the tree item
	 */
	export enum TreeItemCollapsibleState {
		/**
		 * Determines an item can be neither collapsed nor expanded. Implies it has no children.
		 */
		None = 0,
		/**
		 * Determines an item is collapsed
		 */
		Collapsed = 1,
		/**
		 * Determines an item is expanded
		 */
		Expanded = 2
4780 4781 4782
	}

	/**
J
Johannes Rieken 已提交
4783
	 * Value-object describing what options a terminal should use.
4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799
	 */
	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 已提交
4800 4801
	}

J
Johannes Rieken 已提交
4802 4803 4804 4805 4806 4807 4808
	/**
	 * 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 {

		/**
4809
		 * Show progress for the source control viewlet, as overlay for the icon and as progress bar
J
Johannes Rieken 已提交
4810 4811
		 * inside the viewlet (when visible).
		 */
4812
		SourceControl = 1,
J
Johannes Rieken 已提交
4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836

		/**
		 * 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 已提交
4837
	/**
A
Alex Dima 已提交
4838
	 * An event describing an individual change in the text of a [document](#TextDocument).
E
Erich Gamma 已提交
4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855
	 */
	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 已提交
4856
	 * An event describing a transactional [document](#TextDocument) change.
E
Erich Gamma 已提交
4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870
	 */
	export interface TextDocumentChangeEvent {

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

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

4871 4872 4873 4874 4875 4876
	/**
	 * Represents reasons why a text document is saved.
	 */
	export enum TextDocumentSaveReason {

		/**
4877 4878
		 * Manually triggered, e.g. by the user pressing save, by starting debugging,
		 * or by an API call.
4879
		 */
4880
		Manual = 1,
4881 4882 4883 4884

		/**
		 * Automatic after a delay.
		 */
4885
		AfterDelay = 2,
4886 4887 4888 4889 4890 4891 4892

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

4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904
	/**
	 * 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.
		 */
4905
		document: TextDocument;
4906

4907 4908 4909 4910 4911
		/**
		 * The reason why save was triggered.
		 */
		reason: TextDocumentSaveReason;

4912 4913 4914 4915 4916 4917 4918 4919 4920 4921
		/**
		 * 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 => {
4922 4923 4924 4925 4926
		 * 	// async, will *throw* an error
		 * 	setTimeout(() => event.waitUntil(promise));
		 *
		 * 	// sync, OK
		 * 	event.waitUntil(promise);
4927 4928 4929 4930 4931
		 * })
		 * ```
		 *
		 * @param thenable A thenable that resolves to [pre-save-edits](#TextEdit).
		 */
4932
		waitUntil(thenable: Thenable<TextEdit[]>): void;
4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943

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

4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960
	/**
	 * An event describing a change to the set of [workspace folders](#workspace.workspaceFolders).
	 */
	export interface WorkspaceFoldersChangeEvent {
		/**
		 * Added workspace folders.
		 */
		readonly added: WorkspaceFolder[];

		/**
		 * Removed workspace folders.
		 */
		readonly removed: WorkspaceFolder[];
	}

	/**
	 * A workspace folder is one of potentially many roots opened by the editor. All workspace folders
4961
	 * are equal which means there is no notion of an active or master workspace folder.
4962 4963 4964 4965
	 */
	export interface WorkspaceFolder {

		/**
J
Johannes Rieken 已提交
4966 4967 4968 4969
		 * The associated uri for this workspace folder.
		 *
		 * *Note:* The [Uri](#Uri)-type was intentionally chosen such that future releases of the editor can support
		 * workspace folders that are not stored on the local disk, e.g. `ftp://server/workspaces/foo`.
4970 4971 4972 4973 4974
		 */
		readonly uri: Uri;

		/**
		 * The name of this workspace folder. Defaults to
J
Johannes Rieken 已提交
4975
		 * the basename of its [uri-path](#Uri.path)
4976 4977 4978 4979 4980 4981 4982 4983 4984
		 */
		readonly name: string;

		/**
		 * The ordinal number of this workspace folder.
		 */
		readonly index: number;
	}

E
Erich Gamma 已提交
4985
	/**
4986 4987 4988 4989 4990
	 * 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
4991
	 * events and for [finding](#workspace.findFiles) files. Both perform well and run _outside_
S
Steven Clarke 已提交
4992
	 * the editor-process so that they should be always used instead of nodejs-equivalents.
E
Erich Gamma 已提交
4993 4994 4995 4996
	 */
	export namespace workspace {

		/**
4997 4998
		 * ~~The folder that is open in the editor. `undefined` when no folder
		 * has been opened.~~
J
Johannes Rieken 已提交
4999
		 *
5000
		 * @deprecated Use [`workspaceFolders`](#workspace.workspaceFolders) instead.
5001 5002
		 *
		 * @readonly
E
Erich Gamma 已提交
5003
		 */
5004
		export let rootPath: string | undefined;
E
Erich Gamma 已提交
5005 5006

		/**
J
Johannes Rieken 已提交
5007 5008
		 * List of workspace folders or `undefined` when no folder is open.
		 * *Note* that the first entry corresponds to the value of `rootPath`.
Y
Yuki Ueda 已提交
5009 5010
		 *
		 * @readonly
E
Erich Gamma 已提交
5011
		 */
5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026
		export let workspaceFolders: WorkspaceFolder[] | undefined;

		/**
		 * An event that is emitted when a workspace folder is added or removed.
		 */
		export const onDidChangeWorkspaceFolders: Event<WorkspaceFoldersChangeEvent>;

		/**
		 * Returns a [workspace folder](#WorkspaceFolder) for the provided resource. When the resource
		 * is a workspace folder itself, its parent workspace folder or `undefined` is returned.
		 *
		 * @param uri An uri.
		 * @return A workspace folder or `undefined`
		 */
		export function getWorkspaceFolder(uri: Uri): WorkspaceFolder | undefined;
E
Erich Gamma 已提交
5027 5028

		/**
5029
		 * Returns a path that is relative to the workspace folder or folders.
J
Johannes Rieken 已提交
5030
		 *
5031
		 * When there are no [workspace folders](#workspace.workspaceFolders) or when the path
J
Johannes Rieken 已提交
5032
		 * is not contained in them, the input is returned.
J
Johannes Rieken 已提交
5033 5034
		 *
		 * @param pathOrUri A path or uri. When a uri is given its [fsPath](#Uri.fsPath) is used.
J
Johannes Rieken 已提交
5035 5036 5037
		 * @param includeWorkspaceFolder When `true` and when the given path is contained inside a
		 * workspace folder the name of the workspace is prepended. Defaults to `true` when there are
		 * multiple workspace folders and `false` otherwise.
J
Johannes Rieken 已提交
5038
		 * @return A path relative to the root or the input.
E
Erich Gamma 已提交
5039
		 */
J
Johannes Rieken 已提交
5040
		export function asRelativePath(pathOrUri: string | Uri, includeWorkspaceFolder?: boolean): string;
E
Erich Gamma 已提交
5041

5042 5043 5044
		/**
		 * Creates a file system watcher.
		 *
5045 5046
		 * A glob pattern that filters the file events on their absolute path must be provided. Optionally,
		 * flags to ignore certain kinds of events can be provided. To stop listening to events the watcher must be disposed.
5047
		 *
5048
		 * *Note* that only files within the current [workspace folders](#workspace.workspaceFolders) can be watched.
5049
		 *
5050
		 * @param globPattern A [glob pattern](#GlobPattern) that is applied to the absolute paths of created, changed,
B
Benjamin Pasero 已提交
5051
		 * and deleted files. Use a [relative pattern](#RelativePattern) to limit events to a certain [workspace folder](#WorkspaceFolder).
5052 5053 5054 5055 5056
		 * @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.
		 */
5057
		export function createFileSystemWatcher(globPattern: GlobPattern, ignoreCreateEvents?: boolean, ignoreChangeEvents?: boolean, ignoreDeleteEvents?: boolean): FileSystemWatcher;
5058

J
Johannes Rieken 已提交
5059
		/**
B
Benjamin Pasero 已提交
5060
		 * Find files across all [workspace folders](#workspace.workspaceFolders) in the workspace.
J
Johannes Rieken 已提交
5061
		 *
5062
		 * @sample `findFiles('**∕*.js', '**∕node_modules∕**', 10)`
5063
		 * @param include A [glob pattern](#GlobPattern) that defines the files to search for. The glob pattern
B
Benjamin Pasero 已提交
5064 5065
		 * will be matched against the file paths of resulting matches relative to their workspace. Use a [relative pattern](#RelativePattern)
		 * to restrict the search results to a [workspace folder](#WorkspaceFolder).
5066 5067
		 * @param exclude  A [glob pattern](#GlobPattern) that defines files and folders to exclude. The glob pattern
		 * will be matched against the file paths of resulting matches relative to their workspace.
J
Johannes Rieken 已提交
5068
		 * @param maxResults An upper-bound for the result.
5069
		 * @param token A token that can be used to signal cancellation to the underlying search engine.
B
Benjamin Pasero 已提交
5070 5071
		 * @return A thenable that resolves to an array of resource identifiers. Will return no results if no
		 * [workspace folders](#workspace.workspaceFolders) are opened.
J
Johannes Rieken 已提交
5072
		 */
5073
		export function findFiles(include: GlobPattern, exclude?: GlobPattern, maxResults?: number, token?: CancellationToken): Thenable<Uri[]>;
E
Erich Gamma 已提交
5074 5075

		/**
J
Johannes Rieken 已提交
5076 5077 5078
		 * Save all dirty files.
		 *
		 * @param includeUntitled Also save files that have been created during this session.
S
Steven Clarke 已提交
5079
		 * @return A thenable that resolves when the files have been saved.
E
Erich Gamma 已提交
5080 5081 5082 5083
		 */
		export function saveAll(includeUntitled?: boolean): Thenable<boolean>;

		/**
J
Johannes Rieken 已提交
5084 5085 5086
		 * Make changes to one or many resources as defined by the given
		 * [workspace edit](#WorkspaceEdit).
		 *
S
Steven Clarke 已提交
5087 5088 5089
		 * 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 已提交
5090 5091 5092
		 *
		 * @param edit A workspace edit.
		 * @return A thenable that resolves when the edit could be applied.
E
Erich Gamma 已提交
5093 5094 5095 5096 5097
		 */
		export function applyEdit(edit: WorkspaceEdit): Thenable<boolean>;

		/**
		 * All text documents currently known to the system.
J
Johannes Rieken 已提交
5098 5099
		 *
		 * @readonly
E
Erich Gamma 已提交
5100 5101 5102 5103
		 */
		export let textDocuments: TextDocument[];

		/**
5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115
		 * 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 已提交
5116 5117 5118 5119 5120 5121 5122
		 *
		 * @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 已提交
5123 5124 5125
		 * A short-hand for `openTextDocument(Uri.file(fileName))`.
		 *
		 * @see [openTextDocument](#openTextDocument)
A
Andre Weinand 已提交
5126 5127
		 * @param fileName A name of a file on disk.
		 * @return A promise that resolves to a [document](#TextDocument).
E
Erich Gamma 已提交
5128 5129 5130
		 */
		export function openTextDocument(fileName: string): Thenable<TextDocument>;

B
Benjamin Pasero 已提交
5131
		/**
J
Johannes Rieken 已提交
5132 5133
		 * 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
5134
		 * specify the *language* and/or the *content* of the document.
B
Benjamin Pasero 已提交
5135
		 *
J
Johannes Rieken 已提交
5136
		 * @param options Options to control how the document will be created.
B
Benjamin Pasero 已提交
5137 5138
		 * @return A promise that resolves to a [document](#TextDocument).
		 */
5139
		export function openTextDocument(options?: { language?: string; content?: string; }): Thenable<TextDocument>;
B
Benjamin Pasero 已提交
5140

J
Johannes Rieken 已提交
5141
		/**
5142 5143 5144
		 * Register a text document content provider.
		 *
		 * Only one provider can be registered per scheme.
J
Johannes Rieken 已提交
5145
		 *
5146 5147 5148
		 * @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 已提交
5149 5150 5151
		 */
		export function registerTextDocumentContentProvider(scheme: string, provider: TextDocumentContentProvider): Disposable;

A
Alex Dima 已提交
5152
		/**
J
Johannes Rieken 已提交
5153
		 * An event that is emitted when a [text document](#TextDocument) is opened.
A
Alex Dima 已提交
5154
		 */
E
Erich Gamma 已提交
5155 5156
		export const onDidOpenTextDocument: Event<TextDocument>;

A
Alex Dima 已提交
5157 5158 5159
		/**
		 * An event that is emitted when a [text document](#TextDocument) is disposed.
		 */
E
Erich Gamma 已提交
5160 5161
		export const onDidCloseTextDocument: Event<TextDocument>;

A
Alex Dima 已提交
5162
		/**
5163 5164
		 * An event that is emitted when a [text document](#TextDocument) is changed. This usually happens
		 * when the [contents](#TextDocument.getText) changes but also when other things like the
5165
		 * [dirty](#TextDocument.isDirty)-state changes.
A
Alex Dima 已提交
5166
		 */
E
Erich Gamma 已提交
5167 5168
		export const onDidChangeTextDocument: Event<TextDocumentChangeEvent>;

5169 5170
		/**
		 * An event that is emitted when a [text document](#TextDocument) will be saved to disk.
5171
		 *
J
Johannes Rieken 已提交
5172
		 * *Note 1:* Subscribers can delay saving by registering asynchronous work. For the sake of data integrity the editor
5173 5174 5175 5176 5177 5178 5179 5180
		 * 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.
5181 5182 5183
		 */
		export const onWillSaveTextDocument: Event<TextDocumentWillSaveEvent>;

A
Alex Dima 已提交
5184 5185 5186
		/**
		 * An event that is emitted when a [text document](#TextDocument) is saved to disk.
		 */
E
Erich Gamma 已提交
5187 5188 5189
		export const onDidSaveTextDocument: Event<TextDocument>;

		/**
S
Sandeep Somavarapu 已提交
5190
		 * Get a workspace configuration object.
J
Johannes Rieken 已提交
5191 5192
		 *
		 * When a section-identifier is provided only that part of the configuration
A
Andre Weinand 已提交
5193
		 * is returned. Dots in the section-identifier are interpreted as child-access,
J
Johannes Rieken 已提交
5194
		 * like `{ myExt: { setting: { doIt: true }}}` and `getConfiguration('myExt.setting').get('doIt') === true`.
J
Johannes Rieken 已提交
5195
		 *
S
Sandeep Somavarapu 已提交
5196
		 * When a resource is provided, configuration scoped to that resource is returned.
S
Sandeep Somavarapu 已提交
5197 5198
		 *
		 * @param section A dot-separated identifier.
S
Sandeep Somavarapu 已提交
5199
		 * @param resource A resource for which the configuration is asked for
S
Sandeep Somavarapu 已提交
5200 5201
		 * @return The full configuration or a subset.
		 */
S
Sandeep Somavarapu 已提交
5202
		export function getConfiguration(section?: string, resource?: Uri): WorkspaceConfiguration;
E
Erich Gamma 已提交
5203

J
Johannes Rieken 已提交
5204 5205 5206
		/**
		 * An event that is emitted when the [configuration](#WorkspaceConfiguration) changed.
		 */
E
Erich Gamma 已提交
5207
		export const onDidChangeConfiguration: Event<void>;
5208 5209 5210 5211 5212 5213 5214 5215 5216

		/**
		 * Register a task provider.
		 *
		 * @param type The task kind type this provider is registered for.
		 * @param provider A task provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerTaskProvider(type: string, provider: TaskProvider): Disposable;
E
Erich Gamma 已提交
5217 5218
	}

J
Johannes Rieken 已提交
5219
	/**
5220 5221 5222 5223 5224 5225 5226
	 * 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 已提交
5227
	 * The editor provides an API that makes it simple to provide such common features by having all UI and actions already in place and
5228 5229 5230 5231 5232 5233
	 * 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', {
5234 5235 5236
	 * 	provideHover(document, position, token) {
	 * 		return new Hover('I am a hover!');
	 * 	}
5237 5238
	 * });
	 * ```
5239 5240 5241
	 *
	 * 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 已提交
5242
	 * a selector will result in a [score](#languages.match) that is used to determine if and how a provider shall be used. When
5243 5244 5245
	 * 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 已提交
5246
	 */
E
Erich Gamma 已提交
5247 5248 5249 5250 5251 5252 5253 5254 5255
	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 已提交
5256
		 * Compute the match between a document [selector](#DocumentSelector) and a document. Values
5257 5258 5259
		 * greater than zero mean the selector matches the document.
		 *
		 * A match is computed according to these rules:
5260 5261
		 * 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" }`.
5262 5263
		 * 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`
5264 5265 5266
		 *  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
5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282
		 *
		 * 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'
5283
		 * match('javascript', doc); // 10;
5284 5285
		 * match({language: 'javascript', scheme: 'git'}, doc); // 10;
		 * match('*', doc); // 5
5286
		 * ```
J
Johannes Rieken 已提交
5287 5288 5289
		 *
		 * @param selector A document selector.
		 * @param document A text document.
J
Johannes Rieken 已提交
5290
		 * @return A number `>0` when the selector matches and `0` when the selector does not match.
E
Erich Gamma 已提交
5291 5292 5293 5294
		 */
		export function match(selector: DocumentSelector, document: TextDocument): number;

		/**
S
Steven Clarke 已提交
5295
		 * Create a diagnostics collection.
J
Johannes Rieken 已提交
5296 5297 5298
		 *
		 * @param name The [name](#DiagnosticCollection.name) of the collection.
		 * @return A new diagnostic collection.
E
Erich Gamma 已提交
5299 5300 5301 5302
		 */
		export function createDiagnosticCollection(name?: string): DiagnosticCollection;

		/**
J
Johannes Rieken 已提交
5303 5304 5305
		 * Register a completion provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
5306
		 * by their [score](#languages.match) and groups of equal score are sequentially asked for
J
Johannes Rieken 已提交
5307
		 * completion items. The process stops when one or many providers of a group return a
5308 5309
		 * result. A failing provider (rejected promise or exception) will not fail the whole
		 * operation.
E
Erich Gamma 已提交
5310
		 *
J
Johannes Rieken 已提交
5311 5312 5313 5314 5315 5316 5317 5318
		 * @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 已提交
5319 5320 5321
		 * Register a code action provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
5322 5323
		 * 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 已提交
5324 5325
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
J
Johannes Rieken 已提交
5326
		 * @param provider A code action provider.
J
Johannes Rieken 已提交
5327
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
5328
		 */
J
Johannes Rieken 已提交
5329
		export function registerCodeActionsProvider(selector: DocumentSelector, provider: CodeActionProvider): Disposable;
E
Erich Gamma 已提交
5330 5331

		/**
J
Johannes Rieken 已提交
5332 5333 5334
		 * Register a code lens provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
5335 5336
		 * 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 已提交
5337
		 *
J
Johannes Rieken 已提交
5338 5339 5340
		 * @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 已提交
5341
		 */
J
Johannes Rieken 已提交
5342
		export function registerCodeLensProvider(selector: DocumentSelector, provider: CodeLensProvider): Disposable;
E
Erich Gamma 已提交
5343 5344

		/**
J
Johannes Rieken 已提交
5345 5346 5347
		 * Register a definition provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
5348 5349
		 * 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 已提交
5350
		 *
J
Johannes Rieken 已提交
5351 5352 5353
		 * @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 已提交
5354 5355 5356
		 */
		export function registerDefinitionProvider(selector: DocumentSelector, provider: DefinitionProvider): Disposable;

5357
		/**
5358
		 * Register an implementation provider.
5359
		 *
5360 5361 5362
		 * 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.
5363 5364 5365 5366 5367
		 *
		 * @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 已提交
5368
		export function registerImplementationProvider(selector: DocumentSelector, provider: ImplementationProvider): Disposable;
5369

5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382
		/**
		 * 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 已提交
5383
		/**
J
Johannes Rieken 已提交
5384 5385 5386
		 * Register a hover provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
5387 5388
		 * 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 已提交
5389
		 *
J
Johannes Rieken 已提交
5390 5391 5392
		 * @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 已提交
5393 5394 5395 5396
		 */
		export function registerHoverProvider(selector: DocumentSelector, provider: HoverProvider): Disposable;

		/**
J
Johannes Rieken 已提交
5397 5398 5399 5400
		 * 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.
5401
		 * The process stops when a provider returns a `non-falsy` or `non-failure` result.
E
Erich Gamma 已提交
5402
		 *
J
Johannes Rieken 已提交
5403 5404 5405
		 * @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 已提交
5406 5407 5408 5409
		 */
		export function registerDocumentHighlightProvider(selector: DocumentSelector, provider: DocumentHighlightProvider): Disposable;

		/**
J
Johannes Rieken 已提交
5410 5411 5412
		 * Register a document symbol provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
5413 5414
		 * 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 已提交
5415
		 *
J
Johannes Rieken 已提交
5416 5417 5418
		 * @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 已提交
5419 5420 5421 5422
		 */
		export function registerDocumentSymbolProvider(selector: DocumentSelector, provider: DocumentSymbolProvider): Disposable;

		/**
J
Johannes Rieken 已提交
5423 5424
		 * Register a workspace symbol provider.
		 *
5425 5426 5427
		 * 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 已提交
5428
		 *
J
Johannes Rieken 已提交
5429 5430
		 * @param provider A workspace symbol provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
5431 5432 5433 5434
		 */
		export function registerWorkspaceSymbolProvider(provider: WorkspaceSymbolProvider): Disposable;

		/**
J
Johannes Rieken 已提交
5435 5436 5437
		 * Register a reference provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
5438 5439
		 * 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 已提交
5440
		 *
J
Johannes Rieken 已提交
5441 5442 5443
		 * @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 已提交
5444 5445 5446 5447
		 */
		export function registerReferenceProvider(selector: DocumentSelector, provider: ReferenceProvider): Disposable;

		/**
J
Johannes Rieken 已提交
5448 5449 5450
		 * Register a reference provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
5451
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
5452
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
5453
		 *
J
Johannes Rieken 已提交
5454 5455 5456
		 * @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 已提交
5457 5458 5459 5460
		 */
		export function registerRenameProvider(selector: DocumentSelector, provider: RenameProvider): Disposable;

		/**
A
Andre Weinand 已提交
5461
		 * Register a formatting provider for a document.
J
Johannes Rieken 已提交
5462 5463
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
5464
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
5465
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
5466
		 *
J
Johannes Rieken 已提交
5467 5468 5469
		 * @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 已提交
5470 5471 5472 5473
		 */
		export function registerDocumentFormattingEditProvider(selector: DocumentSelector, provider: DocumentFormattingEditProvider): Disposable;

		/**
J
Johannes Rieken 已提交
5474 5475
		 * Register a formatting provider for a document range.
		 *
5476 5477 5478 5479
		 * *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 已提交
5480
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
5481
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
5482
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
5483
		 *
J
Johannes Rieken 已提交
5484 5485 5486
		 * @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 已提交
5487 5488 5489 5490
		 */
		export function registerDocumentRangeFormattingEditProvider(selector: DocumentSelector, provider: DocumentRangeFormattingEditProvider): Disposable;

		/**
E
Erich Gamma 已提交
5491
		 * Register a formatting provider that works on type. The provider is active when the user enables the setting `editor.formatOnType`.
J
Johannes Rieken 已提交
5492 5493
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
5494
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
5495
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
5496
		 *
J
Johannes Rieken 已提交
5497 5498 5499
		 * @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 已提交
5500
		 * @param moreTriggerCharacter More trigger characters.
J
Johannes Rieken 已提交
5501
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
5502 5503 5504 5505
		 */
		export function registerOnTypeFormattingEditProvider(selector: DocumentSelector, provider: OnTypeFormattingEditProvider, firstTriggerCharacter: string, ...moreTriggerCharacter: string[]): Disposable;

		/**
J
Johannes Rieken 已提交
5506 5507 5508
		 * Register a signature help provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
5509 5510
		 * by their [score](#languages.match) and called sequentially until a provider returns a
		 * valid result.
E
Erich Gamma 已提交
5511
		 *
J
Johannes Rieken 已提交
5512 5513 5514 5515
		 * @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 已提交
5516 5517 5518
		 */
		export function registerSignatureHelpProvider(selector: DocumentSelector, provider: SignatureHelpProvider, ...triggerCharacters: string[]): Disposable;

J
Johannes Rieken 已提交
5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531
		/**
		 * 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 已提交
5532
		/**
J
Johannes Rieken 已提交
5533
		 * Set a [language configuration](#LanguageConfiguration) for a language.
E
Erich Gamma 已提交
5534
		 *
A
Andre Weinand 已提交
5535
		 * @param language A language identifier like `typescript`.
J
Johannes Rieken 已提交
5536 5537
		 * @param configuration Language configuration.
		 * @return A [disposable](#Disposable) that unsets this configuration.
E
Erich Gamma 已提交
5538 5539 5540 5541
		 */
		export function setLanguageConfiguration(language: string, configuration: LanguageConfiguration): Disposable;
	}

J
Joao Moreno 已提交
5542
	/**
J
Joao Moreno 已提交
5543
	 * Represents the input box in the Source Control viewlet.
J
Joao Moreno 已提交
5544
	 */
J
Joao Moreno 已提交
5545
	export interface SourceControlInputBox {
J
Joao Moreno 已提交
5546 5547

		/**
J
Joao Moreno 已提交
5548
		 * Setter and getter for the contents of the input box.
J
Joao Moreno 已提交
5549
		 */
J
Joao Moreno 已提交
5550
		value: string;
J
Joao Moreno 已提交
5551 5552
	}

J
Joao Moreno 已提交
5553
	interface QuickDiffProvider {
J
Joao Moreno 已提交
5554 5555

		/**
J
Joao Moreno 已提交
5556 5557 5558 5559 5560
		 * 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 已提交
5561
		 */
J
Joao Moreno 已提交
5562 5563
		provideOriginalResource?(uri: Uri, token: CancellationToken): ProviderResult<Uri>;
	}
J
Joao Moreno 已提交
5564

J
Joao Moreno 已提交
5565 5566 5567 5568 5569
	/**
	 * The theme-aware decorations for a
	 * [source control resource state](#SourceControlResourceState).
	 */
	export interface SourceControlResourceThemableDecorations {
J
Joao Moreno 已提交
5570 5571

		/**
J
Joao Moreno 已提交
5572 5573
		 * The icon path for a specific
		 * [source control resource state](#SourceControlResourceState).
J
Joao Moreno 已提交
5574
		 */
J
Joao Moreno 已提交
5575
		readonly iconPath?: string | Uri;
J
Joao Moreno 已提交
5576 5577 5578
	}

	/**
J
Joao Moreno 已提交
5579 5580
	 * The decorations for a [source control resource state](#SourceControlResourceState).
	 * Can be independently specified for light and dark themes.
J
Joao Moreno 已提交
5581
	 */
J
Joao Moreno 已提交
5582
	export interface SourceControlResourceDecorations extends SourceControlResourceThemableDecorations {
J
Joao Moreno 已提交
5583 5584

		/**
J
Joao Moreno 已提交
5585 5586
		 * Whether the [source control resource state](#SourceControlResourceState) should
		 * be striked-through in the UI.
J
Joao Moreno 已提交
5587
		 */
J
Joao Moreno 已提交
5588
		readonly strikeThrough?: boolean;
J
Joao Moreno 已提交
5589

5590 5591
		/**
		 * Whether the [source control resource state](#SourceControlResourceState) should
I
Ilie Halip 已提交
5592
		 * be faded in the UI.
5593 5594 5595
		 */
		readonly faded?: boolean;

5596 5597 5598 5599 5600 5601
		/**
		 * The title for a specific
		 * [source control resource state](#SourceControlResourceState).
		 */
		readonly tooltip?: string;

J
Joao Moreno 已提交
5602
		/**
J
Joao Moreno 已提交
5603
		 * The light theme decorations.
J
Joao Moreno 已提交
5604
		 */
J
Joao Moreno 已提交
5605
		readonly light?: SourceControlResourceThemableDecorations;
J
Joao Moreno 已提交
5606 5607

		/**
J
Joao Moreno 已提交
5608
		 * The dark theme decorations.
J
Joao Moreno 已提交
5609
		 */
J
Joao Moreno 已提交
5610
		readonly dark?: SourceControlResourceThemableDecorations;
J
Joao Moreno 已提交
5611 5612 5613
	}

	/**
J
Joao Moreno 已提交
5614 5615
	 * An source control resource state represents the state of an underlying workspace
	 * resource within a certain [source control group](#SourceControlResourceGroup).
J
Joao Moreno 已提交
5616
	 */
J
Joao Moreno 已提交
5617
	export interface SourceControlResourceState {
J
Joao Moreno 已提交
5618 5619

		/**
J
Joao Moreno 已提交
5620
		 * The [uri](#Uri) of the underlying resource inside the workspace.
J
Joao Moreno 已提交
5621
		 */
J
Joao Moreno 已提交
5622
		readonly resourceUri: Uri;
J
Joao Moreno 已提交
5623 5624

		/**
J
Joao Moreno 已提交
5625 5626
		 * The [command](#Command) which should be run when the resource
		 * state is open in the Source Control viewlet.
J
Joao Moreno 已提交
5627
		 */
5628
		readonly command?: Command;
J
Joao Moreno 已提交
5629 5630

		/**
J
Joao Moreno 已提交
5631 5632
		 * The [decorations](#SourceControlResourceDecorations) for this source control
		 * resource state.
J
Joao Moreno 已提交
5633
		 */
J
Joao Moreno 已提交
5634
		readonly decorations?: SourceControlResourceDecorations;
J
Joao Moreno 已提交
5635 5636 5637
	}

	/**
J
Joao Moreno 已提交
5638 5639
	 * A source control resource group is a collection of
	 * [source control resource states](#SourceControlResourceState).
J
Joao Moreno 已提交
5640
	 */
J
Joao Moreno 已提交
5641 5642 5643 5644 5645 5646
	export interface SourceControlResourceGroup {

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

		/**
J
Joao Moreno 已提交
5649
		 * The label of this source control resource group.
J
Joao Moreno 已提交
5650
		 */
5651
		label: string;
J
Joao Moreno 已提交
5652 5653

		/**
J
Joao Moreno 已提交
5654 5655
		 * Whether this source control resource group is hidden when it contains
		 * no [source control resource states](#SourceControlResourceState).
J
Joao Moreno 已提交
5656
		 */
J
Joao Moreno 已提交
5657
		hideWhenEmpty?: boolean;
J
Joao Moreno 已提交
5658 5659

		/**
J
Joao Moreno 已提交
5660 5661
		 * This group's collection of
		 * [source control resource states](#SourceControlResourceState).
J
Joao Moreno 已提交
5662
		 */
J
Joao Moreno 已提交
5663
		resourceStates: SourceControlResourceState[];
J
Joao Moreno 已提交
5664 5665

		/**
J
Joao Moreno 已提交
5666
		 * Dispose this source control resource group.
J
Joao Moreno 已提交
5667
		 */
J
Joao Moreno 已提交
5668 5669 5670 5671 5672 5673 5674 5675
		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 已提交
5676 5677

		/**
J
Joao Moreno 已提交
5678
		 * The id of this source control.
J
Joao Moreno 已提交
5679
		 */
J
Joao Moreno 已提交
5680
		readonly id: string;
J
Joao Moreno 已提交
5681 5682

		/**
J
Joao Moreno 已提交
5683
		 * The human-readable label of this source control.
J
Joao Moreno 已提交
5684
		 */
J
Joao Moreno 已提交
5685
		readonly label: string;
J
Joao Moreno 已提交
5686

J
Joao Moreno 已提交
5687 5688 5689 5690 5691
		/**
		 * The (optional) Uri of the root of this source control.
		 */
		readonly rootUri: Uri | undefined;

J
Joao Moreno 已提交
5692 5693 5694 5695 5696
		/**
		 * The [input box](#SourceControlInputBox) for this source control.
		 */
		readonly inputBox: SourceControlInputBox;

J
Joao Moreno 已提交
5697
		/**
J
Joao Moreno 已提交
5698 5699
		 * The UI-visible count of [resource states](#SourceControlResourceState) of
		 * this source control.
J
Joao Moreno 已提交
5700
		 *
J
Joao Moreno 已提交
5701 5702
		 * Equals to the total number of [resource state](#SourceControlResourceState)
		 * of this source control, if undefined.
J
Joao Moreno 已提交
5703
		 */
J
Joao Moreno 已提交
5704
		count?: number;
J
Joao Moreno 已提交
5705 5706

		/**
J
Joao Moreno 已提交
5707
		 * An optional [quick diff provider](#QuickDiffProvider).
J
Joao Moreno 已提交
5708
		 */
J
Joao Moreno 已提交
5709
		quickDiffProvider?: QuickDiffProvider;
J
Joao Moreno 已提交
5710

J
Joao Moreno 已提交
5711
		/**
5712 5713 5714 5715
		 * Optional commit template string.
		 *
		 * The Source Control viewlet will populate the Source Control
		 * input with this value when appropriate.
J
Joao Moreno 已提交
5716
		 */
5717
		commitTemplate?: string;
J
Joao Moreno 已提交
5718 5719

		/**
5720 5721 5722 5723
		 * Optional accept input command.
		 *
		 * This command will be invoked when the user accepts the value
		 * in the Source Control input.
J
Joao Moreno 已提交
5724
		 */
5725
		acceptInputCommand?: Command;
J
Joao Moreno 已提交
5726 5727

		/**
5728 5729 5730
		 * Optional status bar commands.
		 *
		 * These commands will be displayed in the editor's status bar.
J
Joao Moreno 已提交
5731
		 */
5732
		statusBarCommands?: Command[];
J
Joao Moreno 已提交
5733 5734

		/**
5735
		 * Create a new [resource group](#SourceControlResourceGroup).
J
Joao Moreno 已提交
5736
		 */
5737
		createResourceGroup(id: string, label: string): SourceControlResourceGroup;
J
Joao Moreno 已提交
5738 5739

		/**
5740
		 * Dispose this source control.
J
Joao Moreno 已提交
5741
		 */
5742 5743 5744 5745
		dispose(): void;
	}

	export namespace scm {
J
Joao Moreno 已提交
5746 5747

		/**
J
Joao 已提交
5748 5749
		 * ~~The [input box](#SourceControlInputBox) for the last source control
		 * created by the extension.~~
J
Joao Moreno 已提交
5750
		 *
J
Joao Moreno 已提交
5751
		 * @deprecated Use SourceControl.inputBox instead
J
Joao Moreno 已提交
5752
		 */
5753
		export const inputBox: SourceControlInputBox;
J
Joao Moreno 已提交
5754 5755

		/**
J
Joao Moreno 已提交
5756
		 * Creates a new [source control](#SourceControl) instance.
J
Joao Moreno 已提交
5757
		 *
5758
		 * @param id An `id` for the source control. Something short, eg: `git`.
J
Joao Moreno 已提交
5759
		 * @param label A human-readable string for the source control. Eg: `Git`.
J
Joao Moreno 已提交
5760
		 * @param rootUri An optional Uri of the root of the source control. Eg: `Uri.parse(workspaceRoot)`.
J
Joao Moreno 已提交
5761
		 * @return An instance of [source control](#SourceControl).
J
Joao Moreno 已提交
5762
		 */
J
Joao Moreno 已提交
5763
		export function createSourceControl(id: string, label: string, rootUri?: Uri): SourceControl;
J
Joao Moreno 已提交
5764 5765
	}

5766 5767 5768 5769 5770
	/**
	 * Configuration for a debug session.
	 */
	export interface DebugConfiguration {
		/**
5771
		 * The type of the debug session.
5772 5773 5774 5775
		 */
		type: string;

		/**
5776
		 * The name of the debug session.
5777
		 */
5778
		name: string;
5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795

		/**
		 * The request type of the debug session.
		 */
		request: string;

		/**
		 * Additional debug type specific properties.
		 */
		[key: string]: any;
	}

	/**
	 * A debug session.
	 */
	export interface DebugSession {

A
Andre Weinand 已提交
5796 5797 5798 5799 5800
		/**
		 * The unique ID of this debug session.
		 */
		readonly id: string;

5801
		/**
A
Andre Weinand 已提交
5802
		 * The debug session's type from the [debug configuration](#DebugConfiguration).
A
Andre Weinand 已提交
5803
		 */
5804 5805 5806
		readonly type: string;

		/**
A
Andre Weinand 已提交
5807
		 * The debug session's name from the [debug configuration](#DebugConfiguration).
5808 5809 5810 5811 5812 5813 5814 5815 5816 5817
		 */
		readonly name: string;

		/**
		 * Send a custom request to the debug adapter.
		 */
		customRequest(command: string, args?: any): Thenable<any>;
	}

	/**
A
Andre Weinand 已提交
5818
	 * A custom Debug Adapter Protocol event received from a [debug session](#DebugSession).
5819
	 */
A
Andre Weinand 已提交
5820 5821 5822 5823 5824
	export interface DebugSessionCustomEvent {
		/**
		 * The [debug session](#DebugSession) for which the custom event was received.
		 */
		session: DebugSession;
5825 5826

		/**
A
Andre Weinand 已提交
5827
		 * Type of event.
5828
		 */
A
Andre Weinand 已提交
5829 5830 5831 5832 5833 5834 5835 5836
		event: string;

		/**
		 * Event specific information.
		 */
		body?: any;
	}

A
Andre Weinand 已提交
5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865
	/**
	 * A debug configuration provider allows to add the initial debug configurations to a newly created launch.json
	 * and allows to resolve a launch configuration before it is used to start a new debug session.
	 * A debug configuration provider is registered via #workspace.registerDebugConfigurationProvider.
	 */
	export interface DebugConfigurationProvider {
		/**
		 * Provides initial [debug configuration](#DebugConfiguration). If more than one debug configuration provider is
		 * registered for the same type, debug configurations are concatenated in arbitrary order.
		 *
		 * @param folder The workspace folder for which the configurations are used or undefined for a folderless setup.
		 * @param token A cancellation token.
		 * @return An array of [debug configurations](#DebugConfiguration).
		 */
		provideDebugConfigurations?(folder: WorkspaceFolder | undefined, token?: CancellationToken): ProviderResult<DebugConfiguration[]>;

		/**
		 * Resolves a [debug configuration](#DebugConfiguration) by filling in missing values or by adding/changing/removing attributes.
		 * If more than one debug configuration provider is registered for the same type, the resolveDebugConfiguration calls are chained
		 * in arbitrary order and the initial debug configuration is piped through the chain.
		 *
		 * @param folder The workspace folder from which the configuration originates from or undefined for a folderless setup.
		 * @param debugConfiguration The [debug configuration](#DebugConfiguration) to resolve.
		 * @param token A cancellation token.
		 * @return The resolved debug configuration.
		 */
		resolveDebugConfiguration?(folder: WorkspaceFolder | undefined, debugConfiguration: DebugConfiguration, token?: CancellationToken): ProviderResult<DebugConfiguration>;
	}

A
Andre Weinand 已提交
5866 5867 5868 5869
	/**
	 * Namespace for dealing with debug sessions.
	 */
	export namespace debug {
5870 5871

		/**
5872
		 * Start debugging by using either a named launch or named compound configuration,
A
Andre Weinand 已提交
5873
		 * or by directly passing a [DebugConfiguration](#DebugConfiguration).
5874 5875
		 * The named configurations are looked up in '.vscode/launch.json' found in the given folder.
		 * Before debugging starts, all unsaved files are saved and the launch configurations are brought up-to-date.
I
isidor 已提交
5876
		 * Folder specific variables used in the configuration (e.g. '${workspaceFolder}') are resolved against the given folder.
A
Andre Weinand 已提交
5877 5878
		 * @param folder The [workspace folder](#WorkspaceFolder) for looking up named configurations and resolving variables or `undefined` for a non-folder setup.
		 * @param nameOrConfiguration Either the name of a debug or compound configuration or a [DebugConfiguration](#DebugConfiguration) object.
5879 5880 5881
		 * @return A thenable that resolves when debugging could be successfully started.
		 */
		export function startDebugging(folder: WorkspaceFolder | undefined, nameOrConfiguration: string | DebugConfiguration): Thenable<boolean>;
A
Andre Weinand 已提交
5882 5883

		/**
A
Andre Weinand 已提交
5884
		 * The currently active [debug session](#DebugSession) or `undefined`. The active debug session is the one
A
Andre Weinand 已提交
5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896
		 * represented by the debug action floating window or the one currently shown in the drop down menu of the debug action floating window.
		 * If no debug session is active, the value is `undefined`.
		 */
		export let activeDebugSession: DebugSession | undefined;

		/**
		 * An [event](#Event) which fires when the [active debug session](#debug.activeDebugSession)
		 * has changed. *Note* that the event also fires when the active debug session changes
		 * to `undefined`.
		 */
		export const onDidChangeActiveDebugSession: Event<DebugSession | undefined>;

5897
		/**
A
Andre Weinand 已提交
5898
		 * An [event](#Event) which fires when a new [debug session](#DebugSession) has been started.
5899 5900 5901
		 */
		export const onDidStartDebugSession: Event<DebugSession>;

A
Andre Weinand 已提交
5902
		/**
A
Andre Weinand 已提交
5903
		 * An [event](#Event) which fires when a custom DAP event is received from the [debug session](#DebugSession).
A
Andre Weinand 已提交
5904 5905 5906 5907
		 */
		export const onDidReceiveDebugSessionCustomEvent: Event<DebugSessionCustomEvent>;

		/**
A
Andre Weinand 已提交
5908
		 * An [event](#Event) which fires when a [debug session](#DebugSession) has terminated.
A
Andre Weinand 已提交
5909 5910
		 */
		export const onDidTerminateDebugSession: Event<DebugSession>;
A
Andre Weinand 已提交
5911 5912 5913 5914 5915 5916 5917 5918 5919 5920

		/**
		 * Register a [debug configuration provider](#DebugConfigurationProvider) for a specifc debug type.
		 * More than one provider can be registered for the same type.
		 *
		 * @param type The debug type for which the provider is registered.
		 * @param provider The [debug configuration provider](#DebugConfigurationProvider) to register.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerDebugConfigurationProvider(debugType: string, provider: DebugConfigurationProvider): Disposable;
5921 5922
	}

J
Johannes Rieken 已提交
5923
	/**
5924 5925 5926
	 * Namespace for dealing with installed extensions. Extensions are represented
	 * by an [extension](#Extension)-interface which allows to reflect on them.
	 *
S
Steven Clarke 已提交
5927
	 * Extension writers can provide APIs to other extensions by returning their API public
5928 5929 5930 5931
	 * surface from the `activate`-call.
	 *
	 * ```javascript
	 * export function activate(context: vscode.ExtensionContext) {
5932 5933 5934 5935 5936 5937 5938 5939 5940 5941
	 * 	let api = {
	 * 		sum(a, b) {
	 * 			return a + b;
	 * 		},
	 * 		mul(a, b) {
	 * 			return a * b;
	 * 		}
	 * 	};
	 * 	// 'export' public api-surface
	 * 	return api;
5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953
	 * }
	 * ```
	 * 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 已提交
5954
	 */
E
Erich Gamma 已提交
5955 5956
	export namespace extensions {

J
Johannes Rieken 已提交
5957
		/**
5958
		 * Get an extension by its full identifier in the form of: `publisher.name`.
J
Johannes Rieken 已提交
5959
		 *
J
Johannes Rieken 已提交
5960
		 * @param extensionId An extension identifier.
J
Johannes Rieken 已提交
5961 5962
		 * @return An extension or `undefined`.
		 */
5963
		export function getExtension(extensionId: string): Extension<any> | undefined;
E
Erich Gamma 已提交
5964

J
Johannes Rieken 已提交
5965
		/**
A
Andre Weinand 已提交
5966
		 * Get an extension its full identifier in the form of: `publisher.name`.
J
Johannes Rieken 已提交
5967 5968 5969
		 *
		 * @param extensionId An extension identifier.
		 * @return An extension or `undefined`.
J
Johannes Rieken 已提交
5970
		 */
5971
		export function getExtension<T>(extensionId: string): Extension<T> | undefined;
E
Erich Gamma 已提交
5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983

		/**
		 * 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,
J
Johannes Rieken 已提交
5984
 * we recommend the use of native promises which are available in this editor.
E
Erich Gamma 已提交
5985
 */
5986
interface Thenable<T> {
E
Erich Gamma 已提交
5987 5988 5989 5990 5991 5992
	/**
	* 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.
	*/
5993 5994
	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 已提交
5995
}