vscode.d.ts 363.0 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
		/**
N
Nick Schonning 已提交
32
		 * A tooltip for the command, when represented in the UI.
33 34 35
		 */
		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 whitespace 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 94 95 96 97
		 * The associated uri for this document.
		 *
		 * *Note* that most documents use the `file`-scheme, which means they are files on disk. However, **not** all documents are
		 * saved on disk and therefore the `scheme` must be checked before trying to access the underlying file or siblings on disk.
		 *
		 * @see [FileSystemProvider](#FileSystemProvider)
		 * @see [TextDocumentContentProvider](#TextDocumentContentProvider)
E
Erich Gamma 已提交
98
		 */
Y
Yuki Ueda 已提交
99
		readonly uri: Uri;
E
Erich Gamma 已提交
100 101

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

		/**
108 109 110
		 * Is this document representing an untitled file which has never been saved yet. *Note* that
		 * this does not mean the document will be saved to disk, use [`uri.scheme`](#Uri.scheme)
		 * to figure out where a document will be [saved](#FileSystemProvider), e.g. `file`, `ftp` etc.
E
Erich Gamma 已提交
111
		 */
Y
Yuki Ueda 已提交
112
		readonly isUntitled: boolean;
E
Erich Gamma 已提交
113 114

		/**
J
Johannes Rieken 已提交
115
		 * The identifier of the language associated with this document.
E
Erich Gamma 已提交
116
		 */
Y
Yuki Ueda 已提交
117
		readonly languageId: string;
E
Erich Gamma 已提交
118 119 120 121 122

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

		/**
126
		 * `true` if there are unpersisted changes.
E
Erich Gamma 已提交
127
		 */
Y
Yuki Ueda 已提交
128
		readonly isDirty: boolean;
E
Erich Gamma 已提交
129

130
		/**
J
Johannes Rieken 已提交
131
		 * `true` if the document has been closed. A closed document isn't synchronized anymore
132 133 134 135
		 * and won't be re-used when the same resource is opened again.
		 */
		readonly isClosed: boolean;

E
Erich Gamma 已提交
136 137 138 139
		/**
		 * Save the underlying file.
		 *
		 * @return A promise that will resolve to true when the file
140 141
		 * has been saved. If the file was not dirty or the save failed,
		 * will return false.
E
Erich Gamma 已提交
142 143 144
		 */
		save(): Thenable<boolean>;

J
Johannes Rieken 已提交
145 146 147 148 149 150
		/**
		 * The [end of line](#EndOfLine) sequence that is predominately
		 * used in this document.
		 */
		readonly eol: EndOfLine;

E
Erich Gamma 已提交
151 152 153
		/**
		 * The number of lines in this document.
		 */
Y
Yuki Ueda 已提交
154
		readonly lineCount: number;
E
Erich Gamma 已提交
155 156 157 158 159 160

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

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

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

		/**
J
Johannes Rieken 已提交
198 199 200 201
		 * 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 已提交
202
		 * @return The text inside the provided range or the entire text.
E
Erich Gamma 已提交
203 204 205 206
		 */
		getText(range?: Range): string;

		/**
J
Johannes Rieken 已提交
207
		 * Get a word-range at the given position. By default words are defined by
208
		 * common separators, like space, -, _, etc. In addition, per language custom
209
		 * [word definitions](#LanguageConfiguration.wordPattern) can be defined. It
210 211 212 213 214 215 216
		 * 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 已提交
217
		 *
A
Alex Dima 已提交
218 219
		 * The position will be [adjusted](#TextDocument.validatePosition).
		 *
J
Johannes Rieken 已提交
220
		 * @param position A position.
221
		 * @param regex Optional regular expression that describes what a word is.
J
Johannes Rieken 已提交
222
		 * @return A range spanning a word, or `undefined`.
E
Erich Gamma 已提交
223
		 */
224
		getWordRangeAtPosition(position: Position, regex?: RegExp): Range | undefined;
E
Erich Gamma 已提交
225 226

		/**
J
Johannes Rieken 已提交
227 228 229 230
		 * 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 已提交
231 232 233 234
		 */
		validateRange(range: Range): Range;

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

	/**
	 * Represents a line and character position, such as
A
Alex Dima 已提交
245
	 * the position of the cursor.
E
Erich Gamma 已提交
246 247 248 249 250 251 252 253 254 255
	 *
	 * 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 已提交
256
		readonly line: number;
E
Erich Gamma 已提交
257 258 259 260

		/**
		 * The zero-based character value.
		 */
Y
Yuki Ueda 已提交
261
		readonly character: number;
E
Erich Gamma 已提交
262 263

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

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

		/**
279
		 * Check if this position is before or equal to `other`.
A
Alex Dima 已提交
280 281 282 283
		 *
		 * @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 已提交
284 285 286 287
		 */
		isBeforeOrEqual(other: Position): boolean;

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

		/**
297
		 * Check if this position is after or equal to `other`.
A
Alex Dima 已提交
298 299 300 301
		 *
		 * @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 已提交
302 303 304 305
		 */
		isAfterOrEqual(other: Position): boolean;

		/**
M
Mathieu Bruguier 已提交
306
		 * Check if this position is equal to `other`.
A
Alex Dima 已提交
307 308
		 *
		 * @param other A position.
E
Erich Gamma 已提交
309 310 311 312 313 314
		 * @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 已提交
315 316 317 318 319
		 * 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 已提交
320 321 322 323 324
		 * this and the given position are equal.
		 */
		compareTo(other: Position): number;

		/**
A
Alex Dima 已提交
325
		 * Create a new position relative to this position.
E
Erich Gamma 已提交
326 327 328 329 330 331 332 333
		 *
		 * @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;

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

		/**
		 * 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 已提交
360 361 362 363
	}

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

		/**
A
Andre Weinand 已提交
378
		 * The end position. It is after or equal to [start](#Range.start).
E
Erich Gamma 已提交
379
		 */
Y
Yuki Ueda 已提交
380
		readonly end: Position;
E
Erich Gamma 已提交
381 382

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

		/**
A
Alex Dima 已提交
392 393
		 * 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 已提交
394
		 *
A
Alex Dima 已提交
395 396 397 398
		 * @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 已提交
399
		 */
J
Johannes Rieken 已提交
400
		constructor(startLine: number, startCharacter: number, endLine: number, endCharacter: number);
E
Erich Gamma 已提交
401 402

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

		/**
G
Gama11 已提交
408
		 * `true` if `start.line` and `end.line` are equal.
E
Erich Gamma 已提交
409 410 411 412
		 */
		isSingleLine: boolean;

		/**
A
Alex Dima 已提交
413 414 415
		 * Check if a position or a range is contained in this range.
		 *
		 * @param positionOrRange A position or a range.
G
Gama11 已提交
416
		 * @return `true` if the position or range is inside or equal
E
Erich Gamma 已提交
417 418 419 420 421
		 * to this range.
		 */
		contains(positionOrRange: Position | Range): boolean;

		/**
A
Alex Dima 已提交
422 423 424
		 * Check if `other` equals this range.
		 *
		 * @param other A range.
E
Erich Gamma 已提交
425
		 * @return `true` when start and end are [equal](#Position.isEqual) to
A
Andre Weinand 已提交
426
		 * start and end of this range.
E
Erich Gamma 已提交
427 428 429 430
		 */
		isEqual(other: Range): boolean;

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

		/**
A
Alex Dima 已提交
441 442 443
		 * Compute the union of `other` with this range.
		 *
		 * @param other A range.
E
Erich Gamma 已提交
444 445 446 447 448
		 * @return A range of smaller start position and the greater end position.
		 */
		union(other: Range): Range;

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

		/**
		 * 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 已提交
465
		with(change: { start?: Position, end?: Position }): Range;
E
Erich Gamma 已提交
466 467 468 469 470 471 472 473 474
	}

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

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

		/**
		 * The position of the cursor.
A
Andre Weinand 已提交
481
		 * This position might be before or after [anchor](#Selection.anchor).
E
Erich Gamma 已提交
482
		 */
A
Alex Dima 已提交
483
		active: Position;
E
Erich Gamma 已提交
484 485

		/**
486
		 * Create a selection from two positions.
J
Johannes Rieken 已提交
487 488 489
		 *
		 * @param anchor A position.
		 * @param active A position.
E
Erich Gamma 已提交
490 491 492 493
		 */
		constructor(anchor: Position, active: Position);

		/**
A
Alex Dima 已提交
494
		 * Create a selection from four coordinates.
J
Johannes Rieken 已提交
495
		 *
A
Alex Dima 已提交
496 497 498 499
		 * @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 已提交
500
		 */
J
Johannes Rieken 已提交
501
		constructor(anchorLine: number, anchorCharacter: number, activeLine: number, activeCharacter: number);
A
Alex Dima 已提交
502

E
Erich Gamma 已提交
503
		/**
A
Andre Weinand 已提交
504
		 * A selection is reversed if [active](#Selection.active).isBefore([anchor](#Selection.anchor)).
E
Erich Gamma 已提交
505 506 507 508
		 */
		isReversed: boolean;
	}

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

546 547 548 549 550 551 552
	/**
	 * Represents an event describing the change in a [text editor's visible ranges](#TextEditor.visibleRanges).
	 */
	export interface TextEditorVisibleRangesChangeEvent {
		/**
		 * The [text editor](#TextEditor) for which the visible ranges have changed.
		 */
553
		readonly textEditor: TextEditor;
554 555 556
		/**
		 * The new value for the [text editor's visible ranges](#TextEditor.visibleRanges).
		 */
557
		readonly visibleRanges: ReadonlyArray<Range>;
558 559
	}

A
Alex Dima 已提交
560 561 562
	/**
	 * Represents an event describing the change in a [text editor's options](#TextEditor.options).
	 */
J
Johannes Rieken 已提交
563
	export interface TextEditorOptionsChangeEvent {
A
Alex Dima 已提交
564 565 566
		/**
		 * The [text editor](#TextEditor) for which the options have changed.
		 */
567
		readonly textEditor: TextEditor;
A
Alex Dima 已提交
568 569 570
		/**
		 * The new value for the [text editor's options](#TextEditor.options).
		 */
571
		readonly options: TextEditorOptions;
J
Johannes Rieken 已提交
572 573
	}

574 575 576 577 578
	/**
	 * Represents an event describing the change of a [text editor's view column](#TextEditor.viewColumn).
	 */
	export interface TextEditorViewColumnChangeEvent {
		/**
B
Benjamin Pasero 已提交
579
		 * The [text editor](#TextEditor) for which the view column has changed.
580
		 */
581
		readonly textEditor: TextEditor;
582 583 584
		/**
		 * The new value for the [text editor's view column](#TextEditor.viewColumn).
		 */
585
		readonly viewColumn: ViewColumn;
586 587
	}

A
Alex Dima 已提交
588 589 590 591 592
	/**
	 * Rendering style of the cursor.
	 */
	export enum TextEditorCursorStyle {
		/**
593
		 * Render the cursor as a vertical thick line.
A
Alex Dima 已提交
594 595 596
		 */
		Line = 1,
		/**
597
		 * Render the cursor as a block filled.
A
Alex Dima 已提交
598
		 */
A
Alex Dima 已提交
599 600
		Block = 2,
		/**
601
		 * Render the cursor as a thick horizontal line.
A
Alex Dima 已提交
602
		 */
603
		Underline = 3,
604
		/**
605
		 * Render the cursor as a vertical thin line.
606
		 */
607
		LineThin = 4,
608
		/**
609
		 * Render the cursor as a block outlined.
610
		 */
611
		BlockOutline = 5,
612 613 614 615
		/**
		 * Render the cursor as a thin horizontal line.
		 */
		UnderlineThin = 6
A
Alex Dima 已提交
616 617
	}

618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
	/**
	 * 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 已提交
636
	/**
A
Alex Dima 已提交
637
	 * Represents a [text editor](#TextEditor)'s [options](#TextEditor.options).
E
Erich Gamma 已提交
638 639 640 641
	 */
	export interface TextEditorOptions {

		/**
A
Alex Dima 已提交
642 643
		 * The size in spaces a tab takes. This is used for two purposes:
		 *  - the rendering width of a tab character;
644
		 *  - the number of spaces to insert when [insertSpaces](#TextEditorOptions.insertSpaces) is true.
J
Johannes Rieken 已提交
645
		 *
646 647
		 * 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 已提交
648
		 */
649
		tabSize?: number | string;
E
Erich Gamma 已提交
650 651 652

		/**
		 * When pressing Tab insert [n](#TextEditorOptions.tabSize) spaces.
653 654
		 * 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 已提交
655
		 */
656
		insertSpaces?: boolean | string;
A
Alex Dima 已提交
657 658 659 660 661 662 663

		/**
		 * 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;
664 665 666 667 668 669

		/**
		 * 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.
		 */
670
		lineNumbers?: TextEditorLineNumbersStyle;
E
Erich Gamma 已提交
671 672
	}

J
Johannes Rieken 已提交
673
	/**
A
Alex Dima 已提交
674 675
	 * Represents a handle to a set of decorations
	 * sharing the same [styling options](#DecorationRenderOptions) in a [text editor](#TextEditor).
J
Johannes Rieken 已提交
676 677 678 679
	 *
	 * To get an instance of a `TextEditorDecorationType` use
	 * [createTextEditorDecorationType](#window.createTextEditorDecorationType).
	 */
E
Erich Gamma 已提交
680 681 682
	export interface TextEditorDecorationType {

		/**
A
Alex Dima 已提交
683
		 * Internal representation of the handle.
E
Erich Gamma 已提交
684
		 */
Y
Yuki Ueda 已提交
685
		readonly key: string;
E
Erich Gamma 已提交
686

A
Alex Dima 已提交
687 688 689
		/**
		 * Remove this decoration type and all decorations on all text editors using it.
		 */
E
Erich Gamma 已提交
690 691 692
		dispose(): void;
	}

A
Alex Dima 已提交
693 694 695
	/**
	 * Represents different [reveal](#TextEditor.revealRange) strategies in a text editor.
	 */
E
Erich Gamma 已提交
696
	export enum TextEditorRevealType {
A
Alex Dima 已提交
697 698 699
		/**
		 * The range will be revealed with as little scrolling as possible.
		 */
700
		Default = 0,
A
Alex Dima 已提交
701 702 703
		/**
		 * The range will always be revealed in the center of the viewport.
		 */
704
		InCenter = 1,
A
Alex Dima 已提交
705 706 707 708
		/**
		 * 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.
		 */
709 710 711 712 713
		InCenterIfOutsideViewport = 2,
		/**
		 * The range will always be revealed at the top of the viewport.
		 */
		AtTop = 3
E
Erich Gamma 已提交
714 715
	}

A
Alex Dima 已提交
716
	/**
S
Sofian Hnaide 已提交
717
	 * Represents different positions for rendering a decoration in an [overview ruler](#DecorationRenderOptions.overviewRulerLane).
A
Alex Dima 已提交
718 719
	 * The overview ruler supports three lanes.
	 */
E
Erich Gamma 已提交
720 721 722 723 724 725 726
	export enum OverviewRulerLane {
		Left = 1,
		Center = 2,
		Right = 4,
		Full = 7
	}

727
	/**
728
	 * Describes the behavior of decorations when typing/editing at their edges.
729
	 */
730
	export enum DecorationRangeBehavior {
A
Alex Dima 已提交
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
		/**
		 * 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
747 748
	}

749 750 751
	/**
	 * Represents options to configure the behavior of showing a [document](#TextDocument) in an [editor](#TextEditor).
	 */
752
	export interface TextDocumentShowOptions {
753
		/**
754
		 * An optional view column in which the [editor](#TextEditor) should be shown.
B
Benjamin Pasero 已提交
755
		 * The default is the [active](#ViewColumn.Active), other values are adjusted to
J
Johannes Rieken 已提交
756
		 * be `Min(column, columnCount + 1)`, the [active](#ViewColumn.Active)-column is
757 758
		 * not adjusted. Use [`ViewColumn.Beside`](#ViewColumn.Beside) to open the
		 * editor to the side of the currently active one.
759
		 */
J
Johannes Rieken 已提交
760
		viewColumn?: ViewColumn;
761 762 763 764

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

		/**
J
Johannes Rieken 已提交
768 769
		 * An optional flag that controls if an [editor](#TextEditor)-tab will be replaced
		 * with the next editor or if it will be kept.
770
		 */
J
Johannes Rieken 已提交
771
		preview?: boolean;
772 773 774 775 776

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

779 780 781 782 783 784 785 786 787 788 789 790 791
	/**
	 * 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);
	}

792
	/**
S
Sandeep Somavarapu 已提交
793 794
	 * A reference to a named icon. Currently, [File](#ThemeIcon.File), [Folder](#ThemeIcon.Folder),
	 * and [codicons](https://microsoft.github.io/vscode-codicons/dist/codicon.html) are supported.
795
	 * Using a theme icon is preferred over a custom icon as it gives theme authors the possibility to change the icons.
796 797 798
	 *
	 * *Note* that theme icons can also be rendered inside labels and descriptions. Places that support theme icons spell this out
	 * and they use the `$(<name>)`-syntax, for instance `quickPick.label = "Hello World $(globe)"`.
799 800 801
	 */
	export class ThemeIcon {
		/**
J
Johannes Rieken 已提交
802
		 * Reference to an icon representing a file. The icon is taken from the current file icon theme or a placeholder icon is used.
803 804 805 806
		 */
		static readonly File: ThemeIcon;

		/**
J
Johannes Rieken 已提交
807
		 * Reference to an icon representing a folder. The icon is taken from the current file icon theme or a placeholder icon is used.
808 809 810
		 */
		static readonly Folder: ThemeIcon;

S
Sandeep Somavarapu 已提交
811 812
		/**
		 * Creates a reference to a theme icon.
G
Gaurav Makhecha 已提交
813
		 * @param id id of the icon. The available icons are listed in https://microsoft.github.io/vscode-codicons/dist/codicon.html.
S
Sandeep Somavarapu 已提交
814 815
		 */
		constructor(id: string);
816 817
	}

A
Alex Dima 已提交
818 819 820
	/**
	 * Represents theme specific rendering styles for a [text editor decoration](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
821 822 823
	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 已提交
824
		 * Alternatively a color from the color registry can be [referenced](#ThemeColor).
E
Erich Gamma 已提交
825
		 */
826
		backgroundColor?: string | ThemeColor;
E
Erich Gamma 已提交
827 828 829 830

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
831 832 833 834 835 836
		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.
		 */
837
		outlineColor?: string | ThemeColor;
E
Erich Gamma 已提交
838 839 840

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
841
		 * Better use 'outline' for setting one or more of the individual outline properties.
E
Erich Gamma 已提交
842 843 844 845 846
		 */
		outlineStyle?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
847
		 * Better use 'outline' for setting one or more of the individual outline properties.
E
Erich Gamma 已提交
848 849 850 851 852 853
		 */
		outlineWidth?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
854 855 856 857 858 859
		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.
		 */
860
		borderColor?: string | ThemeColor;
E
Erich Gamma 已提交
861 862 863

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
864
		 * Better use 'border' for setting one or more of the individual border properties.
E
Erich Gamma 已提交
865 866 867 868 869
		 */
		borderRadius?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
870
		 * Better use 'border' for setting one or more of the individual border properties.
E
Erich Gamma 已提交
871 872 873 874 875
		 */
		borderSpacing?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
876
		 * Better use 'border' for setting one or more of the individual border properties.
E
Erich Gamma 已提交
877 878 879 880 881
		 */
		borderStyle?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
882
		 * Better use 'border' for setting one or more of the individual border properties.
E
Erich Gamma 已提交
883 884 885
		 */
		borderWidth?: string;

886 887 888 889 890 891 892 893 894 895
		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		fontStyle?: string;

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

E
Erich Gamma 已提交
896 897 898 899 900 901 902 903 904 905 906 907 908
		/**
		 * 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.
		 */
909
		color?: string | ThemeColor;
E
Erich Gamma 已提交
910

M
Matt Bierner 已提交
911 912 913 914 915
		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		opacity?: string;

916 917 918 919 920
		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		letterSpacing?: string;

E
Erich Gamma 已提交
921
		/**
922
		 * An **absolute path** or an URI to an image to be rendered in the gutter.
E
Erich Gamma 已提交
923
		 */
924
		gutterIconPath?: string | Uri;
E
Erich Gamma 已提交
925

926 927 928 929 930 931 932
		/**
		 * 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 已提交
933 934 935
		/**
		 * The color of the decoration in the overview ruler. Use rgba() and define transparent colors to play well with other decorations.
		 */
936
		overviewRulerColor?: string | ThemeColor;
M
Martin Aeschlimann 已提交
937 938

		/**
939
		 * Defines the rendering options of the attachment that is inserted before the decorated text.
M
Martin Aeschlimann 已提交
940 941 942 943
		 */
		before?: ThemableDecorationAttachmentRenderOptions;

		/**
944
		 * Defines the rendering options of the attachment that is inserted after the decorated text.
M
Martin Aeschlimann 已提交
945 946 947 948 949
		 */
		after?: ThemableDecorationAttachmentRenderOptions;
	}

	export interface ThemableDecorationAttachmentRenderOptions {
950 951 952 953 954
		/**
		 * Defines a text content that is shown in the attachment. Either an icon or a text can be shown, but not both.
		 */
		contentText?: string;
		/**
955 956
		 * 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.
957
		 */
958
		contentIconPath?: string | Uri;
959 960 961 962
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
		border?: string;
963 964 965 966
		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		borderColor?: string | ThemeColor;
967 968 969 970 971 972 973 974
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
		fontStyle?: string;
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
		fontWeight?: string;
975 976 977
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
M
Martin Aeschlimann 已提交
978
		textDecoration?: string;
979 980 981
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
982
		color?: string | ThemeColor;
983 984 985
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
986
		backgroundColor?: string | ThemeColor;
987 988 989
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
M
Martin Aeschlimann 已提交
990
		margin?: string;
991 992 993
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
M
Martin Aeschlimann 已提交
994
		width?: string;
995 996 997
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
M
Martin Aeschlimann 已提交
998
		height?: string;
E
Erich Gamma 已提交
999 1000
	}

A
Alex Dima 已提交
1001 1002 1003
	/**
	 * Represents rendering styles for a [text editor decoration](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
1004 1005 1006 1007 1008 1009 1010
	export interface DecorationRenderOptions extends ThemableDecorationRenderOptions {
		/**
		 * Should the decoration be rendered also on the whitespace after the line text.
		 * Defaults to `false`.
		 */
		isWholeLine?: boolean;

1011
		/**
1012 1013
		 * Customize the growing behavior of the decoration when edits occur at the edges of the decoration's range.
		 * Defaults to `DecorationRangeBehavior.OpenOpen`.
1014
		 */
1015
		rangeBehavior?: DecorationRangeBehavior;
1016

E
Erich Gamma 已提交
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
		/**
		 * 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 已提交
1033 1034 1035
	/**
	 * Represents options for a specific decoration in a [decoration set](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
1036 1037 1038
	export interface DecorationOptions {

		/**
1039
		 * Range to which this decoration is applied. The range must not be empty.
E
Erich Gamma 已提交
1040 1041 1042 1043 1044 1045
		 */
		range: Range;

		/**
		 * A message that should be rendered when hovering over the decoration.
		 */
1046
		hoverMessage?: MarkedString | MarkedString[];
M
Martin Aeschlimann 已提交
1047 1048 1049

		/**
		 * Render options applied to the current decoration. For performance reasons, keep the
1050
		 * number of decoration specific options small, and use decoration types wherever possible.
M
Martin Aeschlimann 已提交
1051 1052 1053 1054 1055 1056
		 */
		renderOptions?: DecorationInstanceRenderOptions;
	}

	export interface ThemableDecorationInstanceRenderOptions {
		/**
1057
		 * Defines the rendering options of the attachment that is inserted before the decorated text.
M
Martin Aeschlimann 已提交
1058
		 */
1059
		before?: ThemableDecorationAttachmentRenderOptions;
M
Martin Aeschlimann 已提交
1060 1061

		/**
1062
		 * Defines the rendering options of the attachment that is inserted after the decorated text.
M
Martin Aeschlimann 已提交
1063
		 */
1064
		after?: ThemableDecorationAttachmentRenderOptions;
M
Martin Aeschlimann 已提交
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
	}

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

		/**
		 * Overwrite options for dark themes.
		 */
J
Johannes Rieken 已提交
1076
		dark?: ThemableDecorationInstanceRenderOptions;
E
Erich Gamma 已提交
1077 1078
	}

A
Alex Dima 已提交
1079 1080 1081
	/**
	 * Represents an editor that is attached to a [document](#TextDocument).
	 */
E
Erich Gamma 已提交
1082 1083 1084 1085 1086
	export interface TextEditor {

		/**
		 * The document associated with this text editor. The document will be the same for the entire lifetime of this text editor.
		 */
A
Alex Dima 已提交
1087
		readonly document: TextDocument;
E
Erich Gamma 已提交
1088 1089

		/**
J
Johannes Rieken 已提交
1090
		 * The primary selection on this text editor. Shorthand for `TextEditor.selections[0]`.
E
Erich Gamma 已提交
1091 1092 1093 1094
		 */
		selection: Selection;

		/**
J
Johannes Rieken 已提交
1095
		 * The selections in this text editor. The primary selection is always at index 0.
E
Erich Gamma 已提交
1096 1097 1098
		 */
		selections: Selection[];

1099 1100 1101 1102 1103 1104
		/**
		 * The current visible ranges in the editor (vertically).
		 * This accounts only for vertical scrolling, and not for horizontal scrolling.
		 */
		readonly visibleRanges: Range[];

E
Erich Gamma 已提交
1105 1106 1107 1108 1109
		/**
		 * Text editor options.
		 */
		options: TextEditorOptions;

1110 1111
		/**
		 * The column in which this editor shows. Will be `undefined` in case this
1112
		 * isn't one of the main editors, e.g. an embedded editor, or when the editor
B
Benjamin Pasero 已提交
1113
		 * column is larger than three.
1114
		 */
1115
		viewColumn?: ViewColumn;
1116

E
Erich Gamma 已提交
1117 1118
		/**
		 * Perform an edit on the document associated with this text editor.
J
Johannes Rieken 已提交
1119 1120
		 *
		 * The given callback-function is invoked with an [edit-builder](#TextEditorEdit) which must
A
Andre Weinand 已提交
1121
		 * be used to make edits. Note that the edit-builder is only valid while the
J
Johannes Rieken 已提交
1122 1123
		 * callback executes.
		 *
1124
		 * @param callback A function which can create edits using an [edit-builder](#TextEditorEdit).
1125
		 * @param options The undo/redo behavior around this edit. By default, undo stops will be created before and after this edit.
A
Alex Dima 已提交
1126
		 * @return A promise that resolves with a value indicating if the edits could be applied.
E
Erich Gamma 已提交
1127
		 */
J
Johannes Rieken 已提交
1128
		edit(callback: (editBuilder: TextEditorEdit) => void, options?: { undoStopBefore: boolean; undoStopAfter: boolean; }): Thenable<boolean>;
E
Erich Gamma 已提交
1129

J
Joel Day 已提交
1130
		/**
J
Johannes Rieken 已提交
1131
		 * Insert a [snippet](#SnippetString) and put the editor into snippet mode. "Snippet mode"
1132
		 * means the editor adds placeholders and additional cursors so that the user can complete
J
Johannes Rieken 已提交
1133
		 * or accept the snippet.
J
Joel Day 已提交
1134
		 *
1135
		 * @param snippet The snippet to insert in this edit.
J
Johannes Rieken 已提交
1136
		 * @param location Position or range at which to insert the snippet, defaults to the current editor selection or selections.
1137
		 * @param options The undo/redo behavior around this edit. By default, undo stops will be created before and after this edit.
J
Johannes Rieken 已提交
1138 1139
		 * @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 已提交
1140
		 */
M
Matt Bierner 已提交
1141
		insertSnippet(snippet: SnippetString, location?: Position | Range | ReadonlyArray<Position> | ReadonlyArray<Range>, options?: { undoStopBefore: boolean; undoStopAfter: boolean; }): Thenable<boolean>;
E
Erich Gamma 已提交
1142 1143

		/**
J
Johannes Rieken 已提交
1144 1145 1146
		 * 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 已提交
1147
		 * @see [createTextEditorDecorationType](#window.createTextEditorDecorationType).
A
Alex Dima 已提交
1148
		 *
J
Johannes Rieken 已提交
1149 1150
		 * @param decorationType A decoration type.
		 * @param rangesOrOptions Either [ranges](#Range) or more detailed [options](#DecorationOptions).
E
Erich Gamma 已提交
1151
		 */
J
Johannes Rieken 已提交
1152
		setDecorations(decorationType: TextEditorDecorationType, rangesOrOptions: Range[] | DecorationOptions[]): void;
E
Erich Gamma 已提交
1153 1154

		/**
A
Alex Dima 已提交
1155 1156 1157 1158
		 * 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 已提交
1159 1160 1161 1162
		 */
		revealRange(range: Range, revealType?: TextEditorRevealType): void;

		/**
1163
		 * ~~Show the text editor.~~
J
Johannes Rieken 已提交
1164
		 *
B
Benjamin Pasero 已提交
1165
		 * @deprecated Use [window.showTextDocument](#window.showTextDocument) instead.
E
Erich Gamma 已提交
1166
		 *
J
Johannes Rieken 已提交
1167
		 * @param column The [column](#ViewColumn) in which to show this editor.
B
Benjamin Pasero 已提交
1168
		 * This method shows unexpected behavior and will be removed in the next major update.
E
Erich Gamma 已提交
1169 1170 1171 1172
		 */
		show(column?: ViewColumn): void;

		/**
1173
		 * ~~Hide the text editor.~~
J
Johannes Rieken 已提交
1174
		 *
1175
		 * @deprecated Use the command `workbench.action.closeActiveEditor` instead.
S
Steven Clarke 已提交
1176
		 * This method shows unexpected behavior and will be removed in the next major update.
E
Erich Gamma 已提交
1177 1178 1179 1180
		 */
		hide(): void;
	}

1181
	/**
1182
	 * Represents an end of line character sequence in a [document](#TextDocument).
1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194
	 */
	export enum EndOfLine {
		/**
		 * The line feed `\n` character.
		 */
		LF = 1,
		/**
		 * The carriage return line feed `\r\n` sequence.
		 */
		CRLF = 2
	}

E
Erich Gamma 已提交
1195
	/**
A
Alex Dima 已提交
1196 1197
	 * 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.)
1198
	 * they can be applied on a [document](#TextDocument) associated with a [text editor](#TextEditor).
E
Erich Gamma 已提交
1199 1200 1201
	 */
	export interface TextEditorEdit {
		/**
A
Alex Dima 已提交
1202
		 * Replace a certain text region with a new value.
1203
		 * You can use \r\n or \n in `value` and they will be normalized to the current [document](#TextDocument).
A
Alex Dima 已提交
1204 1205 1206
		 *
		 * @param location The range this operation should remove.
		 * @param value The new text this operation should insert after removing `location`.
E
Erich Gamma 已提交
1207 1208 1209 1210
		 */
		replace(location: Position | Range | Selection, value: string): void;

		/**
A
Alex Dima 已提交
1211
		 * Insert text at a location.
1212
		 * You can use \r\n or \n in `value` and they will be normalized to the current [document](#TextDocument).
A
Alex Dima 已提交
1213 1214 1215 1216
		 * 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 已提交
1217 1218 1219 1220 1221
		 */
		insert(location: Position, value: string): void;

		/**
		 * Delete a certain text region.
A
Alex Dima 已提交
1222 1223
		 *
		 * @param location The range this operation should remove.
E
Erich Gamma 已提交
1224 1225
		 */
		delete(location: Range | Selection): void;
1226 1227 1228 1229

		/**
		 * Set the end of line sequence.
		 *
1230
		 * @param endOfLine The new end of line for the [document](#TextDocument).
1231
		 */
A
Format  
Alex Dima 已提交
1232
		setEndOfLine(endOfLine: EndOfLine): void;
E
Erich Gamma 已提交
1233 1234 1235
	}

	/**
S
Steven Clarke 已提交
1236
	 * A universal resource identifier representing either a file on disk
J
Johannes Rieken 已提交
1237
	 * or another resource, like untitled resources.
E
Erich Gamma 已提交
1238 1239 1240 1241
	 */
	export class Uri {

		/**
J
Johannes Rieken 已提交
1242 1243
		 * Create an URI from a string, e.g. `http://www.msft.com/some/path`,
		 * `file:///usr/home`, or `scheme:with/path`.
J
Johannes Rieken 已提交
1244
		 *
1245
		 * *Note* that for a while uris without a `scheme` were accepted. That is not correct
1246 1247
		 * as all uris should have a scheme. To avoid breakage of existing code the optional
		 * `strict`-argument has been added. We *strongly* advise to use it, e.g. `Uri.parse('my:uri', true)`
1248
		 *
J
Johannes Rieken 已提交
1249 1250
		 * @see [Uri.toString](#Uri.toString)
		 * @param value The string value of an Uri.
1251
		 * @param strict Throw an error when `value` is empty or when no `scheme` can be parsed.
J
Johannes Rieken 已提交
1252
		 * @return A new Uri instance.
E
Erich Gamma 已提交
1253
		 */
1254
		static parse(value: string, strict?: boolean): Uri;
E
Erich Gamma 已提交
1255 1256

		/**
J
Johannes Rieken 已提交
1257 1258
		 * Create an URI from a file system path. The [scheme](#Uri.scheme)
		 * will be `file`.
E
Erich Gamma 已提交
1259
		 *
J
Johannes Rieken 已提交
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276
		 * The *difference* between `Uri#parse` and `Uri#file` is that the latter treats the argument
		 * as path, not as stringified-uri. E.g. `Uri.file(path)` is *not* the same as
		 * `Uri.parse('file://' + path)` because the path might contain characters that are
		 * interpreted (# and ?). See the following sample:
		 * ```ts
		const good = URI.file('/coding/c#/project1');
		good.scheme === 'file';
		good.path === '/coding/c#/project1';
		good.fragment === '';

		const bad = URI.parse('file://' + '/coding/c#/project1');
		bad.scheme === 'file';
		bad.path === '/coding/c'; // path is now broken
		bad.fragment === '/project1';
		```
		 *
		 * @param path A file system or UNC path.
J
Johannes Rieken 已提交
1277
		 * @return A new Uri instance.
E
Erich Gamma 已提交
1278
		 */
J
Johannes Rieken 已提交
1279
		static file(path: string): Uri;
E
Erich Gamma 已提交
1280

1281 1282 1283 1284 1285
		/**
		 * 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 已提交
1286
		/**
J
Johannes Rieken 已提交
1287
		 * Scheme is the `http` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1288 1289
		 * The part before the first colon.
		 */
J
Johannes Rieken 已提交
1290
		readonly scheme: string;
E
Erich Gamma 已提交
1291 1292

		/**
J
Johannes Rieken 已提交
1293
		 * Authority is the `www.msft.com` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1294 1295
		 * The part between the first double slashes and the next slash.
		 */
J
Johannes Rieken 已提交
1296
		readonly authority: string;
E
Erich Gamma 已提交
1297 1298

		/**
J
Johannes Rieken 已提交
1299
		 * Path is the `/some/path` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1300
		 */
J
Johannes Rieken 已提交
1301
		readonly path: string;
E
Erich Gamma 已提交
1302 1303

		/**
J
Johannes Rieken 已提交
1304
		 * Query is the `query` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1305
		 */
J
Johannes Rieken 已提交
1306
		readonly query: string;
E
Erich Gamma 已提交
1307 1308

		/**
J
Johannes Rieken 已提交
1309
		 * Fragment is the `fragment` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1310
		 */
J
Johannes Rieken 已提交
1311
		readonly fragment: string;
E
Erich Gamma 已提交
1312 1313

		/**
1314
		 * The string representing the corresponding file system path of this Uri.
J
Johannes Rieken 已提交
1315
		 *
E
Erich Gamma 已提交
1316
		 * Will handle UNC paths and normalize windows drive letters to lower-case. Also
J
Johannes Rieken 已提交
1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
		 * uses the platform specific path separator.
		 *
		 * * Will *not* validate the path for invalid characters and semantics.
		 * * Will *not* look at the scheme of this Uri.
		 * * The resulting string shall *not* be used for display purposes but
		 * for disk operations, like `readFile` et al.
		 *
		 * The *difference* to the [`path`](#Uri.path)-property is the use of the platform specific
		 * path separator and the handling of UNC paths. The sample below outlines the difference:
		 * ```ts
		const u = URI.parse('file://server/c$/folder/file.txt')
		u.authority === 'server'
		u.path === '/shares/c$/file.txt'
		u.fsPath === '\\server\c$\folder\file.txt'
		```
E
Erich Gamma 已提交
1332
		 */
J
Johannes Rieken 已提交
1333
		readonly fsPath: string;
E
Erich Gamma 已提交
1334

1335 1336 1337
		/**
		 * Derive a new Uri from this Uri.
		 *
1338 1339 1340 1341 1342 1343
		 * ```ts
		 * let file = Uri.parse('before:some/file/path');
		 * let other = file.with({ scheme: 'after' });
		 * assert.ok(other.toString() === 'after:some/file/path');
		 * ```
		 *
1344 1345
		 * @param change An object that describes a change to this Uri. To unset components use `null` or
		 *  the empty string.
1346
		 * @return A new Uri that reflects the given change. Will return `this` Uri if the change
1347 1348 1349 1350
		 *  is not changing anything.
		 */
		with(change: { scheme?: string; authority?: string; path?: string; query?: string; fragment?: string }): Uri;

E
Erich Gamma 已提交
1351
		/**
1352
		 * Returns a string representation of this Uri. The representation and normalization
J
Johannes Rieken 已提交
1353 1354 1355 1356
		 * of a URI depends on the scheme.
		 *
		 * * The resulting string can be safely used with [Uri.parse](#Uri.parse).
		 * * The resulting string shall *not* be used for display purposes.
J
Johannes Rieken 已提交
1357
		 *
1358 1359 1360 1361 1362 1363
		 * *Note* that the implementation will encode _aggressive_ which often leads to unexpected,
		 * but not incorrect, results. For instance, colons are encoded to `%3A` which might be unexpected
		 * in file-uri. Also `&` and `=` will be encoded which might be unexpected for http-uris. For stability
		 * reasons this cannot be changed anymore. If you suffer from too aggressive encoding you should use
		 * the `skipEncoding`-argument: `uri.toString(true)`.
		 *
1364
		 * @param skipEncoding Do not percentage-encode the result, defaults to `false`. Note that
1365
		 *	the `#` and `?` characters occurring in the path will always be encoded.
1366
		 * @returns A string representation of this Uri.
E
Erich Gamma 已提交
1367
		 */
1368
		toString(skipEncoding?: boolean): string;
E
Erich Gamma 已提交
1369

J
Johannes Rieken 已提交
1370 1371 1372 1373 1374
		/**
		 * Returns a JSON representation of this Uri.
		 *
		 * @return An object.
		 */
E
Erich Gamma 已提交
1375 1376 1377 1378
		toJSON(): any;
	}

	/**
S
Steven Clarke 已提交
1379
	 * A cancellation token is passed to an asynchronous or long running
E
Erich Gamma 已提交
1380 1381
	 * operation to request cancellation, like cancelling a request
	 * for completion items because the user continued to type.
1382 1383 1384
	 *
	 * To get an instance of a `CancellationToken` use a
	 * [CancellationTokenSource](#CancellationTokenSource).
E
Erich Gamma 已提交
1385 1386 1387 1388
	 */
	export interface CancellationToken {

		/**
J
Johannes Rieken 已提交
1389
		 * Is `true` when the token has been cancelled, `false` otherwise.
E
Erich Gamma 已提交
1390 1391 1392 1393
		 */
		isCancellationRequested: boolean;

		/**
J
Johannes Rieken 已提交
1394
		 * An [event](#Event) which fires upon cancellation.
E
Erich Gamma 已提交
1395 1396 1397 1398 1399
		 */
		onCancellationRequested: Event<any>;
	}

	/**
J
Johannes Rieken 已提交
1400
	 * A cancellation source creates and controls a [cancellation token](#CancellationToken).
E
Erich Gamma 已提交
1401 1402 1403 1404
	 */
	export class CancellationTokenSource {

		/**
J
Johannes Rieken 已提交
1405
		 * The cancellation token of this source.
E
Erich Gamma 已提交
1406 1407 1408 1409 1410 1411 1412 1413 1414
		 */
		token: CancellationToken;

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

		/**
1415
		 * Dispose object and free resources.
E
Erich Gamma 已提交
1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430
		 */
		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 已提交
1431
		 * @param disposableLikes Objects that have at least a `dispose`-function member.
E
Erich Gamma 已提交
1432 1433 1434 1435 1436 1437 1438 1439
		 * @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 已提交
1440
		 * @param callOnDispose Function that disposes something.
E
Erich Gamma 已提交
1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451
		 */
		constructor(callOnDispose: Function);

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

	/**
	 * Represents a typed event.
J
Johannes Rieken 已提交
1452 1453 1454 1455 1456
	 *
	 * 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 已提交
1457 1458 1459 1460
	 */
	export interface Event<T> {

		/**
J
Johannes Rieken 已提交
1461 1462
		 * A function that represents an event to which you subscribe by calling it with
		 * a listener function as argument.
E
Erich Gamma 已提交
1463 1464
		 *
		 * @param listener The listener function will be called when the event happens.
J
Johannes Rieken 已提交
1465
		 * @param thisArgs The `this`-argument which will be used when calling the event listener.
D
Daniel Imms 已提交
1466
		 * @param disposables An array to which a [disposable](#Disposable) will be added.
A
Andre Weinand 已提交
1467
		 * @return A disposable which unsubscribes the event listener.
E
Erich Gamma 已提交
1468 1469 1470 1471
		 */
		(listener: (e: T) => any, thisArgs?: any, disposables?: Disposable[]): Disposable;
	}

1472 1473 1474 1475 1476
	/**
	 * 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 已提交
1477
	 * inside a [TextDocumentContentProvider](#TextDocumentContentProvider) or when providing
1478 1479 1480 1481 1482 1483 1484 1485 1486 1487
	 * API to other extensions.
	 */
	export class EventEmitter<T> {

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

		/**
M
Matthew J. Clemente 已提交
1488
		 * Notify all subscribers of the [event](#EventEmitter.event). Failure
1489 1490 1491 1492
		 * of one or more listener will not fail this function call.
		 *
		 * @param data The event object.
		 */
1493
		fire(data: T): void;
1494 1495 1496 1497 1498 1499 1500

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

E
Erich Gamma 已提交
1501 1502
	/**
	 * A file system watcher notifies about changes to files and folders
J
Johannes Rieken 已提交
1503
	 * on disk or from other [FileSystemProviders](#FileSystemProvider).
J
Johannes Rieken 已提交
1504 1505
	 *
	 * To get an instance of a `FileSystemWatcher` use
J
Johannes Rieken 已提交
1506
	 * [createFileSystemWatcher](#workspace.createFileSystemWatcher).
E
Erich Gamma 已提交
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525
	 */
	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 已提交
1526
		ignoreDeleteEvents: boolean;
E
Erich Gamma 已提交
1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543

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

1544 1545 1546 1547
	/**
	 * A text document content provider allows to add readonly documents
	 * to the editor, such as source from a dll or generated html from md.
	 *
1548
	 * Content providers are [registered](#workspace.registerTextDocumentContentProvider)
1549
	 * for a [uri-scheme](#Uri.scheme). When a uri with that scheme is to
1550
	 * be [loaded](#workspace.openTextDocument) the content provider is
1551 1552
	 * asked.
	 */
J
Johannes Rieken 已提交
1553 1554
	export interface TextDocumentContentProvider {

1555 1556 1557 1558
		/**
		 * An event to signal a resource has changed.
		 */
		onDidChange?: Event<Uri>;
J
Johannes Rieken 已提交
1559

1560
		/**
1561
		 * Provide textual content for a given uri.
1562
		 *
1563
		 * The editor will use the returned string-content to create a readonly
J
Johannes Rieken 已提交
1564
		 * [document](#TextDocument). Resources allocated should be released when
1565
		 * the corresponding document has been [closed](#workspace.onDidCloseTextDocument).
1566
		 *
1567 1568 1569
		 * **Note**: The contents of the created [document](#TextDocument) might not be
		 * identical to the provided text due to end-of-line-sequence normalization.
		 *
1570 1571 1572
		 * @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.
1573
		 */
1574
		provideTextDocumentContent(uri: Uri, token: CancellationToken): ProviderResult<string>;
J
Johannes Rieken 已提交
1575 1576
	}

E
Erich Gamma 已提交
1577 1578
	/**
	 * Represents an item that can be selected from
A
Andre Weinand 已提交
1579
	 * a list of items.
E
Erich Gamma 已提交
1580 1581 1582 1583
	 */
	export interface QuickPickItem {

		/**
1584 1585
		 * A human-readable string which is rendered prominent. Supports rendering of [theme icons](#ThemeIcon) via
		 * the `$(<name>)`-syntax.
E
Erich Gamma 已提交
1586 1587 1588 1589
		 */
		label: string;

		/**
1590 1591
		 * A human-readable string which is rendered less prominent in the same line. Supports rendering of
		 * [theme icons](#ThemeIcon) via the `$(<name>)`-syntax.
E
Erich Gamma 已提交
1592
		 */
1593
		description?: string;
J
Johannes Rieken 已提交
1594 1595

		/**
1596 1597
		 * A human-readable string which is rendered less prominent in a separate line. Supports rendering of
		 * [theme icons](#ThemeIcon) via the `$(<name>)`-syntax.
J
Johannes Rieken 已提交
1598 1599
		 */
		detail?: string;
C
Christof Marti 已提交
1600 1601

		/**
1602
		 * Optional flag indicating if this item is picked initially.
C
Christof Marti 已提交
1603 1604
		 * (Only honored when the picker allows multiple selections.)
		 *
1605
		 * @see [QuickPickOptions.canPickMany](#QuickPickOptions.canPickMany)
C
Christof Marti 已提交
1606
		 */
1607
		picked?: boolean;
1608 1609 1610 1611 1612

		/**
		 * Always show this item.
		 */
		alwaysShow?: boolean;
E
Erich Gamma 已提交
1613 1614 1615
	}

	/**
J
Johannes Rieken 已提交
1616
	 * Options to configure the behavior of the quick pick UI.
E
Erich Gamma 已提交
1617 1618 1619
	 */
	export interface QuickPickOptions {
		/**
J
Johannes Rieken 已提交
1620 1621
		 * An optional flag to include the description when filtering the picks.
		 */
E
Erich Gamma 已提交
1622 1623
		matchOnDescription?: boolean;

J
Johannes Rieken 已提交
1624 1625 1626 1627 1628
		/**
		 * An optional flag to include the detail when filtering the picks.
		 */
		matchOnDetail?: boolean;

E
Erich Gamma 已提交
1629
		/**
H
hannut91 已提交
1630
		 * An optional string to show as placeholder in the input box to guide the user what to pick on.
J
Johannes Rieken 已提交
1631
		 */
E
Erich Gamma 已提交
1632
		placeHolder?: string;
1633

1634 1635 1636 1637 1638
		/**
		 * Set to `true` to keep the picker open when focus moves to another part of the editor or to another window.
		 */
		ignoreFocusOut?: boolean;

C
Christof Marti 已提交
1639
		/**
C
Christof Marti 已提交
1640
		 * An optional flag to make the picker accept multiple selections, if true the result is an array of picks.
C
Christof Marti 已提交
1641
		 */
1642
		canPickMany?: boolean;
C
Christof Marti 已提交
1643

1644 1645 1646
		/**
		 * An optional function that is invoked whenever an item is selected.
		 */
A
Amadare42 已提交
1647
		onDidSelectItem?(item: QuickPickItem | string): any;
E
Erich Gamma 已提交
1648 1649
	}

1650 1651 1652 1653 1654 1655
	/**
	 * Options to configure the behaviour of the [workspace folder](#WorkspaceFolder) pick UI.
	 */
	export interface WorkspaceFolderPickOptions {

		/**
H
hannut91 已提交
1656
		 * An optional string to show as placeholder in the input box to guide the user what to pick on.
1657 1658 1659 1660 1661 1662 1663 1664 1665
		 */
		placeHolder?: string;

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

1666
	/**
J
Johannes Rieken 已提交
1667
	 * Options to configure the behaviour of a file open dialog.
1668 1669 1670
	 *
	 * * Note 1: A dialog can select files, folders, or both. This is not true for Windows
	 * which enforces to open either files or folder, but *not both*.
1671
	 * * Note 2: Explicitly setting `canSelectFiles` and `canSelectFolders` to `false` is futile
1672
	 * and the editor then silently adjusts the options to select files.
J
Johannes Rieken 已提交
1673
	 */
1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685
	export interface OpenDialogOptions {
		/**
		 * The resource the dialog shows when opened.
		 */
		defaultUri?: Uri;

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

		/**
1686
		 * Allow to select files, defaults to `true`.
1687
		 */
1688
		canSelectFiles?: boolean;
1689 1690

		/**
1691
		 * Allow to select folders, defaults to `false`.
1692
		 */
1693
		canSelectFolders?: boolean;
1694 1695 1696 1697

		/**
		 * Allow to select many files or folders.
		 */
1698
		canSelectMany?: boolean;
1699 1700

		/**
S
Sandeep Somavarapu 已提交
1701
		 * A set of file filters that are used by the dialog. Each entry is a human-readable label,
J
Johannes Rieken 已提交
1702
		 * like "TypeScript", and an array of extensions, e.g.
1703 1704
		 * ```ts
		 * {
J
Johannes Rieken 已提交
1705 1706
		 * 	'Images': ['png', 'jpg']
		 * 	'TypeScript': ['ts', 'tsx']
1707 1708 1709
		 * }
		 * ```
		 */
J
Johannes Rieken 已提交
1710
		filters?: { [name: string]: string[] };
1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727
	}

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

		/**
S
Sandeep Somavarapu 已提交
1728
		 * A set of file filters that are used by the dialog. Each entry is a human-readable label,
J
Johannes Rieken 已提交
1729
		 * like "TypeScript", and an array of extensions, e.g.
1730 1731
		 * ```ts
		 * {
J
Johannes Rieken 已提交
1732 1733
		 * 	'Images': ['png', 'jpg']
		 * 	'TypeScript': ['ts', 'tsx']
1734 1735 1736
		 * }
		 * ```
		 */
J
Johannes Rieken 已提交
1737
		filters?: { [name: string]: string[] };
1738 1739
	}

E
Erich Gamma 已提交
1740
	/**
J
Johannes Rieken 已提交
1741
	 * Represents an action that is shown with an information, warning, or
A
Andre Weinand 已提交
1742
	 * error message.
E
Erich Gamma 已提交
1743
	 *
S
Sofian Hnaide 已提交
1744 1745 1746
	 * @see [showInformationMessage](#window.showInformationMessage)
	 * @see [showWarningMessage](#window.showWarningMessage)
	 * @see [showErrorMessage](#window.showErrorMessage)
E
Erich Gamma 已提交
1747 1748 1749 1750
	 */
	export interface MessageItem {

		/**
A
Andre Weinand 已提交
1751
		 * A short title like 'Retry', 'Open Log' etc.
E
Erich Gamma 已提交
1752 1753
		 */
		title: string;
1754 1755

		/**
1756 1757 1758 1759 1760
		 * A hint for modal dialogs that the item should be triggered
		 * when the user cancels the dialog (e.g. by pressing the ESC
		 * key).
		 *
		 * Note: this option is ignored for non-modal messages.
1761 1762
		 */
		isCloseAffordance?: boolean;
E
Erich Gamma 已提交
1763 1764
	}

J
Joao Moreno 已提交
1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779
	/**
	 * 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 已提交
1780
	/**
J
Johannes Rieken 已提交
1781
	 * Options to configure the behavior of the input box UI.
E
Erich Gamma 已提交
1782 1783
	 */
	export interface InputBoxOptions {
J
Johannes Rieken 已提交
1784

E
Erich Gamma 已提交
1785
		/**
J
Johannes Rieken 已提交
1786 1787
		 * The value to prefill in the input box.
		 */
E
Erich Gamma 已提交
1788 1789
		value?: string;

1790
		/**
1791 1792 1793 1794
		 * 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.
1795
		 */
1796
		valueSelection?: [number, number];
1797

E
Erich Gamma 已提交
1798
		/**
J
Johannes Rieken 已提交
1799 1800
		 * The text to display underneath the input box.
		 */
E
Erich Gamma 已提交
1801 1802 1803
		prompt?: string;

		/**
H
hannut91 已提交
1804
		 * An optional string to show as placeholder in the input box to guide the user what to type.
J
Johannes Rieken 已提交
1805
		 */
E
Erich Gamma 已提交
1806 1807 1808
		placeHolder?: string;

		/**
1809
		 * Controls if a password input is shown. Password input hides the typed text.
J
Johannes Rieken 已提交
1810
		 */
E
Erich Gamma 已提交
1811
		password?: boolean;
1812

1813 1814 1815 1816 1817
		/**
		 * Set to `true` to keep the input box open when focus moves to another part of the editor or to another window.
		 */
		ignoreFocusOut?: boolean;

1818
		/**
P
Pine 已提交
1819
		 * An optional function that will be called to validate input and to give a hint
1820 1821 1822
		 * to the user.
		 *
		 * @param value The current value of the input box.
S
Sandeep Somavarapu 已提交
1823
		 * @return A human-readable string which is presented as diagnostic message.
1824 1825
		 * Return `undefined`, `null`, or the empty string when 'value' is valid.
		 */
1826
		validateInput?(value: string): string | undefined | null | Thenable<string | undefined | null>;
E
Erich Gamma 已提交
1827 1828
	}

B
Benjamin Pasero 已提交
1829 1830 1831 1832 1833
	/**
	 * 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).
	 */
1834
	export class RelativePattern {
1835 1836

		/**
B
Benjamin Pasero 已提交
1837
		 * A base file path to which this pattern will be matched against relatively.
1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849
		 */
		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 已提交
1850
		/**
B
Benjamin Pasero 已提交
1851 1852
		 * 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 已提交
1853
		 *
B
Benjamin Pasero 已提交
1854
		 * @param base A base file path to which this pattern will be matched against relatively.
B
Benjamin Pasero 已提交
1855 1856 1857
		 * @param pattern A file glob pattern like `*.{ts,js}` that will be matched on file paths
		 * relative to the base path.
		 */
1858
		constructor(base: WorkspaceFolder | string, pattern: string)
1859 1860 1861 1862
	}

	/**
	 * A file glob pattern to match file paths against. This can either be a glob pattern string
1863
	 * (like `**​/*.{ts,js}` or `*.{ts,js}`) or a [relative pattern](#RelativePattern).
B
Benjamin Pasero 已提交
1864 1865 1866 1867 1868
	 *
	 * Glob patterns can have the following syntax:
	 * * `*` to match one or more characters in a path segment
	 * * `?` to match on one character in a path segment
	 * * `**` to match any number of path segments, including none
1869
	 * * `{}` to group conditions (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)
B
Benjamin Pasero 已提交
1870 1871
	 * * `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
	 * * `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
1872 1873 1874 1875 1876
	 *
	 * Note: a backslash (`\`) is not valid within a glob pattern. If you have an existing file
	 * path to match against, consider to use the [relative pattern](#RelativePattern) support
	 * that takes care of converting any backslash into slash. Otherwise, make sure to convert
	 * any backslash to slash when creating the glob pattern.
1877 1878 1879
	 */
	export type GlobPattern = string | RelativePattern;

E
Erich Gamma 已提交
1880 1881
	/**
	 * A document filter denotes a document by different properties like
A
Alex Dima 已提交
1882
	 * the [language](#TextDocument.languageId), the [scheme](#Uri.scheme) of
A
Andre Weinand 已提交
1883
	 * its resource, or a glob-pattern that is applied to the [path](#TextDocument.fileName).
E
Erich Gamma 已提交
1884
	 *
J
Johannes Rieken 已提交
1885
	 * @sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
1886
	 * @sample A language filter that applies to all package.json paths: `{ language: 'json', scheme: 'untitled', pattern: '**​/package.json' }`
E
Erich Gamma 已提交
1887 1888 1889 1890 1891 1892 1893 1894 1895
	 */
	export interface DocumentFilter {

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

		/**
J
Johannes Rieken 已提交
1896
		 * A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
E
Erich Gamma 已提交
1897 1898 1899 1900
		 */
		scheme?: string;

		/**
B
Benjamin Pasero 已提交
1901 1902
		 * 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 已提交
1903
		 */
1904
		pattern?: GlobPattern;
E
Erich Gamma 已提交
1905 1906 1907 1908
	}

	/**
	 * A language selector is the combination of one or many language identifiers
1909
	 * and [language filters](#DocumentFilter).
J
Johannes Rieken 已提交
1910
	 *
1911 1912
	 * *Note* that a document selector that is just a language identifier selects *all*
	 * documents, even those that are not saved on disk. Only use such selectors when
1913
	 * a feature works without further context, e.g. without the need to resolve related
1914 1915 1916
	 * 'files'.
	 *
	 * @sample `let sel:DocumentSelector = { scheme: 'file', language: 'typescript' }`;
E
Erich Gamma 已提交
1917
	 */
1918
	export type DocumentSelector = DocumentFilter | string | Array<DocumentFilter | string>;
E
Erich Gamma 已提交
1919

1920 1921 1922 1923 1924 1925
	/**
	 * 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.
	 *
1926
	 * The snippets below are all valid implementations of the [`HoverProvider`](#HoverProvider):
1927 1928
	 *
	 * ```ts
1929 1930 1931 1932 1933
	 * let a: HoverProvider = {
	 * 	provideHover(doc, pos, token): ProviderResult<Hover> {
	 * 		return new Hover('Hello World');
	 * 	}
	 * }
1934
	 *
1935 1936 1937 1938 1939 1940 1941
	 * let b: HoverProvider = {
	 * 	provideHover(doc, pos, token): ProviderResult<Hover> {
	 * 		return new Promise(resolve => {
	 * 			resolve(new Hover('Hello World'));
	 * 	 	});
	 * 	}
	 * }
1942
	 *
1943 1944 1945 1946 1947 1948
	 * let c: HoverProvider = {
	 * 	provideHover(doc, pos, token): ProviderResult<Hover> {
	 * 		return; // undefined
	 * 	}
	 * }
	 * ```
1949
	 */
J
Johannes Rieken 已提交
1950
	export type ProviderResult<T> = T | undefined | null | Thenable<T | undefined | null>;
1951

M
Matt Bierner 已提交
1952 1953 1954 1955
	/**
	 * Kind of a code action.
	 *
	 * Kinds are a hierarchical list of identifiers separated by `.`, e.g. `"refactor.extract.function"`.
M
Matt Bierner 已提交
1956 1957 1958
	 *
	 * Code action kinds are used by VS Code for UI elements such as the refactoring context menu. Users
	 * can also trigger code actions with a specific kind with the `editor.action.codeAction` command.
M
Matt Bierner 已提交
1959 1960 1961 1962 1963 1964 1965 1966
	 */
	export class CodeActionKind {
		/**
		 * Empty kind.
		 */
		static readonly Empty: CodeActionKind;

		/**
M
Matt Bierner 已提交
1967 1968 1969
		 * Base kind for quickfix actions: `quickfix`.
		 *
		 * Quick fix actions address a problem in the code and are shown in the normal code action context menu.
M
Matt Bierner 已提交
1970 1971 1972 1973
		 */
		static readonly QuickFix: CodeActionKind;

		/**
1974
		 * Base kind for refactoring actions: `refactor`
M
Matt Bierner 已提交
1975 1976
		 *
		 * Refactoring actions are shown in the refactoring context menu.
M
Matt Bierner 已提交
1977 1978 1979 1980
		 */
		static readonly Refactor: CodeActionKind;

		/**
1981
		 * Base kind for refactoring extraction actions: `refactor.extract`
1982 1983 1984 1985 1986 1987 1988 1989
		 *
		 * Example extract actions:
		 *
		 * - Extract method
		 * - Extract function
		 * - Extract variable
		 * - Extract interface from class
		 * - ...
M
Matt Bierner 已提交
1990 1991 1992 1993
		 */
		static readonly RefactorExtract: CodeActionKind;

		/**
1994
		 * Base kind for refactoring inline actions: `refactor.inline`
1995 1996 1997 1998 1999 2000 2001
		 *
		 * Example inline actions:
		 *
		 * - Inline function
		 * - Inline variable
		 * - Inline constant
		 * - ...
M
Matt Bierner 已提交
2002 2003 2004 2005
		 */
		static readonly RefactorInline: CodeActionKind;

		/**
2006
		 * Base kind for refactoring rewrite actions: `refactor.rewrite`
2007 2008 2009 2010 2011 2012 2013 2014 2015
		 *
		 * Example rewrite actions:
		 *
		 * - Convert JavaScript function to class
		 * - Add or remove parameter
		 * - Encapsulate field
		 * - Make method static
		 * - Move method to base class
		 * - ...
M
Matt Bierner 已提交
2016 2017 2018
		 */
		static readonly RefactorRewrite: CodeActionKind;

M
Matt Bierner 已提交
2019
		/**
2020
		 * Base kind for source actions: `source`
M
Matt Bierner 已提交
2021
		 *
M
Wording  
Matt Bierner 已提交
2022
		 * Source code actions apply to the entire file. They must be explicitly requested and will not show in the
2023
		 * normal [lightbulb](https://code.visualstudio.com/docs/editor/editingevolved#_code-action) menu. Source actions
M
Wording  
Matt Bierner 已提交
2024
		 * can be run on save using `editor.codeActionsOnSave` and are also shown in the `source` context menu.
M
Matt Bierner 已提交
2025 2026 2027
		 */
		static readonly Source: CodeActionKind;

2028
		/**
M
Matt Bierner 已提交
2029
		 * Base kind for an organize imports source action: `source.organizeImports`.
2030 2031 2032
		 */
		static readonly SourceOrganizeImports: CodeActionKind;

2033 2034 2035 2036 2037 2038 2039 2040
		/**
		 * Base kind for auto-fix source actions: `source.fixAll`.
		 *
		 * Fix all actions automatically fix errors that have a clear fix that do not require user input.
		 * They should not suppress errors or perform unsafe fixes such as generating new types or classes.
		 */
		static readonly SourceFixAll: CodeActionKind;

M
Matt Bierner 已提交
2041 2042 2043 2044 2045
		private constructor(value: string);

		/**
		 * String value of the kind, e.g. `"refactor.extract.function"`.
		 */
2046
		readonly value: string;
M
Matt Bierner 已提交
2047 2048 2049 2050 2051 2052 2053 2054 2055

		/**
		 * Create a new kind by appending a more specific selector to the current kind.
		 *
		 * Does not modify the current kind.
		 */
		append(parts: string): CodeActionKind;

		/**
M
Matt Bierner 已提交
2056
		 * Checks if this code action kind intersects `other`.
M
Matt Bierner 已提交
2057
		 *
M
Matt Bierner 已提交
2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069
		 * The kind `"refactor.extract"` for example intersects `refactor`, `"refactor.extract"` and ``"refactor.extract.function"`,
		 * but not `"unicorn.refactor.extract"`, or `"refactor.extractAll"`.
		 *
		 * @param other Kind to check.
		 */
		intersects(other: CodeActionKind): boolean;

		/**
		 * Checks if `other` is a sub-kind of this `CodeActionKind`.
		 *
		 * The kind `"refactor.extract"` for example contains `"refactor.extract"` and ``"refactor.extract.function"`,
		 * but not `"unicorn.refactor.extract"`, or `"refactor.extractAll"` or `refactor`.
M
Matt Bierner 已提交
2070 2071 2072 2073 2074 2075
		 *
		 * @param other Kind to check.
		 */
		contains(other: CodeActionKind): boolean;
	}

E
Erich Gamma 已提交
2076 2077
	/**
	 * Contains additional diagnostic information about the context in which
J
Johannes Rieken 已提交
2078
	 * a [code action](#CodeActionProvider.provideCodeActions) is run.
E
Erich Gamma 已提交
2079 2080
	 */
	export interface CodeActionContext {
J
Johannes Rieken 已提交
2081 2082 2083
		/**
		 * An array of diagnostics.
		 */
2084
		readonly diagnostics: ReadonlyArray<Diagnostic>;
M
Matt Bierner 已提交
2085 2086 2087 2088

		/**
		 * Requested kind of actions to return.
		 *
2089
		 * Actions not of this kind are filtered out before being shown by the [lightbulb](https://code.visualstudio.com/docs/editor/editingevolved#_code-action).
M
Matt Bierner 已提交
2090 2091
		 */
		readonly only?: CodeActionKind;
E
Erich Gamma 已提交
2092 2093
	}

2094 2095 2096
	/**
	 * A code action represents a change that can be performed in code, e.g. to fix a problem or
	 * to refactor code.
2097
	 *
M
Matthew J. Clemente 已提交
2098
	 * A CodeAction must set either [`edit`](#CodeAction.edit) and/or a [`command`](#CodeAction.command). If both are supplied, the `edit` is applied first, then the command is executed.
2099 2100 2101 2102
	 */
	export class CodeAction {

		/**
2103
		 * A short, human-readable, title for this code action.
2104 2105 2106 2107
		 */
		title: string;

		/**
2108
		 * A [workspace edit](#WorkspaceEdit) this code action performs.
2109 2110 2111 2112
		 */
		edit?: WorkspaceEdit;

		/**
2113
		 * [Diagnostics](#Diagnostic) that this code action resolves.
2114 2115 2116 2117
		 */
		diagnostics?: Diagnostic[];

		/**
2118
		 * A [command](#Command) this code action executes.
2119 2120 2121
		 *
		 * If this command throws an exception, VS Code displays the exception message to users in the editor at the
		 * current cursor position.
2122 2123 2124
		 */
		command?: Command;

M
Matt Bierner 已提交
2125
		/**
2126
		 * [Kind](#CodeActionKind) of the code action.
M
Matt Bierner 已提交
2127 2128 2129
		 *
		 * Used to filter code actions.
		 */
2130
		kind?: CodeActionKind;
M
Matt Bierner 已提交
2131

M
Matt Bierner 已提交
2132 2133 2134 2135 2136 2137 2138 2139 2140
		/**
		 * Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted
		 * by keybindings.
		 *
		 * A quick fix should be marked preferred if it properly addresses the underlying error.
		 * A refactoring should be marked preferred if it is the most reasonable choice of actions to take.
		 */
		isPreferred?: boolean;

M
Matt Bierner 已提交
2141 2142 2143
		/**
		 * Marks that the code action cannot currently be applied.
		 *
2144 2145 2146 2147 2148 2149 2150
		 * - Disabled code actions are not shown in automatic [lightbulb](https://code.visualstudio.com/docs/editor/editingevolved#_code-action)
		 * code action menu.
		 *
		 * - Disabled actions are shown as faded out in the code action menu when the user request a more specific type
		 * of code action, such as refactorings.
		 *
		 * - If the user has a [keybinding](https://code.visualstudio.com/docs/editor/refactoring#_keybindings-for-code-actions)
2151 2152
		 * that auto applies a code action and only a disabled code actions are returned, VS Code will show the user an
		 * error message with `reason` in the editor.
M
Matt Bierner 已提交
2153 2154 2155 2156 2157 2158 2159 2160 2161 2162
		 */
		disabled?: {
			/**
			 * Human readable description of why the code action is currently disabled.
			 *
			 * This is displayed in the code actions UI.
			 */
			readonly reason: string;
		};

2163 2164 2165
		/**
		 * Creates a new code action.
		 *
2166 2167
		 * A code action must have at least a [title](#CodeAction.title) and [edits](#CodeAction.edit)
		 * and/or a [command](#CodeAction.command).
2168 2169
		 *
		 * @param title The title of the code action.
2170
		 * @param kind The kind of the code action.
2171
		 */
2172
		constructor(title: string, kind?: CodeActionKind);
2173 2174
	}

E
Erich Gamma 已提交
2175
	/**
J
Johannes Rieken 已提交
2176
	 * The code action interface defines the contract between extensions and
2177
	 * the [lightbulb](https://code.visualstudio.com/docs/editor/editingevolved#_code-action) feature.
J
Johannes Rieken 已提交
2178 2179
	 *
	 * A code action can be any command that is [known](#commands.getCommands) to the system.
E
Erich Gamma 已提交
2180 2181 2182 2183 2184
	 */
	export interface CodeActionProvider {
		/**
		 * Provide commands for the given document and range.
		 *
J
Johannes Rieken 已提交
2185
		 * @param document The document in which the command was invoked.
2186 2187
		 * @param range The selector or range for which the command was invoked. This will always be a selection if
		 * there is a currently active editor.
J
Johannes Rieken 已提交
2188 2189
		 * @param context Context carrying additional information.
		 * @param token A cancellation token.
2190
		 * @return An array of commands, quick fixes, or refactorings or a thenable of such. The lack of a result can be
A
Andre Weinand 已提交
2191
		 * signaled by returning `undefined`, `null`, or an empty array.
E
Erich Gamma 已提交
2192
		 */
2193
		provideCodeActions(document: TextDocument, range: Range | Selection, context: CodeActionContext, token: CancellationToken): ProviderResult<(Command | CodeAction)[]>;
E
Erich Gamma 已提交
2194 2195
	}

2196
	/**
2197
	 * Metadata about the type of code actions that a [CodeActionProvider](#CodeActionProvider) providers.
2198 2199 2200
	 */
	export interface CodeActionProviderMetadata {
		/**
2201
		 * List of [CodeActionKinds](#CodeActionKind) that a [CodeActionProvider](#CodeActionProvider) may return.
2202
		 *
2203 2204 2205 2206
		 * This list is used to determine if a given `CodeActionProvider` should be invoked or not.
		 * To avoid unnecessary computation, every `CodeActionProvider` should list use `providedCodeActionKinds`. The
		 * list of kinds may either be generic, such as `[CodeActionKind.Refactor]`, or list out every kind provided,
		 * such as `[CodeActionKind.Refactor.Extract.append('function'), CodeActionKind.Refactor.Extract.append('constant'), ...]`.
2207
		 */
2208
		readonly providedCodeActionKinds?: ReadonlyArray<CodeActionKind>;
2209 2210
	}

E
Erich Gamma 已提交
2211 2212 2213
	/**
	 * 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 已提交
2214 2215 2216
	 *
	 * 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 已提交
2217 2218 2219
	 *
	 * @see [CodeLensProvider.provideCodeLenses](#CodeLensProvider.provideCodeLenses)
	 * @see [CodeLensProvider.resolveCodeLens](#CodeLensProvider.resolveCodeLens)
E
Erich Gamma 已提交
2220 2221 2222 2223 2224 2225 2226 2227 2228
	 */
	export class CodeLens {

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

		/**
J
Johannes Rieken 已提交
2229
		 * The command this code lens represents.
E
Erich Gamma 已提交
2230
		 */
2231
		command?: Command;
E
Erich Gamma 已提交
2232 2233

		/**
J
Johannes Rieken 已提交
2234
		 * `true` when there is a command associated.
E
Erich Gamma 已提交
2235
		 */
Y
Yuki Ueda 已提交
2236
		readonly isResolved: boolean;
J
Johannes Rieken 已提交
2237 2238 2239 2240 2241 2242 2243 2244

		/**
		 * 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 已提交
2245 2246 2247 2248 2249 2250 2251 2252
	}

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

2253 2254 2255
		/**
		 * An optional event to signal that the code lenses from this provider have changed.
		 */
2256
		onDidChangeCodeLenses?: Event<void>;
2257

E
Erich Gamma 已提交
2258 2259
		/**
		 * Compute a list of [lenses](#CodeLens). This call should return as fast as possible and if
A
Andre Weinand 已提交
2260
		 * computing the commands is expensive implementors should only return code lens objects with the
E
Erich Gamma 已提交
2261
		 * range set and implement [resolve](#CodeLensProvider.resolveCodeLens).
J
Johannes Rieken 已提交
2262 2263 2264
		 *
		 * @param document The document in which the command was invoked.
		 * @param token A cancellation token.
A
Andre Weinand 已提交
2265 2266
		 * @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 已提交
2267
		 */
2268
		provideCodeLenses(document: TextDocument, token: CancellationToken): ProviderResult<CodeLens[]>;
E
Erich Gamma 已提交
2269 2270 2271 2272

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

M
Matt Bierner 已提交
2281 2282 2283 2284 2285 2286
	/**
	 * Information about where a symbol is defined.
	 *
	 * Provides additional metadata over normal [location](#Location) definitions, including the range of
	 * the defining symbol
	 */
2287
	export type DefinitionLink = LocationLink;
M
Matt Bierner 已提交
2288

E
Erich Gamma 已提交
2289
	/**
J
Johannes Rieken 已提交
2290 2291 2292
	 * 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 已提交
2293 2294 2295
	 */
	export type Definition = Location | Location[];

J
Johannes Rieken 已提交
2296 2297 2298 2299 2300
	/**
	 * 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 已提交
2301
	export interface DefinitionProvider {
J
Johannes Rieken 已提交
2302 2303 2304 2305 2306 2307 2308

		/**
		 * 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 已提交
2309
		 * @return A definition or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
2310
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
2311
		 */
M
Matt Bierner 已提交
2312
		provideDefinition(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Definition | DefinitionLink[]>;
E
Erich Gamma 已提交
2313 2314
	}

2315
	/**
2316
	 * The implementation provider interface defines the contract between extensions and
2317 2318
	 * the go to implementation feature.
	 */
M
Matt Bierner 已提交
2319
	export interface ImplementationProvider {
2320 2321 2322 2323 2324 2325 2326 2327 2328 2329

		/**
		 * 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 已提交
2330
		provideImplementation(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Definition | DefinitionLink[]>;
2331 2332
	}

2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347
	/**
	 * 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`.
		 */
M
Matt Bierner 已提交
2348
		provideTypeDefinition(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Definition | DefinitionLink[]>;
2349 2350
	}

2351 2352
	/**
	 * The declaration of a symbol representation as one or many [locations](#Location)
R
rzj17 已提交
2353
	 * or [location links](#LocationLink).
2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374
	 */
	export type Declaration = Location | Location[] | LocationLink[];

	/**
	 * The declaration provider interface defines the contract between extensions and
	 * the go to declaration feature.
	 */
	export interface DeclarationProvider {

		/**
		 * Provide the declaration 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 declaration or a thenable that resolves to such. The lack of a result can be
		 * signaled by returning `undefined` or `null`.
		 */
		provideDeclaration(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Declaration>;
	}

E
Erich Gamma 已提交
2375
	/**
S
Sandeep Somavarapu 已提交
2376
	 * The MarkdownString represents human-readable text that supports formatting via the
2377
	 * markdown syntax. Standard markdown is supported, also tables, but no embedded html.
2378 2379 2380
	 *
	 * When created with `supportThemeIcons` then rendering of [theme icons](#ThemeIcon) via
	 * the `$(<name>)`-syntax is supported.
2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398
	 */
	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.
E
Eric Amodio 已提交
2399
		 * @param supportThemeIcons Optional, Specifies whether [ThemeIcons](#ThemeIcon) are supported within the [`MarkdownString`](#MarkdownString).
2400
		 */
E
Eric Amodio 已提交
2401
		constructor(value?: string, supportThemeIcons?: boolean);
2402 2403 2404 2405 2406 2407 2408 2409

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

		/**
E
Eric Amodio 已提交
2410
		 * Appends the given string 'as is' to this markdown string. When [`supportThemeIcons`](#MarkdownString.supportThemeIcons) is `true`, [ThemeIcons](#ThemeIcon) in the `value` will be iconified.
2411 2412 2413
		 * @param value Markdown string.
		 */
		appendMarkdown(value: string): MarkdownString;
J
Johannes Rieken 已提交
2414 2415 2416 2417 2418 2419 2420

		/**
		 * Appends the given string as codeblock using the provided language.
		 * @param value A code snippet.
		 * @param language An optional [language identifier](#languages.getLanguages).
		 */
		appendCodeblock(value: string, language?: string): MarkdownString;
2421 2422 2423
	}

	/**
S
Sandeep Somavarapu 已提交
2424
	 * ~~MarkedString can be used to render human-readable text. It is either a markdown string
J
Johannes Rieken 已提交
2425
	 * or a code-block that provides a language and a code snippet. Note that
2426 2427 2428
	 * markdown strings will be sanitized - that means html will be escaped.~~
	 *
	 * @deprecated This type is deprecated, please use [`MarkdownString`](#MarkdownString) instead.
E
Erich Gamma 已提交
2429
	 */
2430
	export type MarkedString = MarkdownString | string | { language: string; value: string };
E
Erich Gamma 已提交
2431

J
Johannes Rieken 已提交
2432 2433 2434 2435
	/**
	 * A hover represents additional information for a symbol or word. Hovers are
	 * rendered in a tooltip-like widget.
	 */
E
Erich Gamma 已提交
2436 2437
	export class Hover {

J
Johannes Rieken 已提交
2438 2439 2440
		/**
		 * The contents of this hover.
		 */
E
Erich Gamma 已提交
2441 2442
		contents: MarkedString[];

J
Johannes Rieken 已提交
2443
		/**
A
Andre Weinand 已提交
2444
		 * The range to which this hover applies. When missing, the
J
Johannes Rieken 已提交
2445
		 * editor will use the range at the current position or the
A
Andre Weinand 已提交
2446
		 * current position itself.
J
Johannes Rieken 已提交
2447
		 */
2448
		range?: Range;
E
Erich Gamma 已提交
2449

J
Johannes Rieken 已提交
2450 2451 2452 2453
		/**
		 * Creates a new hover object.
		 *
		 * @param contents The contents of the hover.
A
Andre Weinand 已提交
2454
		 * @param range The range to which the hover applies.
J
Johannes Rieken 已提交
2455
		 */
E
Erich Gamma 已提交
2456 2457 2458
		constructor(contents: MarkedString | MarkedString[], range?: Range);
	}

J
Johannes Rieken 已提交
2459 2460
	/**
	 * The hover provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
2461
	 * the [hover](https://code.visualstudio.com/docs/editor/intellisense)-feature.
J
Johannes Rieken 已提交
2462
	 */
E
Erich Gamma 已提交
2463
	export interface HoverProvider {
J
Johannes Rieken 已提交
2464 2465 2466

		/**
		 * Provide a hover for the given position and document. Multiple hovers at the same
A
Andre Weinand 已提交
2467 2468
		 * 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 已提交
2469 2470 2471 2472 2473
		 *
		 * @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 已提交
2474
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
2475
		 */
2476
		provideHover(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Hover>;
E
Erich Gamma 已提交
2477 2478
	}

2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508
	/**
	 * An EvaluatableExpression represents an expression in a document that can be evaluated by an active debugger or runtime.
	 * The result of this evaluation is shown in a tooltip-like widget.
	 * If only a range is specified, the expression will be extracted from the underlying document.
	 * An optional expression can be used to override the extracted expression.
	 * In this case the range is still used to highlight the range in the document.
	 */
	export class EvaluatableExpression {

		/*
		 * The range is used to extract the evaluatable expression from the underlying document and to highlight it.
		 */
		readonly range: Range;

		/*
		 * If specified the expression overrides the extracted expression.
		 */
		readonly expression?: string;

		/**
		 * Creates a new evaluatable expression object.
		 *
		 * @param range The range in the underlying document from which the evaluatable expression is extracted.
		 * @param expression If specified overrides the extracted expression.
		 */
		constructor(range: Range, expression?: string);
	}

	/**
	 * The evaluatable expression provider interface defines the contract between extensions and
2509 2510
	 * the debug hover. In this contract the provider returns an evaluatable expression for a given position
	 * in a document and VS Code evaluates this expression in the active debug session and shows the result in a debug hover.
2511 2512 2513 2514 2515
	 */
	export interface EvaluatableExpressionProvider {

		/**
		 * Provide an evaluatable expression for the given document and position.
2516
		 * VS Code will evaluate this expression in the active debug session and will show the result in the debug hover.
2517 2518
		 * The expression can be implicitly specified by the range in the underlying document or by explicitly returning an expression.
		 *
2519 2520
		 * @param document The document for which the debug hover is about to appear.
		 * @param position The line and character position in the document where the debug hover is about to appear.
2521 2522 2523 2524 2525 2526 2527
		 * @param token A cancellation token.
		 * @return An EvaluatableExpression or a thenable that resolves to such. The lack of a result can be
		 * signaled by returning `undefined` or `null`.
		 */
		provideEvaluatableExpression(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<EvaluatableExpression>;
	}

J
Johannes Rieken 已提交
2528 2529 2530
	/**
	 * A document highlight kind.
	 */
E
Erich Gamma 已提交
2531
	export enum DocumentHighlightKind {
J
Johannes Rieken 已提交
2532 2533

		/**
A
Andre Weinand 已提交
2534
		 * A textual occurrence.
J
Johannes Rieken 已提交
2535
		 */
2536
		Text = 0,
J
Johannes Rieken 已提交
2537 2538 2539 2540

		/**
		 * Read-access of a symbol, like reading a variable.
		 */
2541
		Read = 1,
J
Johannes Rieken 已提交
2542 2543 2544 2545

		/**
		 * Write-access of a symbol, like writing to a variable.
		 */
2546
		Write = 2
E
Erich Gamma 已提交
2547 2548
	}

J
Johannes Rieken 已提交
2549 2550 2551 2552 2553
	/**
	 * 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 已提交
2554
	export class DocumentHighlight {
J
Johannes Rieken 已提交
2555 2556 2557 2558

		/**
		 * The range this highlight applies to.
		 */
E
Erich Gamma 已提交
2559
		range: Range;
J
Johannes Rieken 已提交
2560 2561 2562 2563

		/**
		 * The highlight kind, default is [text](#DocumentHighlightKind.Text).
		 */
2564
		kind?: DocumentHighlightKind;
J
Johannes Rieken 已提交
2565 2566 2567 2568 2569 2570 2571 2572

		/**
		 * 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 已提交
2573 2574
	}

J
Johannes Rieken 已提交
2575 2576 2577 2578
	/**
	 * The document highlight provider interface defines the contract between extensions and
	 * the word-highlight-feature.
	 */
E
Erich Gamma 已提交
2579
	export interface DocumentHighlightProvider {
J
Johannes Rieken 已提交
2580 2581

		/**
S
Steven Clarke 已提交
2582
		 * Provide a set of document highlights, like all occurrences of a variable or
J
Johannes Rieken 已提交
2583 2584 2585 2586 2587 2588
		 * 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 已提交
2589
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2590
		 */
2591
		provideDocumentHighlights(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<DocumentHighlight[]>;
E
Erich Gamma 已提交
2592 2593
	}

J
Johannes Rieken 已提交
2594 2595 2596
	/**
	 * A symbol kind.
	 */
E
Erich Gamma 已提交
2597
	export enum SymbolKind {
2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617
		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,
2618 2619 2620 2621
		Null = 20,
		EnumMember = 21,
		Struct = 22,
		Event = 23,
2622 2623
		Operator = 24,
		TypeParameter = 25
E
Erich Gamma 已提交
2624 2625
	}

2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637

	/**
	 * Symbol tags are extra annotations that tweak the rendering of a symbol.
	 */
	export enum SymbolTag {

		/**
		 * Render a symbol as obsolete, usually using a strike-out.
		 */
		Deprecated = 1
	}

J
Johannes Rieken 已提交
2638 2639 2640 2641
	/**
	 * Represents information about programming constructs like variables, classes,
	 * interfaces etc.
	 */
E
Erich Gamma 已提交
2642
	export class SymbolInformation {
J
Johannes Rieken 已提交
2643 2644 2645 2646

		/**
		 * The name of this symbol.
		 */
E
Erich Gamma 已提交
2647
		name: string;
J
Johannes Rieken 已提交
2648 2649 2650 2651

		/**
		 * The name of the symbol containing this symbol.
		 */
E
Erich Gamma 已提交
2652
		containerName: string;
J
Johannes Rieken 已提交
2653 2654 2655 2656

		/**
		 * The kind of this symbol.
		 */
E
Erich Gamma 已提交
2657
		kind: SymbolKind;
J
Johannes Rieken 已提交
2658

2659 2660 2661 2662 2663
		/**
		 * Tags for this symbol.
		 */
		tags?: ReadonlyArray<SymbolTag>;

J
Johannes Rieken 已提交
2664 2665 2666
		/**
		 * The location of this symbol.
		 */
E
Erich Gamma 已提交
2667
		location: Location;
J
Johannes Rieken 已提交
2668

2669 2670 2671 2672 2673 2674
		/**
		 * 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.
M
Maira Wenzel 已提交
2675
		 * @param location The location of the symbol.
2676 2677 2678
		 */
		constructor(name: string, kind: SymbolKind, containerName: string, location: Location);

J
Johannes Rieken 已提交
2679
		/**
2680
		 * ~~Creates a new symbol information object.~~
2681
		 *
2682
		 * @deprecated Please use the constructor taking a [location](#Location) object.
J
Johannes Rieken 已提交
2683 2684 2685 2686 2687
		 *
		 * @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 已提交
2688
		 * @param containerName The name of the symbol containing the symbol.
J
Johannes Rieken 已提交
2689 2690
		 */
		constructor(name: string, kind: SymbolKind, range: Range, uri?: Uri, containerName?: string);
E
Erich Gamma 已提交
2691 2692
	}

2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705
	/**
	 * Represents programming constructs like variables, classes, interfaces etc. that appear in a document. Document
	 * symbols can be hierarchical and they have two ranges: one that encloses its definition and one that points to
	 * its most interesting range, e.g. the range of an identifier.
	 */
	export class DocumentSymbol {

		/**
		 * The name of this symbol.
		 */
		name: string;

		/**
2706
		 * More detail for this symbol, e.g. the signature of a function.
2707 2708 2709 2710 2711 2712 2713 2714
		 */
		detail: string;

		/**
		 * The kind of this symbol.
		 */
		kind: SymbolKind;

2715 2716 2717 2718 2719
		/**
		 * Tags for this symbol.
		 */
		tags?: ReadonlyArray<SymbolTag>;

2720
		/**
2721
		 * The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.
2722 2723 2724 2725
		 */
		range: Range;

		/**
2726
		 * The range that should be selected and reveal when this symbol is being picked, e.g. the name of a function.
J
Johannes Rieken 已提交
2727
		 * Must be contained by the [`range`](#DocumentSymbol.range).
2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747
		 */
		selectionRange: Range;

		/**
		 * Children of this symbol, e.g. properties of a class.
		 */
		children: DocumentSymbol[];

		/**
		 * Creates a new document symbol.
		 *
		 * @param name The name of the symbol.
		 * @param detail Details for the symbol.
		 * @param kind The kind of the symbol.
		 * @param range The full range of the symbol.
		 * @param selectionRange The range that should be reveal.
		 */
		constructor(name: string, detail: string, kind: SymbolKind, range: Range, selectionRange: Range);
	}

J
Johannes Rieken 已提交
2748 2749
	/**
	 * The document symbol provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
2750
	 * the [go to symbol](https://code.visualstudio.com/docs/editor/editingevolved#_go-to-symbol)-feature.
J
Johannes Rieken 已提交
2751
	 */
E
Erich Gamma 已提交
2752
	export interface DocumentSymbolProvider {
J
Johannes Rieken 已提交
2753 2754 2755 2756 2757 2758 2759

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

J
Johannes Rieken 已提交
2765 2766 2767
	/**
	 * Metadata about a document symbol provider.
	 */
2768 2769
	export interface DocumentSymbolProviderMetadata {
		/**
S
Sandeep Somavarapu 已提交
2770
		 * A human-readable string that is shown when multiple outlines trees show for one document.
2771
		 */
J
Johannes Rieken 已提交
2772
		label?: string;
2773 2774
	}

J
Johannes Rieken 已提交
2775 2776 2777 2778
	/**
	 * 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 已提交
2779
	export interface WorkspaceSymbolProvider {
J
Johannes Rieken 已提交
2780 2781

		/**
J
Johannes Rieken 已提交
2782
		 * Project-wide search for a symbol matching the given query string.
J
Johannes Rieken 已提交
2783
		 *
2784 2785 2786 2787 2788
		 * 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 已提交
2789 2790 2791 2792
		 * To improve performance implementors can implement `resolveWorkspaceSymbol` and then provide symbols with partial
		 * [location](#SymbolInformation.location)-objects, without a `range` defined. The editor will then call
		 * `resolveWorkspaceSymbol` for selected symbols only, e.g. when opening a workspace symbol.
		 *
J
Johannes Rieken 已提交
2793
		 * @param query A query string, can be the empty string in which case all symbols should be returned.
J
Johannes Rieken 已提交
2794 2795
		 * @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 已提交
2796
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2797
		 */
M
Matt Bierner 已提交
2798
		provideWorkspaceSymbols(query: string, token: CancellationToken): ProviderResult<SymbolInformation[]>;
2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811

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

J
Johannes Rieken 已提交
2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830
	/**
	 * 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 已提交
2831
	export interface ReferenceProvider {
J
Johannes Rieken 已提交
2832 2833 2834 2835 2836 2837 2838

		/**
		 * 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 token A cancellation token.
2839
		 *
J
Johannes Rieken 已提交
2840
		 * @return An array of locations or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
2841
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2842
		 */
2843
		provideReferences(document: TextDocument, position: Position, context: ReferenceContext, token: CancellationToken): ProviderResult<Location[]>;
E
Erich Gamma 已提交
2844 2845
	}

J
Johannes Rieken 已提交
2846
	/**
S
Steven Clarke 已提交
2847
	 * A text edit represents edits that should be applied
J
Johannes Rieken 已提交
2848
	 * to a document.
J
Johannes Rieken 已提交
2849
	 */
E
Erich Gamma 已提交
2850
	export class TextEdit {
J
Johannes Rieken 已提交
2851 2852 2853 2854 2855 2856 2857 2858

		/**
		 * Utility to create a replace edit.
		 *
		 * @param range A range.
		 * @param newText A string.
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
2859
		static replace(range: Range, newText: string): TextEdit;
J
Johannes Rieken 已提交
2860 2861 2862 2863

		/**
		 * Utility to create an insert edit.
		 *
S
Steven Clarke 已提交
2864
		 * @param position A position, will become an empty range.
J
Johannes Rieken 已提交
2865 2866 2867
		 * @param newText A string.
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
2868
		static insert(position: Position, newText: string): TextEdit;
J
Johannes Rieken 已提交
2869 2870 2871 2872

		/**
		 * Utility to create a delete edit.
		 *
J
Johannes Rieken 已提交
2873
		 * @param range A range.
J
Johannes Rieken 已提交
2874 2875
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
2876
		static delete(range: Range): TextEdit;
J
Johannes Rieken 已提交
2877

2878 2879 2880 2881 2882 2883 2884 2885
		/**
		 * 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 已提交
2886 2887 2888
		/**
		 * The range this edit applies to.
		 */
E
Erich Gamma 已提交
2889
		range: Range;
J
Johannes Rieken 已提交
2890 2891 2892 2893

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

2896 2897
		/**
		 * The eol-sequence used in the document.
J
Johannes Rieken 已提交
2898 2899 2900
		 *
		 * *Note* that the eol-sequence will be applied to the
		 * whole document.
2901
		 */
J
Johannes Rieken 已提交
2902
		newEol?: EndOfLine;
2903

J
Johannes Rieken 已提交
2904 2905 2906 2907 2908 2909 2910
		/**
		 * Create a new TextEdit.
		 *
		 * @param range A range.
		 * @param newText A string.
		 */
		constructor(range: Range, newText: string);
E
Erich Gamma 已提交
2911 2912
	}

2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940
	/**
	 * Additional data for entries of a workspace edit. Supports to label entries and marks entries
	 * as needing confirmation by the user. The editor groups edits with equal labels into tree nodes,
	 * for instance all edits labelled with "Changes in Strings" would be a tree node.
	 */
	export interface WorkspaceEditEntryMetadata {

		/**
		 * A flag which indicates that user confirmation is needed.
		 */
		needsConfirmation: boolean;

		/**
		 * A human-readable string which is rendered prominent.
		 */
		label: string;

		/**
		 * A human-readable string which is rendered less prominent on the same line.
		 */
		description?: string;

		/**
		 * The icon path or [ThemeIcon](#ThemeIcon) for the edit.
		 */
		iconPath?: Uri | { light: Uri; dark: Uri } | ThemeIcon;
	}

E
Erich Gamma 已提交
2941
	/**
2942
	 * A workspace edit is a collection of textual and files changes for
J
Johannes Rieken 已提交
2943
	 * multiple resources and documents.
2944 2945
	 *
	 * Use the [applyEdit](#workspace.applyEdit)-function to apply a workspace edit.
E
Erich Gamma 已提交
2946 2947 2948 2949
	 */
	export class WorkspaceEdit {

		/**
2950
		 * The number of affected resources of textual or resource changes.
E
Erich Gamma 已提交
2951
		 */
Y
Yuki Ueda 已提交
2952
		readonly size: number;
E
Erich Gamma 已提交
2953

J
Johannes Rieken 已提交
2954 2955 2956 2957 2958 2959
		/**
		 * Replace the given range with given text for the given resource.
		 *
		 * @param uri A resource identifier.
		 * @param range A range.
		 * @param newText A string.
2960
		 * @param metadata Optional metadata for the entry.
J
Johannes Rieken 已提交
2961
		 */
2962
		replace(uri: Uri, range: Range, newText: string, metadata?: WorkspaceEditEntryMetadata): void;
E
Erich Gamma 已提交
2963

J
Johannes Rieken 已提交
2964 2965 2966 2967 2968 2969
		/**
		 * Insert the given text at the given position.
		 *
		 * @param uri A resource identifier.
		 * @param position A position.
		 * @param newText A string.
2970
		 * @param metadata Optional metadata for the entry.
J
Johannes Rieken 已提交
2971
		 */
2972
		insert(uri: Uri, position: Position, newText: string, metadata?: WorkspaceEditEntryMetadata): void;
E
Erich Gamma 已提交
2973

J
Johannes Rieken 已提交
2974
		/**
S
Steven Clarke 已提交
2975
		 * Delete the text at the given range.
J
Johannes Rieken 已提交
2976 2977 2978
		 *
		 * @param uri A resource identifier.
		 * @param range A range.
2979
		 * @param metadata Optional metadata for the entry.
J
Johannes Rieken 已提交
2980
		 */
2981
		delete(uri: Uri, range: Range, metadata?: WorkspaceEditEntryMetadata): void;
E
Erich Gamma 已提交
2982

J
Johannes Rieken 已提交
2983
		/**
2984 2985
		 * Check if a text edit for a resource exists.
		 *
J
Johannes Rieken 已提交
2986
		 * @param uri A resource identifier.
A
Andre Weinand 已提交
2987
		 * @return `true` if the given resource will be touched by this edit.
J
Johannes Rieken 已提交
2988
		 */
E
Erich Gamma 已提交
2989 2990
		has(uri: Uri): boolean;

J
Johannes Rieken 已提交
2991 2992 2993 2994 2995 2996
		/**
		 * Set (and replace) text edits for a resource.
		 *
		 * @param uri A resource identifier.
		 * @param edits An array of text edits.
		 */
E
Erich Gamma 已提交
2997 2998
		set(uri: Uri, edits: TextEdit[]): void;

J
Johannes Rieken 已提交
2999 3000 3001 3002 3003 3004
		/**
		 * Get the text edits for a resource.
		 *
		 * @param uri A resource identifier.
		 * @return An array of text edits.
		 */
E
Erich Gamma 已提交
3005 3006
		get(uri: Uri): TextEdit[];

3007 3008 3009 3010 3011 3012
		/**
		 * Create a regular file.
		 *
		 * @param uri Uri of the new file..
		 * @param options Defines if an existing file should be overwritten or be
		 * ignored. When overwrite and ignoreIfExists are both set overwrite wins.
3013
		 * @param metadata Optional metadata for the entry.
3014
		 */
3015
		createFile(uri: Uri, options?: { overwrite?: boolean, ignoreIfExists?: boolean }, metadata?: WorkspaceEditEntryMetadata): void;
3016 3017 3018 3019 3020

		/**
		 * Delete a file or folder.
		 *
		 * @param uri The uri of the file that is to be deleted.
3021
		 * @param metadata Optional metadata for the entry.
3022
		 */
3023
		deleteFile(uri: Uri, options?: { recursive?: boolean, ignoreIfNotExists?: boolean }, metadata?: WorkspaceEditEntryMetadata): void;
3024 3025 3026 3027 3028 3029 3030 3031

		/**
		 * Rename a file or folder.
		 *
		 * @param oldUri The existing file.
		 * @param newUri The new location.
		 * @param options Defines if existing files should be overwritten or be
		 * ignored. When overwrite and ignoreIfExists are both set overwrite wins.
3032
		 * @param metadata Optional metadata for the entry.
3033
		 */
3034
		renameFile(oldUri: Uri, newUri: Uri, options?: { overwrite?: boolean, ignoreIfExists?: boolean }, metadata?: WorkspaceEditEntryMetadata): void;
3035 3036


J
Johannes Rieken 已提交
3037 3038 3039
		/**
		 * Get all text edits grouped by resource.
		 *
J
Johannes Rieken 已提交
3040
		 * @return A shallow copy of `[Uri, TextEdit[]]`-tuples.
J
Johannes Rieken 已提交
3041
		 */
E
Erich Gamma 已提交
3042 3043 3044
		entries(): [Uri, TextEdit[]][];
	}

3045 3046 3047 3048 3049 3050
	/**
	 * 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
3051 3052
	 * the end of the snippet. Variables are defined with `$name` and
	 * `${name:default value}`. The full snippet syntax is documented
S
SteVen Batten 已提交
3053
	 * [here](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_creating-your-own-snippets).
3054 3055 3056 3057 3058 3059 3060 3061
	 */
	export class SnippetString {

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

3062 3063 3064 3065 3066 3067 3068
		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.
3069
		 * @return This snippet string.
3070 3071 3072 3073 3074 3075 3076
		 */
		appendText(string: string): SnippetString;

		/**
		 * Builder-function that appends a tabstop (`$1`, `$2` etc) to
		 * the [`value`](#SnippetString.value) of this snippet string.
		 *
3077
		 * @param number The number of this tabstop, defaults to an auto-increment
3078
		 * value starting at 1.
3079
		 * @return This snippet string.
3080 3081 3082 3083 3084 3085 3086 3087 3088
		 */
		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.
3089
		 * @param number The number of this tabstop, defaults to an auto-increment
3090
		 * value starting at 1.
3091
		 * @return This snippet string.
3092 3093
		 */
		appendPlaceholder(value: string | ((snippet: SnippetString) => any), number?: number): SnippetString;
3094

O
okmttdhr 已提交
3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105
		/**
		 * Builder-function that appends a choice (`${1|a,b,c}`) to
		 * the [`value`](#SnippetString.value) of this snippet string.
		 *
		 * @param values The values for choices - the array of strings
		 * @param number The number of this tabstop, defaults to an auto-increment
		 * value starting at 1.
		 * @return This snippet string.
		 */
		appendChoice(values: string[], number?: number): SnippetString;

3106
		/**
J
Johannes Rieken 已提交
3107
		 * Builder-function that appends a variable (`${VAR}`) to
3108 3109 3110 3111 3112 3113 3114 3115
		 * 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;
3116 3117
	}

E
Erich Gamma 已提交
3118
	/**
J
Johannes Rieken 已提交
3119 3120
	 * 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 已提交
3121 3122
	 */
	export interface RenameProvider {
J
Johannes Rieken 已提交
3123 3124 3125 3126 3127 3128 3129 3130 3131 3132

		/**
		 * 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 已提交
3133
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
3134
		 */
3135
		provideRenameEdits(document: TextDocument, position: Position, newName: string, token: CancellationToken): ProviderResult<WorkspaceEdit>;
J
Johannes Rieken 已提交
3136 3137 3138

		/**
		 * Optional function for resolving and validating a position *before* running rename. The result can
3139
		 * be a range or a range and a placeholder text. The placeholder text should be the identifier of the symbol
J
Johannes Rieken 已提交
3140 3141
		 * which is being renamed - when omitted the text in the returned range is used.
		 *
J
Johannes Rieken 已提交
3142 3143 3144
		 * *Note: * This function should throw an error or return a rejected thenable when the provided location
		 * doesn't allow for a rename.
		 *
J
Johannes Rieken 已提交
3145 3146 3147 3148 3149
		 * @param document The document in which rename will be invoked.
		 * @param position The position at which rename will be invoked.
		 * @param token A cancellation token.
		 * @return The range or range and placeholder text of the identifier that is to be renamed. The lack of a result can signaled by returning `undefined` or `null`.
		 */
3150
		prepareRename?(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Range | { range: Range, placeholder: string }>;
E
Erich Gamma 已提交
3151 3152
	}

3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166
	/**
	 * A semantic tokens legend contains the needed information to decipher
	 * the integer encoded representation of semantic tokens.
	 */
	export class SemanticTokensLegend {
		/**
		 * The possible token types.
		 */
		public readonly tokenTypes: string[];
		/**
		 * The possible token modifiers.
		 */
		public readonly tokenModifiers: string[];

A
Alex Dima 已提交
3167
		constructor(tokenTypes: string[], tokenModifiers?: string[]);
3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186
	}

	/**
	 * A semantic tokens builder can help with creating a `SemanticTokens` instance
	 * which contains delta encoded semantic tokens.
	 */
	export class SemanticTokensBuilder {

		constructor(legend?: SemanticTokensLegend);

		/**
		 * Add another token.
		 *
		 * @param line The token start line number (absolute value).
		 * @param char The token start character (absolute value).
		 * @param length The token length in characters.
		 * @param tokenType The encoded token type.
		 * @param tokenModifiers The encoded token modifiers.
		 */
A
Alex Dima 已提交
3187
		push(line: number, char: number, length: number, tokenType: number, tokenModifiers?: number): void;
3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205

		/**
		 * Add another token. Use only when providing a legend.
		 *
		 * @param range The range of the token. Must be single-line.
		 * @param tokenType The token type.
		 * @param tokenModifiers The token modifiers.
		 */
		push(range: Range, tokenType: string, tokenModifiers?: string[]): void;

		/**
		 * Finish and create a `SemanticTokens` instance.
		 */
		build(resultId?: string): SemanticTokens;
	}

	/**
	 * Represents semantic tokens, either in a range or in an entire document.
A
Alex Dima 已提交
3206 3207
	 * @see [provideDocumentSemanticTokens](#DocumentSemanticTokensProvider.provideDocumentSemanticTokens) for an explanation of the format.
	 * @see [SemanticTokensBuilder](#SemanticTokensBuilder) for a helper to create an instance.
3208 3209 3210 3211 3212 3213 3214 3215 3216 3217
	 */
	export class SemanticTokens {
		/**
		 * The result id of the tokens.
		 *
		 * This is the id that will be passed to `DocumentSemanticTokensProvider.provideDocumentSemanticTokensEdits` (if implemented).
		 */
		readonly resultId?: string;
		/**
		 * The actual tokens data.
A
Alex Dima 已提交
3218
		 * @see [provideDocumentSemanticTokens](#DocumentSemanticTokensProvider.provideDocumentSemanticTokens) for an explanation of the format.
3219 3220 3221 3222 3223 3224 3225 3226
		 */
		readonly data: Uint32Array;

		constructor(data: Uint32Array, resultId?: string);
	}

	/**
	 * Represents edits to semantic tokens.
A
Alex Dima 已提交
3227
	 * @see [provideDocumentSemanticTokensEdits](#DocumentSemanticTokensProvider.provideDocumentSemanticTokensEdits) for an explanation of the format.
3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246
	 */
	export class SemanticTokensEdits {
		/**
		 * The result id of the tokens.
		 *
		 * This is the id that will be passed to `DocumentSemanticTokensProvider.provideDocumentSemanticTokensEdits` (if implemented).
		 */
		readonly resultId?: string;
		/**
		 * The edits to the tokens data.
		 * All edits refer to the initial data state.
		 */
		readonly edits: SemanticTokensEdit[];

		constructor(edits: SemanticTokensEdit[], resultId?: string);
	}

	/**
	 * Represents an edit to semantic tokens.
A
Alex Dima 已提交
3247
	 * @see [provideDocumentSemanticTokensEdits](#DocumentSemanticTokensProvider.provideDocumentSemanticTokensEdits) for an explanation of the format.
3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276
	 */
	export class SemanticTokensEdit {
		/**
		 * The start offset of the edit.
		 */
		readonly start: number;
		/**
		 * The count of elements to remove.
		 */
		readonly deleteCount: number;
		/**
		 * The elements to insert.
		 */
		readonly data?: Uint32Array;

		constructor(start: number, deleteCount: number, data?: Uint32Array);
	}

	/**
	 * The document semantic tokens provider interface defines the contract between extensions and
	 * semantic tokens.
	 */
	export interface DocumentSemanticTokensProvider {
		/**
		 * An optional event to signal that the semantic tokens from this provider have changed.
		 */
		onDidChangeSemanticTokens?: Event<void>;

		/**
A
Alex Dima 已提交
3277 3278
		 * Tokens in a file are represented as an array of integers. The position of each token is expressed relative to
		 * the token before it, because most tokens remain stable relative to each other when edits are made in a file.
3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330
		 *
		 * ---
		 * In short, each token takes 5 integers to represent, so a specific token `i` in the file consists of the following array indices:
		 *  - at index `5*i`   - `deltaLine`: token line number, relative to the previous token
		 *  - at index `5*i+1` - `deltaStart`: token start character, relative to the previous token (relative to 0 or the previous token's start if they are on the same line)
		 *  - at index `5*i+2` - `length`: the length of the token. A token cannot be multiline.
		 *  - at index `5*i+3` - `tokenType`: will be looked up in `SemanticTokensLegend.tokenTypes`. We currently ask that `tokenType` < 65536.
		 *  - at index `5*i+4` - `tokenModifiers`: each set bit will be looked up in `SemanticTokensLegend.tokenModifiers`
		 *
		 * ---
		 * ### How to encode tokens
		 *
		 * Here is an example for encoding a file with 3 tokens in a uint32 array:
		 * ```
		 *    { line: 2, startChar:  5, length: 3, tokenType: "property",  tokenModifiers: ["private", "static"] },
		 *    { line: 2, startChar: 10, length: 4, tokenType: "type",      tokenModifiers: [] },
		 *    { line: 5, startChar:  2, length: 7, tokenType: "class",     tokenModifiers: [] }
		 * ```
		 *
		 * 1. First of all, a legend must be devised. This legend must be provided up-front and capture all possible token types.
		 * For this example, we will choose the following legend which must be passed in when registering the provider:
		 * ```
		 *    tokenTypes: ['property', 'type', 'class'],
		 *    tokenModifiers: ['private', 'static']
		 * ```
		 *
		 * 2. The first transformation step is to encode `tokenType` and `tokenModifiers` as integers using the legend. Token types are looked
		 * up by index, so a `tokenType` value of `1` means `tokenTypes[1]`. Multiple token modifiers can be set by using bit flags,
		 * so a `tokenModifier` value of `3` is first viewed as binary `0b00000011`, which means `[tokenModifiers[0], tokenModifiers[1]]` because
		 * bits 0 and 1 are set. Using this legend, the tokens now are:
		 * ```
		 *    { line: 2, startChar:  5, length: 3, tokenType: 0, tokenModifiers: 3 },
		 *    { line: 2, startChar: 10, length: 4, tokenType: 1, tokenModifiers: 0 },
		 *    { line: 5, startChar:  2, length: 7, tokenType: 2, tokenModifiers: 0 }
		 * ```
		 *
		 * 3. The next step is to represent each token relative to the previous token in the file. In this case, the second token
		 * is on the same line as the first token, so the `startChar` of the second token is made relative to the `startChar`
		 * of the first token, so it will be `10 - 5`. The third token is on a different line than the second token, so the
		 * `startChar` of the third token will not be altered:
		 * ```
		 *    { deltaLine: 2, deltaStartChar: 5, length: 3, tokenType: 0, tokenModifiers: 3 },
		 *    { deltaLine: 0, deltaStartChar: 5, length: 4, tokenType: 1, tokenModifiers: 0 },
		 *    { deltaLine: 3, deltaStartChar: 2, length: 7, tokenType: 2, tokenModifiers: 0 }
		 * ```
		 *
		 * 4. Finally, the last step is to inline each of the 5 fields for a token in a single array, which is a memory friendly representation:
		 * ```
		 *    // 1st token,  2nd token,  3rd token
		 *    [  2,5,3,0,3,  0,5,4,1,0,  3,2,7,2,0 ]
		 * ```
		 *
A
Alex Dima 已提交
3331
		 * @see [SemanticTokensBuilder](#SemanticTokensBuilder) for a helper to encode tokens as integers.
3332 3333 3334 3335 3336 3337 3338
		 * *NOTE*: When doing edits, it is possible that multiple edits occur until VS Code decides to invoke the semantic tokens provider.
		 * *NOTE*: If the provider cannot temporarily compute semantic tokens, it can indicate this by throwing an error with the message 'Busy'.
		 */
		provideDocumentSemanticTokens(document: TextDocument, token: CancellationToken): ProviderResult<SemanticTokens>;

		/**
		 * Instead of always returning all the tokens in a file, it is possible for a `DocumentSemanticTokensProvider` to implement
A
Alex Dima 已提交
3339
		 * this method (`provideDocumentSemanticTokensEdits`) and then return incremental updates to the previously provided semantic tokens.
3340 3341 3342 3343
		 *
		 * ---
		 * ### How tokens change when the document changes
		 *
A
Alex Dima 已提交
3344
		 * Suppose that `provideDocumentSemanticTokens` has previously returned the following semantic tokens:
3345
		 * ```
A
Alex Dima 已提交
3346 3347
		 *    // 1st token,  2nd token,  3rd token
		 *    [  2,5,3,0,3,  0,5,4,1,0,  3,2,7,2,0 ]
3348
		 * ```
A
Alex Dima 已提交
3349 3350
		 *
		 * Also suppose that after some edits, the new semantic tokens in a file are:
3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374
		 * ```
		 *    // 1st token,  2nd token,  3rd token
		 *    [  3,5,3,0,3,  0,5,4,1,0,  3,2,7,2,0 ]
		 * ```
		 * It is possible to express these new tokens in terms of an edit applied to the previous tokens:
		 * ```
		 *    [  2,5,3,0,3,  0,5,4,1,0,  3,2,7,2,0 ] // old tokens
		 *    [  3,5,3,0,3,  0,5,4,1,0,  3,2,7,2,0 ] // new tokens
		 *
		 *    edit: { start:  0, deleteCount: 1, data: [3] } // replace integer at offset 0 with 3
		 * ```
		 *
		 * *NOTE*: If the provider cannot compute `SemanticTokensEdits`, it can "give up" and return all the tokens in the document again.
		 * *NOTE*: All edits in `SemanticTokensEdits` contain indices in the old integers array, so they all refer to the previous result state.
		 */
		provideDocumentSemanticTokensEdits?(document: TextDocument, previousResultId: string, token: CancellationToken): ProviderResult<SemanticTokens | SemanticTokensEdits>;
	}

	/**
	 * The document range semantic tokens provider interface defines the contract between extensions and
	 * semantic tokens.
	 */
	export interface DocumentRangeSemanticTokensProvider {
		/**
A
Alex Dima 已提交
3375
		 * @see [provideDocumentSemanticTokens](#DocumentSemanticTokensProvider.provideDocumentSemanticTokens).
3376 3377 3378 3379
		 */
		provideDocumentRangeSemanticTokens(document: TextDocument, range: Range, token: CancellationToken): ProviderResult<SemanticTokens>;
	}

J
Johannes Rieken 已提交
3380 3381 3382
	/**
	 * Value-object describing what options formatting should use.
	 */
E
Erich Gamma 已提交
3383
	export interface FormattingOptions {
J
Johannes Rieken 已提交
3384 3385 3386 3387

		/**
		 * Size of a tab in spaces.
		 */
E
Erich Gamma 已提交
3388
		tabSize: number;
J
Johannes Rieken 已提交
3389 3390 3391 3392

		/**
		 * Prefer spaces over tabs.
		 */
E
Erich Gamma 已提交
3393
		insertSpaces: boolean;
J
Johannes Rieken 已提交
3394 3395 3396 3397 3398

		/**
		 * Signature for further properties.
		 */
		[key: string]: boolean | number | string;
E
Erich Gamma 已提交
3399 3400 3401
	}

	/**
J
Johannes Rieken 已提交
3402 3403
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
3404 3405
	 */
	export interface DocumentFormattingEditProvider {
J
Johannes Rieken 已提交
3406 3407 3408 3409 3410 3411 3412 3413

		/**
		 * 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 已提交
3414
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
3415
		 */
3416
		provideDocumentFormattingEdits(document: TextDocument, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
3417 3418 3419
	}

	/**
J
Johannes Rieken 已提交
3420 3421
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
3422 3423
	 */
	export interface DocumentRangeFormattingEditProvider {
J
Johannes Rieken 已提交
3424 3425 3426 3427 3428

		/**
		 * 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 已提交
3429 3430
		 * or larger range. Often this is done by adjusting the start and end
		 * of the range to full syntax nodes.
J
Johannes Rieken 已提交
3431 3432 3433 3434 3435 3436
		 *
		 * @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 已提交
3437
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
3438
		 */
3439
		provideDocumentRangeFormattingEdits(document: TextDocument, range: Range, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
3440 3441 3442
	}

	/**
J
Johannes Rieken 已提交
3443 3444
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
3445 3446
	 */
	export interface OnTypeFormattingEditProvider {
J
Johannes Rieken 已提交
3447 3448 3449 3450 3451 3452 3453 3454 3455 3456

		/**
		 * 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 已提交
3457
		 * @param ch The character that has been typed.
J
Johannes Rieken 已提交
3458 3459 3460
		 * @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 已提交
3461
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
3462
		 */
3463
		provideOnTypeFormattingEdits(document: TextDocument, position: Position, ch: string, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
3464 3465
	}

J
Johannes Rieken 已提交
3466 3467 3468 3469
	/**
	 * Represents a parameter of a callable-signature. A parameter can
	 * have a label and a doc-comment.
	 */
E
Erich Gamma 已提交
3470
	export class ParameterInformation {
J
Johannes Rieken 已提交
3471 3472

		/**
3473 3474 3475 3476 3477
		 * The label of this signature.
		 *
		 * Either a string or inclusive start and exclusive end offsets within its containing
		 * [signature label](#SignatureInformation.label). *Note*: A label of type string must be
		 * a substring of its containing signature information's [label](#SignatureInformation.label).
J
Johannes Rieken 已提交
3478
		 */
3479
		label: string | [number, number];
J
Johannes Rieken 已提交
3480 3481 3482 3483 3484

		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
3485
		documentation?: string | MarkdownString;
J
Johannes Rieken 已提交
3486 3487 3488 3489

		/**
		 * Creates a new parameter information object.
		 *
J
Johannes Rieken 已提交
3490
		 * @param label A label string or inclusive start and exclusive end offsets within its containing signature label.
J
Johannes Rieken 已提交
3491 3492
		 * @param documentation A doc string.
		 */
3493
		constructor(label: string | [number, number], documentation?: string | MarkdownString);
E
Erich Gamma 已提交
3494 3495
	}

J
Johannes Rieken 已提交
3496 3497 3498 3499 3500
	/**
	 * 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 已提交
3501
	export class SignatureInformation {
J
Johannes Rieken 已提交
3502 3503 3504 3505 3506

		/**
		 * The label of this signature. Will be shown in
		 * the UI.
		 */
E
Erich Gamma 已提交
3507
		label: string;
J
Johannes Rieken 已提交
3508 3509 3510 3511 3512

		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
3513
		documentation?: string | MarkdownString;
J
Johannes Rieken 已提交
3514 3515 3516 3517

		/**
		 * The parameters of this signature.
		 */
E
Erich Gamma 已提交
3518
		parameters: ParameterInformation[];
J
Johannes Rieken 已提交
3519 3520 3521 3522 3523

		/**
		 * Creates a new signature information object.
		 *
		 * @param label A label string.
J
Johannes Rieken 已提交
3524
		 * @param documentation A doc string.
J
Johannes Rieken 已提交
3525
		 */
3526
		constructor(label: string, documentation?: string | MarkdownString);
E
Erich Gamma 已提交
3527 3528
	}

J
Johannes Rieken 已提交
3529 3530
	/**
	 * Signature help represents the signature of something
S
Steven Clarke 已提交
3531
	 * callable. There can be multiple signatures but only one
J
Johannes Rieken 已提交
3532 3533
	 * active and only one active parameter.
	 */
E
Erich Gamma 已提交
3534
	export class SignatureHelp {
J
Johannes Rieken 已提交
3535 3536 3537 3538

		/**
		 * One or more signatures.
		 */
E
Erich Gamma 已提交
3539
		signatures: SignatureInformation[];
J
Johannes Rieken 已提交
3540 3541 3542 3543

		/**
		 * The active signature.
		 */
E
Erich Gamma 已提交
3544
		activeSignature: number;
J
Johannes Rieken 已提交
3545 3546 3547 3548

		/**
		 * The active parameter of the active signature.
		 */
E
Erich Gamma 已提交
3549 3550 3551
		activeParameter: number;
	}

3552
	/**
3553
	 * How a [`SignatureHelpProvider`](#SignatureHelpProvider) was triggered.
3554
	 */
M
Matt Bierner 已提交
3555
	export enum SignatureHelpTriggerKind {
3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579
		/**
		 * Signature help was invoked manually by the user or by a command.
		 */
		Invoke = 1,

		/**
		 * Signature help was triggered by a trigger character.
		 */
		TriggerCharacter = 2,

		/**
		 * Signature help was triggered by the cursor moving or by the document content changing.
		 */
		ContentChange = 3,
	}

	/**
	 * Additional information about the context in which a
	 * [`SignatureHelpProvider`](#SignatureHelpProvider.provideSignatureHelp) was triggered.
	 */
	export interface SignatureHelpContext {
		/**
		 * Action that caused signature help to be triggered.
		 */
3580
		readonly triggerKind: SignatureHelpTriggerKind;
3581 3582 3583 3584 3585 3586 3587 3588 3589 3590

		/**
		 * Character that caused signature help to be triggered.
		 *
		 * This is `undefined` when signature help is not triggered by typing, such as when manually invoking
		 * signature help or when moving the cursor.
		 */
		readonly triggerCharacter?: string;

		/**
3591
		 * `true` if signature help was already showing when it was triggered.
3592
		 *
M
Matt Bierner 已提交
3593 3594
		 * Retriggers occur when the signature help is already active and can be caused by actions such as
		 * typing a trigger character, a cursor move, or document content changes.
3595 3596
		 */
		readonly isRetrigger: boolean;
3597 3598 3599 3600 3601 3602 3603 3604

		/**
		 * The currently active [`SignatureHelp`](#SignatureHelp).
		 *
		 * The `activeSignatureHelp` has its [`SignatureHelp.activeSignature`] field updated based on
		 * the user arrowing through available signatures.
		 */
		readonly activeSignatureHelp?: SignatureHelp;
3605 3606
	}

J
Johannes Rieken 已提交
3607 3608
	/**
	 * The signature help provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
3609
	 * the [parameter hints](https://code.visualstudio.com/docs/editor/intellisense)-feature.
J
Johannes Rieken 已提交
3610
	 */
E
Erich Gamma 已提交
3611
	export interface SignatureHelpProvider {
J
Johannes Rieken 已提交
3612 3613 3614 3615 3616 3617 3618

		/**
		 * 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.
3619 3620
		 * @param context Information about how signature help was triggered.
		 *
J
Johannes Rieken 已提交
3621
		 * @return Signature help or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
3622
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
3623
		 */
3624 3625 3626 3627
		provideSignatureHelp(document: TextDocument, position: Position, token: CancellationToken, context: SignatureHelpContext): ProviderResult<SignatureHelp>;
	}

	/**
3628 3629
	 * Metadata about a registered [`SignatureHelpProvider`](#SignatureHelpProvider).
	 */
3630 3631 3632 3633 3634 3635 3636 3637 3638
	export interface SignatureHelpProviderMetadata {
		/**
		 * List of characters that trigger signature help.
		 */
		readonly triggerCharacters: ReadonlyArray<string>;

		/**
		 * List of characters that re-trigger signature help.
		 *
3639
		 * These trigger characters are only active when signature help is already showing. All trigger characters
3640 3641 3642
		 * are also counted as re-trigger characters.
		 */
		readonly retriggerCharacters: ReadonlyArray<string>;
E
Erich Gamma 已提交
3643 3644
	}

J
Johannes Rieken 已提交
3645 3646 3647
	/**
	 * Completion item kinds.
	 */
E
Erich Gamma 已提交
3648
	export enum CompletionItemKind {
3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664
		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,
3665
		Reference = 17,
3666
		File = 16,
3667 3668 3669 3670 3671
		Folder = 18,
		EnumMember = 19,
		Constant = 20,
		Struct = 21,
		Event = 22,
3672 3673
		Operator = 23,
		TypeParameter = 24
E
Erich Gamma 已提交
3674 3675
	}

3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686
	/**
	 * Completion item tags are extra annotations that tweak the rendering of a completion
	 * item.
	 */
	export enum CompletionItemTag {
		/**
		 * Render a completion as obsolete, usually using a strike-out.
		 */
		Deprecated = 1
	}

J
Johannes Rieken 已提交
3687
	/**
3688
	 * A completion item represents a text snippet that is proposed to complete text that is being typed.
J
Johannes Rieken 已提交
3689
	 *
3690
	 * It is sufficient to create a completion item from just a [label](#CompletionItem.label). In that
3691 3692
	 * case the completion item will replace the [word](#TextDocument.getWordRangeAtPosition)
	 * until the cursor with the given label or [insertText](#CompletionItem.insertText). Otherwise the
3693
	 * given [edit](#CompletionItem.textEdit) is used.
3694
	 *
3695
	 * When selecting a completion item in the editor its defined or synthesized text edit will be applied
M
Matthew J. Clemente 已提交
3696
	 * to *all* cursors/selections whereas [additionalTextEdits](#CompletionItem.additionalTextEdits) will be
3697
	 * applied as provided.
3698
	 *
J
Johannes Rieken 已提交
3699 3700
	 * @see [CompletionItemProvider.provideCompletionItems](#CompletionItemProvider.provideCompletionItems)
	 * @see [CompletionItemProvider.resolveCompletionItem](#CompletionItemProvider.resolveCompletionItem)
J
Johannes Rieken 已提交
3701
	 */
E
Erich Gamma 已提交
3702
	export class CompletionItem {
J
Johannes Rieken 已提交
3703 3704 3705

		/**
		 * The label of this completion item. By default
A
Andre Weinand 已提交
3706
		 * this is also the text that is inserted when selecting
J
Johannes Rieken 已提交
3707 3708
		 * this completion.
		 */
E
Erich Gamma 已提交
3709
		label: string;
J
Johannes Rieken 已提交
3710 3711

		/**
S
Steven Clarke 已提交
3712
		 * The kind of this completion item. Based on the kind
J
Johannes Rieken 已提交
3713 3714
		 * an icon is chosen by the editor.
		 */
3715
		kind?: CompletionItemKind;
J
Johannes Rieken 已提交
3716

3717 3718 3719 3720 3721
		/**
		 * Tags for this completion item.
		 */
		tags?: ReadonlyArray<CompletionItemTag>;

J
Johannes Rieken 已提交
3722 3723 3724 3725
		/**
		 * A human-readable string with additional information
		 * about this item, like type or symbol information.
		 */
3726
		detail?: string;
J
Johannes Rieken 已提交
3727 3728 3729 3730

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

		/**
A
Andre Weinand 已提交
3734
		 * A string that should be used when comparing this item
J
Johannes Rieken 已提交
3735 3736 3737
		 * with other items. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
3738
		sortText?: string;
J
Johannes Rieken 已提交
3739 3740 3741 3742 3743 3744

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

3747 3748 3749 3750 3751 3752 3753
		/**
		 * Select this item when showing. *Note* that only one completion item can be selected and
		 * that the editor decides which item that is. The rule is that the *first* item of those
		 * that match best is selected.
		 */
		preselect?: boolean;

J
Johannes Rieken 已提交
3754
		/**
3755
		 * A string or snippet that should be inserted in a document when selecting
J
Johannes Rieken 已提交
3756 3757 3758
		 * this completion. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
3759
		insertText?: string | SnippetString;
3760 3761

		/**
3762
		 * A range or a insert and replace range selecting the text that should be replaced by this completion item.
3763
		 *
3764 3765 3766
		 * When omitted, the range of the [current word](#TextDocument.getWordRangeAtPosition) is used as replace-range
		 * and as insert-range the start of the [current word](#TextDocument.getWordRangeAtPosition) to the
		 * current position is used.
3767
		 *
3768
		 * *Note 1:* A range must be a [single line](#Range.isSingleLine) and it must
3769
		 * [contain](#Range.contains) the position at which completion has been [requested](#CompletionItemProvider.provideCompletionItems).
3770
		 * *Note 2:* A insert range must be a prefix of a replace range, that means it must be contained and starting at the same position.
3771
		 */
3772
		range?: Range | { inserting: Range; replacing: Range; };
J
Johannes Rieken 已提交
3773

3774 3775
		/**
		 * An optional set of characters that when pressed while this completion is active will accept it first and
J
Johannes Rieken 已提交
3776
		 * then type that character. *Note* that all commit characters should have `length=1` and that superfluous
3777 3778 3779 3780
		 * characters will be ignored.
		 */
		commitCharacters?: string[];

3781 3782
		/**
		 * Keep whitespace of the [insertText](#CompletionItem.insertText) as is. By default, the editor adjusts leading
3783
		 * whitespace of new lines so that they match the indentation of the line for which the item is accepted - setting
3784 3785 3786 3787
		 * this to `true` will prevent that.
		 */
		keepWhitespace?: boolean;

J
Johannes Rieken 已提交
3788
		/**
3789
		 * @deprecated Use `CompletionItem.insertText` and `CompletionItem.range` instead.
3790 3791
		 *
		 * ~~An [edit](#TextEdit) which is applied to a document when selecting
J
Johannes Rieken 已提交
3792
		 * this completion. When an edit is provided the value of
3793
		 * [insertText](#CompletionItem.insertText) is ignored.~~
3794
		 *
3795 3796
		 * ~~The [range](#Range) of the edit must be single-line and on the same
		 * line completions were [requested](#CompletionItemProvider.provideCompletionItems) at.~~
J
Johannes Rieken 已提交
3797
		 */
3798
		textEdit?: TextEdit;
J
Johannes Rieken 已提交
3799

3800 3801 3802 3803 3804
		/**
		 * 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.
		 */
3805
		additionalTextEdits?: TextEdit[];
3806 3807

		/**
3808 3809
		 * An optional [command](#Command) that is executed *after* inserting this completion. *Note* that
		 * additional modifications to the current document should be described with the
3810 3811
		 * [additionalTextEdits](#CompletionItem.additionalTextEdits)-property.
		 */
3812
		command?: Command;
3813

J
Johannes Rieken 已提交
3814 3815 3816 3817 3818 3819 3820
		/**
		 * 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.
3821
		 * @param kind The [kind](#CompletionItemKind) of the completion.
J
Johannes Rieken 已提交
3822
		 */
3823
		constructor(label: string, kind?: CompletionItemKind);
E
Erich Gamma 已提交
3824 3825
	}

3826 3827 3828 3829
	/**
	 * Represents a collection of [completion items](#CompletionItem) to be presented
	 * in the editor.
	 */
J
Johannes Rieken 已提交
3830
	export class CompletionList {
3831 3832

		/**
3833
		 * This list is not complete. Further typing should result in recomputing
3834 3835
		 * this list.
		 */
3836
		isIncomplete?: boolean;
3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851

		/**
		 * 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 已提交
3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862
	/**
	 * How a [completion provider](#CompletionItemProvider) was triggered
	 */
	export enum CompletionTriggerKind {
		/**
		 * Completion was triggered normally.
		 */
		Invoke = 0,
		/**
		 * Completion was triggered by a trigger character.
		 */
3863 3864 3865 3866 3867
		TriggerCharacter = 1,
		/**
		 * Completion was re-triggered as current completion list is incomplete
		 */
		TriggerForIncompleteCompletions = 2
M
Matt Bierner 已提交
3868 3869
	}

3870 3871 3872 3873 3874
	/**
	 * Contains additional information about the context in which
	 * [completion provider](#CompletionItemProvider.provideCompletionItems) is triggered.
	 */
	export interface CompletionContext {
3875 3876 3877
		/**
		 * How the completion was triggered.
		 */
M
Matt Bierner 已提交
3878
		readonly triggerKind: CompletionTriggerKind;
3879

3880 3881 3882
		/**
		 * Character that triggered the completion item provider.
		 *
M
Matt Bierner 已提交
3883
		 * `undefined` if provider was not triggered by a character.
M
Matt Bierner 已提交
3884 3885
		 *
		 * The trigger character is already in the document when the completion provider is triggered.
3886 3887 3888 3889
		 */
		readonly triggerCharacter?: string;
	}

J
Johannes Rieken 已提交
3890 3891
	/**
	 * The completion item provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
3892
	 * [IntelliSense](https://code.visualstudio.com/docs/editor/intellisense).
J
Johannes Rieken 已提交
3893
	 *
3894 3895 3896
	 * Providers can delay the computation of the [`detail`](#CompletionItem.detail)
	 * and [`documentation`](#CompletionItem.documentation) properties by implementing the
	 * [`resolveCompletionItem`](#CompletionItemProvider.resolveCompletionItem)-function. However, properties that
3897
	 * are needed for the initial sorting and filtering, like `sortText`, `filterText`, `insertText`, and `range`, must
3898
	 * not be changed during resolve.
3899 3900 3901
	 *
	 * 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 已提交
3902
	 */
E
Erich Gamma 已提交
3903
	export interface CompletionItemProvider {
J
Johannes Rieken 已提交
3904 3905

		/**
J
Johannes Rieken 已提交
3906
		 * Provide completion items for the given position and document.
J
Johannes Rieken 已提交
3907
		 *
J
Johannes Rieken 已提交
3908 3909 3910
		 * @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 已提交
3911 3912
		 * @param context How the completion was triggered.
		 *
3913 3914
		 * @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 已提交
3915
		 */
M
Matt Bierner 已提交
3916
		provideCompletionItems(document: TextDocument, position: Position, token: CancellationToken, context: CompletionContext): ProviderResult<CompletionItem[] | CompletionList>;
J
Johannes Rieken 已提交
3917 3918

		/**
J
Johannes Rieken 已提交
3919 3920 3921 3922
		 * 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 已提交
3923
		 *
3924 3925 3926 3927
		 * *Note* that accepting a completion item will not wait for it to be resolved. Because of that [`insertText`](#CompletionItem.insertText),
		 * [`additionalTextEdits`](#CompletionItem.additionalTextEdits), and [`command`](#CompletionItem.command) should not
		 * be changed when resolving an item.
		 *
J
Johannes Rieken 已提交
3928 3929
		 * @param item A completion item currently active in the UI.
		 * @param token A cancellation token.
S
Steven Clarke 已提交
3930
		 * @return The resolved completion item or a thenable that resolves to of such. It is OK to return the given
J
Johannes Rieken 已提交
3931
		 * `item`. When no result is returned, the given `item` will be used.
J
Johannes Rieken 已提交
3932
		 */
3933
		resolveCompletionItem?(item: CompletionItem, token: CancellationToken): ProviderResult<CompletionItem>;
E
Erich Gamma 已提交
3934 3935
	}

J
Johannes Rieken 已提交
3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950

	/**
	 * 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.
		 */
3951
		target?: Uri;
J
Johannes Rieken 已提交
3952

M
Matt Bierner 已提交
3953 3954 3955 3956
		/**
		 * The tooltip text when you hover over this link.
		 *
		 * If a tooltip is provided, is will be displayed in a string that includes instructions on how to
3957
		 * trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS,
M
Matt Bierner 已提交
3958 3959 3960 3961
		 * user settings, and localization.
		 */
		tooltip?: string;

J
Johannes Rieken 已提交
3962 3963 3964 3965 3966 3967
		/**
		 * 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.
		 */
3968
		constructor(range: Range, target?: Uri);
J
Johannes Rieken 已提交
3969 3970 3971 3972 3973 3974 3975 3976 3977
	}

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

		/**
3978 3979 3980
		 * 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 已提交
3981 3982 3983
		 * @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
3984
		 * can be signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
3985
		 */
3986
		provideDocumentLinks(document: TextDocument, token: CancellationToken): ProviderResult<DocumentLink[]>;
3987 3988 3989

		/**
		 * Given a link fill in its [target](#DocumentLink.target). This method is called when an incomplete
3990
		 * link is selected in the UI. Providers can implement this method and return incomplete links
3991 3992 3993 3994 3995 3996
		 * (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.
		 */
3997
		resolveDocumentLink?(link: DocumentLink, token: CancellationToken): ProviderResult<DocumentLink>;
J
Johannes Rieken 已提交
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 4026 4027 4028 4029
	/**
	 * Represents a color in RGBA space.
	 */
	export class Color {

		/**
		 * The red component of this color in the range [0-1].
		 */
		readonly red: number;

		/**
		 * The green component of this color in the range [0-1].
		 */
		readonly green: number;

		/**
		 * The blue component of this color in the range [0-1].
		 */
		readonly blue: number;

		/**
		 * The alpha component of this color in the range [0-1].
		 */
		readonly alpha: number;

		/**
		 * Creates a new color instance.
		 *
		 * @param red The red component.
		 * @param green The green component.
4030
		 * @param blue The blue component.
4031 4032 4033 4034 4035 4036 4037 4038 4039
		 * @param alpha The alpha component.
		 */
		constructor(red: number, green: number, blue: number, alpha: number);
	}

	/**
	 * Represents a color range from a document.
	 */
	export class ColorInformation {
4040

4041
		/**
4042
		 * The range in the document where this color appears.
4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066
		 */
		range: Range;

		/**
		 * The actual color value for this color range.
		 */
		color: Color;

		/**
		 * Creates a new color range.
		 *
		 * @param range The range the color appears in. Must not be empty.
		 * @param color The value of the color.
		 * @param format The format in which this color is currently formatted.
		 */
		constructor(range: Range, color: Color);
	}

	/**
	 * A color presentation object describes how a [`color`](#Color) should be represented as text and what
	 * edits are required to refer to it from source code.
	 *
	 * For some languages one color can have multiple presentations, e.g. css can represent the color red with
	 * the constant `Red`, the hex-value `#ff0000`, or in rgba and hsla forms. In csharp other representations
4067
	 * apply, e.g. `System.Drawing.Color.Red`.
4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 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
	 */
	export class ColorPresentation {

		/**
		 * The label of this color presentation. It will be shown on the color
		 * picker header. By default this is also the text that is inserted when selecting
		 * this color presentation.
		 */
		label: string;

		/**
		 * An [edit](#TextEdit) which is applied to a document when selecting
		 * this presentation for the color.  When `falsy` the [label](#ColorPresentation.label)
		 * is used.
		 */
		textEdit?: TextEdit;

		/**
		 * An optional array of additional [text edits](#TextEdit) that are applied when
		 * selecting this color presentation. Edits must not overlap with the main [edit](#ColorPresentation.textEdit) nor with themselves.
		 */
		additionalTextEdits?: TextEdit[];

		/**
		 * Creates a new color presentation.
		 *
		 * @param label The label of this color presentation.
		 */
		constructor(label: string);
	}

	/**
	 * The document color provider defines the contract between extensions and feature of
	 * picking and modifying colors in the editor.
	 */
	export interface DocumentColorProvider {

		/**
		 * Provide colors for the given document.
		 *
		 * @param document The document in which the command was invoked.
		 * @param token A cancellation token.
4110
		 * @return An array of [color information](#ColorInformation) or a thenable that resolves to such. The lack of a result
4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125
		 * can be signaled by returning `undefined`, `null`, or an empty array.
		 */
		provideDocumentColors(document: TextDocument, token: CancellationToken): ProviderResult<ColorInformation[]>;

		/**
		 * Provide [representations](#ColorPresentation) for a color.
		 *
		 * @param color The color to show and insert.
		 * @param context A context object with additional information
		 * @param token A cancellation token.
		 * @return An array of color presentations or a thenable that resolves to such. The lack of a result
		 * can be signaled by returning `undefined`, `null`, or an empty array.
		 */
		provideColorPresentations(color: Color, context: { document: TextDocument, range: Range }, token: CancellationToken): ProviderResult<ColorPresentation[]>;
	}
4126

4127
	/**
F
Filipe Correia 已提交
4128
	 * A line based folding range. To be valid, start and end line must be bigger than zero and smaller than the number of lines in the document.
4129 4130
	 * Invalid ranges will be ignored.
	 */
4131 4132 4133 4134
	export class FoldingRange {

		/**
		 * The zero-based start line of the range to fold. The folded area starts after the line's last character.
4135
		 * To be valid, the end must be zero or larger and smaller than the number of lines in the document.
4136 4137 4138 4139 4140
		 */
		start: number;

		/**
		 * The zero-based end line of the range to fold. The folded area ends with the line's last character.
4141
		 * To be valid, the end must be zero or larger and smaller than the number of lines in the document.
4142 4143 4144 4145 4146 4147 4148
		 */
		end: number;

		/**
		 * Describes the [Kind](#FoldingRangeKind) of the folding range such as [Comment](#FoldingRangeKind.Comment) or
		 * [Region](#FoldingRangeKind.Region). The kind is used to categorize folding ranges and used by commands
		 * like 'Fold all comments'. See
4149
		 * [FoldingRangeKind](#FoldingRangeKind) for an enumeration of all kinds.
4150
		 * If not set, the range is originated from a syntax element.
4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163
		 */
		kind?: FoldingRangeKind;

		/**
		 * Creates a new folding range.
		 *
		 * @param start The start line of the folded range.
		 * @param end The end line of the folded range.
		 * @param kind The kind of the folding range.
		 */
		constructor(start: number, end: number, kind?: FoldingRangeKind);
	}

4164
	/**
4165 4166 4167 4168
	 * An enumeration of specific folding range kinds. The kind is an optional field of a [FoldingRange](#FoldingRange)
	 * and is used to distinguish specific folding ranges such as ranges originated from comments. The kind is used by commands like
	 * `Fold all comments` or `Fold all regions`.
	 * If the kind is not set on the range, the range originated from a syntax element other than comments, imports or region markers.
4169
	 */
4170
	export enum FoldingRangeKind {
4171
		/**
4172
		 * Kind for folding range representing a comment.
4173
		 */
4174
		Comment = 1,
4175
		/**
4176
		 * Kind for folding range representing a import.
4177
		 */
4178
		Imports = 2,
4179
		/**
4180
		 * Kind for folding range representing regions originating from folding markers like `#region` and `#endregion`.
4181
		 */
4182
		Region = 3
4183 4184 4185 4186 4187 4188 4189 4190
	}

	/**
	 * Folding context (for future use)
	 */
	export interface FoldingContext {
	}

4191 4192 4193 4194
	/**
	 * The folding range provider interface defines the contract between extensions and
	 * [Folding](https://code.visualstudio.com/docs/editor/codebasics#_folding) in the editor.
	 */
4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205
	export interface FoldingRangeProvider {
		/**
		 * Returns a list of folding ranges or null and undefined if the provider
		 * does not want to participate or was cancelled.
		 * @param document The document in which the command was invoked.
		 * @param context Additional context information (for future use)
		 * @param token A cancellation token.
		 */
		provideFoldingRanges(document: TextDocument, context: FoldingContext, token: CancellationToken): ProviderResult<FoldingRange[]>;
	}

4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234
	/**
	 * A selection range represents a part of a selection hierarchy. A selection range
	 * may have a parent selection range that contains it.
	 */
	export class SelectionRange {

		/**
		 * The [range](#Range) of this selection range.
		 */
		range: Range;

		/**
		 * The parent selection range containing this range.
		 */
		parent?: SelectionRange;

		/**
		 * Creates a new selection range.
		 *
		 * @param range The range of the selection range.
		 * @param parent The parent of the selection range.
		 */
		constructor(range: Range, parent?: SelectionRange);
	}

	export interface SelectionRangeProvider {
		/**
		 * Provide selection ranges for the given positions.
		 *
4235
		 * Selection ranges should be computed individually and independent for each position. The editor will merge
4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247
		 * and deduplicate ranges but providers must return hierarchies of selection ranges so that a range
		 * is [contained](#Range.contains) by its parent.
		 *
		 * @param document The document in which the command was invoked.
		 * @param positions The positions at which the command was invoked.
		 * @param token A cancellation token.
		 * @return Selection ranges or a thenable that resolves to such. The lack of a result can be
		 * signaled by returning `undefined` or `null`.
		 */
		provideSelectionRanges(document: TextDocument, positions: Position[], token: CancellationToken): ProviderResult<SelectionRange[]>;
	}

4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331
	/**
	 * Represents programming constructs like functions or constructors in the context
	 * of call hierarchy.
	 */
	export class CallHierarchyItem {
		/**
		 * The name of this item.
		 */
		name: string;

		/**
		 * The kind of this item.
		 */
		kind: SymbolKind;

		/**
		 * Tags for this item.
		 */
		tags?: ReadonlyArray<SymbolTag>;

		/**
		 * More detail for this item, e.g. the signature of a function.
		 */
		detail?: string;

		/**
		 * The resource identifier of this item.
		 */
		uri: Uri;

		/**
		 * The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.
		 */
		range: Range;

		/**
		 * The range that should be selected and revealed when this symbol is being picked, e.g. the name of a function.
		 * Must be contained by the [`range`](#CallHierarchyItem.range).
		 */
		selectionRange: Range;

		/**
		 * Creates a new call hierarchy item.
		 */
		constructor(kind: SymbolKind, name: string, detail: string, uri: Uri, range: Range, selectionRange: Range);
	}

	/**
	 * Represents an incoming call, e.g. a caller of a method or constructor.
	 */
	export class CallHierarchyIncomingCall {

		/**
		 * The item that makes the call.
		 */
		from: CallHierarchyItem;

		/**
		 * The range at which at which the calls appears. This is relative to the caller
		 * denoted by [`this.from`](#CallHierarchyIncomingCall.from).
		 */
		fromRanges: Range[];

		/**
		 * Create a new call object.
		 *
		 * @param item The item making the call.
		 * @param fromRanges The ranges at which the calls appear.
		 */
		constructor(item: CallHierarchyItem, fromRanges: Range[]);
	}

	/**
	 * Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc.
	 */
	export class CallHierarchyOutgoingCall {

		/**
		 * The item that is called.
		 */
		to: CallHierarchyItem;

		/**
		 * The range at which this item is called. This is the range relative to the caller, e.g the item
4332
		 * passed to [`provideCallHierarchyOutgoingCalls`](#CallHierarchyProvider.provideCallHierarchyOutgoingCalls)
4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363
		 * and not [`this.to`](#CallHierarchyOutgoingCall.to).
		 */
		fromRanges: Range[];

		/**
		 * Create a new call object.
		 *
		 * @param item The item being called
		 * @param fromRanges The ranges at which the calls appear.
		 */
		constructor(item: CallHierarchyItem, fromRanges: Range[]);
	}

	/**
	 * The call hierarchy provider interface describes the constract between extensions
	 * and the call hierarchy feature which allows to browse calls and caller of function,
	 * methods, constructor etc.
	 */
	export interface CallHierarchyProvider {

		/**
		 * Bootstraps call hierarchy by returning the item that is denoted by the given document
		 * and position. This item will be used as entry into the call graph. Providers should
		 * return `undefined` or `null` when there is no item at the given location.
		 *
		 * @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.
		 * @returns A call hierarchy item or a thenable that resolves to such. The lack of a result can be
		 * signaled by returning `undefined` or `null`.
		 */
S
Sandeep Somavarapu 已提交
4364
		prepareCallHierarchy(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<CallHierarchyItem | CallHierarchyItem[]>;
4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390

		/**
		 * Provide all incoming calls for an item, e.g all callers for a method. In graph terms this describes directed
		 * and annotated edges inside the call graph, e.g the given item is the starting node and the result is the nodes
		 * that can be reached.
		 *
		 * @param item The hierarchy item for which incoming calls should be computed.
		 * @param token A cancellation token.
		 * @returns A set of incoming calls or a thenable that resolves to such. The lack of a result can be
		 * signaled by returning `undefined` or `null`.
		 */
		provideCallHierarchyIncomingCalls(item: CallHierarchyItem, token: CancellationToken): ProviderResult<CallHierarchyIncomingCall[]>;

		/**
		 * Provide all outgoing calls for an item, e.g call calls to functions, methods, or constructors from the given item. In
		 * graph terms this describes directed and annotated edges inside the call graph, e.g the given item is the starting
		 * node and the result is the nodes that can be reached.
		 *
		 * @param item The hierarchy item for which outgoing calls should be computed.
		 * @param token A cancellation token.
		 * @returns A set of outgoing calls or a thenable that resolves to such. The lack of a result can be
		 * signaled by returning `undefined` or `null`.
		 */
		provideCallHierarchyOutgoingCalls(item: CallHierarchyItem, token: CancellationToken): ProviderResult<CallHierarchyOutgoingCall[]>;
	}

J
Johannes Rieken 已提交
4391 4392 4393 4394
	/**
	 * A tuple of two characters, like a pair of
	 * opening and closing brackets.
	 */
E
Erich Gamma 已提交
4395 4396
	export type CharacterPair = [string, string];

J
Johannes Rieken 已提交
4397 4398 4399
	/**
	 * Describes how comments for a language work.
	 */
E
Erich Gamma 已提交
4400
	export interface CommentRule {
J
Johannes Rieken 已提交
4401 4402 4403 4404

		/**
		 * The line comment token, like `// this is a comment`
		 */
E
Erich Gamma 已提交
4405
		lineComment?: string;
J
Johannes Rieken 已提交
4406 4407 4408 4409 4410

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

A
Alex Dima 已提交
4413 4414 4415
	/**
	 * Describes indentation rules for a language.
	 */
E
Erich Gamma 已提交
4416
	export interface IndentationRule {
A
Alex Dima 已提交
4417
		/**
4418
		 * If a line matches this pattern, then all the lines after it should be unindented once (until another rule matches).
A
Alex Dima 已提交
4419
		 */
E
Erich Gamma 已提交
4420
		decreaseIndentPattern: RegExp;
A
Alex Dima 已提交
4421 4422 4423
		/**
		 * If a line matches this pattern, then all the lines after it should be indented once (until another rule matches).
		 */
E
Erich Gamma 已提交
4424
		increaseIndentPattern: RegExp;
A
Alex Dima 已提交
4425 4426 4427
		/**
		 * If a line matches this pattern, then **only the next line** after it should be indented once.
		 */
E
Erich Gamma 已提交
4428
		indentNextLinePattern?: RegExp;
A
Alex Dima 已提交
4429 4430 4431
		/**
		 * 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 已提交
4432 4433 4434
		unIndentedLinePattern?: RegExp;
	}

A
Alex Dima 已提交
4435 4436 4437
	/**
	 * Describes what to do with the indentation when pressing Enter.
	 */
E
Erich Gamma 已提交
4438
	export enum IndentAction {
A
Alex Dima 已提交
4439 4440 4441
		/**
		 * Insert new line and copy the previous line's indentation.
		 */
4442
		None = 0,
A
Alex Dima 已提交
4443 4444 4445
		/**
		 * Insert new line and indent once (relative to the previous line's indentation).
		 */
4446
		Indent = 1,
A
Alex Dima 已提交
4447 4448 4449 4450 4451
		/**
		 * Insert two new lines:
		 *  - the first one indented which will hold the cursor
		 *  - the second one at the same indentation level
		 */
4452
		IndentOutdent = 2,
A
Alex Dima 已提交
4453 4454 4455
		/**
		 * Insert new line and outdent once (relative to the previous line's indentation).
		 */
4456
		Outdent = 3
E
Erich Gamma 已提交
4457 4458
	}

A
Alex Dima 已提交
4459 4460 4461
	/**
	 * Describes what to do when pressing Enter.
	 */
E
Erich Gamma 已提交
4462
	export interface EnterAction {
A
Alex Dima 已提交
4463 4464 4465 4466 4467 4468 4469
		/**
		 * 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 已提交
4470
		appendText?: string;
A
Alex Dima 已提交
4471 4472 4473 4474
		/**
		 * Describes the number of characters to remove from the new line's indentation.
		 */
		removeText?: number;
E
Erich Gamma 已提交
4475 4476
	}

A
Alex Dima 已提交
4477 4478 4479
	/**
	 * Describes a rule to be evaluated when pressing Enter.
	 */
E
Erich Gamma 已提交
4480
	export interface OnEnterRule {
A
Alex Dima 已提交
4481 4482 4483
		/**
		 * This rule will only execute if the text before the cursor matches this regular expression.
		 */
E
Erich Gamma 已提交
4484
		beforeText: RegExp;
A
Alex Dima 已提交
4485 4486 4487
		/**
		 * This rule will only execute if the text after the cursor matches this regular expression.
		 */
E
Erich Gamma 已提交
4488
		afterText?: RegExp;
A
Alex Dima 已提交
4489 4490 4491
		/**
		 * The action to execute.
		 */
E
Erich Gamma 已提交
4492 4493 4494
		action: EnterAction;
	}

J
Johannes Rieken 已提交
4495
	/**
A
Andre Weinand 已提交
4496
	 * The language configuration interfaces defines the contract between extensions
S
Steven Clarke 已提交
4497
	 * and various editor features, like automatic bracket insertion, automatic indentation etc.
J
Johannes Rieken 已提交
4498
	 */
E
Erich Gamma 已提交
4499
	export interface LanguageConfiguration {
A
Alex Dima 已提交
4500 4501 4502
		/**
		 * The language's comment settings.
		 */
E
Erich Gamma 已提交
4503
		comments?: CommentRule;
A
Alex Dima 已提交
4504 4505 4506 4507
		/**
		 * The language's brackets.
		 * This configuration implicitly affects pressing Enter around these brackets.
		 */
E
Erich Gamma 已提交
4508
		brackets?: CharacterPair[];
A
Alex Dima 已提交
4509 4510 4511 4512 4513 4514 4515
		/**
		 * 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 已提交
4516
		wordPattern?: RegExp;
A
Alex Dima 已提交
4517 4518 4519
		/**
		 * The language's indentation settings.
		 */
E
Erich Gamma 已提交
4520
		indentationRules?: IndentationRule;
A
Alex Dima 已提交
4521 4522 4523
		/**
		 * The language's rules to be evaluated when pressing Enter.
		 */
E
Erich Gamma 已提交
4524 4525 4526
		onEnterRules?: OnEnterRule[];

		/**
A
Alex Dima 已提交
4527
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
4528 4529
		 *
		 * @deprecated Will be replaced by a better API soon.
E
Erich Gamma 已提交
4530 4531
		 */
		__electricCharacterSupport?: {
4532 4533 4534 4535 4536 4537
			/**
			 * This property is deprecated and will be **ignored** from
			 * the editor.
			 * @deprecated
			 */
			brackets?: any;
4538 4539 4540
			/**
			 * This property is deprecated and not fully supported anymore by
			 * the editor (scope and lineStart are ignored).
4541
			 * Use the autoClosingPairs property in the language configuration file instead.
4542 4543
			 * @deprecated
			 */
E
Erich Gamma 已提交
4544
			docComment?: {
A
Alex Dima 已提交
4545 4546 4547 4548
				scope: string;
				open: string;
				lineStart: string;
				close?: string;
E
Erich Gamma 已提交
4549 4550 4551 4552
			};
		};

		/**
A
Alex Dima 已提交
4553
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
4554
		 *
4555
		 * @deprecated * Use the autoClosingPairs property in the language configuration file instead.
E
Erich Gamma 已提交
4556 4557 4558 4559 4560 4561 4562 4563 4564 4565
		 */
		__characterPairSupport?: {
			autoClosingPairs: {
				open: string;
				close: string;
				notIn?: string[];
			}[];
		};
	}

J
Johannes Rieken 已提交
4566
	/**
S
Sandeep Somavarapu 已提交
4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587
	 * 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
4588
	 *
S
Sandeep Somavarapu 已提交
4589 4590 4591 4592 4593
	 * - *Default Settings*
	 * - *Global (User) Settings*
	 * - *Workspace settings*
	 * - *Workspace Folder settings* - From one of the [Workspace Folders](#workspace.workspaceFolders) under which requested resource belongs to.
	 * - *Language settings* - Settings defined under requested language.
S
Sandeep Somavarapu 已提交
4594
	 *
S
Sandeep Somavarapu 已提交
4595
	 * The *effective* value (returned by [`get`](#WorkspaceConfiguration.get)) is computed by overriding or merging the values in the following order.
S
Sandeep Somavarapu 已提交
4596
	 *
S
Sandeep Somavarapu 已提交
4597 4598 4599 4600 4601 4602 4603 4604
	 * ```
	 * `defaultValue`
	 * `globalValue` (if defined)
	 * `workspaceValue` (if defined)
	 * `workspaceFolderValue` (if defined)
	 * `defaultLanguageValue` (if defined)
	 * `globalLanguageValue` (if defined)
	 * `workspaceLanguageValue` (if defined)
S
fix doc  
Sandeep Somavarapu 已提交
4605
	 * `workspaceFolderLanguageValue` (if defined)
S
Sandeep Somavarapu 已提交
4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616
	 * ```
	 * **Note:** Only `object` value types are merged and all other value types are overridden.
	 *
	 * Example 1: Overriding
	 *
	 * ```ts
	 * defaultValue = 'on';
	 * globalValue = 'relative'
	 * workspaceFolderValue = 'off'
	 * value = 'off'
	 * ```
S
Sandeep Somavarapu 已提交
4617
	 *
S
Sandeep Somavarapu 已提交
4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634
	 * Example 2: Language Values
	 *
	 * ```ts
	 * defaultValue = 'on';
	 * globalValue = 'relative'
	 * workspaceFolderValue = 'off'
	 * globalLanguageValue = 'on'
	 * value = 'on'
	 * ```
	 *
	 * Example 3: Object Values
	 *
	 * ```ts
	 * defaultValue = { "a": 1, "b": 2 };
	 * globalValue = { "b": 3, "c": 4 };
	 * value = { "a": 1, "b": 3, "c": 4 };
	 * ```
S
Sandeep Somavarapu 已提交
4635 4636
	 *
	 * *Note:* Workspace and Workspace Folder configurations contains `launch` and `tasks` settings. Their basename will be
4637 4638 4639
	 * part of the section identifier. The following snippets shows how to retrieve all configurations
	 * from `launch.json`:
	 *
4640
	 * ```ts
D
Daniel Imms 已提交
4641
	 * // launch.json configuration
S
Sandeep Somavarapu 已提交
4642
	 * const config = workspace.getConfiguration('launch', vscode.workspace.workspaceFolders[0].uri);
4643 4644
	 *
	 * // retrieve values
D
Daniel Imms 已提交
4645 4646
	 * const values = config.get('configurations');
	 * ```
S
Sandeep Somavarapu 已提交
4647 4648
	 *
	 * Refer to [Settings](https://code.visualstudio.com/docs/getstarted/settings) for more information.
J
Johannes Rieken 已提交
4649
	 */
E
Erich Gamma 已提交
4650 4651
	export interface WorkspaceConfiguration {

4652 4653 4654 4655 4656 4657 4658 4659
		/**
		 * 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 已提交
4660
		/**
J
Johannes Rieken 已提交
4661 4662 4663
		 * Return a value from this configuration.
		 *
		 * @param section Configuration name, supports _dotted_ names.
J
Johannes Rieken 已提交
4664
		 * @param defaultValue A value should be returned when no value could be found, is `undefined`.
J
Johannes Rieken 已提交
4665
		 * @return The value `section` denotes or the default.
E
Erich Gamma 已提交
4666
		 */
4667 4668
		get<T>(section: string, defaultValue: T): T;

E
Erich Gamma 已提交
4669
		/**
J
Johannes Rieken 已提交
4670 4671
		 * Check if this configuration has a certain value.
		 *
4672
		 * @param section Configuration name, supports _dotted_ names.
G
Gama11 已提交
4673
		 * @return `true` if the section doesn't resolve to `undefined`.
E
Erich Gamma 已提交
4674 4675 4676
		 */
		has(section: string): boolean;

4677 4678
		/**
		 * Retrieve all information about a configuration setting. A configuration value
S
Sandeep Somavarapu 已提交
4679
		 * often consists of a *default* value, a global or installation-wide value,
S
Sandeep Somavarapu 已提交
4680 4681
		 * a workspace-specific value, folder-specific value
		 * and language-specific values (if [WorkspaceConfiguration](#WorkspaceConfiguration) is scoped to a language).
S
Sandeep Somavarapu 已提交
4682
		 *
S
Sandeep Somavarapu 已提交
4683
		 * Also provides all language ids under which the given configuration setting is defined.
4684 4685 4686 4687 4688 4689 4690
		 *
		 * *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 已提交
4691 4692 4693 4694 4695 4696 4697 4698 4699
		inspect<T>(section: string): {
			key: string;

			defaultValue?: T;
			globalValue?: T;
			workspaceValue?: T,
			workspaceFolderValue?: T,

			defaultLanguageValue?: T;
S
Sandeep Somavarapu 已提交
4700
			globalLanguageValue?: T;
S
Sandeep Somavarapu 已提交
4701 4702 4703 4704 4705 4706
			workspaceLanguageValue?: T;
			workspaceFolderLanguageValue?: T;

			languageIds?: string[];

		} | undefined;
S
Sandeep Somavarapu 已提交
4707 4708

		/**
S
Sandeep Somavarapu 已提交
4709
		 * Update a configuration value. The updated configuration values are persisted.
S
Sandeep Somavarapu 已提交
4710
		 *
S
Sandeep Somavarapu 已提交
4711
		 * A value can be changed in
S
Sandeep Somavarapu 已提交
4712
		 *
S
Sandeep Somavarapu 已提交
4713 4714 4715 4716
		 * - [Global settings](#ConfigurationTarget.Global): Changes the value for all instances of the editor.
		 * - [Workspace settings](#ConfigurationTarget.Workspace): Changes the value for current workspace, if available.
		 * - [Workspace folder settings](#ConfigurationTarget.WorkspaceFolder): Changes the value for settings from one of the [Workspace Folders](#workspace.workspaceFolders) under which the requested resource belongs to.
		 * - Language settings: Changes the value for the requested languageId.
S
Sandeep Somavarapu 已提交
4717
		 *
S
Sandeep Somavarapu 已提交
4718
		 * *Note:* To remove a configuration value use `undefined`, like so: `config.update('somekey', undefined)`
S
Sandeep Somavarapu 已提交
4719
		 *
4720 4721
		 * @param section Configuration name, supports _dotted_ names.
		 * @param value The new value.
S
Sandeep Somavarapu 已提交
4722
		 * @param configurationTarget The [configuration target](#ConfigurationTarget) or a boolean value.
S
Sandeep Somavarapu 已提交
4723 4724 4725 4726
		 *	- If `true` updates [Global settings](#ConfigurationTarget.Global).
		 *	- If `false` updates [Workspace settings](#ConfigurationTarget.Workspace).
		 *	- If `undefined` or `null` updates to [Workspace folder settings](#ConfigurationTarget.WorkspaceFolder) if configuration is resource specific,
		 * 	otherwise to [Workspace settings](#ConfigurationTarget.Workspace).
S
Sandeep Somavarapu 已提交
4727
		 * @param overrideInLanguage Whether to update the value in the scope of requested languageId or not.
S
Sandeep Somavarapu 已提交
4728 4729 4730 4731 4732 4733 4734 4735 4736
		 *	- If `true` updates the value under the requested languageId.
		 *	- If `undefined` updates the value under the requested languageId only if the configuration is defined for the language.
		 * @throws error while updating
		 *	- configuration which is not registered.
		 *	- window configuration to workspace folder
		 *	- configuration to workspace or workspace folder when no workspace is opened.
		 *	- configuration to workspace folder when there is no workspace folder settings.
		 *	- configuration to workspace folder when [WorkspaceConfiguration](#WorkspaceConfiguration) is not scoped to a resource.
		 */
S
Sandeep Somavarapu 已提交
4737
		update(section: string, value: any, configurationTarget?: ConfigurationTarget | boolean, overrideInLanguage?: boolean): Thenable<void>;
4738

E
Erich Gamma 已提交
4739 4740 4741
		/**
		 * Readable dictionary that backs this configuration.
		 */
4742
		readonly [key: string]: any;
E
Erich Gamma 已提交
4743 4744
	}

J
Johannes Rieken 已提交
4745 4746 4747 4748 4749
	/**
	 * Represents a location inside a resource, such as a line
	 * inside a text file.
	 */
	export class Location {
J
Johannes Rieken 已提交
4750 4751 4752 4753

		/**
		 * The resource identifier of this location.
		 */
J
Johannes Rieken 已提交
4754
		uri: Uri;
J
Johannes Rieken 已提交
4755 4756

		/**
A
Andre Weinand 已提交
4757
		 * The document range of this location.
J
Johannes Rieken 已提交
4758
		 */
J
Johannes Rieken 已提交
4759
		range: Range;
J
Johannes Rieken 已提交
4760 4761 4762 4763 4764 4765 4766 4767

		/**
		 * 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 已提交
4768 4769
	}

4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798
	/**
	 * Represents the connection of two locations. Provides additional metadata over normal [locations](#Location),
	 * including an origin range.
	 */
	export interface LocationLink {
		/**
		 * Span of the origin of this link.
		 *
		 * Used as the underlined span for mouse definition hover. Defaults to the word range at
		 * the definition position.
		 */
		originSelectionRange?: Range;

		/**
		 * The target resource identifier of this link.
		 */
		targetUri: Uri;

		/**
		 * The full target range of this link.
		 */
		targetRange: Range;

		/**
		 * The span of this link.
		 */
		targetSelectionRange?: Range;
	}

4799 4800 4801 4802 4803 4804 4805 4806
	/**
	 * The event that is fired when diagnostics change.
	 */
	export interface DiagnosticChangeEvent {

		/**
		 * An array of resources for which diagnostics have changed.
		 */
4807
		readonly uris: ReadonlyArray<Uri>;
4808 4809
	}

E
Erich Gamma 已提交
4810 4811 4812 4813
	/**
	 * Represents the severity of diagnostics.
	 */
	export enum DiagnosticSeverity {
J
Johannes Rieken 已提交
4814 4815

		/**
S
Steven Clarke 已提交
4816
		 * Something not allowed by the rules of a language or other means.
J
Johannes Rieken 已提交
4817 4818 4819 4820 4821 4822
		 */
		Error = 0,

		/**
		 * Something suspicious but allowed.
		 */
E
Erich Gamma 已提交
4823
		Warning = 1,
J
Johannes Rieken 已提交
4824 4825 4826 4827 4828 4829 4830

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

		/**
A
Andre Weinand 已提交
4831
		 * Something to hint to a better way of doing it, like proposing
J
Johannes Rieken 已提交
4832 4833 4834
		 * a refactoring.
		 */
		Hint = 3
E
Erich Gamma 已提交
4835 4836
	}

4837 4838
	/**
	 * Represents a related message and source code location for a diagnostic. This should be
4839
	 * used to point to code locations that cause or related to a diagnostics, e.g. when duplicating
4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862
	 * a symbol in a scope.
	 */
	export class DiagnosticRelatedInformation {

		/**
		 * The location of this related diagnostic information.
		 */
		location: Location;

		/**
		 * The message of this related diagnostic information.
		 */
		message: string;

		/**
		 * Creates a new related diagnostic information object.
		 *
		 * @param location The location.
		 * @param message The message.
		 */
		constructor(location: Location, message: string);
	}

4863 4864 4865 4866 4867 4868 4869 4870 4871
	/**
	 * Additional metadata about the type of a diagnostic.
	 */
	export enum DiagnosticTag {
		/**
		 * Unused or unnecessary code.
		 *
		 * Diagnostics with this tag are rendered faded out. The amount of fading
		 * is controlled by the `"editorUnnecessaryCode.opacity"` theme color. For
M
Matt Bierner 已提交
4872
		 * example, `"editorUnnecessaryCode.opacity": "#000000c0"` will render the
4873
		 * code with 75% opacity. For high contrast themes, use the
M
Matt Bierner 已提交
4874
		 * `"editorUnnecessaryCode.border"` theme color to underline unnecessary code
4875 4876 4877
		 * instead of fading it out.
		 */
		Unnecessary = 1,
4878 4879 4880 4881 4882 4883 4884

		/**
		 * Deprecated or obsolete code.
		 *
		 * Diagnostics with this tag are rendered with a strike through.
		 */
		Deprecated = 2,
4885 4886
	}

E
Erich Gamma 已提交
4887
	/**
J
Johannes Rieken 已提交
4888 4889
	 * Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
	 * are only valid in the scope of a file.
E
Erich Gamma 已提交
4890
	 */
J
Johannes Rieken 已提交
4891 4892 4893 4894 4895
	export class Diagnostic {

		/**
		 * The range to which this diagnostic applies.
		 */
E
Erich Gamma 已提交
4896
		range: Range;
J
Johannes Rieken 已提交
4897 4898 4899 4900 4901 4902

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

4903
		/**
J
Johannes Rieken 已提交
4904
		 * The severity, default is [error](#DiagnosticSeverity.Error).
4905
		 */
J
Johannes Rieken 已提交
4906
		severity: DiagnosticSeverity;
4907

J
Johannes Rieken 已提交
4908
		/**
J
Johannes Rieken 已提交
4909 4910
		 * A human-readable string describing the source of this
		 * diagnostic, e.g. 'typescript' or 'super lint'.
J
Johannes Rieken 已提交
4911
		 */
J
Johannes Rieken 已提交
4912
		source?: string;
J
Johannes Rieken 已提交
4913 4914

		/**
S
Sandeep Somavarapu 已提交
4915 4916
		 * A code or identifier for this diagnostic.
		 * Should be used for later processing, e.g. when providing [code actions](#CodeActionContext).
J
Johannes Rieken 已提交
4917
		 */
P
Pine Wu 已提交
4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929
		code?: string | number | {
			/**
			 * A code or identifier for this diagnostic.
			 * Should be used for later processing, e.g. when providing [code actions](#CodeActionContext).
			 */
			value: string | number;

			/**
			 * A target URI to open with more information about the diagnostic error.
			 */
			target: Uri;
		};
J
Johannes Rieken 已提交
4930

4931 4932 4933 4934
		/**
		 * An array of related diagnostic information, e.g. when symbol-names within
		 * a scope collide all definitions can be marked via this property.
		 */
J
Johannes Rieken 已提交
4935
		relatedInformation?: DiagnosticRelatedInformation[];
4936

4937 4938 4939 4940 4941
		/**
		 * Additional metadata about the diagnostic.
		 */
		tags?: DiagnosticTag[];

J
Johannes Rieken 已提交
4942
		/**
A
Andre Weinand 已提交
4943
		 * Creates a new diagnostic object.
J
Johannes Rieken 已提交
4944 4945 4946
		 *
		 * @param range The range to which this diagnostic applies.
		 * @param message The human-readable message.
A
Andre Weinand 已提交
4947
		 * @param severity The severity, default is [error](#DiagnosticSeverity.Error).
J
Johannes Rieken 已提交
4948 4949
		 */
		constructor(range: Range, message: string, severity?: DiagnosticSeverity);
E
Erich Gamma 已提交
4950 4951
	}

J
Johannes Rieken 已提交
4952 4953 4954
	/**
	 * A diagnostics collection is a container that manages a set of
	 * [diagnostics](#Diagnostic). Diagnostics are always scopes to a
4955
	 * diagnostics collection and a resource.
J
Johannes Rieken 已提交
4956 4957 4958 4959
	 *
	 * To get an instance of a `DiagnosticCollection` use
	 * [createDiagnosticCollection](#languages.createDiagnosticCollection).
	 */
E
Erich Gamma 已提交
4960 4961 4962
	export interface DiagnosticCollection {

		/**
J
Johannes Rieken 已提交
4963 4964 4965
		 * 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 已提交
4966
		 */
Y
Yuki Ueda 已提交
4967
		readonly name: string;
E
Erich Gamma 已提交
4968 4969 4970

		/**
		 * Assign diagnostics for given resource. Will replace
J
Johannes Rieken 已提交
4971 4972 4973 4974
		 * existing diagnostics for that resource.
		 *
		 * @param uri A resource identifier.
		 * @param diagnostics Array of diagnostics or `undefined`
E
Erich Gamma 已提交
4975
		 */
4976
		set(uri: Uri, diagnostics: ReadonlyArray<Diagnostic> | undefined): void;
E
Erich Gamma 已提交
4977 4978

		/**
4979
		 * Replace all entries in this collection.
J
Johannes Rieken 已提交
4980
		 *
4981 4982 4983 4984 4985 4986
		 * 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 已提交
4987
		 */
4988
		set(entries: ReadonlyArray<[Uri, ReadonlyArray<Diagnostic> | undefined]>): void;
E
Erich Gamma 已提交
4989 4990

		/**
4991 4992
		 * Remove all diagnostics from this collection that belong
		 * to the provided `uri`. The same as `#set(uri, undefined)`.
J
Johannes Rieken 已提交
4993
		 *
4994
		 * @param uri A resource identifier.
E
Erich Gamma 已提交
4995
		 */
4996
		delete(uri: Uri): void;
E
Erich Gamma 已提交
4997 4998 4999 5000 5001 5002 5003

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

5004 5005 5006 5007 5008 5009
		/**
		 * 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.
		 */
5010
		forEach(callback: (uri: Uri, diagnostics: ReadonlyArray<Diagnostic>, collection: DiagnosticCollection) => any, thisArg?: any): void;
5011

5012 5013 5014 5015 5016
		/**
		 * Get the diagnostics for a given resource. *Note* that you cannot
		 * modify the diagnostics-array returned from this call.
		 *
		 * @param uri A resource identifier.
5017
		 * @returns An immutable array of [diagnostics](#Diagnostic) or `undefined`.
5018
		 */
5019
		get(uri: Uri): ReadonlyArray<Diagnostic> | undefined;
5020 5021 5022 5023 5024 5025 5026 5027 5028 5029

		/**
		 * 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 已提交
5030 5031 5032 5033
		/**
		 * Dispose and free associated resources. Calls
		 * [clear](#DiagnosticCollection.clear).
		 */
E
Erich Gamma 已提交
5034 5035 5036
		dispose(): void;
	}

J
Johannes Rieken 已提交
5037
	/**
5038 5039 5040
	 * Denotes a location of an editor in the window. Editors can be arranged in a grid
	 * and each column represents one editor location in that grid by counting the editors
	 * in order of their appearance.
J
Johannes Rieken 已提交
5041 5042
	 */
	export enum ViewColumn {
J
Johannes Rieken 已提交
5043
		/**
5044 5045 5046
		 * A *symbolic* editor column representing the currently active column. This value
		 * can be used when opening editors, but the *resolved* [viewColumn](#TextEditor.viewColumn)-value
		 * of editors will always be `One`, `Two`, `Three`,... or `undefined` but never `Active`.
J
Johannes Rieken 已提交
5047
		 */
5048
		Active = -1,
5049 5050 5051 5052 5053 5054
		/**
		 * A *symbolic* editor column representing the column to the side of the active one. This value
		 * can be used when opening editors, but the *resolved* [viewColumn](#TextEditor.viewColumn)-value
		 * of editors will always be `One`, `Two`, `Three`,... or `undefined` but never `Beside`.
		 */
		Beside = -2,
J
Johannes Rieken 已提交
5055
		/**
5056
		 * The first editor column.
J
Johannes Rieken 已提交
5057
		 */
J
Johannes Rieken 已提交
5058
		One = 1,
J
Johannes Rieken 已提交
5059
		/**
5060
		 * The second editor column.
J
Johannes Rieken 已提交
5061
		 */
J
Johannes Rieken 已提交
5062
		Two = 2,
J
Johannes Rieken 已提交
5063
		/**
5064
		 * The third editor column.
J
Johannes Rieken 已提交
5065
		 */
5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090
		Three = 3,
		/**
		 * The fourth editor column.
		 */
		Four = 4,
		/**
		 * The fifth editor column.
		 */
		Five = 5,
		/**
		 * The sixth editor column.
		 */
		Six = 6,
		/**
		 * The seventh editor column.
		 */
		Seven = 7,
		/**
		 * The eighth editor column.
		 */
		Eight = 8,
		/**
		 * The ninth editor column.
		 */
		Nine = 9
J
Johannes Rieken 已提交
5091 5092
	}

E
Erich Gamma 已提交
5093
	/**
J
Johannes Rieken 已提交
5094 5095 5096
	 * An output channel is a container for readonly textual information.
	 *
	 * To get an instance of an `OutputChannel` use
S
Sandeep Somavarapu 已提交
5097
	 * [createOutputChannel](#window.createOutputChannel).
E
Erich Gamma 已提交
5098
	 */
J
Johannes Rieken 已提交
5099
	export interface OutputChannel {
E
Erich Gamma 已提交
5100

J
Johannes Rieken 已提交
5101 5102 5103
		/**
		 * The human-readable name of this output channel.
		 */
Y
Yuki Ueda 已提交
5104
		readonly name: string;
E
Erich Gamma 已提交
5105 5106

		/**
J
Johannes Rieken 已提交
5107
		 * Append the given value to the channel.
E
Erich Gamma 已提交
5108
		 *
J
Johannes Rieken 已提交
5109
		 * @param value A string, falsy values will not be printed.
E
Erich Gamma 已提交
5110
		 */
J
Johannes Rieken 已提交
5111
		append(value: string): void;
E
Erich Gamma 已提交
5112 5113

		/**
J
Johannes Rieken 已提交
5114 5115
		 * Append the given value and a line feed character
		 * to the channel.
E
Erich Gamma 已提交
5116
		 *
J
Johannes Rieken 已提交
5117
		 * @param value A string, falsy values will be printed.
E
Erich Gamma 已提交
5118 5119 5120
		 */
		appendLine(value: string): void;

J
Johannes Rieken 已提交
5121 5122 5123
		/**
		 * Removes all output from the channel.
		 */
E
Erich Gamma 已提交
5124 5125
		clear(): void;

J
Johannes Rieken 已提交
5126 5127
		/**
		 * Reveal this channel in the UI.
5128
		 *
5129
		 * @param preserveFocus When `true` the channel will not take focus.
J
Johannes Rieken 已提交
5130
		 */
J
Johannes Rieken 已提交
5131
		show(preserveFocus?: boolean): void;
E
Erich Gamma 已提交
5132

5133
		/**
5134
		 * ~~Reveal this channel in the UI.~~
5135
		 *
5136
		 * @deprecated Use the overload with just one parameter (`show(preserveFocus?: boolean): void`).
J
Johannes Rieken 已提交
5137 5138
		 *
		 * @param column This argument is **deprecated** and will be ignored.
5139 5140
		 * @param preserveFocus When `true` the channel will not take focus.
		 */
J
Johannes Rieken 已提交
5141
		show(column?: ViewColumn, preserveFocus?: boolean): void;
5142

J
Johannes Rieken 已提交
5143 5144 5145
		/**
		 * Hide this channel from the UI.
		 */
E
Erich Gamma 已提交
5146 5147
		hide(): void;

J
Johannes Rieken 已提交
5148 5149 5150
		/**
		 * Dispose and free associated resources.
		 */
E
Erich Gamma 已提交
5151 5152 5153 5154
		dispose(): void;
	}

	/**
J
Johannes Rieken 已提交
5155
	 * Represents the alignment of status bar items.
E
Erich Gamma 已提交
5156 5157
	 */
	export enum StatusBarAlignment {
J
Johannes Rieken 已提交
5158 5159 5160 5161

		/**
		 * Aligned to the left side.
		 */
5162
		Left = 1,
J
Johannes Rieken 已提交
5163 5164 5165 5166

		/**
		 * Aligned to the right side.
		 */
5167
		Right = 2
E
Erich Gamma 已提交
5168 5169 5170 5171 5172 5173 5174 5175 5176
	}

	/**
	 * 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 已提交
5177
		 * The alignment of this item.
E
Erich Gamma 已提交
5178
		 */
Y
Yuki Ueda 已提交
5179
		readonly alignment: StatusBarAlignment;
E
Erich Gamma 已提交
5180 5181

		/**
J
Johannes Rieken 已提交
5182 5183
		 * The priority of this item. Higher value means the item should
		 * be shown more to the left.
E
Erich Gamma 已提交
5184
		 */
5185
		readonly priority?: number;
E
Erich Gamma 已提交
5186 5187

		/**
J
Johannes Rieken 已提交
5188 5189
		 * The text to show for the entry. You can embed icons in the text by leveraging the syntax:
		 *
J
Johannes Rieken 已提交
5190
		 * `My text $(icon-name) contains icons like $(icon-name) this one.`
J
Johannes Rieken 已提交
5191
		 *
5192
		 * Where the icon-name is taken from the [codicon](https://microsoft.github.io/vscode-codicons/dist/codicon.html) icon set, e.g.
5193
		 * `light-bulb`, `thumbsup`, `zap` etc.
J
Johannes Rieken 已提交
5194
		 */
E
Erich Gamma 已提交
5195 5196 5197
		text: string;

		/**
J
Johannes Rieken 已提交
5198 5199
		 * The tooltip text when you hover over this entry.
		 */
5200
		tooltip: string | undefined;
E
Erich Gamma 已提交
5201 5202

		/**
J
Johannes Rieken 已提交
5203 5204
		 * The foreground color for this entry.
		 */
5205
		color: string | ThemeColor | undefined;
E
Erich Gamma 已提交
5206 5207

		/**
5208 5209 5210
		 * [`Command`](#Command) or identifier of a command to run on click.
		 *
		 * The command must be [known](#commands.getCommands).
5211 5212 5213
		 *
		 * Note that if this is a [`Command`](#Command) object, only the [`command`](#Command.command) and [`arguments`](#Command.arguments)
		 * are used by VS Code.
J
Johannes Rieken 已提交
5214
		 */
5215
		command: string | Command | undefined;
E
Erich Gamma 已提交
5216 5217 5218 5219 5220 5221 5222

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

		/**
J
Johannes Rieken 已提交
5223
		 * Hide the entry in the status bar.
E
Erich Gamma 已提交
5224 5225 5226 5227
		 */
		hide(): void;

		/**
J
Johannes Rieken 已提交
5228 5229
		 * Dispose and free associated resources. Call
		 * [hide](#StatusBarItem.hide).
E
Erich Gamma 已提交
5230 5231 5232 5233
		 */
		dispose(): void;
	}

5234 5235 5236 5237 5238 5239 5240
	/**
	 * Defines a generalized way of reporting progress updates.
	 */
	export interface Progress<T> {

		/**
		 * Report a progress update.
5241 5242
		 * @param value A progress item, like a message and/or an
		 * report on how much work finished
5243
		 */
J
Johannes Rieken 已提交
5244
		report(value: T): void;
5245 5246
	}

D
Daniel Imms 已提交
5247 5248 5249
	/**
	 * An individual terminal instance within the integrated terminal.
	 */
D
Daniel Imms 已提交
5250
	export interface Terminal {
D
Daniel Imms 已提交
5251

5252 5253 5254
		/**
		 * The name of the terminal.
		 */
Y
Yuki Ueda 已提交
5255
		readonly name: string;
5256

5257 5258 5259
		/**
		 * The process ID of the shell process.
		 */
5260
		readonly processId: Thenable<number | undefined>;
5261

5262 5263 5264 5265 5266 5267 5268
		/**
		 * The object used to initialize the terminal, this is useful for example to detecting the
		 * shell type of when the terminal was not launched by this extension or for detecting what
		 * folder the shell was launched in.
		 */
		readonly creationOptions: Readonly<TerminalOptions | ExtensionTerminalOptions>;

5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283
		/**
		 * The exit status of the terminal, this will be undefined while the terminal is active.
		 *
		 * **Example:** Show a notification with the exit code when the terminal exits with a
		 * non-zero exit code.
		 * ```typescript
		 * window.onDidCloseTerminal(t => {
		 *   if (t.exitStatus && t.exitStatus.code) {
		 *   	vscode.window.showInformationMessage(`Exit code: ${t.exitStatus.code}`);
		 *   }
		 * });
		 * ```
		 */
		readonly exitStatus: TerminalExitStatus | undefined;

D
Daniel Imms 已提交
5284
		/**
D
Daniel Imms 已提交
5285
		 * Send text to the terminal. The text is written to the stdin of the underlying pty process
5286
		 * (shell) of the terminal.
D
Daniel Imms 已提交
5287
		 *
D
Daniel Imms 已提交
5288
		 * @param text The text to send.
D
Daniel Imms 已提交
5289
		 * @param addNewLine Whether to add a new line to the text being sent, this is normally
5290 5291
		 * 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 已提交
5292
		 */
5293
		sendText(text: string, addNewLine?: boolean): void;
D
Daniel Imms 已提交
5294 5295

		/**
D
Daniel Imms 已提交
5296
		 * Show the terminal panel and reveal this terminal in the UI.
D
Daniel Imms 已提交
5297
		 *
D
Daniel Imms 已提交
5298
		 * @param preserveFocus When `true` the terminal will not take focus.
D
Daniel Imms 已提交
5299
		 */
D
Daniel Imms 已提交
5300
		show(preserveFocus?: boolean): void;
D
Daniel Imms 已提交
5301 5302

		/**
D
Daniel Imms 已提交
5303
		 * Hide the terminal panel if this terminal is currently showing.
D
Daniel Imms 已提交
5304 5305 5306 5307 5308 5309 5310
		 */
		hide(): void;

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

J
Johannes Rieken 已提交
5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329
	/**
	 * In a remote window the extension kind describes if an extension
	 * runs where the UI (window) runs or if an extension runs remotely.
	 */
	export enum ExtensionKind {

		/**
		 * Extension runs where the UI runs.
		 */
		UI = 1,

		/**
		 * Extension runs where the remote extension host runs.
		 */
		Workspace = 2
	}

J
Johannes Rieken 已提交
5330 5331 5332
	/**
	 * Represents an extension.
	 *
A
Alex Dima 已提交
5333
	 * To get an instance of an `Extension` use [getExtension](#extensions.getExtension).
J
Johannes Rieken 已提交
5334
	 */
E
Erich Gamma 已提交
5335
	export interface Extension<T> {
J
Johannes Rieken 已提交
5336

E
Erich Gamma 已提交
5337
		/**
J
Johannes Rieken 已提交
5338
		 * The canonical extension identifier in the form of: `publisher.name`.
E
Erich Gamma 已提交
5339
		 */
Y
Yuki Ueda 已提交
5340
		readonly id: string;
E
Erich Gamma 已提交
5341 5342

		/**
J
Johannes Rieken 已提交
5343
		 * The absolute file path of the directory containing this extension.
E
Erich Gamma 已提交
5344
		 */
Y
Yuki Ueda 已提交
5345
		readonly extensionPath: string;
E
Erich Gamma 已提交
5346 5347

		/**
5348
		 * `true` if the extension has been activated.
E
Erich Gamma 已提交
5349
		 */
Y
Yuki Ueda 已提交
5350
		readonly isActive: boolean;
E
Erich Gamma 已提交
5351 5352 5353 5354

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

J
Johannes Rieken 已提交
5357 5358 5359
		/**
		 * The extension kind describes if an extension runs where the UI runs
		 * or if an extension runs where the remote extension host runs. The extension kind
J
Johannes Rieken 已提交
5360
		 * is defined in the `package.json`-file of extensions but can also be refined
R
ryenus 已提交
5361
		 * via the `remote.extensionKind`-setting. When no remote extension host exists,
J
Johannes Rieken 已提交
5362 5363 5364 5365
		 * the value is [`ExtensionKind.UI`](#ExtensionKind.UI).
		 */
		extensionKind: ExtensionKind;

E
Erich Gamma 已提交
5366
		/**
A
Alex Dima 已提交
5367
		 * The public API exported by this extension. It is an invalid action
J
Johannes Rieken 已提交
5368
		 * to access this field before this extension has been activated.
E
Erich Gamma 已提交
5369
		 */
Y
Yuki Ueda 已提交
5370
		readonly exports: T;
E
Erich Gamma 已提交
5371 5372 5373

		/**
		 * Activates this extension and returns its public API.
J
Johannes Rieken 已提交
5374
		 *
S
Steven Clarke 已提交
5375
		 * @return A promise that will resolve when this extension has been activated.
E
Erich Gamma 已提交
5376 5377 5378 5379
		 */
		activate(): Thenable<T>;
	}

J
Johannes Rieken 已提交
5380
	/**
S
Steven Clarke 已提交
5381 5382
	 * An extension context is a collection of utilities private to an
	 * extension.
J
Johannes Rieken 已提交
5383
	 *
S
Steven Clarke 已提交
5384
	 * An instance of an `ExtensionContext` is provided as the first
J
Johannes Rieken 已提交
5385 5386
	 * parameter to the `activate`-call of an extension.
	 */
E
Erich Gamma 已提交
5387 5388 5389 5390
	export interface ExtensionContext {

		/**
		 * An array to which disposables can be added. When this
J
Johannes Rieken 已提交
5391
		 * extension is deactivated the disposables will be disposed.
E
Erich Gamma 已提交
5392
		 */
5393
		readonly subscriptions: { dispose(): any }[];
E
Erich Gamma 已提交
5394 5395 5396

		/**
		 * A memento object that stores state in the context
5397
		 * of the currently opened [workspace](#workspace.workspaceFolders).
E
Erich Gamma 已提交
5398
		 */
5399
		readonly workspaceState: Memento;
E
Erich Gamma 已提交
5400 5401 5402

		/**
		 * A memento object that stores state independent
5403
		 * of the current opened [workspace](#workspace.workspaceFolders).
E
Erich Gamma 已提交
5404
		 */
5405
		readonly globalState: Memento;
E
Erich Gamma 已提交
5406 5407

		/**
J
Johannes Rieken 已提交
5408
		 * The absolute file path of the directory containing the extension.
E
Erich Gamma 已提交
5409
		 */
5410
		readonly extensionPath: string;
E
Erich Gamma 已提交
5411 5412

		/**
A
Alex Dima 已提交
5413 5414 5415 5416
		 * 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 已提交
5417 5418
		 */
		asAbsolutePath(relativePath: string): string;
D
Dirk Baeumer 已提交
5419 5420

		/**
J
Johannes Rieken 已提交
5421 5422 5423
		 * 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 已提交
5424
		 *
5425 5426
		 * Use [`workspaceState`](#ExtensionContext.workspaceState) or
		 * [`globalState`](#ExtensionContext.globalState) to store key value data.
D
Dirk Baeumer 已提交
5427
		 */
5428
		readonly storagePath: string | undefined;
5429

S
Sandeep Somavarapu 已提交
5430
		/**
5431
		 * An absolute file path in which the extension can store global state.
S
Sandeep Somavarapu 已提交
5432 5433 5434 5435 5436
		 * The directory might not exist on disk and creation is
		 * up to the extension. However, the parent directory is guaranteed to be existent.
		 *
		 * Use [`globalState`](#ExtensionContext.globalState) to store key value data.
		 */
5437
		readonly globalStoragePath: string;
S
Sandeep Somavarapu 已提交
5438

5439 5440 5441 5442 5443
		/**
		 * An absolute file path of a directory in which the extension can create log files.
		 * The directory might not exist on disk and creation is up to the extension. However,
		 * the parent directory is guaranteed to be existent.
		 */
5444
		readonly logPath: string;
E
Erich Gamma 已提交
5445 5446 5447 5448 5449 5450 5451 5452
	}

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

5453 5454 5455 5456 5457 5458 5459 5460
		/**
		 * Return a value.
		 *
		 * @param key A string.
		 * @return The stored value or `undefined`.
		 */
		get<T>(key: string): T | undefined;

E
Erich Gamma 已提交
5461
		/**
J
Johannes Rieken 已提交
5462 5463 5464 5465 5466
		 * 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.
5467
		 * @return The stored value or the defaultValue.
E
Erich Gamma 已提交
5468
		 */
5469
		get<T>(key: string, defaultValue: T): T;
E
Erich Gamma 已提交
5470 5471

		/**
S
Steven Clarke 已提交
5472
		 * Store a value. The value must be JSON-stringifyable.
J
Johannes Rieken 已提交
5473 5474 5475
		 *
		 * @param key A string.
		 * @param value A value. MUST not contain cyclic references.
E
Erich Gamma 已提交
5476 5477 5478 5479
		 */
		update(key: string, value: any): Thenable<void>;
	}

5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549
	/**
	 * 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;
5550 5551 5552 5553

		/**
		 * Controls whether to show the "Terminal will be reused by tasks, press any key to close it" message.
		 */
D
Dirk Baeumer 已提交
5554
		showReuseMessage?: boolean;
A
Alex Ross 已提交
5555 5556 5557 5558 5559

		/**
		 * Controls whether the terminal is cleared before executing the task.
		 */
		clear?: boolean;
5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570
	}

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

		/**
		 * The clean task group;
		 */
J
Johannes Rieken 已提交
5571
		static Clean: TaskGroup;
5572 5573 5574 5575

		/**
		 * The build task group;
		 */
J
Johannes Rieken 已提交
5576
		static Build: TaskGroup;
5577 5578 5579 5580

		/**
		 * The rebuild all task group;
		 */
J
Johannes Rieken 已提交
5581
		static Rebuild: TaskGroup;
5582 5583 5584 5585

		/**
		 * The test all task group;
		 */
J
Johannes Rieken 已提交
5586
		static Test: TaskGroup;
5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597

		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 {
		/**
5598
		 * The task definition describing the task provided by an extension.
5599 5600 5601 5602 5603 5604 5605 5606 5607
		 * 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;
		 * }
		 * ```
5608 5609 5610
		 *
		 * Note that type identifier starting with a '$' are reserved for internal
		 * usages and shouldn't be used by extensions.
5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638
		 */
		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 };
	}

	/**
5639
	 * The execution of a task happens as an external process
5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677
	 * 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;
	}

5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709
	/**
	 * The shell quoting options.
	 */
	export interface ShellQuotingOptions {

		/**
		 * The character used to do character escaping. If a string is provided only spaces
		 * are escaped. If a `{ escapeChar, charsToEscape }` literal is provide all characters
		 * in `charsToEscape` are escaped using the `escapeChar`.
		 */
		escape?: string | {
			/**
			 * The escape character.
			 */
			escapeChar: string;
			/**
			 * The characters to escape.
			 */
			charsToEscape: string;
		};

		/**
		 * The character used for strong quoting. The string's length must be 1.
		 */
		strong?: string;

		/**
		 * The character used for weak quoting. The string's length must be 1.
		 */
		weak?: string;
	}

5710 5711 5712 5713 5714 5715 5716 5717 5718 5719
	/**
	 * Options for a shell execution
	 */
	export interface ShellExecutionOptions {
		/**
		 * The shell executable.
		 */
		executable?: string;

		/**
D
Dirk Baeumer 已提交
5720 5721 5722 5723
		 * The arguments to be passed to the shell executable used to run the task. Most shells
		 * require special arguments to execute a command. For  example `bash` requires the `-c`
		 * argument to execute a command, `PowerShell` requires `-Command` and `cmd` requires both
		 * `/d` and `/c`.
5724 5725 5726
		 */
		shellArgs?: string[];

5727 5728 5729 5730 5731
		/**
		 * The shell quotes supported by this shell.
		 */
		shellQuoting?: ShellQuotingOptions;

5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745
		/**
		 * 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 };
	}

5746 5747
	/**
	 * Defines how an argument should be quoted if it contains
5748
	 * spaces or unsupported characters.
5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790
	 */
	export enum ShellQuoting {

		/**
		 * Character escaping should be used. This for example
		 * uses \ on bash and ` on PowerShell.
		 */
		Escape = 1,

		/**
		 * Strong string quoting should be used. This for example
		 * uses " for Windows cmd and ' for bash and PowerShell.
		 * Strong quoting treats arguments as literal strings.
		 * Under PowerShell echo 'The value is $(2 * 3)' will
		 * print `The value is $(2 * 3)`
		 */
		Strong = 2,

		/**
		 * Weak string quoting should be used. This for example
		 * uses " for Windows cmd, bash and PowerShell. Weak quoting
		 * still performs some kind of evaluation inside the quoted
		 * string.  Under PowerShell echo "The value is $(2 * 3)"
		 * will print `The value is 6`
		 */
		Weak = 3
	}

	/**
	 * A string that will be quoted depending on the used shell.
	 */
	export interface ShellQuotedString {
		/**
		 * The actual string value.
		 */
		value: string;

		/**
		 * The quoting style to use.
		 */
		quoting: ShellQuoting;
	}
5791 5792 5793

	export class ShellExecution {
		/**
5794
		 * Creates a shell execution with a full command line.
5795 5796 5797 5798 5799 5800 5801
		 *
		 * @param commandLine The command line to execute.
		 * @param options Optional options for the started the shell.
		 */
		constructor(commandLine: string, options?: ShellExecutionOptions);

		/**
5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814
		 * Creates a shell execution with a command and arguments. For the real execution VS Code will
		 * construct a command line from the command and the arguments. This is subject to interpretation
		 * especially when it comes to quoting. If full control over the command line is needed please
		 * use the constructor that creates a `ShellExecution` with the full command line.
		 *
		 * @param command The command to execute.
		 * @param args The command arguments.
		 * @param options Optional options for the started the shell.
		 */
		constructor(command: string | ShellQuotedString, args: (string | ShellQuotedString)[], options?: ShellExecutionOptions);

		/**
		 * The shell command line. Is `undefined` if created with a command and arguments.
5815
		 */
5816
		commandLine: string | undefined;
5817

5818 5819 5820 5821 5822 5823 5824 5825 5826 5827
		/**
		 * The shell command. Is `undefined` if created with a full command line.
		 */
		command: string | ShellQuotedString;

		/**
		 * The shell args. Is `undefined` if created with a full command line.
		 */
		args: (string | ShellQuotedString)[];

5828 5829 5830 5831 5832 5833 5834
		/**
		 * The shell options used when the command line is executed in a shell.
		 * Defaults to undefined.
		 */
		options?: ShellExecutionOptions;
	}

A
Alex Ross 已提交
5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850
	/**
	 * Class used to execute an extension callback as a task.
	 */
	export class CustomExecution {
		/**
		 * Constructs a CustomExecution task object. The callback will be executed the task is run, at which point the
		 * extension should return the Pseudoterminal it will "run in". The task should wait to do further execution until
		 * [Pseudoterminal.open](#Pseudoterminal.open) is called. Task cancellation should be handled using
		 * [Pseudoterminal.close](#Pseudoterminal.close). When the task is complete fire
		 * [Pseudoterminal.onDidClose](#Pseudoterminal.onDidClose).
		 * @param process The [Pseudoterminal](#Pseudoterminal) to be used by the task to display output.
		 * @param callback The callback that will be called when the task is started by a user.
		 */
		constructor(callback: () => Thenable<Pseudoterminal>);
	}

D
Dirk Baeumer 已提交
5851 5852 5853 5854 5855
	/**
	 * The scope of a task.
	 */
	export enum TaskScope {
		/**
5856
		 * The task is a global task. Global tasks are currrently not supported.
D
Dirk Baeumer 已提交
5857 5858 5859 5860 5861 5862 5863 5864 5865
		 */
		Global = 1,

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

5866 5867 5868 5869 5870 5871 5872 5873 5874 5875
	/**
	 * Run options for a task.
	 */
	export interface RunOptions {
		/**
		 * Controls whether task variables are re-evaluated on rerun.
		 */
		reevaluateOnRerun?: boolean;
	}

5876 5877 5878 5879 5880 5881
	/**
	 * A task to execute
	 */
	export class Task {

		/**
5882
		 * Creates a new task.
D
Dirk Baeumer 已提交
5883
		 *
5884
		 * @param definition The task definition as defined in the taskDefinitions extension point.
5885
		 * @param scope Specifies the task's scope. It is either a global or a workspace task or a task for a specific workspace folder. Global tasks are currently not supported.
D
Dirk Baeumer 已提交
5886
		 * @param name The task's name. Is presented in the user interface.
5887 5888 5889 5890 5891 5892
		 * @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.
		 */
A
Alex Ross 已提交
5893
		constructor(taskDefinition: TaskDefinition, scope: WorkspaceFolder | TaskScope.Global | TaskScope.Workspace, name: string, source: string, execution?: ProcessExecution | ShellExecution | CustomExecution, problemMatchers?: string | string[]);
5894

D
Dirk Baeumer 已提交
5895
		/**
5896 5897
		 * ~~Creates a new task.~~
		 *
5898
		 * @deprecated Use the new constructors that allow specifying a scope for the task.
D
Dirk Baeumer 已提交
5899 5900 5901 5902 5903 5904 5905 5906 5907
		 *
		 * @param definition The task definition as defined in the taskDefinitions extension point.
		 * @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.
		 */
5908
		constructor(taskDefinition: TaskDefinition, name: string, source: string, execution?: ProcessExecution | ShellExecution, problemMatchers?: string | string[]);
D
Dirk Baeumer 已提交
5909

5910 5911 5912 5913 5914
		/**
		 * The task's definition.
		 */
		definition: TaskDefinition;

D
Dirk Baeumer 已提交
5915
		/**
D
Dirk Baeumer 已提交
5916
		 * The task's scope.
D
Dirk Baeumer 已提交
5917
		 */
5918
		readonly scope?: TaskScope.Global | TaskScope.Workspace | WorkspaceFolder;
D
Dirk Baeumer 已提交
5919

5920 5921 5922 5923 5924 5925 5926 5927
		/**
		 * The task's name
		 */
		name: string;

		/**
		 * The task's execution engine
		 */
A
Alex Ross 已提交
5928
		execution?: ProcessExecution | ShellExecution | CustomExecution;
5929 5930 5931 5932 5933 5934 5935

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

		/**
5936 5937
		 * A human-readable string describing the source of this shell task, e.g. 'gulp'
		 * or 'npm'. Supports rendering of [theme icons](#ThemeIcon) via the `$(<name>)`-syntax.
5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958
		 */
		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[];
5959 5960 5961 5962 5963

		/**
		 * Run options for the task
		 */
		runOptions: RunOptions;
5964 5965 5966 5967
	}

	/**
	 * A task provider allows to add tasks to the task service.
D
Dirk Baeumer 已提交
5968
	 * A task provider is registered via #tasks.registerTaskProvider.
5969 5970 5971 5972 5973 5974 5975 5976 5977 5978
	 */
	export interface TaskProvider {
		/**
		 * Provides tasks.
		 * @param token A cancellation token.
		 * @return an array of tasks
		 */
		provideTasks(token?: CancellationToken): ProviderResult<Task[]>;

		/**
5979
		 * Resolves a task that has no [`execution`](#Task.execution) set. Tasks are
D
Dirk Baeumer 已提交
5980
		 * often created from information found in the `tasks.json`-file. Such tasks miss
5981
		 * the information on how to execute them and a task provider must fill in
D
Dirk Baeumer 已提交
5982 5983 5984 5985
		 * the missing information in the `resolveTask`-method. This method will not be
		 * called for tasks returned from the above `provideTasks` method since those
		 * tasks are always fully resolved. A valid default implementation for the
		 * `resolveTask` method is to return `undefined`.
5986
		 *
5987 5988
		 * @param task The task to resolve.
		 * @param token A cancellation token.
5989
		 * @return The resolved task
5990 5991 5992 5993
		 */
		resolveTask(task: Task, token?: CancellationToken): ProviderResult<Task>;
	}

D
Dirk Baeumer 已提交
5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020
	/**
	 * An object representing an executed Task. It can be used
	 * to terminate a task.
	 *
	 * This interface is not intended to be implemented.
	 */
	export interface TaskExecution {
		/**
		 * The task that got started.
		 */
		task: Task;

		/**
		 * Terminates the task execution.
		 */
		terminate(): void;
	}

	/**
	 * An event signaling the start of a task execution.
	 *
	 * This interface is not intended to be implemented.
	 */
	interface TaskStartEvent {
		/**
		 * The task item representing the task that got started.
		 */
6021
		readonly execution: TaskExecution;
D
Dirk Baeumer 已提交
6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032
	}

	/**
	 * An event signaling the end of an executed task.
	 *
	 * This interface is not intended to be implemented.
	 */
	interface TaskEndEvent {
		/**
		 * The task item representing the task that finished.
		 */
6033
		readonly execution: TaskExecution;
D
Dirk Baeumer 已提交
6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044
	}

	/**
	 * An event signaling the start of a process execution
	 * triggered through a task
	 */
	export interface TaskProcessStartEvent {

		/**
		 * The task execution for which the process got started.
		 */
6045
		readonly execution: TaskExecution;
D
Dirk Baeumer 已提交
6046 6047 6048 6049

		/**
		 * The underlying process id.
		 */
6050
		readonly processId: number;
D
Dirk Baeumer 已提交
6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061
	}

	/**
	 * An event signaling the end of a process execution
	 * triggered through a task
	 */
	export interface TaskProcessEndEvent {

		/**
		 * The task execution for which the process got started.
		 */
6062
		readonly execution: TaskExecution;
D
Dirk Baeumer 已提交
6063 6064 6065 6066

		/**
		 * The process's exit code.
		 */
6067
		readonly exitCode: number;
D
Dirk Baeumer 已提交
6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101
	}

	export interface TaskFilter {
		/**
		 * The task version as used in the tasks.json file.
		 * The string support the package.json semver notation.
		 */
		version?: string;

		/**
		 * The task type to return;
		 */
		type?: string;
	}

	/**
	 * Namespace for tasks functionality.
	 */
	export namespace tasks {

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

		/**
		 * Fetches all tasks available in the systems. This includes tasks
		 * from `tasks.json` files as well as tasks from task providers
		 * contributed through extensions.
		 *
J
Johannes Rieken 已提交
6102
		 * @param filter Optional filter to select tasks of a certain type or version.
D
Dirk Baeumer 已提交
6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116
		 */
		export function fetchTasks(filter?: TaskFilter): Thenable<Task[]>;

		/**
		 * Executes a task that is managed by VS Code. The returned
		 * task execution can be used to terminate the task.
		 *
		 * @param task the task to execute
		 */
		export function executeTask(task: Task): Thenable<TaskExecution>;

		/**
		 * The currently active task executions or an empty array.
		 */
6117
		export const taskExecutions: ReadonlyArray<TaskExecution>;
D
Dirk Baeumer 已提交
6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143

		/**
		 * Fires when a task starts.
		 */
		export const onDidStartTask: Event<TaskStartEvent>;

		/**
		 * Fires when a task ends.
		 */
		export const onDidEndTask: Event<TaskEndEvent>;

		/**
		 * Fires when the underlying process has been started.
		 * This event will not fire for tasks that don't
		 * execute an underlying process.
		 */
		export const onDidStartTaskProcess: Event<TaskProcessStartEvent>;

		/**
		 * Fires when the underlying process has ended.
		 * This event will not fire for tasks that don't
		 * execute an underlying process.
		 */
		export const onDidEndTaskProcess: Event<TaskProcessEndEvent>;
	}

6144
	/**
6145
	 * Enumeration of file types. The types `File` and `Directory` can also be
S
Sandeep Somavarapu 已提交
6146
	 * a symbolic links, in that case use `FileType.File | FileType.SymbolicLink` and
6147
	 * `FileType.Directory | FileType.SymbolicLink`.
6148
	 */
6149 6150 6151 6152 6153
	export enum FileType {
		/**
		 * The file type is unknown.
		 */
		Unknown = 0,
6154
		/**
6155
		 * A regular file.
6156
		 */
6157 6158 6159 6160 6161 6162 6163 6164 6165 6166
		File = 1,
		/**
		 * A directory.
		 */
		Directory = 2,
		/**
		 * A symbolic link to a file.
		 */
		SymbolicLink = 64
	}
6167

6168
	/**
6169
	 * The `FileStat`-type represents metadata about a file
6170 6171
	 */
	export interface FileStat {
6172
		/**
6173 6174
		 * The type of the file, e.g. is a regular file, a directory, or symbolic link
		 * to a file.
S
Sandeep Somavarapu 已提交
6175 6176
		 *
		 * *Note:* This value might be a bitmask, e.g. `FileType.File | FileType.SymbolicLink`.
6177
		 */
6178
		type: FileType;
6179
		/**
6180
		 * The creation timestamp in milliseconds elapsed since January 1, 1970 00:00:00 UTC.
6181
		 */
6182
		ctime: number;
6183
		/**
6184
		 * The modification timestamp in milliseconds elapsed since January 1, 1970 00:00:00 UTC.
6185 6186 6187 6188
		 *
		 * *Note:* If the file changed, it is important to provide an updated `mtime` that advanced
		 * from the previous value. Otherwise there may be optimizations in place that will not show
		 * the updated file contents in an editor for example.
6189 6190 6191 6192
		 */
		mtime: number;
		/**
		 * The size in bytes.
6193 6194 6195 6196
		 *
		 * *Note:* If the file changed, it is important to provide an updated `size`. Otherwise there
		 * may be optimizations in place that will not show the updated file contents in an editor for
		 * example.
6197 6198 6199 6200 6201 6202 6203
		 */
		size: number;
	}

	/**
	 * A type that filesystem providers should use to signal errors.
	 *
D
David Linskey 已提交
6204 6205
	 * This class has factory methods for common error-cases, like `FileNotFound` when
	 * a file or folder doesn't exist, use them like so: `throw vscode.FileSystemError.FileNotFound(someUri);`
6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233
	 */
	export class FileSystemError extends Error {

		/**
		 * Create an error to signal that a file or folder wasn't found.
		 * @param messageOrUri Message or uri.
		 */
		static FileNotFound(messageOrUri?: string | Uri): FileSystemError;

		/**
		 * Create an error to signal that a file or folder already exists, e.g. when
		 * creating but not overwriting a file.
		 * @param messageOrUri Message or uri.
		 */
		static FileExists(messageOrUri?: string | Uri): FileSystemError;

		/**
		 * Create an error to signal that a file is not a folder.
		 * @param messageOrUri Message or uri.
		 */
		static FileNotADirectory(messageOrUri?: string | Uri): FileSystemError;

		/**
		 * Create an error to signal that a file is a folder.
		 * @param messageOrUri Message or uri.
		 */
		static FileIsADirectory(messageOrUri?: string | Uri): FileSystemError;

6234 6235 6236 6237 6238 6239
		/**
		 * Create an error to signal that an operation lacks required permissions.
		 * @param messageOrUri Message or uri.
		 */
		static NoPermissions(messageOrUri?: string | Uri): FileSystemError;

6240 6241 6242 6243 6244 6245 6246
		/**
		 * Create an error to signal that the file system is unavailable or too busy to
		 * complete a request.
		 * @param messageOrUri Message or uri.
		 */
		static Unavailable(messageOrUri?: string | Uri): FileSystemError;

6247 6248 6249 6250 6251 6252
		/**
		 * Creates a new filesystem error.
		 *
		 * @param messageOrUri Message or uri.
		 */
		constructor(messageOrUri?: string | Uri);
6253 6254 6255 6256 6257 6258 6259 6260

		/**
		 * A code that identifies this error.
		 *
		 * Possible values are names of errors, like [`FileNotFound`](#FileSystemError.FileNotFound),
		 * or `Unknown` for unspecified errors.
		 */
		readonly code: string;
6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291
	}

	/**
	 * Enumeration of file change types.
	 */
	export enum FileChangeType {

		/**
		 * The contents or metadata of a file have changed.
		 */
		Changed = 1,

		/**
		 * A file has been created.
		 */
		Created = 2,

		/**
		 * A file has been deleted.
		 */
		Deleted = 3,
	}

	/**
	 * The event filesystem providers must use to signal a file change.
	 */
	export interface FileChangeEvent {

		/**
		 * The type of change.
		 */
6292
		readonly type: FileChangeType;
6293 6294 6295 6296

		/**
		 * The uri of the file that has changed.
		 */
6297
		readonly uri: Uri;
6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308
	}

	/**
	 * The filesystem provider defines what the editor needs to read, write, discover,
	 * and to manage files and folders. It allows extensions to serve files from remote places,
	 * like ftp-servers, and to seamlessly integrate those into the editor.
	 *
	 * * *Note 1:* The filesystem provider API works with [uris](#Uri) and assumes hierarchical
	 * paths, e.g. `foo:/my/path` is a child of `foo:/my/` and a parent of `foo:/my/path/deeper`.
	 * * *Note 2:* There is an activation event `onFileSystem:<scheme>` that fires when a file
	 * or folder is being accessed.
J
Johannes Rieken 已提交
6309 6310
	 * * *Note 3:* The word 'file' is often used to denote all [kinds](#FileType) of files, e.g.
	 * folders, symbolic links, and regular files.
6311 6312 6313 6314 6315
	 */
	export interface FileSystemProvider {

		/**
		 * An event to signal that a resource has been created, changed, or deleted. This
6316
		 * event should fire for resources that are being [watched](#FileSystemProvider.watch)
6317
		 * by clients of this provider.
6318 6319 6320 6321 6322
		 *
		 * *Note:* It is important that the metadata of the file that changed provides an
		 * updated `mtime` that advanced from the previous value in the [stat](#FileStat) and a
		 * correct `size` value. Otherwise there may be optimizations in place that will not show
		 * the change in an editor for example.
6323
		 */
6324
		readonly onDidChangeFile: Event<FileChangeEvent[]>;
6325 6326 6327

		/**
		 * Subscribe to events in the file or folder denoted by `uri`.
J
Johannes Rieken 已提交
6328 6329 6330 6331 6332
		 *
		 * The editor will call this function for files and folders. In the latter case, the
		 * options differ from defaults, e.g. what files/folders to exclude from watching
		 * and if subfolders, sub-subfolder, etc. should be watched (`recursive`).
		 *
6333 6334
		 * @param uri The uri of the file to be watched.
		 * @param options Configures the watch.
J
Johannes Rieken 已提交
6335
		 * @returns A disposable that tells the provider to stop watching the `uri`.
6336
		 */
6337
		watch(uri: Uri, options: { recursive: boolean; excludes: string[] }): Disposable;
6338 6339

		/**
6340
		 * Retrieve metadata about a file.
6341
		 *
6342 6343 6344 6345
		 * Note that the metadata for symbolic links should be the metadata of the file they refer to.
		 * Still, the [SymbolicLink](#FileType.SymbolicLink)-type must be used in addition to the actual type, e.g.
		 * `FileType.SymbolicLink | FileType.Directory`.
		 *
J
Johannes Rieken 已提交
6346
		 * @param uri The uri of the file to retrieve metadata about.
6347
		 * @return The file metadata about the file.
6348
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `uri` doesn't exist.
6349
		 */
6350
		stat(uri: Uri): FileStat | Thenable<FileStat>;
6351 6352

		/**
J
Johannes Rieken 已提交
6353
		 * Retrieve all entries of a [directory](#FileType.Directory).
6354 6355
		 *
		 * @param uri The uri of the folder.
6356 6357
		 * @return An array of name/type-tuples or a thenable that resolves to such.
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `uri` doesn't exist.
6358
		 */
6359
		readDirectory(uri: Uri): [string, FileType][] | Thenable<[string, FileType][]>;
6360 6361

		/**
J
Johannes Rieken 已提交
6362
		 * Create a new directory (Note, that new files are created via `write`-calls).
6363
		 *
6364
		 * @param uri The uri of the new folder.
J
Johannes Rieken 已提交
6365
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when the parent of `uri` doesn't exist, e.g. no mkdirp-logic required.
6366
		 * @throws [`FileExists`](#FileSystemError.FileExists) when `uri` already exists.
6367
		 * @throws [`NoPermissions`](#FileSystemError.NoPermissions) when permissions aren't sufficient.
6368
		 */
6369
		createDirectory(uri: Uri): void | Thenable<void>;
6370 6371 6372 6373 6374

		/**
		 * Read the entire contents of a file.
		 *
		 * @param uri The uri of the file.
6375 6376
		 * @return An array of bytes or a thenable that resolves to such.
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `uri` doesn't exist.
6377
		 */
6378
		readFile(uri: Uri): Uint8Array | Thenable<Uint8Array>;
6379 6380 6381 6382 6383 6384

		/**
		 * Write data to a file, replacing its entire contents.
		 *
		 * @param uri The uri of the file.
		 * @param content The new content of the file.
J
Johannes Rieken 已提交
6385
		 * @param options Defines if missing files should or must be created.
6386
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `uri` doesn't exist and `create` is not set.
J
Johannes Rieken 已提交
6387
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when the parent of `uri` doesn't exist and `create` is set, e.g. no mkdirp-logic required.
J
Johannes Rieken 已提交
6388
		 * @throws [`FileExists`](#FileSystemError.FileExists) when `uri` already exists, `create` is set but `overwrite` is not set.
6389
		 * @throws [`NoPermissions`](#FileSystemError.NoPermissions) when permissions aren't sufficient.
6390
		 */
6391
		writeFile(uri: Uri, content: Uint8Array, options: { create: boolean, overwrite: boolean }): void | Thenable<void>;
6392 6393

		/**
J
Johannes Rieken 已提交
6394
		 * Delete a file.
6395
		 *
6396 6397 6398
		 * @param uri The resource that is to be deleted.
		 * @param options Defines if deletion of folders is recursive.
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `uri` doesn't exist.
6399
		 * @throws [`NoPermissions`](#FileSystemError.NoPermissions) when permissions aren't sufficient.
6400
		 */
6401
		delete(uri: Uri, options: { recursive: boolean }): void | Thenable<void>;
6402 6403 6404 6405

		/**
		 * Rename a file or folder.
		 *
J
Johannes Rieken 已提交
6406 6407
		 * @param oldUri The existing file.
		 * @param newUri The new location.
6408
		 * @param options Defines if existing files should be overwritten.
6409
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `oldUri` doesn't exist.
J
Johannes Rieken 已提交
6410
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when parent of `newUri` doesn't exist, e.g. no mkdirp-logic required.
6411
		 * @throws [`FileExists`](#FileSystemError.FileExists) when `newUri` exists and when the `overwrite` option is not `true`.
6412
		 * @throws [`NoPermissions`](#FileSystemError.NoPermissions) when permissions aren't sufficient.
6413
		 */
6414
		rename(oldUri: Uri, newUri: Uri, options: { overwrite: boolean }): void | Thenable<void>;
6415 6416 6417 6418 6419

		/**
		 * Copy files or folders. Implementing this function is optional but it will speedup
		 * the copy operation.
		 *
J
Johannes Rieken 已提交
6420
		 * @param source The existing file.
J
Johannes Rieken 已提交
6421
		 * @param destination The destination location.
6422
		 * @param options Defines if existing files should be overwritten.
J
Johannes Rieken 已提交
6423 6424
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `source` doesn't exist.
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when parent of `destination` doesn't exist, e.g. no mkdirp-logic required.
6425
		 * @throws [`FileExists`](#FileSystemError.FileExists) when `destination` exists and when the `overwrite` option is not `true`.
6426
		 * @throws [`NoPermissions`](#FileSystemError.NoPermissions) when permissions aren't sufficient.
6427
		 */
6428
		copy?(source: Uri, destination: Uri, options: { overwrite: boolean }): void | Thenable<void>;
6429 6430
	}

6431 6432 6433 6434 6435 6436
	/**
	 * The file system interface exposes the editor's built-in and contributed
	 * [file system providers](#FileSystemProvider). It allows extensions to work
	 * with files from the local disk as well as files from remote places, like the
	 * remote extension host or ftp-servers.
	 *
G
Gaurav Makhecha 已提交
6437
	 * *Note* that an instance of this interface is available as [`workspace.fs`](#workspace.fs).
6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459
	 */
	export interface FileSystem {

		/**
		 * Retrieve metadata about a file.
		 *
		 * @param uri The uri of the file to retrieve metadata about.
		 * @return The file metadata about the file.
		 */
		stat(uri: Uri): Thenable<FileStat>;

		/**
		 * Retrieve all entries of a [directory](#FileType.Directory).
		 *
		 * @param uri The uri of the folder.
		 * @return An array of name/type-tuples or a thenable that resolves to such.
		 */
		readDirectory(uri: Uri): Thenable<[string, FileType][]>;

		/**
		 * Create a new directory (Note, that new files are created via `write`-calls).
		 *
J
Johannes Rieken 已提交
6460 6461 6462
		 * *Note* that missing directories are created automatically, e.g this call has
		 * `mkdirp` semantics.
		 *
6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500
		 * @param uri The uri of the new folder.
		 */
		createDirectory(uri: Uri): Thenable<void>;

		/**
		 * Read the entire contents of a file.
		 *
		 * @param uri The uri of the file.
		 * @return An array of bytes or a thenable that resolves to such.
		 */
		readFile(uri: Uri): Thenable<Uint8Array>;

		/**
		 * Write data to a file, replacing its entire contents.
		 *
		 * @param uri The uri of the file.
		 * @param content The new content of the file.
		 */
		writeFile(uri: Uri, content: Uint8Array): Thenable<void>;

		/**
		 * Delete a file.
		 *
		 * @param uri The resource that is to be deleted.
		 * @param options Defines if trash can should be used and if deletion of folders is recursive
		 */
		delete(uri: Uri, options?: { recursive?: boolean, useTrash?: boolean }): Thenable<void>;

		/**
		 * Rename a file or folder.
		 *
		 * @param oldUri The existing file.
		 * @param newUri The new location.
		 * @param options Defines if existing files should be overwritten.
		 */
		rename(source: Uri, target: Uri, options?: { overwrite?: boolean }): Thenable<void>;

		/**
J
Johannes Rieken 已提交
6501
		 * Copy files or folders.
6502 6503 6504 6505 6506 6507 6508 6509
		 *
		 * @param source The existing file.
		 * @param destination The destination location.
		 * @param options Defines if existing files should be overwritten.
		 */
		copy(source: Uri, target: Uri, options?: { overwrite?: boolean }): Thenable<void>;
	}

6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524
	/**
	 * Defines a port mapping used for localhost inside the webview.
	 */
	export interface WebviewPortMapping {
		/**
		 * Localhost port to remap inside the webview.
		 */
		readonly webviewPort: number;

		/**
		 * Destination port. The `webviewPort` is resolved to this port.
		 */
		readonly extensionHostPort: number;
	}

6525 6526 6527 6528 6529
	/**
	 * Content settings for a webview.
	 */
	export interface WebviewOptions {
		/**
M
Matt Bierner 已提交
6530
		 * Controls whether scripts are enabled in the webview content or not.
6531 6532 6533 6534 6535 6536
		 *
		 * Defaults to false (scripts-disabled).
		 */
		readonly enableScripts?: boolean;

		/**
M
Matt Bierner 已提交
6537
		 * Controls whether command uris are enabled in webview content or not.
6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550
		 *
		 * Defaults to false.
		 */
		readonly enableCommandUris?: boolean;

		/**
		 * Root paths from which the webview can load local (filesystem) resources using the `vscode-resource:` scheme.
		 *
		 * Default to the root folders of the current workspace plus the extension's install directory.
		 *
		 * Pass in an empty array to disallow access to any local resources.
		 */
		readonly localResourceRoots?: ReadonlyArray<Uri>;
6551 6552 6553 6554 6555 6556 6557 6558

		/**
		 * Mappings of localhost ports used inside the webview.
		 *
		 * Port mapping allow webviews to transparently define how localhost ports are resolved. This can be used
		 * to allow using a static localhost port inside the webview that is resolved to random port that a service is
		 * running on.
		 *
6559
		 * If a webview accesses localhost content, we recommend that you specify port mappings even if
6560
		 * the `webviewPort` and `extensionHostPort` ports are the same.
6561 6562 6563
		 *
		 * *Note* that port mappings only work for `http` or `https` urls. Websocket urls (e.g. `ws://localhost:3000`)
		 * cannot be mapped to another port.
6564 6565
		 */
		readonly portMapping?: ReadonlyArray<WebviewPortMapping>;
6566 6567 6568
	}

	/**
6569
	 * Displays html content, similarly to an iframe.
6570 6571 6572 6573 6574
	 */
	export interface Webview {
		/**
		 * Content settings for the webview.
		 */
6575
		options: WebviewOptions;
6576 6577

		/**
6578
		 * HTML contents of the webview.
6579
		 *
6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600
		 * This should be a complete, valid html document. Changing this property causes the webview to be reloaded.
		 *
		 * Webviews are sandboxed from normal extension process, so all communication with the webview must use
		 * message passing. To send a message from the extension to the webview, use [`postMessage`](#Webview.postMessage).
		 * To send message from the webview back to an extension, use the `acquireVsCodeApi` function inside the webview
		 * to get a handle to VS Code's api and then call `.postMessage()`:
		 *
		 * ```html
		 * <script>
		 *     const vscode = acquireVsCodeApi(); // acquireVsCodeApi can only be invoked once
		 *     vscode.postMessage({ message: 'hello!' });
		 * </script>
		 * ```
		 *
		 * To load a resources from the workspace inside a webview, use the `[asWebviewUri](#Webview.asWebviewUri)` method
		 * and ensure the resource's directory is listed in [`WebviewOptions.localResourceRoots`](#WebviewOptions.localResourceRoots).
		 *
		 * Keep in mind that even though webviews are sandboxed, they still allow running scripts and loading arbitrary content,
		 * so extensions must follow all standard web security best practices when working with webviews. This includes
		 * properly sanitizing all untrusted input (including content from the workspace) and
		 * setting a [content security policy](https://aka.ms/vscode-api-webview-csp).
6601 6602 6603 6604 6605
		 */
		html: string;

		/**
		 * Fired when the webview content posts a message.
6606 6607 6608 6609
		 *
		 * Webview content can post strings or json serilizable objects back to a VS Code extension. They cannot
		 * post `Blob`, `File`, `ImageData` and other DOM specific objects since the extension that receives the
		 * message does not run in a browser environment.
6610 6611 6612 6613 6614 6615
		 */
		readonly onDidReceiveMessage: Event<any>;

		/**
		 * Post a message to the webview content.
		 *
6616 6617
		 * Messages are only delivered if the webview is live (either visible or in the
		 * background with `retainContextWhenHidden`).
6618
		 *
6619
		 * @param message Body of the message. This must be a string or other json serilizable object.
6620 6621
		 */
		postMessage(message: any): Thenable<boolean>;
M
Matt Bierner 已提交
6622 6623 6624 6625

		/**
		 * Convert a uri for the local file system to one that can be used inside webviews.
		 *
M
Spell  
Matt Bierner 已提交
6626
		 * Webviews cannot directly load resources from the workspace or local file system using `file:` uris. The
M
Matt Bierner 已提交
6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645
		 * `asWebviewUri` function takes a local `file:` uri and converts it into a uri that can be used inside of
		 * a webview to load the same resource:
		 *
		 * ```ts
		 * webview.html = `<img src="${webview.asWebviewUri(vscode.Uri.file('/Users/codey/workspace/cat.gif'))}">`
		 * ```
		 */
		asWebviewUri(localResource: Uri): Uri;

		/**
		 * Content security policy source for webview resources.
		 *
		 * This is the origin that should be used in a content security policy rule:
		 *
		 * ```
		 * img-src https: ${webview.cspSource} ...;
		 * ```
		 */
		readonly cspSource: string;
6646 6647 6648 6649 6650 6651 6652
	}

	/**
	 * Content settings for a webview panel.
	 */
	export interface WebviewPanelOptions {
		/**
M
Matt Bierner 已提交
6653
		 * Controls if the find widget is enabled in the panel.
6654 6655 6656 6657 6658 6659
		 *
		 * Defaults to false.
		 */
		readonly enableFindWidget?: boolean;

		/**
M
Matt Bierner 已提交
6660 6661
		 * Controls if the webview panel's content (iframe) is kept around even when the panel
		 * is no longer visible.
6662 6663
		 *
		 * Normally the webview panel's html context is created when the panel becomes visible
N
Nick Schonning 已提交
6664
		 * and destroyed when it is hidden. Extensions that have complex state
6665
		 * or UI can set the `retainContextWhenHidden` to make VS Code keep the webview
6666 6667 6668 6669 6670
		 * context around, even when the webview moves to a background tab. When a webview using
		 * `retainContextWhenHidden` becomes hidden, its scripts and other dynamic content are suspended.
		 * When the panel becomes visible again, the context is automatically restored
		 * in the exact same state it was in originally. You cannot send messages to a
		 * hidden webview, even with `retainContextWhenHidden` enabled.
6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682
		 *
		 * `retainContextWhenHidden` has a high memory overhead and should only be used if
		 * your panel's context cannot be quickly saved and restored.
		 */
		readonly retainContextWhenHidden?: boolean;
	}

	/**
	 * A panel that contains a webview.
	 */
	interface WebviewPanel {
		/**
M
Matt Bierner 已提交
6683
		 * Identifies the type of the webview panel, such as `'markdown.preview'`.
6684 6685 6686 6687 6688 6689 6690 6691
		 */
		readonly viewType: string;

		/**
		 * Title of the panel shown in UI.
		 */
		title: string;

6692 6693 6694 6695 6696
		/**
		 * Icon for the panel shown in UI.
		 */
		iconPath?: Uri | { light: Uri; dark: Uri };

6697
		/**
6698
		 * [`Webview`](#Webview) belonging to the panel.
6699 6700 6701 6702 6703 6704 6705 6706 6707 6708
		 */
		readonly webview: Webview;

		/**
		 * Content settings for the webview panel.
		 */
		readonly options: WebviewPanelOptions;

		/**
		 * Editor position of the panel. This property is only set if the webview is in
6709
		 * one of the editor view columns.
6710 6711 6712
		 */
		readonly viewColumn?: ViewColumn;

M
Matt Bierner 已提交
6713
		/**
6714
		 * Whether the panel is active (focused by the user).
M
Matt Bierner 已提交
6715 6716 6717
		 */
		readonly active: boolean;

6718
		/**
6719
		 * Whether the panel is visible.
6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742
		 */
		readonly visible: boolean;

		/**
		 * Fired when the panel's view state changes.
		 */
		readonly onDidChangeViewState: Event<WebviewPanelOnDidChangeViewStateEvent>;

		/**
		 * Fired when the panel is disposed.
		 *
		 * This may be because the user closed the panel or because `.dispose()` was
		 * called on it.
		 *
		 * Trying to use the panel after it has been disposed throws an exception.
		 */
		readonly onDidDispose: Event<void>;

		/**
		 * Show the webview panel in a given column.
		 *
		 * A webview panel may only show in a single column at a time. If it is already showing, this
		 * method moves it to a new column.
6743 6744
		 *
		 * @param viewColumn View column to show the panel in. Shows in the current `viewColumn` if undefined.
6745
		 * @param preserveFocus When `true`, the webview will not take focus.
6746
		 */
6747
		reveal(viewColumn?: ViewColumn, preserveFocus?: boolean): void;
6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768

		/**
		 * Dispose of the webview panel.
		 *
		 * This closes the panel if it showing and disposes of the resources owned by the webview.
		 * Webview panels are also disposed when the user closes the webview panel. Both cases
		 * fire the `onDispose` event.
		 */
		dispose(): any;
	}

	/**
	 * Event fired when a webview panel's view state changes.
	 */
	export interface WebviewPanelOnDidChangeViewStateEvent {
		/**
		 * Webview panel whose view state changed.
		 */
		readonly webviewPanel: WebviewPanel;
	}

6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794
	/**
	 * Restore webview panels that have been persisted when vscode shuts down.
	 *
	 * There are two types of webview persistence:
	 *
	 * - Persistence within a session.
	 * - Persistence across sessions (across restarts of VS Code).
	 *
	 * A `WebviewPanelSerializer` is only required for the second case: persisting a webview across sessions.
	 *
	 * Persistence within a session allows a webview to save its state when it becomes hidden
	 * and restore its content from this state when it becomes visible again. It is powered entirely
	 * by the webview content itself. To save off a persisted state, call `acquireVsCodeApi().setState()` with
	 * any json serializable object. To restore the state again, call `getState()`
	 *
	 * ```js
	 * // Within the webview
	 * const vscode = acquireVsCodeApi();
	 *
	 * // Get existing state
	 * const oldState = vscode.getState() || { value: 0 };
	 *
	 * // Update state
	 * setState({ value: oldState.value + 1 })
	 * ```
	 *
M
Matt Bierner 已提交
6795 6796
	 * A `WebviewPanelSerializer` extends this persistence across restarts of VS Code. When the editor is shutdown,
	 * VS Code will save off the state from `setState` of all webviews that have a serializer. When the
6797 6798 6799 6800 6801
	 * webview first becomes visible after the restart, this state is passed to `deserializeWebviewPanel`.
	 * The extension can then restore the old `WebviewPanel` from this state.
	 */
	interface WebviewPanelSerializer {
		/**
6802
		 * Restore a webview panel from its serialized `state`.
6803 6804 6805
		 *
		 * Called when a serialized webview first becomes visible.
		 *
M
Matt Bierner 已提交
6806 6807 6808
		 * @param webviewPanel Webview panel to restore. The serializer should take ownership of this panel. The
		 * serializer must restore the webview's `.html` and hook up all webview events.
		 * @param state Persisted state from the webview content.
6809
		 *
S
Simon Siefke 已提交
6810
		 * @return Thenable indicating that the webview has been fully restored.
6811 6812 6813 6814
		 */
		deserializeWebviewPanel(webviewPanel: WebviewPanel, state: any): Thenable<void>;
	}

6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839
	/**
	 * Provider for text based custom editors.
	 *
	 * Text based custom editors use a [`TextDocument`](#TextDocument) as their data model. This considerably simplifies
	 * implementing a custom editor as it allows VS Code to handle many common operations such as
	 * undo and backup. The provider is responsible for synchronizing text changes between the webview and the `TextDocument`.
	 */
	export interface CustomTextEditorProvider {

		/**
		 * Resolve a custom editor for a given text resource.
		 *
		 * This is called when a user first opens a resource for a `CustomTextEditorProvider`, or if they reopen an
		 * existing editor using this `CustomTextEditorProvider`.
		 *
		 * To resolve a custom editor, the provider must fill in its initial html content and hook up all
		 * the event listeners it is interested it. The provider can also hold onto the `WebviewPanel` to use later,
		 * for example in a command. See [`WebviewPanel`](#WebviewPanel) for additional details.
		 *
		 * @param document Document for the resource to resolve.
		 * @param webviewPanel Webview to resolve.
		 * @param token A cancellation token that indicates the result is no longer needed.
		 *
		 * @return Thenable indicating that the custom editor has been resolved.
		 */
6840
		resolveCustomTextEditor(document: TextDocument, webviewPanel: WebviewPanel, token: CancellationToken): Thenable<void> | void;
6841 6842
	}

J
Johannes Rieken 已提交
6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860
	/**
	 * The clipboard provides read and write access to the system's clipboard.
	 */
	export interface Clipboard {

		/**
		 * Read the current clipboard contents as text.
		 * @returns A thenable that resolves to a string.
		 */
		readText(): Thenable<string>;

		/**
		 * Writes text into the clipboard.
		 * @returns A thenable that resolves when writing happened.
		 */
		writeText(value: string): Thenable<void>;
	}

6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876
	/**
	 * Possible kinds of UI that can use extensions.
	 */
	export enum UIKind {

		/**
		 * Extensions are accessed from a desktop application.
		 */
		Desktop = 1,

		/**
		 * Extensions are accessed from a web browser.
		 */
		Web = 2
	}

6877 6878 6879 6880 6881
	/**
	 * Namespace describing the environment the editor runs in.
	 */
	export namespace env {

6882 6883 6884
		/**
		 * The application name of the editor, like 'VS Code'.
		 */
6885
		export const appName: string;
6886

J
Johannes Rieken 已提交
6887 6888 6889
		/**
		 * The application root folder from which the editor is running.
		 */
6890
		export const appRoot: string;
J
Johannes Rieken 已提交
6891

P
Peng Lyu 已提交
6892 6893 6894 6895 6896
		/**
		 * The custom uri scheme the editor registers to in the operating system.
		 */
		export const uriScheme: string;

J
Johannes Rieken 已提交
6897 6898 6899
		/**
		 * Represents the preferred user-language, like `de-CH`, `fr`, or `en-US`.
		 */
6900
		export const language: string;
J
Johannes Rieken 已提交
6901

J
Johannes Rieken 已提交
6902 6903 6904 6905 6906
		/**
		 * The system clipboard.
		 */
		export const clipboard: Clipboard;

6907 6908 6909
		/**
		 * A unique identifier for the computer.
		 */
6910
		export const machineId: string;
6911 6912 6913 6914 6915

		/**
		 * A unique identifier for the current session.
		 * Changes each time the editor is started.
		 */
6916
		export const sessionId: string;
6917

J
Johannes Rieken 已提交
6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928
		/**
		 * The name of a remote. Defined by extensions, popular samples are `wsl` for the Windows
		 * Subsystem for Linux or `ssh-remote` for remotes using a secure shell.
		 *
		 * *Note* that the value is `undefined` when there is no remote extension host but that the
		 * value is defined in all extension hosts (local and remote) in case a remote extension host
		 * exists. Use [`Extension#extensionKind`](#Extension.extensionKind) to know if
		 * a specific extension runs remote or not.
		 */
		export const remoteName: string | undefined;

D
Daniel Imms 已提交
6929 6930 6931 6932 6933 6934
		/**
		 * The detected default shell for the extension host, this is overridden by the
		 * `terminal.integrated.shell` setting for the extension host's platform.
		 */
		export const shell: string;

6935 6936 6937 6938 6939 6940 6941
		/**
		 * The UI kind property indicates from which UI extensions
		 * are accessed from. For example, extensions could be accessed
		 * from a desktop application or a web browser.
		 */
		export const uiKind: UIKind;

6942
		/**
B
Benjamin Pasero 已提交
6943 6944 6945 6946 6947
		 * Opens a link externally using the default application. Depending on the
		 * used scheme this can be:
		 * * a browser (`http:`, `https:`)
		 * * a mail client (`mailto:`)
		 * * VSCode itself (`vscode:` from `vscode.env.uriScheme`)
6948 6949 6950 6951 6952 6953 6954
		 *
		 * *Note* that [`showTextDocument`](#window.showTextDocument) is the right
		 * way to open a text document inside the editor, not this function.
		 *
		 * @param target The uri that should be opened.
		 * @returns A promise indicating if open was successful.
		 */
J
Johannes Rieken 已提交
6955
		export function openExternal(target: Uri): Thenable<boolean>;
M
Matt Bierner 已提交
6956 6957

		/**
6958 6959 6960 6961 6962
		 * Resolves a uri to form that is accessible externally. Currently only supports `https:`, `http:` and
		 * `vscode.env.uriScheme` uris.
		 *
		 * #### `http:` or `https:` scheme
		 *
M
Matt Bierner 已提交
6963 6964 6965
		 * Resolves an *external* uri, such as a `http:` or `https:` link, from where the extension is running to a
		 * uri to the same resource on the client machine.
		 *
6966
		 * This is a no-op if the extension is running on the client machine.
M
Matt Bierner 已提交
6967 6968 6969 6970 6971
		 *
		 * If the extension is running remotely, this function automatically establishes a port forwarding tunnel
		 * from the local machine to `target` on the remote and returns a local uri to the tunnel. The lifetime of
		 * the port fowarding tunnel is managed by VS Code and the tunnel can be closed by the user.
		 *
6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995
		 * *Note* that uris passed through `openExternal` are automatically resolved and you should not call `asExternalUri` on them.
		 *
		 * #### `vscode.env.uriScheme`
		 *
		 * Creates a uri that - if opened in a browser (e.g. via `openExternal`) - will result in a registered [UriHandler](#UriHandler)
		 * to trigger.
		 *
		 * Extensions should not make any assumptions about the resulting uri and should not alter it in anyway.
		 * Rather, extensions can e.g. use this uri in an authentication flow, by adding the uri as callback query
		 * argument to the server to authenticate to.
		 *
		 * *Note* that if the server decides to add additional query parameters to the uri (e.g. a token or secret), it
		 * will appear in the uri that is passed to the [UriHandler](#UriHandler).
		 *
		 * **Example** of an authentication flow:
		 * ```typescript
		 * vscode.window.registerUriHandler({
		 *   handleUri(uri: vscode.Uri): vscode.ProviderResult<void> {
		 *     if (uri.path === '/did-authenticate') {
		 *       console.log(uri.toString());
		 *     }
		 *   }
		 * });
		 *
B
Benjamin Pasero 已提交
6996
		 * const callableUri = await vscode.env.asExternalUri(vscode.Uri.parse(`${vscode.env.uriScheme}://my.extension/did-authenticate`));
6997 6998
		 * await vscode.env.openExternal(callableUri);
		 * ```
M
Matt Bierner 已提交
6999
		 *
7000 7001 7002
		 * *Note* that extensions should not cache the result of `asExternalUri` as the resolved uri may become invalid due to
		 * a system or user action — for example, in remote cases, a user may close a port forwarding tunnel that was opened by
		 * `asExternalUri`.
M
Matt Bierner 已提交
7003 7004 7005 7006
		 *
		 * @return A uri that can be used on the client machine.
		 */
		export function asExternalUri(target: Uri): Thenable<Uri>;
7007 7008
	}

E
Erich Gamma 已提交
7009
	/**
7010 7011 7012 7013 7014 7015 7016 7017
	 * 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 已提交
7018
	 * the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette).
7019
	 * * keybinding - Use the `keybindings`-section in `package.json` to enable
G
Greg Van Liew 已提交
7020
	 * [keybindings](https://code.visualstudio.com/docs/getstarted/keybindings#_customizing-shortcuts)
7021 7022
	 * for your extension.
	 *
S
Steven Clarke 已提交
7023
	 * Commands from other extensions and from the editor itself are accessible to an extension. However,
7024 7025 7026
	 * 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 已提交
7027
	 * register a command handler with the identifier `extension.sayHello`.
7028 7029
	 * ```javascript
	 * commands.registerCommand('extension.sayHello', () => {
7030
	 * 	window.showInformationMessage('Hello World!');
7031 7032
	 * });
	 * ```
G
Gama11 已提交
7033
	 * Second, bind the command identifier to a title under which it will show in the palette (`package.json`).
7034 7035
	 * ```json
	 * {
7036 7037 7038 7039 7040 7041
	 * 	"contributes": {
	 * 		"commands": [{
	 * 			"command": "extension.sayHello",
	 * 			"title": "Hello World"
	 * 		}]
	 * 	}
7042 7043
	 * }
	 * ```
E
Erich Gamma 已提交
7044 7045 7046 7047 7048
	 */
	export namespace commands {

		/**
		 * Registers a command that can be invoked via a keyboard shortcut,
S
Steven Clarke 已提交
7049
		 * a menu item, an action, or directly.
E
Erich Gamma 已提交
7050
		 *
J
Johannes Rieken 已提交
7051 7052 7053 7054 7055
		 * 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 已提交
7056
		 * @param thisArg The `this` context used when invoking the handler function.
J
Johannes Rieken 已提交
7057
		 * @return Disposable which unregisters this command on disposal.
E
Erich Gamma 已提交
7058 7059 7060 7061
		 */
		export function registerCommand(command: string, callback: (...args: any[]) => any, thisArg?: any): Disposable;

		/**
J
Johannes Rieken 已提交
7062
		 * Registers a text editor command that can be invoked via a keyboard shortcut,
S
Steven Clarke 已提交
7063
		 * a menu item, an action, or directly.
E
Erich Gamma 已提交
7064
		 *
J
Johannes Rieken 已提交
7065
		 * Text editor commands are different from ordinary [commands](#commands.registerCommand) as
S
Steven Clarke 已提交
7066
		 * they only execute when there is an active editor when the command is called. Also, the
J
Johannes Rieken 已提交
7067 7068 7069 7070 7071
		 * 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 已提交
7072
		 * @param thisArg The `this` context used when invoking the handler function.
J
Johannes Rieken 已提交
7073
		 * @return Disposable which unregisters this command on disposal.
E
Erich Gamma 已提交
7074
		 */
J
Johannes Rieken 已提交
7075
		export function registerTextEditorCommand(command: string, callback: (textEditor: TextEditor, edit: TextEditorEdit, ...args: any[]) => void, thisArg?: any): Disposable;
E
Erich Gamma 已提交
7076 7077

		/**
J
Johannes Rieken 已提交
7078 7079
		 * Executes the command denoted by the given command identifier.
		 *
J
Johannes Rieken 已提交
7080
		 * * *Note 1:* When executing an editor command not all types are allowed to
7081
		 * be passed as arguments. Allowed are the primitive types `string`, `boolean`,
J
Johannes Rieken 已提交
7082 7083
		 * `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 已提交
7084
		 * by extensions.
E
Erich Gamma 已提交
7085
		 *
J
Johannes Rieken 已提交
7086
		 * @param command Identifier of the command to execute.
J
Johannes Rieken 已提交
7087 7088 7089
		 * @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 已提交
7090
		 */
7091
		export function executeCommand<T>(command: string, ...rest: any[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
7092 7093

		/**
P
Per Persson 已提交
7094
		 * Retrieve the list of all available commands. Commands starting with an underscore are
7095
		 * treated as internal commands.
E
Erich Gamma 已提交
7096
		 *
7097
		 * @param filterInternal Set `true` to not see internal commands (starting with an underscore)
E
Erich Gamma 已提交
7098 7099
		 * @return Thenable that resolves to a list of command ids.
		 */
7100
		export function getCommands(filterInternal?: boolean): Thenable<string[]>;
E
Erich Gamma 已提交
7101 7102
	}

J
Joao 已提交
7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113
	/**
	 * Represents the state of a window.
	 */
	export interface WindowState {

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

J
Joao Moreno 已提交
7114
	/**
J
Joao Moreno 已提交
7115
	 * A uri handler is responsible for handling system-wide [uris](#Uri).
J
Joao Moreno 已提交
7116 7117 7118 7119 7120 7121
	 *
	 * @see [window.registerUriHandler](#window.registerUriHandler).
	 */
	export interface UriHandler {

		/**
J
Joao Moreno 已提交
7122
		 * Handle the provided system-wide [uri](#Uri).
J
Joao Moreno 已提交
7123 7124 7125 7126 7127 7128
		 *
		 * @see [window.registerUriHandler](#window.registerUriHandler).
		 */
		handleUri(uri: Uri): ProviderResult<void>;
	}

E
Erich Gamma 已提交
7129
	/**
7130 7131 7132
	 * 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 已提交
7133 7134 7135 7136
	 */
	export namespace window {

		/**
7137
		 * The currently active editor or `undefined`. The active editor is the one
S
Steven Clarke 已提交
7138
		 * that currently has focus or, when none has focus, the one that has changed
E
Erich Gamma 已提交
7139 7140
		 * input most recently.
		 */
7141
		export let activeTextEditor: TextEditor | undefined;
E
Erich Gamma 已提交
7142 7143

		/**
7144
		 * The currently visible editors or an empty array.
E
Erich Gamma 已提交
7145 7146 7147 7148
		 */
		export let visibleTextEditors: TextEditor[];

		/**
7149
		 * An [event](#Event) which fires when the [active editor](#window.activeTextEditor)
J
Johannes Rieken 已提交
7150
		 * has changed. *Note* that the event also fires when the active editor changes
7151
		 * to `undefined`.
E
Erich Gamma 已提交
7152
		 */
7153
		export const onDidChangeActiveTextEditor: Event<TextEditor | undefined>;
E
Erich Gamma 已提交
7154

7155 7156 7157 7158
		/**
		 * An [event](#Event) which fires when the array of [visible editors](#window.visibleTextEditors)
		 * has changed.
		 */
7159
		export const onDidChangeVisibleTextEditors: Event<TextEditor[]>;
7160

E
Erich Gamma 已提交
7161
		/**
A
Andre Weinand 已提交
7162
		 * An [event](#Event) which fires when the selection in an editor has changed.
E
Erich Gamma 已提交
7163 7164 7165
		 */
		export const onDidChangeTextEditorSelection: Event<TextEditorSelectionChangeEvent>;

7166
		/**
7167
		 * An [event](#Event) which fires when the visible ranges of an editor has changed.
7168 7169 7170
		 */
		export const onDidChangeTextEditorVisibleRanges: Event<TextEditorVisibleRangesChangeEvent>;

E
Erich Gamma 已提交
7171 7172 7173 7174 7175
		/**
		 * An [event](#Event) which fires when the options of an editor have changed.
		 */
		export const onDidChangeTextEditorOptions: Event<TextEditorOptionsChangeEvent>;

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

D
Daniel Imms 已提交
7181 7182 7183 7184 7185
		/**
		 * The currently opened terminals or an empty array.
		 */
		export const terminals: ReadonlyArray<Terminal>;

D
Daniel Imms 已提交
7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198
		/**
		 * The currently active terminal or `undefined`. The active terminal is the one that
		 * currently has focus or most recently had focus.
		 */
		export const activeTerminal: Terminal | undefined;

		/**
		 * An [event](#Event) which fires when the [active terminal](#window.activeTerminal)
		 * has changed. *Note* that the event also fires when the active terminal changes
		 * to `undefined`.
		 */
		export const onDidChangeActiveTerminal: Event<Terminal | undefined>;

D
Daniel Imms 已提交
7199 7200 7201 7202 7203 7204
		/**
		 * An [event](#Event) which fires when a terminal has been created, either through the
		 * [createTerminal](#window.createTerminal) API or commands.
		 */
		export const onDidOpenTerminal: Event<Terminal>;

7205
		/**
7206
		 * An [event](#Event) which fires when a terminal is disposed.
7207 7208 7209
		 */
		export const onDidCloseTerminal: Event<Terminal>;

J
Joao 已提交
7210 7211 7212
		/**
		 * Represents the current window's state.
		 */
7213
		export const state: WindowState;
J
Joao 已提交
7214 7215 7216 7217 7218 7219 7220

		/**
		 * 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 已提交
7221 7222 7223 7224 7225
		/**
		 * 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.
B
Benjamin Pasero 已提交
7226
		 * @param column A view column in which the [editor](#TextEditor) should be shown. The default is the [active](#ViewColumn.Active), other values
7227 7228
		 * are adjusted to be `Min(column, columnCount + 1)`, the [active](#ViewColumn.Active)-column is not adjusted. Use [`ViewColumn.Beside`](#ViewColumn.Beside)
		 * to open the editor to the side of the currently active one.
7229
		 * @param preserveFocus When `true` the editor will not take focus.
E
Erich Gamma 已提交
7230 7231
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
7232
		export function showTextDocument(document: TextDocument, column?: ViewColumn, preserveFocus?: boolean): Thenable<TextEditor>;
E
Erich Gamma 已提交
7233

7234
		/**
B
Benjamin Pasero 已提交
7235 7236
		 * 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).
7237 7238
		 *
		 * @param document A text document to be shown.
B
Benjamin Pasero 已提交
7239
		 * @param options [Editor options](#TextDocumentShowOptions) to configure the behavior of showing the [editor](#TextEditor).
7240 7241
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
7242
		export function showTextDocument(document: TextDocument, options?: TextDocumentShowOptions): Thenable<TextEditor>;
7243

B
Benjamin Pasero 已提交
7244
		/**
J
Johannes Rieken 已提交
7245
		 * A short-hand for `openTextDocument(uri).then(document => showTextDocument(document, options))`.
B
Benjamin Pasero 已提交
7246
		 *
J
Johannes Rieken 已提交
7247
		 * @see [openTextDocument](#openTextDocument)
B
Benjamin Pasero 已提交
7248 7249
		 *
		 * @param uri A resource identifier.
B
Benjamin Pasero 已提交
7250
		 * @param options [Editor options](#TextDocumentShowOptions) to configure the behavior of showing the [editor](#TextEditor).
B
Benjamin Pasero 已提交
7251 7252 7253 7254
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
		export function showTextDocument(uri: Uri, options?: TextDocumentShowOptions): Thenable<TextEditor>;

E
Erich Gamma 已提交
7255
		/**
J
Johannes Rieken 已提交
7256 7257 7258 7259
		 * 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 已提交
7260 7261 7262 7263 7264 7265 7266
		 */
		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 已提交
7267 7268
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
7269
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
7270
		 */
7271
		export function showInformationMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
7272

J
Joao Moreno 已提交
7273 7274 7275 7276 7277 7278 7279 7280 7281
		/**
		 * 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 已提交
7282
		export function showInformationMessage(message: string, options: MessageOptions, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
7283 7284

		/**
J
Johannes Rieken 已提交
7285
		 * Show an information message.
J
Johannes Rieken 已提交
7286
		 *
E
Erich Gamma 已提交
7287
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
7288 7289 7290
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
7291
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
7292
		 */
7293
		export function showInformationMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
7294

J
Joao Moreno 已提交
7295 7296 7297 7298 7299 7300 7301 7302 7303 7304
		/**
		 * 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 已提交
7305
		export function showInformationMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
7306 7307

		/**
J
Johannes Rieken 已提交
7308
		 * Show a warning message.
J
Johannes Rieken 已提交
7309
		 *
E
Erich Gamma 已提交
7310
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
7311 7312 7313
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
7314
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
7315
		 */
7316
		export function showWarningMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
7317

J
Joao Moreno 已提交
7318 7319 7320 7321 7322 7323 7324 7325 7326 7327
		/**
		 * 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 已提交
7328
		export function showWarningMessage(message: string, options: MessageOptions, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
7329 7330

		/**
J
Johannes Rieken 已提交
7331
		 * Show a warning message.
J
Johannes Rieken 已提交
7332
		 *
E
Erich Gamma 已提交
7333
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
7334 7335 7336
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
7337
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
7338
		 */
7339
		export function showWarningMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
7340

J
Joao Moreno 已提交
7341 7342 7343 7344 7345 7346 7347 7348 7349 7350
		/**
		 * 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 已提交
7351
		export function showWarningMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
7352 7353

		/**
J
Johannes Rieken 已提交
7354
		 * Show an error message.
J
Johannes Rieken 已提交
7355
		 *
E
Erich Gamma 已提交
7356
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
7357 7358 7359
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
7360
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
7361
		 */
7362
		export function showErrorMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
7363

J
Joao Moreno 已提交
7364 7365 7366 7367 7368 7369 7370 7371 7372 7373
		/**
		 * 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 已提交
7374
		export function showErrorMessage(message: string, options: MessageOptions, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
7375 7376

		/**
J
Johannes Rieken 已提交
7377
		 * Show an error message.
J
Johannes Rieken 已提交
7378
		 *
E
Erich Gamma 已提交
7379
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
7380 7381 7382
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
7383
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
7384
		 */
7385
		export function showErrorMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
7386

J
Joao Moreno 已提交
7387 7388 7389 7390 7391 7392 7393 7394 7395 7396
		/**
		 * 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 已提交
7397
		export function showErrorMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
7398

C
Christof Marti 已提交
7399 7400 7401 7402 7403 7404 7405 7406
		/**
		 * Shows a selection list allowing multiple selections.
		 *
		 * @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.
		 * @param token A token that can be used to signal cancellation.
		 * @return A promise that resolves to the selected items or `undefined`.
		 */
7407
		export function showQuickPick(items: string[] | Thenable<string[]>, options: QuickPickOptions & { canPickMany: true; }, token?: CancellationToken): Thenable<string[] | undefined>;
C
Christof Marti 已提交
7408

E
Erich Gamma 已提交
7409 7410 7411
		/**
		 * Shows a selection list.
		 *
J
Johannes Rieken 已提交
7412 7413
		 * @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.
7414
		 * @param token A token that can be used to signal cancellation.
C
Christof Marti 已提交
7415
		 * @return A promise that resolves to the selection or `undefined`.
E
Erich Gamma 已提交
7416
		 */
7417
		export function showQuickPick(items: string[] | Thenable<string[]>, options?: QuickPickOptions, token?: CancellationToken): Thenable<string | undefined>;
E
Erich Gamma 已提交
7418

C
Christof Marti 已提交
7419 7420 7421 7422 7423 7424 7425 7426
		/**
		 * Shows a selection list allowing multiple selections.
		 *
		 * @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.
		 * @param token A token that can be used to signal cancellation.
		 * @return A promise that resolves to the selected items or `undefined`.
		 */
7427
		export function showQuickPick<T extends QuickPickItem>(items: T[] | Thenable<T[]>, options: QuickPickOptions & { canPickMany: true; }, token?: CancellationToken): Thenable<T[] | undefined>;
C
Christof Marti 已提交
7428

E
Erich Gamma 已提交
7429 7430 7431
		/**
		 * Shows a selection list.
		 *
J
Johannes Rieken 已提交
7432 7433
		 * @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.
7434
		 * @param token A token that can be used to signal cancellation.
C
Christof Marti 已提交
7435
		 * @return A promise that resolves to the selected item or `undefined`.
E
Erich Gamma 已提交
7436
		 */
7437
		export function showQuickPick<T extends QuickPickItem>(items: T[] | Thenable<T[]>, options?: QuickPickOptions, token?: CancellationToken): Thenable<T | undefined>;
E
Erich Gamma 已提交
7438

7439 7440 7441 7442 7443 7444 7445 7446 7447
		/**
		 * Shows a selection list of [workspace folders](#workspace.workspaceFolders) to pick from.
		 * Returns `undefined` if no folder is open.
		 *
		 * @param options Configures the behavior of the workspace folder list.
		 * @return A promise that resolves to the workspace folder or `undefined`.
		 */
		export function showWorkspaceFolderPick(options?: WorkspaceFolderPickOptions): Thenable<WorkspaceFolder | undefined>;

7448
		/**
7449 7450
		 * Shows a file open dialog to the user which allows to select a file
		 * for opening-purposes.
7451 7452 7453 7454 7455 7456 7457
		 *
		 * @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>;

		/**
7458 7459
		 * Shows a file save dialog to the user which allows to select a file
		 * for saving-purposes.
7460 7461 7462 7463 7464 7465
		 *
		 * @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 已提交
7466 7467 7468
		/**
		 * Opens an input box to ask the user for input.
		 *
7469
		 * The returned value will be `undefined` if the input box was canceled (e.g. pressing ESC). Otherwise the
A
Andre Weinand 已提交
7470
		 * returned value will be the string typed by the user or an empty string if the user did not type
S
Steven Clarke 已提交
7471
		 * anything but dismissed the input box with OK.
E
Erich Gamma 已提交
7472
		 *
J
Johannes Rieken 已提交
7473
		 * @param options Configures the behavior of the input box.
7474
		 * @param token A token that can be used to signal cancellation.
J
Johannes Rieken 已提交
7475
		 * @return A promise that resolves to a string the user provided or to `undefined` in case of dismissal.
E
Erich Gamma 已提交
7476
		 */
7477
		export function showInputBox(options?: InputBoxOptions, token?: CancellationToken): Thenable<string | undefined>;
E
Erich Gamma 已提交
7478

C
Christof Marti 已提交
7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501
		/**
		 * Creates a [QuickPick](#QuickPick) to let the user pick an item from a list
		 * of items of type T.
		 *
		 * Note that in many cases the more convenient [window.showQuickPick](#window.showQuickPick)
		 * is easier to use. [window.createQuickPick](#window.createQuickPick) should be used
		 * when [window.showQuickPick](#window.showQuickPick) does not offer the required flexibility.
		 *
		 * @return A new [QuickPick](#QuickPick).
		 */
		export function createQuickPick<T extends QuickPickItem>(): QuickPick<T>;

		/**
		 * Creates a [InputBox](#InputBox) to let the user enter some text input.
		 *
		 * Note that in many cases the more convenient [window.showInputBox](#window.showInputBox)
		 * is easier to use. [window.createInputBox](#window.createInputBox) should be used
		 * when [window.showInputBox](#window.showInputBox) does not offer the required flexibility.
		 *
		 * @return A new [InputBox](#InputBox).
		 */
		export function createInputBox(): InputBox;

E
Erich Gamma 已提交
7502
		/**
7503 7504
		 * Creates a new [output channel](#OutputChannel) with the given name.
		 *
7505
		 * @param name Human-readable string which will be used to represent the channel in the UI.
E
Erich Gamma 已提交
7506
		 */
S
Sandeep Somavarapu 已提交
7507
		export function createOutputChannel(name: string): OutputChannel;
E
Erich Gamma 已提交
7508

7509 7510 7511 7512 7513
		/**
		 * Create and show a new webview panel.
		 *
		 * @param viewType Identifies the type of the webview panel.
		 * @param title Title of the panel.
7514
		 * @param showOptions Where to show the webview in the editor. If preserveFocus is set, the new webview will not take focus.
7515 7516 7517 7518
		 * @param options Settings for the new panel.
		 *
		 * @return New webview panel.
		 */
7519
		export function createWebviewPanel(viewType: string, title: string, showOptions: ViewColumn | { viewColumn: ViewColumn, preserveFocus?: boolean }, options?: WebviewPanelOptions & WebviewOptions): WebviewPanel;
7520

E
Erich Gamma 已提交
7521
		/**
S
Steven Clarke 已提交
7522
		 * Set a message to the status bar. This is a short hand for the more powerful
E
Erich Gamma 已提交
7523
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
7524
		 *
G
Gama11 已提交
7525
		 * @param text The message to show, supports icon substitution as in status bar [items](#StatusBarItem.text).
7526
		 * @param hideAfterTimeout Timeout in milliseconds after which the message will be disposed.
J
Johannes Rieken 已提交
7527
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
7528
		 */
7529
		export function setStatusBarMessage(text: string, hideAfterTimeout: number): Disposable;
E
Erich Gamma 已提交
7530 7531

		/**
S
Steven Clarke 已提交
7532
		 * Set a message to the status bar. This is a short hand for the more powerful
J
Johannes Rieken 已提交
7533
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
7534
		 *
G
Gama11 已提交
7535
		 * @param text The message to show, supports icon substitution as in status bar [items](#StatusBarItem.text).
7536
		 * @param hideWhenDone Thenable on which completion (resolve or reject) the message will be disposed.
J
Johannes Rieken 已提交
7537
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
7538
		 */
7539
		export function setStatusBarMessage(text: string, hideWhenDone: Thenable<any>): Disposable;
E
Erich Gamma 已提交
7540 7541

		/**
S
Steven Clarke 已提交
7542
		 * Set a message to the status bar. This is a short hand for the more powerful
J
Johannes Rieken 已提交
7543
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
7544
		 *
7545 7546 7547
		 * *Note* that status bar messages stack and that they must be disposed when no
		 * longer used.
		 *
G
Gama11 已提交
7548
		 * @param text The message to show, supports icon substitution as in status bar [items](#StatusBarItem.text).
J
Johannes Rieken 已提交
7549
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
7550
		 */
7551
		export function setStatusBarMessage(text: string): Disposable;
E
Erich Gamma 已提交
7552

7553
		/**
J
Johannes Rieken 已提交
7554 7555
		 * ~~Show progress in the Source Control viewlet while running the given callback and while
		 * its returned promise isn't resolve or rejected.~~
7556
		 *
7557 7558
		 * @deprecated Use `withProgress` instead.
		 *
7559 7560
		 * @param task A callback returning a promise. Progress increments can be reported with
		 * the provided [progress](#Progress)-object.
7561
		 * @return The thenable the task did return.
7562 7563 7564
		 */
		export function withScmProgress<R>(task: (progress: Progress<number>) => Thenable<R>): Thenable<R>;

J
Johannes Rieken 已提交
7565 7566 7567 7568 7569 7570 7571
		/**
		 * 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.
7572
		 *
7573 7574 7575 7576
		 * To report discrete progress, use `increment` to indicate how much work has been completed. Each call with
		 * a `increment` value will be summed up and reflected as overall progress until 100% is reached (a value of
		 * e.g. `10` accounts for `10%` of work done).
		 * Note that currently only `ProgressLocation.Notification` is capable of showing discrete progress.
7577 7578 7579 7580 7581
		 *
		 * To monitor if the operation has been cancelled by the user, use the provided [`CancellationToken`](#CancellationToken).
		 * Note that currently only `ProgressLocation.Notification` is supporting to show a cancel button to cancel the
		 * long running operation.
		 *
J
Johannes Rieken 已提交
7582 7583
		 * @return The thenable the task-callback returned.
		 */
7584
		export function withProgress<R>(options: ProgressOptions, task: (progress: Progress<{ message?: string; increment?: number }>, token: CancellationToken) => Thenable<R>): Thenable<R>;
7585

E
Erich Gamma 已提交
7586
		/**
J
Johannes Rieken 已提交
7587 7588
		 * Creates a status bar [item](#StatusBarItem).
		 *
J
Johannes Rieken 已提交
7589
		 * @param alignment The alignment of the item.
J
Johannes Rieken 已提交
7590
		 * @param priority The priority of the item. Higher values mean the item should be shown more to the left.
J
Johannes Rieken 已提交
7591 7592
		 * @return A new status bar item.
		 */
E
Erich Gamma 已提交
7593
		export function createStatusBarItem(alignment?: StatusBarAlignment, priority?: number): StatusBarItem;
D
Daniel Imms 已提交
7594

D
Daniel Imms 已提交
7595
		/**
D
Daniel Imms 已提交
7596 7597
		 * Creates a [Terminal](#Terminal) with a backing shell process. The cwd of the terminal will be the workspace
		 * directory if it exists.
D
Daniel Imms 已提交
7598
		 *
7599
		 * @param name Optional human-readable string which will be used to represent the terminal in the UI.
7600
		 * @param shellPath Optional path to a custom shell executable to be used in the terminal.
7601
		 * @param shellArgs Optional args for the custom shell executable. A string can be used on Windows only which
D
Daniel Imms 已提交
7602 7603
		 * allows specifying shell args in
		 * [command-line format](https://msdn.microsoft.com/en-au/08dfcab2-eb6e-49a4-80eb-87d4076c98c6).
D
Daniel Imms 已提交
7604 7605
		 * @return A new Terminal.
		 */
7606
		export function createTerminal(name?: string, shellPath?: string, shellArgs?: string[] | string): Terminal;
7607 7608

		/**
D
Daniel Imms 已提交
7609
		 * Creates a [Terminal](#Terminal) with a backing shell process.
7610 7611 7612 7613 7614
		 *
		 * @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 已提交
7615

7616 7617 7618 7619 7620 7621 7622 7623 7624
		/**
		 * Creates a [Terminal](#Terminal) where an extension controls its input and output.
		 *
		 * @param options An [ExtensionTerminalOptions](#ExtensionTerminalOptions) object describing
		 * the characteristics of the new terminal.
		 * @return A new Terminal.
		 */
		export function createTerminal(options: ExtensionTerminalOptions): Terminal;

7625 7626 7627 7628 7629 7630 7631
		/**
		 * Register a [TerminalLinkHandler](#TerminalLinkHandler) that can be used to intercept and
		 * handle links that are activated within terminals.
		 * @param handler The link handler being registered.
		 */
		export function registerTerminalLinkHandler(handler: TerminalLinkHandler): Disposable;

S
Sandeep Somavarapu 已提交
7632 7633
		/**
		 * Register a [TreeDataProvider](#TreeDataProvider) for the view contributed using the extension point `views`.
7634
		 * This will allow you to contribute data to the [TreeView](#TreeView) and update if the data changes.
S
Sandeep Somavarapu 已提交
7635
		 *
S
Sandeep Somavarapu 已提交
7636
		 * **Note:** To get access to the [TreeView](#TreeView) and perform operations on it, use [createTreeView](#window.createTreeView).
7637
		 *
S
Sandeep Somavarapu 已提交
7638 7639 7640 7641
		 * @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;
7642 7643 7644 7645

		/**
		 * Create a [TreeView](#TreeView) for the view contributed using the extension point `views`.
		 * @param viewId Id of the view contributed using the extension point `views`.
S
Sandeep Somavarapu 已提交
7646
		 * @param options Options for creating the [TreeView](#TreeView)
7647 7648
		 * @returns a [TreeView](#TreeView).
		 */
S
Sandeep Somavarapu 已提交
7649
		export function createTreeView<T>(viewId: string, options: TreeViewOptions<T>): TreeView<T>;
J
Joao Moreno 已提交
7650 7651

		/**
J
Joao Moreno 已提交
7652 7653 7654 7655 7656
		 * Registers a [uri handler](#UriHandler) capable of handling system-wide [uris](#Uri).
		 * In case there are multiple windows open, the topmost window will handle the uri.
		 * A uri handler is scoped to the extension it is contributed from; it will only
		 * be able to handle uris which are directed to the extension itself. A uri must respect
		 * the following rules:
J
Joao Moreno 已提交
7657
		 *
7658
		 * - The uri-scheme must be `vscode.env.uriScheme`;
7659
		 * - The uri-authority must be the extension id (e.g. `my.extension`);
J
Joao Moreno 已提交
7660 7661
		 * - The uri-path, -query and -fragment parts are arbitrary.
		 *
J
Joao Moreno 已提交
7662 7663
		 * For example, if the `my.extension` extension registers a uri handler, it will only
		 * be allowed to handle uris with the prefix `product-name://my.extension`.
J
Joao Moreno 已提交
7664
		 *
J
Joao Moreno 已提交
7665
		 * An extension can only register a single uri handler in its entire activation lifetime.
J
Joao Moreno 已提交
7666
		 *
J
Joao Moreno 已提交
7667
		 * * *Note:* There is an activation event `onUri` that fires when a uri directed for
J
Joao Moreno 已提交
7668 7669
		 * the current extension is about to be handled.
		 *
J
Joao Moreno 已提交
7670
		 * @param handler The uri handler to register for this extension.
J
Joao Moreno 已提交
7671 7672
		 */
		export function registerUriHandler(handler: UriHandler): Disposable;
7673

7674 7675 7676
		/**
		 * Registers a webview panel serializer.
		 *
J
Joao Moreno 已提交
7677 7678
		 * Extensions that support reviving should have an `"onWebviewPanel:viewType"` activation event and
		 * make sure that [registerWebviewPanelSerializer](#registerWebviewPanelSerializer) is called during activation.
7679
		 *
J
Joao Moreno 已提交
7680
		 * Only a single serializer may be registered at a time for a given `viewType`.
7681 7682 7683 7684 7685
		 *
		 * @param viewType Type of the webview panel that can be serialized.
		 * @param serializer Webview serializer.
		 */
		export function registerWebviewPanelSerializer(viewType: string, serializer: WebviewPanelSerializer): Disposable;
7686 7687

		/**
7688
		 * Register a provider for custom editors for the `viewType` contributed by the `customEditors` extension point.
7689
		 *
7690
		 * When a custom editor is opened, VS Code fires an `onCustomEditor:viewType` activation event. Your extension
7691
		 * must register a [`CustomTextEditorProvider`](#CustomTextEditorProvider) for `viewType` as part of activation.
7692 7693 7694
		 *
		 * @param viewType Unique identifier for the custom editor provider. This should match the `viewType` from the
		 *   `customEditors` contribution point.
7695 7696 7697 7698 7699
		 * @param provider Provider that resolves custom editors.
		 * @param options Options for the provider.
		 *
		 * @return Disposable that unregisters the provider.
		 */
J
Johannes Rieken 已提交
7700
		export function registerCustomEditorProvider(viewType: string, provider: CustomTextEditorProvider, options?: { readonly webviewOptions?: WebviewPanelOptions; }): Disposable;
S
Sandeep Somavarapu 已提交
7701 7702
	}

S
Sandeep Somavarapu 已提交
7703
	/**
7704
	 * Options for creating a [TreeView](#TreeView)
S
Sandeep Somavarapu 已提交
7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716
	 */
	export interface TreeViewOptions<T> {

		/**
		 * A data provider that provides tree data.
		 */
		treeDataProvider: TreeDataProvider<T>;

		/**
		 * Whether to show collapse all action or not.
		 */
		showCollapseAll?: boolean;
7717 7718 7719 7720

		/**
		 * Whether the tree supports multi-select. When the tree supports multi-select and a command is executed from the tree,
		 * the first argument to the command is the tree item that the command was executed on and the second argument is an
7721
		 * array containing all selected tree items.
7722 7723
		 */
		canSelectMany?: boolean;
S
Sandeep Somavarapu 已提交
7724 7725
	}

S
Sandeep Somavarapu 已提交
7726 7727 7728 7729 7730 7731 7732 7733
	/**
	 * The event that is fired when an element in the [TreeView](#TreeView) is expanded or collapsed
	 */
	export interface TreeViewExpansionEvent<T> {

		/**
		 * Element that is expanded or collapsed.
		 */
7734
		readonly element: T;
S
Sandeep Somavarapu 已提交
7735 7736 7737

	}

S
Sandeep Somavarapu 已提交
7738
	/**
7739
	 * The event that is fired when there is a change in [tree view's selection](#TreeView.selection)
S
Sandeep Somavarapu 已提交
7740 7741 7742 7743 7744 7745
	 */
	export interface TreeViewSelectionChangeEvent<T> {

		/**
		 * Selected elements.
		 */
7746
		readonly selection: T[];
7747 7748 7749

	}

S
Add doc  
Sandeep Somavarapu 已提交
7750 7751 7752
	/**
	 * The event that is fired when there is a change in [tree view's visibility](#TreeView.visible)
	 */
7753 7754 7755 7756 7757
	export interface TreeViewVisibilityChangeEvent {

		/**
		 * `true` if the [tree view](#TreeView) is visible otherwise `false`.
		 */
7758
		readonly visible: boolean;
S
Sandeep Somavarapu 已提交
7759 7760 7761

	}

7762 7763 7764 7765 7766
	/**
	 * Represents a Tree view
	 */
	export interface TreeView<T> extends Disposable {

S
Sandeep Somavarapu 已提交
7767 7768 7769
		/**
		 * Event that is fired when an element is expanded
		 */
S
Sandeep Somavarapu 已提交
7770
		readonly onDidExpandElement: Event<TreeViewExpansionEvent<T>>;
S
Sandeep Somavarapu 已提交
7771 7772 7773 7774

		/**
		 * Event that is fired when an element is collapsed
		 */
S
Sandeep Somavarapu 已提交
7775
		readonly onDidCollapseElement: Event<TreeViewExpansionEvent<T>>;
S
Sandeep Somavarapu 已提交
7776

S
Sandeep Somavarapu 已提交
7777
		/**
7778 7779
		 * Currently selected elements.
		 */
7780
		readonly selection: T[];
7781 7782 7783

		/**
		 * Event that is fired when the [selection](#TreeView.selection) has changed
S
Sandeep Somavarapu 已提交
7784 7785 7786
		 */
		readonly onDidChangeSelection: Event<TreeViewSelectionChangeEvent<T>>;

S
Sandeep Somavarapu 已提交
7787
		/**
7788
		 * `true` if the [tree view](#TreeView) is visible otherwise `false`.
S
Sandeep Somavarapu 已提交
7789
		 */
7790
		readonly visible: boolean;
S
Sandeep Somavarapu 已提交
7791

7792
		/**
M
Matthew J. Clemente 已提交
7793
		 * Event that is fired when [visibility](#TreeView.visible) has changed
7794 7795 7796
		 */
		readonly onDidChangeVisibility: Event<TreeViewVisibilityChangeEvent>;

A
Alex Ross 已提交
7797 7798
		/**
		 * An optional human-readable message that will be rendered in the view.
A
Alex Ross 已提交
7799
		 * Setting the message to null, undefined, or empty string will remove the message from the view.
A
Alex Ross 已提交
7800 7801 7802
		 */
		message?: string;

A
Alex Ross 已提交
7803 7804 7805 7806 7807 7808
		/**
		 * The tree view title is initially taken from the extension package.json
		 * Changes to the title property will be properly reflected in the UI in the title of the view.
		 */
		title?: string;

7809 7810
		/**
		 * Reveals the given element in the tree view.
S
Sandeep Somavarapu 已提交
7811
		 * If the tree view is not visible then the tree view is shown and element is revealed.
7812
		 *
S
Sandeep Somavarapu 已提交
7813
		 * By default revealed element is selected.
7814
		 * In order to not to select, set the option `select` to `false`.
7815
		 * In order to focus, set the option `focus` to `true`.
7816 7817
		 * In order to expand the revealed element, set the option `expand` to `true`. To expand recursively set `expand` to the number of levels to expand.
		 * **NOTE:** You can expand only to 3 levels maximum.
7818 7819 7820
		 *
		 * **NOTE:** [TreeDataProvider](#TreeDataProvider) is required to implement [getParent](#TreeDataProvider.getParent) method to access this API.
		 */
7821
		reveal(element: T, options?: { select?: boolean, focus?: boolean, expand?: boolean | number }): Thenable<void>;
S
Sandeep Somavarapu 已提交
7822 7823 7824 7825 7826 7827 7828 7829
	}

	/**
	 * A data provider that provides tree data
	 */
	export interface TreeDataProvider<T> {
		/**
		 * An optional event to signal that an element or root has changed.
S
Sandeep Somavarapu 已提交
7830
		 * This will trigger the view to update the changed element/root and its children recursively (if shown).
S
Sandeep Somavarapu 已提交
7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849
		 * 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[]>;
7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860

		/**
		 * Optional method to return the parent of `element`.
		 * Return `null` or `undefined` if `element` is a child of root.
		 *
		 * **NOTE:** This method should be implemented in order to access [reveal](#TreeView.reveal) API.
		 *
		 * @param element The element for which the parent has to be returned.
		 * @return Parent of `element`.
		 */
		getParent?(element: T): ProviderResult<T>;
S
Sandeep Somavarapu 已提交
7861 7862 7863 7864
	}

	export class TreeItem {
		/**
7865
		 * A human-readable string describing this item. When `falsy`, it is derived from [resourceUri](#TreeItem.resourceUri).
S
Sandeep Somavarapu 已提交
7866
		 */
7867
		label?: string;
S
Sandeep Somavarapu 已提交
7868

7869
		/**
7870
		 * Optional id for the tree item that has to be unique across tree. The id is used to preserve the selection and expansion state of the tree item.
7871
		 *
7872
		 * If not provided, an id is generated using the tree item's label. **Note** that when labels change, ids will change and that selection and expansion state cannot be kept stable anymore.
7873 7874 7875
		 */
		id?: string;

S
Sandeep Somavarapu 已提交
7876
		/**
7877
		 * The icon path or [ThemeIcon](#ThemeIcon) for the tree item.
S
Sandeep Somavarapu 已提交
7878
		 * When `falsy`, [Folder Theme Icon](#ThemeIcon.Folder) is assigned, if item is collapsible otherwise [File Theme Icon](#ThemeIcon.File).
7879
		 * When a file or folder [ThemeIcon](#ThemeIcon) is specified, icon is derived from the current file icon theme for the specified theme icon using [resourceUri](#TreeItem.resourceUri) (if provided).
S
Sandeep Somavarapu 已提交
7880
		 */
7881
		iconPath?: string | Uri | { light: string | Uri; dark: string | Uri } | ThemeIcon;
S
Sandeep Somavarapu 已提交
7882

S
Sandeep Somavarapu 已提交
7883
		/**
S
Sandeep Somavarapu 已提交
7884
		 * A human-readable string which is rendered less prominent.
S
Sandeep Somavarapu 已提交
7885 7886 7887 7888
		 * When `true`, it is derived from [resourceUri](#TreeItem.resourceUri) and when `falsy`, it is not shown.
		 */
		description?: string | boolean;

7889 7890
		/**
		 * The [uri](#Uri) of the resource representing this item.
S
Sandeep Somavarapu 已提交
7891 7892
		 *
		 * Will be used to derive the [label](#TreeItem.label), when it is not provided.
7893
		 * Will be used to derive the icon from current file icon theme, when [iconPath](#TreeItem.iconPath) has [ThemeIcon](#ThemeIcon) value.
7894
		 */
7895
		resourceUri?: Uri;
7896

S
Sandeep Somavarapu 已提交
7897 7898 7899 7900 7901
		/**
		 * The tooltip text when you hover over this item.
		 */
		tooltip?: string | undefined;

S
Sandeep Somavarapu 已提交
7902
		/**
7903
		 * The [command](#Command) that should be executed when the tree item is selected.
S
Sandeep Somavarapu 已提交
7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936
		 */
		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);
7937 7938 7939 7940 7941 7942

		/**
		 * @param resourceUri The [uri](#Uri) of the resource representing this item.
		 * @param collapsibleState [TreeItemCollapsibleState](#TreeItemCollapsibleState) of the tree item. Default is [TreeItemCollapsibleState.None](#TreeItemCollapsibleState.None)
		 */
		constructor(resourceUri: Uri, collapsibleState?: TreeItemCollapsibleState);
S
Sandeep Somavarapu 已提交
7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960
	}

	/**
	 * 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
7961 7962 7963
	}

	/**
J
Johannes Rieken 已提交
7964
	 * Value-object describing what options a terminal should use.
7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977
	 */
	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;

		/**
7978 7979
		 * Args for the custom shell executable. A string can be used on Windows only which allows
		 * specifying shell args in [command-line format](https://msdn.microsoft.com/en-au/08dfcab2-eb6e-49a4-80eb-87d4076c98c6).
7980
		 */
7981
		shellArgs?: string[] | string;
7982 7983

		/**
K
kieferrm 已提交
7984
		 * A path or Uri for the current working directory to be used for the terminal.
7985
		 */
K
kieferrm 已提交
7986
		cwd?: string | Uri;
7987

7988 7989 7990
		/**
		 * Object with environment variables that will be added to the VS Code process.
		 */
C
Christof Marti 已提交
7991
		env?: { [key: string]: string | null };
7992 7993 7994 7995 7996

		/**
		 * Whether the terminal process environment should be exactly as provided in
		 * `TerminalOptions.env`. When this is false (default), the environment will be based on the
		 * window's environment and also apply configured platform settings like
D
Daniel Imms 已提交
7997 7998
		 * `terminal.integrated.windows.env` on top. When this is true, the complete environment
		 * must be provided as nothing will be inherited from the process or any configuration.
7999 8000
		 */
		strictEnv?: boolean;
8001 8002 8003 8004 8005 8006 8007 8008

		/**
		 * When enabled the terminal will run the process as normal but not be surfaced to the user
		 * until `Terminal.show` is called. The typical usage for this is when you need to run
		 * something that may need interactivity but only want to tell the user about it when
		 * interaction is needed. Note that the terminals will still be exposed to all extensions
		 * as normal.
		 */
8009
		hideFromUser?: boolean;
E
Erich Gamma 已提交
8010 8011
	}

8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036
	/**
	 * Value-object describing what options a virtual process terminal should use.
	 */
	export interface ExtensionTerminalOptions {
		/**
		 * A human-readable string which will be used to represent the terminal in the UI.
		 */
		name: string;

		/**
		 * An implementation of [Pseudoterminal](#Pseudoterminal) that allows an extension to
		 * control a terminal.
		 */
		pty: Pseudoterminal;
	}

	/**
	 * Defines the interface of a terminal pty, enabling extensions to control a terminal.
	 */
	interface Pseudoterminal {
		/**
		 * An event that when fired will write data to the terminal. Unlike
		 * [Terminal.sendText](#Terminal.sendText) which sends text to the underlying _process_
		 * (the pty "slave"), this will write the text to the terminal itself (the pty "master").
		 *
D
Daniel Imms 已提交
8037 8038 8039
		 * Note writing `\n` will just move the cursor down 1 row, you need to write `\r` as well
		 * to move the cursor to the left-most cell.
		 *
8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058
		 * **Example:** Write red text to the terminal
		 * ```typescript
		 * const writeEmitter = new vscode.EventEmitter<string>();
		 * const pty: vscode.Pseudoterminal = {
		 *   onDidWrite: writeEmitter.event,
		 *   open: () => writeEmitter.fire('\x1b[31mHello world\x1b[0m'),
		 *   close: () => {}
		 * };
		 * vscode.window.createTerminal({ name: 'My terminal', pty });
		 * ```
		 *
		 * **Example:** Move the cursor to the 10th row and 20th column and write an asterisk
		 * ```typescript
		 * writeEmitter.fire('\x1b[10;20H*');
		 * ```
		 */
		onDidWrite: Event<string>;

		/**
8059
		 * An event that when fired allows overriding the [dimensions](#Pseudoterminal.setDimensions) of the
8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089
		 * terminal. Note that when set, the overridden dimensions will only take effect when they
		 * are lower than the actual dimensions of the terminal (ie. there will never be a scroll
		 * bar). Set to `undefined` for the terminal to go back to the regular dimensions (fit to
		 * the size of the panel).
		 *
		 * **Example:** Override the dimensions of a terminal to 20 columns and 10 rows
		 * ```typescript
		 * const dimensionsEmitter = new vscode.EventEmitter<vscode.TerminalDimensions>();
		 * const pty: vscode.Pseudoterminal = {
		 *   onDidWrite: writeEmitter.event,
		 *   onDidOverrideDimensions: dimensionsEmitter.event,
		 *   open: () => {
		 *     dimensionsEmitter.fire({
		 *       columns: 20,
		 *       rows: 10
		 *     });
		 *   },
		 *   close: () => {}
		 * };
		 * vscode.window.createTerminal({ name: 'My terminal', pty });
		 * ```
		 */
		onDidOverrideDimensions?: Event<TerminalDimensions | undefined>;

		/**
		 * An event that when fired will signal that the pty is closed and dispose of the terminal.
		 *
		 * A number can be used to provide an exit code for the terminal. Exit codes must be
		 * positive and a non-zero exit codes signals failure which shows a notification for a
		 * regular terminal and allows dependent tasks to proceed when used with the
8090
		 * `CustomExecution` API.
8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177
		 *
		 * **Example:** Exit the terminal when "y" is pressed, otherwise show a notification.
		 * ```typescript
		 * const writeEmitter = new vscode.EventEmitter<string>();
		 * const closeEmitter = new vscode.EventEmitter<vscode.TerminalDimensions>();
		 * const pty: vscode.Pseudoterminal = {
		 *   onDidWrite: writeEmitter.event,
		 *   onDidClose: closeEmitter.event,
		 *   open: () => writeEmitter.fire('Press y to exit successfully'),
		 *   close: () => {},
		 *   handleInput: data => {
		 *     if (data !== 'y') {
		 *       vscode.window.showInformationMessage('Something went wrong');
		 *     }
		 *     closeEmitter.fire();
		 *   }
		 * };
		 * vscode.window.createTerminal({ name: 'Exit example', pty });
		 */
		onDidClose?: Event<void | number>;

		/**
		 * Implement to handle when the pty is open and ready to start firing events.
		 *
		 * @param initialDimensions The dimensions of the terminal, this will be undefined if the
		 * terminal panel has not been opened before this is called.
		 */
		open(initialDimensions: TerminalDimensions | undefined): void;

		/**
		 * Implement to handle when the terminal is closed by an act of the user.
		 */
		close(): void;

		/**
		 * Implement to handle incoming keystrokes in the terminal or when an extension calls
		 * [Terminal.sendText](#Terminal.sendText). `data` contains the keystrokes/text serialized into
		 * their corresponding VT sequence representation.
		 *
		 * @param data The incoming data.
		 *
		 * **Example:** Echo input in the terminal. The sequence for enter (`\r`) is translated to
		 * CRLF to go to a new line and move the cursor to the start of the line.
		 * ```typescript
		 * const writeEmitter = new vscode.EventEmitter<string>();
		 * const pty: vscode.Pseudoterminal = {
		 *   onDidWrite: writeEmitter.event,
		 *   open: () => {},
		 *   close: () => {},
		 *   handleInput: data => writeEmitter.fire(data === '\r' ? '\r\n' : data)
		 * };
		 * vscode.window.createTerminal({ name: 'Local echo', pty });
		 * ```
		 */
		handleInput?(data: string): void;

		/**
		 * Implement to handle when the number of rows and columns that fit into the terminal panel
		 * changes, for example when font size changes or when the panel is resized. The initial
		 * state of a terminal's dimensions should be treated as `undefined` until this is triggered
		 * as the size of a terminal isn't know until it shows up in the user interface.
		 *
		 * When dimensions are overridden by
		 * [onDidOverrideDimensions](#Pseudoterminal.onDidOverrideDimensions), `setDimensions` will
		 * continue to be called with the regular panel dimensions, allowing the extension continue
		 * to react dimension changes.
		 *
		 * @param dimensions The new dimensions.
		 */
		setDimensions?(dimensions: TerminalDimensions): void;
	}

	/**
	 * Represents the dimensions of a terminal.
	 */
	export interface TerminalDimensions {
		/**
		 * The number of columns in the terminal.
		 */
		readonly columns: number;

		/**
		 * The number of rows in the terminal.
		 */
		readonly rows: number;
	}

8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191
	/**
	 * Represents how a terminal exited.
	 */
	export interface TerminalExitStatus {
		/**
		 * The exit code that a terminal exited with, it can have the following values:
		 * - Zero: the terminal process or custom execution succeeded.
		 * - Non-zero: the terminal process or custom execution failed.
		 * - `undefined`: the user forcibly closed the terminal or a custom execution exited
		 *   without providing an exit code.
		 */
		readonly code: number | undefined;
	}

8192 8193 8194 8195 8196 8197 8198 8199 8200 8201
	export interface TerminalLinkHandler {
		/**
		 * Handles a link that is activated within the terminal.
		 *
		 * @return Whether the link was handled, if the link was handled this link will not be
		 * considered by any other extension or by the default built-in link handler.
		 */
		handleLink(terminal: Terminal, link: string): ProviderResult<boolean>;
	}

J
Johannes Rieken 已提交
8202 8203 8204 8205 8206 8207 8208
	/**
	 * 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 {

		/**
8209
		 * Show progress for the source control viewlet, as overlay for the icon and as progress bar
8210
		 * inside the viewlet (when visible). Neither supports cancellation nor discrete progress.
J
Johannes Rieken 已提交
8211
		 */
8212
		SourceControl = 1,
J
Johannes Rieken 已提交
8213 8214

		/**
8215
		 * Show progress in the status bar of the editor. Neither supports cancellation nor discrete progress.
J
Johannes Rieken 已提交
8216
		 */
8217 8218 8219
		Window = 10,

		/**
8220
		 * Show progress as notification with an optional cancel button. Supports to show infinite and discrete progress.
8221 8222
		 */
		Notification = 15
J
Johannes Rieken 已提交
8223 8224 8225 8226 8227 8228 8229 8230 8231 8232
	}

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

		/**
		 * The location at which progress should show.
		 */
8233
		location: ProgressLocation | { viewId: string };
J
Johannes Rieken 已提交
8234 8235 8236 8237 8238 8239

		/**
		 * A human-readable string which will be used to describe the
		 * operation.
		 */
		title?: string;
8240 8241 8242 8243 8244 8245 8246 8247

		/**
		 * Controls if a cancel button should show to allow the user to
		 * cancel the long running operation.  Note that currently only
		 * `ProgressLocation.Notification` is supporting to show a cancel
		 * button.
		 */
		cancellable?: boolean;
J
Johannes Rieken 已提交
8248 8249
	}

C
Christof Marti 已提交
8250
	/**
8251
	 * A light-weight user input UI that is initially not visible. After
C
Christof Marti 已提交
8252 8253 8254 8255 8256
	 * configuring it through its properties the extension can make it
	 * visible by calling [QuickInput.show](#QuickInput.show).
	 *
	 * There are several reasons why this UI might have to be hidden and
	 * the extension will be notified through [QuickInput.onDidHide](#QuickInput.onDidHide).
8257
	 * (Examples include: an explicit call to [QuickInput.hide](#QuickInput.hide),
C
Christof Marti 已提交
8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325
	 * the user pressing Esc, some other input UI opening, etc.)
	 *
	 * A user pressing Enter or some other gesture implying acceptance
	 * of the current state does not automatically hide this UI component.
	 * It is up to the extension to decide whether to accept the user's input
	 * and if the UI should indeed be hidden through a call to [QuickInput.hide](#QuickInput.hide).
	 *
	 * When the extension no longer needs this input UI, it should
	 * [QuickInput.dispose](#QuickInput.dispose) it to allow for freeing up
	 * any resources associated with it.
	 *
	 * See [QuickPick](#QuickPick) and [InputBox](#InputBox) for concrete UIs.
	 */
	export interface QuickInput {

		/**
		 * An optional title.
		 */
		title: string | undefined;

		/**
		 * An optional current step count.
		 */
		step: number | undefined;

		/**
		 * An optional total step count.
		 */
		totalSteps: number | undefined;

		/**
		 * If the UI should allow for user input. Defaults to true.
		 *
		 * Change this to false, e.g., while validating user input or
		 * loading data for the next step in user input.
		 */
		enabled: boolean;

		/**
		 * If the UI should show a progress indicator. Defaults to false.
		 *
		 * Change this to true, e.g., while loading more data or validating
		 * user input.
		 */
		busy: boolean;

		/**
		 * If the UI should stay open even when loosing UI focus. Defaults to false.
		 */
		ignoreFocusOut: boolean;

		/**
		 * Makes the input UI visible in its current configuration. Any other input
		 * UI will first fire an [QuickInput.onDidHide](#QuickInput.onDidHide) event.
		 */
		show(): void;

		/**
		 * Hides this input UI. This will also fire an [QuickInput.onDidHide](#QuickInput.onDidHide)
		 * event.
		 */
		hide(): void;

		/**
		 * An event signaling when this input UI is hidden.
		 *
		 * There are several reasons why this UI might have to be hidden and
		 * the extension will be notified through [QuickInput.onDidHide](#QuickInput.onDidHide).
8326
		 * (Examples include: an explicit call to [QuickInput.hide](#QuickInput.hide),
C
Christof Marti 已提交
8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409
		 * the user pressing Esc, some other input UI opening, etc.)
		 */
		onDidHide: Event<void>;

		/**
		 * Dispose of this input UI and any associated resources. If it is still
		 * visible, it is first hidden. After this call the input UI is no longer
		 * functional and no additional methods or properties on it should be
		 * accessed. Instead a new input UI should be created.
		 */
		dispose(): void;
	}

	/**
	 * A concrete [QuickInput](#QuickInput) to let the user pick an item from a
	 * list of items of type T. The items can be filtered through a filter text field and
	 * there is an option [canSelectMany](#QuickPick.canSelectMany) to allow for
	 * selecting multiple items.
	 *
	 * Note that in many cases the more convenient [window.showQuickPick](#window.showQuickPick)
	 * is easier to use. [window.createQuickPick](#window.createQuickPick) should be used
	 * when [window.showQuickPick](#window.showQuickPick) does not offer the required flexibility.
	 */
	export interface QuickPick<T extends QuickPickItem> extends QuickInput {

		/**
		 * Current value of the filter text.
		 */
		value: string;

		/**
		 * Optional placeholder in the filter text.
		 */
		placeholder: string | undefined;

		/**
		 * An event signaling when the value of the filter text has changed.
		 */
		readonly onDidChangeValue: Event<string>;

		/**
		 * An event signaling when the user indicated acceptance of the selected item(s).
		 */
		readonly onDidAccept: Event<void>;

		/**
		 * Buttons for actions in the UI.
		 */
		buttons: ReadonlyArray<QuickInputButton>;

		/**
		 * An event signaling when a button was triggered.
		 */
		readonly onDidTriggerButton: Event<QuickInputButton>;

		/**
		 * Items to pick from.
		 */
		items: ReadonlyArray<T>;

		/**
		 * If multiple items can be selected at the same time. Defaults to false.
		 */
		canSelectMany: boolean;

		/**
		 * If the filter text should also be matched against the description of the items. Defaults to false.
		 */
		matchOnDescription: boolean;

		/**
		 * If the filter text should also be matched against the detail of the items. Defaults to false.
		 */
		matchOnDetail: boolean;

		/**
		 * Active items. This can be read and updated by the extension.
		 */
		activeItems: ReadonlyArray<T>;

		/**
		 * An event signaling when the active items have changed.
		 */
8410
		readonly onDidChangeActive: Event<T[]>;
C
Christof Marti 已提交
8411 8412 8413 8414 8415 8416 8417 8418 8419

		/**
		 * Selected items. This can be read and updated by the extension.
		 */
		selectedItems: ReadonlyArray<T>;

		/**
		 * An event signaling when the selected items have changed.
		 */
8420
		readonly onDidChangeSelection: Event<T[]>;
C
Christof Marti 已提交
8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485
	}

	/**
	 * A concrete [QuickInput](#QuickInput) to let the user input a text value.
	 *
	 * Note that in many cases the more convenient [window.showInputBox](#window.showInputBox)
	 * is easier to use. [window.createInputBox](#window.createInputBox) should be used
	 * when [window.showInputBox](#window.showInputBox) does not offer the required flexibility.
	 */
	export interface InputBox extends QuickInput {

		/**
		 * Current input value.
		 */
		value: string;

		/**
		 * Optional placeholder in the filter text.
		 */
		placeholder: string | undefined;

		/**
		 * If the input value should be hidden. Defaults to false.
		 */
		password: boolean;

		/**
		 * An event signaling when the value has changed.
		 */
		readonly onDidChangeValue: Event<string>;

		/**
		 * An event signaling when the user indicated acceptance of the input value.
		 */
		readonly onDidAccept: Event<void>;

		/**
		 * Buttons for actions in the UI.
		 */
		buttons: ReadonlyArray<QuickInputButton>;

		/**
		 * An event signaling when a button was triggered.
		 */
		readonly onDidTriggerButton: Event<QuickInputButton>;

		/**
		 * An optional prompt text providing some ask or explanation to the user.
		 */
		prompt: string | undefined;

		/**
		 * An optional validation message indicating a problem with the current input value.
		 */
		validationMessage: string | undefined;
	}

	/**
	 * Button for an action in a [QuickPick](#QuickPick) or [InputBox](#InputBox).
	 */
	export interface QuickInputButton {

		/**
		 * Icon for the button.
		 */
8486
		readonly iconPath: Uri | { light: Uri; dark: Uri } | ThemeIcon;
C
Christof Marti 已提交
8487 8488 8489 8490 8491 8492 8493 8494 8495 8496

		/**
		 * An optional tooltip.
		 */
		readonly tooltip?: string | undefined;
	}

	/**
	 * Predefined buttons for [QuickPick](#QuickPick) and [InputBox](#InputBox).
	 */
8497
	export class QuickInputButtons {
C
Christof Marti 已提交
8498 8499 8500 8501 8502 8503 8504

		/**
		 * A back button for [QuickPick](#QuickPick) and [InputBox](#InputBox).
		 *
		 * When a navigation 'back' button is needed this one should be used for consistency.
		 * It comes with a predefined icon, tooltip and location.
		 */
8505 8506 8507 8508 8509 8510
		static readonly Back: QuickInputButton;

		/**
		 * @hidden
		 */
		private constructor();
C
Christof Marti 已提交
8511 8512
	}

E
Erich Gamma 已提交
8513
	/**
A
Alex Dima 已提交
8514
	 * An event describing an individual change in the text of a [document](#TextDocument).
E
Erich Gamma 已提交
8515 8516 8517 8518 8519
	 */
	export interface TextDocumentContentChangeEvent {
		/**
		 * The range that got replaced.
		 */
8520
		readonly range: Range;
8521 8522 8523
		/**
		 * The offset of the range that got replaced.
		 */
8524
		readonly rangeOffset: number;
E
Erich Gamma 已提交
8525 8526 8527
		/**
		 * The length of the range that got replaced.
		 */
8528
		readonly rangeLength: number;
E
Erich Gamma 已提交
8529 8530 8531
		/**
		 * The new text for the range.
		 */
8532
		readonly text: string;
E
Erich Gamma 已提交
8533 8534 8535
	}

	/**
A
Alex Dima 已提交
8536
	 * An event describing a transactional [document](#TextDocument) change.
E
Erich Gamma 已提交
8537 8538 8539 8540 8541 8542
	 */
	export interface TextDocumentChangeEvent {

		/**
		 * The affected document.
		 */
8543
		readonly document: TextDocument;
E
Erich Gamma 已提交
8544 8545 8546 8547

		/**
		 * An array of content changes.
		 */
8548
		readonly contentChanges: ReadonlyArray<TextDocumentContentChangeEvent>;
E
Erich Gamma 已提交
8549 8550
	}

8551 8552 8553 8554 8555 8556
	/**
	 * Represents reasons why a text document is saved.
	 */
	export enum TextDocumentSaveReason {

		/**
8557 8558
		 * Manually triggered, e.g. by the user pressing save, by starting debugging,
		 * or by an API call.
8559
		 */
8560
		Manual = 1,
8561 8562 8563 8564

		/**
		 * Automatic after a delay.
		 */
8565
		AfterDelay = 2,
8566 8567 8568 8569 8570 8571 8572

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

8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584
	/**
	 * 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.
		 */
8585
		readonly document: TextDocument;
8586

8587 8588 8589
		/**
		 * The reason why save was triggered.
		 */
8590
		readonly reason: TextDocumentSaveReason;
8591

8592 8593 8594 8595 8596 8597 8598 8599 8600 8601
		/**
		 * 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 => {
8602 8603 8604 8605 8606
		 * 	// async, will *throw* an error
		 * 	setTimeout(() => event.waitUntil(promise));
		 *
		 * 	// sync, OK
		 * 	event.waitUntil(promise);
8607 8608 8609 8610 8611
		 * })
		 * ```
		 *
		 * @param thenable A thenable that resolves to [pre-save-edits](#TextEdit).
		 */
8612
		waitUntil(thenable: Thenable<TextEdit[]>): void;
8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623

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

J
Johannes Rieken 已提交
8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789
	/**
	 * An event that is fired when files are going to be created.
	 *
	 * To make modifications to the workspace before the files are created,
	 * call the [`waitUntil](#FileWillCreateEvent.waitUntil)-function with a
	 * thenable that resolves to a [workspace edit](#WorkspaceEdit).
	 */
	export interface FileWillCreateEvent {

		/**
		 * The files that are going to be created.
		 */
		readonly files: ReadonlyArray<Uri>;

		/**
		 * Allows to pause the event and to apply a [workspace edit](#WorkspaceEdit).
		 *
		 * *Note:* This function can only be called during event dispatch and not
		 * in an asynchronous manner:
		 *
		 * ```ts
		 * workspace.onWillCreateFiles(event => {
		 * 	// async, will *throw* an error
		 * 	setTimeout(() => event.waitUntil(promise));
		 *
		 * 	// sync, OK
		 * 	event.waitUntil(promise);
		 * })
		 * ```
		 *
		 * @param thenable A thenable that delays saving.
		 */
		waitUntil(thenable: Thenable<WorkspaceEdit>): void;

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

	/**
	 * An event that is fired after files are created.
	 */
	export interface FileCreateEvent {

		/**
		 * The files that got created.
		 */
		readonly files: ReadonlyArray<Uri>;
	}

	/**
	 * An event that is fired when files are going to be deleted.
	 *
	 * To make modifications to the workspace before the files are deleted,
	 * call the [`waitUntil](#FileWillCreateEvent.waitUntil)-function with a
	 * thenable that resolves to a [workspace edit](#WorkspaceEdit).
	 */
	export interface FileWillDeleteEvent {

		/**
		 * The files that are going to be deleted.
		 */
		readonly files: ReadonlyArray<Uri>;

		/**
		 * Allows to pause the event and to apply a [workspace edit](#WorkspaceEdit).
		 *
		 * *Note:* This function can only be called during event dispatch and not
		 * in an asynchronous manner:
		 *
		 * ```ts
		 * workspace.onWillCreateFiles(event => {
		 * 	// async, will *throw* an error
		 * 	setTimeout(() => event.waitUntil(promise));
		 *
		 * 	// sync, OK
		 * 	event.waitUntil(promise);
		 * })
		 * ```
		 *
		 * @param thenable A thenable that delays saving.
		 */
		waitUntil(thenable: Thenable<WorkspaceEdit>): void;

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

	/**
	 * An event that is fired after files are deleted.
	 */
	export interface FileDeleteEvent {

		/**
		 * The files that got deleted.
		 */
		readonly files: ReadonlyArray<Uri>;
	}

	/**
	 * An event that is fired when files are going to be renamed.
	 *
	 * To make modifications to the workspace before the files are renamed,
	 * call the [`waitUntil](#FileWillCreateEvent.waitUntil)-function with a
	 * thenable that resolves to a [workspace edit](#WorkspaceEdit).
	 */
	export interface FileWillRenameEvent {

		/**
		 * The files that are going to be renamed.
		 */
		readonly files: ReadonlyArray<{ oldUri: Uri, newUri: Uri }>;

		/**
		 * Allows to pause the event and to apply a [workspace edit](#WorkspaceEdit).
		 *
		 * *Note:* This function can only be called during event dispatch and not
		 * in an asynchronous manner:
		 *
		 * ```ts
		 * workspace.onWillCreateFiles(event => {
		 * 	// async, will *throw* an error
		 * 	setTimeout(() => event.waitUntil(promise));
		 *
		 * 	// sync, OK
		 * 	event.waitUntil(promise);
		 * })
		 * ```
		 *
		 * @param thenable A thenable that delays saving.
		 */
		waitUntil(thenable: Thenable<WorkspaceEdit>): void;

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

	/**
	 * An event that is fired after files are renamed.
	 */
	export interface FileRenameEvent {

		/**
		 * The files that got renamed.
		 */
		readonly files: ReadonlyArray<{ oldUri: Uri, newUri: Uri }>;
	}


8790 8791 8792 8793 8794 8795 8796
	/**
	 * An event describing a change to the set of [workspace folders](#workspace.workspaceFolders).
	 */
	export interface WorkspaceFoldersChangeEvent {
		/**
		 * Added workspace folders.
		 */
8797
		readonly added: ReadonlyArray<WorkspaceFolder>;
8798 8799 8800 8801

		/**
		 * Removed workspace folders.
		 */
8802
		readonly removed: ReadonlyArray<WorkspaceFolder>;
8803 8804 8805 8806
	}

	/**
	 * A workspace folder is one of potentially many roots opened by the editor. All workspace folders
8807
	 * are equal which means there is no notion of an active or master workspace folder.
8808 8809 8810 8811
	 */
	export interface WorkspaceFolder {

		/**
J
Johannes Rieken 已提交
8812 8813 8814 8815
		 * 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`.
8816 8817 8818 8819 8820
		 */
		readonly uri: Uri;

		/**
		 * The name of this workspace folder. Defaults to
J
Johannes Rieken 已提交
8821
		 * the basename of its [uri-path](#Uri.path)
8822 8823 8824 8825 8826 8827 8828 8829 8830
		 */
		readonly name: string;

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

E
Erich Gamma 已提交
8831
	/**
8832 8833 8834 8835 8836
	 * 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
8837
	 * events and for [finding](#workspace.findFiles) files. Both perform well and run _outside_
S
Steven Clarke 已提交
8838
	 * the editor-process so that they should be always used instead of nodejs-equivalents.
E
Erich Gamma 已提交
8839 8840 8841
	 */
	export namespace workspace {

8842 8843 8844 8845 8846 8847 8848 8849
		/**
		 * A [file system](#FileSystem) instance that allows to interact with local and remote
		 * files, e.g. `vscode.workspace.fs.readDirectory(someUri)` allows to retrieve all entries
		 * of a directory or `vscode.workspace.fs.stat(anotherUri)` returns the meta data for a
		 * file.
		 */
		export const fs: FileSystem;

E
Erich Gamma 已提交
8850
		/**
8851 8852
		 * ~~The folder that is open in the editor. `undefined` when no folder
		 * has been opened.~~
J
Johannes Rieken 已提交
8853
		 *
8854
		 * @deprecated Use [`workspaceFolders`](#workspace.workspaceFolders) instead.
E
Erich Gamma 已提交
8855
		 */
8856
		export const rootPath: string | undefined;
E
Erich Gamma 已提交
8857 8858

		/**
J
Johannes Rieken 已提交
8859 8860
		 * List of workspace folders or `undefined` when no folder is open.
		 * *Note* that the first entry corresponds to the value of `rootPath`.
E
Erich Gamma 已提交
8861
		 */
8862
		export const workspaceFolders: ReadonlyArray<WorkspaceFolder> | undefined;
8863

8864 8865 8866 8867
		/**
		 * The name of the workspace. `undefined` when no folder
		 * has been opened.
		 */
8868
		export const name: string | undefined;
8869

8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900
		/**
		 * The location of the workspace file, for example:
		 *
		 * `file:///Users/name/Development/myProject.code-workspace`
		 *
		 * or
		 *
		 * `untitled:1555503116870`
		 *
		 * for a workspace that is untitled and not yet saved.
		 *
		 * Depending on the workspace that is opened, the value will be:
		 *  * `undefined` when no workspace or  a single folder is opened
		 *  * the path of the workspace file as `Uri` otherwise. if the workspace
		 * is untitled, the returned URI will use the `untitled:` scheme
		 *
		 * The location can e.g. be used with the `vscode.openFolder` command to
		 * open the workspace again after it has been closed.
		 *
		 * **Example:**
		 * ```typescript
		 * vscode.commands.executeCommand('vscode.openFolder', uriOfWorkspace);
		 * ```
		 *
		 * **Note:** it is not advised to use `workspace.workspaceFile` to write
		 * configuration data into the file. You can use `workspace.getConfiguration().update()`
		 * for that purpose which will work both when a single folder is opened as
		 * well as an untitled or saved workspace.
		 */
		export const workspaceFile: Uri | undefined;

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

		/**
8907 8908 8909
		 * Returns the [workspace folder](#WorkspaceFolder) that contains a given uri.
		 * * returns `undefined` when the given uri doesn't match any workspace folder
		 * * returns the *input* when the given uri is a workspace folder itself
8910 8911 8912 8913 8914
		 *
		 * @param uri An uri.
		 * @return A workspace folder or `undefined`
		 */
		export function getWorkspaceFolder(uri: Uri): WorkspaceFolder | undefined;
E
Erich Gamma 已提交
8915 8916

		/**
8917
		 * Returns a path that is relative to the workspace folder or folders.
J
Johannes Rieken 已提交
8918
		 *
8919
		 * When there are no [workspace folders](#workspace.workspaceFolders) or when the path
J
Johannes Rieken 已提交
8920
		 * is not contained in them, the input is returned.
J
Johannes Rieken 已提交
8921 8922
		 *
		 * @param pathOrUri A path or uri. When a uri is given its [fsPath](#Uri.fsPath) is used.
J
Johannes Rieken 已提交
8923 8924 8925
		 * @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 已提交
8926
		 * @return A path relative to the root or the input.
E
Erich Gamma 已提交
8927
		 */
J
Johannes Rieken 已提交
8928
		export function asRelativePath(pathOrUri: string | Uri, includeWorkspaceFolder?: boolean): string;
E
Erich Gamma 已提交
8929

8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972
		/**
		 * This method replaces `deleteCount` [workspace folders](#workspace.workspaceFolders) starting at index `start`
		 * by an optional set of `workspaceFoldersToAdd` on the `vscode.workspace.workspaceFolders` array. This "splice"
		 * behavior can be used to add, remove and change workspace folders in a single operation.
		 *
		 * If the first workspace folder is added, removed or changed, the currently executing extensions (including the
		 * one that called this method) will be terminated and restarted so that the (deprecated) `rootPath` property is
		 * updated to point to the first workspace folder.
		 *
		 * Use the [`onDidChangeWorkspaceFolders()`](#onDidChangeWorkspaceFolders) event to get notified when the
		 * workspace folders have been updated.
		 *
		 * **Example:** adding a new workspace folder at the end of workspace folders
		 * ```typescript
		 * workspace.updateWorkspaceFolders(workspace.workspaceFolders ? workspace.workspaceFolders.length : 0, null, { uri: ...});
		 * ```
		 *
		 * **Example:** removing the first workspace folder
		 * ```typescript
		 * workspace.updateWorkspaceFolders(0, 1);
		 * ```
		 *
		 * **Example:** replacing an existing workspace folder with a new one
		 * ```typescript
		 * workspace.updateWorkspaceFolders(0, 1, { uri: ...});
		 * ```
		 *
		 * It is valid to remove an existing workspace folder and add it again with a different name
		 * to rename that folder.
		 *
		 * **Note:** it is not valid to call [updateWorkspaceFolders()](#updateWorkspaceFolders) multiple times
		 * without waiting for the [`onDidChangeWorkspaceFolders()`](#onDidChangeWorkspaceFolders) to fire.
		 *
		 * @param start the zero-based location in the list of currently opened [workspace folders](#WorkspaceFolder)
		 * from which to start deleting workspace folders.
		 * @param deleteCount the optional number of workspace folders to remove.
		 * @param workspaceFoldersToAdd the optional variable set of workspace folders to add in place of the deleted ones.
		 * Each workspace is identified with a mandatory URI and an optional name.
		 * @return true if the operation was successfully started and false otherwise if arguments were used that would result
		 * in invalid workspace folder state (e.g. 2 folders with the same URI).
		 */
		export function updateWorkspaceFolders(start: number, deleteCount: number | undefined | null, ...workspaceFoldersToAdd: { uri: Uri, name?: string }[]): boolean;

8973 8974 8975
		/**
		 * Creates a file system watcher.
		 *
8976 8977
		 * 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.
8978
		 *
8979
		 * *Note* that only files within the current [workspace folders](#workspace.workspaceFolders) can be watched.
8980
		 *
8981
		 * @param globPattern A [glob pattern](#GlobPattern) that is applied to the absolute paths of created, changed,
B
Benjamin Pasero 已提交
8982
		 * and deleted files. Use a [relative pattern](#RelativePattern) to limit events to a certain [workspace folder](#WorkspaceFolder).
8983 8984 8985 8986 8987
		 * @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.
		 */
8988
		export function createFileSystemWatcher(globPattern: GlobPattern, ignoreCreateEvents?: boolean, ignoreChangeEvents?: boolean, ignoreDeleteEvents?: boolean): FileSystemWatcher;
8989

J
Johannes Rieken 已提交
8990
		/**
B
Benjamin Pasero 已提交
8991
		 * Find files across all [workspace folders](#workspace.workspaceFolders) in the workspace.
J
Johannes Rieken 已提交
8992
		 *
8993
		 * @sample `findFiles('**​/*.js', '**​/node_modules/**', 10)`
8994
		 * @param include A [glob pattern](#GlobPattern) that defines the files to search for. The glob pattern
B
Benjamin Pasero 已提交
8995 8996
		 * 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).
8997
		 * @param exclude  A [glob pattern](#GlobPattern) that defines files and folders to exclude. The glob pattern
J
Johannes Rieken 已提交
8998
		 * will be matched against the file paths of resulting matches relative to their workspace. When `undefined` only default excludes will
8999
		 * apply, when `null` no excludes will apply.
J
Johannes Rieken 已提交
9000
		 * @param maxResults An upper-bound for the result.
9001
		 * @param token A token that can be used to signal cancellation to the underlying search engine.
B
Benjamin Pasero 已提交
9002 9003
		 * @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 已提交
9004
		 */
J
Johannes Rieken 已提交
9005
		export function findFiles(include: GlobPattern, exclude?: GlobPattern | null, maxResults?: number, token?: CancellationToken): Thenable<Uri[]>;
E
Erich Gamma 已提交
9006 9007

		/**
J
Johannes Rieken 已提交
9008 9009 9010
		 * Save all dirty files.
		 *
		 * @param includeUntitled Also save files that have been created during this session.
S
Steven Clarke 已提交
9011
		 * @return A thenable that resolves when the files have been saved.
E
Erich Gamma 已提交
9012 9013 9014 9015
		 */
		export function saveAll(includeUntitled?: boolean): Thenable<boolean>;

		/**
9016
		 * Make changes to one or many resources or create, delete, and rename resources as defined by the given
J
Johannes Rieken 已提交
9017 9018
		 * [workspace edit](#WorkspaceEdit).
		 *
9019 9020
		 * All changes of a workspace edit are applied in the same order in which they have been added. If
		 * multiple textual inserts are made at the same position, these strings appear in the resulting text
J
Johannes Rieken 已提交
9021 9022
		 * in the order the 'inserts' were made, unless that are interleaved with resource edits. Invalid sequences
		 * like 'delete file a' -> 'insert text in file a' cause failure of the operation.
9023 9024
		 *
		 * When applying a workspace edit that consists only of text edits an 'all-or-nothing'-strategy is used.
9025
		 * A workspace edit with resource creations or deletions aborts the operation, e.g. consecutive edits will
9026
		 * not be attempted, when a single edit fails.
J
Johannes Rieken 已提交
9027 9028 9029
		 *
		 * @param edit A workspace edit.
		 * @return A thenable that resolves when the edit could be applied.
E
Erich Gamma 已提交
9030 9031 9032 9033 9034 9035
		 */
		export function applyEdit(edit: WorkspaceEdit): Thenable<boolean>;

		/**
		 * All text documents currently known to the system.
		 */
9036
		export const textDocuments: ReadonlyArray<TextDocument>;
E
Erich Gamma 已提交
9037 9038

		/**
9039 9040 9041 9042 9043 9044 9045 9046
		 * 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.
J
Johannes Rieken 已提交
9047 9048
		 * * For all other schemes contributed [text document content providers](#TextDocumentContentProvider) and
		 * [file system providers](#FileSystemProvider) are consulted.
9049 9050 9051
		 *
		 * *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 已提交
9052 9053 9054 9055 9056 9057 9058
		 *
		 * @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 已提交
9059 9060 9061
		 * A short-hand for `openTextDocument(Uri.file(fileName))`.
		 *
		 * @see [openTextDocument](#openTextDocument)
A
Andre Weinand 已提交
9062 9063
		 * @param fileName A name of a file on disk.
		 * @return A promise that resolves to a [document](#TextDocument).
E
Erich Gamma 已提交
9064 9065 9066
		 */
		export function openTextDocument(fileName: string): Thenable<TextDocument>;

B
Benjamin Pasero 已提交
9067
		/**
J
Johannes Rieken 已提交
9068 9069
		 * 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
9070
		 * specify the *language* and/or the *content* of the document.
B
Benjamin Pasero 已提交
9071
		 *
J
Johannes Rieken 已提交
9072
		 * @param options Options to control how the document will be created.
B
Benjamin Pasero 已提交
9073 9074
		 * @return A promise that resolves to a [document](#TextDocument).
		 */
9075
		export function openTextDocument(options?: { language?: string; content?: string; }): Thenable<TextDocument>;
B
Benjamin Pasero 已提交
9076

J
Johannes Rieken 已提交
9077
		/**
9078 9079 9080
		 * Register a text document content provider.
		 *
		 * Only one provider can be registered per scheme.
J
Johannes Rieken 已提交
9081
		 *
9082 9083 9084
		 * @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 已提交
9085 9086 9087
		 */
		export function registerTextDocumentContentProvider(scheme: string, provider: TextDocumentContentProvider): Disposable;

A
Alex Dima 已提交
9088
		/**
J
Johannes Rieken 已提交
9089 9090
		 * An event that is emitted when a [text document](#TextDocument) is opened or when the language id
		 * of a text document [has been changed](#languages.setTextDocumentLanguage).
9091 9092
		 *
		 * To add an event listener when a visible text document is opened, use the [TextEditor](#TextEditor) events in the
J
Johannes Rieken 已提交
9093
		 * [window](#window) namespace. Note that:
9094 9095 9096 9097 9098
		 *
		 * - The event is emitted before the [document](#TextDocument) is updated in the
		 * [active text editor](#window.activeTextEditor)
		 * - When a [text document](#TextDocument) is already open (e.g.: open in another [visible text editor](#window.visibleTextEditors)) this event is not emitted
		 *
A
Alex Dima 已提交
9099
		 */
E
Erich Gamma 已提交
9100 9101
		export const onDidOpenTextDocument: Event<TextDocument>;

A
Alex Dima 已提交
9102
		/**
J
Johannes Rieken 已提交
9103 9104
		 * An event that is emitted when a [text document](#TextDocument) is disposed or when the language id
		 * of a text document [has been changed](#languages.setTextDocumentLanguage).
9105 9106
		 *
		 * To add an event listener when a visible text document is closed, use the [TextEditor](#TextEditor) events in the
J
Johannes Rieken 已提交
9107
		 * [window](#window) namespace. Note that this event is not emitted when a [TextEditor](#TextEditor) is closed
S
Sean Poulter 已提交
9108
		 * but the document remains open in another [visible text editor](#window.visibleTextEditors).
A
Alex Dima 已提交
9109
		 */
E
Erich Gamma 已提交
9110 9111
		export const onDidCloseTextDocument: Event<TextDocument>;

A
Alex Dima 已提交
9112
		/**
9113 9114
		 * 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
9115
		 * [dirty](#TextDocument.isDirty)-state changes.
A
Alex Dima 已提交
9116
		 */
E
Erich Gamma 已提交
9117 9118
		export const onDidChangeTextDocument: Event<TextDocumentChangeEvent>;

9119 9120
		/**
		 * An event that is emitted when a [text document](#TextDocument) will be saved to disk.
9121
		 *
J
Johannes Rieken 已提交
9122
		 * *Note 1:* Subscribers can delay saving by registering asynchronous work. For the sake of data integrity the editor
9123 9124 9125 9126 9127 9128 9129 9130
		 * 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.
9131 9132 9133
		 */
		export const onWillSaveTextDocument: Event<TextDocumentWillSaveEvent>;

A
Alex Dima 已提交
9134 9135 9136
		/**
		 * An event that is emitted when a [text document](#TextDocument) is saved to disk.
		 */
E
Erich Gamma 已提交
9137 9138
		export const onDidSaveTextDocument: Event<TextDocument>;

J
Johannes Rieken 已提交
9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208
		/**
		 * An event that is emitted when files are being created.
		 *
		 * *Note 1:* This event is triggered by user gestures, like creating a file from the
		 * explorer, or from the [`workspace.applyEdit`](#workspace.applyEdit)-api. This event is *not* fired when
		 * files change on disk, e.g triggered by another application, or when using the
		 * [`workspace.fs`](#FileSystem)-api.
		 *
		 * *Note 2:* When this event is fired, edits to files thare are being created cannot be applied.
		 */
		export const onWillCreateFiles: Event<FileWillCreateEvent>;

		/**
		 * An event that is emitted when files have been created.
		 *
		 * *Note:* This event is triggered by user gestures, like creating a file from the
		 * explorer, or from the [`workspace.applyEdit`](#workspace.applyEdit)-api, but this event is *not* fired when
		 * files change on disk, e.g triggered by another application, or when using the
		 * [`workspace.fs`](#FileSystem)-api.
		 */
		export const onDidCreateFiles: Event<FileCreateEvent>;

		/**
		 * An event that is emitted when files are being deleted.
		 *
		 * *Note 1:* This event is triggered by user gestures, like deleting a file from the
		 * explorer, or from the [`workspace.applyEdit`](#workspace.applyEdit)-api, but this event is *not* fired when
		 * files change on disk, e.g triggered by another application, or when using the
		 * [`workspace.fs`](#FileSystem)-api.
		 *
		 * *Note 2:* When deleting a folder with children only one event is fired.
		 */
		export const onWillDeleteFiles: Event<FileWillDeleteEvent>;

		/**
		 * An event that is emitted when files have been deleted.
		 *
		 * *Note 1:* This event is triggered by user gestures, like deleting a file from the
		 * explorer, or from the [`workspace.applyEdit`](#workspace.applyEdit)-api, but this event is *not* fired when
		 * files change on disk, e.g triggered by another application, or when using the
		 * [`workspace.fs`](#FileSystem)-api.
		 *
		 * *Note 2:* When deleting a folder with children only one event is fired.
		 */
		export const onDidDeleteFiles: Event<FileDeleteEvent>;

		/**
		 * An event that is emitted when files are being renamed.
		 *
		 * *Note 1:* This event is triggered by user gestures, like renaming a file from the
		 * explorer, and from the [`workspace.applyEdit`](#workspace.applyEdit)-api, but this event is *not* fired when
		 * files change on disk, e.g triggered by another application, or when using the
		 * [`workspace.fs`](#FileSystem)-api.
		 *
		 * *Note 2:* When renaming a folder with children only one event is fired.
		 */
		export const onWillRenameFiles: Event<FileWillRenameEvent>;

		/**
		 * An event that is emitted when files have been renamed.
		 *
		 * *Note 1:* This event is triggered by user gestures, like renaming a file from the
		 * explorer, and from the [`workspace.applyEdit`](#workspace.applyEdit)-api, but this event is *not* fired when
		 * files change on disk, e.g triggered by another application, or when using the
		 * [`workspace.fs`](#FileSystem)-api.
		 *
		 * *Note 2:* When renaming a folder with children only one event is fired.
		 */
		export const onDidRenameFiles: Event<FileRenameEvent>;

E
Erich Gamma 已提交
9209
		/**
S
Sandeep Somavarapu 已提交
9210 9211 9212 9213 9214 9215
		 * Get a workspace configuration object.
		 *
		 * When a section-identifier is provided only that part of the configuration
		 * is returned. Dots in the section-identifier are interpreted as child-access,
		 * like `{ myExt: { setting: { doIt: true }}}` and `getConfiguration('myExt.setting').get('doIt') === true`.
		 *
S
Sandeep Somavarapu 已提交
9216
		 * When a scope is provided configuraiton confined to that scope is returned. Scope can be a resource or a language identifier or both.
J
Johannes Rieken 已提交
9217
		 *
S
Sandeep Somavarapu 已提交
9218
		 * @param section A dot-separated identifier.
S
Sandeep Somavarapu 已提交
9219
		 * @param scope A scope for which the configuration is asked for.
S
Sandeep Somavarapu 已提交
9220 9221
		 * @return The full configuration or a subset.
		 */
S
Sandeep Somavarapu 已提交
9222
		export function getConfiguration(section?: string | undefined, scope?: ConfigurationScope | null): WorkspaceConfiguration;
E
Erich Gamma 已提交
9223

J
Johannes Rieken 已提交
9224 9225 9226
		/**
		 * An event that is emitted when the [configuration](#WorkspaceConfiguration) changed.
		 */
S
Sandeep Somavarapu 已提交
9227
		export const onDidChangeConfiguration: Event<ConfigurationChangeEvent>;
9228 9229

		/**
J
Johannes Rieken 已提交
9230 9231 9232
		 * ~~Register a task provider.~~
		 *
		 * @deprecated Use the corresponding function on the `tasks` namespace instead
9233 9234 9235 9236 9237 9238
		 *
		 * @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;
9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250

		/**
		 * Register a filesystem provider for a given scheme, e.g. `ftp`.
		 *
		 * There can only be one provider per scheme and an error is being thrown when a scheme
		 * has been claimed by another provider or when it is reserved.
		 *
		 * @param scheme The uri-[scheme](#Uri.scheme) the provider registers for.
		 * @param provider The filesystem provider.
		 * @param options Immutable metadata about the provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
M
Matt Bierner 已提交
9251
		export function registerFileSystemProvider(scheme: string, provider: FileSystemProvider, options?: { readonly isCaseSensitive?: boolean, readonly isReadonly?: boolean }): Disposable;
E
Erich Gamma 已提交
9252 9253
	}

S
Sandeep Somavarapu 已提交
9254 9255 9256 9257 9258 9259
	/**
	 * The configuration scope which can be a
	 * a 'resource' or a languageId or both or
	 * a '[TextDocument](#TextDocument)' or
	 * a '[WorkspaceFolder](#WorkspaceFolder)'
	 */
S
Sandeep Somavarapu 已提交
9260 9261
	export type ConfigurationScope = Uri | TextDocument | WorkspaceFolder | { uri?: Uri, languageId: string };

S
Sandeep Somavarapu 已提交
9262 9263 9264 9265 9266 9267
	/**
	 * An event describing the change in Configuration
	 */
	export interface ConfigurationChangeEvent {

		/**
S
Sandeep Somavarapu 已提交
9268
		 * Returns `true` if the given section is affected in the provided scope.
S
Sandeep Somavarapu 已提交
9269 9270
		 *
		 * @param section Configuration name, supports _dotted_ names.
S
Sandeep Somavarapu 已提交
9271 9272
		 * @param scope A scope in which to check.
		 * @return `true` if the given section is affected in the provided scope.
S
Sandeep Somavarapu 已提交
9273
		 */
S
Sandeep Somavarapu 已提交
9274
		affectsConfiguration(section: string, scope?: ConfigurationScope): boolean;
S
Sandeep Somavarapu 已提交
9275 9276
	}

J
Johannes Rieken 已提交
9277
	/**
9278 9279 9280 9281 9282 9283 9284
	 * 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 已提交
9285
	 * The editor provides an API that makes it simple to provide such common features by having all UI and actions already in place and
9286 9287 9288 9289 9290 9291
	 * 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', {
9292 9293 9294
	 * 	provideHover(document, position, token) {
	 * 		return new Hover('I am a hover!');
	 * 	}
9295 9296
	 * });
	 * ```
9297 9298 9299
	 *
	 * 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 已提交
9300
	 * a selector will result in a [score](#languages.match) that is used to determine if and how a provider shall be used. When
9301 9302 9303
	 * 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 已提交
9304
	 */
E
Erich Gamma 已提交
9305 9306 9307 9308 9309 9310 9311 9312
	export namespace languages {

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

9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325
		/**
		 * Set (and change) the [language](#TextDocument.languageId) that is associated
		 * with the given document.
		 *
		 * *Note* that calling this function will trigger the [`onDidCloseTextDocument`](#workspace.onDidCloseTextDocument) event
		 * followed by the [`onDidOpenTextDocument`](#workspace.onDidOpenTextDocument) event.
		 *
		 * @param document The document which language is to be changed
		 * @param languageId The new language identifier.
		 * @returns A thenable that resolves with the updated document.
		 */
		export function setTextDocumentLanguage(document: TextDocument, languageId: string): Thenable<TextDocument>;

E
Erich Gamma 已提交
9326
		/**
J
Johannes Rieken 已提交
9327
		 * Compute the match between a document [selector](#DocumentSelector) and a document. Values
9328 9329 9330
		 * greater than zero mean the selector matches the document.
		 *
		 * A match is computed according to these rules:
9331 9332
		 * 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" }`.
9333 9334
		 * 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`
9335 9336
		 *  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`
9337
		 *  4. The result is the maximum value of each match
9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353
		 *
		 * 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'
9354
		 * match('javascript', doc); // 10;
9355 9356
		 * match({language: 'javascript', scheme: 'git'}, doc); // 10;
		 * match('*', doc); // 5
9357
		 * ```
J
Johannes Rieken 已提交
9358 9359 9360
		 *
		 * @param selector A document selector.
		 * @param document A text document.
J
Johannes Rieken 已提交
9361
		 * @return A number `>0` when the selector matches and `0` when the selector does not match.
E
Erich Gamma 已提交
9362 9363 9364
		 */
		export function match(selector: DocumentSelector, document: TextDocument): number;

9365 9366 9367 9368 9369 9370 9371
		/**
		 * An [event](#Event) which fires when the global set of diagnostics changes. This is
		 * newly added and removed diagnostics.
		 */
		export const onDidChangeDiagnostics: Event<DiagnosticChangeEvent>;

		/**
9372
		 * Get all diagnostics for a given resource.
9373 9374
		 *
		 * @param resource A resource
9375
		 * @returns An array of [diagnostics](#Diagnostic) objects or an empty array.
9376 9377 9378 9379
		 */
		export function getDiagnostics(resource: Uri): Diagnostic[];

		/**
9380
		 * Get all diagnostics.
9381 9382 9383 9384 9385
		 *
		 * @returns An array of uri-diagnostics tuples or an empty array.
		 */
		export function getDiagnostics(): [Uri, Diagnostic[]][];

E
Erich Gamma 已提交
9386
		/**
S
Steven Clarke 已提交
9387
		 * Create a diagnostics collection.
J
Johannes Rieken 已提交
9388 9389 9390
		 *
		 * @param name The [name](#DiagnosticCollection.name) of the collection.
		 * @return A new diagnostic collection.
E
Erich Gamma 已提交
9391 9392 9393 9394
		 */
		export function createDiagnosticCollection(name?: string): DiagnosticCollection;

		/**
J
Johannes Rieken 已提交
9395 9396 9397
		 * Register a completion provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
9398
		 * by their [score](#languages.match) and groups of equal score are sequentially asked for
J
Johannes Rieken 已提交
9399
		 * completion items. The process stops when one or many providers of a group return a
9400 9401
		 * result. A failing provider (rejected promise or exception) will not fail the whole
		 * operation.
E
Erich Gamma 已提交
9402
		 *
9403 9404 9405 9406 9407
		 * A completion item provider can be associated with a set of `triggerCharacters`. When trigger
		 * characters are being typed, completions are requested but only from providers that registered
		 * the typed character. Because of that trigger characters should be different than [word characters](#LanguageConfiguration.wordPattern),
		 * a common trigger character is `.` to trigger member completions.
		 *
J
Johannes Rieken 已提交
9408 9409
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A completion provider.
9410
		 * @param triggerCharacters Trigger completion when the user types one of the characters.
J
Johannes Rieken 已提交
9411 9412 9413 9414 9415
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerCompletionItemProvider(selector: DocumentSelector, provider: CompletionItemProvider, ...triggerCharacters: string[]): Disposable;

		/**
J
Johannes Rieken 已提交
9416 9417 9418
		 * Register a code action provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
9419 9420
		 * 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 已提交
9421 9422
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
J
Johannes Rieken 已提交
9423
		 * @param provider A code action provider.
9424
		 * @param metadata Metadata about the kind of code actions the provider providers.
J
Johannes Rieken 已提交
9425
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
9426
		 */
9427
		export function registerCodeActionsProvider(selector: DocumentSelector, provider: CodeActionProvider, metadata?: CodeActionProviderMetadata): Disposable;
E
Erich Gamma 已提交
9428 9429

		/**
J
Johannes Rieken 已提交
9430 9431 9432
		 * Register a code lens provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
9433 9434
		 * 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 已提交
9435
		 *
J
Johannes Rieken 已提交
9436 9437 9438
		 * @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 已提交
9439
		 */
J
Johannes Rieken 已提交
9440
		export function registerCodeLensProvider(selector: DocumentSelector, provider: CodeLensProvider): Disposable;
E
Erich Gamma 已提交
9441 9442

		/**
J
Johannes Rieken 已提交
9443 9444 9445
		 * Register a definition provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
9446 9447
		 * 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 已提交
9448
		 *
J
Johannes Rieken 已提交
9449 9450 9451
		 * @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 已提交
9452 9453 9454
		 */
		export function registerDefinitionProvider(selector: DocumentSelector, provider: DefinitionProvider): Disposable;

9455
		/**
9456
		 * Register an implementation provider.
9457
		 *
9458 9459 9460
		 * 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.
9461 9462 9463 9464 9465
		 *
		 * @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 已提交
9466
		export function registerImplementationProvider(selector: DocumentSelector, provider: ImplementationProvider): Disposable;
9467

9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479 9480
		/**
		 * 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;

9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493
		/**
		 * Register a declaration 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 declaration provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerDeclarationProvider(selector: DocumentSelector, provider: DeclarationProvider): Disposable;

E
Erich Gamma 已提交
9494
		/**
J
Johannes Rieken 已提交
9495 9496 9497
		 * Register a hover provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
9498 9499
		 * 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 已提交
9500
		 *
J
Johannes Rieken 已提交
9501 9502 9503
		 * @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 已提交
9504 9505 9506
		 */
		export function registerHoverProvider(selector: DocumentSelector, provider: HoverProvider): Disposable;

9507 9508
		/**
		 * Register a provider that locates evaluatable expressions in text documents.
9509
		 * VS Code will evaluate the expression in the active debug session and will show the result in the debug hover.
9510 9511 9512 9513 9514 9515 9516 9517 9518
		 *
		 * If multiple providers are registered for a language an arbitrary provider will be used.
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider An evaluatable expression provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerEvaluatableExpressionProvider(selector: DocumentSelector, provider: EvaluatableExpressionProvider): Disposable;

E
Erich Gamma 已提交
9519
		/**
J
Johannes Rieken 已提交
9520 9521 9522 9523
		 * 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.
9524
		 * The process stops when a provider returns a `non-falsy` or `non-failure` result.
E
Erich Gamma 已提交
9525
		 *
J
Johannes Rieken 已提交
9526 9527 9528
		 * @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 已提交
9529 9530 9531 9532
		 */
		export function registerDocumentHighlightProvider(selector: DocumentSelector, provider: DocumentHighlightProvider): Disposable;

		/**
J
Johannes Rieken 已提交
9533 9534 9535
		 * Register a document symbol provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
9536 9537
		 * 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 已提交
9538
		 *
J
Johannes Rieken 已提交
9539 9540
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A document symbol provider.
9541
		 * @param metaData metadata about the provider
J
Johannes Rieken 已提交
9542
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
9543
		 */
9544
		export function registerDocumentSymbolProvider(selector: DocumentSelector, provider: DocumentSymbolProvider, metaData?: DocumentSymbolProviderMetadata): Disposable;
E
Erich Gamma 已提交
9545 9546

		/**
J
Johannes Rieken 已提交
9547 9548
		 * Register a workspace symbol provider.
		 *
9549 9550 9551
		 * 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 已提交
9552
		 *
J
Johannes Rieken 已提交
9553 9554
		 * @param provider A workspace symbol provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
9555 9556 9557 9558
		 */
		export function registerWorkspaceSymbolProvider(provider: WorkspaceSymbolProvider): Disposable;

		/**
J
Johannes Rieken 已提交
9559 9560 9561
		 * Register a reference provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
9562 9563
		 * 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 已提交
9564
		 *
J
Johannes Rieken 已提交
9565 9566 9567
		 * @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 已提交
9568 9569 9570 9571
		 */
		export function registerReferenceProvider(selector: DocumentSelector, provider: ReferenceProvider): Disposable;

		/**
9572
		 * Register a rename provider.
J
Johannes Rieken 已提交
9573 9574
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
9575
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
9576
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
9577
		 *
J
Johannes Rieken 已提交
9578 9579 9580
		 * @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 已提交
9581 9582 9583
		 */
		export function registerRenameProvider(selector: DocumentSelector, provider: RenameProvider): Disposable;

9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599
		/**
		 * Register a semantic tokens provider for a whole document.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
		 * of the selected provider will cause a failure of the whole operation.
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A document semantic tokens provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerDocumentSemanticTokensProvider(selector: DocumentSelector, provider: DocumentSemanticTokensProvider, legend: SemanticTokensLegend): Disposable;

		/**
		 * Register a semantic tokens provider for a document range.
		 *
A
Alex Dima 已提交
9600 9601 9602 9603 9604 9605
		 * *Note:* If a document has both a `DocumentSemanticTokensProvider` and a `DocumentRangeSemanticTokensProvider`,
		 * the range provider will be invoked only initially, for the time in which the full document provider takes
		 * to resolve the first request. Once the full document provider resolves the first request, the semantic tokens
		 * provided via the range provider will be discarded and from that point forward, only the document provider
		 * will be used.
		 *
9606 9607 9608 9609 9610 9611 9612 9613 9614 9615
		 * Multiple providers can be registered for a language. In that case providers are sorted
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
		 * of the selected provider will cause a failure of the whole operation.
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A document range semantic tokens provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerDocumentRangeSemanticTokensProvider(selector: DocumentSelector, provider: DocumentRangeSemanticTokensProvider, legend: SemanticTokensLegend): Disposable;

E
Erich Gamma 已提交
9616
		/**
A
Andre Weinand 已提交
9617
		 * Register a formatting provider for a document.
J
Johannes Rieken 已提交
9618 9619
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
9620
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
9621
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
9622
		 *
J
Johannes Rieken 已提交
9623 9624 9625
		 * @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 已提交
9626 9627 9628 9629
		 */
		export function registerDocumentFormattingEditProvider(selector: DocumentSelector, provider: DocumentFormattingEditProvider): Disposable;

		/**
J
Johannes Rieken 已提交
9630 9631
		 * Register a formatting provider for a document range.
		 *
9632
		 * *Note:* A document range provider is also a [document formatter](#DocumentFormattingEditProvider)
M
Matthew J. Clemente 已提交
9633
		 * which means there is no need to [register](#languages.registerDocumentFormattingEditProvider) a document
9634 9635
		 * formatter when also registering a range provider.
		 *
J
Johannes Rieken 已提交
9636
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
9637
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
9638
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
9639
		 *
J
Johannes Rieken 已提交
9640 9641 9642
		 * @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 已提交
9643 9644 9645 9646
		 */
		export function registerDocumentRangeFormattingEditProvider(selector: DocumentSelector, provider: DocumentRangeFormattingEditProvider): Disposable;

		/**
E
Erich Gamma 已提交
9647
		 * Register a formatting provider that works on type. The provider is active when the user enables the setting `editor.formatOnType`.
J
Johannes Rieken 已提交
9648 9649
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
9650
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
9651
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
9652
		 *
J
Johannes Rieken 已提交
9653 9654 9655
		 * @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 已提交
9656
		 * @param moreTriggerCharacter More trigger characters.
J
Johannes Rieken 已提交
9657
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
9658 9659 9660 9661
		 */
		export function registerOnTypeFormattingEditProvider(selector: DocumentSelector, provider: OnTypeFormattingEditProvider, firstTriggerCharacter: string, ...moreTriggerCharacter: string[]): Disposable;

		/**
J
Johannes Rieken 已提交
9662 9663 9664
		 * Register a signature help provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
9665 9666
		 * by their [score](#languages.match) and called sequentially until a provider returns a
		 * valid result.
E
Erich Gamma 已提交
9667
		 *
J
Johannes Rieken 已提交
9668 9669 9670
		 * @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 `(`.
9671
		 * @param metadata Information about the provider.
J
Johannes Rieken 已提交
9672
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
9673 9674
		 */
		export function registerSignatureHelpProvider(selector: DocumentSelector, provider: SignatureHelpProvider, ...triggerCharacters: string[]): Disposable;
9675
		export function registerSignatureHelpProvider(selector: DocumentSelector, provider: SignatureHelpProvider, metadata: SignatureHelpProviderMetadata): Disposable;
E
Erich Gamma 已提交
9676

J
Johannes Rieken 已提交
9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689
		/**
		 * 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;

9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702
		/**
		 * Register a color 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 color provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerColorProvider(selector: DocumentSelector, provider: DocumentColorProvider): Disposable;

9703 9704 9705
		/**
		 * Register a folding range provider.
		 *
9706 9707 9708 9709 9710 9711 9712
		 * Multiple providers can be registered for a language. In that case providers are asked in
		 * parallel and the results are merged.
		 * If multiple folding ranges start at the same position, only the range of the first registered provider is used.
		 * If a folding range overlaps with an other range that has a smaller position, it is also ignored.
		 *
		 * A failing provider (rejected promise or exception) will
		 * not cause a failure of the whole operation.
9713 9714 9715 9716 9717
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A folding range provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
9718
		export function registerFoldingRangeProvider(selector: DocumentSelector, provider: FoldingRangeProvider): Disposable;
9719

9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732
		/**
		 * Register a selection range 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 selection range provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerSelectionRangeProvider(selector: DocumentSelector, provider: SelectionRangeProvider): Disposable;

9733 9734 9735 9736 9737 9738 9739 9740 9741
		/**
		 * Register a call hierarchy provider.
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A call hierarchy provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerCallHierarchyProvider(selector: DocumentSelector, provider: CallHierarchyProvider): Disposable;

E
Erich Gamma 已提交
9742
		/**
J
Johannes Rieken 已提交
9743
		 * Set a [language configuration](#LanguageConfiguration) for a language.
E
Erich Gamma 已提交
9744
		 *
A
Andre Weinand 已提交
9745
		 * @param language A language identifier like `typescript`.
J
Johannes Rieken 已提交
9746 9747
		 * @param configuration Language configuration.
		 * @return A [disposable](#Disposable) that unsets this configuration.
E
Erich Gamma 已提交
9748 9749 9750 9751
		 */
		export function setLanguageConfiguration(language: string, configuration: LanguageConfiguration): Disposable;
	}

J
Joao Moreno 已提交
9752
	/**
J
Joao Moreno 已提交
9753
	 * Represents the input box in the Source Control viewlet.
J
Joao Moreno 已提交
9754
	 */
J
Joao Moreno 已提交
9755
	export interface SourceControlInputBox {
J
Joao Moreno 已提交
9756 9757

		/**
J
Joao Moreno 已提交
9758
		 * Setter and getter for the contents of the input box.
J
Joao Moreno 已提交
9759
		 */
J
Joao Moreno 已提交
9760
		value: string;
9761 9762

		/**
H
hannut91 已提交
9763
		 * A string to show as placeholder in the input box to guide the user.
9764 9765
		 */
		placeholder: string;
9766 9767 9768 9769 9770

		/**
		 * Controls whether the input box is visible (default is `true`).
		 */
		visible: boolean;
J
Joao Moreno 已提交
9771 9772
	}

J
Joao Moreno 已提交
9773
	interface QuickDiffProvider {
J
Joao Moreno 已提交
9774 9775

		/**
J
Joao Moreno 已提交
9776 9777 9778 9779 9780
		 * 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 已提交
9781
		 */
J
Joao Moreno 已提交
9782 9783
		provideOriginalResource?(uri: Uri, token: CancellationToken): ProviderResult<Uri>;
	}
J
Joao Moreno 已提交
9784

J
Joao Moreno 已提交
9785 9786 9787 9788 9789
	/**
	 * The theme-aware decorations for a
	 * [source control resource state](#SourceControlResourceState).
	 */
	export interface SourceControlResourceThemableDecorations {
J
Joao Moreno 已提交
9790 9791

		/**
J
Joao Moreno 已提交
9792 9793
		 * The icon path for a specific
		 * [source control resource state](#SourceControlResourceState).
J
Joao Moreno 已提交
9794
		 */
J
Joao Moreno 已提交
9795
		readonly iconPath?: string | Uri;
J
Joao Moreno 已提交
9796 9797 9798
	}

	/**
J
Joao Moreno 已提交
9799 9800
	 * The decorations for a [source control resource state](#SourceControlResourceState).
	 * Can be independently specified for light and dark themes.
J
Joao Moreno 已提交
9801
	 */
J
Joao Moreno 已提交
9802
	export interface SourceControlResourceDecorations extends SourceControlResourceThemableDecorations {
J
Joao Moreno 已提交
9803 9804

		/**
J
Joao Moreno 已提交
9805 9806
		 * Whether the [source control resource state](#SourceControlResourceState) should
		 * be striked-through in the UI.
J
Joao Moreno 已提交
9807
		 */
J
Joao Moreno 已提交
9808
		readonly strikeThrough?: boolean;
J
Joao Moreno 已提交
9809

9810 9811
		/**
		 * Whether the [source control resource state](#SourceControlResourceState) should
I
Ilie Halip 已提交
9812
		 * be faded in the UI.
9813 9814 9815
		 */
		readonly faded?: boolean;

9816 9817 9818 9819 9820 9821
		/**
		 * The title for a specific
		 * [source control resource state](#SourceControlResourceState).
		 */
		readonly tooltip?: string;

J
Joao Moreno 已提交
9822
		/**
J
Joao Moreno 已提交
9823
		 * The light theme decorations.
J
Joao Moreno 已提交
9824
		 */
J
Joao Moreno 已提交
9825
		readonly light?: SourceControlResourceThemableDecorations;
J
Joao Moreno 已提交
9826 9827

		/**
J
Joao Moreno 已提交
9828
		 * The dark theme decorations.
J
Joao Moreno 已提交
9829
		 */
J
Joao Moreno 已提交
9830
		readonly dark?: SourceControlResourceThemableDecorations;
J
Joao Moreno 已提交
9831 9832 9833
	}

	/**
J
Joao Moreno 已提交
9834 9835
	 * An source control resource state represents the state of an underlying workspace
	 * resource within a certain [source control group](#SourceControlResourceGroup).
J
Joao Moreno 已提交
9836
	 */
J
Joao Moreno 已提交
9837
	export interface SourceControlResourceState {
J
Joao Moreno 已提交
9838 9839

		/**
J
Joao Moreno 已提交
9840
		 * The [uri](#Uri) of the underlying resource inside the workspace.
J
Joao Moreno 已提交
9841
		 */
J
Joao Moreno 已提交
9842
		readonly resourceUri: Uri;
J
Joao Moreno 已提交
9843 9844

		/**
J
Joao Moreno 已提交
9845 9846
		 * The [command](#Command) which should be run when the resource
		 * state is open in the Source Control viewlet.
J
Joao Moreno 已提交
9847
		 */
9848
		readonly command?: Command;
J
Joao Moreno 已提交
9849 9850

		/**
J
Joao Moreno 已提交
9851 9852
		 * The [decorations](#SourceControlResourceDecorations) for this source control
		 * resource state.
J
Joao Moreno 已提交
9853
		 */
J
Joao Moreno 已提交
9854
		readonly decorations?: SourceControlResourceDecorations;
J
Joao Moreno 已提交
9855 9856 9857
	}

	/**
J
Joao Moreno 已提交
9858 9859
	 * A source control resource group is a collection of
	 * [source control resource states](#SourceControlResourceState).
J
Joao Moreno 已提交
9860
	 */
J
Joao Moreno 已提交
9861 9862 9863 9864 9865 9866
	export interface SourceControlResourceGroup {

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

		/**
J
Joao Moreno 已提交
9869
		 * The label of this source control resource group.
J
Joao Moreno 已提交
9870
		 */
9871
		label: string;
J
Joao Moreno 已提交
9872 9873

		/**
J
Joao Moreno 已提交
9874 9875
		 * Whether this source control resource group is hidden when it contains
		 * no [source control resource states](#SourceControlResourceState).
J
Joao Moreno 已提交
9876
		 */
J
Joao Moreno 已提交
9877
		hideWhenEmpty?: boolean;
J
Joao Moreno 已提交
9878 9879

		/**
J
Joao Moreno 已提交
9880 9881
		 * This group's collection of
		 * [source control resource states](#SourceControlResourceState).
J
Joao Moreno 已提交
9882
		 */
J
Joao Moreno 已提交
9883
		resourceStates: SourceControlResourceState[];
J
Joao Moreno 已提交
9884 9885

		/**
J
Joao Moreno 已提交
9886
		 * Dispose this source control resource group.
J
Joao Moreno 已提交
9887
		 */
J
Joao Moreno 已提交
9888 9889 9890 9891 9892 9893 9894 9895
		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 已提交
9896 9897

		/**
J
Joao Moreno 已提交
9898
		 * The id of this source control.
J
Joao Moreno 已提交
9899
		 */
J
Joao Moreno 已提交
9900
		readonly id: string;
J
Joao Moreno 已提交
9901 9902

		/**
J
Joao Moreno 已提交
9903
		 * The human-readable label of this source control.
J
Joao Moreno 已提交
9904
		 */
J
Joao Moreno 已提交
9905
		readonly label: string;
J
Joao Moreno 已提交
9906

J
Joao Moreno 已提交
9907 9908 9909 9910 9911
		/**
		 * The (optional) Uri of the root of this source control.
		 */
		readonly rootUri: Uri | undefined;

J
Joao Moreno 已提交
9912 9913 9914 9915 9916
		/**
		 * The [input box](#SourceControlInputBox) for this source control.
		 */
		readonly inputBox: SourceControlInputBox;

J
Joao Moreno 已提交
9917
		/**
J
Joao Moreno 已提交
9918 9919
		 * The UI-visible count of [resource states](#SourceControlResourceState) of
		 * this source control.
J
Joao Moreno 已提交
9920
		 *
J
Joao Moreno 已提交
9921 9922
		 * Equals to the total number of [resource state](#SourceControlResourceState)
		 * of this source control, if undefined.
J
Joao Moreno 已提交
9923
		 */
J
Joao Moreno 已提交
9924
		count?: number;
J
Joao Moreno 已提交
9925 9926

		/**
J
Joao Moreno 已提交
9927
		 * An optional [quick diff provider](#QuickDiffProvider).
J
Joao Moreno 已提交
9928
		 */
J
Joao Moreno 已提交
9929
		quickDiffProvider?: QuickDiffProvider;
J
Joao Moreno 已提交
9930

J
Joao Moreno 已提交
9931
		/**
9932 9933 9934 9935
		 * Optional commit template string.
		 *
		 * The Source Control viewlet will populate the Source Control
		 * input with this value when appropriate.
J
Joao Moreno 已提交
9936
		 */
9937
		commitTemplate?: string;
J
Joao Moreno 已提交
9938 9939

		/**
9940 9941 9942 9943
		 * Optional accept input command.
		 *
		 * This command will be invoked when the user accepts the value
		 * in the Source Control input.
J
Joao Moreno 已提交
9944
		 */
9945
		acceptInputCommand?: Command;
J
Joao Moreno 已提交
9946 9947

		/**
9948 9949 9950
		 * Optional status bar commands.
		 *
		 * These commands will be displayed in the editor's status bar.
J
Joao Moreno 已提交
9951
		 */
9952
		statusBarCommands?: Command[];
J
Joao Moreno 已提交
9953 9954

		/**
9955
		 * Create a new [resource group](#SourceControlResourceGroup).
J
Joao Moreno 已提交
9956
		 */
9957
		createResourceGroup(id: string, label: string): SourceControlResourceGroup;
J
Joao Moreno 已提交
9958 9959

		/**
9960
		 * Dispose this source control.
J
Joao Moreno 已提交
9961
		 */
9962 9963 9964 9965
		dispose(): void;
	}

	export namespace scm {
J
Joao Moreno 已提交
9966 9967

		/**
J
Joao 已提交
9968 9969
		 * ~~The [input box](#SourceControlInputBox) for the last source control
		 * created by the extension.~~
J
Joao Moreno 已提交
9970
		 *
J
Joao Moreno 已提交
9971
		 * @deprecated Use SourceControl.inputBox instead
J
Joao Moreno 已提交
9972
		 */
9973
		export const inputBox: SourceControlInputBox;
J
Joao Moreno 已提交
9974 9975

		/**
J
Joao Moreno 已提交
9976
		 * Creates a new [source control](#SourceControl) instance.
J
Joao Moreno 已提交
9977
		 *
9978 9979 9980
		 * @param id An `id` for the source control. Something short, e.g.: `git`.
		 * @param label A human-readable string for the source control. E.g.: `Git`.
		 * @param rootUri An optional Uri of the root of the source control. E.g.: `Uri.parse(workspaceRoot)`.
J
Joao Moreno 已提交
9981
		 * @return An instance of [source control](#SourceControl).
J
Joao Moreno 已提交
9982
		 */
J
Joao Moreno 已提交
9983
		export function createSourceControl(id: string, label: string, rootUri?: Uri): SourceControl;
J
Joao Moreno 已提交
9984 9985
	}

9986 9987 9988 9989 9990
	/**
	 * Configuration for a debug session.
	 */
	export interface DebugConfiguration {
		/**
9991
		 * The type of the debug session.
9992 9993 9994 9995
		 */
		type: string;

		/**
9996
		 * The name of the debug session.
9997
		 */
9998
		name: string;
9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015

		/**
		 * 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 已提交
10016 10017 10018 10019 10020
		/**
		 * The unique ID of this debug session.
		 */
		readonly id: string;

10021
		/**
A
Andre Weinand 已提交
10022
		 * The debug session's type from the [debug configuration](#DebugConfiguration).
A
Andre Weinand 已提交
10023
		 */
10024 10025 10026
		readonly type: string;

		/**
10027 10028
		 * The debug session's name is initially taken from the [debug configuration](#DebugConfiguration).
		 * Any changes will be properly reflected in the UI.
10029
		 */
10030
		name: string;
10031

10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044
		/**
		 * The workspace folder of this session or `undefined` for a folderless setup.
		 */
		readonly workspaceFolder: WorkspaceFolder | undefined;

		/**
		 * The "resolved" [debug configuration](#DebugConfiguration) of this session.
		 * "Resolved" means that
		 * - all variables have been substituted and
		 * - platform specific attribute sections have been "flattened" for the matching platform and removed for non-matching platforms.
		 */
		readonly configuration: DebugConfiguration;

10045 10046 10047 10048 10049 10050 10051
		/**
		 * Send a custom request to the debug adapter.
		 */
		customRequest(command: string, args?: any): Thenable<any>;
	}

	/**
A
Andre Weinand 已提交
10052
	 * A custom Debug Adapter Protocol event received from a [debug session](#DebugSession).
10053
	 */
A
Andre Weinand 已提交
10054 10055 10056 10057
	export interface DebugSessionCustomEvent {
		/**
		 * The [debug session](#DebugSession) for which the custom event was received.
		 */
10058
		readonly session: DebugSession;
10059 10060

		/**
A
Andre Weinand 已提交
10061
		 * Type of event.
10062
		 */
10063
		readonly event: string;
A
Andre Weinand 已提交
10064 10065 10066 10067

		/**
		 * Event specific information.
		 */
10068
		readonly body?: any;
A
Andre Weinand 已提交
10069 10070
	}

A
Andre Weinand 已提交
10071 10072
	/**
	 * A debug configuration provider allows to add the initial debug configurations to a newly created launch.json
10073 10074
	 * and to resolve a launch configuration before it is used to start a new debug session.
	 * A debug configuration provider is registered via #debug.registerDebugConfigurationProvider.
A
Andre Weinand 已提交
10075 10076 10077 10078 10079 10080
	 */
	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.
		 *
A
Andre Weinand 已提交
10081
		 * @param folder The workspace folder for which the configurations are used or `undefined` for a folderless setup.
A
Andre Weinand 已提交
10082 10083 10084 10085 10086 10087 10088 10089 10090
		 * @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.
10091
		 * Returning the value 'undefined' prevents the debug session from starting.
10092
		 * Returning the value 'null' prevents the debug session from starting and opens the underlying debug configuration instead.
A
Andre Weinand 已提交
10093
		 *
A
Andre Weinand 已提交
10094
		 * @param folder The workspace folder from which the configuration originates from or `undefined` for a folderless setup.
A
Andre Weinand 已提交
10095 10096
		 * @param debugConfiguration The [debug configuration](#DebugConfiguration) to resolve.
		 * @param token A cancellation token.
10097
		 * @return The resolved debug configuration or undefined or null.
A
Andre Weinand 已提交
10098 10099
		 */
		resolveDebugConfiguration?(folder: WorkspaceFolder | undefined, debugConfiguration: DebugConfiguration, token?: CancellationToken): ProviderResult<DebugConfiguration>;
10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114

		/**
		 * This hook is directly called after 'resolveDebugConfiguration' but with all variables substituted.
		 * It can be used to resolve or verify 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 'resolveDebugConfigurationWithSubstitutedVariables' calls are chained
		 * in arbitrary order and the initial debug configuration is piped through the chain.
		 * Returning the value 'undefined' prevents the debug session from starting.
		 * Returning the value 'null' prevents the debug session from starting and opens the underlying debug configuration instead.
		 *
		 * @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 or undefined or null.
		 */
		resolveDebugConfigurationWithSubstitutedVariables?(folder: WorkspaceFolder | undefined, debugConfiguration: DebugConfiguration, token?: CancellationToken): ProviderResult<DebugConfiguration>;
A
Andre Weinand 已提交
10115 10116
	}

10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188
	/**
	 * Represents a debug adapter executable and optional arguments and runtime options passed to it.
	 */
	export class DebugAdapterExecutable {

		/**
		 * Creates a description for a debug adapter based on an executable program.
		 *
		 * @param command The command or executable path that implements the debug adapter.
		 * @param args Optional arguments to be passed to the command or executable.
		 * @param options Optional options to be used when starting the command or executable.
		 */
		constructor(command: string, args?: string[], options?: DebugAdapterExecutableOptions);

		/**
		 * The command or path of the debug adapter executable.
		 * A command must be either an absolute path of an executable or the name of an command to be looked up via the PATH environment variable.
		 * The special value 'node' will be mapped to VS Code's built-in Node.js runtime.
		 */
		readonly command: string;

		/**
		 * The arguments passed to the debug adapter executable. Defaults to an empty array.
		 */
		readonly args: string[];

		/**
		 * Optional options to be used when the debug adapter is started.
		 * Defaults to undefined.
		 */
		readonly options?: DebugAdapterExecutableOptions;
	}

	/**
	 * Options for a debug adapter executable.
	 */
	export interface DebugAdapterExecutableOptions {

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

		/**
		 * The current working directory for the executed debug adapter.
		 */
		cwd?: string;
	}

	/**
	 * Represents a debug adapter running as a socket based server.
	 */
	export class DebugAdapterServer {

		/**
		 * The port.
		 */
		readonly port: number;

		/**
		 * The host.
		 */
		readonly host?: string;

		/**
		 * Create a description for a debug adapter running as a socket based server.
		 */
		constructor(port: number, host?: string);
	}

S
Sandeep Somavarapu 已提交
10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227
	/**
	 * A debug adapter that implements the Debug Adapter Protocol can be registered with VS Code if it implements the DebugAdapter interface.
	 */
	export interface DebugAdapter extends Disposable {

		/**
		 * An event which fires after the debug adapter has sent a Debug Adapter Protocol message to VS Code.
		 * Messages can be requests, responses, or events.
		 */
		readonly onDidSendMessage: Event<DebugProtocolMessage>;

		/**
		 * Handle a Debug Adapter Protocol message.
		 * Messages can be requests, responses, or events.
		 * Results or errors are returned via onSendMessage events.
		 * @param message A Debug Adapter Protocol message
		 */
		handleMessage(message: DebugProtocolMessage): void;
	}

	/**
	 * A DebugProtocolMessage is an opaque stand-in type for the [ProtocolMessage](https://microsoft.github.io/debug-adapter-protocol/specification#Base_Protocol_ProtocolMessage) type defined in the Debug Adapter Protocol.
	 */
	export interface DebugProtocolMessage {
		// Properties: see details [here](https://microsoft.github.io/debug-adapter-protocol/specification#Base_Protocol_ProtocolMessage).
	}

	/**
	 * A debug adapter descriptor for an inline implementation.
	 */
	export class DebugAdapterInlineImplementation {

		/**
		 * Create a descriptor for an inline implementation of a debug adapter.
		 */
		constructor(implementation: DebugAdapter);
	}

	export type DebugAdapterDescriptor = DebugAdapterExecutable | DebugAdapterServer | DebugAdapterInlineImplementation;
10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249

	export interface DebugAdapterDescriptorFactory {
		/**
		 * 'createDebugAdapterDescriptor' is called at the start of a debug session to provide details about the debug adapter to use.
		 * These details must be returned as objects of type [DebugAdapterDescriptor](#DebugAdapterDescriptor).
		 * Currently two types of debug adapters are supported:
		 * - a debug adapter executable is specified as a command path and arguments (see [DebugAdapterExecutable](#DebugAdapterExecutable)),
		 * - a debug adapter server reachable via a communication port (see [DebugAdapterServer](#DebugAdapterServer)).
		 * If the method is not implemented the default behavior is this:
		 *   createDebugAdapter(session: DebugSession, executable: DebugAdapterExecutable) {
		 *      if (typeof session.configuration.debugServer === 'number') {
		 *         return new DebugAdapterServer(session.configuration.debugServer);
		 *      }
		 *      return executable;
		 *   }
		 * @param session The [debug session](#DebugSession) for which the debug adapter will be used.
		 * @param executable The debug adapter's executable information as specified in the package.json (or undefined if no such information exists).
		 * @return a [debug adapter descriptor](#DebugAdapterDescriptor) or undefined.
		 */
		createDebugAdapterDescriptor(session: DebugSession, executable: DebugAdapterExecutable | undefined): ProviderResult<DebugAdapterDescriptor>;
	}

A
Andre Weinand 已提交
10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270
	/**
	 * A Debug Adapter Tracker is a means to track the communication between VS Code and a Debug Adapter.
	 */
	export interface DebugAdapterTracker {
		/**
		 * A session with the debug adapter is about to be started.
		 */
		onWillStartSession?(): void;
		/**
		 * The debug adapter is about to receive a Debug Adapter Protocol message from VS Code.
		 */
		onWillReceiveMessage?(message: any): void;
		/**
		 * The debug adapter has sent a Debug Adapter Protocol message to VS Code.
		 */
		onDidSendMessage?(message: any): void;
		/**
		 * The debug adapter session is about to be stopped.
		 */
		onWillStopSession?(): void;
		/**
10271
		 * An error with the debug adapter has occurred.
A
Andre Weinand 已提交
10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290
		 */
		onError?(error: Error): void;
		/**
		 * The debug adapter has exited with the given exit code or signal.
		 */
		onExit?(code: number | undefined, signal: string | undefined): void;
	}

	export interface DebugAdapterTrackerFactory {
		/**
		 * The method 'createDebugAdapterTracker' is called at the start of a debug session in order
		 * to return a "tracker" object that provides read-access to the communication between VS Code and a debug adapter.
		 *
		 * @param session The [debug session](#DebugSession) for which the debug adapter tracker will be used.
		 * @return A [debug adapter tracker](#DebugAdapterTracker) or undefined.
		 */
		createDebugAdapterTracker(session: DebugSession): ProviderResult<DebugAdapterTracker>;
	}

10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310
	/**
	 * Represents the debug console.
	 */
	export interface DebugConsole {
		/**
		 * Append the given value to the debug console.
		 *
		 * @param value A string, falsy values will not be printed.
		 */
		append(value: string): void;

		/**
		 * Append the given value and a line feed character
		 * to the debug console.
		 *
		 * @param value A string, falsy values will be printed.
		 */
		appendLine(value: string): void;
	}

A
Andre Weinand 已提交
10311
	/**
10312
	 * An event describing the changes to the set of [breakpoints](#Breakpoint).
A
Andre Weinand 已提交
10313
	 */
10314 10315 10316 10317
	export interface BreakpointsChangeEvent {
		/**
		 * Added breakpoints.
		 */
10318
		readonly added: ReadonlyArray<Breakpoint>;
10319 10320

		/**
10321
		 * Removed breakpoints.
10322
		 */
10323
		readonly removed: ReadonlyArray<Breakpoint>;
10324 10325 10326 10327

		/**
		 * Changed breakpoints.
		 */
10328
		readonly changed: ReadonlyArray<Breakpoint>;
10329 10330 10331 10332 10333 10334
	}

	/**
	 * The base class of all breakpoint types.
	 */
	export class Breakpoint {
10335 10336 10337 10338
		/**
		 * The unique ID of the breakpoint.
		 */
		readonly id: string;
10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350
		/**
		 * Is breakpoint enabled.
		 */
		readonly enabled: boolean;
		/**
		 * An optional expression for conditional breakpoints.
		 */
		readonly condition?: string;
		/**
		 * An optional expression that controls how many hits of the breakpoint are ignored.
		 */
		readonly hitCondition?: string;
10351 10352 10353 10354
		/**
		 * An optional message that gets logged when this breakpoint is hit. Embedded expressions within {} are interpolated by the debug adapter.
		 */
		readonly logMessage?: string;
10355

10356
		protected constructor(enabled?: boolean, condition?: string, hitCondition?: string, logMessage?: string);
10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370
	}

	/**
	 * A breakpoint specified by a source location.
	 */
	export class SourceBreakpoint extends Breakpoint {
		/**
		 * The source and line position of this breakpoint.
		 */
		readonly location: Location;

		/**
		 * Create a new breakpoint for a source location.
		 */
10371
		constructor(location: Location, enabled?: boolean, condition?: string, hitCondition?: string, logMessage?: string);
10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385
	}

	/**
	 * A breakpoint specified by a function name.
	 */
	export class FunctionBreakpoint extends Breakpoint {
		/**
		 * The name of the function to which this breakpoint is attached.
		 */
		readonly functionName: string;

		/**
		 * Create a new function breakpoint.
		 */
10386
		constructor(functionName: string, enabled?: boolean, condition?: string, hitCondition?: string, logMessage?: string);
10387 10388
	}

I
isidor 已提交
10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418 10419 10420 10421 10422 10423
	/**
	 * Debug console mode used by debug session, see [options](#DebugSessionOptions).
	 */
	export enum DebugConsoleMode {
		/**
		 * Debug session should have a separate debug console.
		 */
		Separate = 0,

		/**
		 * Debug session should share debug console with its parent session.
		 * This value has no effect for sessions which do not have a parent session.
		 */
		MergeWithParent = 1
	}

	/**
	 * Options for [starting a debug session](#debug.startDebugging).
	 */
	export interface DebugSessionOptions {

		/**
		 * When specified the newly created debug session is registered as a "child" session of this
		 * "parent" debug session.
		 */
		parentSession?: DebugSession;

		/**
		 * Controls whether this session should have a separate debug console or share it
		 * with the parent session. Has no effect for sessions which do not have a parent session.
		 * Defaults to Separate.
		 */
		consoleMode?: DebugConsoleMode;
	}

10424 10425 10426 10427 10428 10429 10430
	/**
	 * A DebugProtocolSource is an opaque stand-in type for the [Source](https://microsoft.github.io/debug-adapter-protocol/specification#Types_Source) type defined in the Debug Adapter Protocol.
	 */
	export interface DebugProtocolSource {
		// Properties: see details [here](https://microsoft.github.io/debug-adapter-protocol/specification#Types_Source).
	}

10431 10432 10433 10434
	/**
	 * Namespace for debug functionality.
	 */
	export namespace debug {
A
Andre Weinand 已提交
10435 10436

		/**
A
Andre Weinand 已提交
10437
		 * The currently active [debug session](#DebugSession) or `undefined`. The active debug session is the one
A
Andre Weinand 已提交
10438 10439 10440 10441 10442
		 * 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;

10443 10444
		/**
		 * The currently active [debug console](#DebugConsole).
10445
		 * If no debug session is active, output sent to the debug console is not shown.
10446 10447 10448
		 */
		export let activeDebugConsole: DebugConsole;

10449 10450 10451 10452 10453 10454
		/**
		 * List of breakpoints.
		 */
		export let breakpoints: Breakpoint[];


A
Andre Weinand 已提交
10455 10456 10457 10458 10459 10460 10461
		/**
		 * 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>;

10462
		/**
A
Andre Weinand 已提交
10463
		 * An [event](#Event) which fires when a new [debug session](#DebugSession) has been started.
10464 10465 10466
		 */
		export const onDidStartDebugSession: Event<DebugSession>;

A
Andre Weinand 已提交
10467
		/**
A
Andre Weinand 已提交
10468
		 * An [event](#Event) which fires when a custom DAP event is received from the [debug session](#DebugSession).
A
Andre Weinand 已提交
10469 10470 10471 10472
		 */
		export const onDidReceiveDebugSessionCustomEvent: Event<DebugSessionCustomEvent>;

		/**
A
Andre Weinand 已提交
10473
		 * An [event](#Event) which fires when a [debug session](#DebugSession) has terminated.
A
Andre Weinand 已提交
10474 10475
		 */
		export const onDidTerminateDebugSession: Event<DebugSession>;
A
Andre Weinand 已提交
10476

10477 10478 10479 10480 10481 10482
		/**
		 * An [event](#Event) that is emitted when the set of breakpoints is added, removed, or changed.
		 */
		export const onDidChangeBreakpoints: Event<BreakpointsChangeEvent>;


A
Andre Weinand 已提交
10483
		/**
10484
		 * Register a [debug configuration provider](#DebugConfigurationProvider) for a specific debug type.
A
Andre Weinand 已提交
10485 10486 10487 10488 10489 10490 10491
		 * 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;
10492

10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503
		/**
		 * Register a [debug adapter descriptor factory](#DebugAdapterDescriptorFactory) for a specific debug type.
		 * An extension is only allowed to register a DebugAdapterDescriptorFactory for the debug type(s) defined by the extension. Otherwise an error is thrown.
		 * Registering more than one DebugAdapterDescriptorFactory for a debug type results in an error.
		 *
		 * @param debugType The debug type for which the factory is registered.
		 * @param factory The [debug adapter descriptor factory](#DebugAdapterDescriptorFactory) to register.
		 * @return A [disposable](#Disposable) that unregisters this factory when being disposed.
		 */
		export function registerDebugAdapterDescriptorFactory(debugType: string, factory: DebugAdapterDescriptorFactory): Disposable;

A
Andre Weinand 已提交
10504 10505 10506 10507 10508 10509 10510 10511 10512
		/**
		 * Register a debug adapter tracker factory for the given debug type.
		 *
		 * @param debugType The debug type for which the factory is registered or '*' for matching all debug types.
		 * @param factory The [debug adapter tracker factory](#DebugAdapterTrackerFactory) to register.
		 * @return A [disposable](#Disposable) that unregisters this factory when being disposed.
		 */
		export function registerDebugAdapterTrackerFactory(debugType: string, factory: DebugAdapterTrackerFactory): Disposable;

10513 10514 10515 10516 10517 10518 10519 10520
		/**
		 * Start debugging by using either a named launch or named compound configuration,
		 * or by directly passing a [DebugConfiguration](#DebugConfiguration).
		 * 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.
		 * Folder specific variables used in the configuration (e.g. '${workspaceFolder}') are resolved against the given folder.
		 * @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.
I
isidor 已提交
10521
		 * @param parentSessionOrOptions Debug sesison options. When passed a parent [debug session](#DebugSession), assumes options with just this parent session.
10522 10523
		 * @return A thenable that resolves when debugging could be successfully started.
		 */
I
isidor 已提交
10524
		export function startDebugging(folder: WorkspaceFolder | undefined, nameOrConfiguration: string | DebugConfiguration, parentSessionOrOptions?: DebugSession | DebugSessionOptions): Thenable<boolean>;
10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536

		/**
		 * Add breakpoints.
		 * @param breakpoints The breakpoints to add.
		*/
		export function addBreakpoints(breakpoints: Breakpoint[]): void;

		/**
		 * Remove breakpoints.
		 * @param breakpoints The breakpoints to remove.
		 */
		export function removeBreakpoints(breakpoints: Breakpoint[]): void;
10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549

		/**
		 * Converts a "Source" descriptor object received via the Debug Adapter Protocol into a Uri that can be used to load its contents.
		 * If the source descriptor is based on a path, a file Uri is returned.
		 * If the source descriptor uses a reference number, a specific debug Uri (scheme 'debug') is constructed that requires a corresponding VS Code ContentProvider and a running debug session
		 *
		 * If the "Source" descriptor has insufficient information for creating the Uri, an error is thrown.
		 *
		 * @param source An object conforming to the [Source](https://microsoft.github.io/debug-adapter-protocol/specification#Types_Source) type defined in the Debug Adapter Protocol.
		 * @param session An optional debug session that will be used when the source descriptor uses a reference number to load the contents from an active debug session.
		 * @return A uri that can be used to load the contents of the source.
		 */
		export function asDebugSourceUri(source: DebugProtocolSource, session?: DebugSession): Uri;
10550 10551
	}

J
Johannes Rieken 已提交
10552
	/**
10553
	 * Namespace for dealing with installed extensions. Extensions are represented
J
Jon Malmaud 已提交
10554
	 * by an [extension](#Extension)-interface which enables reflection on them.
10555
	 *
S
Steven Clarke 已提交
10556
	 * Extension writers can provide APIs to other extensions by returning their API public
10557 10558 10559 10560
	 * surface from the `activate`-call.
	 *
	 * ```javascript
	 * export function activate(context: vscode.ExtensionContext) {
10561 10562 10563 10564 10565 10566 10567 10568 10569 10570
	 * 	let api = {
	 * 		sum(a, b) {
	 * 			return a + b;
	 * 		},
	 * 		mul(a, b) {
	 * 			return a * b;
	 * 		}
	 * 	};
	 * 	// 'export' public api-surface
	 * 	return api;
10571 10572
	 * }
	 * ```
10573
	 * When depending on the API of another extension add an `extensionDependencies`-entry
10574 10575 10576 10577 10578 10579 10580 10581 10582
	 * 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 已提交
10583
	 */
E
Erich Gamma 已提交
10584 10585
	export namespace extensions {

J
Johannes Rieken 已提交
10586
		/**
10587
		 * Get an extension by its full identifier in the form of: `publisher.name`.
J
Johannes Rieken 已提交
10588
		 *
J
Johannes Rieken 已提交
10589
		 * @param extensionId An extension identifier.
J
Johannes Rieken 已提交
10590 10591
		 * @return An extension or `undefined`.
		 */
10592
		export function getExtension(extensionId: string): Extension<any> | undefined;
E
Erich Gamma 已提交
10593

J
Johannes Rieken 已提交
10594
		/**
10595
		 * Get an extension by its full identifier in the form of: `publisher.name`.
J
Johannes Rieken 已提交
10596 10597 10598
		 *
		 * @param extensionId An extension identifier.
		 * @return An extension or `undefined`.
J
Johannes Rieken 已提交
10599
		 */
10600
		export function getExtension<T>(extensionId: string): Extension<T> | undefined;
E
Erich Gamma 已提交
10601 10602 10603 10604

		/**
		 * All extensions currently known to the system.
		 */
M
Matt Bierner 已提交
10605
		export const all: ReadonlyArray<Extension<any>>;
10606 10607 10608 10609 10610 10611

		/**
		 * An event which fires when `extensions.all` changes. This can happen when extensions are
		 * installed, uninstalled, enabled or disabled.
		 */
		export const onDidChange: Event<void>;
E
Erich Gamma 已提交
10612
	}
P
Peng Lyu 已提交
10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630

	//#region Comments

	/**
	 * Collapsible state of a [comment thread](#CommentThread)
	 */
	export enum CommentThreadCollapsibleState {
		/**
		 * Determines an item is collapsed
		 */
		Collapsed = 0,

		/**
		 * Determines an item is expanded
		 */
		Expanded = 1
	}

P
Peng Lyu 已提交
10631 10632 10633
	/**
	 * Comment mode of a [comment](#Comment)
	 */
P
Peng Lyu 已提交
10634
	export enum CommentMode {
P
Peng Lyu 已提交
10635 10636 10637
		/**
		 * Displays the comment editor
		 */
P
Peng Lyu 已提交
10638
		Editing = 0,
P
Peng Lyu 已提交
10639 10640 10641 10642

		/**
		 * Displays the preview of the comment
		 */
P
Peng Lyu 已提交
10643 10644 10645 10646 10647 10648 10649 10650 10651 10652
		Preview = 1
	}

	/**
	 * A collection of [comments](#Comment) representing a conversation at a particular range in a document.
	 */
	export interface CommentThread {
		/**
		 * The uri of the document the thread has been created on.
		 */
10653
		readonly uri: Uri;
P
Peng Lyu 已提交
10654 10655 10656 10657 10658

		/**
		 * The range the comment thread is located within the document. The thread icon will be shown
		 * at the first line of the range.
		 */
P
Peng Lyu 已提交
10659
		range: Range;
P
Peng Lyu 已提交
10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671

		/**
		 * The ordered comments of the thread.
		 */
		comments: ReadonlyArray<Comment>;

		/**
		 * Whether the thread should be collapsed or expanded when opening the document.
		 * Defaults to Collapsed.
		 */
		collapsibleState: CommentThreadCollapsibleState;

P
Peng Lyu 已提交
10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691
		/**
		 * Context value of the comment thread. This can be used to contribute thread specific actions.
		 * For example, a comment thread is given a context value as `editable`. When contributing actions to `comments/commentThread/title`
		 * using `menus` extension point, you can specify context value for key `commentThread` in `when` expression like `commentThread == editable`.
		 * ```
		 *	"contributes": {
		 *		"menus": {
		 *			"comments/commentThread/title": [
		 *				{
		 *					"command": "extension.deleteCommentThread",
		 *					"when": "commentThread == editable"
		 *				}
		 *			]
		 *		}
		 *	}
		 * ```
		 * This will show action `extension.deleteCommentThread` only for comment threads with `contextValue` is `editable`.
		 */
		contextValue?: string;

P
Peng Lyu 已提交
10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719
		/**
		 * The optional human-readable label describing the [Comment Thread](#CommentThread)
		 */
		label?: string;

		/**
		 * Dispose this comment thread.
		 *
		 * Once disposed, this comment thread will be removed from visible editors and Comment Panel when approriate.
		 */
		dispose(): void;
	}

	/**
	 * Author information of a [comment](#Comment)
	 */
	export interface CommentAuthorInformation {
		/**
		 * The display name of the author of the comment
		 */
		name: string;

		/**
		 * The optional icon path for the author
		 */
		iconPath?: Uri;
	}

P
Peng Lyu 已提交
10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 10740 10741 10742 10743 10744
	/**
	 * Reactions of a [comment](#Comment)
	 */
	export interface CommentReaction {
		/**
		 * The human-readable label for the reaction
		 */
		readonly label: string;

		/**
		 * Icon for the reaction shown in UI.
		 */
		readonly iconPath: string | Uri;

		/**
		 * The number of users who have reacted to this reaction
		 */
		readonly count: number;

		/**
		 * Whether the [author](CommentAuthorInformation) of the comment has reacted to this reaction
		 */
		readonly authorHasReacted: boolean;
	}

P
Peng Lyu 已提交
10745 10746 10747 10748 10749 10750 10751 10752 10753
	/**
	 * A comment is displayed within the editor or the Comments Panel, depending on how it is provided.
	 */
	export interface Comment {
		/**
		 * The human-readable comment body
		 */
		body: string | MarkdownString;

P
Peng Lyu 已提交
10754 10755 10756
		/**
		 * [Comment mode](#CommentMode) of the comment
		 */
P
Peng Lyu 已提交
10757 10758 10759
		mode: CommentMode;

		/**
P
Peng Lyu 已提交
10760
		 * The [author information](#CommentAuthorInformation) of the comment
P
Peng Lyu 已提交
10761 10762 10763
		 */
		author: CommentAuthorInformation;

P
Peng Lyu 已提交
10764 10765 10766 10767
		/**
		 * Context value of the comment. This can be used to contribute comment specific actions.
		 * For example, a comment is given a context value as `editable`. When contributing actions to `comments/comment/title`
		 * using `menus` extension point, you can specify context value for key `comment` in `when` expression like `comment == editable`.
10768
		 * ```json
P
Peng Lyu 已提交
10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783
		 *	"contributes": {
		 *		"menus": {
		 *			"comments/comment/title": [
		 *				{
		 *					"command": "extension.deleteComment",
		 *					"when": "comment == editable"
		 *				}
		 *			]
		 *		}
		 *	}
		 * ```
		 * This will show action `extension.deleteComment` only for comments with `contextValue` is `editable`.
		 */
		contextValue?: string;

P
Peng Lyu 已提交
10784 10785 10786 10787 10788
		/**
		 * Optional reactions of the [comment](#Comment)
		 */
		reactions?: CommentReaction[];

P
Peng Lyu 已提交
10789 10790 10791 10792 10793 10794 10795
		/**
		 * Optional label describing the [Comment](#Comment)
		 * Label will be rendered next to authorName if exists.
		 */
		label?: string;
	}

P
Peng Lyu 已提交
10796
	/**
10797
	 * Command argument for actions registered in `comments/commentThread/context`.
P
Peng Lyu 已提交
10798
	 */
P
Peng Lyu 已提交
10799
	export interface CommentReply {
P
Peng Lyu 已提交
10800 10801 10802
		/**
		 * The active [comment thread](#CommentThread)
		 */
P
Peng Lyu 已提交
10803 10804
		thread: CommentThread;

P
Peng Lyu 已提交
10805 10806 10807
		/**
		 * The value in the comment editor
		 */
P
Peng Lyu 已提交
10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838
		text: string;
	}

	/**
	 * Commenting range provider for a [comment controller](#CommentController).
	 */
	export interface CommentingRangeProvider {
		/**
		 * Provide a list of ranges which allow new comment threads creation or null for a given document
		 */
		provideCommentingRanges(document: TextDocument, token: CancellationToken): ProviderResult<Range[]>;
	}

	/**
	 * A comment controller is able to provide [comments](#CommentThread) support to the editor and
	 * provide users various ways to interact with comments.
	 */
	export interface CommentController {
		/**
		 * The id of this comment controller.
		 */
		readonly id: string;

		/**
		 * The human-readable label of this comment controller.
		 */
		readonly label: string;

		/**
		 * Optional commenting range provider. Provide a list [ranges](#Range) which support commenting to any given resource uri.
		 *
P
Peng Lyu 已提交
10839
		 * If not provided, users can leave comments in any document opened in the editor.
P
Peng Lyu 已提交
10840 10841 10842 10843 10844 10845 10846
		 */
		commentingRangeProvider?: CommentingRangeProvider;

		/**
		 * Create a [comment thread](#CommentThread). The comment thread will be displayed in visible text editors (if the resource matches)
		 * and Comments Panel once created.
		 *
10847
		 * @param uri The uri of the document the thread has been created on.
P
Peng Lyu 已提交
10848 10849 10850
		 * @param range The range the comment thread is located within the document.
		 * @param comments The ordered comments of the thread.
		 */
10851
		createCommentThread(uri: Uri, range: Range, comments: Comment[]): CommentThread;
P
Peng Lyu 已提交
10852

P
Peng Lyu 已提交
10853 10854 10855 10856 10857
		/**
		 * Optional reaction handler for creating and deleting reactions on a [comment](#Comment).
		 */
		reactionHandler?: (comment: Comment, reaction: CommentReaction) => Promise<void>;

P
Peng Lyu 已提交
10858 10859 10860 10861 10862 10863 10864 10865 10866
		/**
		 * Dispose this comment controller.
		 *
		 * Once disposed, all [comment threads](#CommentThread) created by this comment controller will also be removed from the editor
		 * and Comments Panel.
		 */
		dispose(): void;
	}

P
Peng Lyu 已提交
10867
	namespace comments {
P
Peng Lyu 已提交
10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878
		/**
		 * Creates a new [comment controller](#CommentController) instance.
		 *
		 * @param id An `id` for the comment controller.
		 * @param label A human-readable string for the comment controller.
		 * @return An instance of [comment controller](#CommentController).
		 */
		export function createCommentController(id: string, label: string): CommentController;
	}

	//#endregion
E
Erich Gamma 已提交
10879 10880 10881 10882
}

/**
 * Thenable is a common denominator between ES6 promises, Q, jquery.Deferred, WinJS.Promise,
10883
 * and others. This API makes no assumption about what promise library is being used which
E
Erich Gamma 已提交
10884
 * enables reusing existing code without migrating to a specific promise implementation. Still,
J
Johannes Rieken 已提交
10885
 * we recommend the use of native promises which are available in this editor.
E
Erich Gamma 已提交
10886
 */
10887
interface Thenable<T> {
E
Erich Gamma 已提交
10888 10889 10890 10891 10892 10893
	/**
	* 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.
	*/
10894 10895
	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 已提交
10896
}