vscode.d.ts 317.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 131 132 133 134 135
		/**
		 * `true` if the document have been closed. A closed document isn't synchronized anymore
		 * and won't be re-used when the same resource is opened again.
		 */
		readonly isClosed: boolean;

E
Erich Gamma 已提交
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
	/**
793 794
	 * A reference to a named icon. Currently only [File](#ThemeIcon.File) and [Folder](#ThemeIcon.Folder) are supported.
	 * Using a theme icon is preferred over a custom icon as it gives theme authors the possibility to change the icons.
795 796 797
	 */
	export class ThemeIcon {
		/**
798
		 * Reference to a icon representing a file. The icon is taken from the current file icon theme or a placeholder icon.
799 800 801 802
		 */
		static readonly File: ThemeIcon;

		/**
803
		 * Reference to a icon representing a folder. The icon is taken from the current file icon theme or a placeholder icon.
804 805 806 807 808 809
		 */
		static readonly Folder: ThemeIcon;

		private constructor(id: string);
	}

A
Alex Dima 已提交
810 811 812
	/**
	 * Represents theme specific rendering styles for a [text editor decoration](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
813 814 815
	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 已提交
816
		 * Alternatively a color from the color registry can be [referenced](#ThemeColor).
E
Erich Gamma 已提交
817
		 */
818
		backgroundColor?: string | ThemeColor;
E
Erich Gamma 已提交
819 820 821 822

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
823 824 825 826 827 828
		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.
		 */
829
		outlineColor?: string | ThemeColor;
E
Erich Gamma 已提交
830 831 832

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
833
		 * Better use 'outline' for setting one or more of the individual outline properties.
E
Erich Gamma 已提交
834 835 836 837 838
		 */
		outlineStyle?: string;

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

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
846 847 848 849 850 851
		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.
		 */
852
		borderColor?: string | ThemeColor;
E
Erich Gamma 已提交
853 854 855

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
856
		 * Better use 'border' for setting one or more of the individual border properties.
E
Erich Gamma 已提交
857 858 859 860 861
		 */
		borderRadius?: string;

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

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

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

878 879 880 881 882 883 884 885 886 887
		/**
		 * 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 已提交
888 889 890 891 892 893 894 895 896 897 898 899 900
		/**
		 * 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.
		 */
901
		color?: string | ThemeColor;
E
Erich Gamma 已提交
902

M
Matt Bierner 已提交
903 904 905 906 907
		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		opacity?: string;

908 909 910 911 912
		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		letterSpacing?: string;

E
Erich Gamma 已提交
913
		/**
914
		 * An **absolute path** or an URI to an image to be rendered in the gutter.
E
Erich Gamma 已提交
915
		 */
916
		gutterIconPath?: string | Uri;
E
Erich Gamma 已提交
917

918 919 920 921 922 923 924
		/**
		 * 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 已提交
925 926 927
		/**
		 * The color of the decoration in the overview ruler. Use rgba() and define transparent colors to play well with other decorations.
		 */
928
		overviewRulerColor?: string | ThemeColor;
M
Martin Aeschlimann 已提交
929 930

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

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

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

A
Alex Dima 已提交
993 994 995
	/**
	 * Represents rendering styles for a [text editor decoration](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
996 997 998 999 1000 1001 1002
	export interface DecorationRenderOptions extends ThemableDecorationRenderOptions {
		/**
		 * Should the decoration be rendered also on the whitespace after the line text.
		 * Defaults to `false`.
		 */
		isWholeLine?: boolean;

1003
		/**
1004 1005
		 * Customize the growing behavior of the decoration when edits occur at the edges of the decoration's range.
		 * Defaults to `DecorationRangeBehavior.OpenOpen`.
1006
		 */
1007
		rangeBehavior?: DecorationRangeBehavior;
1008

E
Erich Gamma 已提交
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
		/**
		 * 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 已提交
1025 1026 1027
	/**
	 * Represents options for a specific decoration in a [decoration set](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
1028 1029 1030
	export interface DecorationOptions {

		/**
1031
		 * Range to which this decoration is applied. The range must not be empty.
E
Erich Gamma 已提交
1032 1033 1034 1035 1036 1037
		 */
		range: Range;

		/**
		 * A message that should be rendered when hovering over the decoration.
		 */
1038
		hoverMessage?: MarkedString | MarkedString[];
M
Martin Aeschlimann 已提交
1039 1040 1041

		/**
		 * Render options applied to the current decoration. For performance reasons, keep the
1042
		 * number of decoration specific options small, and use decoration types wherever possible.
M
Martin Aeschlimann 已提交
1043 1044 1045 1046 1047 1048
		 */
		renderOptions?: DecorationInstanceRenderOptions;
	}

	export interface ThemableDecorationInstanceRenderOptions {
		/**
1049
		 * Defines the rendering options of the attachment that is inserted before the decorated text.
M
Martin Aeschlimann 已提交
1050
		 */
1051
		before?: ThemableDecorationAttachmentRenderOptions;
M
Martin Aeschlimann 已提交
1052 1053

		/**
1054
		 * Defines the rendering options of the attachment that is inserted after the decorated text.
M
Martin Aeschlimann 已提交
1055
		 */
1056
		after?: ThemableDecorationAttachmentRenderOptions;
M
Martin Aeschlimann 已提交
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
	}

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

		/**
		 * Overwrite options for dark themes.
		 */
J
Johannes Rieken 已提交
1068
		dark?: ThemableDecorationInstanceRenderOptions;
E
Erich Gamma 已提交
1069 1070
	}

A
Alex Dima 已提交
1071 1072 1073
	/**
	 * Represents an editor that is attached to a [document](#TextDocument).
	 */
E
Erich Gamma 已提交
1074 1075 1076 1077 1078
	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 已提交
1079
		readonly document: TextDocument;
E
Erich Gamma 已提交
1080 1081

		/**
J
Johannes Rieken 已提交
1082
		 * The primary selection on this text editor. Shorthand for `TextEditor.selections[0]`.
E
Erich Gamma 已提交
1083 1084 1085 1086
		 */
		selection: Selection;

		/**
J
Johannes Rieken 已提交
1087
		 * The selections in this text editor. The primary selection is always at index 0.
E
Erich Gamma 已提交
1088 1089 1090
		 */
		selections: Selection[];

1091 1092 1093 1094 1095 1096
		/**
		 * 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 已提交
1097 1098 1099 1100 1101
		/**
		 * Text editor options.
		 */
		options: TextEditorOptions;

1102 1103
		/**
		 * The column in which this editor shows. Will be `undefined` in case this
1104
		 * isn't one of the main editors, e.g. an embedded editor, or when the editor
B
Benjamin Pasero 已提交
1105
		 * column is larger than three.
1106
		 */
1107
		viewColumn?: ViewColumn;
1108

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

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

		/**
J
Johannes Rieken 已提交
1136 1137 1138
		 * 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 已提交
1139
		 * @see [createTextEditorDecorationType](#window.createTextEditorDecorationType).
A
Alex Dima 已提交
1140
		 *
J
Johannes Rieken 已提交
1141 1142
		 * @param decorationType A decoration type.
		 * @param rangesOrOptions Either [ranges](#Range) or more detailed [options](#DecorationOptions).
E
Erich Gamma 已提交
1143
		 */
J
Johannes Rieken 已提交
1144
		setDecorations(decorationType: TextEditorDecorationType, rangesOrOptions: Range[] | DecorationOptions[]): void;
E
Erich Gamma 已提交
1145 1146

		/**
A
Alex Dima 已提交
1147 1148 1149 1150
		 * 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 已提交
1151 1152 1153 1154
		 */
		revealRange(range: Range, revealType?: TextEditorRevealType): void;

		/**
1155
		 * ~~Show the text editor.~~
J
Johannes Rieken 已提交
1156
		 *
B
Benjamin Pasero 已提交
1157
		 * @deprecated Use [window.showTextDocument](#window.showTextDocument) instead.
E
Erich Gamma 已提交
1158
		 *
J
Johannes Rieken 已提交
1159
		 * @param column The [column](#ViewColumn) in which to show this editor.
B
Benjamin Pasero 已提交
1160
		 * This method shows unexpected behavior and will be removed in the next major update.
E
Erich Gamma 已提交
1161 1162 1163 1164
		 */
		show(column?: ViewColumn): void;

		/**
1165
		 * ~~Hide the text editor.~~
J
Johannes Rieken 已提交
1166
		 *
1167
		 * @deprecated Use the command `workbench.action.closeActiveEditor` instead.
S
Steven Clarke 已提交
1168
		 * This method shows unexpected behavior and will be removed in the next major update.
E
Erich Gamma 已提交
1169 1170 1171 1172
		 */
		hide(): void;
	}

1173
	/**
1174
	 * Represents an end of line character sequence in a [document](#TextDocument).
1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186
	 */
	export enum EndOfLine {
		/**
		 * The line feed `\n` character.
		 */
		LF = 1,
		/**
		 * The carriage return line feed `\r\n` sequence.
		 */
		CRLF = 2
	}

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

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

		/**
		 * Delete a certain text region.
A
Alex Dima 已提交
1215 1216
		 *
		 * @param location The range this operation should remove.
E
Erich Gamma 已提交
1217 1218
		 */
		delete(location: Range | Selection): void;
1219 1220 1221 1222

		/**
		 * Set the end of line sequence.
		 *
1223
		 * @param endOfLine The new end of line for the [document](#TextDocument).
1224
		 */
A
Format  
Alex Dima 已提交
1225
		setEndOfLine(endOfLine: EndOfLine): void;
E
Erich Gamma 已提交
1226 1227 1228
	}

	/**
S
Steven Clarke 已提交
1229
	 * A universal resource identifier representing either a file on disk
J
Johannes Rieken 已提交
1230
	 * or another resource, like untitled resources.
E
Erich Gamma 已提交
1231 1232 1233 1234
	 */
	export class Uri {

		/**
J
Johannes Rieken 已提交
1235 1236
		 * Create an URI from a string, e.g. `http://www.msft.com/some/path`,
		 * `file:///usr/home`, or `scheme:with/path`.
J
Johannes Rieken 已提交
1237
		 *
1238
		 * *Note* that for a while uris without a `scheme` were accepted. That is not correct
1239 1240
		 * as all uris should have a scheme. When missing the `file`-scheme is being used unless
		 * the  `strict`-argument is `true` in which case an error is thrown.
1241
		 *
J
Johannes Rieken 已提交
1242 1243
		 * @see [Uri.toString](#Uri.toString)
		 * @param value The string value of an Uri.
1244
		 * @param strict Throw an error when `value` is empty or when no `scheme` can be parsed.
J
Johannes Rieken 已提交
1245
		 * @return A new Uri instance.
E
Erich Gamma 已提交
1246
		 */
1247
		static parse(value: string, strict?: boolean): Uri;
E
Erich Gamma 已提交
1248 1249

		/**
J
Johannes Rieken 已提交
1250 1251
		 * Create an URI from a file system path. The [scheme](#Uri.scheme)
		 * will be `file`.
E
Erich Gamma 已提交
1252
		 *
J
Johannes Rieken 已提交
1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269
		 * 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 已提交
1270
		 * @return A new Uri instance.
E
Erich Gamma 已提交
1271
		 */
J
Johannes Rieken 已提交
1272
		static file(path: string): Uri;
E
Erich Gamma 已提交
1273

1274 1275 1276 1277 1278
		/**
		 * 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 已提交
1279
		/**
J
Johannes Rieken 已提交
1280
		 * Scheme is the `http` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1281 1282
		 * The part before the first colon.
		 */
J
Johannes Rieken 已提交
1283
		readonly scheme: string;
E
Erich Gamma 已提交
1284 1285

		/**
J
Johannes Rieken 已提交
1286
		 * Authority is the `www.msft.com` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1287 1288
		 * The part between the first double slashes and the next slash.
		 */
J
Johannes Rieken 已提交
1289
		readonly authority: string;
E
Erich Gamma 已提交
1290 1291

		/**
J
Johannes Rieken 已提交
1292
		 * Path is the `/some/path` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1293
		 */
J
Johannes Rieken 已提交
1294
		readonly path: string;
E
Erich Gamma 已提交
1295 1296

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

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

		/**
1307
		 * The string representing the corresponding file system path of this Uri.
J
Johannes Rieken 已提交
1308
		 *
E
Erich Gamma 已提交
1309
		 * Will handle UNC paths and normalize windows drive letters to lower-case. Also
J
Johannes Rieken 已提交
1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324
		 * 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 已提交
1325
		 */
J
Johannes Rieken 已提交
1326
		readonly fsPath: string;
E
Erich Gamma 已提交
1327

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

E
Erich Gamma 已提交
1344
		/**
1345
		 * Returns a string representation of this Uri. The representation and normalization
J
Johannes Rieken 已提交
1346 1347 1348 1349
		 * 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 已提交
1350
		 *
1351 1352 1353 1354 1355 1356
		 * *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)`.
		 *
1357
		 * @param skipEncoding Do not percentage-encode the result, defaults to `false`. Note that
1358
		 *	the `#` and `?` characters occurring in the path will always be encoded.
1359
		 * @returns A string representation of this Uri.
E
Erich Gamma 已提交
1360
		 */
1361
		toString(skipEncoding?: boolean): string;
E
Erich Gamma 已提交
1362

J
Johannes Rieken 已提交
1363 1364 1365 1366 1367
		/**
		 * Returns a JSON representation of this Uri.
		 *
		 * @return An object.
		 */
E
Erich Gamma 已提交
1368 1369 1370 1371
		toJSON(): any;
	}

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

		/**
J
Johannes Rieken 已提交
1382
		 * Is `true` when the token has been cancelled, `false` otherwise.
E
Erich Gamma 已提交
1383 1384 1385 1386
		 */
		isCancellationRequested: boolean;

		/**
J
Johannes Rieken 已提交
1387
		 * An [event](#Event) which fires upon cancellation.
E
Erich Gamma 已提交
1388 1389 1390 1391 1392
		 */
		onCancellationRequested: Event<any>;
	}

	/**
J
Johannes Rieken 已提交
1393
	 * A cancellation source creates and controls a [cancellation token](#CancellationToken).
E
Erich Gamma 已提交
1394 1395 1396 1397
	 */
	export class CancellationTokenSource {

		/**
J
Johannes Rieken 已提交
1398
		 * The cancellation token of this source.
E
Erich Gamma 已提交
1399 1400 1401 1402 1403 1404 1405 1406 1407
		 */
		token: CancellationToken;

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

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

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

	/**
	 * Represents a typed event.
J
Johannes Rieken 已提交
1445 1446 1447 1448 1449
	 *
	 * 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 已提交
1450 1451 1452 1453
	 */
	export interface Event<T> {

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

1465 1466 1467 1468 1469
	/**
	 * 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 已提交
1470
	 * inside a [TextDocumentContentProvider](#TextDocumentContentProvider) or when providing
1471 1472 1473 1474 1475 1476 1477 1478 1479 1480
	 * API to other extensions.
	 */
	export class EventEmitter<T> {

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

		/**
M
Matthew J. Clemente 已提交
1481
		 * Notify all subscribers of the [event](#EventEmitter.event). Failure
1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
		 * of one or more listener will not fail this function call.
		 *
		 * @param data The event object.
		 */
		fire(data?: T): void;

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

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

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

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

1548 1549 1550 1551
		/**
		 * An event to signal a resource has changed.
		 */
		onDidChange?: Event<Uri>;
J
Johannes Rieken 已提交
1552

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

E
Erich Gamma 已提交
1570 1571
	/**
	 * Represents an item that can be selected from
A
Andre Weinand 已提交
1572
	 * a list of items.
E
Erich Gamma 已提交
1573 1574 1575 1576
	 */
	export interface QuickPickItem {

		/**
J
Johannes Rieken 已提交
1577
		 * A human readable string which is rendered prominent.
E
Erich Gamma 已提交
1578 1579 1580 1581
		 */
		label: string;

		/**
J
Johannes Rieken 已提交
1582
		 * A human readable string which is rendered less prominent.
E
Erich Gamma 已提交
1583
		 */
1584
		description?: string;
J
Johannes Rieken 已提交
1585 1586 1587 1588 1589

		/**
		 * A human readable string which is rendered less prominent.
		 */
		detail?: string;
C
Christof Marti 已提交
1590 1591

		/**
1592
		 * Optional flag indicating if this item is picked initially.
C
Christof Marti 已提交
1593 1594
		 * (Only honored when the picker allows multiple selections.)
		 *
1595
		 * @see [QuickPickOptions.canPickMany](#QuickPickOptions.canPickMany)
C
Christof Marti 已提交
1596
		 */
1597
		picked?: boolean;
1598 1599 1600 1601 1602

		/**
		 * Always show this item.
		 */
		alwaysShow?: boolean;
E
Erich Gamma 已提交
1603 1604 1605
	}

	/**
J
Johannes Rieken 已提交
1606
	 * Options to configure the behavior of the quick pick UI.
E
Erich Gamma 已提交
1607 1608 1609
	 */
	export interface QuickPickOptions {
		/**
J
Johannes Rieken 已提交
1610 1611
		 * An optional flag to include the description when filtering the picks.
		 */
E
Erich Gamma 已提交
1612 1613
		matchOnDescription?: boolean;

J
Johannes Rieken 已提交
1614 1615 1616 1617 1618
		/**
		 * An optional flag to include the detail when filtering the picks.
		 */
		matchOnDetail?: boolean;

E
Erich Gamma 已提交
1619
		/**
S
Steven Clarke 已提交
1620
		 * An optional string to show as place holder in the input box to guide the user what to pick on.
J
Johannes Rieken 已提交
1621
		 */
E
Erich Gamma 已提交
1622
		placeHolder?: string;
1623

1624 1625 1626 1627 1628
		/**
		 * 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 已提交
1629
		/**
C
Christof Marti 已提交
1630
		 * An optional flag to make the picker accept multiple selections, if true the result is an array of picks.
C
Christof Marti 已提交
1631
		 */
1632
		canPickMany?: boolean;
C
Christof Marti 已提交
1633

1634 1635 1636
		/**
		 * An optional function that is invoked whenever an item is selected.
		 */
A
Amadare42 已提交
1637
		onDidSelectItem?(item: QuickPickItem | string): any;
E
Erich Gamma 已提交
1638 1639
	}

1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655
	/**
	 * Options to configure the behaviour of the [workspace folder](#WorkspaceFolder) pick UI.
	 */
	export interface WorkspaceFolderPickOptions {

		/**
		 * An optional string to show as place holder in the input box to guide the user what to pick on.
		 */
		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;
	}

1656
	/**
J
Johannes Rieken 已提交
1657
	 * Options to configure the behaviour of a file open dialog.
1658 1659 1660
	 *
	 * * 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*.
1661
	 * * Note 2: Explicitly setting `canSelectFiles` and `canSelectFolders` to `false` is futile
1662
	 * and the editor then silently adjusts the options to select files.
J
Johannes Rieken 已提交
1663
	 */
1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675
	export interface OpenDialogOptions {
		/**
		 * The resource the dialog shows when opened.
		 */
		defaultUri?: Uri;

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

		/**
1676
		 * Allow to select files, defaults to `true`.
1677
		 */
1678
		canSelectFiles?: boolean;
1679 1680

		/**
1681
		 * Allow to select folders, defaults to `false`.
1682
		 */
1683
		canSelectFolders?: boolean;
1684 1685 1686 1687

		/**
		 * Allow to select many files or folders.
		 */
1688
		canSelectMany?: boolean;
1689 1690

		/**
J
Johannes Rieken 已提交
1691 1692
		 * A set of file filters that are used by the dialog. Each entry is a human readable label,
		 * like "TypeScript", and an array of extensions, e.g.
1693 1694
		 * ```ts
		 * {
J
Johannes Rieken 已提交
1695 1696
		 * 	'Images': ['png', 'jpg']
		 * 	'TypeScript': ['ts', 'tsx']
1697 1698 1699
		 * }
		 * ```
		 */
J
Johannes Rieken 已提交
1700
		filters?: { [name: string]: string[] };
1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717
	}

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

		/**
J
Johannes Rieken 已提交
1718 1719
		 * A set of file filters that are used by the dialog. Each entry is a human readable label,
		 * like "TypeScript", and an array of extensions, e.g.
1720 1721
		 * ```ts
		 * {
J
Johannes Rieken 已提交
1722 1723
		 * 	'Images': ['png', 'jpg']
		 * 	'TypeScript': ['ts', 'tsx']
1724 1725 1726
		 * }
		 * ```
		 */
J
Johannes Rieken 已提交
1727
		filters?: { [name: string]: string[] };
1728 1729
	}

E
Erich Gamma 已提交
1730
	/**
J
Johannes Rieken 已提交
1731
	 * Represents an action that is shown with an information, warning, or
A
Andre Weinand 已提交
1732
	 * error message.
E
Erich Gamma 已提交
1733
	 *
S
Sofian Hnaide 已提交
1734 1735 1736
	 * @see [showInformationMessage](#window.showInformationMessage)
	 * @see [showWarningMessage](#window.showWarningMessage)
	 * @see [showErrorMessage](#window.showErrorMessage)
E
Erich Gamma 已提交
1737 1738 1739 1740
	 */
	export interface MessageItem {

		/**
A
Andre Weinand 已提交
1741
		 * A short title like 'Retry', 'Open Log' etc.
E
Erich Gamma 已提交
1742 1743
		 */
		title: string;
1744 1745

		/**
1746 1747 1748 1749 1750
		 * 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.
1751 1752
		 */
		isCloseAffordance?: boolean;
E
Erich Gamma 已提交
1753 1754
	}

J
Joao Moreno 已提交
1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769
	/**
	 * 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 已提交
1770
	/**
J
Johannes Rieken 已提交
1771
	 * Options to configure the behavior of the input box UI.
E
Erich Gamma 已提交
1772 1773
	 */
	export interface InputBoxOptions {
J
Johannes Rieken 已提交
1774

E
Erich Gamma 已提交
1775
		/**
J
Johannes Rieken 已提交
1776 1777
		 * The value to prefill in the input box.
		 */
E
Erich Gamma 已提交
1778 1779
		value?: string;

1780
		/**
1781 1782 1783 1784
		 * 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.
1785
		 */
1786
		valueSelection?: [number, number];
1787

E
Erich Gamma 已提交
1788
		/**
J
Johannes Rieken 已提交
1789 1790
		 * The text to display underneath the input box.
		 */
E
Erich Gamma 已提交
1791 1792 1793
		prompt?: string;

		/**
J
Johannes Rieken 已提交
1794 1795
		 * An optional string to show as place holder in the input box to guide the user what to type.
		 */
E
Erich Gamma 已提交
1796 1797 1798
		placeHolder?: string;

		/**
1799
		 * Set to `true` to show a password prompt that will not show the typed value.
J
Johannes Rieken 已提交
1800
		 */
E
Erich Gamma 已提交
1801
		password?: boolean;
1802

1803 1804 1805 1806 1807
		/**
		 * Set to `true` to keep the input box open when focus moves to another part of the editor or to another window.
		 */
		ignoreFocusOut?: boolean;

1808
		/**
P
Pine 已提交
1809
		 * An optional function that will be called to validate input and to give a hint
1810 1811 1812 1813 1814 1815
		 * to the user.
		 *
		 * @param value The current value of the input box.
		 * @return A human readable string which is presented as diagnostic message.
		 * Return `undefined`, `null`, or the empty string when 'value' is valid.
		 */
1816
		validateInput?(value: string): string | undefined | null | Thenable<string | undefined | null>;
E
Erich Gamma 已提交
1817 1818
	}

B
Benjamin Pasero 已提交
1819 1820 1821 1822 1823
	/**
	 * 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).
	 */
1824
	export class RelativePattern {
1825 1826

		/**
B
Benjamin Pasero 已提交
1827
		 * A base file path to which this pattern will be matched against relatively.
1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839
		 */
		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 已提交
1840
		/**
B
Benjamin Pasero 已提交
1841 1842
		 * 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 已提交
1843
		 *
B
Benjamin Pasero 已提交
1844
		 * @param base A base file path to which this pattern will be matched against relatively.
B
Benjamin Pasero 已提交
1845 1846 1847
		 * @param pattern A file glob pattern like `*.{ts,js}` that will be matched on file paths
		 * relative to the base path.
		 */
1848
		constructor(base: WorkspaceFolder | string, pattern: string)
1849 1850 1851 1852
	}

	/**
	 * A file glob pattern to match file paths against. This can either be a glob pattern string
1853
	 * (like `**​/*.{ts,js}` or `*.{ts,js}`) or a [relative pattern](#RelativePattern).
B
Benjamin Pasero 已提交
1854 1855 1856 1857 1858
	 *
	 * 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
1859
	 * * `{}` to group conditions (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)
B
Benjamin Pasero 已提交
1860 1861
	 * * `[]` 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`)
1862 1863 1864 1865 1866
	 *
	 * 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.
1867 1868 1869
	 */
	export type GlobPattern = string | RelativePattern;

E
Erich Gamma 已提交
1870 1871
	/**
	 * A document filter denotes a document by different properties like
A
Alex Dima 已提交
1872
	 * the [language](#TextDocument.languageId), the [scheme](#Uri.scheme) of
A
Andre Weinand 已提交
1873
	 * its resource, or a glob-pattern that is applied to the [path](#TextDocument.fileName).
E
Erich Gamma 已提交
1874
	 *
J
Johannes Rieken 已提交
1875
	 * @sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
1876
	 * @sample A language filter that applies to all package.json paths: `{ language: 'json', scheme: 'untitled', pattern: '**​/package.json' }`
E
Erich Gamma 已提交
1877 1878 1879 1880 1881 1882 1883 1884 1885
	 */
	export interface DocumentFilter {

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

		/**
J
Johannes Rieken 已提交
1886
		 * A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
E
Erich Gamma 已提交
1887 1888 1889 1890
		 */
		scheme?: string;

		/**
B
Benjamin Pasero 已提交
1891 1892
		 * 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 已提交
1893
		 */
1894
		pattern?: GlobPattern;
E
Erich Gamma 已提交
1895 1896 1897 1898
	}

	/**
	 * A language selector is the combination of one or many language identifiers
1899
	 * and [language filters](#DocumentFilter).
J
Johannes Rieken 已提交
1900
	 *
1901 1902
	 * *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
1903
	 * a feature works without further context, e.g. without the need to resolve related
1904 1905 1906
	 * 'files'.
	 *
	 * @sample `let sel:DocumentSelector = { scheme: 'file', language: 'typescript' }`;
E
Erich Gamma 已提交
1907
	 */
1908
	export type DocumentSelector = DocumentFilter | string | Array<DocumentFilter | string>;
E
Erich Gamma 已提交
1909

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

M
Matt Bierner 已提交
1942 1943 1944 1945
	/**
	 * Kind of a code action.
	 *
	 * Kinds are a hierarchical list of identifiers separated by `.`, e.g. `"refactor.extract.function"`.
M
Matt Bierner 已提交
1946 1947 1948
	 *
	 * 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 已提交
1949 1950 1951 1952 1953 1954 1955 1956
	 */
	export class CodeActionKind {
		/**
		 * Empty kind.
		 */
		static readonly Empty: CodeActionKind;

		/**
M
Matt Bierner 已提交
1957 1958 1959
		 * 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 已提交
1960 1961 1962 1963
		 */
		static readonly QuickFix: CodeActionKind;

		/**
1964
		 * Base kind for refactoring actions: `refactor`
M
Matt Bierner 已提交
1965 1966
		 *
		 * Refactoring actions are shown in the refactoring context menu.
M
Matt Bierner 已提交
1967 1968 1969 1970
		 */
		static readonly Refactor: CodeActionKind;

		/**
1971
		 * Base kind for refactoring extraction actions: `refactor.extract`
1972 1973 1974 1975 1976 1977 1978 1979
		 *
		 * Example extract actions:
		 *
		 * - Extract method
		 * - Extract function
		 * - Extract variable
		 * - Extract interface from class
		 * - ...
M
Matt Bierner 已提交
1980 1981 1982 1983
		 */
		static readonly RefactorExtract: CodeActionKind;

		/**
1984
		 * Base kind for refactoring inline actions: `refactor.inline`
1985 1986 1987 1988 1989 1990 1991
		 *
		 * Example inline actions:
		 *
		 * - Inline function
		 * - Inline variable
		 * - Inline constant
		 * - ...
M
Matt Bierner 已提交
1992 1993 1994 1995
		 */
		static readonly RefactorInline: CodeActionKind;

		/**
1996
		 * Base kind for refactoring rewrite actions: `refactor.rewrite`
1997 1998 1999 2000 2001 2002 2003 2004 2005
		 *
		 * 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 已提交
2006 2007 2008
		 */
		static readonly RefactorRewrite: CodeActionKind;

M
Matt Bierner 已提交
2009
		/**
2010
		 * Base kind for source actions: `source`
M
Matt Bierner 已提交
2011
		 *
M
Matt Bierner 已提交
2012 2013
		 * Source code actions apply to the entire file and can be run on save
		 * using `editor.codeActionsOnSave`. They also are shown in `source` context menu.
M
Matt Bierner 已提交
2014 2015 2016
		 */
		static readonly Source: CodeActionKind;

2017
		/**
M
Matt Bierner 已提交
2018
		 * Base kind for an organize imports source action: `source.organizeImports`.
2019 2020 2021
		 */
		static readonly SourceOrganizeImports: CodeActionKind;

2022 2023 2024 2025 2026 2027 2028 2029
		/**
		 * 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 已提交
2030 2031 2032 2033 2034
		private constructor(value: string);

		/**
		 * String value of the kind, e.g. `"refactor.extract.function"`.
		 */
2035
		readonly value: string;
M
Matt Bierner 已提交
2036 2037 2038 2039 2040 2041 2042 2043 2044

		/**
		 * 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 已提交
2045
		 * Checks if this code action kind intersects `other`.
M
Matt Bierner 已提交
2046
		 *
M
Matt Bierner 已提交
2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058
		 * 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 已提交
2059 2060 2061 2062 2063 2064
		 *
		 * @param other Kind to check.
		 */
		contains(other: CodeActionKind): boolean;
	}

E
Erich Gamma 已提交
2065 2066
	/**
	 * Contains additional diagnostic information about the context in which
J
Johannes Rieken 已提交
2067
	 * a [code action](#CodeActionProvider.provideCodeActions) is run.
E
Erich Gamma 已提交
2068 2069
	 */
	export interface CodeActionContext {
J
Johannes Rieken 已提交
2070 2071 2072
		/**
		 * An array of diagnostics.
		 */
2073
		readonly diagnostics: ReadonlyArray<Diagnostic>;
M
Matt Bierner 已提交
2074 2075 2076 2077 2078 2079 2080

		/**
		 * Requested kind of actions to return.
		 *
		 * Actions not of this kind are filtered out before being shown by the lightbulb.
		 */
		readonly only?: CodeActionKind;
E
Erich Gamma 已提交
2081 2082
	}

2083 2084 2085
	/**
	 * A code action represents a change that can be performed in code, e.g. to fix a problem or
	 * to refactor code.
2086
	 *
M
Matthew J. Clemente 已提交
2087
	 * 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.
2088 2089 2090 2091
	 */
	export class CodeAction {

		/**
2092
		 * A short, human-readable, title for this code action.
2093 2094 2095 2096
		 */
		title: string;

		/**
2097
		 * A [workspace edit](#WorkspaceEdit) this code action performs.
2098 2099 2100 2101
		 */
		edit?: WorkspaceEdit;

		/**
2102
		 * [Diagnostics](#Diagnostic) that this code action resolves.
2103 2104 2105 2106
		 */
		diagnostics?: Diagnostic[];

		/**
2107
		 * A [command](#Command) this code action executes.
2108 2109 2110
		 */
		command?: Command;

M
Matt Bierner 已提交
2111
		/**
2112
		 * [Kind](#CodeActionKind) of the code action.
M
Matt Bierner 已提交
2113 2114 2115
		 *
		 * Used to filter code actions.
		 */
2116
		kind?: CodeActionKind;
M
Matt Bierner 已提交
2117

M
Matt Bierner 已提交
2118 2119 2120 2121 2122 2123 2124 2125 2126
		/**
		 * 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;

2127 2128 2129
		/**
		 * Creates a new code action.
		 *
2130 2131
		 * A code action must have at least a [title](#CodeAction.title) and [edits](#CodeAction.edit)
		 * and/or a [command](#CodeAction.command).
2132 2133
		 *
		 * @param title The title of the code action.
2134
		 * @param kind The kind of the code action.
2135
		 */
2136
		constructor(title: string, kind?: CodeActionKind);
2137 2138
	}

E
Erich Gamma 已提交
2139
	/**
J
Johannes Rieken 已提交
2140 2141 2142 2143
	 * The code action interface defines the contract between extensions and
	 * the [light bulb](https://code.visualstudio.com/docs/editor/editingevolved#_code-action) feature.
	 *
	 * A code action can be any command that is [known](#commands.getCommands) to the system.
E
Erich Gamma 已提交
2144 2145 2146 2147 2148
	 */
	export interface CodeActionProvider {
		/**
		 * Provide commands for the given document and range.
		 *
J
Johannes Rieken 已提交
2149
		 * @param document The document in which the command was invoked.
2150 2151
		 * @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 已提交
2152 2153
		 * @param context Context carrying additional information.
		 * @param token A cancellation token.
2154
		 * @return An array of commands, quick fixes, or refactorings or a thenable of such. The lack of a result can be
A
Andre Weinand 已提交
2155
		 * signaled by returning `undefined`, `null`, or an empty array.
E
Erich Gamma 已提交
2156
		 */
2157
		provideCodeActions(document: TextDocument, range: Range | Selection, context: CodeActionContext, token: CancellationToken): ProviderResult<(Command | CodeAction)[]>;
E
Erich Gamma 已提交
2158 2159
	}

2160 2161 2162 2163 2164 2165 2166 2167 2168 2169
	/**
	 * Metadata about the type of code actions that a [CodeActionProvider](#CodeActionProvider) providers
	 */
	export interface CodeActionProviderMetadata {
		/**
		 * [CodeActionKinds](#CodeActionKind) that this provider may return.
		 *
		 * The list of kinds may be generic, such as `CodeActionKind.Refactor`, or the provider
		 * may list our every specific kind they provide, such as `CodeActionKind.Refactor.Extract.append('function`)`
		 */
2170
		readonly providedCodeActionKinds?: ReadonlyArray<CodeActionKind>;
2171 2172
	}

E
Erich Gamma 已提交
2173 2174 2175
	/**
	 * 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 已提交
2176 2177 2178
	 *
	 * 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 已提交
2179 2180 2181
	 *
	 * @see [CodeLensProvider.provideCodeLenses](#CodeLensProvider.provideCodeLenses)
	 * @see [CodeLensProvider.resolveCodeLens](#CodeLensProvider.resolveCodeLens)
E
Erich Gamma 已提交
2182 2183 2184 2185 2186 2187 2188 2189 2190
	 */
	export class CodeLens {

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

		/**
J
Johannes Rieken 已提交
2191
		 * The command this code lens represents.
E
Erich Gamma 已提交
2192
		 */
2193
		command?: Command;
E
Erich Gamma 已提交
2194 2195

		/**
J
Johannes Rieken 已提交
2196
		 * `true` when there is a command associated.
E
Erich Gamma 已提交
2197
		 */
Y
Yuki Ueda 已提交
2198
		readonly isResolved: boolean;
J
Johannes Rieken 已提交
2199 2200 2201 2202 2203 2204 2205 2206

		/**
		 * 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 已提交
2207 2208 2209 2210 2211 2212 2213 2214
	}

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

2215 2216 2217
		/**
		 * An optional event to signal that the code lenses from this provider have changed.
		 */
2218
		onDidChangeCodeLenses?: Event<void>;
2219

E
Erich Gamma 已提交
2220 2221
		/**
		 * Compute a list of [lenses](#CodeLens). This call should return as fast as possible and if
A
Andre Weinand 已提交
2222
		 * computing the commands is expensive implementors should only return code lens objects with the
E
Erich Gamma 已提交
2223
		 * range set and implement [resolve](#CodeLensProvider.resolveCodeLens).
J
Johannes Rieken 已提交
2224 2225 2226
		 *
		 * @param document The document in which the command was invoked.
		 * @param token A cancellation token.
A
Andre Weinand 已提交
2227 2228
		 * @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 已提交
2229
		 */
2230
		provideCodeLenses(document: TextDocument, token: CancellationToken): ProviderResult<CodeLens[]>;
E
Erich Gamma 已提交
2231 2232 2233 2234

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

M
Matt Bierner 已提交
2243 2244 2245 2246 2247 2248
	/**
	 * Information about where a symbol is defined.
	 *
	 * Provides additional metadata over normal [location](#Location) definitions, including the range of
	 * the defining symbol
	 */
2249
	export type DefinitionLink = LocationLink;
M
Matt Bierner 已提交
2250

E
Erich Gamma 已提交
2251
	/**
J
Johannes Rieken 已提交
2252 2253 2254
	 * 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 已提交
2255 2256 2257
	 */
	export type Definition = Location | Location[];

J
Johannes Rieken 已提交
2258 2259 2260 2261 2262
	/**
	 * 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 已提交
2263
	export interface DefinitionProvider {
J
Johannes Rieken 已提交
2264 2265 2266 2267 2268 2269 2270

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

2277
	/**
2278
	 * The implementation provider interface defines the contract between extensions and
2279 2280
	 * the go to implementation feature.
	 */
M
Matt Bierner 已提交
2281
	export interface ImplementationProvider {
2282 2283 2284 2285 2286 2287 2288 2289 2290 2291

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

2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309
	/**
	 * 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 已提交
2310
		provideTypeDefinition(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Definition | DefinitionLink[]>;
2311 2312
	}

2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336
	/**
	 * The declaration of a symbol representation as one or many [locations](#Location)
	 * or [location links][#LocationLink].
	 */
	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 已提交
2337
	/**
2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371
	 * The MarkdownString represents human readable text that supports formatting via the
	 * markdown syntax. Standard markdown is supported, also tables, but no embedded html.
	 */
	export class MarkdownString {

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

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

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

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

		/**
		 * Appends the given string 'as is' to this markdown string.
		 * @param value Markdown string.
		 */
		appendMarkdown(value: string): MarkdownString;
J
Johannes Rieken 已提交
2372 2373 2374 2375 2376 2377 2378

		/**
		 * 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;
2379 2380 2381 2382
	}

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

J
Johannes Rieken 已提交
2390 2391 2392 2393
	/**
	 * A hover represents additional information for a symbol or word. Hovers are
	 * rendered in a tooltip-like widget.
	 */
E
Erich Gamma 已提交
2394 2395
	export class Hover {

J
Johannes Rieken 已提交
2396 2397 2398
		/**
		 * The contents of this hover.
		 */
E
Erich Gamma 已提交
2399 2400
		contents: MarkedString[];

J
Johannes Rieken 已提交
2401
		/**
A
Andre Weinand 已提交
2402
		 * The range to which this hover applies. When missing, the
J
Johannes Rieken 已提交
2403
		 * editor will use the range at the current position or the
A
Andre Weinand 已提交
2404
		 * current position itself.
J
Johannes Rieken 已提交
2405
		 */
2406
		range?: Range;
E
Erich Gamma 已提交
2407

J
Johannes Rieken 已提交
2408 2409 2410 2411
		/**
		 * Creates a new hover object.
		 *
		 * @param contents The contents of the hover.
A
Andre Weinand 已提交
2412
		 * @param range The range to which the hover applies.
J
Johannes Rieken 已提交
2413
		 */
E
Erich Gamma 已提交
2414 2415 2416
		constructor(contents: MarkedString | MarkedString[], range?: Range);
	}

J
Johannes Rieken 已提交
2417 2418
	/**
	 * The hover provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
2419
	 * the [hover](https://code.visualstudio.com/docs/editor/intellisense)-feature.
J
Johannes Rieken 已提交
2420
	 */
E
Erich Gamma 已提交
2421
	export interface HoverProvider {
J
Johannes Rieken 已提交
2422 2423 2424

		/**
		 * Provide a hover for the given position and document. Multiple hovers at the same
A
Andre Weinand 已提交
2425 2426
		 * 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 已提交
2427 2428 2429 2430 2431
		 *
		 * @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 已提交
2432
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
2433
		 */
2434
		provideHover(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Hover>;
E
Erich Gamma 已提交
2435 2436
	}

J
Johannes Rieken 已提交
2437 2438 2439
	/**
	 * A document highlight kind.
	 */
E
Erich Gamma 已提交
2440
	export enum DocumentHighlightKind {
J
Johannes Rieken 已提交
2441 2442

		/**
A
Andre Weinand 已提交
2443
		 * A textual occurrence.
J
Johannes Rieken 已提交
2444
		 */
2445
		Text = 0,
J
Johannes Rieken 已提交
2446 2447 2448 2449

		/**
		 * Read-access of a symbol, like reading a variable.
		 */
2450
		Read = 1,
J
Johannes Rieken 已提交
2451 2452 2453 2454

		/**
		 * Write-access of a symbol, like writing to a variable.
		 */
2455
		Write = 2
E
Erich Gamma 已提交
2456 2457
	}

J
Johannes Rieken 已提交
2458 2459 2460 2461 2462
	/**
	 * 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 已提交
2463
	export class DocumentHighlight {
J
Johannes Rieken 已提交
2464 2465 2466 2467

		/**
		 * The range this highlight applies to.
		 */
E
Erich Gamma 已提交
2468
		range: Range;
J
Johannes Rieken 已提交
2469 2470 2471 2472

		/**
		 * The highlight kind, default is [text](#DocumentHighlightKind.Text).
		 */
2473
		kind?: DocumentHighlightKind;
J
Johannes Rieken 已提交
2474 2475 2476 2477 2478 2479 2480 2481

		/**
		 * 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 已提交
2482 2483
	}

J
Johannes Rieken 已提交
2484 2485 2486 2487
	/**
	 * The document highlight provider interface defines the contract between extensions and
	 * the word-highlight-feature.
	 */
E
Erich Gamma 已提交
2488
	export interface DocumentHighlightProvider {
J
Johannes Rieken 已提交
2489 2490

		/**
S
Steven Clarke 已提交
2491
		 * Provide a set of document highlights, like all occurrences of a variable or
J
Johannes Rieken 已提交
2492 2493 2494 2495 2496 2497
		 * 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 已提交
2498
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2499
		 */
2500
		provideDocumentHighlights(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<DocumentHighlight[]>;
E
Erich Gamma 已提交
2501 2502
	}

J
Johannes Rieken 已提交
2503 2504 2505
	/**
	 * A symbol kind.
	 */
E
Erich Gamma 已提交
2506
	export enum SymbolKind {
2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526
		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,
2527 2528 2529 2530
		Null = 20,
		EnumMember = 21,
		Struct = 22,
		Event = 23,
2531 2532
		Operator = 24,
		TypeParameter = 25
E
Erich Gamma 已提交
2533 2534
	}

2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546

	/**
	 * 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 已提交
2547 2548 2549 2550
	/**
	 * Represents information about programming constructs like variables, classes,
	 * interfaces etc.
	 */
E
Erich Gamma 已提交
2551
	export class SymbolInformation {
J
Johannes Rieken 已提交
2552 2553 2554 2555

		/**
		 * The name of this symbol.
		 */
E
Erich Gamma 已提交
2556
		name: string;
J
Johannes Rieken 已提交
2557 2558 2559 2560

		/**
		 * The name of the symbol containing this symbol.
		 */
E
Erich Gamma 已提交
2561
		containerName: string;
J
Johannes Rieken 已提交
2562 2563 2564 2565

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

2568 2569 2570 2571 2572
		/**
		 * Tags for this symbol.
		 */
		tags?: ReadonlyArray<SymbolTag>;

J
Johannes Rieken 已提交
2573 2574 2575
		/**
		 * The location of this symbol.
		 */
E
Erich Gamma 已提交
2576
		location: Location;
J
Johannes Rieken 已提交
2577

2578 2579 2580 2581 2582 2583
		/**
		 * 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 已提交
2584
		 * @param location The location of the symbol.
2585 2586 2587
		 */
		constructor(name: string, kind: SymbolKind, containerName: string, location: Location);

J
Johannes Rieken 已提交
2588
		/**
2589
		 * ~~Creates a new symbol information object.~~
2590
		 *
2591
		 * @deprecated Please use the constructor taking a [location](#Location) object.
J
Johannes Rieken 已提交
2592 2593 2594 2595 2596
		 *
		 * @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 已提交
2597
		 * @param containerName The name of the symbol containing the symbol.
J
Johannes Rieken 已提交
2598 2599
		 */
		constructor(name: string, kind: SymbolKind, range: Range, uri?: Uri, containerName?: string);
E
Erich Gamma 已提交
2600 2601
	}

2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614
	/**
	 * 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;

		/**
2615
		 * More detail for this symbol, e.g. the signature of a function.
2616 2617 2618 2619 2620 2621 2622 2623
		 */
		detail: string;

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

2624 2625 2626 2627 2628
		/**
		 * Tags for this symbol.
		 */
		tags?: ReadonlyArray<SymbolTag>;

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

		/**
2635
		 * The range that should be selected and reveal when this symbol is being picked, e.g. the name of a function.
J
Johannes Rieken 已提交
2636
		 * Must be contained by the [`range`](#DocumentSymbol.range).
2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656
		 */
		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 已提交
2657 2658
	/**
	 * The document symbol provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
2659
	 * the [go to symbol](https://code.visualstudio.com/docs/editor/editingevolved#_go-to-symbol)-feature.
J
Johannes Rieken 已提交
2660
	 */
E
Erich Gamma 已提交
2661
	export interface DocumentSymbolProvider {
J
Johannes Rieken 已提交
2662 2663 2664 2665 2666 2667 2668

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

J
Johannes Rieken 已提交
2674 2675 2676
	/**
	 * Metadata about a document symbol provider.
	 */
2677 2678
	export interface DocumentSymbolProviderMetadata {
		/**
J
Johannes Rieken 已提交
2679
		 * A human readable string that is shown when multiple outlines trees show for one document.
2680
		 */
J
Johannes Rieken 已提交
2681
		label?: string;
2682 2683
	}

J
Johannes Rieken 已提交
2684 2685 2686 2687
	/**
	 * 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 已提交
2688
	export interface WorkspaceSymbolProvider {
J
Johannes Rieken 已提交
2689 2690

		/**
J
Johannes Rieken 已提交
2691
		 * Project-wide search for a symbol matching the given query string.
J
Johannes Rieken 已提交
2692
		 *
2693 2694 2695 2696 2697
		 * 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 已提交
2698 2699 2700 2701
		 * 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 已提交
2702
		 * @param query A query string, can be the empty string in which case all symbols should be returned.
J
Johannes Rieken 已提交
2703 2704
		 * @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 已提交
2705
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2706
		 */
M
Matt Bierner 已提交
2707
		provideWorkspaceSymbols(query: string, token: CancellationToken): ProviderResult<SymbolInformation[]>;
2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720

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

J
Johannes Rieken 已提交
2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739
	/**
	 * 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 已提交
2740
	export interface ReferenceProvider {
J
Johannes Rieken 已提交
2741 2742 2743 2744 2745 2746 2747

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

J
Johannes Rieken 已提交
2755
	/**
S
Steven Clarke 已提交
2756
	 * A text edit represents edits that should be applied
J
Johannes Rieken 已提交
2757
	 * to a document.
J
Johannes Rieken 已提交
2758
	 */
E
Erich Gamma 已提交
2759
	export class TextEdit {
J
Johannes Rieken 已提交
2760 2761 2762 2763 2764 2765 2766 2767

		/**
		 * Utility to create a replace edit.
		 *
		 * @param range A range.
		 * @param newText A string.
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
2768
		static replace(range: Range, newText: string): TextEdit;
J
Johannes Rieken 已提交
2769 2770 2771 2772

		/**
		 * Utility to create an insert edit.
		 *
S
Steven Clarke 已提交
2773
		 * @param position A position, will become an empty range.
J
Johannes Rieken 已提交
2774 2775 2776
		 * @param newText A string.
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
2777
		static insert(position: Position, newText: string): TextEdit;
J
Johannes Rieken 已提交
2778 2779 2780 2781

		/**
		 * Utility to create a delete edit.
		 *
J
Johannes Rieken 已提交
2782
		 * @param range A range.
J
Johannes Rieken 已提交
2783 2784
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
2785
		static delete(range: Range): TextEdit;
J
Johannes Rieken 已提交
2786

2787 2788 2789 2790 2791 2792 2793 2794
		/**
		 * 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 已提交
2795 2796 2797
		/**
		 * The range this edit applies to.
		 */
E
Erich Gamma 已提交
2798
		range: Range;
J
Johannes Rieken 已提交
2799 2800 2801 2802

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

2805 2806
		/**
		 * The eol-sequence used in the document.
J
Johannes Rieken 已提交
2807 2808 2809
		 *
		 * *Note* that the eol-sequence will be applied to the
		 * whole document.
2810
		 */
J
Johannes Rieken 已提交
2811
		newEol?: EndOfLine;
2812

J
Johannes Rieken 已提交
2813 2814 2815 2816 2817 2818 2819
		/**
		 * Create a new TextEdit.
		 *
		 * @param range A range.
		 * @param newText A string.
		 */
		constructor(range: Range, newText: string);
E
Erich Gamma 已提交
2820 2821 2822
	}

	/**
2823
	 * A workspace edit is a collection of textual and files changes for
J
Johannes Rieken 已提交
2824
	 * multiple resources and documents.
2825 2826
	 *
	 * Use the [applyEdit](#workspace.applyEdit)-function to apply a workspace edit.
E
Erich Gamma 已提交
2827 2828 2829 2830
	 */
	export class WorkspaceEdit {

		/**
2831
		 * The number of affected resources of textual or resource changes.
E
Erich Gamma 已提交
2832
		 */
Y
Yuki Ueda 已提交
2833
		readonly size: number;
E
Erich Gamma 已提交
2834

J
Johannes Rieken 已提交
2835 2836 2837 2838 2839 2840 2841 2842
		/**
		 * Replace the given range with given text for the given resource.
		 *
		 * @param uri A resource identifier.
		 * @param range A range.
		 * @param newText A string.
		 */
		replace(uri: Uri, range: Range, newText: string): void;
E
Erich Gamma 已提交
2843

J
Johannes Rieken 已提交
2844 2845 2846 2847 2848 2849 2850 2851
		/**
		 * Insert the given text at the given position.
		 *
		 * @param uri A resource identifier.
		 * @param position A position.
		 * @param newText A string.
		 */
		insert(uri: Uri, position: Position, newText: string): void;
E
Erich Gamma 已提交
2852

J
Johannes Rieken 已提交
2853
		/**
S
Steven Clarke 已提交
2854
		 * Delete the text at the given range.
J
Johannes Rieken 已提交
2855 2856 2857
		 *
		 * @param uri A resource identifier.
		 * @param range A range.
J
Johannes Rieken 已提交
2858 2859
		 */
		delete(uri: Uri, range: Range): void;
E
Erich Gamma 已提交
2860

J
Johannes Rieken 已提交
2861
		/**
2862 2863
		 * Check if a text edit for a resource exists.
		 *
J
Johannes Rieken 已提交
2864
		 * @param uri A resource identifier.
A
Andre Weinand 已提交
2865
		 * @return `true` if the given resource will be touched by this edit.
J
Johannes Rieken 已提交
2866
		 */
E
Erich Gamma 已提交
2867 2868
		has(uri: Uri): boolean;

J
Johannes Rieken 已提交
2869 2870 2871 2872 2873 2874
		/**
		 * Set (and replace) text edits for a resource.
		 *
		 * @param uri A resource identifier.
		 * @param edits An array of text edits.
		 */
E
Erich Gamma 已提交
2875 2876
		set(uri: Uri, edits: TextEdit[]): void;

J
Johannes Rieken 已提交
2877 2878 2879 2880 2881 2882
		/**
		 * Get the text edits for a resource.
		 *
		 * @param uri A resource identifier.
		 * @return An array of text edits.
		 */
E
Erich Gamma 已提交
2883 2884
		get(uri: Uri): TextEdit[];

2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911
		/**
		 * 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.
		 */
		createFile(uri: Uri, options?: { overwrite?: boolean, ignoreIfExists?: boolean }): void;

		/**
		 * Delete a file or folder.
		 *
		 * @param uri The uri of the file that is to be deleted.
		 */
		deleteFile(uri: Uri, options?: { recursive?: boolean, ignoreIfNotExists?: boolean }): 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 or be
		 * ignored. When overwrite and ignoreIfExists are both set overwrite wins.
		 */
		renameFile(oldUri: Uri, newUri: Uri, options?: { overwrite?: boolean, ignoreIfExists?: boolean }): void;


J
Johannes Rieken 已提交
2912 2913 2914
		/**
		 * Get all text edits grouped by resource.
		 *
J
Johannes Rieken 已提交
2915
		 * @return A shallow copy of `[Uri, TextEdit[]]`-tuples.
J
Johannes Rieken 已提交
2916
		 */
E
Erich Gamma 已提交
2917 2918 2919
		entries(): [Uri, TextEdit[]][];
	}

2920 2921 2922 2923 2924 2925
	/**
	 * 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
2926 2927
	 * the end of the snippet. Variables are defined with `$name` and
	 * `${name:default value}`. The full snippet syntax is documented
S
SteVen Batten 已提交
2928
	 * [here](https://code.visualstudio.com/docs/editor/userdefinedsnippets#_creating-your-own-snippets).
2929 2930 2931 2932 2933 2934 2935 2936
	 */
	export class SnippetString {

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

2937 2938 2939 2940 2941 2942 2943
		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.
2944
		 * @return This snippet string.
2945 2946 2947 2948 2949 2950 2951
		 */
		appendText(string: string): SnippetString;

		/**
		 * Builder-function that appends a tabstop (`$1`, `$2` etc) to
		 * the [`value`](#SnippetString.value) of this snippet string.
		 *
2952
		 * @param number The number of this tabstop, defaults to an auto-increment
2953
		 * value starting at 1.
2954
		 * @return This snippet string.
2955 2956 2957 2958 2959 2960 2961 2962 2963
		 */
		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.
2964
		 * @param number The number of this tabstop, defaults to an auto-increment
2965
		 * value starting at 1.
2966
		 * @return This snippet string.
2967 2968
		 */
		appendPlaceholder(value: string | ((snippet: SnippetString) => any), number?: number): SnippetString;
2969 2970

		/**
J
Johannes Rieken 已提交
2971
		 * Builder-function that appends a variable (`${VAR}`) to
2972 2973 2974 2975 2976 2977 2978 2979
		 * 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;
2980 2981
	}

E
Erich Gamma 已提交
2982
	/**
J
Johannes Rieken 已提交
2983 2984
	 * 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 已提交
2985 2986
	 */
	export interface RenameProvider {
J
Johannes Rieken 已提交
2987 2988 2989 2990 2991 2992 2993 2994 2995 2996

		/**
		 * 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 已提交
2997
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
2998
		 */
2999
		provideRenameEdits(document: TextDocument, position: Position, newName: string, token: CancellationToken): ProviderResult<WorkspaceEdit>;
J
Johannes Rieken 已提交
3000 3001 3002

		/**
		 * Optional function for resolving and validating a position *before* running rename. The result can
3003
		 * be a range or a range and a placeholder text. The placeholder text should be the identifier of the symbol
J
Johannes Rieken 已提交
3004 3005 3006 3007 3008 3009 3010
		 * which is being renamed - when omitted the text in the returned range is used.
		 *
		 * @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`.
		 */
3011
		prepareRename?(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Range | { range: Range, placeholder: string }>;
E
Erich Gamma 已提交
3012 3013
	}

J
Johannes Rieken 已提交
3014 3015 3016
	/**
	 * Value-object describing what options formatting should use.
	 */
E
Erich Gamma 已提交
3017
	export interface FormattingOptions {
J
Johannes Rieken 已提交
3018 3019 3020 3021

		/**
		 * Size of a tab in spaces.
		 */
E
Erich Gamma 已提交
3022
		tabSize: number;
J
Johannes Rieken 已提交
3023 3024 3025 3026

		/**
		 * Prefer spaces over tabs.
		 */
E
Erich Gamma 已提交
3027
		insertSpaces: boolean;
J
Johannes Rieken 已提交
3028 3029 3030 3031 3032

		/**
		 * Signature for further properties.
		 */
		[key: string]: boolean | number | string;
E
Erich Gamma 已提交
3033 3034 3035
	}

	/**
J
Johannes Rieken 已提交
3036 3037
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
3038 3039
	 */
	export interface DocumentFormattingEditProvider {
J
Johannes Rieken 已提交
3040 3041 3042 3043 3044 3045 3046 3047

		/**
		 * 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 已提交
3048
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
3049
		 */
3050
		provideDocumentFormattingEdits(document: TextDocument, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
3051 3052 3053
	}

	/**
J
Johannes Rieken 已提交
3054 3055
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
3056 3057
	 */
	export interface DocumentRangeFormattingEditProvider {
J
Johannes Rieken 已提交
3058 3059 3060 3061 3062

		/**
		 * 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 已提交
3063 3064
		 * or larger range. Often this is done by adjusting the start and end
		 * of the range to full syntax nodes.
J
Johannes Rieken 已提交
3065 3066 3067 3068 3069 3070
		 *
		 * @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 已提交
3071
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
3072
		 */
3073
		provideDocumentRangeFormattingEdits(document: TextDocument, range: Range, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
3074 3075 3076
	}

	/**
J
Johannes Rieken 已提交
3077 3078
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
3079 3080
	 */
	export interface OnTypeFormattingEditProvider {
J
Johannes Rieken 已提交
3081 3082 3083 3084 3085 3086 3087 3088 3089 3090

		/**
		 * 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 已提交
3091
		 * @param ch The character that has been typed.
J
Johannes Rieken 已提交
3092 3093 3094
		 * @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 已提交
3095
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
3096
		 */
3097
		provideOnTypeFormattingEdits(document: TextDocument, position: Position, ch: string, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
3098 3099
	}

J
Johannes Rieken 已提交
3100 3101 3102 3103
	/**
	 * Represents a parameter of a callable-signature. A parameter can
	 * have a label and a doc-comment.
	 */
E
Erich Gamma 已提交
3104
	export class ParameterInformation {
J
Johannes Rieken 已提交
3105 3106

		/**
3107 3108 3109 3110 3111
		 * 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 已提交
3112
		 */
3113
		label: string | [number, number];
J
Johannes Rieken 已提交
3114 3115 3116 3117 3118

		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
3119
		documentation?: string | MarkdownString;
J
Johannes Rieken 已提交
3120 3121 3122 3123

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

J
Johannes Rieken 已提交
3130 3131 3132 3133 3134
	/**
	 * 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 已提交
3135
	export class SignatureInformation {
J
Johannes Rieken 已提交
3136 3137 3138 3139 3140

		/**
		 * The label of this signature. Will be shown in
		 * the UI.
		 */
E
Erich Gamma 已提交
3141
		label: string;
J
Johannes Rieken 已提交
3142 3143 3144 3145 3146

		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
3147
		documentation?: string | MarkdownString;
J
Johannes Rieken 已提交
3148 3149 3150 3151

		/**
		 * The parameters of this signature.
		 */
E
Erich Gamma 已提交
3152
		parameters: ParameterInformation[];
J
Johannes Rieken 已提交
3153 3154 3155 3156 3157

		/**
		 * Creates a new signature information object.
		 *
		 * @param label A label string.
J
Johannes Rieken 已提交
3158
		 * @param documentation A doc string.
J
Johannes Rieken 已提交
3159
		 */
3160
		constructor(label: string, documentation?: string | MarkdownString);
E
Erich Gamma 已提交
3161 3162
	}

J
Johannes Rieken 已提交
3163 3164
	/**
	 * Signature help represents the signature of something
S
Steven Clarke 已提交
3165
	 * callable. There can be multiple signatures but only one
J
Johannes Rieken 已提交
3166 3167
	 * active and only one active parameter.
	 */
E
Erich Gamma 已提交
3168
	export class SignatureHelp {
J
Johannes Rieken 已提交
3169 3170 3171 3172

		/**
		 * One or more signatures.
		 */
E
Erich Gamma 已提交
3173
		signatures: SignatureInformation[];
J
Johannes Rieken 已提交
3174 3175 3176 3177

		/**
		 * The active signature.
		 */
E
Erich Gamma 已提交
3178
		activeSignature: number;
J
Johannes Rieken 已提交
3179 3180 3181 3182

		/**
		 * The active parameter of the active signature.
		 */
E
Erich Gamma 已提交
3183 3184 3185
		activeParameter: number;
	}

3186
	/**
3187
	 * How a [`SignatureHelpProvider`](#SignatureHelpProvider) was triggered.
3188
	 */
M
Matt Bierner 已提交
3189
	export enum SignatureHelpTriggerKind {
3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213
		/**
		 * 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.
		 */
3214
		readonly triggerKind: SignatureHelpTriggerKind;
3215 3216 3217 3218 3219 3220 3221 3222 3223 3224

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

		/**
3225
		 * `true` if signature help was already showing when it was triggered.
3226
		 *
M
Matt Bierner 已提交
3227 3228
		 * 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.
3229 3230
		 */
		readonly isRetrigger: boolean;
3231 3232 3233 3234 3235 3236 3237 3238

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

J
Johannes Rieken 已提交
3241 3242
	/**
	 * The signature help provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
3243
	 * the [parameter hints](https://code.visualstudio.com/docs/editor/intellisense)-feature.
J
Johannes Rieken 已提交
3244
	 */
E
Erich Gamma 已提交
3245
	export interface SignatureHelpProvider {
J
Johannes Rieken 已提交
3246 3247 3248 3249 3250 3251 3252

		/**
		 * 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.
3253 3254
		 * @param context Information about how signature help was triggered.
		 *
J
Johannes Rieken 已提交
3255
		 * @return Signature help or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
3256
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
3257
		 */
3258 3259 3260 3261
		provideSignatureHelp(document: TextDocument, position: Position, token: CancellationToken, context: SignatureHelpContext): ProviderResult<SignatureHelp>;
	}

	/**
3262 3263
	 * Metadata about a registered [`SignatureHelpProvider`](#SignatureHelpProvider).
	 */
3264 3265 3266 3267 3268 3269 3270 3271 3272
	export interface SignatureHelpProviderMetadata {
		/**
		 * List of characters that trigger signature help.
		 */
		readonly triggerCharacters: ReadonlyArray<string>;

		/**
		 * List of characters that re-trigger signature help.
		 *
3273
		 * These trigger characters are only active when signature help is already showing. All trigger characters
3274 3275 3276
		 * are also counted as re-trigger characters.
		 */
		readonly retriggerCharacters: ReadonlyArray<string>;
E
Erich Gamma 已提交
3277 3278
	}

J
Johannes Rieken 已提交
3279 3280 3281
	/**
	 * Completion item kinds.
	 */
E
Erich Gamma 已提交
3282
	export enum CompletionItemKind {
3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298
		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,
3299
		Reference = 17,
3300
		File = 16,
3301 3302 3303 3304 3305
		Folder = 18,
		EnumMember = 19,
		Constant = 20,
		Struct = 21,
		Event = 22,
3306 3307
		Operator = 23,
		TypeParameter = 24
E
Erich Gamma 已提交
3308 3309
	}

3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320
	/**
	 * 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 已提交
3321
	/**
3322
	 * A completion item represents a text snippet that is proposed to complete text that is being typed.
J
Johannes Rieken 已提交
3323
	 *
3324
	 * It is sufficient to create a completion item from just a [label](#CompletionItem.label). In that
3325 3326
	 * case the completion item will replace the [word](#TextDocument.getWordRangeAtPosition)
	 * until the cursor with the given label or [insertText](#CompletionItem.insertText). Otherwise the
3327
	 * given [edit](#CompletionItem.textEdit) is used.
3328
	 *
3329
	 * When selecting a completion item in the editor its defined or synthesized text edit will be applied
M
Matthew J. Clemente 已提交
3330
	 * to *all* cursors/selections whereas [additionalTextEdits](#CompletionItem.additionalTextEdits) will be
3331
	 * applied as provided.
3332
	 *
J
Johannes Rieken 已提交
3333 3334
	 * @see [CompletionItemProvider.provideCompletionItems](#CompletionItemProvider.provideCompletionItems)
	 * @see [CompletionItemProvider.resolveCompletionItem](#CompletionItemProvider.resolveCompletionItem)
J
Johannes Rieken 已提交
3335
	 */
E
Erich Gamma 已提交
3336
	export class CompletionItem {
J
Johannes Rieken 已提交
3337 3338 3339

		/**
		 * The label of this completion item. By default
A
Andre Weinand 已提交
3340
		 * this is also the text that is inserted when selecting
J
Johannes Rieken 已提交
3341 3342
		 * this completion.
		 */
E
Erich Gamma 已提交
3343
		label: string;
J
Johannes Rieken 已提交
3344 3345

		/**
S
Steven Clarke 已提交
3346
		 * The kind of this completion item. Based on the kind
J
Johannes Rieken 已提交
3347 3348
		 * an icon is chosen by the editor.
		 */
3349
		kind?: CompletionItemKind;
J
Johannes Rieken 已提交
3350

3351 3352 3353 3354 3355
		/**
		 * Tags for this completion item.
		 */
		tags?: ReadonlyArray<CompletionItemTag>;

J
Johannes Rieken 已提交
3356 3357 3358 3359
		/**
		 * A human-readable string with additional information
		 * about this item, like type or symbol information.
		 */
3360
		detail?: string;
J
Johannes Rieken 已提交
3361 3362 3363 3364

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

		/**
A
Andre Weinand 已提交
3368
		 * A string that should be used when comparing this item
J
Johannes Rieken 已提交
3369 3370 3371
		 * with other items. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
3372
		sortText?: string;
J
Johannes Rieken 已提交
3373 3374 3375 3376 3377 3378

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

3381 3382 3383 3384 3385 3386 3387
		/**
		 * 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 已提交
3388
		/**
3389
		 * A string or snippet that should be inserted in a document when selecting
J
Johannes Rieken 已提交
3390 3391 3392
		 * this completion. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
3393
		insertText?: string | SnippetString;
3394 3395

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

3406 3407
		/**
		 * An optional set of characters that when pressed while this completion is active will accept it first and
J
Johannes Rieken 已提交
3408
		 * then type that character. *Note* that all commit characters should have `length=1` and that superfluous
3409 3410 3411 3412
		 * characters will be ignored.
		 */
		commitCharacters?: string[];

3413 3414
		/**
		 * Keep whitespace of the [insertText](#CompletionItem.insertText) as is. By default, the editor adjusts leading
3415
		 * whitespace of new lines so that they match the indentation of the line for which the item is accepted - setting
3416 3417 3418 3419
		 * this to `true` will prevent that.
		 */
		keepWhitespace?: boolean;

J
Johannes Rieken 已提交
3420
		/**
3421
		 * @deprecated Use `CompletionItem.insertText` and `CompletionItem.range` instead.
3422 3423
		 *
		 * ~~An [edit](#TextEdit) which is applied to a document when selecting
J
Johannes Rieken 已提交
3424
		 * this completion. When an edit is provided the value of
3425
		 * [insertText](#CompletionItem.insertText) is ignored.~~
3426
		 *
3427 3428
		 * ~~The [range](#Range) of the edit must be single-line and on the same
		 * line completions were [requested](#CompletionItemProvider.provideCompletionItems) at.~~
J
Johannes Rieken 已提交
3429
		 */
3430
		textEdit?: TextEdit;
J
Johannes Rieken 已提交
3431

3432 3433 3434 3435 3436
		/**
		 * 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.
		 */
3437
		additionalTextEdits?: TextEdit[];
3438 3439

		/**
3440 3441
		 * An optional [command](#Command) that is executed *after* inserting this completion. *Note* that
		 * additional modifications to the current document should be described with the
3442 3443
		 * [additionalTextEdits](#CompletionItem.additionalTextEdits)-property.
		 */
3444
		command?: Command;
3445

J
Johannes Rieken 已提交
3446 3447 3448 3449 3450 3451 3452
		/**
		 * 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.
3453
		 * @param kind The [kind](#CompletionItemKind) of the completion.
J
Johannes Rieken 已提交
3454
		 */
3455
		constructor(label: string, kind?: CompletionItemKind);
E
Erich Gamma 已提交
3456 3457
	}

3458 3459 3460 3461
	/**
	 * Represents a collection of [completion items](#CompletionItem) to be presented
	 * in the editor.
	 */
J
Johannes Rieken 已提交
3462
	export class CompletionList {
3463 3464

		/**
3465
		 * This list is not complete. Further typing should result in recomputing
3466 3467
		 * this list.
		 */
3468
		isIncomplete?: boolean;
3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483

		/**
		 * 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 已提交
3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494
	/**
	 * How a [completion provider](#CompletionItemProvider) was triggered
	 */
	export enum CompletionTriggerKind {
		/**
		 * Completion was triggered normally.
		 */
		Invoke = 0,
		/**
		 * Completion was triggered by a trigger character.
		 */
3495 3496 3497 3498 3499
		TriggerCharacter = 1,
		/**
		 * Completion was re-triggered as current completion list is incomplete
		 */
		TriggerForIncompleteCompletions = 2
M
Matt Bierner 已提交
3500 3501
	}

3502 3503 3504 3505 3506
	/**
	 * Contains additional information about the context in which
	 * [completion provider](#CompletionItemProvider.provideCompletionItems) is triggered.
	 */
	export interface CompletionContext {
3507 3508 3509
		/**
		 * How the completion was triggered.
		 */
M
Matt Bierner 已提交
3510
		readonly triggerKind: CompletionTriggerKind;
3511

3512 3513 3514
		/**
		 * Character that triggered the completion item provider.
		 *
M
Matt Bierner 已提交
3515
		 * `undefined` if provider was not triggered by a character.
M
Matt Bierner 已提交
3516 3517
		 *
		 * The trigger character is already in the document when the completion provider is triggered.
3518 3519 3520 3521
		 */
		readonly triggerCharacter?: string;
	}

J
Johannes Rieken 已提交
3522 3523
	/**
	 * The completion item provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
3524
	 * [IntelliSense](https://code.visualstudio.com/docs/editor/intellisense).
J
Johannes Rieken 已提交
3525
	 *
3526 3527 3528
	 * 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
3529
	 * are needed for the initial sorting and filtering, like `sortText`, `filterText`, `insertText`, and `range`, must
3530
	 * not be changed during resolve.
3531 3532 3533
	 *
	 * 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 已提交
3534
	 */
E
Erich Gamma 已提交
3535
	export interface CompletionItemProvider {
J
Johannes Rieken 已提交
3536 3537

		/**
J
Johannes Rieken 已提交
3538
		 * Provide completion items for the given position and document.
J
Johannes Rieken 已提交
3539
		 *
J
Johannes Rieken 已提交
3540 3541 3542
		 * @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 已提交
3543 3544
		 * @param context How the completion was triggered.
		 *
3545 3546
		 * @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 已提交
3547
		 */
M
Matt Bierner 已提交
3548
		provideCompletionItems(document: TextDocument, position: Position, token: CancellationToken, context: CompletionContext): ProviderResult<CompletionItem[] | CompletionList>;
J
Johannes Rieken 已提交
3549 3550

		/**
J
Johannes Rieken 已提交
3551 3552 3553 3554
		 * 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 已提交
3555
		 *
3556 3557 3558 3559
		 * *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 已提交
3560 3561
		 * @param item A completion item currently active in the UI.
		 * @param token A cancellation token.
S
Steven Clarke 已提交
3562
		 * @return The resolved completion item or a thenable that resolves to of such. It is OK to return the given
J
Johannes Rieken 已提交
3563
		 * `item`. When no result is returned, the given `item` will be used.
J
Johannes Rieken 已提交
3564
		 */
3565
		resolveCompletionItem?(item: CompletionItem, token: CancellationToken): ProviderResult<CompletionItem>;
E
Erich Gamma 已提交
3566 3567
	}

J
Johannes Rieken 已提交
3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582

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

M
Matt Bierner 已提交
3585 3586 3587 3588
		/**
		 * 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
3589
		 * trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS,
M
Matt Bierner 已提交
3590 3591 3592 3593
		 * user settings, and localization.
		 */
		tooltip?: string;

J
Johannes Rieken 已提交
3594 3595 3596 3597 3598 3599
		/**
		 * 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.
		 */
3600
		constructor(range: Range, target?: Uri);
J
Johannes Rieken 已提交
3601 3602 3603 3604 3605 3606 3607 3608 3609
	}

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

		/**
3610 3611 3612
		 * 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 已提交
3613 3614 3615
		 * @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
3616
		 * can be signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
3617
		 */
3618
		provideDocumentLinks(document: TextDocument, token: CancellationToken): ProviderResult<DocumentLink[]>;
3619 3620 3621

		/**
		 * Given a link fill in its [target](#DocumentLink.target). This method is called when an incomplete
3622
		 * link is selected in the UI. Providers can implement this method and return incomplete links
3623 3624 3625 3626 3627 3628
		 * (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.
		 */
3629
		resolveDocumentLink?(link: DocumentLink, token: CancellationToken): ProviderResult<DocumentLink>;
J
Johannes Rieken 已提交
3630 3631
	}

3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661
	/**
	 * 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.
3662
		 * @param blue The blue component.
3663 3664 3665 3666 3667 3668 3669 3670 3671
		 * @param alpha The alpha component.
		 */
		constructor(red: number, green: number, blue: number, alpha: number);
	}

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

3673
		/**
3674
		 * The range in the document where this color appears.
3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698
		 */
		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
3699
	 * apply, e.g. `System.Drawing.Color.Red`.
3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741
	 */
	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.
3742
		 * @return An array of [color information](#ColorInformation) or a thenable that resolves to such. The lack of a result
3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757
		 * 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[]>;
	}
3758

3759
	/**
F
Filipe Correia 已提交
3760
	 * 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.
3761 3762
	 * Invalid ranges will be ignored.
	 */
3763 3764 3765 3766
	export class FoldingRange {

		/**
		 * The zero-based start line of the range to fold. The folded area starts after the line's last character.
3767
		 * To be valid, the end must be zero or larger and smaller than the number of lines in the document.
3768 3769 3770 3771 3772
		 */
		start: number;

		/**
		 * The zero-based end line of the range to fold. The folded area ends with the line's last character.
3773
		 * To be valid, the end must be zero or larger and smaller than the number of lines in the document.
3774 3775 3776 3777 3778 3779 3780
		 */
		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
3781
		 * [FoldingRangeKind](#FoldingRangeKind) for an enumeration of all kinds.
3782
		 * If not set, the range is originated from a syntax element.
3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795
		 */
		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);
	}

3796
	/**
3797 3798 3799 3800
	 * 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.
3801
	 */
3802
	export enum FoldingRangeKind {
3803
		/**
3804
		 * Kind for folding range representing a comment.
3805
		 */
3806
		Comment = 1,
3807
		/**
3808
		 * Kind for folding range representing a import.
3809
		 */
3810
		Imports = 2,
3811
		/**
3812
		 * Kind for folding range representing regions originating from folding markers like `#region` and `#endregion`.
3813
		 */
3814
		Region = 3
3815 3816 3817 3818 3819 3820 3821 3822
	}

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

3823 3824 3825 3826
	/**
	 * The folding range provider interface defines the contract between extensions and
	 * [Folding](https://code.visualstudio.com/docs/editor/codebasics#_folding) in the editor.
	 */
3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837
	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[]>;
	}

3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866
	/**
	 * 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.
		 *
3867
		 * Selection ranges should be computed individually and independent for each position. The editor will merge
3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879
		 * 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[]>;
	}

J
Johannes Rieken 已提交
3880 3881 3882 3883
	/**
	 * A tuple of two characters, like a pair of
	 * opening and closing brackets.
	 */
E
Erich Gamma 已提交
3884 3885
	export type CharacterPair = [string, string];

J
Johannes Rieken 已提交
3886 3887 3888
	/**
	 * Describes how comments for a language work.
	 */
E
Erich Gamma 已提交
3889
	export interface CommentRule {
J
Johannes Rieken 已提交
3890 3891 3892 3893

		/**
		 * The line comment token, like `// this is a comment`
		 */
E
Erich Gamma 已提交
3894
		lineComment?: string;
J
Johannes Rieken 已提交
3895 3896 3897 3898 3899

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

A
Alex Dima 已提交
3902 3903 3904
	/**
	 * Describes indentation rules for a language.
	 */
E
Erich Gamma 已提交
3905
	export interface IndentationRule {
A
Alex Dima 已提交
3906
		/**
3907
		 * If a line matches this pattern, then all the lines after it should be unindented once (until another rule matches).
A
Alex Dima 已提交
3908
		 */
E
Erich Gamma 已提交
3909
		decreaseIndentPattern: RegExp;
A
Alex Dima 已提交
3910 3911 3912
		/**
		 * If a line matches this pattern, then all the lines after it should be indented once (until another rule matches).
		 */
E
Erich Gamma 已提交
3913
		increaseIndentPattern: RegExp;
A
Alex Dima 已提交
3914 3915 3916
		/**
		 * If a line matches this pattern, then **only the next line** after it should be indented once.
		 */
E
Erich Gamma 已提交
3917
		indentNextLinePattern?: RegExp;
A
Alex Dima 已提交
3918 3919 3920
		/**
		 * 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 已提交
3921 3922 3923
		unIndentedLinePattern?: RegExp;
	}

A
Alex Dima 已提交
3924 3925 3926
	/**
	 * Describes what to do with the indentation when pressing Enter.
	 */
E
Erich Gamma 已提交
3927
	export enum IndentAction {
A
Alex Dima 已提交
3928 3929 3930
		/**
		 * Insert new line and copy the previous line's indentation.
		 */
3931
		None = 0,
A
Alex Dima 已提交
3932 3933 3934
		/**
		 * Insert new line and indent once (relative to the previous line's indentation).
		 */
3935
		Indent = 1,
A
Alex Dima 已提交
3936 3937 3938 3939 3940
		/**
		 * Insert two new lines:
		 *  - the first one indented which will hold the cursor
		 *  - the second one at the same indentation level
		 */
3941
		IndentOutdent = 2,
A
Alex Dima 已提交
3942 3943 3944
		/**
		 * Insert new line and outdent once (relative to the previous line's indentation).
		 */
3945
		Outdent = 3
E
Erich Gamma 已提交
3946 3947
	}

A
Alex Dima 已提交
3948 3949 3950
	/**
	 * Describes what to do when pressing Enter.
	 */
E
Erich Gamma 已提交
3951
	export interface EnterAction {
A
Alex Dima 已提交
3952 3953 3954 3955 3956 3957 3958
		/**
		 * 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 已提交
3959
		appendText?: string;
A
Alex Dima 已提交
3960 3961 3962 3963
		/**
		 * Describes the number of characters to remove from the new line's indentation.
		 */
		removeText?: number;
E
Erich Gamma 已提交
3964 3965
	}

A
Alex Dima 已提交
3966 3967 3968
	/**
	 * Describes a rule to be evaluated when pressing Enter.
	 */
E
Erich Gamma 已提交
3969
	export interface OnEnterRule {
A
Alex Dima 已提交
3970 3971 3972
		/**
		 * This rule will only execute if the text before the cursor matches this regular expression.
		 */
E
Erich Gamma 已提交
3973
		beforeText: RegExp;
A
Alex Dima 已提交
3974 3975 3976
		/**
		 * This rule will only execute if the text after the cursor matches this regular expression.
		 */
E
Erich Gamma 已提交
3977
		afterText?: RegExp;
A
Alex Dima 已提交
3978 3979 3980
		/**
		 * The action to execute.
		 */
E
Erich Gamma 已提交
3981 3982 3983
		action: EnterAction;
	}

J
Johannes Rieken 已提交
3984
	/**
A
Andre Weinand 已提交
3985
	 * The language configuration interfaces defines the contract between extensions
S
Steven Clarke 已提交
3986
	 * and various editor features, like automatic bracket insertion, automatic indentation etc.
J
Johannes Rieken 已提交
3987
	 */
E
Erich Gamma 已提交
3988
	export interface LanguageConfiguration {
A
Alex Dima 已提交
3989 3990 3991
		/**
		 * The language's comment settings.
		 */
E
Erich Gamma 已提交
3992
		comments?: CommentRule;
A
Alex Dima 已提交
3993 3994 3995 3996
		/**
		 * The language's brackets.
		 * This configuration implicitly affects pressing Enter around these brackets.
		 */
E
Erich Gamma 已提交
3997
		brackets?: CharacterPair[];
A
Alex Dima 已提交
3998 3999 4000 4001 4002 4003 4004
		/**
		 * 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 已提交
4005
		wordPattern?: RegExp;
A
Alex Dima 已提交
4006 4007 4008
		/**
		 * The language's indentation settings.
		 */
E
Erich Gamma 已提交
4009
		indentationRules?: IndentationRule;
A
Alex Dima 已提交
4010 4011 4012
		/**
		 * The language's rules to be evaluated when pressing Enter.
		 */
E
Erich Gamma 已提交
4013 4014 4015
		onEnterRules?: OnEnterRule[];

		/**
A
Alex Dima 已提交
4016
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
4017 4018
		 *
		 * @deprecated Will be replaced by a better API soon.
E
Erich Gamma 已提交
4019 4020
		 */
		__electricCharacterSupport?: {
4021 4022 4023 4024 4025 4026
			/**
			 * This property is deprecated and will be **ignored** from
			 * the editor.
			 * @deprecated
			 */
			brackets?: any;
4027 4028 4029
			/**
			 * This property is deprecated and not fully supported anymore by
			 * the editor (scope and lineStart are ignored).
4030
			 * Use the autoClosingPairs property in the language configuration file instead.
4031 4032
			 * @deprecated
			 */
E
Erich Gamma 已提交
4033
			docComment?: {
A
Alex Dima 已提交
4034 4035 4036 4037
				scope: string;
				open: string;
				lineStart: string;
				close?: string;
E
Erich Gamma 已提交
4038 4039 4040 4041
			};
		};

		/**
A
Alex Dima 已提交
4042
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
4043
		 *
4044
		 * @deprecated * Use the autoClosingPairs property in the language configuration file instead.
E
Erich Gamma 已提交
4045 4046 4047 4048 4049 4050 4051 4052 4053 4054
		 */
		__characterPairSupport?: {
			autoClosingPairs: {
				open: string;
				close: string;
				notIn?: string[];
			}[];
		};
	}

J
Johannes Rieken 已提交
4055
	/**
S
Sandeep Somavarapu 已提交
4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076
	 * 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
4077
	 *
S
Sandeep Somavarapu 已提交
4078 4079 4080 4081
	 * - Default configuration
	 * - Global configuration
	 * - Workspace configuration (if available)
	 * - Workspace folder configuration of the requested resource (if available)
4082
	 *
4083
	 * *Global configuration* comes from User Settings and overrides Defaults.
S
Sandeep Somavarapu 已提交
4084
	 *
4085
	 * *Workspace configuration* comes from Workspace Settings and overrides Global configuration.
S
Sandeep Somavarapu 已提交
4086
	 *
4087
	 * *Workspace Folder configuration* comes from `.vscode` folder under one of the [workspace folders](#workspace.workspaceFolders) and overrides Workspace configuration.
S
Sandeep Somavarapu 已提交
4088 4089
	 *
	 * *Note:* Workspace and Workspace Folder configurations contains `launch` and `tasks` settings. Their basename will be
4090 4091 4092
	 * part of the section identifier. The following snippets shows how to retrieve all configurations
	 * from `launch.json`:
	 *
4093
	 * ```ts
D
Daniel Imms 已提交
4094
	 * // launch.json configuration
S
Sandeep Somavarapu 已提交
4095
	 * const config = workspace.getConfiguration('launch', vscode.window.activeTextEditor.document.uri);
4096 4097
	 *
	 * // retrieve values
D
Daniel Imms 已提交
4098 4099
	 * const values = config.get('configurations');
	 * ```
S
Sandeep Somavarapu 已提交
4100 4101
	 *
	 * Refer to [Settings](https://code.visualstudio.com/docs/getstarted/settings) for more information.
J
Johannes Rieken 已提交
4102
	 */
E
Erich Gamma 已提交
4103 4104
	export interface WorkspaceConfiguration {

4105 4106 4107 4108 4109 4110 4111 4112
		/**
		 * 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 已提交
4113
		/**
J
Johannes Rieken 已提交
4114 4115 4116
		 * Return a value from this configuration.
		 *
		 * @param section Configuration name, supports _dotted_ names.
J
Johannes Rieken 已提交
4117
		 * @param defaultValue A value should be returned when no value could be found, is `undefined`.
J
Johannes Rieken 已提交
4118
		 * @return The value `section` denotes or the default.
E
Erich Gamma 已提交
4119
		 */
4120 4121
		get<T>(section: string, defaultValue: T): T;

E
Erich Gamma 已提交
4122
		/**
J
Johannes Rieken 已提交
4123 4124
		 * Check if this configuration has a certain value.
		 *
4125
		 * @param section Configuration name, supports _dotted_ names.
G
Gama11 已提交
4126
		 * @return `true` if the section doesn't resolve to `undefined`.
E
Erich Gamma 已提交
4127 4128 4129
		 */
		has(section: string): boolean;

4130 4131
		/**
		 * Retrieve all information about a configuration setting. A configuration value
S
Sandeep Somavarapu 已提交
4132 4133 4134 4135
		 * often consists of a *default* value, a global or installation-wide value,
		 * a workspace-specific value and a folder-specific value.
		 *
		 * The *effective* value (returned by [`get`](#WorkspaceConfiguration.get))
4136 4137 4138
		 * is computed like this: `defaultValue` overridden by `globalValue`,
		 * `globalValue` overridden by `workspaceValue`. `workspaceValue` overwridden by `workspaceFolderValue`.
		 * Refer to [Settings](https://code.visualstudio.com/docs/getstarted/settings)
S
Sandeep Somavarapu 已提交
4139
		 * for more information.
4140 4141 4142 4143 4144 4145 4146
		 *
		 * *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 已提交
4147
		inspect<T>(section: string): { key: string; defaultValue?: T; globalValue?: T; workspaceValue?: T, workspaceFolderValue?: T } | undefined;
S
Sandeep Somavarapu 已提交
4148 4149

		/**
S
Sandeep Somavarapu 已提交
4150
		 * Update a configuration value. The updated configuration values are persisted.
S
Sandeep Somavarapu 已提交
4151
		 *
S
Sandeep Somavarapu 已提交
4152
		 * A value can be changed in
S
Sandeep Somavarapu 已提交
4153
		 *
S
Sandeep Somavarapu 已提交
4154 4155 4156 4157
		 * - [Global configuration](#ConfigurationTarget.Global): Changes the value for all instances of the editor.
		 * - [Workspace configuration](#ConfigurationTarget.Workspace): Changes the value for current workspace, if available.
		 * - [Workspace folder configuration](#ConfigurationTarget.WorkspaceFolder): Changes the value for the
		 * [Workspace folder](#workspace.workspaceFolders) to which the current [configuration](#WorkspaceConfiguration) is scoped to.
S
Sandeep Somavarapu 已提交
4158
		 *
S
Sandeep Somavarapu 已提交
4159 4160 4161 4162
		 * *Note 1:* Setting a global value in the presence of a more specific workspace value
		 * has no observable effect in that workspace, but in others. Setting a workspace value
		 * in the presence of a more specific folder value has no observable effect for the resources
		 * under respective [folder](#workspace.workspaceFolders), but in others. Refer to
4163
		 * [Settings Inheritance](https://code.visualstudio.com/docs/getstarted/settings) for more information.
4164
		 *
4165 4166
		 * *Note 2:* To remove a configuration value use `undefined`, like so: `config.update('somekey', undefined)`
		 *
S
Sandeep Somavarapu 已提交
4167 4168 4169
		 * Will throw error when
		 * - Writing a configuration which is not registered.
		 * - Writing a configuration to workspace or folder target when no workspace is opened
S
Sandeep Somavarapu 已提交
4170
		 * - Writing a configuration to folder target when there is no folder settings
S
Sandeep Somavarapu 已提交
4171 4172 4173
		 * - Writing to folder target without passing a resource when getting the configuration (`workspace.getConfiguration(section, resource)`)
		 * - Writing a window configuration to folder target
		 *
4174 4175
		 * @param section Configuration name, supports _dotted_ names.
		 * @param value The new value.
S
Sandeep Somavarapu 已提交
4176
		 * @param configurationTarget The [configuration target](#ConfigurationTarget) or a boolean value.
S
Sandeep Somavarapu 已提交
4177 4178 4179 4180 4181
		 *	- If `true` configuration target is `ConfigurationTarget.Global`.
		 *	- If `false` configuration target is `ConfigurationTarget.Workspace`.
		 *	- If `undefined` or `null` configuration target is
		 *	`ConfigurationTarget.WorkspaceFolder` when configuration is resource specific
		 *	`ConfigurationTarget.Workspace` otherwise.
4182
		 */
S
Sandeep Somavarapu 已提交
4183
		update(section: string, value: any, configurationTarget?: ConfigurationTarget | boolean): Thenable<void>;
4184

E
Erich Gamma 已提交
4185 4186 4187
		/**
		 * Readable dictionary that backs this configuration.
		 */
4188
		readonly [key: string]: any;
E
Erich Gamma 已提交
4189 4190
	}

J
Johannes Rieken 已提交
4191 4192 4193 4194 4195
	/**
	 * Represents a location inside a resource, such as a line
	 * inside a text file.
	 */
	export class Location {
J
Johannes Rieken 已提交
4196 4197 4198 4199

		/**
		 * The resource identifier of this location.
		 */
J
Johannes Rieken 已提交
4200
		uri: Uri;
J
Johannes Rieken 已提交
4201 4202

		/**
A
Andre Weinand 已提交
4203
		 * The document range of this location.
J
Johannes Rieken 已提交
4204
		 */
J
Johannes Rieken 已提交
4205
		range: Range;
J
Johannes Rieken 已提交
4206 4207 4208 4209 4210 4211 4212 4213

		/**
		 * 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 已提交
4214 4215
	}

4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244
	/**
	 * 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;
	}

4245 4246 4247 4248 4249 4250 4251 4252
	/**
	 * The event that is fired when diagnostics change.
	 */
	export interface DiagnosticChangeEvent {

		/**
		 * An array of resources for which diagnostics have changed.
		 */
4253
		readonly uris: ReadonlyArray<Uri>;
4254 4255
	}

E
Erich Gamma 已提交
4256 4257 4258 4259
	/**
	 * Represents the severity of diagnostics.
	 */
	export enum DiagnosticSeverity {
J
Johannes Rieken 已提交
4260 4261

		/**
S
Steven Clarke 已提交
4262
		 * Something not allowed by the rules of a language or other means.
J
Johannes Rieken 已提交
4263 4264 4265 4266 4267 4268
		 */
		Error = 0,

		/**
		 * Something suspicious but allowed.
		 */
E
Erich Gamma 已提交
4269
		Warning = 1,
J
Johannes Rieken 已提交
4270 4271 4272 4273 4274 4275 4276

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

		/**
A
Andre Weinand 已提交
4277
		 * Something to hint to a better way of doing it, like proposing
J
Johannes Rieken 已提交
4278 4279 4280
		 * a refactoring.
		 */
		Hint = 3
E
Erich Gamma 已提交
4281 4282
	}

4283 4284
	/**
	 * Represents a related message and source code location for a diagnostic. This should be
4285
	 * used to point to code locations that cause or related to a diagnostics, e.g. when duplicating
4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308
	 * 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);
	}

4309 4310 4311 4312 4313 4314 4315 4316 4317
	/**
	 * 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 已提交
4318
		 * example, `"editorUnnecessaryCode.opacity": "#000000c0"` will render the
4319
		 * code with 75% opacity. For high contrast themes, use the
M
Matt Bierner 已提交
4320
		 * `"editorUnnecessaryCode.border"` theme color to underline unnecessary code
4321 4322 4323
		 * instead of fading it out.
		 */
		Unnecessary = 1,
4324 4325 4326 4327 4328 4329 4330

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

E
Erich Gamma 已提交
4333
	/**
J
Johannes Rieken 已提交
4334 4335
	 * Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
	 * are only valid in the scope of a file.
E
Erich Gamma 已提交
4336
	 */
J
Johannes Rieken 已提交
4337 4338 4339 4340 4341
	export class Diagnostic {

		/**
		 * The range to which this diagnostic applies.
		 */
E
Erich Gamma 已提交
4342
		range: Range;
J
Johannes Rieken 已提交
4343 4344 4345 4346 4347 4348

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

4349
		/**
J
Johannes Rieken 已提交
4350
		 * The severity, default is [error](#DiagnosticSeverity.Error).
4351
		 */
J
Johannes Rieken 已提交
4352
		severity: DiagnosticSeverity;
4353

J
Johannes Rieken 已提交
4354
		/**
J
Johannes Rieken 已提交
4355 4356
		 * A human-readable string describing the source of this
		 * diagnostic, e.g. 'typescript' or 'super lint'.
J
Johannes Rieken 已提交
4357
		 */
J
Johannes Rieken 已提交
4358
		source?: string;
J
Johannes Rieken 已提交
4359 4360

		/**
S
Sandeep Somavarapu 已提交
4361 4362
		 * A code or identifier for this diagnostic.
		 * Should be used for later processing, e.g. when providing [code actions](#CodeActionContext).
J
Johannes Rieken 已提交
4363
		 */
J
Johannes Rieken 已提交
4364
		code?: string | number;
J
Johannes Rieken 已提交
4365

4366 4367 4368 4369
		/**
		 * 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 已提交
4370
		relatedInformation?: DiagnosticRelatedInformation[];
4371

4372 4373 4374 4375 4376
		/**
		 * Additional metadata about the diagnostic.
		 */
		tags?: DiagnosticTag[];

J
Johannes Rieken 已提交
4377
		/**
A
Andre Weinand 已提交
4378
		 * Creates a new diagnostic object.
J
Johannes Rieken 已提交
4379 4380 4381
		 *
		 * @param range The range to which this diagnostic applies.
		 * @param message The human-readable message.
A
Andre Weinand 已提交
4382
		 * @param severity The severity, default is [error](#DiagnosticSeverity.Error).
J
Johannes Rieken 已提交
4383 4384
		 */
		constructor(range: Range, message: string, severity?: DiagnosticSeverity);
E
Erich Gamma 已提交
4385 4386
	}

J
Johannes Rieken 已提交
4387 4388 4389
	/**
	 * A diagnostics collection is a container that manages a set of
	 * [diagnostics](#Diagnostic). Diagnostics are always scopes to a
4390
	 * diagnostics collection and a resource.
J
Johannes Rieken 已提交
4391 4392 4393 4394
	 *
	 * To get an instance of a `DiagnosticCollection` use
	 * [createDiagnosticCollection](#languages.createDiagnosticCollection).
	 */
E
Erich Gamma 已提交
4395 4396 4397
	export interface DiagnosticCollection {

		/**
J
Johannes Rieken 已提交
4398 4399 4400
		 * 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 已提交
4401
		 */
Y
Yuki Ueda 已提交
4402
		readonly name: string;
E
Erich Gamma 已提交
4403 4404 4405

		/**
		 * Assign diagnostics for given resource. Will replace
J
Johannes Rieken 已提交
4406 4407 4408 4409
		 * existing diagnostics for that resource.
		 *
		 * @param uri A resource identifier.
		 * @param diagnostics Array of diagnostics or `undefined`
E
Erich Gamma 已提交
4410
		 */
4411
		set(uri: Uri, diagnostics: ReadonlyArray<Diagnostic> | undefined): void;
E
Erich Gamma 已提交
4412 4413

		/**
4414
		 * Replace all entries in this collection.
J
Johannes Rieken 已提交
4415
		 *
4416 4417 4418 4419 4420 4421
		 * 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 已提交
4422
		 */
4423
		set(entries: ReadonlyArray<[Uri, ReadonlyArray<Diagnostic> | undefined]>): void;
E
Erich Gamma 已提交
4424 4425

		/**
4426 4427
		 * Remove all diagnostics from this collection that belong
		 * to the provided `uri`. The same as `#set(uri, undefined)`.
J
Johannes Rieken 已提交
4428
		 *
4429
		 * @param uri A resource identifier.
E
Erich Gamma 已提交
4430
		 */
4431
		delete(uri: Uri): void;
E
Erich Gamma 已提交
4432 4433 4434 4435 4436 4437 4438

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

4439 4440 4441 4442 4443 4444
		/**
		 * 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.
		 */
4445
		forEach(callback: (uri: Uri, diagnostics: ReadonlyArray<Diagnostic>, collection: DiagnosticCollection) => any, thisArg?: any): void;
4446

4447 4448 4449 4450 4451
		/**
		 * Get the diagnostics for a given resource. *Note* that you cannot
		 * modify the diagnostics-array returned from this call.
		 *
		 * @param uri A resource identifier.
4452
		 * @returns An immutable array of [diagnostics](#Diagnostic) or `undefined`.
4453
		 */
4454
		get(uri: Uri): ReadonlyArray<Diagnostic> | undefined;
4455 4456 4457 4458 4459 4460 4461 4462 4463 4464

		/**
		 * 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 已提交
4465 4466 4467 4468
		/**
		 * Dispose and free associated resources. Calls
		 * [clear](#DiagnosticCollection.clear).
		 */
E
Erich Gamma 已提交
4469 4470 4471
		dispose(): void;
	}

J
Johannes Rieken 已提交
4472
	/**
4473 4474 4475
	 * 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 已提交
4476 4477
	 */
	export enum ViewColumn {
J
Johannes Rieken 已提交
4478
		/**
4479 4480 4481
		 * 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 已提交
4482
		 */
4483
		Active = -1,
4484 4485 4486 4487 4488 4489
		/**
		 * 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 已提交
4490
		/**
4491
		 * The first editor column.
J
Johannes Rieken 已提交
4492
		 */
J
Johannes Rieken 已提交
4493
		One = 1,
J
Johannes Rieken 已提交
4494
		/**
4495
		 * The second editor column.
J
Johannes Rieken 已提交
4496
		 */
J
Johannes Rieken 已提交
4497
		Two = 2,
J
Johannes Rieken 已提交
4498
		/**
4499
		 * The third editor column.
J
Johannes Rieken 已提交
4500
		 */
4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525
		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 已提交
4526 4527
	}

E
Erich Gamma 已提交
4528
	/**
J
Johannes Rieken 已提交
4529 4530 4531
	 * An output channel is a container for readonly textual information.
	 *
	 * To get an instance of an `OutputChannel` use
S
Sandeep Somavarapu 已提交
4532
	 * [createOutputChannel](#window.createOutputChannel).
E
Erich Gamma 已提交
4533
	 */
J
Johannes Rieken 已提交
4534
	export interface OutputChannel {
E
Erich Gamma 已提交
4535

J
Johannes Rieken 已提交
4536 4537 4538
		/**
		 * The human-readable name of this output channel.
		 */
Y
Yuki Ueda 已提交
4539
		readonly name: string;
E
Erich Gamma 已提交
4540 4541

		/**
J
Johannes Rieken 已提交
4542
		 * Append the given value to the channel.
E
Erich Gamma 已提交
4543
		 *
J
Johannes Rieken 已提交
4544
		 * @param value A string, falsy values will not be printed.
E
Erich Gamma 已提交
4545
		 */
J
Johannes Rieken 已提交
4546
		append(value: string): void;
E
Erich Gamma 已提交
4547 4548

		/**
J
Johannes Rieken 已提交
4549 4550
		 * Append the given value and a line feed character
		 * to the channel.
E
Erich Gamma 已提交
4551
		 *
J
Johannes Rieken 已提交
4552
		 * @param value A string, falsy values will be printed.
E
Erich Gamma 已提交
4553 4554 4555
		 */
		appendLine(value: string): void;

J
Johannes Rieken 已提交
4556 4557 4558
		/**
		 * Removes all output from the channel.
		 */
E
Erich Gamma 已提交
4559 4560
		clear(): void;

J
Johannes Rieken 已提交
4561 4562
		/**
		 * Reveal this channel in the UI.
4563
		 *
4564
		 * @param preserveFocus When `true` the channel will not take focus.
J
Johannes Rieken 已提交
4565
		 */
J
Johannes Rieken 已提交
4566
		show(preserveFocus?: boolean): void;
E
Erich Gamma 已提交
4567

4568
		/**
4569
		 * ~~Reveal this channel in the UI.~~
4570
		 *
4571
		 * @deprecated Use the overload with just one parameter (`show(preserveFocus?: boolean): void`).
J
Johannes Rieken 已提交
4572 4573
		 *
		 * @param column This argument is **deprecated** and will be ignored.
4574 4575
		 * @param preserveFocus When `true` the channel will not take focus.
		 */
J
Johannes Rieken 已提交
4576
		show(column?: ViewColumn, preserveFocus?: boolean): void;
4577

J
Johannes Rieken 已提交
4578 4579 4580
		/**
		 * Hide this channel from the UI.
		 */
E
Erich Gamma 已提交
4581 4582
		hide(): void;

J
Johannes Rieken 已提交
4583 4584 4585
		/**
		 * Dispose and free associated resources.
		 */
E
Erich Gamma 已提交
4586 4587 4588 4589
		dispose(): void;
	}

	/**
J
Johannes Rieken 已提交
4590
	 * Represents the alignment of status bar items.
E
Erich Gamma 已提交
4591 4592
	 */
	export enum StatusBarAlignment {
J
Johannes Rieken 已提交
4593 4594 4595 4596

		/**
		 * Aligned to the left side.
		 */
4597
		Left = 1,
J
Johannes Rieken 已提交
4598 4599 4600 4601

		/**
		 * Aligned to the right side.
		 */
4602
		Right = 2
E
Erich Gamma 已提交
4603 4604 4605 4606 4607 4608 4609 4610 4611
	}

	/**
	 * 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 已提交
4612
		 * The alignment of this item.
E
Erich Gamma 已提交
4613
		 */
Y
Yuki Ueda 已提交
4614
		readonly alignment: StatusBarAlignment;
E
Erich Gamma 已提交
4615 4616

		/**
J
Johannes Rieken 已提交
4617 4618
		 * The priority of this item. Higher value means the item should
		 * be shown more to the left.
E
Erich Gamma 已提交
4619
		 */
4620
		readonly priority?: number;
E
Erich Gamma 已提交
4621 4622

		/**
J
Johannes Rieken 已提交
4623 4624
		 * The text to show for the entry. You can embed icons in the text by leveraging the syntax:
		 *
J
Johannes Rieken 已提交
4625
		 * `My text $(icon-name) contains icons like $(icon-name) this one.`
J
Johannes Rieken 已提交
4626
		 *
4627 4628
		 * Where the icon-name is taken from the [octicon](https://octicons.github.com) icon set, e.g.
		 * `light-bulb`, `thumbsup`, `zap` etc.
J
Johannes Rieken 已提交
4629
		 */
E
Erich Gamma 已提交
4630 4631 4632
		text: string;

		/**
J
Johannes Rieken 已提交
4633 4634
		 * The tooltip text when you hover over this entry.
		 */
4635
		tooltip: string | undefined;
E
Erich Gamma 已提交
4636 4637

		/**
J
Johannes Rieken 已提交
4638 4639
		 * The foreground color for this entry.
		 */
4640
		color: string | ThemeColor | undefined;
E
Erich Gamma 已提交
4641 4642

		/**
J
Johannes Rieken 已提交
4643 4644 4645
		 * The identifier of a command to run on click. The command must be
		 * [known](#commands.getCommands).
		 */
4646
		command: string | undefined;
E
Erich Gamma 已提交
4647 4648 4649 4650 4651 4652 4653

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

		/**
J
Johannes Rieken 已提交
4654
		 * Hide the entry in the status bar.
E
Erich Gamma 已提交
4655 4656 4657 4658
		 */
		hide(): void;

		/**
J
Johannes Rieken 已提交
4659 4660
		 * Dispose and free associated resources. Call
		 * [hide](#StatusBarItem.hide).
E
Erich Gamma 已提交
4661 4662 4663 4664
		 */
		dispose(): void;
	}

4665 4666 4667 4668 4669 4670 4671
	/**
	 * Defines a generalized way of reporting progress updates.
	 */
	export interface Progress<T> {

		/**
		 * Report a progress update.
4672 4673
		 * @param value A progress item, like a message and/or an
		 * report on how much work finished
4674
		 */
J
Johannes Rieken 已提交
4675
		report(value: T): void;
4676 4677
	}

D
Daniel Imms 已提交
4678 4679 4680
	/**
	 * An individual terminal instance within the integrated terminal.
	 */
D
Daniel Imms 已提交
4681
	export interface Terminal {
D
Daniel Imms 已提交
4682

4683 4684 4685
		/**
		 * The name of the terminal.
		 */
Y
Yuki Ueda 已提交
4686
		readonly name: string;
4687

4688 4689 4690
		/**
		 * The process ID of the shell process.
		 */
Y
Yuki Ueda 已提交
4691
		readonly processId: Thenable<number>;
4692

D
Daniel Imms 已提交
4693
		/**
D
Daniel Imms 已提交
4694
		 * Send text to the terminal. The text is written to the stdin of the underlying pty process
4695
		 * (shell) of the terminal.
D
Daniel Imms 已提交
4696
		 *
D
Daniel Imms 已提交
4697
		 * @param text The text to send.
D
Daniel Imms 已提交
4698
		 * @param addNewLine Whether to add a new line to the text being sent, this is normally
4699 4700
		 * 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 已提交
4701
		 */
4702
		sendText(text: string, addNewLine?: boolean): void;
D
Daniel Imms 已提交
4703 4704

		/**
D
Daniel Imms 已提交
4705
		 * Show the terminal panel and reveal this terminal in the UI.
D
Daniel Imms 已提交
4706
		 *
D
Daniel Imms 已提交
4707
		 * @param preserveFocus When `true` the terminal will not take focus.
D
Daniel Imms 已提交
4708
		 */
D
Daniel Imms 已提交
4709
		show(preserveFocus?: boolean): void;
D
Daniel Imms 已提交
4710 4711

		/**
D
Daniel Imms 已提交
4712
		 * Hide the terminal panel if this terminal is currently showing.
D
Daniel Imms 已提交
4713 4714 4715 4716 4717 4718 4719
		 */
		hide(): void;

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

J
Johannes Rieken 已提交
4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738
	/**
	 * 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 已提交
4739 4740 4741
	/**
	 * Represents an extension.
	 *
A
Alex Dima 已提交
4742
	 * To get an instance of an `Extension` use [getExtension](#extensions.getExtension).
J
Johannes Rieken 已提交
4743
	 */
E
Erich Gamma 已提交
4744
	export interface Extension<T> {
J
Johannes Rieken 已提交
4745

E
Erich Gamma 已提交
4746
		/**
J
Johannes Rieken 已提交
4747
		 * The canonical extension identifier in the form of: `publisher.name`.
E
Erich Gamma 已提交
4748
		 */
Y
Yuki Ueda 已提交
4749
		readonly id: string;
E
Erich Gamma 已提交
4750 4751

		/**
J
Johannes Rieken 已提交
4752
		 * The absolute file path of the directory containing this extension.
E
Erich Gamma 已提交
4753
		 */
Y
Yuki Ueda 已提交
4754
		readonly extensionPath: string;
E
Erich Gamma 已提交
4755 4756

		/**
4757
		 * `true` if the extension has been activated.
E
Erich Gamma 已提交
4758
		 */
Y
Yuki Ueda 已提交
4759
		readonly isActive: boolean;
E
Erich Gamma 已提交
4760 4761 4762 4763

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

J
Johannes Rieken 已提交
4766 4767 4768 4769 4770 4771 4772 4773 4774
		/**
		 * 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
		 * if defined in the `package.json` file of extensions but can also be refined
		 * via the the `remote.extensionKind`-setting. When no remote extension host exists,
		 * the value is [`ExtensionKind.UI`](#ExtensionKind.UI).
		 */
		extensionKind: ExtensionKind;

E
Erich Gamma 已提交
4775
		/**
A
Alex Dima 已提交
4776
		 * The public API exported by this extension. It is an invalid action
J
Johannes Rieken 已提交
4777
		 * to access this field before this extension has been activated.
E
Erich Gamma 已提交
4778
		 */
Y
Yuki Ueda 已提交
4779
		readonly exports: T;
E
Erich Gamma 已提交
4780 4781 4782

		/**
		 * Activates this extension and returns its public API.
J
Johannes Rieken 已提交
4783
		 *
S
Steven Clarke 已提交
4784
		 * @return A promise that will resolve when this extension has been activated.
E
Erich Gamma 已提交
4785 4786 4787 4788
		 */
		activate(): Thenable<T>;
	}

J
Johannes Rieken 已提交
4789
	/**
S
Steven Clarke 已提交
4790 4791
	 * An extension context is a collection of utilities private to an
	 * extension.
J
Johannes Rieken 已提交
4792
	 *
S
Steven Clarke 已提交
4793
	 * An instance of an `ExtensionContext` is provided as the first
J
Johannes Rieken 已提交
4794 4795
	 * parameter to the `activate`-call of an extension.
	 */
E
Erich Gamma 已提交
4796 4797 4798 4799
	export interface ExtensionContext {

		/**
		 * An array to which disposables can be added. When this
J
Johannes Rieken 已提交
4800
		 * extension is deactivated the disposables will be disposed.
E
Erich Gamma 已提交
4801
		 */
4802
		readonly subscriptions: { dispose(): any }[];
E
Erich Gamma 已提交
4803 4804 4805

		/**
		 * A memento object that stores state in the context
4806
		 * of the currently opened [workspace](#workspace.workspaceFolders).
E
Erich Gamma 已提交
4807
		 */
4808
		readonly workspaceState: Memento;
E
Erich Gamma 已提交
4809 4810 4811

		/**
		 * A memento object that stores state independent
4812
		 * of the current opened [workspace](#workspace.workspaceFolders).
E
Erich Gamma 已提交
4813
		 */
4814
		readonly globalState: Memento;
E
Erich Gamma 已提交
4815 4816

		/**
J
Johannes Rieken 已提交
4817
		 * The absolute file path of the directory containing the extension.
E
Erich Gamma 已提交
4818
		 */
4819
		readonly extensionPath: string;
E
Erich Gamma 已提交
4820 4821

		/**
A
Alex Dima 已提交
4822 4823 4824 4825
		 * 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 已提交
4826 4827
		 */
		asAbsolutePath(relativePath: string): string;
D
Dirk Baeumer 已提交
4828 4829

		/**
J
Johannes Rieken 已提交
4830 4831 4832
		 * 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 已提交
4833
		 *
4834 4835
		 * Use [`workspaceState`](#ExtensionContext.workspaceState) or
		 * [`globalState`](#ExtensionContext.globalState) to store key value data.
D
Dirk Baeumer 已提交
4836
		 */
4837
		readonly storagePath: string | undefined;
4838

S
Sandeep Somavarapu 已提交
4839
		/**
4840
		 * An absolute file path in which the extension can store global state.
S
Sandeep Somavarapu 已提交
4841 4842 4843 4844 4845
		 * 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.
		 */
4846
		readonly globalStoragePath: string;
S
Sandeep Somavarapu 已提交
4847

4848 4849 4850 4851 4852
		/**
		 * 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.
		 */
4853
		readonly logPath: string;
E
Erich Gamma 已提交
4854 4855 4856 4857 4858 4859 4860 4861
	}

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

4862 4863 4864 4865 4866 4867 4868 4869
		/**
		 * Return a value.
		 *
		 * @param key A string.
		 * @return The stored value or `undefined`.
		 */
		get<T>(key: string): T | undefined;

E
Erich Gamma 已提交
4870
		/**
J
Johannes Rieken 已提交
4871 4872 4873 4874 4875
		 * 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.
4876
		 * @return The stored value or the defaultValue.
E
Erich Gamma 已提交
4877
		 */
4878
		get<T>(key: string, defaultValue: T): T;
E
Erich Gamma 已提交
4879 4880

		/**
S
Steven Clarke 已提交
4881
		 * Store a value. The value must be JSON-stringifyable.
J
Johannes Rieken 已提交
4882 4883 4884
		 *
		 * @param key A string.
		 * @param value A value. MUST not contain cyclic references.
E
Erich Gamma 已提交
4885 4886 4887 4888
		 */
		update(key: string, value: any): Thenable<void>;
	}

4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958
	/**
	 * 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;
4959 4960 4961 4962

		/**
		 * Controls whether to show the "Terminal will be reused by tasks, press any key to close it" message.
		 */
D
Dirk Baeumer 已提交
4963
		showReuseMessage?: boolean;
A
Alex Ross 已提交
4964 4965 4966 4967 4968

		/**
		 * Controls whether the terminal is cleared before executing the task.
		 */
		clear?: boolean;
4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979
	}

	/**
	 * 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 已提交
4980
		static Clean: TaskGroup;
4981 4982 4983 4984

		/**
		 * The build task group;
		 */
J
Johannes Rieken 已提交
4985
		static Build: TaskGroup;
4986 4987 4988 4989

		/**
		 * The rebuild all task group;
		 */
J
Johannes Rieken 已提交
4990
		static Rebuild: TaskGroup;
4991 4992 4993 4994

		/**
		 * The test all task group;
		 */
J
Johannes Rieken 已提交
4995
		static Test: TaskGroup;
4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006

		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 {
		/**
5007
		 * The task definition describing the task provided by an extension.
5008 5009 5010 5011 5012 5013 5014 5015 5016
		 * 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;
		 * }
		 * ```
5017 5018 5019
		 *
		 * Note that type identifier starting with a '$' are reserved for internal
		 * usages and shouldn't be used by extensions.
5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047
		 */
		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 };
	}

	/**
5048
	 * The execution of a task happens as an external process
5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086
	 * 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;
	}

5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118
	/**
	 * 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;
	}

5119 5120 5121 5122 5123 5124 5125 5126 5127 5128
	/**
	 * Options for a shell execution
	 */
	export interface ShellExecutionOptions {
		/**
		 * The shell executable.
		 */
		executable?: string;

		/**
D
Dirk Baeumer 已提交
5129 5130 5131 5132
		 * 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`.
5133 5134 5135
		 */
		shellArgs?: string[];

5136 5137 5138 5139 5140
		/**
		 * The shell quotes supported by this shell.
		 */
		shellQuoting?: ShellQuotingOptions;

5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154
		/**
		 * 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 };
	}

5155 5156
	/**
	 * Defines how an argument should be quoted if it contains
5157
	 * spaces or unsupported characters.
5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199
	 */
	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;
	}
5200 5201 5202

	export class ShellExecution {
		/**
5203
		 * Creates a shell execution with a full command line.
5204 5205 5206 5207 5208 5209 5210
		 *
		 * @param commandLine The command line to execute.
		 * @param options Optional options for the started the shell.
		 */
		constructor(commandLine: string, options?: ShellExecutionOptions);

		/**
5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223
		 * 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.
5224
		 */
5225
		commandLine: string | undefined;
5226

5227 5228 5229 5230 5231 5232 5233 5234 5235 5236
		/**
		 * 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)[];

5237 5238 5239 5240 5241 5242 5243
		/**
		 * The shell options used when the command line is executed in a shell.
		 * Defaults to undefined.
		 */
		options?: ShellExecutionOptions;
	}

A
Alex Ross 已提交
5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259
	/**
	 * 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 已提交
5260 5261 5262 5263 5264
	/**
	 * The scope of a task.
	 */
	export enum TaskScope {
		/**
5265
		 * The task is a global task. Global tasks are currrently not supported.
D
Dirk Baeumer 已提交
5266 5267 5268 5269 5270 5271 5272 5273 5274
		 */
		Global = 1,

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

5275 5276 5277 5278 5279 5280 5281 5282 5283 5284
	/**
	 * Run options for a task.
	 */
	export interface RunOptions {
		/**
		 * Controls whether task variables are re-evaluated on rerun.
		 */
		reevaluateOnRerun?: boolean;
	}

5285 5286 5287 5288 5289 5290
	/**
	 * A task to execute
	 */
	export class Task {

		/**
5291
		 * Creates a new task.
D
Dirk Baeumer 已提交
5292
		 *
5293
		 * @param definition The task definition as defined in the taskDefinitions extension point.
5294
		 * @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 已提交
5295
		 * @param name The task's name. Is presented in the user interface.
5296 5297 5298 5299 5300 5301
		 * @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 已提交
5302
		constructor(taskDefinition: TaskDefinition, scope: WorkspaceFolder | TaskScope.Global | TaskScope.Workspace, name: string, source: string, execution?: ProcessExecution | ShellExecution | CustomExecution, problemMatchers?: string | string[]);
5303

D
Dirk Baeumer 已提交
5304
		/**
5305 5306
		 * ~~Creates a new task.~~
		 *
5307
		 * @deprecated Use the new constructors that allow specifying a scope for the task.
D
Dirk Baeumer 已提交
5308 5309 5310 5311 5312 5313 5314 5315 5316
		 *
		 * @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.
		 */
5317
		constructor(taskDefinition: TaskDefinition, name: string, source: string, execution?: ProcessExecution | ShellExecution, problemMatchers?: string | string[]);
D
Dirk Baeumer 已提交
5318

5319 5320 5321 5322 5323
		/**
		 * The task's definition.
		 */
		definition: TaskDefinition;

D
Dirk Baeumer 已提交
5324
		/**
D
Dirk Baeumer 已提交
5325
		 * The task's scope.
D
Dirk Baeumer 已提交
5326
		 */
5327
		readonly scope?: TaskScope.Global | TaskScope.Workspace | WorkspaceFolder;
D
Dirk Baeumer 已提交
5328

5329 5330 5331 5332 5333 5334 5335 5336
		/**
		 * The task's name
		 */
		name: string;

		/**
		 * The task's execution engine
		 */
A
Alex Ross 已提交
5337
		execution?: ProcessExecution | ShellExecution | CustomExecution;
5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367

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

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

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

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

		/**
		 * The problem matchers attached to the task. Defaults to an empty
		 * array.
		 */
		problemMatchers: string[];
5368 5369 5370 5371 5372

		/**
		 * Run options for the task
		 */
		runOptions: RunOptions;
5373 5374 5375 5376
	}

	/**
	 * A task provider allows to add tasks to the task service.
D
Dirk Baeumer 已提交
5377
	 * A task provider is registered via #tasks.registerTaskProvider.
5378 5379 5380 5381 5382 5383 5384 5385 5386 5387
	 */
	export interface TaskProvider {
		/**
		 * Provides tasks.
		 * @param token A cancellation token.
		 * @return an array of tasks
		 */
		provideTasks(token?: CancellationToken): ProviderResult<Task[]>;

		/**
5388
		 * Resolves a task that has no [`execution`](#Task.execution) set. Tasks are
D
Dirk Baeumer 已提交
5389
		 * often created from information found in the `tasks.json`-file. Such tasks miss
5390
		 * the information on how to execute them and a task provider must fill in
D
Dirk Baeumer 已提交
5391 5392 5393 5394
		 * 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`.
5395
		 *
5396 5397
		 * @param task The task to resolve.
		 * @param token A cancellation token.
5398
		 * @return The resolved task
5399 5400 5401 5402
		 */
		resolveTask(task: Task, token?: CancellationToken): ProviderResult<Task>;
	}

D
Dirk Baeumer 已提交
5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429
	/**
	 * 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.
		 */
5430
		readonly execution: TaskExecution;
D
Dirk Baeumer 已提交
5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441
	}

	/**
	 * 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.
		 */
5442
		readonly execution: TaskExecution;
D
Dirk Baeumer 已提交
5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453
	}

	/**
	 * 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.
		 */
5454
		readonly execution: TaskExecution;
D
Dirk Baeumer 已提交
5455 5456 5457 5458

		/**
		 * The underlying process id.
		 */
5459
		readonly processId: number;
D
Dirk Baeumer 已提交
5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470
	}

	/**
	 * 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.
		 */
5471
		readonly execution: TaskExecution;
D
Dirk Baeumer 已提交
5472 5473 5474 5475

		/**
		 * The process's exit code.
		 */
5476
		readonly exitCode: number;
D
Dirk Baeumer 已提交
5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510
	}

	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 已提交
5511
		 * @param filter Optional filter to select tasks of a certain type or version.
D
Dirk Baeumer 已提交
5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525
		 */
		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.
		 */
5526
		export const taskExecutions: ReadonlyArray<TaskExecution>;
D
Dirk Baeumer 已提交
5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552

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

5553
	/**
5554 5555 5556
	 * Enumeration of file types. The types `File` and `Directory` can also be
	 * a symbolic links, in that use `FileType.File | FileType.SymbolicLink` and
	 * `FileType.Directory | FileType.SymbolicLink`.
5557
	 */
5558 5559 5560 5561 5562
	export enum FileType {
		/**
		 * The file type is unknown.
		 */
		Unknown = 0,
5563
		/**
5564
		 * A regular file.
5565
		 */
5566 5567 5568 5569 5570 5571 5572 5573 5574 5575
		File = 1,
		/**
		 * A directory.
		 */
		Directory = 2,
		/**
		 * A symbolic link to a file.
		 */
		SymbolicLink = 64
	}
5576

5577
	/**
5578
	 * The `FileStat`-type represents metadata about a file
5579 5580
	 */
	export interface FileStat {
5581
		/**
5582 5583
		 * The type of the file, e.g. is a regular file, a directory, or symbolic link
		 * to a file.
5584
		 */
5585
		type: FileType;
5586
		/**
5587
		 * The creation timestamp in milliseconds elapsed since January 1, 1970 00:00:00 UTC.
5588
		 */
5589
		ctime: number;
5590
		/**
5591
		 * The modification timestamp in milliseconds elapsed since January 1, 1970 00:00:00 UTC.
5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602
		 */
		mtime: number;
		/**
		 * The size in bytes.
		 */
		size: number;
	}

	/**
	 * A type that filesystem providers should use to signal errors.
	 *
D
David Linskey 已提交
5603 5604
	 * 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);`
5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632
	 */
	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;

5633 5634 5635 5636 5637 5638
		/**
		 * Create an error to signal that an operation lacks required permissions.
		 * @param messageOrUri Message or uri.
		 */
		static NoPermissions(messageOrUri?: string | Uri): FileSystemError;

5639 5640 5641 5642 5643 5644 5645
		/**
		 * 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;

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 5678 5679 5680 5681 5682
		/**
		 * Creates a new filesystem error.
		 *
		 * @param messageOrUri Message or uri.
		 */
		constructor(messageOrUri?: string | Uri);
	}

	/**
	 * 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.
		 */
5683
		readonly type: FileChangeType;
5684 5685 5686 5687

		/**
		 * The uri of the file that has changed.
		 */
5688
		readonly uri: Uri;
5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699
	}

	/**
	 * 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 已提交
5700 5701
	 * * *Note 3:* The word 'file' is often used to denote all [kinds](#FileType) of files, e.g.
	 * folders, symbolic links, and regular files.
5702 5703 5704 5705 5706
	 */
	export interface FileSystemProvider {

		/**
		 * An event to signal that a resource has been created, changed, or deleted. This
5707
		 * event should fire for resources that are being [watched](#FileSystemProvider.watch)
5708 5709
		 * by clients of this provider.
		 */
5710
		readonly onDidChangeFile: Event<FileChangeEvent[]>;
5711 5712 5713

		/**
		 * Subscribe to events in the file or folder denoted by `uri`.
J
Johannes Rieken 已提交
5714 5715 5716 5717 5718
		 *
		 * 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`).
		 *
5719 5720
		 * @param uri The uri of the file to be watched.
		 * @param options Configures the watch.
J
Johannes Rieken 已提交
5721
		 * @returns A disposable that tells the provider to stop watching the `uri`.
5722
		 */
5723
		watch(uri: Uri, options: { recursive: boolean; excludes: string[] }): Disposable;
5724 5725

		/**
5726
		 * Retrieve metadata about a file.
5727
		 *
5728 5729 5730 5731
		 * 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 已提交
5732
		 * @param uri The uri of the file to retrieve metadata about.
5733
		 * @return The file metadata about the file.
5734
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `uri` doesn't exist.
5735
		 */
5736
		stat(uri: Uri): FileStat | Thenable<FileStat>;
5737 5738

		/**
J
Johannes Rieken 已提交
5739
		 * Retrieve all entries of a [directory](#FileType.Directory).
5740 5741
		 *
		 * @param uri The uri of the folder.
5742 5743
		 * @return An array of name/type-tuples or a thenable that resolves to such.
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `uri` doesn't exist.
5744
		 */
5745
		readDirectory(uri: Uri): [string, FileType][] | Thenable<[string, FileType][]>;
5746 5747

		/**
J
Johannes Rieken 已提交
5748
		 * Create a new directory (Note, that new files are created via `write`-calls).
5749
		 *
5750
		 * @param uri The uri of the new folder.
J
Johannes Rieken 已提交
5751
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when the parent of `uri` doesn't exist, e.g. no mkdirp-logic required.
5752
		 * @throws [`FileExists`](#FileSystemError.FileExists) when `uri` already exists.
5753
		 * @throws [`NoPermissions`](#FileSystemError.NoPermissions) when permissions aren't sufficient.
5754
		 */
5755
		createDirectory(uri: Uri): void | Thenable<void>;
5756 5757 5758 5759 5760

		/**
		 * Read the entire contents of a file.
		 *
		 * @param uri The uri of the file.
5761 5762
		 * @return An array of bytes or a thenable that resolves to such.
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `uri` doesn't exist.
5763
		 */
5764
		readFile(uri: Uri): Uint8Array | Thenable<Uint8Array>;
5765 5766 5767 5768 5769 5770

		/**
		 * 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 已提交
5771
		 * @param options Defines if missing files should or must be created.
5772
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `uri` doesn't exist and `create` is not set.
J
Johannes Rieken 已提交
5773
		 * @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 已提交
5774
		 * @throws [`FileExists`](#FileSystemError.FileExists) when `uri` already exists, `create` is set but `overwrite` is not set.
5775
		 * @throws [`NoPermissions`](#FileSystemError.NoPermissions) when permissions aren't sufficient.
5776
		 */
5777
		writeFile(uri: Uri, content: Uint8Array, options: { create: boolean, overwrite: boolean }): void | Thenable<void>;
5778 5779

		/**
J
Johannes Rieken 已提交
5780
		 * Delete a file.
5781
		 *
5782 5783 5784
		 * @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.
5785
		 * @throws [`NoPermissions`](#FileSystemError.NoPermissions) when permissions aren't sufficient.
5786
		 */
5787
		delete(uri: Uri, options: { recursive: boolean }): void | Thenable<void>;
5788 5789 5790 5791

		/**
		 * Rename a file or folder.
		 *
J
Johannes Rieken 已提交
5792 5793
		 * @param oldUri The existing file.
		 * @param newUri The new location.
5794
		 * @param options Defines if existing files should be overwritten.
5795
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `oldUri` doesn't exist.
J
Johannes Rieken 已提交
5796
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when parent of `newUri` doesn't exist, e.g. no mkdirp-logic required.
5797
		 * @throws [`FileExists`](#FileSystemError.FileExists) when `newUri` exists and when the `overwrite` option is not `true`.
5798
		 * @throws [`NoPermissions`](#FileSystemError.NoPermissions) when permissions aren't sufficient.
5799
		 */
5800
		rename(oldUri: Uri, newUri: Uri, options: { overwrite: boolean }): void | Thenable<void>;
5801 5802 5803 5804 5805

		/**
		 * Copy files or folders. Implementing this function is optional but it will speedup
		 * the copy operation.
		 *
J
Johannes Rieken 已提交
5806
		 * @param source The existing file.
J
Johannes Rieken 已提交
5807
		 * @param destination The destination location.
5808
		 * @param options Defines if existing files should be overwritten.
J
Johannes Rieken 已提交
5809 5810
		 * @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.
5811
		 * @throws [`FileExists`](#FileSystemError.FileExists) when `destination` exists and when the `overwrite` option is not `true`.
5812
		 * @throws [`NoPermissions`](#FileSystemError.NoPermissions) when permissions aren't sufficient.
5813
		 */
5814
		copy?(source: Uri, destination: Uri, options: { overwrite: boolean }): void | Thenable<void>;
5815 5816
	}

5817 5818 5819 5820 5821 5822
	/**
	 * 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.
	 *
J
Johannes Rieken 已提交
5823
	 * *Note* that an instance of this interface is avaiable as [`workspace.fs`](#workspace.fs).
5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883
	 */
	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).
		 *
		 * @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 已提交
5884
		 * Copy files or folders.
5885 5886 5887 5888 5889 5890 5891 5892
		 *
		 * @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>;
	}

5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907
	/**
	 * 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;
	}

5908 5909 5910 5911 5912
	/**
	 * Content settings for a webview.
	 */
	export interface WebviewOptions {
		/**
M
Matt Bierner 已提交
5913
		 * Controls whether scripts are enabled in the webview content or not.
5914 5915 5916 5917 5918 5919
		 *
		 * Defaults to false (scripts-disabled).
		 */
		readonly enableScripts?: boolean;

		/**
M
Matt Bierner 已提交
5920
		 * Controls whether command uris are enabled in webview content or not.
5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933
		 *
		 * 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>;
5934 5935 5936 5937 5938 5939 5940 5941

		/**
		 * 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.
		 *
5942
		 * If a webview accesses localhost content, we recommend that you specify port mappings even if
5943
		 * the `webviewPort` and `extensionHostPort` ports are the same.
5944 5945 5946
		 *
		 * *Note* that port mappings only work for `http` or `https` urls. Websocket urls (e.g. `ws://localhost:3000`)
		 * cannot be mapped to another port.
5947 5948
		 */
		readonly portMapping?: ReadonlyArray<WebviewPortMapping>;
5949 5950 5951 5952 5953 5954 5955 5956 5957
	}

	/**
	 * A webview displays html content, like an iframe.
	 */
	export interface Webview {
		/**
		 * Content settings for the webview.
		 */
5958
		options: WebviewOptions;
5959 5960 5961 5962 5963 5964 5965 5966 5967 5968

		/**
		 * Contents of the webview.
		 *
		 * Should be a complete html document.
		 */
		html: string;

		/**
		 * Fired when the webview content posts a message.
5969 5970 5971 5972
		 *
		 * 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.
5973 5974 5975 5976 5977 5978
		 */
		readonly onDidReceiveMessage: Event<any>;

		/**
		 * Post a message to the webview content.
		 *
5979 5980
		 * Messages are only delivered if the webview is live (either visible or in the
		 * background with `retainContextWhenHidden`).
5981
		 *
5982
		 * @param message Body of the message. This must be a string or other json serilizable object.
5983 5984
		 */
		postMessage(message: any): Thenable<boolean>;
M
Matt Bierner 已提交
5985 5986 5987 5988

		/**
		 * Convert a uri for the local file system to one that can be used inside webviews.
		 *
M
Spell  
Matt Bierner 已提交
5989
		 * Webviews cannot directly load resources from the workspace or local file system using `file:` uris. The
M
Matt Bierner 已提交
5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008
		 * `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;
6009 6010 6011 6012 6013 6014 6015
	}

	/**
	 * Content settings for a webview panel.
	 */
	export interface WebviewPanelOptions {
		/**
M
Matt Bierner 已提交
6016
		 * Controls if the find widget is enabled in the panel.
6017 6018 6019 6020 6021 6022
		 *
		 * Defaults to false.
		 */
		readonly enableFindWidget?: boolean;

		/**
M
Matt Bierner 已提交
6023 6024
		 * Controls if the webview panel's content (iframe) is kept around even when the panel
		 * is no longer visible.
6025 6026
		 *
		 * Normally the webview panel's html context is created when the panel becomes visible
N
Nick Schonning 已提交
6027
		 * and destroyed when it is hidden. Extensions that have complex state
6028
		 * or UI can set the `retainContextWhenHidden` to make VS Code keep the webview
6029 6030 6031 6032 6033
		 * 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.
6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045
		 *
		 * `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 已提交
6046
		 * Identifies the type of the webview panel, such as `'markdown.preview'`.
6047 6048 6049 6050 6051 6052 6053 6054
		 */
		readonly viewType: string;

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

6055 6056 6057 6058 6059
		/**
		 * Icon for the panel shown in UI.
		 */
		iconPath?: Uri | { light: Uri; dark: Uri };

6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071
		/**
		 * Webview belonging to the panel.
		 */
		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
6072
		 * one of the editor view columns.
6073 6074 6075
		 */
		readonly viewColumn?: ViewColumn;

M
Matt Bierner 已提交
6076
		/**
6077
		 * Whether the panel is active (focused by the user).
M
Matt Bierner 已提交
6078 6079 6080
		 */
		readonly active: boolean;

6081
		/**
6082
		 * Whether the panel is visible.
6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105
		 */
		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.
6106 6107
		 *
		 * @param viewColumn View column to show the panel in. Shows in the current `viewColumn` if undefined.
6108
		 * @param preserveFocus When `true`, the webview will not take focus.
6109
		 */
6110
		reveal(viewColumn?: ViewColumn, preserveFocus?: boolean): void;
6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131

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

6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157
	/**
	 * 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 已提交
6158 6159
	 * 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
6160 6161 6162 6163 6164
	 * 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 {
		/**
6165
		 * Restore a webview panel from its serialized `state`.
6166 6167 6168
		 *
		 * Called when a serialized webview first becomes visible.
		 *
M
Matt Bierner 已提交
6169 6170 6171
		 * @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.
6172
		 *
S
Simon Siefke 已提交
6173
		 * @return Thenable indicating that the webview has been fully restored.
6174 6175 6176 6177
		 */
		deserializeWebviewPanel(webviewPanel: WebviewPanel, state: any): Thenable<void>;
	}

J
Johannes Rieken 已提交
6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195
	/**
	 * 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>;
	}

6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211
	/**
	 * 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
	}

6212 6213 6214 6215 6216
	/**
	 * Namespace describing the environment the editor runs in.
	 */
	export namespace env {

6217 6218 6219
		/**
		 * The application name of the editor, like 'VS Code'.
		 */
6220
		export const appName: string;
6221

J
Johannes Rieken 已提交
6222 6223 6224
		/**
		 * The application root folder from which the editor is running.
		 */
6225
		export const appRoot: string;
J
Johannes Rieken 已提交
6226

P
Peng Lyu 已提交
6227 6228 6229 6230 6231
		/**
		 * The custom uri scheme the editor registers to in the operating system.
		 */
		export const uriScheme: string;

J
Johannes Rieken 已提交
6232 6233 6234
		/**
		 * Represents the preferred user-language, like `de-CH`, `fr`, or `en-US`.
		 */
6235
		export const language: string;
J
Johannes Rieken 已提交
6236

J
Johannes Rieken 已提交
6237 6238 6239 6240 6241
		/**
		 * The system clipboard.
		 */
		export const clipboard: Clipboard;

6242 6243 6244
		/**
		 * A unique identifier for the computer.
		 */
6245
		export const machineId: string;
6246 6247 6248 6249 6250

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

J
Johannes Rieken 已提交
6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263
		/**
		 * 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 已提交
6264 6265 6266 6267 6268 6269
		/**
		 * 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;

6270 6271 6272 6273 6274 6275 6276
		/**
		 * 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;

6277
		/**
B
Benjamin Pasero 已提交
6278 6279 6280 6281 6282
		 * 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`)
6283 6284 6285 6286 6287 6288 6289
		 *
		 * *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 已提交
6290
		export function openExternal(target: Uri): Thenable<boolean>;
M
Matt Bierner 已提交
6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306

		/**
		 * 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.
		 *
		 * This is a no-op if the extension is running on the client machine. Currently only supports
		 * `https:` and `http:` uris.
		 *
		 * 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.
		 *
		 * 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 forwardng tunnel
		 * that was opened by `asExternalUri`.
		 *
B
Benjamin Pasero 已提交
6307
		 * *Note* that uris passed through `openExternal` are automatically resolved and you should not call `asExternalUri`
M
Matt Bierner 已提交
6308 6309 6310 6311 6312
		 * on them.
		 *
		 * @return A uri that can be used on the client machine.
		 */
		export function asExternalUri(target: Uri): Thenable<Uri>;
6313 6314
	}

E
Erich Gamma 已提交
6315
	/**
6316 6317 6318 6319 6320 6321 6322 6323
	 * 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 已提交
6324
	 * the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette).
6325
	 * * keybinding - Use the `keybindings`-section in `package.json` to enable
G
Greg Van Liew 已提交
6326
	 * [keybindings](https://code.visualstudio.com/docs/getstarted/keybindings#_customizing-shortcuts)
6327 6328
	 * for your extension.
	 *
S
Steven Clarke 已提交
6329
	 * Commands from other extensions and from the editor itself are accessible to an extension. However,
6330 6331 6332
	 * 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 已提交
6333
	 * register a command handler with the identifier `extension.sayHello`.
6334 6335
	 * ```javascript
	 * commands.registerCommand('extension.sayHello', () => {
6336
	 * 	window.showInformationMessage('Hello World!');
6337 6338
	 * });
	 * ```
G
Gama11 已提交
6339
	 * Second, bind the command identifier to a title under which it will show in the palette (`package.json`).
6340 6341
	 * ```json
	 * {
6342 6343 6344 6345 6346 6347
	 * 	"contributes": {
	 * 		"commands": [{
	 * 			"command": "extension.sayHello",
	 * 			"title": "Hello World"
	 * 		}]
	 * 	}
6348 6349
	 * }
	 * ```
E
Erich Gamma 已提交
6350 6351 6352 6353 6354
	 */
	export namespace commands {

		/**
		 * Registers a command that can be invoked via a keyboard shortcut,
S
Steven Clarke 已提交
6355
		 * a menu item, an action, or directly.
E
Erich Gamma 已提交
6356
		 *
J
Johannes Rieken 已提交
6357 6358 6359 6360 6361
		 * 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 已提交
6362
		 * @param thisArg The `this` context used when invoking the handler function.
J
Johannes Rieken 已提交
6363
		 * @return Disposable which unregisters this command on disposal.
E
Erich Gamma 已提交
6364 6365 6366 6367
		 */
		export function registerCommand(command: string, callback: (...args: any[]) => any, thisArg?: any): Disposable;

		/**
J
Johannes Rieken 已提交
6368
		 * Registers a text editor command that can be invoked via a keyboard shortcut,
S
Steven Clarke 已提交
6369
		 * a menu item, an action, or directly.
E
Erich Gamma 已提交
6370
		 *
J
Johannes Rieken 已提交
6371
		 * Text editor commands are different from ordinary [commands](#commands.registerCommand) as
S
Steven Clarke 已提交
6372
		 * they only execute when there is an active editor when the command is called. Also, the
J
Johannes Rieken 已提交
6373 6374 6375 6376 6377
		 * 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 已提交
6378
		 * @param thisArg The `this` context used when invoking the handler function.
J
Johannes Rieken 已提交
6379
		 * @return Disposable which unregisters this command on disposal.
E
Erich Gamma 已提交
6380
		 */
J
Johannes Rieken 已提交
6381
		export function registerTextEditorCommand(command: string, callback: (textEditor: TextEditor, edit: TextEditorEdit, ...args: any[]) => void, thisArg?: any): Disposable;
E
Erich Gamma 已提交
6382 6383

		/**
J
Johannes Rieken 已提交
6384 6385
		 * Executes the command denoted by the given command identifier.
		 *
J
Johannes Rieken 已提交
6386
		 * * *Note 1:* When executing an editor command not all types are allowed to
6387
		 * be passed as arguments. Allowed are the primitive types `string`, `boolean`,
J
Johannes Rieken 已提交
6388 6389
		 * `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 已提交
6390
		 * by extensions.
E
Erich Gamma 已提交
6391
		 *
J
Johannes Rieken 已提交
6392
		 * @param command Identifier of the command to execute.
J
Johannes Rieken 已提交
6393 6394 6395
		 * @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 已提交
6396
		 */
6397
		export function executeCommand<T>(command: string, ...rest: any[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
6398 6399

		/**
P
Per Persson 已提交
6400
		 * Retrieve the list of all available commands. Commands starting with an underscore are
6401
		 * treated as internal commands.
E
Erich Gamma 已提交
6402
		 *
6403
		 * @param filterInternal Set `true` to not see internal commands (starting with an underscore)
E
Erich Gamma 已提交
6404 6405
		 * @return Thenable that resolves to a list of command ids.
		 */
6406
		export function getCommands(filterInternal?: boolean): Thenable<string[]>;
E
Erich Gamma 已提交
6407 6408
	}

J
Joao 已提交
6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419
	/**
	 * Represents the state of a window.
	 */
	export interface WindowState {

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

J
Joao Moreno 已提交
6420
	/**
J
Joao Moreno 已提交
6421
	 * A uri handler is responsible for handling system-wide [uris](#Uri).
J
Joao Moreno 已提交
6422 6423 6424 6425 6426 6427
	 *
	 * @see [window.registerUriHandler](#window.registerUriHandler).
	 */
	export interface UriHandler {

		/**
J
Joao Moreno 已提交
6428
		 * Handle the provided system-wide [uri](#Uri).
J
Joao Moreno 已提交
6429 6430 6431 6432 6433 6434
		 *
		 * @see [window.registerUriHandler](#window.registerUriHandler).
		 */
		handleUri(uri: Uri): ProviderResult<void>;
	}

E
Erich Gamma 已提交
6435
	/**
6436 6437 6438
	 * 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 已提交
6439 6440 6441 6442
	 */
	export namespace window {

		/**
6443
		 * The currently active editor or `undefined`. The active editor is the one
S
Steven Clarke 已提交
6444
		 * that currently has focus or, when none has focus, the one that has changed
E
Erich Gamma 已提交
6445 6446
		 * input most recently.
		 */
6447
		export let activeTextEditor: TextEditor | undefined;
E
Erich Gamma 已提交
6448 6449

		/**
6450
		 * The currently visible editors or an empty array.
E
Erich Gamma 已提交
6451 6452 6453 6454
		 */
		export let visibleTextEditors: TextEditor[];

		/**
6455
		 * An [event](#Event) which fires when the [active editor](#window.activeTextEditor)
J
Johannes Rieken 已提交
6456
		 * has changed. *Note* that the event also fires when the active editor changes
6457
		 * to `undefined`.
E
Erich Gamma 已提交
6458
		 */
6459
		export const onDidChangeActiveTextEditor: Event<TextEditor | undefined>;
E
Erich Gamma 已提交
6460

6461 6462 6463 6464
		/**
		 * An [event](#Event) which fires when the array of [visible editors](#window.visibleTextEditors)
		 * has changed.
		 */
6465
		export const onDidChangeVisibleTextEditors: Event<TextEditor[]>;
6466

E
Erich Gamma 已提交
6467
		/**
A
Andre Weinand 已提交
6468
		 * An [event](#Event) which fires when the selection in an editor has changed.
E
Erich Gamma 已提交
6469 6470 6471
		 */
		export const onDidChangeTextEditorSelection: Event<TextEditorSelectionChangeEvent>;

6472
		/**
6473
		 * An [event](#Event) which fires when the visible ranges of an editor has changed.
6474 6475 6476
		 */
		export const onDidChangeTextEditorVisibleRanges: Event<TextEditorVisibleRangesChangeEvent>;

E
Erich Gamma 已提交
6477 6478 6479 6480 6481
		/**
		 * An [event](#Event) which fires when the options of an editor have changed.
		 */
		export const onDidChangeTextEditorOptions: Event<TextEditorOptionsChangeEvent>;

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

D
Daniel Imms 已提交
6487 6488 6489 6490 6491
		/**
		 * The currently opened terminals or an empty array.
		 */
		export const terminals: ReadonlyArray<Terminal>;

D
Daniel Imms 已提交
6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504
		/**
		 * 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 已提交
6505 6506 6507 6508 6509 6510
		/**
		 * 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>;

6511
		/**
6512
		 * An [event](#Event) which fires when a terminal is disposed.
6513 6514 6515
		 */
		export const onDidCloseTerminal: Event<Terminal>;

J
Joao 已提交
6516 6517 6518
		/**
		 * Represents the current window's state.
		 */
6519
		export const state: WindowState;
J
Joao 已提交
6520 6521 6522 6523 6524 6525 6526

		/**
		 * 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 已提交
6527 6528 6529 6530 6531
		/**
		 * 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 已提交
6532
		 * @param column A view column in which the [editor](#TextEditor) should be shown. The default is the [active](#ViewColumn.Active), other values
6533 6534
		 * 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.
6535
		 * @param preserveFocus When `true` the editor will not take focus.
E
Erich Gamma 已提交
6536 6537
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
6538
		export function showTextDocument(document: TextDocument, column?: ViewColumn, preserveFocus?: boolean): Thenable<TextEditor>;
E
Erich Gamma 已提交
6539

6540
		/**
B
Benjamin Pasero 已提交
6541 6542
		 * 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).
6543 6544
		 *
		 * @param document A text document to be shown.
B
Benjamin Pasero 已提交
6545
		 * @param options [Editor options](#TextDocumentShowOptions) to configure the behavior of showing the [editor](#TextEditor).
6546 6547
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
6548
		export function showTextDocument(document: TextDocument, options?: TextDocumentShowOptions): Thenable<TextEditor>;
6549

B
Benjamin Pasero 已提交
6550
		/**
J
Johannes Rieken 已提交
6551
		 * A short-hand for `openTextDocument(uri).then(document => showTextDocument(document, options))`.
B
Benjamin Pasero 已提交
6552
		 *
J
Johannes Rieken 已提交
6553
		 * @see [openTextDocument](#openTextDocument)
B
Benjamin Pasero 已提交
6554 6555
		 *
		 * @param uri A resource identifier.
B
Benjamin Pasero 已提交
6556
		 * @param options [Editor options](#TextDocumentShowOptions) to configure the behavior of showing the [editor](#TextEditor).
B
Benjamin Pasero 已提交
6557 6558 6559 6560
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
		export function showTextDocument(uri: Uri, options?: TextDocumentShowOptions): Thenable<TextEditor>;

E
Erich Gamma 已提交
6561
		/**
J
Johannes Rieken 已提交
6562 6563 6564 6565
		 * 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 已提交
6566 6567 6568 6569 6570 6571 6572
		 */
		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 已提交
6573 6574
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
6575
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
6576
		 */
6577
		export function showInformationMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
6578

J
Joao Moreno 已提交
6579 6580 6581 6582 6583 6584 6585 6586 6587
		/**
		 * 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 已提交
6588
		export function showInformationMessage(message: string, options: MessageOptions, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
6589 6590

		/**
J
Johannes Rieken 已提交
6591
		 * Show an information message.
J
Johannes Rieken 已提交
6592
		 *
E
Erich Gamma 已提交
6593
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
6594 6595 6596
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
6597
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
6598
		 */
6599
		export function showInformationMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
6600

J
Joao Moreno 已提交
6601 6602 6603 6604 6605 6606 6607 6608 6609 6610
		/**
		 * 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 已提交
6611
		export function showInformationMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
6612 6613

		/**
J
Johannes Rieken 已提交
6614
		 * Show a warning message.
J
Johannes Rieken 已提交
6615
		 *
E
Erich Gamma 已提交
6616
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
6617 6618 6619
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
6620
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
6621
		 */
6622
		export function showWarningMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
6623

J
Joao Moreno 已提交
6624 6625 6626 6627 6628 6629 6630 6631 6632 6633
		/**
		 * 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 已提交
6634
		export function showWarningMessage(message: string, options: MessageOptions, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
6635 6636

		/**
J
Johannes Rieken 已提交
6637
		 * Show a warning message.
J
Johannes Rieken 已提交
6638
		 *
E
Erich Gamma 已提交
6639
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
6640 6641 6642
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
6643
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
6644
		 */
6645
		export function showWarningMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
6646

J
Joao Moreno 已提交
6647 6648 6649 6650 6651 6652 6653 6654 6655 6656
		/**
		 * 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 已提交
6657
		export function showWarningMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
6658 6659

		/**
J
Johannes Rieken 已提交
6660
		 * Show an error message.
J
Johannes Rieken 已提交
6661
		 *
E
Erich Gamma 已提交
6662
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
6663 6664 6665
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
6666
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
6667
		 */
6668
		export function showErrorMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
6669

J
Joao Moreno 已提交
6670 6671 6672 6673 6674 6675 6676 6677 6678 6679
		/**
		 * 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 已提交
6680
		export function showErrorMessage(message: string, options: MessageOptions, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
6681 6682

		/**
J
Johannes Rieken 已提交
6683
		 * Show an error message.
J
Johannes Rieken 已提交
6684
		 *
E
Erich Gamma 已提交
6685
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
6686 6687 6688
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
6689
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
6690
		 */
6691
		export function showErrorMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
6692

J
Joao Moreno 已提交
6693 6694 6695 6696 6697 6698 6699 6700 6701 6702
		/**
		 * 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 已提交
6703
		export function showErrorMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
6704

C
Christof Marti 已提交
6705 6706 6707 6708 6709 6710 6711 6712
		/**
		 * 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`.
		 */
6713
		export function showQuickPick(items: string[] | Thenable<string[]>, options: QuickPickOptions & { canPickMany: true; }, token?: CancellationToken): Thenable<string[] | undefined>;
C
Christof Marti 已提交
6714

E
Erich Gamma 已提交
6715 6716 6717
		/**
		 * Shows a selection list.
		 *
J
Johannes Rieken 已提交
6718 6719
		 * @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.
6720
		 * @param token A token that can be used to signal cancellation.
C
Christof Marti 已提交
6721
		 * @return A promise that resolves to the selection or `undefined`.
E
Erich Gamma 已提交
6722
		 */
6723
		export function showQuickPick(items: string[] | Thenable<string[]>, options?: QuickPickOptions, token?: CancellationToken): Thenable<string | undefined>;
E
Erich Gamma 已提交
6724

C
Christof Marti 已提交
6725 6726 6727 6728 6729 6730 6731 6732
		/**
		 * 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`.
		 */
6733
		export function showQuickPick<T extends QuickPickItem>(items: T[] | Thenable<T[]>, options: QuickPickOptions & { canPickMany: true; }, token?: CancellationToken): Thenable<T[] | undefined>;
C
Christof Marti 已提交
6734

E
Erich Gamma 已提交
6735 6736 6737
		/**
		 * Shows a selection list.
		 *
J
Johannes Rieken 已提交
6738 6739
		 * @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.
6740
		 * @param token A token that can be used to signal cancellation.
C
Christof Marti 已提交
6741
		 * @return A promise that resolves to the selected item or `undefined`.
E
Erich Gamma 已提交
6742
		 */
6743
		export function showQuickPick<T extends QuickPickItem>(items: T[] | Thenable<T[]>, options?: QuickPickOptions, token?: CancellationToken): Thenable<T | undefined>;
E
Erich Gamma 已提交
6744

6745 6746 6747 6748 6749 6750 6751 6752 6753
		/**
		 * 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>;

6754
		/**
6755 6756
		 * Shows a file open dialog to the user which allows to select a file
		 * for opening-purposes.
6757 6758 6759 6760 6761 6762 6763
		 *
		 * @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>;

		/**
6764 6765
		 * Shows a file save dialog to the user which allows to select a file
		 * for saving-purposes.
6766 6767 6768 6769 6770 6771
		 *
		 * @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 已提交
6772 6773 6774
		/**
		 * Opens an input box to ask the user for input.
		 *
6775
		 * The returned value will be `undefined` if the input box was canceled (e.g. pressing ESC). Otherwise the
A
Andre Weinand 已提交
6776
		 * returned value will be the string typed by the user or an empty string if the user did not type
S
Steven Clarke 已提交
6777
		 * anything but dismissed the input box with OK.
E
Erich Gamma 已提交
6778
		 *
J
Johannes Rieken 已提交
6779
		 * @param options Configures the behavior of the input box.
6780
		 * @param token A token that can be used to signal cancellation.
J
Johannes Rieken 已提交
6781
		 * @return A promise that resolves to a string the user provided or to `undefined` in case of dismissal.
E
Erich Gamma 已提交
6782
		 */
6783
		export function showInputBox(options?: InputBoxOptions, token?: CancellationToken): Thenable<string | undefined>;
E
Erich Gamma 已提交
6784

C
Christof Marti 已提交
6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807
		/**
		 * 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 已提交
6808
		/**
6809 6810
		 * Creates a new [output channel](#OutputChannel) with the given name.
		 *
6811
		 * @param name Human-readable string which will be used to represent the channel in the UI.
E
Erich Gamma 已提交
6812
		 */
S
Sandeep Somavarapu 已提交
6813
		export function createOutputChannel(name: string): OutputChannel;
E
Erich Gamma 已提交
6814

6815 6816 6817 6818 6819
		/**
		 * Create and show a new webview panel.
		 *
		 * @param viewType Identifies the type of the webview panel.
		 * @param title Title of the panel.
6820
		 * @param showOptions Where to show the webview in the editor. If preserveFocus is set, the new webview will not take focus.
6821 6822 6823 6824
		 * @param options Settings for the new panel.
		 *
		 * @return New webview panel.
		 */
6825
		export function createWebviewPanel(viewType: string, title: string, showOptions: ViewColumn | { viewColumn: ViewColumn, preserveFocus?: boolean }, options?: WebviewPanelOptions & WebviewOptions): WebviewPanel;
6826

E
Erich Gamma 已提交
6827
		/**
S
Steven Clarke 已提交
6828
		 * Set a message to the status bar. This is a short hand for the more powerful
E
Erich Gamma 已提交
6829
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
6830
		 *
G
Gama11 已提交
6831
		 * @param text The message to show, supports icon substitution as in status bar [items](#StatusBarItem.text).
6832
		 * @param hideAfterTimeout Timeout in milliseconds after which the message will be disposed.
J
Johannes Rieken 已提交
6833
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
6834
		 */
6835
		export function setStatusBarMessage(text: string, hideAfterTimeout: number): Disposable;
E
Erich Gamma 已提交
6836 6837

		/**
S
Steven Clarke 已提交
6838
		 * Set a message to the status bar. This is a short hand for the more powerful
J
Johannes Rieken 已提交
6839
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
6840
		 *
G
Gama11 已提交
6841
		 * @param text The message to show, supports icon substitution as in status bar [items](#StatusBarItem.text).
6842
		 * @param hideWhenDone Thenable on which completion (resolve or reject) the message will be disposed.
J
Johannes Rieken 已提交
6843
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
6844
		 */
6845
		export function setStatusBarMessage(text: string, hideWhenDone: Thenable<any>): Disposable;
E
Erich Gamma 已提交
6846 6847

		/**
S
Steven Clarke 已提交
6848
		 * Set a message to the status bar. This is a short hand for the more powerful
J
Johannes Rieken 已提交
6849
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
6850
		 *
6851 6852 6853
		 * *Note* that status bar messages stack and that they must be disposed when no
		 * longer used.
		 *
G
Gama11 已提交
6854
		 * @param text The message to show, supports icon substitution as in status bar [items](#StatusBarItem.text).
J
Johannes Rieken 已提交
6855
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
6856
		 */
6857
		export function setStatusBarMessage(text: string): Disposable;
E
Erich Gamma 已提交
6858

6859
		/**
J
Johannes Rieken 已提交
6860 6861
		 * ~~Show progress in the Source Control viewlet while running the given callback and while
		 * its returned promise isn't resolve or rejected.~~
6862
		 *
6863 6864
		 * @deprecated Use `withProgress` instead.
		 *
6865 6866
		 * @param task A callback returning a promise. Progress increments can be reported with
		 * the provided [progress](#Progress)-object.
6867
		 * @return The thenable the task did return.
6868 6869 6870
		 */
		export function withScmProgress<R>(task: (progress: Progress<number>) => Thenable<R>): Thenable<R>;

J
Johannes Rieken 已提交
6871 6872 6873 6874 6875 6876 6877
		/**
		 * 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.
6878
		 *
6879 6880 6881 6882
		 * 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.
6883 6884 6885 6886 6887
		 *
		 * 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 已提交
6888 6889
		 * @return The thenable the task-callback returned.
		 */
6890
		export function withProgress<R>(options: ProgressOptions, task: (progress: Progress<{ message?: string; increment?: number }>, token: CancellationToken) => Thenable<R>): Thenable<R>;
6891

E
Erich Gamma 已提交
6892
		/**
J
Johannes Rieken 已提交
6893 6894
		 * Creates a status bar [item](#StatusBarItem).
		 *
J
Johannes Rieken 已提交
6895
		 * @param alignment The alignment of the item.
J
Johannes Rieken 已提交
6896
		 * @param priority The priority of the item. Higher values mean the item should be shown more to the left.
J
Johannes Rieken 已提交
6897 6898
		 * @return A new status bar item.
		 */
E
Erich Gamma 已提交
6899
		export function createStatusBarItem(alignment?: StatusBarAlignment, priority?: number): StatusBarItem;
D
Daniel Imms 已提交
6900

D
Daniel Imms 已提交
6901
		/**
D
Daniel Imms 已提交
6902 6903
		 * 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 已提交
6904
		 *
6905
		 * @param name Optional human-readable string which will be used to represent the terminal in the UI.
6906
		 * @param shellPath Optional path to a custom shell executable to be used in the terminal.
6907
		 * @param shellArgs Optional args for the custom shell executable. A string can be used on Windows only which
D
Daniel Imms 已提交
6908 6909
		 * allows specifying shell args in
		 * [command-line format](https://msdn.microsoft.com/en-au/08dfcab2-eb6e-49a4-80eb-87d4076c98c6).
D
Daniel Imms 已提交
6910 6911
		 * @return A new Terminal.
		 */
6912
		export function createTerminal(name?: string, shellPath?: string, shellArgs?: string[] | string): Terminal;
6913 6914

		/**
D
Daniel Imms 已提交
6915
		 * Creates a [Terminal](#Terminal) with a backing shell process.
6916 6917 6918 6919 6920
		 *
		 * @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 已提交
6921

6922 6923 6924 6925 6926 6927 6928 6929 6930
		/**
		 * 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;

S
Sandeep Somavarapu 已提交
6931 6932
		/**
		 * Register a [TreeDataProvider](#TreeDataProvider) for the view contributed using the extension point `views`.
6933
		 * This will allow you to contribute data to the [TreeView](#TreeView) and update if the data changes.
S
Sandeep Somavarapu 已提交
6934
		 *
S
Sandeep Somavarapu 已提交
6935
		 * **Note:** To get access to the [TreeView](#TreeView) and perform operations on it, use [createTreeView](#window.createTreeView).
6936
		 *
S
Sandeep Somavarapu 已提交
6937 6938 6939 6940
		 * @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;
6941 6942 6943 6944

		/**
		 * 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 已提交
6945
		 * @param options Options for creating the [TreeView](#TreeView)
6946 6947
		 * @returns a [TreeView](#TreeView).
		 */
S
Sandeep Somavarapu 已提交
6948
		export function createTreeView<T>(viewId: string, options: TreeViewOptions<T>): TreeView<T>;
J
Joao Moreno 已提交
6949 6950

		/**
J
Joao Moreno 已提交
6951 6952 6953 6954 6955
		 * 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 已提交
6956
		 *
6957
		 * - The uri-scheme must be `vscode.env.uriScheme`;
6958
		 * - The uri-authority must be the extension id (e.g. `my.extension`);
J
Joao Moreno 已提交
6959 6960
		 * - The uri-path, -query and -fragment parts are arbitrary.
		 *
J
Joao Moreno 已提交
6961 6962
		 * 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 已提交
6963
		 *
J
Joao Moreno 已提交
6964
		 * An extension can only register a single uri handler in its entire activation lifetime.
J
Joao Moreno 已提交
6965
		 *
J
Joao Moreno 已提交
6966
		 * * *Note:* There is an activation event `onUri` that fires when a uri directed for
J
Joao Moreno 已提交
6967 6968
		 * the current extension is about to be handled.
		 *
J
Joao Moreno 已提交
6969
		 * @param handler The uri handler to register for this extension.
J
Joao Moreno 已提交
6970 6971
		 */
		export function registerUriHandler(handler: UriHandler): Disposable;
6972

6973 6974 6975
		/**
		 * Registers a webview panel serializer.
		 *
J
Joao Moreno 已提交
6976 6977
		 * Extensions that support reviving should have an `"onWebviewPanel:viewType"` activation event and
		 * make sure that [registerWebviewPanelSerializer](#registerWebviewPanelSerializer) is called during activation.
6978
		 *
J
Joao Moreno 已提交
6979
		 * Only a single serializer may be registered at a time for a given `viewType`.
6980 6981 6982 6983 6984
		 *
		 * @param viewType Type of the webview panel that can be serialized.
		 * @param serializer Webview serializer.
		 */
		export function registerWebviewPanelSerializer(viewType: string, serializer: WebviewPanelSerializer): Disposable;
S
Sandeep Somavarapu 已提交
6985 6986
	}

S
Sandeep Somavarapu 已提交
6987
	/**
6988
	 * Options for creating a [TreeView](#TreeView)
S
Sandeep Somavarapu 已提交
6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000
	 */
	export interface TreeViewOptions<T> {

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

		/**
		 * Whether to show collapse all action or not.
		 */
		showCollapseAll?: boolean;
7001 7002 7003 7004

		/**
		 * 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
7005
		 * array containing all selected tree items.
7006 7007
		 */
		canSelectMany?: boolean;
S
Sandeep Somavarapu 已提交
7008 7009
	}

S
Sandeep Somavarapu 已提交
7010 7011 7012 7013 7014 7015 7016 7017
	/**
	 * 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.
		 */
7018
		readonly element: T;
S
Sandeep Somavarapu 已提交
7019 7020 7021

	}

S
Sandeep Somavarapu 已提交
7022
	/**
7023
	 * The event that is fired when there is a change in [tree view's selection](#TreeView.selection)
S
Sandeep Somavarapu 已提交
7024 7025 7026 7027 7028 7029
	 */
	export interface TreeViewSelectionChangeEvent<T> {

		/**
		 * Selected elements.
		 */
7030
		readonly selection: T[];
7031 7032 7033

	}

S
Add doc  
Sandeep Somavarapu 已提交
7034 7035 7036
	/**
	 * The event that is fired when there is a change in [tree view's visibility](#TreeView.visible)
	 */
7037 7038 7039 7040 7041
	export interface TreeViewVisibilityChangeEvent {

		/**
		 * `true` if the [tree view](#TreeView) is visible otherwise `false`.
		 */
7042
		readonly visible: boolean;
S
Sandeep Somavarapu 已提交
7043 7044 7045

	}

7046 7047 7048 7049 7050
	/**
	 * Represents a Tree view
	 */
	export interface TreeView<T> extends Disposable {

S
Sandeep Somavarapu 已提交
7051 7052 7053
		/**
		 * Event that is fired when an element is expanded
		 */
S
Sandeep Somavarapu 已提交
7054
		readonly onDidExpandElement: Event<TreeViewExpansionEvent<T>>;
S
Sandeep Somavarapu 已提交
7055 7056 7057 7058

		/**
		 * Event that is fired when an element is collapsed
		 */
S
Sandeep Somavarapu 已提交
7059
		readonly onDidCollapseElement: Event<TreeViewExpansionEvent<T>>;
S
Sandeep Somavarapu 已提交
7060

S
Sandeep Somavarapu 已提交
7061
		/**
7062 7063
		 * Currently selected elements.
		 */
7064
		readonly selection: T[];
7065 7066 7067

		/**
		 * Event that is fired when the [selection](#TreeView.selection) has changed
S
Sandeep Somavarapu 已提交
7068 7069 7070
		 */
		readonly onDidChangeSelection: Event<TreeViewSelectionChangeEvent<T>>;

S
Sandeep Somavarapu 已提交
7071
		/**
7072
		 * `true` if the [tree view](#TreeView) is visible otherwise `false`.
S
Sandeep Somavarapu 已提交
7073
		 */
7074
		readonly visible: boolean;
S
Sandeep Somavarapu 已提交
7075

7076
		/**
M
Matthew J. Clemente 已提交
7077
		 * Event that is fired when [visibility](#TreeView.visible) has changed
7078 7079 7080
		 */
		readonly onDidChangeVisibility: Event<TreeViewVisibilityChangeEvent>;

A
Alex Ross 已提交
7081 7082
		/**
		 * An optional human-readable message that will be rendered in the view.
A
Alex Ross 已提交
7083
		 * Setting the message to null, undefined, or empty string will remove the message from the view.
A
Alex Ross 已提交
7084 7085 7086
		 */
		message?: string;

7087 7088
		/**
		 * Reveals the given element in the tree view.
S
Sandeep Somavarapu 已提交
7089
		 * If the tree view is not visible then the tree view is shown and element is revealed.
7090
		 *
S
Sandeep Somavarapu 已提交
7091
		 * By default revealed element is selected.
7092
		 * In order to not to select, set the option `select` to `false`.
7093
		 * In order to focus, set the option `focus` to `true`.
7094 7095
		 * 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.
7096 7097 7098
		 *
		 * **NOTE:** [TreeDataProvider](#TreeDataProvider) is required to implement [getParent](#TreeDataProvider.getParent) method to access this API.
		 */
7099
		reveal(element: T, options?: { select?: boolean, focus?: boolean, expand?: boolean | number }): Thenable<void>;
S
Sandeep Somavarapu 已提交
7100 7101 7102 7103 7104 7105 7106 7107
	}

	/**
	 * 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 已提交
7108
		 * This will trigger the view to update the changed element/root and its children recursively (if shown).
S
Sandeep Somavarapu 已提交
7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127
		 * 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[]>;
7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138

		/**
		 * 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 已提交
7139 7140 7141 7142
	}

	export class TreeItem {
		/**
7143
		 * A human-readable string describing this item. When `falsy`, it is derived from [resourceUri](#TreeItem.resourceUri).
S
Sandeep Somavarapu 已提交
7144
		 */
7145
		label?: string;
S
Sandeep Somavarapu 已提交
7146

7147
		/**
7148
		 * 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.
7149
		 *
7150
		 * 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.
7151 7152 7153
		 */
		id?: string;

S
Sandeep Somavarapu 已提交
7154
		/**
7155
		 * The icon path or [ThemeIcon](#ThemeIcon) for the tree item.
S
Sandeep Somavarapu 已提交
7156 7157
		 * When `falsy`, [Folder Theme Icon](#ThemeIcon.Folder) is assigned, if item is collapsible otherwise [File Theme Icon](#ThemeIcon.File).
		 * When a [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 已提交
7158
		 */
7159
		iconPath?: string | Uri | { light: string | Uri; dark: string | Uri } | ThemeIcon;
S
Sandeep Somavarapu 已提交
7160

S
Sandeep Somavarapu 已提交
7161 7162 7163 7164 7165 7166
		/**
		 * A human readable string which is rendered less prominent.
		 * When `true`, it is derived from [resourceUri](#TreeItem.resourceUri) and when `falsy`, it is not shown.
		 */
		description?: string | boolean;

7167 7168
		/**
		 * The [uri](#Uri) of the resource representing this item.
S
Sandeep Somavarapu 已提交
7169 7170
		 *
		 * Will be used to derive the [label](#TreeItem.label), when it is not provided.
S
Sandeep Somavarapu 已提交
7171
		 * Will be used to derive the icon from current icon theme, when [iconPath](#TreeItem.iconPath) has [ThemeIcon](#ThemeIcon) value.
7172
		 */
7173
		resourceUri?: Uri;
7174

S
Sandeep Somavarapu 已提交
7175 7176 7177 7178 7179
		/**
		 * The tooltip text when you hover over this item.
		 */
		tooltip?: string | undefined;

S
Sandeep Somavarapu 已提交
7180
		/**
7181
		 * The [command](#Command) that should be executed when the tree item is selected.
S
Sandeep Somavarapu 已提交
7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214
		 */
		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);
7215 7216 7217 7218 7219 7220

		/**
		 * @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 已提交
7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238
	}

	/**
	 * 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
7239 7240 7241
	}

	/**
J
Johannes Rieken 已提交
7242
	 * Value-object describing what options a terminal should use.
7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255
	 */
	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;

		/**
7256 7257
		 * 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).
7258
		 */
7259
		shellArgs?: string[] | string;
7260 7261

		/**
K
kieferrm 已提交
7262
		 * A path or Uri for the current working directory to be used for the terminal.
7263
		 */
K
kieferrm 已提交
7264
		cwd?: string | Uri;
7265

7266 7267 7268
		/**
		 * Object with environment variables that will be added to the VS Code process.
		 */
C
Christof Marti 已提交
7269
		env?: { [key: string]: string | null };
7270 7271 7272 7273 7274

		/**
		 * 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 已提交
7275 7276
		 * `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.
7277 7278
		 */
		strictEnv?: boolean;
7279 7280 7281 7282 7283 7284 7285 7286

		/**
		 * 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.
		 */
7287
		hideFromUser?: boolean;
E
Erich Gamma 已提交
7288 7289
	}

7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364
	/**
	 * 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").
		 *
		 * **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>;

		/**
		 * An event that when fired allows overriding the [dimensions](#Terminal.dimensions) of the
		 * 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
7365
		 * `CustomExecution` API.
7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452
		 *
		 * **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;
	}

J
Johannes Rieken 已提交
7453 7454 7455 7456 7457 7458 7459
	/**
	 * 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 {

		/**
7460
		 * Show progress for the source control viewlet, as overlay for the icon and as progress bar
7461
		 * inside the viewlet (when visible). Neither supports cancellation nor discrete progress.
J
Johannes Rieken 已提交
7462
		 */
7463
		SourceControl = 1,
J
Johannes Rieken 已提交
7464 7465

		/**
7466
		 * Show progress in the status bar of the editor. Neither supports cancellation nor discrete progress.
J
Johannes Rieken 已提交
7467
		 */
7468 7469 7470
		Window = 10,

		/**
7471
		 * Show progress as notification with an optional cancel button. Supports to show infinite and discrete progress.
7472 7473
		 */
		Notification = 15
J
Johannes Rieken 已提交
7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490
	}

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

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

		/**
		 * A human-readable string which will be used to describe the
		 * operation.
		 */
		title?: string;
7491 7492 7493 7494 7495 7496 7497 7498

		/**
		 * 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 已提交
7499 7500
	}

C
Christof Marti 已提交
7501
	/**
7502
	 * A light-weight user input UI that is initially not visible. After
C
Christof Marti 已提交
7503 7504 7505 7506 7507
	 * 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).
7508
	 * (Examples include: an explicit call to [QuickInput.hide](#QuickInput.hide),
C
Christof Marti 已提交
7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576
	 * 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).
7577
		 * (Examples include: an explicit call to [QuickInput.hide](#QuickInput.hide),
C
Christof Marti 已提交
7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660
		 * 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.
		 */
7661
		readonly onDidChangeActive: Event<T[]>;
C
Christof Marti 已提交
7662 7663 7664 7665 7666 7667 7668 7669 7670

		/**
		 * Selected items. This can be read and updated by the extension.
		 */
		selectedItems: ReadonlyArray<T>;

		/**
		 * An event signaling when the selected items have changed.
		 */
7671
		readonly onDidChangeSelection: Event<T[]>;
C
Christof Marti 已提交
7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736
	}

	/**
	 * 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.
		 */
7737
		readonly iconPath: Uri | { light: Uri; dark: Uri } | ThemeIcon;
C
Christof Marti 已提交
7738 7739 7740 7741 7742 7743 7744 7745 7746 7747

		/**
		 * An optional tooltip.
		 */
		readonly tooltip?: string | undefined;
	}

	/**
	 * Predefined buttons for [QuickPick](#QuickPick) and [InputBox](#InputBox).
	 */
7748
	export class QuickInputButtons {
C
Christof Marti 已提交
7749 7750 7751 7752 7753 7754 7755

		/**
		 * 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.
		 */
7756 7757 7758 7759 7760 7761
		static readonly Back: QuickInputButton;

		/**
		 * @hidden
		 */
		private constructor();
C
Christof Marti 已提交
7762 7763
	}

E
Erich Gamma 已提交
7764
	/**
A
Alex Dima 已提交
7765
	 * An event describing an individual change in the text of a [document](#TextDocument).
E
Erich Gamma 已提交
7766 7767 7768 7769 7770 7771
	 */
	export interface TextDocumentContentChangeEvent {
		/**
		 * The range that got replaced.
		 */
		range: Range;
7772 7773 7774 7775
		/**
		 * The offset of the range that got replaced.
		 */
		rangeOffset: number;
E
Erich Gamma 已提交
7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786
		/**
		 * The length of the range that got replaced.
		 */
		rangeLength: number;
		/**
		 * The new text for the range.
		 */
		text: string;
	}

	/**
A
Alex Dima 已提交
7787
	 * An event describing a transactional [document](#TextDocument) change.
E
Erich Gamma 已提交
7788 7789 7790 7791 7792 7793
	 */
	export interface TextDocumentChangeEvent {

		/**
		 * The affected document.
		 */
7794
		readonly document: TextDocument;
E
Erich Gamma 已提交
7795 7796 7797 7798

		/**
		 * An array of content changes.
		 */
7799
		readonly contentChanges: ReadonlyArray<TextDocumentContentChangeEvent>;
E
Erich Gamma 已提交
7800 7801
	}

7802 7803 7804 7805 7806 7807
	/**
	 * Represents reasons why a text document is saved.
	 */
	export enum TextDocumentSaveReason {

		/**
7808 7809
		 * Manually triggered, e.g. by the user pressing save, by starting debugging,
		 * or by an API call.
7810
		 */
7811
		Manual = 1,
7812 7813 7814 7815

		/**
		 * Automatic after a delay.
		 */
7816
		AfterDelay = 2,
7817 7818 7819 7820 7821 7822 7823

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

7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835
	/**
	 * 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.
		 */
7836
		readonly document: TextDocument;
7837

7838 7839 7840
		/**
		 * The reason why save was triggered.
		 */
7841
		readonly reason: TextDocumentSaveReason;
7842

7843 7844 7845 7846 7847 7848 7849 7850 7851 7852
		/**
		 * 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 => {
7853 7854 7855 7856 7857
		 * 	// async, will *throw* an error
		 * 	setTimeout(() => event.waitUntil(promise));
		 *
		 * 	// sync, OK
		 * 	event.waitUntil(promise);
7858 7859 7860 7861 7862
		 * })
		 * ```
		 *
		 * @param thenable A thenable that resolves to [pre-save-edits](#TextEdit).
		 */
7863
		waitUntil(thenable: Thenable<TextEdit[]>): void;
7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874

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

7875 7876 7877 7878 7879 7880 7881
	/**
	 * An event describing a change to the set of [workspace folders](#workspace.workspaceFolders).
	 */
	export interface WorkspaceFoldersChangeEvent {
		/**
		 * Added workspace folders.
		 */
7882
		readonly added: ReadonlyArray<WorkspaceFolder>;
7883 7884 7885 7886

		/**
		 * Removed workspace folders.
		 */
7887
		readonly removed: ReadonlyArray<WorkspaceFolder>;
7888 7889 7890 7891
	}

	/**
	 * A workspace folder is one of potentially many roots opened by the editor. All workspace folders
7892
	 * are equal which means there is no notion of an active or master workspace folder.
7893 7894 7895 7896
	 */
	export interface WorkspaceFolder {

		/**
J
Johannes Rieken 已提交
7897 7898 7899 7900
		 * 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`.
7901 7902 7903 7904 7905
		 */
		readonly uri: Uri;

		/**
		 * The name of this workspace folder. Defaults to
J
Johannes Rieken 已提交
7906
		 * the basename of its [uri-path](#Uri.path)
7907 7908 7909 7910 7911 7912 7913 7914 7915
		 */
		readonly name: string;

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

E
Erich Gamma 已提交
7916
	/**
7917 7918 7919 7920 7921
	 * 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
7922
	 * events and for [finding](#workspace.findFiles) files. Both perform well and run _outside_
S
Steven Clarke 已提交
7923
	 * the editor-process so that they should be always used instead of nodejs-equivalents.
E
Erich Gamma 已提交
7924 7925 7926
	 */
	export namespace workspace {

7927 7928 7929 7930 7931 7932 7933 7934
		/**
		 * 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 已提交
7935
		/**
7936 7937
		 * ~~The folder that is open in the editor. `undefined` when no folder
		 * has been opened.~~
J
Johannes Rieken 已提交
7938
		 *
7939
		 * @deprecated Use [`workspaceFolders`](#workspace.workspaceFolders) instead.
E
Erich Gamma 已提交
7940
		 */
7941
		export const rootPath: string | undefined;
E
Erich Gamma 已提交
7942 7943

		/**
J
Johannes Rieken 已提交
7944 7945
		 * 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 已提交
7946
		 */
7947
		export const workspaceFolders: WorkspaceFolder[] | undefined;
7948

7949 7950 7951 7952
		/**
		 * The name of the workspace. `undefined` when no folder
		 * has been opened.
		 */
7953
		export const name: string | undefined;
7954

7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985
		/**
		 * 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;

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

		/**
7992 7993 7994
		 * 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
7995 7996 7997 7998 7999
		 *
		 * @param uri An uri.
		 * @return A workspace folder or `undefined`
		 */
		export function getWorkspaceFolder(uri: Uri): WorkspaceFolder | undefined;
E
Erich Gamma 已提交
8000 8001

		/**
8002
		 * Returns a path that is relative to the workspace folder or folders.
J
Johannes Rieken 已提交
8003
		 *
8004
		 * When there are no [workspace folders](#workspace.workspaceFolders) or when the path
J
Johannes Rieken 已提交
8005
		 * is not contained in them, the input is returned.
J
Johannes Rieken 已提交
8006 8007
		 *
		 * @param pathOrUri A path or uri. When a uri is given its [fsPath](#Uri.fsPath) is used.
J
Johannes Rieken 已提交
8008 8009 8010
		 * @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 已提交
8011
		 * @return A path relative to the root or the input.
E
Erich Gamma 已提交
8012
		 */
J
Johannes Rieken 已提交
8013
		export function asRelativePath(pathOrUri: string | Uri, includeWorkspaceFolder?: boolean): string;
E
Erich Gamma 已提交
8014

8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057
		/**
		 * 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;

8058 8059 8060
		/**
		 * Creates a file system watcher.
		 *
8061 8062
		 * 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.
8063
		 *
8064
		 * *Note* that only files within the current [workspace folders](#workspace.workspaceFolders) can be watched.
8065
		 *
8066
		 * @param globPattern A [glob pattern](#GlobPattern) that is applied to the absolute paths of created, changed,
B
Benjamin Pasero 已提交
8067
		 * and deleted files. Use a [relative pattern](#RelativePattern) to limit events to a certain [workspace folder](#WorkspaceFolder).
8068 8069 8070 8071 8072
		 * @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.
		 */
8073
		export function createFileSystemWatcher(globPattern: GlobPattern, ignoreCreateEvents?: boolean, ignoreChangeEvents?: boolean, ignoreDeleteEvents?: boolean): FileSystemWatcher;
8074

J
Johannes Rieken 已提交
8075
		/**
B
Benjamin Pasero 已提交
8076
		 * Find files across all [workspace folders](#workspace.workspaceFolders) in the workspace.
J
Johannes Rieken 已提交
8077
		 *
8078
		 * @sample `findFiles('**​/*.js', '**​/node_modules/**', 10)`
8079
		 * @param include A [glob pattern](#GlobPattern) that defines the files to search for. The glob pattern
B
Benjamin Pasero 已提交
8080 8081
		 * 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).
8082
		 * @param exclude  A [glob pattern](#GlobPattern) that defines files and folders to exclude. The glob pattern
J
Johannes Rieken 已提交
8083
		 * will be matched against the file paths of resulting matches relative to their workspace. When `undefined` only default excludes will
8084
		 * apply, when `null` no excludes will apply.
J
Johannes Rieken 已提交
8085
		 * @param maxResults An upper-bound for the result.
8086
		 * @param token A token that can be used to signal cancellation to the underlying search engine.
B
Benjamin Pasero 已提交
8087 8088
		 * @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 已提交
8089
		 */
J
Johannes Rieken 已提交
8090
		export function findFiles(include: GlobPattern, exclude?: GlobPattern | null, maxResults?: number, token?: CancellationToken): Thenable<Uri[]>;
E
Erich Gamma 已提交
8091 8092

		/**
J
Johannes Rieken 已提交
8093 8094 8095
		 * Save all dirty files.
		 *
		 * @param includeUntitled Also save files that have been created during this session.
S
Steven Clarke 已提交
8096
		 * @return A thenable that resolves when the files have been saved.
E
Erich Gamma 已提交
8097 8098 8099 8100
		 */
		export function saveAll(includeUntitled?: boolean): Thenable<boolean>;

		/**
8101
		 * Make changes to one or many resources or create, delete, and rename resources as defined by the given
J
Johannes Rieken 已提交
8102 8103
		 * [workspace edit](#WorkspaceEdit).
		 *
8104 8105 8106 8107 8108 8109
		 * 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
		 * in the order the 'inserts' were made. Invalid sequences like 'delete file a' -> 'insert text in file a'
		 * cause failure of the operation.
		 *
		 * When applying a workspace edit that consists only of text edits an 'all-or-nothing'-strategy is used.
8110
		 * A workspace edit with resource creations or deletions aborts the operation, e.g. consecutive edits will
8111
		 * not be attempted, when a single edit fails.
J
Johannes Rieken 已提交
8112 8113 8114
		 *
		 * @param edit A workspace edit.
		 * @return A thenable that resolves when the edit could be applied.
E
Erich Gamma 已提交
8115 8116 8117 8118 8119 8120
		 */
		export function applyEdit(edit: WorkspaceEdit): Thenable<boolean>;

		/**
		 * All text documents currently known to the system.
		 */
8121
		export const textDocuments: TextDocument[];
E
Erich Gamma 已提交
8122 8123

		/**
8124 8125 8126 8127 8128 8129 8130 8131
		 * 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 已提交
8132 8133
		 * * For all other schemes contributed [text document content providers](#TextDocumentContentProvider) and
		 * [file system providers](#FileSystemProvider) are consulted.
8134 8135 8136
		 *
		 * *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 已提交
8137 8138 8139 8140 8141 8142 8143
		 *
		 * @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 已提交
8144 8145 8146
		 * A short-hand for `openTextDocument(Uri.file(fileName))`.
		 *
		 * @see [openTextDocument](#openTextDocument)
A
Andre Weinand 已提交
8147 8148
		 * @param fileName A name of a file on disk.
		 * @return A promise that resolves to a [document](#TextDocument).
E
Erich Gamma 已提交
8149 8150 8151
		 */
		export function openTextDocument(fileName: string): Thenable<TextDocument>;

B
Benjamin Pasero 已提交
8152
		/**
J
Johannes Rieken 已提交
8153 8154
		 * 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
8155
		 * specify the *language* and/or the *content* of the document.
B
Benjamin Pasero 已提交
8156
		 *
J
Johannes Rieken 已提交
8157
		 * @param options Options to control how the document will be created.
B
Benjamin Pasero 已提交
8158 8159
		 * @return A promise that resolves to a [document](#TextDocument).
		 */
8160
		export function openTextDocument(options?: { language?: string; content?: string; }): Thenable<TextDocument>;
B
Benjamin Pasero 已提交
8161

J
Johannes Rieken 已提交
8162
		/**
8163 8164 8165
		 * Register a text document content provider.
		 *
		 * Only one provider can be registered per scheme.
J
Johannes Rieken 已提交
8166
		 *
8167 8168 8169
		 * @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 已提交
8170 8171 8172
		 */
		export function registerTextDocumentContentProvider(scheme: string, provider: TextDocumentContentProvider): Disposable;

A
Alex Dima 已提交
8173
		/**
J
Johannes Rieken 已提交
8174 8175
		 * 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).
8176 8177
		 *
		 * To add an event listener when a visible text document is opened, use the [TextEditor](#TextEditor) events in the
J
Johannes Rieken 已提交
8178
		 * [window](#window) namespace. Note that:
8179 8180 8181 8182 8183
		 *
		 * - 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 已提交
8184
		 */
E
Erich Gamma 已提交
8185 8186
		export const onDidOpenTextDocument: Event<TextDocument>;

A
Alex Dima 已提交
8187
		/**
J
Johannes Rieken 已提交
8188 8189
		 * 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).
8190 8191
		 *
		 * To add an event listener when a visible text document is closed, use the [TextEditor](#TextEditor) events in the
J
Johannes Rieken 已提交
8192
		 * [window](#window) namespace. Note that this event is not emitted when a [TextEditor](#TextEditor) is closed
S
Sean Poulter 已提交
8193
		 * but the document remains open in another [visible text editor](#window.visibleTextEditors).
A
Alex Dima 已提交
8194
		 */
E
Erich Gamma 已提交
8195 8196
		export const onDidCloseTextDocument: Event<TextDocument>;

A
Alex Dima 已提交
8197
		/**
8198 8199
		 * 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
8200
		 * [dirty](#TextDocument.isDirty)-state changes.
A
Alex Dima 已提交
8201
		 */
E
Erich Gamma 已提交
8202 8203
		export const onDidChangeTextDocument: Event<TextDocumentChangeEvent>;

8204 8205
		/**
		 * An event that is emitted when a [text document](#TextDocument) will be saved to disk.
8206
		 *
J
Johannes Rieken 已提交
8207
		 * *Note 1:* Subscribers can delay saving by registering asynchronous work. For the sake of data integrity the editor
8208 8209 8210 8211 8212 8213 8214 8215
		 * 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.
8216 8217 8218
		 */
		export const onWillSaveTextDocument: Event<TextDocumentWillSaveEvent>;

A
Alex Dima 已提交
8219 8220 8221
		/**
		 * An event that is emitted when a [text document](#TextDocument) is saved to disk.
		 */
E
Erich Gamma 已提交
8222 8223 8224
		export const onDidSaveTextDocument: Event<TextDocument>;

		/**
S
Sandeep Somavarapu 已提交
8225
		 * Get a workspace configuration object.
J
Johannes Rieken 已提交
8226 8227
		 *
		 * When a section-identifier is provided only that part of the configuration
A
Andre Weinand 已提交
8228
		 * is returned. Dots in the section-identifier are interpreted as child-access,
J
Johannes Rieken 已提交
8229
		 * like `{ myExt: { setting: { doIt: true }}}` and `getConfiguration('myExt.setting').get('doIt') === true`.
J
Johannes Rieken 已提交
8230
		 *
S
Sandeep Somavarapu 已提交
8231
		 * When a resource is provided, configuration scoped to that resource is returned.
S
Sandeep Somavarapu 已提交
8232 8233
		 *
		 * @param section A dot-separated identifier.
S
Sandeep Somavarapu 已提交
8234
		 * @param resource A resource for which the configuration is asked for
S
Sandeep Somavarapu 已提交
8235 8236
		 * @return The full configuration or a subset.
		 */
S
Sandeep Somavarapu 已提交
8237
		export function getConfiguration(section?: string, resource?: Uri | null): WorkspaceConfiguration;
E
Erich Gamma 已提交
8238

J
Johannes Rieken 已提交
8239 8240 8241
		/**
		 * An event that is emitted when the [configuration](#WorkspaceConfiguration) changed.
		 */
S
Sandeep Somavarapu 已提交
8242
		export const onDidChangeConfiguration: Event<ConfigurationChangeEvent>;
8243 8244

		/**
J
Johannes Rieken 已提交
8245 8246 8247
		 * ~~Register a task provider.~~
		 *
		 * @deprecated Use the corresponding function on the `tasks` namespace instead
8248 8249 8250 8251 8252 8253
		 *
		 * @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;
8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265

		/**
		 * 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 已提交
8266
		export function registerFileSystemProvider(scheme: string, provider: FileSystemProvider, options?: { readonly isCaseSensitive?: boolean, readonly isReadonly?: boolean }): Disposable;
E
Erich Gamma 已提交
8267 8268
	}

S
Sandeep Somavarapu 已提交
8269 8270 8271 8272 8273 8274
	/**
	 * An event describing the change in Configuration
	 */
	export interface ConfigurationChangeEvent {

		/**
S
Sandeep Somavarapu 已提交
8275
		 * Returns `true` if the given section for the given resource (if provided) is affected.
S
Sandeep Somavarapu 已提交
8276 8277 8278
		 *
		 * @param section Configuration name, supports _dotted_ names.
		 * @param resource A resource Uri.
S
Sandeep Somavarapu 已提交
8279
		 * @return `true` if the given section for the given resource (if provided) is affected.
S
Sandeep Somavarapu 已提交
8280 8281 8282 8283
		 */
		affectsConfiguration(section: string, resource?: Uri): boolean;
	}

J
Johannes Rieken 已提交
8284
	/**
8285 8286 8287 8288 8289 8290 8291
	 * 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 已提交
8292
	 * The editor provides an API that makes it simple to provide such common features by having all UI and actions already in place and
8293 8294 8295 8296 8297 8298
	 * 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', {
8299 8300 8301
	 * 	provideHover(document, position, token) {
	 * 		return new Hover('I am a hover!');
	 * 	}
8302 8303
	 * });
	 * ```
8304 8305 8306
	 *
	 * 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 已提交
8307
	 * a selector will result in a [score](#languages.match) that is used to determine if and how a provider shall be used. When
8308 8309 8310
	 * 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 已提交
8311
	 */
E
Erich Gamma 已提交
8312 8313 8314 8315 8316 8317 8318 8319
	export namespace languages {

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

8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332
		/**
		 * 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 已提交
8333
		/**
J
Johannes Rieken 已提交
8334
		 * Compute the match between a document [selector](#DocumentSelector) and a document. Values
8335 8336 8337
		 * greater than zero mean the selector matches the document.
		 *
		 * A match is computed according to these rules:
8338 8339
		 * 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" }`.
8340 8341
		 * 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`
8342 8343
		 *  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`
8344
		 *  4. The result is the maximum value of each match
8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360
		 *
		 * 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'
8361
		 * match('javascript', doc); // 10;
8362 8363
		 * match({language: 'javascript', scheme: 'git'}, doc); // 10;
		 * match('*', doc); // 5
8364
		 * ```
J
Johannes Rieken 已提交
8365 8366 8367
		 *
		 * @param selector A document selector.
		 * @param document A text document.
J
Johannes Rieken 已提交
8368
		 * @return A number `>0` when the selector matches and `0` when the selector does not match.
E
Erich Gamma 已提交
8369 8370 8371
		 */
		export function match(selector: DocumentSelector, document: TextDocument): number;

8372 8373 8374 8375 8376 8377 8378
		/**
		 * An [event](#Event) which fires when the global set of diagnostics changes. This is
		 * newly added and removed diagnostics.
		 */
		export const onDidChangeDiagnostics: Event<DiagnosticChangeEvent>;

		/**
8379
		 * Get all diagnostics for a given resource.
8380 8381
		 *
		 * @param resource A resource
8382
		 * @returns An array of [diagnostics](#Diagnostic) objects or an empty array.
8383 8384 8385 8386
		 */
		export function getDiagnostics(resource: Uri): Diagnostic[];

		/**
8387
		 * Get all diagnostics.
8388 8389 8390 8391 8392
		 *
		 * @returns An array of uri-diagnostics tuples or an empty array.
		 */
		export function getDiagnostics(): [Uri, Diagnostic[]][];

E
Erich Gamma 已提交
8393
		/**
S
Steven Clarke 已提交
8394
		 * Create a diagnostics collection.
J
Johannes Rieken 已提交
8395 8396 8397
		 *
		 * @param name The [name](#DiagnosticCollection.name) of the collection.
		 * @return A new diagnostic collection.
E
Erich Gamma 已提交
8398 8399 8400 8401
		 */
		export function createDiagnosticCollection(name?: string): DiagnosticCollection;

		/**
J
Johannes Rieken 已提交
8402 8403 8404
		 * Register a completion provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
8405
		 * by their [score](#languages.match) and groups of equal score are sequentially asked for
J
Johannes Rieken 已提交
8406
		 * completion items. The process stops when one or many providers of a group return a
8407 8408
		 * result. A failing provider (rejected promise or exception) will not fail the whole
		 * operation.
E
Erich Gamma 已提交
8409
		 *
8410 8411 8412 8413 8414
		 * 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 已提交
8415 8416
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A completion provider.
8417
		 * @param triggerCharacters Trigger completion when the user types one of the characters.
J
Johannes Rieken 已提交
8418 8419 8420 8421 8422
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerCompletionItemProvider(selector: DocumentSelector, provider: CompletionItemProvider, ...triggerCharacters: string[]): Disposable;

		/**
J
Johannes Rieken 已提交
8423 8424 8425
		 * Register a code action provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
8426 8427
		 * 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 已提交
8428 8429
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
J
Johannes Rieken 已提交
8430
		 * @param provider A code action provider.
8431
		 * @param metadata Metadata about the kind of code actions the provider providers.
J
Johannes Rieken 已提交
8432
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
8433
		 */
8434
		export function registerCodeActionsProvider(selector: DocumentSelector, provider: CodeActionProvider, metadata?: CodeActionProviderMetadata): Disposable;
E
Erich Gamma 已提交
8435 8436

		/**
J
Johannes Rieken 已提交
8437 8438 8439
		 * Register a code lens provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
8440 8441
		 * 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 已提交
8442
		 *
J
Johannes Rieken 已提交
8443 8444 8445
		 * @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 已提交
8446
		 */
J
Johannes Rieken 已提交
8447
		export function registerCodeLensProvider(selector: DocumentSelector, provider: CodeLensProvider): Disposable;
E
Erich Gamma 已提交
8448 8449

		/**
J
Johannes Rieken 已提交
8450 8451 8452
		 * Register a definition provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
8453 8454
		 * 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 已提交
8455
		 *
J
Johannes Rieken 已提交
8456 8457 8458
		 * @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 已提交
8459 8460 8461
		 */
		export function registerDefinitionProvider(selector: DocumentSelector, provider: DefinitionProvider): Disposable;

8462
		/**
8463
		 * Register an implementation provider.
8464
		 *
8465 8466 8467
		 * 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.
8468 8469 8470 8471 8472
		 *
		 * @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 已提交
8473
		export function registerImplementationProvider(selector: DocumentSelector, provider: ImplementationProvider): Disposable;
8474

8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487
		/**
		 * 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;

8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500
		/**
		 * 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 已提交
8501
		/**
J
Johannes Rieken 已提交
8502 8503 8504
		 * Register a hover provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
8505 8506
		 * 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 已提交
8507
		 *
J
Johannes Rieken 已提交
8508 8509 8510
		 * @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 已提交
8511 8512 8513 8514
		 */
		export function registerHoverProvider(selector: DocumentSelector, provider: HoverProvider): Disposable;

		/**
J
Johannes Rieken 已提交
8515 8516 8517 8518
		 * 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.
8519
		 * The process stops when a provider returns a `non-falsy` or `non-failure` result.
E
Erich Gamma 已提交
8520
		 *
J
Johannes Rieken 已提交
8521 8522 8523
		 * @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 已提交
8524 8525 8526 8527
		 */
		export function registerDocumentHighlightProvider(selector: DocumentSelector, provider: DocumentHighlightProvider): Disposable;

		/**
J
Johannes Rieken 已提交
8528 8529 8530
		 * Register a document symbol provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
8531 8532
		 * 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 已提交
8533
		 *
J
Johannes Rieken 已提交
8534 8535
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A document symbol provider.
8536
		 * @param metaData metadata about the provider
J
Johannes Rieken 已提交
8537
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
8538
		 */
8539
		export function registerDocumentSymbolProvider(selector: DocumentSelector, provider: DocumentSymbolProvider, metaData?: DocumentSymbolProviderMetadata): Disposable;
E
Erich Gamma 已提交
8540 8541

		/**
J
Johannes Rieken 已提交
8542 8543
		 * Register a workspace symbol provider.
		 *
8544 8545 8546
		 * 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 已提交
8547
		 *
J
Johannes Rieken 已提交
8548 8549
		 * @param provider A workspace symbol provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
8550 8551 8552 8553
		 */
		export function registerWorkspaceSymbolProvider(provider: WorkspaceSymbolProvider): Disposable;

		/**
J
Johannes Rieken 已提交
8554 8555 8556
		 * Register a reference provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
8557 8558
		 * 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 已提交
8559
		 *
J
Johannes Rieken 已提交
8560 8561 8562
		 * @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 已提交
8563 8564 8565 8566
		 */
		export function registerReferenceProvider(selector: DocumentSelector, provider: ReferenceProvider): Disposable;

		/**
8567
		 * Register a rename provider.
J
Johannes Rieken 已提交
8568 8569
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
8570
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
8571
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
8572
		 *
J
Johannes Rieken 已提交
8573 8574 8575
		 * @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 已提交
8576 8577 8578 8579
		 */
		export function registerRenameProvider(selector: DocumentSelector, provider: RenameProvider): Disposable;

		/**
A
Andre Weinand 已提交
8580
		 * Register a formatting provider for a document.
J
Johannes Rieken 已提交
8581 8582
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
8583
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
8584
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
8585
		 *
J
Johannes Rieken 已提交
8586 8587 8588
		 * @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 已提交
8589 8590 8591 8592
		 */
		export function registerDocumentFormattingEditProvider(selector: DocumentSelector, provider: DocumentFormattingEditProvider): Disposable;

		/**
J
Johannes Rieken 已提交
8593 8594
		 * Register a formatting provider for a document range.
		 *
8595
		 * *Note:* A document range provider is also a [document formatter](#DocumentFormattingEditProvider)
M
Matthew J. Clemente 已提交
8596
		 * which means there is no need to [register](#languages.registerDocumentFormattingEditProvider) a document
8597 8598
		 * formatter when also registering a range provider.
		 *
J
Johannes Rieken 已提交
8599
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
8600
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
8601
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
8602
		 *
J
Johannes Rieken 已提交
8603 8604 8605
		 * @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 已提交
8606 8607 8608 8609
		 */
		export function registerDocumentRangeFormattingEditProvider(selector: DocumentSelector, provider: DocumentRangeFormattingEditProvider): Disposable;

		/**
E
Erich Gamma 已提交
8610
		 * Register a formatting provider that works on type. The provider is active when the user enables the setting `editor.formatOnType`.
J
Johannes Rieken 已提交
8611 8612
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
8613
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
8614
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
8615
		 *
J
Johannes Rieken 已提交
8616 8617 8618
		 * @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 已提交
8619
		 * @param moreTriggerCharacter More trigger characters.
J
Johannes Rieken 已提交
8620
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
8621 8622 8623 8624
		 */
		export function registerOnTypeFormattingEditProvider(selector: DocumentSelector, provider: OnTypeFormattingEditProvider, firstTriggerCharacter: string, ...moreTriggerCharacter: string[]): Disposable;

		/**
J
Johannes Rieken 已提交
8625 8626 8627
		 * Register a signature help provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
8628 8629
		 * by their [score](#languages.match) and called sequentially until a provider returns a
		 * valid result.
E
Erich Gamma 已提交
8630
		 *
J
Johannes Rieken 已提交
8631 8632 8633
		 * @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 `(`.
8634
		 * @param metadata Information about the provider.
J
Johannes Rieken 已提交
8635
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
8636 8637
		 */
		export function registerSignatureHelpProvider(selector: DocumentSelector, provider: SignatureHelpProvider, ...triggerCharacters: string[]): Disposable;
8638
		export function registerSignatureHelpProvider(selector: DocumentSelector, provider: SignatureHelpProvider, metadata: SignatureHelpProviderMetadata): Disposable;
E
Erich Gamma 已提交
8639

J
Johannes Rieken 已提交
8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652
		/**
		 * 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;

8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665
		/**
		 * 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;

8666 8667 8668
		/**
		 * Register a folding range provider.
		 *
8669 8670 8671 8672 8673 8674 8675
		 * 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.
8676 8677 8678 8679 8680
		 *
		 * @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.
		 */
8681
		export function registerFoldingRangeProvider(selector: DocumentSelector, provider: FoldingRangeProvider): Disposable;
8682

8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695
		/**
		 * 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;

E
Erich Gamma 已提交
8696
		/**
J
Johannes Rieken 已提交
8697
		 * Set a [language configuration](#LanguageConfiguration) for a language.
E
Erich Gamma 已提交
8698
		 *
A
Andre Weinand 已提交
8699
		 * @param language A language identifier like `typescript`.
J
Johannes Rieken 已提交
8700 8701
		 * @param configuration Language configuration.
		 * @return A [disposable](#Disposable) that unsets this configuration.
E
Erich Gamma 已提交
8702 8703 8704 8705
		 */
		export function setLanguageConfiguration(language: string, configuration: LanguageConfiguration): Disposable;
	}

J
Joao Moreno 已提交
8706
	/**
J
Joao Moreno 已提交
8707
	 * Represents the input box in the Source Control viewlet.
J
Joao Moreno 已提交
8708
	 */
J
Joao Moreno 已提交
8709
	export interface SourceControlInputBox {
J
Joao Moreno 已提交
8710 8711

		/**
J
Joao Moreno 已提交
8712
		 * Setter and getter for the contents of the input box.
J
Joao Moreno 已提交
8713
		 */
J
Joao Moreno 已提交
8714
		value: string;
8715 8716 8717 8718 8719

		/**
		 * A string to show as place holder in the input box to guide the user.
		 */
		placeholder: string;
J
Joao Moreno 已提交
8720 8721
	}

J
Joao Moreno 已提交
8722
	interface QuickDiffProvider {
J
Joao Moreno 已提交
8723 8724

		/**
J
Joao Moreno 已提交
8725 8726 8727 8728 8729
		 * 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 已提交
8730
		 */
J
Joao Moreno 已提交
8731 8732
		provideOriginalResource?(uri: Uri, token: CancellationToken): ProviderResult<Uri>;
	}
J
Joao Moreno 已提交
8733

J
Joao Moreno 已提交
8734 8735 8736 8737 8738
	/**
	 * The theme-aware decorations for a
	 * [source control resource state](#SourceControlResourceState).
	 */
	export interface SourceControlResourceThemableDecorations {
J
Joao Moreno 已提交
8739 8740

		/**
J
Joao Moreno 已提交
8741 8742
		 * The icon path for a specific
		 * [source control resource state](#SourceControlResourceState).
J
Joao Moreno 已提交
8743
		 */
J
Joao Moreno 已提交
8744
		readonly iconPath?: string | Uri;
J
Joao Moreno 已提交
8745 8746 8747
	}

	/**
J
Joao Moreno 已提交
8748 8749
	 * The decorations for a [source control resource state](#SourceControlResourceState).
	 * Can be independently specified for light and dark themes.
J
Joao Moreno 已提交
8750
	 */
J
Joao Moreno 已提交
8751
	export interface SourceControlResourceDecorations extends SourceControlResourceThemableDecorations {
J
Joao Moreno 已提交
8752 8753

		/**
J
Joao Moreno 已提交
8754 8755
		 * Whether the [source control resource state](#SourceControlResourceState) should
		 * be striked-through in the UI.
J
Joao Moreno 已提交
8756
		 */
J
Joao Moreno 已提交
8757
		readonly strikeThrough?: boolean;
J
Joao Moreno 已提交
8758

8759 8760
		/**
		 * Whether the [source control resource state](#SourceControlResourceState) should
I
Ilie Halip 已提交
8761
		 * be faded in the UI.
8762 8763 8764
		 */
		readonly faded?: boolean;

8765 8766 8767 8768 8769 8770
		/**
		 * The title for a specific
		 * [source control resource state](#SourceControlResourceState).
		 */
		readonly tooltip?: string;

J
Joao Moreno 已提交
8771
		/**
J
Joao Moreno 已提交
8772
		 * The light theme decorations.
J
Joao Moreno 已提交
8773
		 */
J
Joao Moreno 已提交
8774
		readonly light?: SourceControlResourceThemableDecorations;
J
Joao Moreno 已提交
8775 8776

		/**
J
Joao Moreno 已提交
8777
		 * The dark theme decorations.
J
Joao Moreno 已提交
8778
		 */
J
Joao Moreno 已提交
8779
		readonly dark?: SourceControlResourceThemableDecorations;
J
Joao Moreno 已提交
8780 8781 8782
	}

	/**
J
Joao Moreno 已提交
8783 8784
	 * An source control resource state represents the state of an underlying workspace
	 * resource within a certain [source control group](#SourceControlResourceGroup).
J
Joao Moreno 已提交
8785
	 */
J
Joao Moreno 已提交
8786
	export interface SourceControlResourceState {
J
Joao Moreno 已提交
8787 8788

		/**
J
Joao Moreno 已提交
8789
		 * The [uri](#Uri) of the underlying resource inside the workspace.
J
Joao Moreno 已提交
8790
		 */
J
Joao Moreno 已提交
8791
		readonly resourceUri: Uri;
J
Joao Moreno 已提交
8792 8793

		/**
J
Joao Moreno 已提交
8794 8795
		 * The [command](#Command) which should be run when the resource
		 * state is open in the Source Control viewlet.
J
Joao Moreno 已提交
8796
		 */
8797
		readonly command?: Command;
J
Joao Moreno 已提交
8798 8799

		/**
J
Joao Moreno 已提交
8800 8801
		 * The [decorations](#SourceControlResourceDecorations) for this source control
		 * resource state.
J
Joao Moreno 已提交
8802
		 */
J
Joao Moreno 已提交
8803
		readonly decorations?: SourceControlResourceDecorations;
J
Joao Moreno 已提交
8804 8805 8806
	}

	/**
J
Joao Moreno 已提交
8807 8808
	 * A source control resource group is a collection of
	 * [source control resource states](#SourceControlResourceState).
J
Joao Moreno 已提交
8809
	 */
J
Joao Moreno 已提交
8810 8811 8812 8813 8814 8815
	export interface SourceControlResourceGroup {

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

		/**
J
Joao Moreno 已提交
8818
		 * The label of this source control resource group.
J
Joao Moreno 已提交
8819
		 */
8820
		label: string;
J
Joao Moreno 已提交
8821 8822

		/**
J
Joao Moreno 已提交
8823 8824
		 * Whether this source control resource group is hidden when it contains
		 * no [source control resource states](#SourceControlResourceState).
J
Joao Moreno 已提交
8825
		 */
J
Joao Moreno 已提交
8826
		hideWhenEmpty?: boolean;
J
Joao Moreno 已提交
8827 8828

		/**
J
Joao Moreno 已提交
8829 8830
		 * This group's collection of
		 * [source control resource states](#SourceControlResourceState).
J
Joao Moreno 已提交
8831
		 */
J
Joao Moreno 已提交
8832
		resourceStates: SourceControlResourceState[];
J
Joao Moreno 已提交
8833 8834

		/**
J
Joao Moreno 已提交
8835
		 * Dispose this source control resource group.
J
Joao Moreno 已提交
8836
		 */
J
Joao Moreno 已提交
8837 8838 8839 8840 8841 8842 8843 8844
		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 已提交
8845 8846

		/**
J
Joao Moreno 已提交
8847
		 * The id of this source control.
J
Joao Moreno 已提交
8848
		 */
J
Joao Moreno 已提交
8849
		readonly id: string;
J
Joao Moreno 已提交
8850 8851

		/**
J
Joao Moreno 已提交
8852
		 * The human-readable label of this source control.
J
Joao Moreno 已提交
8853
		 */
J
Joao Moreno 已提交
8854
		readonly label: string;
J
Joao Moreno 已提交
8855

J
Joao Moreno 已提交
8856 8857 8858 8859 8860
		/**
		 * The (optional) Uri of the root of this source control.
		 */
		readonly rootUri: Uri | undefined;

J
Joao Moreno 已提交
8861 8862 8863 8864 8865
		/**
		 * The [input box](#SourceControlInputBox) for this source control.
		 */
		readonly inputBox: SourceControlInputBox;

J
Joao Moreno 已提交
8866
		/**
J
Joao Moreno 已提交
8867 8868
		 * The UI-visible count of [resource states](#SourceControlResourceState) of
		 * this source control.
J
Joao Moreno 已提交
8869
		 *
J
Joao Moreno 已提交
8870 8871
		 * Equals to the total number of [resource state](#SourceControlResourceState)
		 * of this source control, if undefined.
J
Joao Moreno 已提交
8872
		 */
J
Joao Moreno 已提交
8873
		count?: number;
J
Joao Moreno 已提交
8874 8875

		/**
J
Joao Moreno 已提交
8876
		 * An optional [quick diff provider](#QuickDiffProvider).
J
Joao Moreno 已提交
8877
		 */
J
Joao Moreno 已提交
8878
		quickDiffProvider?: QuickDiffProvider;
J
Joao Moreno 已提交
8879

J
Joao Moreno 已提交
8880
		/**
8881 8882 8883 8884
		 * Optional commit template string.
		 *
		 * The Source Control viewlet will populate the Source Control
		 * input with this value when appropriate.
J
Joao Moreno 已提交
8885
		 */
8886
		commitTemplate?: string;
J
Joao Moreno 已提交
8887 8888

		/**
8889 8890 8891 8892
		 * Optional accept input command.
		 *
		 * This command will be invoked when the user accepts the value
		 * in the Source Control input.
J
Joao Moreno 已提交
8893
		 */
8894
		acceptInputCommand?: Command;
J
Joao Moreno 已提交
8895 8896

		/**
8897 8898 8899
		 * Optional status bar commands.
		 *
		 * These commands will be displayed in the editor's status bar.
J
Joao Moreno 已提交
8900
		 */
8901
		statusBarCommands?: Command[];
J
Joao Moreno 已提交
8902 8903

		/**
8904
		 * Create a new [resource group](#SourceControlResourceGroup).
J
Joao Moreno 已提交
8905
		 */
8906
		createResourceGroup(id: string, label: string): SourceControlResourceGroup;
J
Joao Moreno 已提交
8907 8908

		/**
8909
		 * Dispose this source control.
J
Joao Moreno 已提交
8910
		 */
8911 8912 8913 8914
		dispose(): void;
	}

	export namespace scm {
J
Joao Moreno 已提交
8915 8916

		/**
J
Joao 已提交
8917 8918
		 * ~~The [input box](#SourceControlInputBox) for the last source control
		 * created by the extension.~~
J
Joao Moreno 已提交
8919
		 *
J
Joao Moreno 已提交
8920
		 * @deprecated Use SourceControl.inputBox instead
J
Joao Moreno 已提交
8921
		 */
8922
		export const inputBox: SourceControlInputBox;
J
Joao Moreno 已提交
8923 8924

		/**
J
Joao Moreno 已提交
8925
		 * Creates a new [source control](#SourceControl) instance.
J
Joao Moreno 已提交
8926
		 *
8927 8928 8929
		 * @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 已提交
8930
		 * @return An instance of [source control](#SourceControl).
J
Joao Moreno 已提交
8931
		 */
J
Joao Moreno 已提交
8932
		export function createSourceControl(id: string, label: string, rootUri?: Uri): SourceControl;
J
Joao Moreno 已提交
8933 8934
	}

8935 8936 8937 8938 8939
	/**
	 * Configuration for a debug session.
	 */
	export interface DebugConfiguration {
		/**
8940
		 * The type of the debug session.
8941 8942 8943 8944
		 */
		type: string;

		/**
8945
		 * The name of the debug session.
8946
		 */
8947
		name: string;
8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964

		/**
		 * 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 已提交
8965 8966 8967 8968 8969
		/**
		 * The unique ID of this debug session.
		 */
		readonly id: string;

8970
		/**
A
Andre Weinand 已提交
8971
		 * The debug session's type from the [debug configuration](#DebugConfiguration).
A
Andre Weinand 已提交
8972
		 */
8973 8974 8975
		readonly type: string;

		/**
8976 8977
		 * The debug session's name is initially taken from the [debug configuration](#DebugConfiguration).
		 * Any changes will be properly reflected in the UI.
8978
		 */
8979
		name: string;
8980

8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993
		/**
		 * 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;

8994 8995 8996 8997 8998 8999 9000
		/**
		 * Send a custom request to the debug adapter.
		 */
		customRequest(command: string, args?: any): Thenable<any>;
	}

	/**
A
Andre Weinand 已提交
9001
	 * A custom Debug Adapter Protocol event received from a [debug session](#DebugSession).
9002
	 */
A
Andre Weinand 已提交
9003 9004 9005 9006
	export interface DebugSessionCustomEvent {
		/**
		 * The [debug session](#DebugSession) for which the custom event was received.
		 */
9007
		readonly session: DebugSession;
9008 9009

		/**
A
Andre Weinand 已提交
9010
		 * Type of event.
9011
		 */
9012
		readonly event: string;
A
Andre Weinand 已提交
9013 9014 9015 9016

		/**
		 * Event specific information.
		 */
9017
		readonly body?: any;
A
Andre Weinand 已提交
9018 9019
	}

A
Andre Weinand 已提交
9020 9021
	/**
	 * A debug configuration provider allows to add the initial debug configurations to a newly created launch.json
9022 9023
	 * 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 已提交
9024 9025 9026 9027 9028 9029
	 */
	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 已提交
9030
		 * @param folder The workspace folder for which the configurations are used or `undefined` for a folderless setup.
A
Andre Weinand 已提交
9031 9032 9033 9034 9035 9036 9037 9038 9039
		 * @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.
9040
		 * Returning the value 'undefined' prevents the debug session from starting.
9041
		 * Returning the value 'null' prevents the debug session from starting and opens the underlying debug configuration instead.
A
Andre Weinand 已提交
9042
		 *
A
Andre Weinand 已提交
9043
		 * @param folder The workspace folder from which the configuration originates from or `undefined` for a folderless setup.
A
Andre Weinand 已提交
9044 9045
		 * @param debugConfiguration The [debug configuration](#DebugConfiguration) to resolve.
		 * @param token A cancellation token.
9046
		 * @return The resolved debug configuration or undefined or null.
A
Andre Weinand 已提交
9047 9048 9049 9050
		 */
		resolveDebugConfiguration?(folder: WorkspaceFolder | undefined, debugConfiguration: DebugConfiguration, token?: CancellationToken): ProviderResult<DebugConfiguration>;
	}

9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145
	/**
	 * 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);
	}

	export type DebugAdapterDescriptor = DebugAdapterExecutable | DebugAdapterServer;

	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 已提交
9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166
	/**
	 * 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;
		/**
9167
		 * An error with the debug adapter has occurred.
A
Andre Weinand 已提交
9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186
		 */
		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>;
	}

9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206
	/**
	 * 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 已提交
9207
	/**
9208
	 * An event describing the changes to the set of [breakpoints](#Breakpoint).
A
Andre Weinand 已提交
9209
	 */
9210 9211 9212 9213
	export interface BreakpointsChangeEvent {
		/**
		 * Added breakpoints.
		 */
9214
		readonly added: ReadonlyArray<Breakpoint>;
9215 9216

		/**
9217
		 * Removed breakpoints.
9218
		 */
9219
		readonly removed: ReadonlyArray<Breakpoint>;
9220 9221 9222 9223

		/**
		 * Changed breakpoints.
		 */
9224
		readonly changed: ReadonlyArray<Breakpoint>;
9225 9226 9227 9228 9229 9230
	}

	/**
	 * The base class of all breakpoint types.
	 */
	export class Breakpoint {
9231 9232 9233 9234
		/**
		 * The unique ID of the breakpoint.
		 */
		readonly id: string;
9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246
		/**
		 * 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;
9247 9248 9249 9250
		/**
		 * An optional message that gets logged when this breakpoint is hit. Embedded expressions within {} are interpolated by the debug adapter.
		 */
		readonly logMessage?: string;
9251

9252
		protected constructor(enabled?: boolean, condition?: string, hitCondition?: string, logMessage?: string);
9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266
	}

	/**
	 * 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.
		 */
9267
		constructor(location: Location, enabled?: boolean, condition?: string, hitCondition?: string, logMessage?: string);
9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281
	}

	/**
	 * 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.
		 */
9282
		constructor(functionName: string, enabled?: boolean, condition?: string, hitCondition?: string, logMessage?: string);
9283 9284
	}

I
isidor 已提交
9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319
	/**
	 * 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;
	}

9320 9321 9322 9323
	/**
	 * Namespace for debug functionality.
	 */
	export namespace debug {
A
Andre Weinand 已提交
9324 9325

		/**
A
Andre Weinand 已提交
9326
		 * The currently active [debug session](#DebugSession) or `undefined`. The active debug session is the one
A
Andre Weinand 已提交
9327 9328 9329 9330 9331
		 * 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;

9332 9333
		/**
		 * The currently active [debug console](#DebugConsole).
9334
		 * If no debug session is active, output sent to the debug console is not shown.
9335 9336 9337
		 */
		export let activeDebugConsole: DebugConsole;

9338 9339 9340 9341 9342 9343
		/**
		 * List of breakpoints.
		 */
		export let breakpoints: Breakpoint[];


A
Andre Weinand 已提交
9344 9345 9346 9347 9348 9349 9350
		/**
		 * 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>;

9351
		/**
A
Andre Weinand 已提交
9352
		 * An [event](#Event) which fires when a new [debug session](#DebugSession) has been started.
9353 9354 9355
		 */
		export const onDidStartDebugSession: Event<DebugSession>;

A
Andre Weinand 已提交
9356
		/**
A
Andre Weinand 已提交
9357
		 * An [event](#Event) which fires when a custom DAP event is received from the [debug session](#DebugSession).
A
Andre Weinand 已提交
9358 9359 9360 9361
		 */
		export const onDidReceiveDebugSessionCustomEvent: Event<DebugSessionCustomEvent>;

		/**
A
Andre Weinand 已提交
9362
		 * An [event](#Event) which fires when a [debug session](#DebugSession) has terminated.
A
Andre Weinand 已提交
9363 9364
		 */
		export const onDidTerminateDebugSession: Event<DebugSession>;
A
Andre Weinand 已提交
9365

9366 9367 9368 9369 9370 9371
		/**
		 * An [event](#Event) that is emitted when the set of breakpoints is added, removed, or changed.
		 */
		export const onDidChangeBreakpoints: Event<BreakpointsChangeEvent>;


A
Andre Weinand 已提交
9372
		/**
9373
		 * Register a [debug configuration provider](#DebugConfigurationProvider) for a specific debug type.
A
Andre Weinand 已提交
9374 9375 9376 9377 9378 9379 9380
		 * 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;
9381

9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392
		/**
		 * 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 已提交
9393 9394 9395 9396 9397 9398 9399 9400 9401
		/**
		 * 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;

9402 9403 9404 9405 9406 9407 9408 9409
		/**
		 * 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 已提交
9410
		 * @param parentSessionOrOptions Debug sesison options. When passed a parent [debug session](#DebugSession), assumes options with just this parent session.
9411 9412
		 * @return A thenable that resolves when debugging could be successfully started.
		 */
I
isidor 已提交
9413
		export function startDebugging(folder: WorkspaceFolder | undefined, nameOrConfiguration: string | DebugConfiguration, parentSessionOrOptions?: DebugSession | DebugSessionOptions): Thenable<boolean>;
9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425

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

J
Johannes Rieken 已提交
9428
	/**
9429
	 * Namespace for dealing with installed extensions. Extensions are represented
J
Jon Malmaud 已提交
9430
	 * by an [extension](#Extension)-interface which enables reflection on them.
9431
	 *
S
Steven Clarke 已提交
9432
	 * Extension writers can provide APIs to other extensions by returning their API public
9433 9434 9435 9436
	 * surface from the `activate`-call.
	 *
	 * ```javascript
	 * export function activate(context: vscode.ExtensionContext) {
9437 9438 9439 9440 9441 9442 9443 9444 9445 9446
	 * 	let api = {
	 * 		sum(a, b) {
	 * 			return a + b;
	 * 		},
	 * 		mul(a, b) {
	 * 			return a * b;
	 * 		}
	 * 	};
	 * 	// 'export' public api-surface
	 * 	return api;
9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458
	 * }
	 * ```
	 * When depending on the API of another extension add an `extensionDependency`-entry
	 * to `package.json`, and use the [getExtension](#extensions.getExtension)-function
	 * and the [exports](#Extension.exports)-property, like below:
	 *
	 * ```javascript
	 * let mathExt = extensions.getExtension('genius.math');
	 * let importedApi = mathExt.exports;
	 *
	 * console.log(importedApi.mul(42, 1));
	 * ```
J
Johannes Rieken 已提交
9459
	 */
E
Erich Gamma 已提交
9460 9461
	export namespace extensions {

J
Johannes Rieken 已提交
9462
		/**
9463
		 * Get an extension by its full identifier in the form of: `publisher.name`.
J
Johannes Rieken 已提交
9464
		 *
J
Johannes Rieken 已提交
9465
		 * @param extensionId An extension identifier.
J
Johannes Rieken 已提交
9466 9467
		 * @return An extension or `undefined`.
		 */
9468
		export function getExtension(extensionId: string): Extension<any> | undefined;
E
Erich Gamma 已提交
9469

J
Johannes Rieken 已提交
9470
		/**
A
Andre Weinand 已提交
9471
		 * Get an extension its full identifier in the form of: `publisher.name`.
J
Johannes Rieken 已提交
9472 9473 9474
		 *
		 * @param extensionId An extension identifier.
		 * @return An extension or `undefined`.
J
Johannes Rieken 已提交
9475
		 */
9476
		export function getExtension<T>(extensionId: string): Extension<T> | undefined;
E
Erich Gamma 已提交
9477 9478 9479 9480

		/**
		 * All extensions currently known to the system.
		 */
M
Matt Bierner 已提交
9481
		export const all: ReadonlyArray<Extension<any>>;
9482 9483 9484 9485 9486 9487

		/**
		 * 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 已提交
9488
	}
P
Peng Lyu 已提交
9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506

	//#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 已提交
9507 9508 9509
	/**
	 * Comment mode of a [comment](#Comment)
	 */
P
Peng Lyu 已提交
9510
	export enum CommentMode {
P
Peng Lyu 已提交
9511 9512 9513
		/**
		 * Displays the comment editor
		 */
P
Peng Lyu 已提交
9514
		Editing = 0,
P
Peng Lyu 已提交
9515 9516 9517 9518

		/**
		 * Displays the preview of the comment
		 */
P
Peng Lyu 已提交
9519 9520 9521 9522 9523 9524 9525 9526 9527 9528
		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.
		 */
9529
		readonly uri: Uri;
P
Peng Lyu 已提交
9530 9531 9532 9533 9534

		/**
		 * 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 已提交
9535
		range: Range;
P
Peng Lyu 已提交
9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547

		/**
		 * 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 已提交
9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567
		/**
		 * 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 已提交
9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595
		/**
		 * 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 已提交
9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620
	/**
	 * 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 已提交
9621 9622 9623 9624 9625 9626 9627 9628 9629
	/**
	 * 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 已提交
9630 9631 9632
		/**
		 * [Comment mode](#CommentMode) of the comment
		 */
P
Peng Lyu 已提交
9633 9634 9635
		mode: CommentMode;

		/**
P
Peng Lyu 已提交
9636
		 * The [author information](#CommentAuthorInformation) of the comment
P
Peng Lyu 已提交
9637 9638 9639
		 */
		author: CommentAuthorInformation;

P
Peng Lyu 已提交
9640 9641 9642 9643
		/**
		 * 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`.
9644
		 * ```json
P
Peng Lyu 已提交
9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659
		 *	"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 已提交
9660 9661 9662 9663 9664
		/**
		 * Optional reactions of the [comment](#Comment)
		 */
		reactions?: CommentReaction[];

P
Peng Lyu 已提交
9665 9666 9667 9668 9669 9670 9671
		/**
		 * Optional label describing the [Comment](#Comment)
		 * Label will be rendered next to authorName if exists.
		 */
		label?: string;
	}

P
Peng Lyu 已提交
9672
	/**
9673
	 * Command argument for actions registered in `comments/commentThread/context`.
P
Peng Lyu 已提交
9674
	 */
P
Peng Lyu 已提交
9675
	export interface CommentReply {
P
Peng Lyu 已提交
9676 9677 9678
		/**
		 * The active [comment thread](#CommentThread)
		 */
P
Peng Lyu 已提交
9679 9680
		thread: CommentThread;

P
Peng Lyu 已提交
9681 9682 9683
		/**
		 * The value in the comment editor
		 */
P
Peng Lyu 已提交
9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714
		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 已提交
9715
		 * If not provided, users can leave comments in any document opened in the editor.
P
Peng Lyu 已提交
9716 9717 9718 9719 9720 9721 9722
		 */
		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.
		 *
9723
		 * @param uri The uri of the document the thread has been created on.
P
Peng Lyu 已提交
9724 9725 9726
		 * @param range The range the comment thread is located within the document.
		 * @param comments The ordered comments of the thread.
		 */
9727
		createCommentThread(uri: Uri, range: Range, comments: Comment[]): CommentThread;
P
Peng Lyu 已提交
9728

P
Peng Lyu 已提交
9729 9730 9731 9732 9733
		/**
		 * Optional reaction handler for creating and deleting reactions on a [comment](#Comment).
		 */
		reactionHandler?: (comment: Comment, reaction: CommentReaction) => Promise<void>;

P
Peng Lyu 已提交
9734 9735 9736 9737 9738 9739 9740 9741 9742
		/**
		 * 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 已提交
9743
	namespace comments {
P
Peng Lyu 已提交
9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754
		/**
		 * 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 已提交
9755 9756 9757 9758
}

/**
 * Thenable is a common denominator between ES6 promises, Q, jquery.Deferred, WinJS.Promise,
9759
 * and others. This API makes no assumption about what promise library is being used which
E
Erich Gamma 已提交
9760
 * enables reusing existing code without migrating to a specific promise implementation. Still,
J
Johannes Rieken 已提交
9761
 * we recommend the use of native promises which are available in this editor.
E
Erich Gamma 已提交
9762
 */
9763
interface Thenable<T> {
E
Erich Gamma 已提交
9764 9765 9766 9767 9768 9769
	/**
	* 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.
	*/
9770 9771
	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 已提交
9772
}