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

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

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

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

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

31
		/**
N
Nick Schonning 已提交
32
		 * A tooltip for the command, when represented in the UI.
33 34 35
		 */
		tooltip?: string;

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

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

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

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

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

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

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

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

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

		/**
J
Johannes Rieken 已提交
91 92 93 94 95 96 97
		 * The associated uri for this document.
		 *
		 * *Note* that most documents use the `file`-scheme, which means they are files on disk. However, **not** all documents are
		 * saved on disk and therefore the `scheme` must be checked before trying to access the underlying file or siblings on disk.
		 *
		 * @see [FileSystemProvider](#FileSystemProvider)
		 * @see [TextDocumentContentProvider](#TextDocumentContentProvider)
E
Erich Gamma 已提交
98
		 */
Y
Yuki Ueda 已提交
99
		readonly uri: Uri;
E
Erich Gamma 已提交
100 101

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

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

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

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

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

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

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

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

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

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

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

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

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

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

		/**
J
Johannes Rieken 已提交
207
		 * Get a word-range at the given position. By default words are defined by
208
		 * common separators, like space, -, _, etc. In addition, per language custom
209
		 * [word definitions](#LanguageConfiguration.wordPattern) can be defined. It
210 211 212 213 214 215 216
		 * is also possible to provide a custom regular expression.
		 *
		 * * *Note 1:* A custom regular expression must not match the empty string and
		 * if it does, it will be ignored.
		 * * *Note 2:* A custom regular expression will fail to match multiline strings
		 * and in the name of speed regular expressions should not match words with
		 * spaces. Use [`TextLine.text`](#TextLine.text) for more complex, non-wordy, scenarios.
J
Johannes Rieken 已提交
217
		 *
A
Alex Dima 已提交
218 219
		 * The position will be [adjusted](#TextDocument.validatePosition).
		 *
J
Johannes Rieken 已提交
220
		 * @param position A position.
221
		 * @param regex Optional regular expression that describes what a word is.
J
Johannes Rieken 已提交
222
		 * @return A range spanning a word, or `undefined`.
E
Erich Gamma 已提交
223
		 */
224
		getWordRangeAtPosition(position: Position, regex?: RegExp): Range | undefined;
E
Erich Gamma 已提交
225 226

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

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

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

		/**
		 * The zero-based line value.
		 */
Y
Yuki Ueda 已提交
256
		readonly line: number;
E
Erich Gamma 已提交
257 258 259 260

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

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

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

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

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

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

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

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

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

334 335 336 337 338 339 340 341 342
		/**
		 * Derived a new position relative to this position.
		 *
		 * @param change An object that describes a delta to this position.
		 * @return A position that reflects the given delta. Will return `this` position if the change
		 * is not changing anything.
		 */
		translate(change: { lineDelta?: number; characterDelta?: number; }): Position;

E
Erich Gamma 已提交
343
		/**
A
Alex Dima 已提交
344 345
		 * Create a new position derived from this position.
		 *
E
Erich Gamma 已提交
346 347
		 * @param line Value that should be used as line value, default is the [existing value](#Position.line)
		 * @param character Value that should be used as character value, default is the [existing value](#Position.character)
A
Alex Dima 已提交
348
		 * @return A position where line and character are replaced by the given values.
E
Erich Gamma 已提交
349 350
		 */
		with(line?: number, character?: number): Position;
351 352 353 354 355 356 357 358 359

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

	/**
	 * A range represents an ordered pair of two positions.
A
Alex Dima 已提交
364
	 * It is guaranteed that [start](#Range.start).isBeforeOrEqual([end](#Range.end))
E
Erich Gamma 已提交
365 366 367 368 369 370 371 372
	 *
	 * Range objects are __immutable__. Use the [with](#Range.with),
	 * [intersection](#Range.intersection), or [union](#Range.union) methods
	 * to derive new ranges from an existing range.
	 */
	export class Range {

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

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

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

		/**
A
Alex Dima 已提交
392 393
		 * Create a new range from number coordinates. It is a shorter equivalent of
		 * using `new Range(new Position(startLine, startCharacter), new Position(endLine, endCharacter))`
J
Johannes Rieken 已提交
394
		 *
A
Alex Dima 已提交
395 396 397 398
		 * @param startLine A zero-based line value.
		 * @param startCharacter A zero-based character value.
		 * @param endLine A zero-based line value.
		 * @param endCharacter A zero-based character value.
E
Erich Gamma 已提交
399
		 */
J
Johannes Rieken 已提交
400
		constructor(startLine: number, startCharacter: number, endLine: number, endCharacter: number);
E
Erich Gamma 已提交
401 402

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

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

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

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

		/**
A
Alex Dima 已提交
431 432 433 434
		 * Intersect `range` with this range and returns a new range or `undefined`
		 * if the ranges have no overlap.
		 *
		 * @param range A range.
E
Erich Gamma 已提交
435 436 437
		 * @return A range of the greater start and smaller end positions. Will
		 * return undefined when there is no overlap.
		 */
438
		intersection(range: Range): Range | undefined;
E
Erich Gamma 已提交
439 440

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

		/**
449
		 * Derived a new range from this range.
A
Alex Dima 已提交
450
		 *
E
Erich Gamma 已提交
451 452 453
		 * @param start A position that should be used as start. The default value is the [current start](#Range.start).
		 * @param end A position that should be used as end. The default value is the [current end](#Range.end).
		 * @return A range derived from this range with the given start and end position.
454
		 * If start and end are not different `this` range will be returned.
E
Erich Gamma 已提交
455 456
		 */
		with(start?: Position, end?: Position): Range;
457 458 459 460 461 462 463 464

		/**
		 * Derived a new range from this range.
		 *
		 * @param change An object that describes a change to this range.
		 * @return A range that reflects the given change. Will return `this` range if the change
		 * is not changing anything.
		 */
J
Johannes Rieken 已提交
465
		with(change: { start?: Position, end?: Position }): Range;
E
Erich Gamma 已提交
466 467 468 469 470 471 472 473 474
	}

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

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

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

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

		/**
A
Alex Dima 已提交
494
		 * Create a selection from four coordinates.
J
Johannes Rieken 已提交
495
		 *
A
Alex Dima 已提交
496 497 498 499
		 * @param anchorLine A zero-based line value.
		 * @param anchorCharacter A zero-based character value.
		 * @param activeLine A zero-based line value.
		 * @param activeCharacter A zero-based character value.
E
Erich Gamma 已提交
500
		 */
J
Johannes Rieken 已提交
501
		constructor(anchorLine: number, anchorCharacter: number, activeLine: number, activeCharacter: number);
A
Alex Dima 已提交
502

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

509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
	/**
	 * Represents sources that can cause [selection change events](#window.onDidChangeTextEditorSelection).
	*/
	export enum TextEditorSelectionChangeKind {
		/**
		 * Selection changed due to typing in the editor.
		 */
		Keyboard = 1,
		/**
		 * Selection change due to clicking in the editor.
		 */
		Mouse = 2,
		/**
		 * Selection changed because a command ran.
		 */
		Command = 3
	}

A
Alex Dima 已提交
527 528 529
	/**
	 * Represents an event describing the change in a [text editor's selections](#TextEditor.selections).
	 */
J
Johannes Rieken 已提交
530
	export interface TextEditorSelectionChangeEvent {
A
Alex Dima 已提交
531 532 533
		/**
		 * The [text editor](#TextEditor) for which the selections have changed.
		 */
534
		readonly textEditor: TextEditor;
A
Alex Dima 已提交
535 536 537
		/**
		 * The new value for the [text editor's selections](#TextEditor.selections).
		 */
538
		readonly selections: ReadonlyArray<Selection>;
539 540 541 542
		/**
		 * The [change kind](#TextEditorSelectionChangeKind) which has triggered this
		 * event. Can be `undefined`.
		 */
543
		readonly kind?: TextEditorSelectionChangeKind;
J
Johannes Rieken 已提交
544 545
	}

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

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

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

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

618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
	/**
	 * Rendering style of the line numbers.
	 */
	export enum TextEditorLineNumbersStyle {
		/**
		 * Do not render the line numbers.
		 */
		Off = 0,
		/**
		 * Render the line numbers.
		 */
		On = 1,
		/**
		 * Render the line numbers with values relative to the primary cursor location.
		 */
		Relative = 2
	}

E
Erich Gamma 已提交
636
	/**
A
Alex Dima 已提交
637
	 * Represents a [text editor](#TextEditor)'s [options](#TextEditor.options).
E
Erich Gamma 已提交
638 639 640 641
	 */
	export interface TextEditorOptions {

		/**
A
Alex Dima 已提交
642 643
		 * The size in spaces a tab takes. This is used for two purposes:
		 *  - the rendering width of a tab character;
644
		 *  - the number of spaces to insert when [insertSpaces](#TextEditorOptions.insertSpaces) is true.
J
Johannes Rieken 已提交
645
		 *
646 647
		 * When getting a text editor's options, this property will always be a number (resolved).
		 * When setting a text editor's options, this property is optional and it can be a number or `"auto"`.
E
Erich Gamma 已提交
648
		 */
649
		tabSize?: number | string;
E
Erich Gamma 已提交
650 651 652

		/**
		 * When pressing Tab insert [n](#TextEditorOptions.tabSize) spaces.
653 654
		 * When getting a text editor's options, this property will always be a boolean (resolved).
		 * When setting a text editor's options, this property is optional and it can be a boolean or `"auto"`.
E
Erich Gamma 已提交
655
		 */
656
		insertSpaces?: boolean | string;
A
Alex Dima 已提交
657 658 659 660 661 662 663

		/**
		 * The rendering style of the cursor in this editor.
		 * When getting a text editor's options, this property will always be present.
		 * When setting a text editor's options, this property is optional.
		 */
		cursorStyle?: TextEditorCursorStyle;
664 665 666 667 668 669

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

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

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

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

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

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

727
	/**
728
	 * Describes the behavior of decorations when typing/editing at their edges.
729
	 */
730
	export enum DecorationRangeBehavior {
A
Alex Dima 已提交
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
		/**
		 * The decoration's range will widen when edits occur at the start or end.
		 */
		OpenOpen = 0,
		/**
		 * The decoration's range will not widen when edits occur at the start of end.
		 */
		ClosedClosed = 1,
		/**
		 * The decoration's range will widen when edits occur at the start, but not at the end.
		 */
		OpenClosed = 2,
		/**
		 * The decoration's range will widen when edits occur at the end, but not at the start.
		 */
		ClosedOpen = 3
747 748
	}

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

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

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

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

779 780 781 782 783 784 785 786 787 788 789 790 791
	/**
	 * A reference to one of the workbench colors as defined in https://code.visualstudio.com/docs/getstarted/theme-color-reference.
	 * Using a theme color is preferred over a custom color as it gives theme authors and users the possibility to change the color.
	 */
	export class ThemeColor {

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

792
	/**
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. To avoid breakage of existing code the optional
		 * `strict`-argument has been added. We *strongly* advise to use it, e.g. `Uri.parse('my:uri', true)`
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
Wording  
Matt Bierner 已提交
2012 2013 2014
		 * Source code actions apply to the entire file. They must be explicitly requested and will not show in the
		 * normal [light bulb](https://code.visualstudio.com/docs/editor/editingevolved#_code-action) menu. Source actions
		 * can be run on save using `editor.codeActionsOnSave` and are also shown in the `source` context menu.
M
Matt Bierner 已提交
2015 2016 2017
		 */
		static readonly Source: CodeActionKind;

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

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

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

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

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

		/**
		 * 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 已提交
2082 2083
	}

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

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

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

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

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

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

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

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

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

2161 2162 2163 2164 2165 2166 2167 2168 2169 2170
	/**
	 * 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`)`
		 */
2171
		readonly providedCodeActionKinds?: ReadonlyArray<CodeActionKind>;
2172 2173
	}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310
	/**
	 * 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 已提交
2311
		provideTypeDefinition(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Definition | DefinitionLink[]>;
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 2337
	/**
	 * 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 已提交
2338
	/**
2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358
	 * 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.
E
Eric Amodio 已提交
2359
		 * @param supportThemeIcons Optional, Specifies whether [ThemeIcons](#ThemeIcon) are supported within the [`MarkdownString`](#MarkdownString).
2360
		 */
E
Eric Amodio 已提交
2361
		constructor(value?: string, supportThemeIcons?: boolean);
2362 2363 2364 2365 2366 2367 2368 2369

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

		/**
E
Eric Amodio 已提交
2370
		 * Appends the given string 'as is' to this markdown string. When [`supportThemeIcons`](#MarkdownString.supportThemeIcons) is `true`, [ThemeIcons](#ThemeIcon) in the `value` will be iconified.
2371 2372 2373
		 * @param value Markdown string.
		 */
		appendMarkdown(value: string): MarkdownString;
J
Johannes Rieken 已提交
2374 2375 2376 2377 2378 2379 2380

		/**
		 * 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;
2381 2382 2383 2384
	}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

		/**
		 * 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 已提交
2484 2485
	}

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

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

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

2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

J
Johannes Rieken 已提交
2837 2838 2839 2840 2841 2842 2843 2844
		/**
		 * 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 已提交
2845

J
Johannes Rieken 已提交
2846 2847 2848 2849 2850 2851 2852 2853
		/**
		 * 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 已提交
2854

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

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

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

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

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

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

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

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

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

O
okmttdhr 已提交
2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982
		/**
		 * Builder-function that appends a choice (`${1|a,b,c}`) to
		 * the [`value`](#SnippetString.value) of this snippet string.
		 *
		 * @param values The values for choices - the array of strings
		 * @param number The number of this tabstop, defaults to an auto-increment
		 * value starting at 1.
		 * @return This snippet string.
		 */
		appendChoice(values: string[], number?: number): SnippetString;

2983
		/**
J
Johannes Rieken 已提交
2984
		 * Builder-function that appends a variable (`${VAR}`) to
2985 2986 2987 2988 2989 2990 2991 2992
		 * 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;
2993 2994
	}

E
Erich Gamma 已提交
2995
	/**
J
Johannes Rieken 已提交
2996 2997
	 * 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 已提交
2998 2999
	 */
	export interface RenameProvider {
J
Johannes Rieken 已提交
3000 3001 3002 3003 3004 3005 3006 3007 3008 3009

		/**
		 * 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 已提交
3010
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
3011
		 */
3012
		provideRenameEdits(document: TextDocument, position: Position, newName: string, token: CancellationToken): ProviderResult<WorkspaceEdit>;
J
Johannes Rieken 已提交
3013 3014 3015

		/**
		 * Optional function for resolving and validating a position *before* running rename. The result can
3016
		 * be a range or a range and a placeholder text. The placeholder text should be the identifier of the symbol
J
Johannes Rieken 已提交
3017 3018
		 * which is being renamed - when omitted the text in the returned range is used.
		 *
J
Johannes Rieken 已提交
3019 3020 3021
		 * *Note: * This function should throw an error or return a rejected thenable when the provided location
		 * doesn't allow for a rename.
		 *
J
Johannes Rieken 已提交
3022 3023 3024 3025 3026
		 * @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`.
		 */
3027
		prepareRename?(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Range | { range: Range, placeholder: string }>;
E
Erich Gamma 已提交
3028 3029
	}

J
Johannes Rieken 已提交
3030 3031 3032
	/**
	 * Value-object describing what options formatting should use.
	 */
E
Erich Gamma 已提交
3033
	export interface FormattingOptions {
J
Johannes Rieken 已提交
3034 3035 3036 3037

		/**
		 * Size of a tab in spaces.
		 */
E
Erich Gamma 已提交
3038
		tabSize: number;
J
Johannes Rieken 已提交
3039 3040 3041 3042

		/**
		 * Prefer spaces over tabs.
		 */
E
Erich Gamma 已提交
3043
		insertSpaces: boolean;
J
Johannes Rieken 已提交
3044 3045 3046 3047 3048

		/**
		 * Signature for further properties.
		 */
		[key: string]: boolean | number | string;
E
Erich Gamma 已提交
3049 3050 3051
	}

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

		/**
		 * 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 已提交
3064
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
3065
		 */
3066
		provideDocumentFormattingEdits(document: TextDocument, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
3067 3068 3069
	}

	/**
J
Johannes Rieken 已提交
3070 3071
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
3072 3073
	 */
	export interface DocumentRangeFormattingEditProvider {
J
Johannes Rieken 已提交
3074 3075 3076 3077 3078

		/**
		 * 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 已提交
3079 3080
		 * or larger range. Often this is done by adjusting the start and end
		 * of the range to full syntax nodes.
J
Johannes Rieken 已提交
3081 3082 3083 3084 3085 3086
		 *
		 * @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 已提交
3087
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
3088
		 */
3089
		provideDocumentRangeFormattingEdits(document: TextDocument, range: Range, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
3090 3091 3092
	}

	/**
J
Johannes Rieken 已提交
3093 3094
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
3095 3096
	 */
	export interface OnTypeFormattingEditProvider {
J
Johannes Rieken 已提交
3097 3098 3099 3100 3101 3102 3103 3104 3105 3106

		/**
		 * 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 已提交
3107
		 * @param ch The character that has been typed.
J
Johannes Rieken 已提交
3108 3109 3110
		 * @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 已提交
3111
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
3112
		 */
3113
		provideOnTypeFormattingEdits(document: TextDocument, position: Position, ch: string, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
3114 3115
	}

J
Johannes Rieken 已提交
3116 3117 3118 3119
	/**
	 * Represents a parameter of a callable-signature. A parameter can
	 * have a label and a doc-comment.
	 */
E
Erich Gamma 已提交
3120
	export class ParameterInformation {
J
Johannes Rieken 已提交
3121 3122

		/**
3123 3124 3125 3126 3127
		 * 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 已提交
3128
		 */
3129
		label: string | [number, number];
J
Johannes Rieken 已提交
3130 3131 3132 3133 3134

		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
3135
		documentation?: string | MarkdownString;
J
Johannes Rieken 已提交
3136 3137 3138 3139

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

J
Johannes Rieken 已提交
3146 3147 3148 3149 3150
	/**
	 * 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 已提交
3151
	export class SignatureInformation {
J
Johannes Rieken 已提交
3152 3153 3154 3155 3156

		/**
		 * The label of this signature. Will be shown in
		 * the UI.
		 */
E
Erich Gamma 已提交
3157
		label: string;
J
Johannes Rieken 已提交
3158 3159 3160 3161 3162

		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
3163
		documentation?: string | MarkdownString;
J
Johannes Rieken 已提交
3164 3165 3166 3167

		/**
		 * The parameters of this signature.
		 */
E
Erich Gamma 已提交
3168
		parameters: ParameterInformation[];
J
Johannes Rieken 已提交
3169 3170 3171 3172 3173

		/**
		 * Creates a new signature information object.
		 *
		 * @param label A label string.
J
Johannes Rieken 已提交
3174
		 * @param documentation A doc string.
J
Johannes Rieken 已提交
3175
		 */
3176
		constructor(label: string, documentation?: string | MarkdownString);
E
Erich Gamma 已提交
3177 3178
	}

J
Johannes Rieken 已提交
3179 3180
	/**
	 * Signature help represents the signature of something
S
Steven Clarke 已提交
3181
	 * callable. There can be multiple signatures but only one
J
Johannes Rieken 已提交
3182 3183
	 * active and only one active parameter.
	 */
E
Erich Gamma 已提交
3184
	export class SignatureHelp {
J
Johannes Rieken 已提交
3185 3186 3187 3188

		/**
		 * One or more signatures.
		 */
E
Erich Gamma 已提交
3189
		signatures: SignatureInformation[];
J
Johannes Rieken 已提交
3190 3191 3192 3193

		/**
		 * The active signature.
		 */
E
Erich Gamma 已提交
3194
		activeSignature: number;
J
Johannes Rieken 已提交
3195 3196 3197 3198

		/**
		 * The active parameter of the active signature.
		 */
E
Erich Gamma 已提交
3199 3200 3201
		activeParameter: number;
	}

3202
	/**
3203
	 * How a [`SignatureHelpProvider`](#SignatureHelpProvider) was triggered.
3204
	 */
M
Matt Bierner 已提交
3205
	export enum SignatureHelpTriggerKind {
3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229
		/**
		 * 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.
		 */
3230
		readonly triggerKind: SignatureHelpTriggerKind;
3231 3232 3233 3234 3235 3236 3237 3238 3239 3240

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

		/**
3241
		 * `true` if signature help was already showing when it was triggered.
3242
		 *
M
Matt Bierner 已提交
3243 3244
		 * 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.
3245 3246
		 */
		readonly isRetrigger: boolean;
3247 3248 3249 3250 3251 3252 3253 3254

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

J
Johannes Rieken 已提交
3257 3258
	/**
	 * The signature help provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
3259
	 * the [parameter hints](https://code.visualstudio.com/docs/editor/intellisense)-feature.
J
Johannes Rieken 已提交
3260
	 */
E
Erich Gamma 已提交
3261
	export interface SignatureHelpProvider {
J
Johannes Rieken 已提交
3262 3263 3264 3265 3266 3267 3268

		/**
		 * 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.
3269 3270
		 * @param context Information about how signature help was triggered.
		 *
J
Johannes Rieken 已提交
3271
		 * @return Signature help or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
3272
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
3273
		 */
3274 3275 3276 3277
		provideSignatureHelp(document: TextDocument, position: Position, token: CancellationToken, context: SignatureHelpContext): ProviderResult<SignatureHelp>;
	}

	/**
3278 3279
	 * Metadata about a registered [`SignatureHelpProvider`](#SignatureHelpProvider).
	 */
3280 3281 3282 3283 3284 3285 3286 3287 3288
	export interface SignatureHelpProviderMetadata {
		/**
		 * List of characters that trigger signature help.
		 */
		readonly triggerCharacters: ReadonlyArray<string>;

		/**
		 * List of characters that re-trigger signature help.
		 *
3289
		 * These trigger characters are only active when signature help is already showing. All trigger characters
3290 3291 3292
		 * are also counted as re-trigger characters.
		 */
		readonly retriggerCharacters: ReadonlyArray<string>;
E
Erich Gamma 已提交
3293 3294
	}

J
Johannes Rieken 已提交
3295 3296 3297
	/**
	 * Completion item kinds.
	 */
E
Erich Gamma 已提交
3298
	export enum CompletionItemKind {
3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314
		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,
3315
		Reference = 17,
3316
		File = 16,
3317 3318 3319 3320 3321
		Folder = 18,
		EnumMember = 19,
		Constant = 20,
		Struct = 21,
		Event = 22,
3322 3323
		Operator = 23,
		TypeParameter = 24
E
Erich Gamma 已提交
3324 3325
	}

3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336
	/**
	 * 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 已提交
3337
	/**
3338
	 * A completion item represents a text snippet that is proposed to complete text that is being typed.
J
Johannes Rieken 已提交
3339
	 *
3340
	 * It is sufficient to create a completion item from just a [label](#CompletionItem.label). In that
3341 3342
	 * case the completion item will replace the [word](#TextDocument.getWordRangeAtPosition)
	 * until the cursor with the given label or [insertText](#CompletionItem.insertText). Otherwise the
3343
	 * given [edit](#CompletionItem.textEdit) is used.
3344
	 *
3345
	 * When selecting a completion item in the editor its defined or synthesized text edit will be applied
M
Matthew J. Clemente 已提交
3346
	 * to *all* cursors/selections whereas [additionalTextEdits](#CompletionItem.additionalTextEdits) will be
3347
	 * applied as provided.
3348
	 *
J
Johannes Rieken 已提交
3349 3350
	 * @see [CompletionItemProvider.provideCompletionItems](#CompletionItemProvider.provideCompletionItems)
	 * @see [CompletionItemProvider.resolveCompletionItem](#CompletionItemProvider.resolveCompletionItem)
J
Johannes Rieken 已提交
3351
	 */
E
Erich Gamma 已提交
3352
	export class CompletionItem {
J
Johannes Rieken 已提交
3353 3354 3355

		/**
		 * The label of this completion item. By default
A
Andre Weinand 已提交
3356
		 * this is also the text that is inserted when selecting
J
Johannes Rieken 已提交
3357 3358
		 * this completion.
		 */
E
Erich Gamma 已提交
3359
		label: string;
J
Johannes Rieken 已提交
3360 3361

		/**
S
Steven Clarke 已提交
3362
		 * The kind of this completion item. Based on the kind
J
Johannes Rieken 已提交
3363 3364
		 * an icon is chosen by the editor.
		 */
3365
		kind?: CompletionItemKind;
J
Johannes Rieken 已提交
3366

3367 3368 3369 3370 3371
		/**
		 * Tags for this completion item.
		 */
		tags?: ReadonlyArray<CompletionItemTag>;

J
Johannes Rieken 已提交
3372 3373 3374 3375
		/**
		 * A human-readable string with additional information
		 * about this item, like type or symbol information.
		 */
3376
		detail?: string;
J
Johannes Rieken 已提交
3377 3378 3379 3380

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

		/**
A
Andre Weinand 已提交
3384
		 * A string that should be used when comparing this item
J
Johannes Rieken 已提交
3385 3386 3387
		 * with other items. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
3388
		sortText?: string;
J
Johannes Rieken 已提交
3389 3390 3391 3392 3393 3394

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

3397 3398 3399 3400 3401 3402 3403
		/**
		 * 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 已提交
3404
		/**
3405
		 * A string or snippet that should be inserted in a document when selecting
J
Johannes Rieken 已提交
3406 3407 3408
		 * this completion. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
3409
		insertText?: string | SnippetString;
3410 3411

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

3422 3423
		/**
		 * An optional set of characters that when pressed while this completion is active will accept it first and
J
Johannes Rieken 已提交
3424
		 * then type that character. *Note* that all commit characters should have `length=1` and that superfluous
3425 3426 3427 3428
		 * characters will be ignored.
		 */
		commitCharacters?: string[];

3429 3430
		/**
		 * Keep whitespace of the [insertText](#CompletionItem.insertText) as is. By default, the editor adjusts leading
3431
		 * whitespace of new lines so that they match the indentation of the line for which the item is accepted - setting
3432 3433 3434 3435
		 * this to `true` will prevent that.
		 */
		keepWhitespace?: boolean;

J
Johannes Rieken 已提交
3436
		/**
3437
		 * @deprecated Use `CompletionItem.insertText` and `CompletionItem.range` instead.
3438 3439
		 *
		 * ~~An [edit](#TextEdit) which is applied to a document when selecting
J
Johannes Rieken 已提交
3440
		 * this completion. When an edit is provided the value of
3441
		 * [insertText](#CompletionItem.insertText) is ignored.~~
3442
		 *
3443 3444
		 * ~~The [range](#Range) of the edit must be single-line and on the same
		 * line completions were [requested](#CompletionItemProvider.provideCompletionItems) at.~~
J
Johannes Rieken 已提交
3445
		 */
3446
		textEdit?: TextEdit;
J
Johannes Rieken 已提交
3447

3448 3449 3450 3451 3452
		/**
		 * 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.
		 */
3453
		additionalTextEdits?: TextEdit[];
3454 3455

		/**
3456 3457
		 * An optional [command](#Command) that is executed *after* inserting this completion. *Note* that
		 * additional modifications to the current document should be described with the
3458 3459
		 * [additionalTextEdits](#CompletionItem.additionalTextEdits)-property.
		 */
3460
		command?: Command;
3461

J
Johannes Rieken 已提交
3462 3463 3464 3465 3466 3467 3468
		/**
		 * 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.
3469
		 * @param kind The [kind](#CompletionItemKind) of the completion.
J
Johannes Rieken 已提交
3470
		 */
3471
		constructor(label: string, kind?: CompletionItemKind);
E
Erich Gamma 已提交
3472 3473
	}

3474 3475 3476 3477
	/**
	 * Represents a collection of [completion items](#CompletionItem) to be presented
	 * in the editor.
	 */
J
Johannes Rieken 已提交
3478
	export class CompletionList {
3479 3480

		/**
3481
		 * This list is not complete. Further typing should result in recomputing
3482 3483
		 * this list.
		 */
3484
		isIncomplete?: boolean;
3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499

		/**
		 * 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 已提交
3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510
	/**
	 * How a [completion provider](#CompletionItemProvider) was triggered
	 */
	export enum CompletionTriggerKind {
		/**
		 * Completion was triggered normally.
		 */
		Invoke = 0,
		/**
		 * Completion was triggered by a trigger character.
		 */
3511 3512 3513 3514 3515
		TriggerCharacter = 1,
		/**
		 * Completion was re-triggered as current completion list is incomplete
		 */
		TriggerForIncompleteCompletions = 2
M
Matt Bierner 已提交
3516 3517
	}

3518 3519 3520 3521 3522
	/**
	 * Contains additional information about the context in which
	 * [completion provider](#CompletionItemProvider.provideCompletionItems) is triggered.
	 */
	export interface CompletionContext {
3523 3524 3525
		/**
		 * How the completion was triggered.
		 */
M
Matt Bierner 已提交
3526
		readonly triggerKind: CompletionTriggerKind;
3527

3528 3529 3530
		/**
		 * Character that triggered the completion item provider.
		 *
M
Matt Bierner 已提交
3531
		 * `undefined` if provider was not triggered by a character.
M
Matt Bierner 已提交
3532 3533
		 *
		 * The trigger character is already in the document when the completion provider is triggered.
3534 3535 3536 3537
		 */
		readonly triggerCharacter?: string;
	}

J
Johannes Rieken 已提交
3538 3539
	/**
	 * The completion item provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
3540
	 * [IntelliSense](https://code.visualstudio.com/docs/editor/intellisense).
J
Johannes Rieken 已提交
3541
	 *
3542 3543 3544
	 * 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
3545
	 * are needed for the initial sorting and filtering, like `sortText`, `filterText`, `insertText`, and `range`, must
3546
	 * not be changed during resolve.
3547 3548 3549
	 *
	 * 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 已提交
3550
	 */
E
Erich Gamma 已提交
3551
	export interface CompletionItemProvider {
J
Johannes Rieken 已提交
3552 3553

		/**
J
Johannes Rieken 已提交
3554
		 * Provide completion items for the given position and document.
J
Johannes Rieken 已提交
3555
		 *
J
Johannes Rieken 已提交
3556 3557 3558
		 * @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 已提交
3559 3560
		 * @param context How the completion was triggered.
		 *
3561 3562
		 * @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 已提交
3563
		 */
M
Matt Bierner 已提交
3564
		provideCompletionItems(document: TextDocument, position: Position, token: CancellationToken, context: CompletionContext): ProviderResult<CompletionItem[] | CompletionList>;
J
Johannes Rieken 已提交
3565 3566

		/**
J
Johannes Rieken 已提交
3567 3568 3569 3570
		 * 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 已提交
3571
		 *
3572 3573 3574 3575
		 * *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 已提交
3576 3577
		 * @param item A completion item currently active in the UI.
		 * @param token A cancellation token.
S
Steven Clarke 已提交
3578
		 * @return The resolved completion item or a thenable that resolves to of such. It is OK to return the given
J
Johannes Rieken 已提交
3579
		 * `item`. When no result is returned, the given `item` will be used.
J
Johannes Rieken 已提交
3580
		 */
3581
		resolveCompletionItem?(item: CompletionItem, token: CancellationToken): ProviderResult<CompletionItem>;
E
Erich Gamma 已提交
3582 3583
	}

J
Johannes Rieken 已提交
3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598

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

M
Matt Bierner 已提交
3601 3602 3603 3604
		/**
		 * 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
3605
		 * trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS,
M
Matt Bierner 已提交
3606 3607 3608 3609
		 * user settings, and localization.
		 */
		tooltip?: string;

J
Johannes Rieken 已提交
3610 3611 3612 3613 3614 3615
		/**
		 * 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.
		 */
3616
		constructor(range: Range, target?: Uri);
J
Johannes Rieken 已提交
3617 3618 3619 3620 3621 3622 3623 3624 3625
	}

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

		/**
3626 3627 3628
		 * 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 已提交
3629 3630 3631
		 * @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
3632
		 * can be signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
3633
		 */
3634
		provideDocumentLinks(document: TextDocument, token: CancellationToken): ProviderResult<DocumentLink[]>;
3635 3636 3637

		/**
		 * Given a link fill in its [target](#DocumentLink.target). This method is called when an incomplete
3638
		 * link is selected in the UI. Providers can implement this method and return incomplete links
3639 3640 3641 3642 3643 3644
		 * (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.
		 */
3645
		resolveDocumentLink?(link: DocumentLink, token: CancellationToken): ProviderResult<DocumentLink>;
J
Johannes Rieken 已提交
3646 3647
	}

3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677
	/**
	 * 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.
3678
		 * @param blue The blue component.
3679 3680 3681 3682 3683 3684 3685 3686 3687
		 * @param alpha The alpha component.
		 */
		constructor(red: number, green: number, blue: number, alpha: number);
	}

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

3689
		/**
3690
		 * The range in the document where this color appears.
3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714
		 */
		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
3715
	 * apply, e.g. `System.Drawing.Color.Red`.
3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757
	 */
	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.
3758
		 * @return An array of [color information](#ColorInformation) or a thenable that resolves to such. The lack of a result
3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773
		 * 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[]>;
	}
3774

3775
	/**
F
Filipe Correia 已提交
3776
	 * 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.
3777 3778
	 * Invalid ranges will be ignored.
	 */
3779 3780 3781 3782
	export class FoldingRange {

		/**
		 * The zero-based start line of the range to fold. The folded area starts after the line's last character.
3783
		 * To be valid, the end must be zero or larger and smaller than the number of lines in the document.
3784 3785 3786 3787 3788
		 */
		start: number;

		/**
		 * The zero-based end line of the range to fold. The folded area ends with the line's last character.
3789
		 * To be valid, the end must be zero or larger and smaller than the number of lines in the document.
3790 3791 3792 3793 3794 3795 3796
		 */
		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
3797
		 * [FoldingRangeKind](#FoldingRangeKind) for an enumeration of all kinds.
3798
		 * If not set, the range is originated from a syntax element.
3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811
		 */
		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);
	}

3812
	/**
3813 3814 3815 3816
	 * 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.
3817
	 */
3818
	export enum FoldingRangeKind {
3819
		/**
3820
		 * Kind for folding range representing a comment.
3821
		 */
3822
		Comment = 1,
3823
		/**
3824
		 * Kind for folding range representing a import.
3825
		 */
3826
		Imports = 2,
3827
		/**
3828
		 * Kind for folding range representing regions originating from folding markers like `#region` and `#endregion`.
3829
		 */
3830
		Region = 3
3831 3832 3833 3834 3835 3836 3837 3838
	}

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

3839 3840 3841 3842
	/**
	 * The folding range provider interface defines the contract between extensions and
	 * [Folding](https://code.visualstudio.com/docs/editor/codebasics#_folding) in the editor.
	 */
3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853
	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[]>;
	}

3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882
	/**
	 * 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.
		 *
3883
		 * Selection ranges should be computed individually and independent for each position. The editor will merge
3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895
		 * 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[]>;
	}

3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011
	/**
	 * Represents programming constructs like functions or constructors in the context
	 * of call hierarchy.
	 */
	export class CallHierarchyItem {
		/**
		 * The name of this item.
		 */
		name: string;

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

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

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

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

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

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

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

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

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

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

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

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

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

		/**
		 * The range at which this item is called. This is the range relative to the caller, e.g the item
		 * passed to [`provideCallHierarchyOutgoingCalls`](#CallHierarchyItemProvider.provideCallHierarchyOutgoingCalls)
		 * and not [`this.to`](#CallHierarchyOutgoingCall.to).
		 */
		fromRanges: Range[];

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

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

		/**
		 * Bootstraps call hierarchy by returning the item that is denoted by the given document
		 * and position. This item will be used as entry into the call graph. Providers should
		 * return `undefined` or `null` when there is no item at the given location.
		 *
		 * @param document The document in which the command was invoked.
		 * @param position The position at which the command was invoked.
		 * @param token A cancellation token.
		 * @returns A call hierarchy item or a thenable that resolves to such. The lack of a result can be
		 * signaled by returning `undefined` or `null`.
		 */
4012
		prepareCallHierarchy(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<CallHierarchyItem | CallHierarchyItem[]>;
4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038

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

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

J
Johannes Rieken 已提交
4039 4040 4041 4042
	/**
	 * A tuple of two characters, like a pair of
	 * opening and closing brackets.
	 */
E
Erich Gamma 已提交
4043 4044
	export type CharacterPair = [string, string];

J
Johannes Rieken 已提交
4045 4046 4047
	/**
	 * Describes how comments for a language work.
	 */
E
Erich Gamma 已提交
4048
	export interface CommentRule {
J
Johannes Rieken 已提交
4049 4050 4051 4052

		/**
		 * The line comment token, like `// this is a comment`
		 */
E
Erich Gamma 已提交
4053
		lineComment?: string;
J
Johannes Rieken 已提交
4054 4055 4056 4057 4058

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

A
Alex Dima 已提交
4061 4062 4063
	/**
	 * Describes indentation rules for a language.
	 */
E
Erich Gamma 已提交
4064
	export interface IndentationRule {
A
Alex Dima 已提交
4065
		/**
4066
		 * If a line matches this pattern, then all the lines after it should be unindented once (until another rule matches).
A
Alex Dima 已提交
4067
		 */
E
Erich Gamma 已提交
4068
		decreaseIndentPattern: RegExp;
A
Alex Dima 已提交
4069 4070 4071
		/**
		 * If a line matches this pattern, then all the lines after it should be indented once (until another rule matches).
		 */
E
Erich Gamma 已提交
4072
		increaseIndentPattern: RegExp;
A
Alex Dima 已提交
4073 4074 4075
		/**
		 * If a line matches this pattern, then **only the next line** after it should be indented once.
		 */
E
Erich Gamma 已提交
4076
		indentNextLinePattern?: RegExp;
A
Alex Dima 已提交
4077 4078 4079
		/**
		 * 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 已提交
4080 4081 4082
		unIndentedLinePattern?: RegExp;
	}

A
Alex Dima 已提交
4083 4084 4085
	/**
	 * Describes what to do with the indentation when pressing Enter.
	 */
E
Erich Gamma 已提交
4086
	export enum IndentAction {
A
Alex Dima 已提交
4087 4088 4089
		/**
		 * Insert new line and copy the previous line's indentation.
		 */
4090
		None = 0,
A
Alex Dima 已提交
4091 4092 4093
		/**
		 * Insert new line and indent once (relative to the previous line's indentation).
		 */
4094
		Indent = 1,
A
Alex Dima 已提交
4095 4096 4097 4098 4099
		/**
		 * Insert two new lines:
		 *  - the first one indented which will hold the cursor
		 *  - the second one at the same indentation level
		 */
4100
		IndentOutdent = 2,
A
Alex Dima 已提交
4101 4102 4103
		/**
		 * Insert new line and outdent once (relative to the previous line's indentation).
		 */
4104
		Outdent = 3
E
Erich Gamma 已提交
4105 4106
	}

A
Alex Dima 已提交
4107 4108 4109
	/**
	 * Describes what to do when pressing Enter.
	 */
E
Erich Gamma 已提交
4110
	export interface EnterAction {
A
Alex Dima 已提交
4111 4112 4113 4114 4115 4116 4117
		/**
		 * 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 已提交
4118
		appendText?: string;
A
Alex Dima 已提交
4119 4120 4121 4122
		/**
		 * Describes the number of characters to remove from the new line's indentation.
		 */
		removeText?: number;
E
Erich Gamma 已提交
4123 4124
	}

A
Alex Dima 已提交
4125 4126 4127
	/**
	 * Describes a rule to be evaluated when pressing Enter.
	 */
E
Erich Gamma 已提交
4128
	export interface OnEnterRule {
A
Alex Dima 已提交
4129 4130 4131
		/**
		 * This rule will only execute if the text before the cursor matches this regular expression.
		 */
E
Erich Gamma 已提交
4132
		beforeText: RegExp;
A
Alex Dima 已提交
4133 4134 4135
		/**
		 * This rule will only execute if the text after the cursor matches this regular expression.
		 */
E
Erich Gamma 已提交
4136
		afterText?: RegExp;
A
Alex Dima 已提交
4137 4138 4139
		/**
		 * The action to execute.
		 */
E
Erich Gamma 已提交
4140 4141 4142
		action: EnterAction;
	}

J
Johannes Rieken 已提交
4143
	/**
A
Andre Weinand 已提交
4144
	 * The language configuration interfaces defines the contract between extensions
S
Steven Clarke 已提交
4145
	 * and various editor features, like automatic bracket insertion, automatic indentation etc.
J
Johannes Rieken 已提交
4146
	 */
E
Erich Gamma 已提交
4147
	export interface LanguageConfiguration {
A
Alex Dima 已提交
4148 4149 4150
		/**
		 * The language's comment settings.
		 */
E
Erich Gamma 已提交
4151
		comments?: CommentRule;
A
Alex Dima 已提交
4152 4153 4154 4155
		/**
		 * The language's brackets.
		 * This configuration implicitly affects pressing Enter around these brackets.
		 */
E
Erich Gamma 已提交
4156
		brackets?: CharacterPair[];
A
Alex Dima 已提交
4157 4158 4159 4160 4161 4162 4163
		/**
		 * 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 已提交
4164
		wordPattern?: RegExp;
A
Alex Dima 已提交
4165 4166 4167
		/**
		 * The language's indentation settings.
		 */
E
Erich Gamma 已提交
4168
		indentationRules?: IndentationRule;
A
Alex Dima 已提交
4169 4170 4171
		/**
		 * The language's rules to be evaluated when pressing Enter.
		 */
E
Erich Gamma 已提交
4172 4173 4174
		onEnterRules?: OnEnterRule[];

		/**
A
Alex Dima 已提交
4175
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
4176 4177
		 *
		 * @deprecated Will be replaced by a better API soon.
E
Erich Gamma 已提交
4178 4179
		 */
		__electricCharacterSupport?: {
4180 4181 4182 4183 4184 4185
			/**
			 * This property is deprecated and will be **ignored** from
			 * the editor.
			 * @deprecated
			 */
			brackets?: any;
4186 4187 4188
			/**
			 * This property is deprecated and not fully supported anymore by
			 * the editor (scope and lineStart are ignored).
4189
			 * Use the autoClosingPairs property in the language configuration file instead.
4190 4191
			 * @deprecated
			 */
E
Erich Gamma 已提交
4192
			docComment?: {
A
Alex Dima 已提交
4193 4194 4195 4196
				scope: string;
				open: string;
				lineStart: string;
				close?: string;
E
Erich Gamma 已提交
4197 4198 4199 4200
			};
		};

		/**
A
Alex Dima 已提交
4201
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
4202
		 *
4203
		 * @deprecated * Use the autoClosingPairs property in the language configuration file instead.
E
Erich Gamma 已提交
4204 4205 4206 4207 4208 4209 4210 4211 4212 4213
		 */
		__characterPairSupport?: {
			autoClosingPairs: {
				open: string;
				close: string;
				notIn?: string[];
			}[];
		};
	}

J
Johannes Rieken 已提交
4214
	/**
S
Sandeep Somavarapu 已提交
4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235
	 * 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
4236
	 *
S
Sandeep Somavarapu 已提交
4237 4238 4239 4240
	 * - Default configuration
	 * - Global configuration
	 * - Workspace configuration (if available)
	 * - Workspace folder configuration of the requested resource (if available)
4241
	 *
4242
	 * *Global configuration* comes from User Settings and overrides Defaults.
S
Sandeep Somavarapu 已提交
4243
	 *
4244
	 * *Workspace configuration* comes from Workspace Settings and overrides Global configuration.
S
Sandeep Somavarapu 已提交
4245
	 *
4246
	 * *Workspace Folder configuration* comes from `.vscode` folder under one of the [workspace folders](#workspace.workspaceFolders) and overrides Workspace configuration.
S
Sandeep Somavarapu 已提交
4247 4248
	 *
	 * *Note:* Workspace and Workspace Folder configurations contains `launch` and `tasks` settings. Their basename will be
4249 4250 4251
	 * part of the section identifier. The following snippets shows how to retrieve all configurations
	 * from `launch.json`:
	 *
4252
	 * ```ts
D
Daniel Imms 已提交
4253
	 * // launch.json configuration
S
Sandeep Somavarapu 已提交
4254
	 * const config = workspace.getConfiguration('launch', vscode.window.activeTextEditor.document.uri);
4255 4256
	 *
	 * // retrieve values
D
Daniel Imms 已提交
4257 4258
	 * const values = config.get('configurations');
	 * ```
S
Sandeep Somavarapu 已提交
4259 4260
	 *
	 * Refer to [Settings](https://code.visualstudio.com/docs/getstarted/settings) for more information.
J
Johannes Rieken 已提交
4261
	 */
E
Erich Gamma 已提交
4262 4263
	export interface WorkspaceConfiguration {

4264 4265 4266 4267 4268 4269 4270 4271
		/**
		 * 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 已提交
4272
		/**
J
Johannes Rieken 已提交
4273 4274 4275
		 * Return a value from this configuration.
		 *
		 * @param section Configuration name, supports _dotted_ names.
J
Johannes Rieken 已提交
4276
		 * @param defaultValue A value should be returned when no value could be found, is `undefined`.
J
Johannes Rieken 已提交
4277
		 * @return The value `section` denotes or the default.
E
Erich Gamma 已提交
4278
		 */
4279 4280
		get<T>(section: string, defaultValue: T): T;

E
Erich Gamma 已提交
4281
		/**
J
Johannes Rieken 已提交
4282 4283
		 * Check if this configuration has a certain value.
		 *
4284
		 * @param section Configuration name, supports _dotted_ names.
G
Gama11 已提交
4285
		 * @return `true` if the section doesn't resolve to `undefined`.
E
Erich Gamma 已提交
4286 4287 4288
		 */
		has(section: string): boolean;

4289 4290
		/**
		 * Retrieve all information about a configuration setting. A configuration value
S
Sandeep Somavarapu 已提交
4291 4292 4293 4294
		 * 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))
4295 4296 4297
		 * 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 已提交
4298
		 * for more information.
4299 4300 4301 4302 4303 4304 4305
		 *
		 * *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 已提交
4306
		inspect<T>(section: string): { key: string; defaultValue?: T; globalValue?: T; workspaceValue?: T, workspaceFolderValue?: T } | undefined;
S
Sandeep Somavarapu 已提交
4307 4308

		/**
S
Sandeep Somavarapu 已提交
4309
		 * Update a configuration value. The updated configuration values are persisted.
S
Sandeep Somavarapu 已提交
4310
		 *
S
Sandeep Somavarapu 已提交
4311
		 * A value can be changed in
S
Sandeep Somavarapu 已提交
4312
		 *
S
Sandeep Somavarapu 已提交
4313 4314 4315 4316
		 * - [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 已提交
4317
		 *
S
Sandeep Somavarapu 已提交
4318 4319 4320 4321
		 * *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
4322
		 * [Settings Inheritance](https://code.visualstudio.com/docs/getstarted/settings) for more information.
4323
		 *
4324 4325
		 * *Note 2:* To remove a configuration value use `undefined`, like so: `config.update('somekey', undefined)`
		 *
S
Sandeep Somavarapu 已提交
4326 4327 4328
		 * 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 已提交
4329
		 * - Writing a configuration to folder target when there is no folder settings
S
Sandeep Somavarapu 已提交
4330 4331 4332
		 * - Writing to folder target without passing a resource when getting the configuration (`workspace.getConfiguration(section, resource)`)
		 * - Writing a window configuration to folder target
		 *
4333 4334
		 * @param section Configuration name, supports _dotted_ names.
		 * @param value The new value.
S
Sandeep Somavarapu 已提交
4335
		 * @param configurationTarget The [configuration target](#ConfigurationTarget) or a boolean value.
S
Sandeep Somavarapu 已提交
4336 4337 4338 4339 4340
		 *	- 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.
4341
		 */
S
Sandeep Somavarapu 已提交
4342
		update(section: string, value: any, configurationTarget?: ConfigurationTarget | boolean): Thenable<void>;
4343

E
Erich Gamma 已提交
4344 4345 4346
		/**
		 * Readable dictionary that backs this configuration.
		 */
4347
		readonly [key: string]: any;
E
Erich Gamma 已提交
4348 4349
	}

J
Johannes Rieken 已提交
4350 4351 4352 4353 4354
	/**
	 * Represents a location inside a resource, such as a line
	 * inside a text file.
	 */
	export class Location {
J
Johannes Rieken 已提交
4355 4356 4357 4358

		/**
		 * The resource identifier of this location.
		 */
J
Johannes Rieken 已提交
4359
		uri: Uri;
J
Johannes Rieken 已提交
4360 4361

		/**
A
Andre Weinand 已提交
4362
		 * The document range of this location.
J
Johannes Rieken 已提交
4363
		 */
J
Johannes Rieken 已提交
4364
		range: Range;
J
Johannes Rieken 已提交
4365 4366 4367 4368 4369 4370 4371 4372

		/**
		 * 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 已提交
4373 4374
	}

4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403
	/**
	 * 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;
	}

4404 4405 4406 4407 4408 4409 4410 4411
	/**
	 * The event that is fired when diagnostics change.
	 */
	export interface DiagnosticChangeEvent {

		/**
		 * An array of resources for which diagnostics have changed.
		 */
4412
		readonly uris: ReadonlyArray<Uri>;
4413 4414
	}

E
Erich Gamma 已提交
4415 4416 4417 4418
	/**
	 * Represents the severity of diagnostics.
	 */
	export enum DiagnosticSeverity {
J
Johannes Rieken 已提交
4419 4420

		/**
S
Steven Clarke 已提交
4421
		 * Something not allowed by the rules of a language or other means.
J
Johannes Rieken 已提交
4422 4423 4424 4425 4426 4427
		 */
		Error = 0,

		/**
		 * Something suspicious but allowed.
		 */
E
Erich Gamma 已提交
4428
		Warning = 1,
J
Johannes Rieken 已提交
4429 4430 4431 4432 4433 4434 4435

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

		/**
A
Andre Weinand 已提交
4436
		 * Something to hint to a better way of doing it, like proposing
J
Johannes Rieken 已提交
4437 4438 4439
		 * a refactoring.
		 */
		Hint = 3
E
Erich Gamma 已提交
4440 4441
	}

4442 4443
	/**
	 * Represents a related message and source code location for a diagnostic. This should be
4444
	 * used to point to code locations that cause or related to a diagnostics, e.g. when duplicating
4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467
	 * 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);
	}

4468 4469 4470 4471 4472 4473 4474 4475 4476
	/**
	 * 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 已提交
4477
		 * example, `"editorUnnecessaryCode.opacity": "#000000c0"` will render the
4478
		 * code with 75% opacity. For high contrast themes, use the
M
Matt Bierner 已提交
4479
		 * `"editorUnnecessaryCode.border"` theme color to underline unnecessary code
4480 4481 4482
		 * instead of fading it out.
		 */
		Unnecessary = 1,
4483 4484 4485 4486 4487 4488 4489

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

E
Erich Gamma 已提交
4492
	/**
J
Johannes Rieken 已提交
4493 4494
	 * Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
	 * are only valid in the scope of a file.
E
Erich Gamma 已提交
4495
	 */
J
Johannes Rieken 已提交
4496 4497 4498 4499 4500
	export class Diagnostic {

		/**
		 * The range to which this diagnostic applies.
		 */
E
Erich Gamma 已提交
4501
		range: Range;
J
Johannes Rieken 已提交
4502 4503 4504 4505 4506 4507

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

4508
		/**
J
Johannes Rieken 已提交
4509
		 * The severity, default is [error](#DiagnosticSeverity.Error).
4510
		 */
J
Johannes Rieken 已提交
4511
		severity: DiagnosticSeverity;
4512

J
Johannes Rieken 已提交
4513
		/**
J
Johannes Rieken 已提交
4514 4515
		 * A human-readable string describing the source of this
		 * diagnostic, e.g. 'typescript' or 'super lint'.
J
Johannes Rieken 已提交
4516
		 */
J
Johannes Rieken 已提交
4517
		source?: string;
J
Johannes Rieken 已提交
4518 4519

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

4525 4526 4527 4528
		/**
		 * 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 已提交
4529
		relatedInformation?: DiagnosticRelatedInformation[];
4530

4531 4532 4533 4534 4535
		/**
		 * Additional metadata about the diagnostic.
		 */
		tags?: DiagnosticTag[];

J
Johannes Rieken 已提交
4536
		/**
A
Andre Weinand 已提交
4537
		 * Creates a new diagnostic object.
J
Johannes Rieken 已提交
4538 4539 4540
		 *
		 * @param range The range to which this diagnostic applies.
		 * @param message The human-readable message.
A
Andre Weinand 已提交
4541
		 * @param severity The severity, default is [error](#DiagnosticSeverity.Error).
J
Johannes Rieken 已提交
4542 4543
		 */
		constructor(range: Range, message: string, severity?: DiagnosticSeverity);
E
Erich Gamma 已提交
4544 4545
	}

J
Johannes Rieken 已提交
4546 4547 4548
	/**
	 * A diagnostics collection is a container that manages a set of
	 * [diagnostics](#Diagnostic). Diagnostics are always scopes to a
4549
	 * diagnostics collection and a resource.
J
Johannes Rieken 已提交
4550 4551 4552 4553
	 *
	 * To get an instance of a `DiagnosticCollection` use
	 * [createDiagnosticCollection](#languages.createDiagnosticCollection).
	 */
E
Erich Gamma 已提交
4554 4555 4556
	export interface DiagnosticCollection {

		/**
J
Johannes Rieken 已提交
4557 4558 4559
		 * 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 已提交
4560
		 */
Y
Yuki Ueda 已提交
4561
		readonly name: string;
E
Erich Gamma 已提交
4562 4563 4564

		/**
		 * Assign diagnostics for given resource. Will replace
J
Johannes Rieken 已提交
4565 4566 4567 4568
		 * existing diagnostics for that resource.
		 *
		 * @param uri A resource identifier.
		 * @param diagnostics Array of diagnostics or `undefined`
E
Erich Gamma 已提交
4569
		 */
4570
		set(uri: Uri, diagnostics: ReadonlyArray<Diagnostic> | undefined): void;
E
Erich Gamma 已提交
4571 4572

		/**
4573
		 * Replace all entries in this collection.
J
Johannes Rieken 已提交
4574
		 *
4575 4576 4577 4578 4579 4580
		 * 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 已提交
4581
		 */
4582
		set(entries: ReadonlyArray<[Uri, ReadonlyArray<Diagnostic> | undefined]>): void;
E
Erich Gamma 已提交
4583 4584

		/**
4585 4586
		 * Remove all diagnostics from this collection that belong
		 * to the provided `uri`. The same as `#set(uri, undefined)`.
J
Johannes Rieken 已提交
4587
		 *
4588
		 * @param uri A resource identifier.
E
Erich Gamma 已提交
4589
		 */
4590
		delete(uri: Uri): void;
E
Erich Gamma 已提交
4591 4592 4593 4594 4595 4596 4597

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

4598 4599 4600 4601 4602 4603
		/**
		 * 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.
		 */
4604
		forEach(callback: (uri: Uri, diagnostics: ReadonlyArray<Diagnostic>, collection: DiagnosticCollection) => any, thisArg?: any): void;
4605

4606 4607 4608 4609 4610
		/**
		 * Get the diagnostics for a given resource. *Note* that you cannot
		 * modify the diagnostics-array returned from this call.
		 *
		 * @param uri A resource identifier.
4611
		 * @returns An immutable array of [diagnostics](#Diagnostic) or `undefined`.
4612
		 */
4613
		get(uri: Uri): ReadonlyArray<Diagnostic> | undefined;
4614 4615 4616 4617 4618 4619 4620 4621 4622 4623

		/**
		 * 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 已提交
4624 4625 4626 4627
		/**
		 * Dispose and free associated resources. Calls
		 * [clear](#DiagnosticCollection.clear).
		 */
E
Erich Gamma 已提交
4628 4629 4630
		dispose(): void;
	}

J
Johannes Rieken 已提交
4631
	/**
4632 4633 4634
	 * 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 已提交
4635 4636
	 */
	export enum ViewColumn {
J
Johannes Rieken 已提交
4637
		/**
4638 4639 4640
		 * 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 已提交
4641
		 */
4642
		Active = -1,
4643 4644 4645 4646 4647 4648
		/**
		 * 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 已提交
4649
		/**
4650
		 * The first editor column.
J
Johannes Rieken 已提交
4651
		 */
J
Johannes Rieken 已提交
4652
		One = 1,
J
Johannes Rieken 已提交
4653
		/**
4654
		 * The second editor column.
J
Johannes Rieken 已提交
4655
		 */
J
Johannes Rieken 已提交
4656
		Two = 2,
J
Johannes Rieken 已提交
4657
		/**
4658
		 * The third editor column.
J
Johannes Rieken 已提交
4659
		 */
4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684
		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 已提交
4685 4686
	}

E
Erich Gamma 已提交
4687
	/**
J
Johannes Rieken 已提交
4688 4689 4690
	 * An output channel is a container for readonly textual information.
	 *
	 * To get an instance of an `OutputChannel` use
S
Sandeep Somavarapu 已提交
4691
	 * [createOutputChannel](#window.createOutputChannel).
E
Erich Gamma 已提交
4692
	 */
J
Johannes Rieken 已提交
4693
	export interface OutputChannel {
E
Erich Gamma 已提交
4694

J
Johannes Rieken 已提交
4695 4696 4697
		/**
		 * The human-readable name of this output channel.
		 */
Y
Yuki Ueda 已提交
4698
		readonly name: string;
E
Erich Gamma 已提交
4699 4700

		/**
J
Johannes Rieken 已提交
4701
		 * Append the given value to the channel.
E
Erich Gamma 已提交
4702
		 *
J
Johannes Rieken 已提交
4703
		 * @param value A string, falsy values will not be printed.
E
Erich Gamma 已提交
4704
		 */
J
Johannes Rieken 已提交
4705
		append(value: string): void;
E
Erich Gamma 已提交
4706 4707

		/**
J
Johannes Rieken 已提交
4708 4709
		 * Append the given value and a line feed character
		 * to the channel.
E
Erich Gamma 已提交
4710
		 *
J
Johannes Rieken 已提交
4711
		 * @param value A string, falsy values will be printed.
E
Erich Gamma 已提交
4712 4713 4714
		 */
		appendLine(value: string): void;

J
Johannes Rieken 已提交
4715 4716 4717
		/**
		 * Removes all output from the channel.
		 */
E
Erich Gamma 已提交
4718 4719
		clear(): void;

J
Johannes Rieken 已提交
4720 4721
		/**
		 * Reveal this channel in the UI.
4722
		 *
4723
		 * @param preserveFocus When `true` the channel will not take focus.
J
Johannes Rieken 已提交
4724
		 */
J
Johannes Rieken 已提交
4725
		show(preserveFocus?: boolean): void;
E
Erich Gamma 已提交
4726

4727
		/**
4728
		 * ~~Reveal this channel in the UI.~~
4729
		 *
4730
		 * @deprecated Use the overload with just one parameter (`show(preserveFocus?: boolean): void`).
J
Johannes Rieken 已提交
4731 4732
		 *
		 * @param column This argument is **deprecated** and will be ignored.
4733 4734
		 * @param preserveFocus When `true` the channel will not take focus.
		 */
J
Johannes Rieken 已提交
4735
		show(column?: ViewColumn, preserveFocus?: boolean): void;
4736

J
Johannes Rieken 已提交
4737 4738 4739
		/**
		 * Hide this channel from the UI.
		 */
E
Erich Gamma 已提交
4740 4741
		hide(): void;

J
Johannes Rieken 已提交
4742 4743 4744
		/**
		 * Dispose and free associated resources.
		 */
E
Erich Gamma 已提交
4745 4746 4747 4748
		dispose(): void;
	}

	/**
J
Johannes Rieken 已提交
4749
	 * Represents the alignment of status bar items.
E
Erich Gamma 已提交
4750 4751
	 */
	export enum StatusBarAlignment {
J
Johannes Rieken 已提交
4752 4753 4754 4755

		/**
		 * Aligned to the left side.
		 */
4756
		Left = 1,
J
Johannes Rieken 已提交
4757 4758 4759 4760

		/**
		 * Aligned to the right side.
		 */
4761
		Right = 2
E
Erich Gamma 已提交
4762 4763 4764 4765 4766 4767 4768 4769 4770
	}

	/**
	 * 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 已提交
4771
		 * The alignment of this item.
E
Erich Gamma 已提交
4772
		 */
Y
Yuki Ueda 已提交
4773
		readonly alignment: StatusBarAlignment;
E
Erich Gamma 已提交
4774 4775

		/**
J
Johannes Rieken 已提交
4776 4777
		 * The priority of this item. Higher value means the item should
		 * be shown more to the left.
E
Erich Gamma 已提交
4778
		 */
4779
		readonly priority?: number;
E
Erich Gamma 已提交
4780 4781

		/**
J
Johannes Rieken 已提交
4782 4783
		 * The text to show for the entry. You can embed icons in the text by leveraging the syntax:
		 *
J
Johannes Rieken 已提交
4784
		 * `My text $(icon-name) contains icons like $(icon-name) this one.`
J
Johannes Rieken 已提交
4785
		 *
4786
		 * Where the icon-name is taken from the [codicon](https://microsoft.github.io/vscode-codicons/dist/codicon.html) icon set, e.g.
4787
		 * `light-bulb`, `thumbsup`, `zap` etc.
J
Johannes Rieken 已提交
4788
		 */
E
Erich Gamma 已提交
4789 4790 4791
		text: string;

		/**
J
Johannes Rieken 已提交
4792 4793
		 * The tooltip text when you hover over this entry.
		 */
4794
		tooltip: string | undefined;
E
Erich Gamma 已提交
4795 4796

		/**
J
Johannes Rieken 已提交
4797 4798
		 * The foreground color for this entry.
		 */
4799
		color: string | ThemeColor | undefined;
E
Erich Gamma 已提交
4800 4801

		/**
J
Johannes Rieken 已提交
4802 4803 4804
		 * The identifier of a command to run on click. The command must be
		 * [known](#commands.getCommands).
		 */
4805
		command: string | undefined;
E
Erich Gamma 已提交
4806 4807 4808 4809 4810 4811 4812

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

		/**
J
Johannes Rieken 已提交
4813
		 * Hide the entry in the status bar.
E
Erich Gamma 已提交
4814 4815 4816 4817
		 */
		hide(): void;

		/**
J
Johannes Rieken 已提交
4818 4819
		 * Dispose and free associated resources. Call
		 * [hide](#StatusBarItem.hide).
E
Erich Gamma 已提交
4820 4821 4822 4823
		 */
		dispose(): void;
	}

4824 4825 4826 4827 4828 4829 4830
	/**
	 * Defines a generalized way of reporting progress updates.
	 */
	export interface Progress<T> {

		/**
		 * Report a progress update.
4831 4832
		 * @param value A progress item, like a message and/or an
		 * report on how much work finished
4833
		 */
J
Johannes Rieken 已提交
4834
		report(value: T): void;
4835 4836
	}

D
Daniel Imms 已提交
4837 4838 4839
	/**
	 * An individual terminal instance within the integrated terminal.
	 */
D
Daniel Imms 已提交
4840
	export interface Terminal {
D
Daniel Imms 已提交
4841

4842 4843 4844
		/**
		 * The name of the terminal.
		 */
Y
Yuki Ueda 已提交
4845
		readonly name: string;
4846

4847 4848 4849
		/**
		 * The process ID of the shell process.
		 */
4850
		readonly processId: Thenable<number | undefined>;
4851

D
Daniel Imms 已提交
4852
		/**
D
Daniel Imms 已提交
4853
		 * Send text to the terminal. The text is written to the stdin of the underlying pty process
4854
		 * (shell) of the terminal.
D
Daniel Imms 已提交
4855
		 *
D
Daniel Imms 已提交
4856
		 * @param text The text to send.
D
Daniel Imms 已提交
4857
		 * @param addNewLine Whether to add a new line to the text being sent, this is normally
4858 4859
		 * 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 已提交
4860
		 */
4861
		sendText(text: string, addNewLine?: boolean): void;
D
Daniel Imms 已提交
4862 4863

		/**
D
Daniel Imms 已提交
4864
		 * Show the terminal panel and reveal this terminal in the UI.
D
Daniel Imms 已提交
4865
		 *
D
Daniel Imms 已提交
4866
		 * @param preserveFocus When `true` the terminal will not take focus.
D
Daniel Imms 已提交
4867
		 */
D
Daniel Imms 已提交
4868
		show(preserveFocus?: boolean): void;
D
Daniel Imms 已提交
4869 4870

		/**
D
Daniel Imms 已提交
4871
		 * Hide the terminal panel if this terminal is currently showing.
D
Daniel Imms 已提交
4872 4873 4874 4875 4876 4877 4878
		 */
		hide(): void;

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

J
Johannes Rieken 已提交
4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897
	/**
	 * 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 已提交
4898 4899 4900
	/**
	 * Represents an extension.
	 *
A
Alex Dima 已提交
4901
	 * To get an instance of an `Extension` use [getExtension](#extensions.getExtension).
J
Johannes Rieken 已提交
4902
	 */
E
Erich Gamma 已提交
4903
	export interface Extension<T> {
J
Johannes Rieken 已提交
4904

E
Erich Gamma 已提交
4905
		/**
J
Johannes Rieken 已提交
4906
		 * The canonical extension identifier in the form of: `publisher.name`.
E
Erich Gamma 已提交
4907
		 */
Y
Yuki Ueda 已提交
4908
		readonly id: string;
E
Erich Gamma 已提交
4909 4910

		/**
J
Johannes Rieken 已提交
4911
		 * The absolute file path of the directory containing this extension.
E
Erich Gamma 已提交
4912
		 */
Y
Yuki Ueda 已提交
4913
		readonly extensionPath: string;
E
Erich Gamma 已提交
4914 4915

		/**
4916
		 * `true` if the extension has been activated.
E
Erich Gamma 已提交
4917
		 */
Y
Yuki Ueda 已提交
4918
		readonly isActive: boolean;
E
Erich Gamma 已提交
4919 4920 4921 4922

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

J
Johannes Rieken 已提交
4925 4926 4927
		/**
		 * The extension kind describes if an extension runs where the UI runs
		 * or if an extension runs where the remote extension host runs. The extension kind
J
Johannes Rieken 已提交
4928
		 * is defined in the `package.json`-file of extensions but can also be refined
R
ryenus 已提交
4929
		 * via the `remote.extensionKind`-setting. When no remote extension host exists,
J
Johannes Rieken 已提交
4930 4931 4932 4933
		 * the value is [`ExtensionKind.UI`](#ExtensionKind.UI).
		 */
		extensionKind: ExtensionKind;

E
Erich Gamma 已提交
4934
		/**
A
Alex Dima 已提交
4935
		 * The public API exported by this extension. It is an invalid action
J
Johannes Rieken 已提交
4936
		 * to access this field before this extension has been activated.
E
Erich Gamma 已提交
4937
		 */
Y
Yuki Ueda 已提交
4938
		readonly exports: T;
E
Erich Gamma 已提交
4939 4940 4941

		/**
		 * Activates this extension and returns its public API.
J
Johannes Rieken 已提交
4942
		 *
S
Steven Clarke 已提交
4943
		 * @return A promise that will resolve when this extension has been activated.
E
Erich Gamma 已提交
4944 4945 4946 4947
		 */
		activate(): Thenable<T>;
	}

J
Johannes Rieken 已提交
4948
	/**
S
Steven Clarke 已提交
4949 4950
	 * An extension context is a collection of utilities private to an
	 * extension.
J
Johannes Rieken 已提交
4951
	 *
S
Steven Clarke 已提交
4952
	 * An instance of an `ExtensionContext` is provided as the first
J
Johannes Rieken 已提交
4953 4954
	 * parameter to the `activate`-call of an extension.
	 */
E
Erich Gamma 已提交
4955 4956 4957 4958
	export interface ExtensionContext {

		/**
		 * An array to which disposables can be added. When this
J
Johannes Rieken 已提交
4959
		 * extension is deactivated the disposables will be disposed.
E
Erich Gamma 已提交
4960
		 */
4961
		readonly subscriptions: { dispose(): any }[];
E
Erich Gamma 已提交
4962 4963 4964

		/**
		 * A memento object that stores state in the context
4965
		 * of the currently opened [workspace](#workspace.workspaceFolders).
E
Erich Gamma 已提交
4966
		 */
4967
		readonly workspaceState: Memento;
E
Erich Gamma 已提交
4968 4969 4970

		/**
		 * A memento object that stores state independent
4971
		 * of the current opened [workspace](#workspace.workspaceFolders).
E
Erich Gamma 已提交
4972
		 */
4973
		readonly globalState: Memento;
E
Erich Gamma 已提交
4974 4975

		/**
J
Johannes Rieken 已提交
4976
		 * The absolute file path of the directory containing the extension.
E
Erich Gamma 已提交
4977
		 */
4978
		readonly extensionPath: string;
E
Erich Gamma 已提交
4979 4980

		/**
A
Alex Dima 已提交
4981 4982 4983 4984
		 * 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 已提交
4985 4986
		 */
		asAbsolutePath(relativePath: string): string;
D
Dirk Baeumer 已提交
4987 4988

		/**
J
Johannes Rieken 已提交
4989 4990 4991
		 * 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 已提交
4992
		 *
4993 4994
		 * Use [`workspaceState`](#ExtensionContext.workspaceState) or
		 * [`globalState`](#ExtensionContext.globalState) to store key value data.
D
Dirk Baeumer 已提交
4995
		 */
4996
		readonly storagePath: string | undefined;
4997

S
Sandeep Somavarapu 已提交
4998
		/**
4999
		 * An absolute file path in which the extension can store global state.
S
Sandeep Somavarapu 已提交
5000 5001 5002 5003 5004
		 * 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.
		 */
5005
		readonly globalStoragePath: string;
S
Sandeep Somavarapu 已提交
5006

5007 5008 5009 5010 5011
		/**
		 * 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.
		 */
5012
		readonly logPath: string;
E
Erich Gamma 已提交
5013 5014 5015 5016 5017 5018 5019 5020
	}

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

5021 5022 5023 5024 5025 5026 5027 5028
		/**
		 * Return a value.
		 *
		 * @param key A string.
		 * @return The stored value or `undefined`.
		 */
		get<T>(key: string): T | undefined;

E
Erich Gamma 已提交
5029
		/**
J
Johannes Rieken 已提交
5030 5031 5032 5033 5034
		 * 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.
5035
		 * @return The stored value or the defaultValue.
E
Erich Gamma 已提交
5036
		 */
5037
		get<T>(key: string, defaultValue: T): T;
E
Erich Gamma 已提交
5038 5039

		/**
S
Steven Clarke 已提交
5040
		 * Store a value. The value must be JSON-stringifyable.
J
Johannes Rieken 已提交
5041 5042 5043
		 *
		 * @param key A string.
		 * @param value A value. MUST not contain cyclic references.
E
Erich Gamma 已提交
5044 5045 5046 5047
		 */
		update(key: string, value: any): Thenable<void>;
	}

5048 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 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
	/**
	 * 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;
5118 5119 5120 5121

		/**
		 * Controls whether to show the "Terminal will be reused by tasks, press any key to close it" message.
		 */
D
Dirk Baeumer 已提交
5122
		showReuseMessage?: boolean;
A
Alex Ross 已提交
5123 5124 5125 5126 5127

		/**
		 * Controls whether the terminal is cleared before executing the task.
		 */
		clear?: boolean;
5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138
	}

	/**
	 * 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 已提交
5139
		static Clean: TaskGroup;
5140 5141 5142 5143

		/**
		 * The build task group;
		 */
J
Johannes Rieken 已提交
5144
		static Build: TaskGroup;
5145 5146 5147 5148

		/**
		 * The rebuild all task group;
		 */
J
Johannes Rieken 已提交
5149
		static Rebuild: TaskGroup;
5150 5151 5152 5153

		/**
		 * The test all task group;
		 */
J
Johannes Rieken 已提交
5154
		static Test: TaskGroup;
5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165

		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 {
		/**
5166
		 * The task definition describing the task provided by an extension.
5167 5168 5169 5170 5171 5172 5173 5174 5175
		 * 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;
		 * }
		 * ```
5176 5177 5178
		 *
		 * Note that type identifier starting with a '$' are reserved for internal
		 * usages and shouldn't be used by extensions.
5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206
		 */
		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 };
	}

	/**
5207
	 * The execution of a task happens as an external process
5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245
	 * 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;
	}

5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277
	/**
	 * 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;
	}

5278 5279 5280 5281 5282 5283 5284 5285 5286 5287
	/**
	 * Options for a shell execution
	 */
	export interface ShellExecutionOptions {
		/**
		 * The shell executable.
		 */
		executable?: string;

		/**
D
Dirk Baeumer 已提交
5288 5289 5290 5291
		 * 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`.
5292 5293 5294
		 */
		shellArgs?: string[];

5295 5296 5297 5298 5299
		/**
		 * The shell quotes supported by this shell.
		 */
		shellQuoting?: ShellQuotingOptions;

5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313
		/**
		 * 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 };
	}

5314 5315
	/**
	 * Defines how an argument should be quoted if it contains
5316
	 * spaces or unsupported characters.
5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358
	 */
	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;
	}
5359 5360 5361

	export class ShellExecution {
		/**
5362
		 * Creates a shell execution with a full command line.
5363 5364 5365 5366 5367 5368 5369
		 *
		 * @param commandLine The command line to execute.
		 * @param options Optional options for the started the shell.
		 */
		constructor(commandLine: string, options?: ShellExecutionOptions);

		/**
5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382
		 * 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.
5383
		 */
5384
		commandLine: string | undefined;
5385

5386 5387 5388 5389 5390 5391 5392 5393 5394 5395
		/**
		 * 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)[];

5396 5397 5398 5399 5400 5401 5402
		/**
		 * The shell options used when the command line is executed in a shell.
		 * Defaults to undefined.
		 */
		options?: ShellExecutionOptions;
	}

A
Alex Ross 已提交
5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418
	/**
	 * 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 已提交
5419 5420 5421 5422 5423
	/**
	 * The scope of a task.
	 */
	export enum TaskScope {
		/**
5424
		 * The task is a global task. Global tasks are currrently not supported.
D
Dirk Baeumer 已提交
5425 5426 5427 5428 5429 5430 5431 5432 5433
		 */
		Global = 1,

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

5434 5435 5436 5437 5438 5439 5440 5441 5442 5443
	/**
	 * Run options for a task.
	 */
	export interface RunOptions {
		/**
		 * Controls whether task variables are re-evaluated on rerun.
		 */
		reevaluateOnRerun?: boolean;
	}

5444 5445 5446 5447 5448 5449
	/**
	 * A task to execute
	 */
	export class Task {

		/**
5450
		 * Creates a new task.
D
Dirk Baeumer 已提交
5451
		 *
5452
		 * @param definition The task definition as defined in the taskDefinitions extension point.
5453
		 * @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 已提交
5454
		 * @param name The task's name. Is presented in the user interface.
5455 5456 5457 5458 5459 5460
		 * @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 已提交
5461
		constructor(taskDefinition: TaskDefinition, scope: WorkspaceFolder | TaskScope.Global | TaskScope.Workspace, name: string, source: string, execution?: ProcessExecution | ShellExecution | CustomExecution, problemMatchers?: string | string[]);
5462

D
Dirk Baeumer 已提交
5463
		/**
5464 5465
		 * ~~Creates a new task.~~
		 *
5466
		 * @deprecated Use the new constructors that allow specifying a scope for the task.
D
Dirk Baeumer 已提交
5467 5468 5469 5470 5471 5472 5473 5474 5475
		 *
		 * @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.
		 */
5476
		constructor(taskDefinition: TaskDefinition, name: string, source: string, execution?: ProcessExecution | ShellExecution, problemMatchers?: string | string[]);
D
Dirk Baeumer 已提交
5477

5478 5479 5480 5481 5482
		/**
		 * The task's definition.
		 */
		definition: TaskDefinition;

D
Dirk Baeumer 已提交
5483
		/**
D
Dirk Baeumer 已提交
5484
		 * The task's scope.
D
Dirk Baeumer 已提交
5485
		 */
5486
		readonly scope?: TaskScope.Global | TaskScope.Workspace | WorkspaceFolder;
D
Dirk Baeumer 已提交
5487

5488 5489 5490 5491 5492 5493 5494 5495
		/**
		 * The task's name
		 */
		name: string;

		/**
		 * The task's execution engine
		 */
A
Alex Ross 已提交
5496
		execution?: ProcessExecution | ShellExecution | CustomExecution;
5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526

		/**
		 * 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[];
5527 5528 5529 5530 5531

		/**
		 * Run options for the task
		 */
		runOptions: RunOptions;
5532 5533 5534 5535
	}

	/**
	 * A task provider allows to add tasks to the task service.
D
Dirk Baeumer 已提交
5536
	 * A task provider is registered via #tasks.registerTaskProvider.
5537 5538 5539 5540 5541 5542 5543 5544 5545 5546
	 */
	export interface TaskProvider {
		/**
		 * Provides tasks.
		 * @param token A cancellation token.
		 * @return an array of tasks
		 */
		provideTasks(token?: CancellationToken): ProviderResult<Task[]>;

		/**
5547
		 * Resolves a task that has no [`execution`](#Task.execution) set. Tasks are
D
Dirk Baeumer 已提交
5548
		 * often created from information found in the `tasks.json`-file. Such tasks miss
5549
		 * the information on how to execute them and a task provider must fill in
D
Dirk Baeumer 已提交
5550 5551 5552 5553
		 * 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`.
5554
		 *
5555 5556
		 * @param task The task to resolve.
		 * @param token A cancellation token.
5557
		 * @return The resolved task
5558 5559 5560 5561
		 */
		resolveTask(task: Task, token?: CancellationToken): ProviderResult<Task>;
	}

D
Dirk Baeumer 已提交
5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588
	/**
	 * 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.
		 */
5589
		readonly execution: TaskExecution;
D
Dirk Baeumer 已提交
5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600
	}

	/**
	 * 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.
		 */
5601
		readonly execution: TaskExecution;
D
Dirk Baeumer 已提交
5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612
	}

	/**
	 * 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.
		 */
5613
		readonly execution: TaskExecution;
D
Dirk Baeumer 已提交
5614 5615 5616 5617

		/**
		 * The underlying process id.
		 */
5618
		readonly processId: number;
D
Dirk Baeumer 已提交
5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629
	}

	/**
	 * 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.
		 */
5630
		readonly execution: TaskExecution;
D
Dirk Baeumer 已提交
5631 5632 5633 5634

		/**
		 * The process's exit code.
		 */
5635
		readonly exitCode: number;
D
Dirk Baeumer 已提交
5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669
	}

	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 已提交
5670
		 * @param filter Optional filter to select tasks of a certain type or version.
D
Dirk Baeumer 已提交
5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684
		 */
		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.
		 */
5685
		export const taskExecutions: ReadonlyArray<TaskExecution>;
D
Dirk Baeumer 已提交
5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711

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

5712
	/**
5713 5714 5715
	 * 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`.
5716
	 */
5717 5718 5719 5720 5721
	export enum FileType {
		/**
		 * The file type is unknown.
		 */
		Unknown = 0,
5722
		/**
5723
		 * A regular file.
5724
		 */
5725 5726 5727 5728 5729 5730 5731 5732 5733 5734
		File = 1,
		/**
		 * A directory.
		 */
		Directory = 2,
		/**
		 * A symbolic link to a file.
		 */
		SymbolicLink = 64
	}
5735

5736
	/**
5737
	 * The `FileStat`-type represents metadata about a file
5738 5739
	 */
	export interface FileStat {
5740
		/**
5741 5742
		 * The type of the file, e.g. is a regular file, a directory, or symbolic link
		 * to a file.
5743
		 */
5744
		type: FileType;
5745
		/**
5746
		 * The creation timestamp in milliseconds elapsed since January 1, 1970 00:00:00 UTC.
5747
		 */
5748
		ctime: number;
5749
		/**
5750
		 * The modification timestamp in milliseconds elapsed since January 1, 1970 00:00:00 UTC.
5751 5752 5753 5754
		 *
		 * *Note:* If the file changed, it is important to provide an updated `mtime` that advanced
		 * from the previous value. Otherwise there may be optimizations in place that will not show
		 * the updated file contents in an editor for example.
5755 5756 5757 5758
		 */
		mtime: number;
		/**
		 * The size in bytes.
5759 5760 5761 5762
		 *
		 * *Note:* If the file changed, it is important to provide an updated `size`. Otherwise there
		 * may be optimizations in place that will not show the updated file contents in an editor for
		 * example.
5763 5764 5765 5766 5767 5768 5769
		 */
		size: number;
	}

	/**
	 * A type that filesystem providers should use to signal errors.
	 *
D
David Linskey 已提交
5770 5771
	 * 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);`
5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799
	 */
	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;

5800 5801 5802 5803 5804 5805
		/**
		 * Create an error to signal that an operation lacks required permissions.
		 * @param messageOrUri Message or uri.
		 */
		static NoPermissions(messageOrUri?: string | Uri): FileSystemError;

5806 5807 5808 5809 5810 5811 5812
		/**
		 * 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;

5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 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
		/**
		 * 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.
		 */
5850
		readonly type: FileChangeType;
5851 5852 5853 5854

		/**
		 * The uri of the file that has changed.
		 */
5855
		readonly uri: Uri;
5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866
	}

	/**
	 * 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 已提交
5867 5868
	 * * *Note 3:* The word 'file' is often used to denote all [kinds](#FileType) of files, e.g.
	 * folders, symbolic links, and regular files.
5869 5870 5871 5872 5873
	 */
	export interface FileSystemProvider {

		/**
		 * An event to signal that a resource has been created, changed, or deleted. This
5874
		 * event should fire for resources that are being [watched](#FileSystemProvider.watch)
5875
		 * by clients of this provider.
5876 5877 5878 5879 5880
		 *
		 * *Note:* It is important that the metadata of the file that changed provides an
		 * updated `mtime` that advanced from the previous value in the [stat](#FileStat) and a
		 * correct `size` value. Otherwise there may be optimizations in place that will not show
		 * the change in an editor for example.
5881
		 */
5882
		readonly onDidChangeFile: Event<FileChangeEvent[]>;
5883 5884 5885

		/**
		 * Subscribe to events in the file or folder denoted by `uri`.
J
Johannes Rieken 已提交
5886 5887 5888 5889 5890
		 *
		 * 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`).
		 *
5891 5892
		 * @param uri The uri of the file to be watched.
		 * @param options Configures the watch.
J
Johannes Rieken 已提交
5893
		 * @returns A disposable that tells the provider to stop watching the `uri`.
5894
		 */
5895
		watch(uri: Uri, options: { recursive: boolean; excludes: string[] }): Disposable;
5896 5897

		/**
5898
		 * Retrieve metadata about a file.
5899
		 *
5900 5901 5902 5903
		 * 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 已提交
5904
		 * @param uri The uri of the file to retrieve metadata about.
5905
		 * @return The file metadata about the file.
5906
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `uri` doesn't exist.
5907
		 */
5908
		stat(uri: Uri): FileStat | Thenable<FileStat>;
5909 5910

		/**
J
Johannes Rieken 已提交
5911
		 * Retrieve all entries of a [directory](#FileType.Directory).
5912 5913
		 *
		 * @param uri The uri of the folder.
5914 5915
		 * @return An array of name/type-tuples or a thenable that resolves to such.
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `uri` doesn't exist.
5916
		 */
5917
		readDirectory(uri: Uri): [string, FileType][] | Thenable<[string, FileType][]>;
5918 5919

		/**
J
Johannes Rieken 已提交
5920
		 * Create a new directory (Note, that new files are created via `write`-calls).
5921
		 *
5922
		 * @param uri The uri of the new folder.
J
Johannes Rieken 已提交
5923
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when the parent of `uri` doesn't exist, e.g. no mkdirp-logic required.
5924
		 * @throws [`FileExists`](#FileSystemError.FileExists) when `uri` already exists.
5925
		 * @throws [`NoPermissions`](#FileSystemError.NoPermissions) when permissions aren't sufficient.
5926
		 */
5927
		createDirectory(uri: Uri): void | Thenable<void>;
5928 5929 5930 5931 5932

		/**
		 * Read the entire contents of a file.
		 *
		 * @param uri The uri of the file.
5933 5934
		 * @return An array of bytes or a thenable that resolves to such.
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `uri` doesn't exist.
5935
		 */
5936
		readFile(uri: Uri): Uint8Array | Thenable<Uint8Array>;
5937 5938 5939 5940 5941 5942

		/**
		 * 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 已提交
5943
		 * @param options Defines if missing files should or must be created.
5944
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `uri` doesn't exist and `create` is not set.
J
Johannes Rieken 已提交
5945
		 * @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 已提交
5946
		 * @throws [`FileExists`](#FileSystemError.FileExists) when `uri` already exists, `create` is set but `overwrite` is not set.
5947
		 * @throws [`NoPermissions`](#FileSystemError.NoPermissions) when permissions aren't sufficient.
5948
		 */
5949
		writeFile(uri: Uri, content: Uint8Array, options: { create: boolean, overwrite: boolean }): void | Thenable<void>;
5950 5951

		/**
J
Johannes Rieken 已提交
5952
		 * Delete a file.
5953
		 *
5954 5955 5956
		 * @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.
5957
		 * @throws [`NoPermissions`](#FileSystemError.NoPermissions) when permissions aren't sufficient.
5958
		 */
5959
		delete(uri: Uri, options: { recursive: boolean }): void | Thenable<void>;
5960 5961 5962 5963

		/**
		 * Rename a file or folder.
		 *
J
Johannes Rieken 已提交
5964 5965
		 * @param oldUri The existing file.
		 * @param newUri The new location.
5966
		 * @param options Defines if existing files should be overwritten.
5967
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when `oldUri` doesn't exist.
J
Johannes Rieken 已提交
5968
		 * @throws [`FileNotFound`](#FileSystemError.FileNotFound) when parent of `newUri` doesn't exist, e.g. no mkdirp-logic required.
5969
		 * @throws [`FileExists`](#FileSystemError.FileExists) when `newUri` exists and when the `overwrite` option is not `true`.
5970
		 * @throws [`NoPermissions`](#FileSystemError.NoPermissions) when permissions aren't sufficient.
5971
		 */
5972
		rename(oldUri: Uri, newUri: Uri, options: { overwrite: boolean }): void | Thenable<void>;
5973 5974 5975 5976 5977

		/**
		 * Copy files or folders. Implementing this function is optional but it will speedup
		 * the copy operation.
		 *
J
Johannes Rieken 已提交
5978
		 * @param source The existing file.
J
Johannes Rieken 已提交
5979
		 * @param destination The destination location.
5980
		 * @param options Defines if existing files should be overwritten.
J
Johannes Rieken 已提交
5981 5982
		 * @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.
5983
		 * @throws [`FileExists`](#FileSystemError.FileExists) when `destination` exists and when the `overwrite` option is not `true`.
5984
		 * @throws [`NoPermissions`](#FileSystemError.NoPermissions) when permissions aren't sufficient.
5985
		 */
5986
		copy?(source: Uri, destination: Uri, options: { overwrite: boolean }): void | Thenable<void>;
5987 5988
	}

5989 5990 5991 5992 5993 5994
	/**
	 * 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 已提交
5995
	 * *Note* that an instance of this interface is avaiable as [`workspace.fs`](#workspace.fs).
5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017
	 */
	export interface FileSystem {

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

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

		/**
		 * Create a new directory (Note, that new files are created via `write`-calls).
		 *
J
Johannes Rieken 已提交
6018 6019 6020
		 * *Note* that missing directories are created automatically, e.g this call has
		 * `mkdirp` semantics.
		 *
6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058
		 * @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 已提交
6059
		 * Copy files or folders.
6060 6061 6062 6063 6064 6065 6066 6067
		 *
		 * @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>;
	}

6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082
	/**
	 * 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;
	}

6083 6084 6085 6086 6087
	/**
	 * Content settings for a webview.
	 */
	export interface WebviewOptions {
		/**
M
Matt Bierner 已提交
6088
		 * Controls whether scripts are enabled in the webview content or not.
6089 6090 6091 6092 6093 6094
		 *
		 * Defaults to false (scripts-disabled).
		 */
		readonly enableScripts?: boolean;

		/**
M
Matt Bierner 已提交
6095
		 * Controls whether command uris are enabled in webview content or not.
6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108
		 *
		 * 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>;
6109 6110 6111 6112 6113 6114 6115 6116

		/**
		 * 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.
		 *
6117
		 * If a webview accesses localhost content, we recommend that you specify port mappings even if
6118
		 * the `webviewPort` and `extensionHostPort` ports are the same.
6119 6120 6121
		 *
		 * *Note* that port mappings only work for `http` or `https` urls. Websocket urls (e.g. `ws://localhost:3000`)
		 * cannot be mapped to another port.
6122 6123
		 */
		readonly portMapping?: ReadonlyArray<WebviewPortMapping>;
6124 6125 6126 6127 6128 6129 6130 6131 6132
	}

	/**
	 * A webview displays html content, like an iframe.
	 */
	export interface Webview {
		/**
		 * Content settings for the webview.
		 */
6133
		options: WebviewOptions;
6134 6135 6136 6137 6138 6139 6140 6141 6142 6143

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

		/**
		 * Fired when the webview content posts a message.
6144 6145 6146 6147
		 *
		 * 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.
6148 6149 6150 6151 6152 6153
		 */
		readonly onDidReceiveMessage: Event<any>;

		/**
		 * Post a message to the webview content.
		 *
6154 6155
		 * Messages are only delivered if the webview is live (either visible or in the
		 * background with `retainContextWhenHidden`).
6156
		 *
6157
		 * @param message Body of the message. This must be a string or other json serilizable object.
6158 6159
		 */
		postMessage(message: any): Thenable<boolean>;
M
Matt Bierner 已提交
6160 6161 6162 6163

		/**
		 * Convert a uri for the local file system to one that can be used inside webviews.
		 *
M
Spell  
Matt Bierner 已提交
6164
		 * Webviews cannot directly load resources from the workspace or local file system using `file:` uris. The
M
Matt Bierner 已提交
6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183
		 * `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;
6184 6185 6186 6187 6188 6189 6190
	}

	/**
	 * Content settings for a webview panel.
	 */
	export interface WebviewPanelOptions {
		/**
M
Matt Bierner 已提交
6191
		 * Controls if the find widget is enabled in the panel.
6192 6193 6194 6195 6196 6197
		 *
		 * Defaults to false.
		 */
		readonly enableFindWidget?: boolean;

		/**
M
Matt Bierner 已提交
6198 6199
		 * Controls if the webview panel's content (iframe) is kept around even when the panel
		 * is no longer visible.
6200 6201
		 *
		 * Normally the webview panel's html context is created when the panel becomes visible
N
Nick Schonning 已提交
6202
		 * and destroyed when it is hidden. Extensions that have complex state
6203
		 * or UI can set the `retainContextWhenHidden` to make VS Code keep the webview
6204 6205 6206 6207 6208
		 * 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.
6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220
		 *
		 * `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 已提交
6221
		 * Identifies the type of the webview panel, such as `'markdown.preview'`.
6222 6223 6224 6225 6226 6227 6228 6229
		 */
		readonly viewType: string;

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

6230 6231 6232 6233 6234
		/**
		 * Icon for the panel shown in UI.
		 */
		iconPath?: Uri | { light: Uri; dark: Uri };

6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246
		/**
		 * 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
6247
		 * one of the editor view columns.
6248 6249 6250
		 */
		readonly viewColumn?: ViewColumn;

M
Matt Bierner 已提交
6251
		/**
6252
		 * Whether the panel is active (focused by the user).
M
Matt Bierner 已提交
6253 6254 6255
		 */
		readonly active: boolean;

6256
		/**
6257
		 * Whether the panel is visible.
6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280
		 */
		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.
6281 6282
		 *
		 * @param viewColumn View column to show the panel in. Shows in the current `viewColumn` if undefined.
6283
		 * @param preserveFocus When `true`, the webview will not take focus.
6284
		 */
6285
		reveal(viewColumn?: ViewColumn, preserveFocus?: boolean): void;
6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306

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

6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332
	/**
	 * 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 已提交
6333 6334
	 * 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
6335 6336 6337 6338 6339
	 * 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 {
		/**
6340
		 * Restore a webview panel from its serialized `state`.
6341 6342 6343
		 *
		 * Called when a serialized webview first becomes visible.
		 *
M
Matt Bierner 已提交
6344 6345 6346
		 * @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.
6347
		 *
S
Simon Siefke 已提交
6348
		 * @return Thenable indicating that the webview has been fully restored.
6349 6350 6351 6352
		 */
		deserializeWebviewPanel(webviewPanel: WebviewPanel, state: any): Thenable<void>;
	}

J
Johannes Rieken 已提交
6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370
	/**
	 * 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>;
	}

6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386
	/**
	 * 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
	}

6387 6388 6389 6390 6391
	/**
	 * Namespace describing the environment the editor runs in.
	 */
	export namespace env {

6392 6393 6394
		/**
		 * The application name of the editor, like 'VS Code'.
		 */
6395
		export const appName: string;
6396

J
Johannes Rieken 已提交
6397 6398 6399
		/**
		 * The application root folder from which the editor is running.
		 */
6400
		export const appRoot: string;
J
Johannes Rieken 已提交
6401

P
Peng Lyu 已提交
6402 6403 6404 6405 6406
		/**
		 * The custom uri scheme the editor registers to in the operating system.
		 */
		export const uriScheme: string;

J
Johannes Rieken 已提交
6407 6408 6409
		/**
		 * Represents the preferred user-language, like `de-CH`, `fr`, or `en-US`.
		 */
6410
		export const language: string;
J
Johannes Rieken 已提交
6411

J
Johannes Rieken 已提交
6412 6413 6414 6415 6416
		/**
		 * The system clipboard.
		 */
		export const clipboard: Clipboard;

6417 6418 6419
		/**
		 * A unique identifier for the computer.
		 */
6420
		export const machineId: string;
6421 6422 6423 6424 6425

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

J
Johannes Rieken 已提交
6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438
		/**
		 * 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 已提交
6439 6440 6441 6442 6443 6444
		/**
		 * 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;

6445 6446 6447 6448 6449 6450 6451
		/**
		 * 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;

6452
		/**
B
Benjamin Pasero 已提交
6453 6454 6455 6456 6457
		 * 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`)
6458 6459 6460 6461 6462 6463 6464
		 *
		 * *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 已提交
6465
		export function openExternal(target: Uri): Thenable<boolean>;
M
Matt Bierner 已提交
6466 6467

		/**
6468 6469 6470 6471 6472
		 * Resolves a uri to form that is accessible externally. Currently only supports `https:`, `http:` and
		 * `vscode.env.uriScheme` uris.
		 *
		 * #### `http:` or `https:` scheme
		 *
M
Matt Bierner 已提交
6473 6474 6475
		 * 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.
		 *
6476
		 * This is a no-op if the extension is running on the client machine.
M
Matt Bierner 已提交
6477 6478 6479 6480 6481
		 *
		 * 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.
		 *
6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505
		 * *Note* that uris passed through `openExternal` are automatically resolved and you should not call `asExternalUri` on them.
		 *
		 * #### `vscode.env.uriScheme`
		 *
		 * Creates a uri that - if opened in a browser (e.g. via `openExternal`) - will result in a registered [UriHandler](#UriHandler)
		 * to trigger.
		 *
		 * Extensions should not make any assumptions about the resulting uri and should not alter it in anyway.
		 * Rather, extensions can e.g. use this uri in an authentication flow, by adding the uri as callback query
		 * argument to the server to authenticate to.
		 *
		 * *Note* that if the server decides to add additional query parameters to the uri (e.g. a token or secret), it
		 * will appear in the uri that is passed to the [UriHandler](#UriHandler).
		 *
		 * **Example** of an authentication flow:
		 * ```typescript
		 * vscode.window.registerUriHandler({
		 *   handleUri(uri: vscode.Uri): vscode.ProviderResult<void> {
		 *     if (uri.path === '/did-authenticate') {
		 *       console.log(uri.toString());
		 *     }
		 *   }
		 * });
		 *
B
Benjamin Pasero 已提交
6506
		 * const callableUri = await vscode.env.asExternalUri(vscode.Uri.parse(`${vscode.env.uriScheme}://my.extension/did-authenticate`));
6507 6508
		 * await vscode.env.openExternal(callableUri);
		 * ```
M
Matt Bierner 已提交
6509
		 *
6510 6511 6512
		 * *Note* that extensions should not cache the result of `asExternalUri` as the resolved uri may become invalid due to
		 * a system or user action — for example, in remote cases, a user may close a port forwarding tunnel that was opened by
		 * `asExternalUri`.
M
Matt Bierner 已提交
6513 6514 6515 6516
		 *
		 * @return A uri that can be used on the client machine.
		 */
		export function asExternalUri(target: Uri): Thenable<Uri>;
6517 6518
	}

E
Erich Gamma 已提交
6519
	/**
6520 6521 6522 6523 6524 6525 6526 6527
	 * 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 已提交
6528
	 * the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette).
6529
	 * * keybinding - Use the `keybindings`-section in `package.json` to enable
G
Greg Van Liew 已提交
6530
	 * [keybindings](https://code.visualstudio.com/docs/getstarted/keybindings#_customizing-shortcuts)
6531 6532
	 * for your extension.
	 *
S
Steven Clarke 已提交
6533
	 * Commands from other extensions and from the editor itself are accessible to an extension. However,
6534 6535 6536
	 * 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 已提交
6537
	 * register a command handler with the identifier `extension.sayHello`.
6538 6539
	 * ```javascript
	 * commands.registerCommand('extension.sayHello', () => {
6540
	 * 	window.showInformationMessage('Hello World!');
6541 6542
	 * });
	 * ```
G
Gama11 已提交
6543
	 * Second, bind the command identifier to a title under which it will show in the palette (`package.json`).
6544 6545
	 * ```json
	 * {
6546 6547 6548 6549 6550 6551
	 * 	"contributes": {
	 * 		"commands": [{
	 * 			"command": "extension.sayHello",
	 * 			"title": "Hello World"
	 * 		}]
	 * 	}
6552 6553
	 * }
	 * ```
E
Erich Gamma 已提交
6554 6555 6556 6557 6558
	 */
	export namespace commands {

		/**
		 * Registers a command that can be invoked via a keyboard shortcut,
S
Steven Clarke 已提交
6559
		 * a menu item, an action, or directly.
E
Erich Gamma 已提交
6560
		 *
J
Johannes Rieken 已提交
6561 6562 6563 6564 6565
		 * 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 已提交
6566
		 * @param thisArg The `this` context used when invoking the handler function.
J
Johannes Rieken 已提交
6567
		 * @return Disposable which unregisters this command on disposal.
E
Erich Gamma 已提交
6568 6569 6570 6571
		 */
		export function registerCommand(command: string, callback: (...args: any[]) => any, thisArg?: any): Disposable;

		/**
J
Johannes Rieken 已提交
6572
		 * Registers a text editor command that can be invoked via a keyboard shortcut,
S
Steven Clarke 已提交
6573
		 * a menu item, an action, or directly.
E
Erich Gamma 已提交
6574
		 *
J
Johannes Rieken 已提交
6575
		 * Text editor commands are different from ordinary [commands](#commands.registerCommand) as
S
Steven Clarke 已提交
6576
		 * they only execute when there is an active editor when the command is called. Also, the
J
Johannes Rieken 已提交
6577 6578 6579 6580 6581
		 * 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 已提交
6582
		 * @param thisArg The `this` context used when invoking the handler function.
J
Johannes Rieken 已提交
6583
		 * @return Disposable which unregisters this command on disposal.
E
Erich Gamma 已提交
6584
		 */
J
Johannes Rieken 已提交
6585
		export function registerTextEditorCommand(command: string, callback: (textEditor: TextEditor, edit: TextEditorEdit, ...args: any[]) => void, thisArg?: any): Disposable;
E
Erich Gamma 已提交
6586 6587

		/**
J
Johannes Rieken 已提交
6588 6589
		 * Executes the command denoted by the given command identifier.
		 *
J
Johannes Rieken 已提交
6590
		 * * *Note 1:* When executing an editor command not all types are allowed to
6591
		 * be passed as arguments. Allowed are the primitive types `string`, `boolean`,
J
Johannes Rieken 已提交
6592 6593
		 * `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 已提交
6594
		 * by extensions.
E
Erich Gamma 已提交
6595
		 *
J
Johannes Rieken 已提交
6596
		 * @param command Identifier of the command to execute.
J
Johannes Rieken 已提交
6597 6598 6599
		 * @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 已提交
6600
		 */
6601
		export function executeCommand<T>(command: string, ...rest: any[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
6602 6603

		/**
P
Per Persson 已提交
6604
		 * Retrieve the list of all available commands. Commands starting with an underscore are
6605
		 * treated as internal commands.
E
Erich Gamma 已提交
6606
		 *
6607
		 * @param filterInternal Set `true` to not see internal commands (starting with an underscore)
E
Erich Gamma 已提交
6608 6609
		 * @return Thenable that resolves to a list of command ids.
		 */
6610
		export function getCommands(filterInternal?: boolean): Thenable<string[]>;
E
Erich Gamma 已提交
6611 6612
	}

J
Joao 已提交
6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623
	/**
	 * Represents the state of a window.
	 */
	export interface WindowState {

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

J
Joao Moreno 已提交
6624
	/**
J
Joao Moreno 已提交
6625
	 * A uri handler is responsible for handling system-wide [uris](#Uri).
J
Joao Moreno 已提交
6626 6627 6628 6629 6630 6631
	 *
	 * @see [window.registerUriHandler](#window.registerUriHandler).
	 */
	export interface UriHandler {

		/**
J
Joao Moreno 已提交
6632
		 * Handle the provided system-wide [uri](#Uri).
J
Joao Moreno 已提交
6633 6634 6635 6636 6637 6638
		 *
		 * @see [window.registerUriHandler](#window.registerUriHandler).
		 */
		handleUri(uri: Uri): ProviderResult<void>;
	}

E
Erich Gamma 已提交
6639
	/**
6640 6641 6642
	 * 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 已提交
6643 6644 6645 6646
	 */
	export namespace window {

		/**
6647
		 * The currently active editor or `undefined`. The active editor is the one
S
Steven Clarke 已提交
6648
		 * that currently has focus or, when none has focus, the one that has changed
E
Erich Gamma 已提交
6649 6650
		 * input most recently.
		 */
6651
		export let activeTextEditor: TextEditor | undefined;
E
Erich Gamma 已提交
6652 6653

		/**
6654
		 * The currently visible editors or an empty array.
E
Erich Gamma 已提交
6655 6656 6657 6658
		 */
		export let visibleTextEditors: TextEditor[];

		/**
6659
		 * An [event](#Event) which fires when the [active editor](#window.activeTextEditor)
J
Johannes Rieken 已提交
6660
		 * has changed. *Note* that the event also fires when the active editor changes
6661
		 * to `undefined`.
E
Erich Gamma 已提交
6662
		 */
6663
		export const onDidChangeActiveTextEditor: Event<TextEditor | undefined>;
E
Erich Gamma 已提交
6664

6665 6666 6667 6668
		/**
		 * An [event](#Event) which fires when the array of [visible editors](#window.visibleTextEditors)
		 * has changed.
		 */
6669
		export const onDidChangeVisibleTextEditors: Event<TextEditor[]>;
6670

E
Erich Gamma 已提交
6671
		/**
A
Andre Weinand 已提交
6672
		 * An [event](#Event) which fires when the selection in an editor has changed.
E
Erich Gamma 已提交
6673 6674 6675
		 */
		export const onDidChangeTextEditorSelection: Event<TextEditorSelectionChangeEvent>;

6676
		/**
6677
		 * An [event](#Event) which fires when the visible ranges of an editor has changed.
6678 6679 6680
		 */
		export const onDidChangeTextEditorVisibleRanges: Event<TextEditorVisibleRangesChangeEvent>;

E
Erich Gamma 已提交
6681 6682 6683 6684 6685
		/**
		 * An [event](#Event) which fires when the options of an editor have changed.
		 */
		export const onDidChangeTextEditorOptions: Event<TextEditorOptionsChangeEvent>;

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

D
Daniel Imms 已提交
6691 6692 6693 6694 6695
		/**
		 * The currently opened terminals or an empty array.
		 */
		export const terminals: ReadonlyArray<Terminal>;

D
Daniel Imms 已提交
6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708
		/**
		 * 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 已提交
6709 6710 6711 6712 6713 6714
		/**
		 * 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>;

6715
		/**
6716
		 * An [event](#Event) which fires when a terminal is disposed.
6717 6718 6719
		 */
		export const onDidCloseTerminal: Event<Terminal>;

J
Joao 已提交
6720 6721 6722
		/**
		 * Represents the current window's state.
		 */
6723
		export const state: WindowState;
J
Joao 已提交
6724 6725 6726 6727 6728 6729 6730

		/**
		 * 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 已提交
6731 6732 6733 6734 6735
		/**
		 * 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 已提交
6736
		 * @param column A view column in which the [editor](#TextEditor) should be shown. The default is the [active](#ViewColumn.Active), other values
6737 6738
		 * 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.
6739
		 * @param preserveFocus When `true` the editor will not take focus.
E
Erich Gamma 已提交
6740 6741
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
6742
		export function showTextDocument(document: TextDocument, column?: ViewColumn, preserveFocus?: boolean): Thenable<TextEditor>;
E
Erich Gamma 已提交
6743

6744
		/**
B
Benjamin Pasero 已提交
6745 6746
		 * 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).
6747 6748
		 *
		 * @param document A text document to be shown.
B
Benjamin Pasero 已提交
6749
		 * @param options [Editor options](#TextDocumentShowOptions) to configure the behavior of showing the [editor](#TextEditor).
6750 6751
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
6752
		export function showTextDocument(document: TextDocument, options?: TextDocumentShowOptions): Thenable<TextEditor>;
6753

B
Benjamin Pasero 已提交
6754
		/**
J
Johannes Rieken 已提交
6755
		 * A short-hand for `openTextDocument(uri).then(document => showTextDocument(document, options))`.
B
Benjamin Pasero 已提交
6756
		 *
J
Johannes Rieken 已提交
6757
		 * @see [openTextDocument](#openTextDocument)
B
Benjamin Pasero 已提交
6758 6759
		 *
		 * @param uri A resource identifier.
B
Benjamin Pasero 已提交
6760
		 * @param options [Editor options](#TextDocumentShowOptions) to configure the behavior of showing the [editor](#TextEditor).
B
Benjamin Pasero 已提交
6761 6762 6763 6764
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
		export function showTextDocument(uri: Uri, options?: TextDocumentShowOptions): Thenable<TextEditor>;

E
Erich Gamma 已提交
6765
		/**
J
Johannes Rieken 已提交
6766 6767 6768 6769
		 * 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 已提交
6770 6771 6772 6773 6774 6775 6776
		 */
		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 已提交
6777 6778
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
6779
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
6780
		 */
6781
		export function showInformationMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
6782

J
Joao Moreno 已提交
6783 6784 6785 6786 6787 6788 6789 6790 6791
		/**
		 * 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 已提交
6792
		export function showInformationMessage(message: string, options: MessageOptions, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
6793 6794

		/**
J
Johannes Rieken 已提交
6795
		 * Show an information message.
J
Johannes Rieken 已提交
6796
		 *
E
Erich Gamma 已提交
6797
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
6798 6799 6800
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
6801
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
6802
		 */
6803
		export function showInformationMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
6804

J
Joao Moreno 已提交
6805 6806 6807 6808 6809 6810 6811 6812 6813 6814
		/**
		 * 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 已提交
6815
		export function showInformationMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
6816 6817

		/**
J
Johannes Rieken 已提交
6818
		 * Show a warning message.
J
Johannes Rieken 已提交
6819
		 *
E
Erich Gamma 已提交
6820
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
6821 6822 6823
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
6824
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
6825
		 */
6826
		export function showWarningMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
6827

J
Joao Moreno 已提交
6828 6829 6830 6831 6832 6833 6834 6835 6836 6837
		/**
		 * 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 已提交
6838
		export function showWarningMessage(message: string, options: MessageOptions, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
6839 6840

		/**
J
Johannes Rieken 已提交
6841
		 * Show a warning message.
J
Johannes Rieken 已提交
6842
		 *
E
Erich Gamma 已提交
6843
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
6844 6845 6846
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
6847
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
6848
		 */
6849
		export function showWarningMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
6850

J
Joao Moreno 已提交
6851 6852 6853 6854 6855 6856 6857 6858 6859 6860
		/**
		 * 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 已提交
6861
		export function showWarningMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
6862 6863

		/**
J
Johannes Rieken 已提交
6864
		 * Show an error message.
J
Johannes Rieken 已提交
6865
		 *
E
Erich Gamma 已提交
6866
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
6867 6868 6869
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
6870
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
6871
		 */
6872
		export function showErrorMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
6873

J
Joao Moreno 已提交
6874 6875 6876 6877 6878 6879 6880 6881 6882 6883
		/**
		 * 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 已提交
6884
		export function showErrorMessage(message: string, options: MessageOptions, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
6885 6886

		/**
J
Johannes Rieken 已提交
6887
		 * Show an error message.
J
Johannes Rieken 已提交
6888
		 *
E
Erich Gamma 已提交
6889
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
6890 6891 6892
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
6893
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
6894
		 */
6895
		export function showErrorMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
6896

J
Joao Moreno 已提交
6897 6898 6899 6900 6901 6902 6903 6904 6905 6906
		/**
		 * 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 已提交
6907
		export function showErrorMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
6908

C
Christof Marti 已提交
6909 6910 6911 6912 6913 6914 6915 6916
		/**
		 * 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`.
		 */
6917
		export function showQuickPick(items: string[] | Thenable<string[]>, options: QuickPickOptions & { canPickMany: true; }, token?: CancellationToken): Thenable<string[] | undefined>;
C
Christof Marti 已提交
6918

E
Erich Gamma 已提交
6919 6920 6921
		/**
		 * Shows a selection list.
		 *
J
Johannes Rieken 已提交
6922 6923
		 * @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.
6924
		 * @param token A token that can be used to signal cancellation.
C
Christof Marti 已提交
6925
		 * @return A promise that resolves to the selection or `undefined`.
E
Erich Gamma 已提交
6926
		 */
6927
		export function showQuickPick(items: string[] | Thenable<string[]>, options?: QuickPickOptions, token?: CancellationToken): Thenable<string | undefined>;
E
Erich Gamma 已提交
6928

C
Christof Marti 已提交
6929 6930 6931 6932 6933 6934 6935 6936
		/**
		 * 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`.
		 */
6937
		export function showQuickPick<T extends QuickPickItem>(items: T[] | Thenable<T[]>, options: QuickPickOptions & { canPickMany: true; }, token?: CancellationToken): Thenable<T[] | undefined>;
C
Christof Marti 已提交
6938

E
Erich Gamma 已提交
6939 6940 6941
		/**
		 * Shows a selection list.
		 *
J
Johannes Rieken 已提交
6942 6943
		 * @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.
6944
		 * @param token A token that can be used to signal cancellation.
C
Christof Marti 已提交
6945
		 * @return A promise that resolves to the selected item or `undefined`.
E
Erich Gamma 已提交
6946
		 */
6947
		export function showQuickPick<T extends QuickPickItem>(items: T[] | Thenable<T[]>, options?: QuickPickOptions, token?: CancellationToken): Thenable<T | undefined>;
E
Erich Gamma 已提交
6948

6949 6950 6951 6952 6953 6954 6955 6956 6957
		/**
		 * 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>;

6958
		/**
6959 6960
		 * Shows a file open dialog to the user which allows to select a file
		 * for opening-purposes.
6961 6962 6963 6964 6965 6966 6967
		 *
		 * @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>;

		/**
6968 6969
		 * Shows a file save dialog to the user which allows to select a file
		 * for saving-purposes.
6970 6971 6972 6973 6974 6975
		 *
		 * @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 已提交
6976 6977 6978
		/**
		 * Opens an input box to ask the user for input.
		 *
6979
		 * The returned value will be `undefined` if the input box was canceled (e.g. pressing ESC). Otherwise the
A
Andre Weinand 已提交
6980
		 * returned value will be the string typed by the user or an empty string if the user did not type
S
Steven Clarke 已提交
6981
		 * anything but dismissed the input box with OK.
E
Erich Gamma 已提交
6982
		 *
J
Johannes Rieken 已提交
6983
		 * @param options Configures the behavior of the input box.
6984
		 * @param token A token that can be used to signal cancellation.
J
Johannes Rieken 已提交
6985
		 * @return A promise that resolves to a string the user provided or to `undefined` in case of dismissal.
E
Erich Gamma 已提交
6986
		 */
6987
		export function showInputBox(options?: InputBoxOptions, token?: CancellationToken): Thenable<string | undefined>;
E
Erich Gamma 已提交
6988

C
Christof Marti 已提交
6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011
		/**
		 * 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 已提交
7012
		/**
7013 7014
		 * Creates a new [output channel](#OutputChannel) with the given name.
		 *
7015
		 * @param name Human-readable string which will be used to represent the channel in the UI.
E
Erich Gamma 已提交
7016
		 */
S
Sandeep Somavarapu 已提交
7017
		export function createOutputChannel(name: string): OutputChannel;
E
Erich Gamma 已提交
7018

7019 7020 7021 7022 7023
		/**
		 * Create and show a new webview panel.
		 *
		 * @param viewType Identifies the type of the webview panel.
		 * @param title Title of the panel.
7024
		 * @param showOptions Where to show the webview in the editor. If preserveFocus is set, the new webview will not take focus.
7025 7026 7027 7028
		 * @param options Settings for the new panel.
		 *
		 * @return New webview panel.
		 */
7029
		export function createWebviewPanel(viewType: string, title: string, showOptions: ViewColumn | { viewColumn: ViewColumn, preserveFocus?: boolean }, options?: WebviewPanelOptions & WebviewOptions): WebviewPanel;
7030

E
Erich Gamma 已提交
7031
		/**
S
Steven Clarke 已提交
7032
		 * Set a message to the status bar. This is a short hand for the more powerful
E
Erich Gamma 已提交
7033
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
7034
		 *
G
Gama11 已提交
7035
		 * @param text The message to show, supports icon substitution as in status bar [items](#StatusBarItem.text).
7036
		 * @param hideAfterTimeout Timeout in milliseconds after which the message will be disposed.
J
Johannes Rieken 已提交
7037
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
7038
		 */
7039
		export function setStatusBarMessage(text: string, hideAfterTimeout: number): Disposable;
E
Erich Gamma 已提交
7040 7041

		/**
S
Steven Clarke 已提交
7042
		 * Set a message to the status bar. This is a short hand for the more powerful
J
Johannes Rieken 已提交
7043
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
7044
		 *
G
Gama11 已提交
7045
		 * @param text The message to show, supports icon substitution as in status bar [items](#StatusBarItem.text).
7046
		 * @param hideWhenDone Thenable on which completion (resolve or reject) the message will be disposed.
J
Johannes Rieken 已提交
7047
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
7048
		 */
7049
		export function setStatusBarMessage(text: string, hideWhenDone: Thenable<any>): Disposable;
E
Erich Gamma 已提交
7050 7051

		/**
S
Steven Clarke 已提交
7052
		 * Set a message to the status bar. This is a short hand for the more powerful
J
Johannes Rieken 已提交
7053
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
7054
		 *
7055 7056 7057
		 * *Note* that status bar messages stack and that they must be disposed when no
		 * longer used.
		 *
G
Gama11 已提交
7058
		 * @param text The message to show, supports icon substitution as in status bar [items](#StatusBarItem.text).
J
Johannes Rieken 已提交
7059
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
7060
		 */
7061
		export function setStatusBarMessage(text: string): Disposable;
E
Erich Gamma 已提交
7062

7063
		/**
J
Johannes Rieken 已提交
7064 7065
		 * ~~Show progress in the Source Control viewlet while running the given callback and while
		 * its returned promise isn't resolve or rejected.~~
7066
		 *
7067 7068
		 * @deprecated Use `withProgress` instead.
		 *
7069 7070
		 * @param task A callback returning a promise. Progress increments can be reported with
		 * the provided [progress](#Progress)-object.
7071
		 * @return The thenable the task did return.
7072 7073 7074
		 */
		export function withScmProgress<R>(task: (progress: Progress<number>) => Thenable<R>): Thenable<R>;

J
Johannes Rieken 已提交
7075 7076 7077 7078 7079 7080 7081
		/**
		 * 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.
7082
		 *
7083 7084 7085 7086
		 * 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.
7087 7088 7089 7090 7091
		 *
		 * 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 已提交
7092 7093
		 * @return The thenable the task-callback returned.
		 */
7094
		export function withProgress<R>(options: ProgressOptions, task: (progress: Progress<{ message?: string; increment?: number }>, token: CancellationToken) => Thenable<R>): Thenable<R>;
7095

E
Erich Gamma 已提交
7096
		/**
J
Johannes Rieken 已提交
7097 7098
		 * Creates a status bar [item](#StatusBarItem).
		 *
J
Johannes Rieken 已提交
7099
		 * @param alignment The alignment of the item.
J
Johannes Rieken 已提交
7100
		 * @param priority The priority of the item. Higher values mean the item should be shown more to the left.
J
Johannes Rieken 已提交
7101 7102
		 * @return A new status bar item.
		 */
E
Erich Gamma 已提交
7103
		export function createStatusBarItem(alignment?: StatusBarAlignment, priority?: number): StatusBarItem;
D
Daniel Imms 已提交
7104

D
Daniel Imms 已提交
7105
		/**
D
Daniel Imms 已提交
7106 7107
		 * 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 已提交
7108
		 *
7109
		 * @param name Optional human-readable string which will be used to represent the terminal in the UI.
7110
		 * @param shellPath Optional path to a custom shell executable to be used in the terminal.
7111
		 * @param shellArgs Optional args for the custom shell executable. A string can be used on Windows only which
D
Daniel Imms 已提交
7112 7113
		 * allows specifying shell args in
		 * [command-line format](https://msdn.microsoft.com/en-au/08dfcab2-eb6e-49a4-80eb-87d4076c98c6).
D
Daniel Imms 已提交
7114 7115
		 * @return A new Terminal.
		 */
7116
		export function createTerminal(name?: string, shellPath?: string, shellArgs?: string[] | string): Terminal;
7117 7118

		/**
D
Daniel Imms 已提交
7119
		 * Creates a [Terminal](#Terminal) with a backing shell process.
7120 7121 7122 7123 7124
		 *
		 * @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 已提交
7125

7126 7127 7128 7129 7130 7131 7132 7133 7134
		/**
		 * 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 已提交
7135 7136
		/**
		 * Register a [TreeDataProvider](#TreeDataProvider) for the view contributed using the extension point `views`.
7137
		 * This will allow you to contribute data to the [TreeView](#TreeView) and update if the data changes.
S
Sandeep Somavarapu 已提交
7138
		 *
S
Sandeep Somavarapu 已提交
7139
		 * **Note:** To get access to the [TreeView](#TreeView) and perform operations on it, use [createTreeView](#window.createTreeView).
7140
		 *
S
Sandeep Somavarapu 已提交
7141 7142 7143 7144
		 * @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;
7145 7146 7147 7148

		/**
		 * 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 已提交
7149
		 * @param options Options for creating the [TreeView](#TreeView)
7150 7151
		 * @returns a [TreeView](#TreeView).
		 */
S
Sandeep Somavarapu 已提交
7152
		export function createTreeView<T>(viewId: string, options: TreeViewOptions<T>): TreeView<T>;
J
Joao Moreno 已提交
7153 7154

		/**
J
Joao Moreno 已提交
7155 7156 7157 7158 7159
		 * 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 已提交
7160
		 *
7161
		 * - The uri-scheme must be `vscode.env.uriScheme`;
7162
		 * - The uri-authority must be the extension id (e.g. `my.extension`);
J
Joao Moreno 已提交
7163 7164
		 * - The uri-path, -query and -fragment parts are arbitrary.
		 *
J
Joao Moreno 已提交
7165 7166
		 * 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 已提交
7167
		 *
J
Joao Moreno 已提交
7168
		 * An extension can only register a single uri handler in its entire activation lifetime.
J
Joao Moreno 已提交
7169
		 *
J
Joao Moreno 已提交
7170
		 * * *Note:* There is an activation event `onUri` that fires when a uri directed for
J
Joao Moreno 已提交
7171 7172
		 * the current extension is about to be handled.
		 *
J
Joao Moreno 已提交
7173
		 * @param handler The uri handler to register for this extension.
J
Joao Moreno 已提交
7174 7175
		 */
		export function registerUriHandler(handler: UriHandler): Disposable;
7176

7177 7178 7179
		/**
		 * Registers a webview panel serializer.
		 *
J
Joao Moreno 已提交
7180 7181
		 * Extensions that support reviving should have an `"onWebviewPanel:viewType"` activation event and
		 * make sure that [registerWebviewPanelSerializer](#registerWebviewPanelSerializer) is called during activation.
7182
		 *
J
Joao Moreno 已提交
7183
		 * Only a single serializer may be registered at a time for a given `viewType`.
7184 7185 7186 7187 7188
		 *
		 * @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 已提交
7189 7190
	}

S
Sandeep Somavarapu 已提交
7191
	/**
7192
	 * Options for creating a [TreeView](#TreeView)
S
Sandeep Somavarapu 已提交
7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204
	 */
	export interface TreeViewOptions<T> {

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

		/**
		 * Whether to show collapse all action or not.
		 */
		showCollapseAll?: boolean;
7205 7206 7207 7208

		/**
		 * 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
7209
		 * array containing all selected tree items.
7210 7211
		 */
		canSelectMany?: boolean;
S
Sandeep Somavarapu 已提交
7212 7213
	}

S
Sandeep Somavarapu 已提交
7214 7215 7216 7217 7218 7219 7220 7221
	/**
	 * 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.
		 */
7222
		readonly element: T;
S
Sandeep Somavarapu 已提交
7223 7224 7225

	}

S
Sandeep Somavarapu 已提交
7226
	/**
7227
	 * The event that is fired when there is a change in [tree view's selection](#TreeView.selection)
S
Sandeep Somavarapu 已提交
7228 7229 7230 7231 7232 7233
	 */
	export interface TreeViewSelectionChangeEvent<T> {

		/**
		 * Selected elements.
		 */
7234
		readonly selection: T[];
7235 7236 7237

	}

S
Add doc  
Sandeep Somavarapu 已提交
7238 7239 7240
	/**
	 * The event that is fired when there is a change in [tree view's visibility](#TreeView.visible)
	 */
7241 7242 7243 7244 7245
	export interface TreeViewVisibilityChangeEvent {

		/**
		 * `true` if the [tree view](#TreeView) is visible otherwise `false`.
		 */
7246
		readonly visible: boolean;
S
Sandeep Somavarapu 已提交
7247 7248 7249

	}

7250 7251 7252 7253 7254
	/**
	 * Represents a Tree view
	 */
	export interface TreeView<T> extends Disposable {

S
Sandeep Somavarapu 已提交
7255 7256 7257
		/**
		 * Event that is fired when an element is expanded
		 */
S
Sandeep Somavarapu 已提交
7258
		readonly onDidExpandElement: Event<TreeViewExpansionEvent<T>>;
S
Sandeep Somavarapu 已提交
7259 7260 7261 7262

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

S
Sandeep Somavarapu 已提交
7265
		/**
7266 7267
		 * Currently selected elements.
		 */
7268
		readonly selection: T[];
7269 7270 7271

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

S
Sandeep Somavarapu 已提交
7275
		/**
7276
		 * `true` if the [tree view](#TreeView) is visible otherwise `false`.
S
Sandeep Somavarapu 已提交
7277
		 */
7278
		readonly visible: boolean;
S
Sandeep Somavarapu 已提交
7279

7280
		/**
M
Matthew J. Clemente 已提交
7281
		 * Event that is fired when [visibility](#TreeView.visible) has changed
7282 7283 7284
		 */
		readonly onDidChangeVisibility: Event<TreeViewVisibilityChangeEvent>;

A
Alex Ross 已提交
7285 7286
		/**
		 * An optional human-readable message that will be rendered in the view.
A
Alex Ross 已提交
7287
		 * Setting the message to null, undefined, or empty string will remove the message from the view.
A
Alex Ross 已提交
7288 7289 7290
		 */
		message?: string;

A
Alex Ross 已提交
7291 7292 7293 7294 7295 7296
		/**
		 * The tree view title is initially taken from the extension package.json
		 * Changes to the title property will be properly reflected in the UI in the title of the view.
		 */
		title?: string;

7297 7298
		/**
		 * Reveals the given element in the tree view.
S
Sandeep Somavarapu 已提交
7299
		 * If the tree view is not visible then the tree view is shown and element is revealed.
7300
		 *
S
Sandeep Somavarapu 已提交
7301
		 * By default revealed element is selected.
7302
		 * In order to not to select, set the option `select` to `false`.
7303
		 * In order to focus, set the option `focus` to `true`.
7304 7305
		 * 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.
7306 7307 7308
		 *
		 * **NOTE:** [TreeDataProvider](#TreeDataProvider) is required to implement [getParent](#TreeDataProvider.getParent) method to access this API.
		 */
7309
		reveal(element: T, options?: { select?: boolean, focus?: boolean, expand?: boolean | number }): Thenable<void>;
S
Sandeep Somavarapu 已提交
7310 7311 7312 7313 7314 7315 7316 7317
	}

	/**
	 * 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 已提交
7318
		 * This will trigger the view to update the changed element/root and its children recursively (if shown).
S
Sandeep Somavarapu 已提交
7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337
		 * 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[]>;
7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348

		/**
		 * 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 已提交
7349 7350 7351 7352
	}

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

7357
		/**
7358
		 * 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.
7359
		 *
7360
		 * 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.
7361 7362 7363
		 */
		id?: string;

S
Sandeep Somavarapu 已提交
7364
		/**
7365
		 * The icon path or [ThemeIcon](#ThemeIcon) for the tree item.
S
Sandeep Somavarapu 已提交
7366 7367
		 * 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 已提交
7368
		 */
7369
		iconPath?: string | Uri | { light: string | Uri; dark: string | Uri } | ThemeIcon;
S
Sandeep Somavarapu 已提交
7370

S
Sandeep Somavarapu 已提交
7371 7372 7373 7374 7375 7376
		/**
		 * 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;

7377 7378
		/**
		 * The [uri](#Uri) of the resource representing this item.
S
Sandeep Somavarapu 已提交
7379 7380
		 *
		 * Will be used to derive the [label](#TreeItem.label), when it is not provided.
S
Sandeep Somavarapu 已提交
7381
		 * Will be used to derive the icon from current icon theme, when [iconPath](#TreeItem.iconPath) has [ThemeIcon](#ThemeIcon) value.
7382
		 */
7383
		resourceUri?: Uri;
7384

S
Sandeep Somavarapu 已提交
7385 7386 7387 7388 7389
		/**
		 * The tooltip text when you hover over this item.
		 */
		tooltip?: string | undefined;

S
Sandeep Somavarapu 已提交
7390
		/**
7391
		 * The [command](#Command) that should be executed when the tree item is selected.
S
Sandeep Somavarapu 已提交
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
		 */
		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);
7425 7426 7427 7428 7429 7430

		/**
		 * @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 已提交
7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448
	}

	/**
	 * 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
7449 7450 7451
	}

	/**
J
Johannes Rieken 已提交
7452
	 * Value-object describing what options a terminal should use.
7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465
	 */
	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;

		/**
7466 7467
		 * 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).
7468
		 */
7469
		shellArgs?: string[] | string;
7470 7471

		/**
K
kieferrm 已提交
7472
		 * A path or Uri for the current working directory to be used for the terminal.
7473
		 */
K
kieferrm 已提交
7474
		cwd?: string | Uri;
7475

7476 7477 7478
		/**
		 * Object with environment variables that will be added to the VS Code process.
		 */
C
Christof Marti 已提交
7479
		env?: { [key: string]: string | null };
7480 7481 7482 7483 7484

		/**
		 * 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 已提交
7485 7486
		 * `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.
7487 7488
		 */
		strictEnv?: boolean;
7489 7490 7491 7492 7493 7494 7495 7496

		/**
		 * 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.
		 */
7497
		hideFromUser?: boolean;
E
Erich Gamma 已提交
7498 7499
	}

7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524
	/**
	 * Value-object describing what options a virtual process terminal should use.
	 */
	export interface ExtensionTerminalOptions {
		/**
		 * A human-readable string which will be used to represent the terminal in the UI.
		 */
		name: string;

		/**
		 * An implementation of [Pseudoterminal](#Pseudoterminal) that allows an extension to
		 * control a terminal.
		 */
		pty: Pseudoterminal;
	}

	/**
	 * Defines the interface of a terminal pty, enabling extensions to control a terminal.
	 */
	interface Pseudoterminal {
		/**
		 * An event that when fired will write data to the terminal. Unlike
		 * [Terminal.sendText](#Terminal.sendText) which sends text to the underlying _process_
		 * (the pty "slave"), this will write the text to the terminal itself (the pty "master").
		 *
D
Daniel Imms 已提交
7525 7526 7527
		 * Note writing `\n` will just move the cursor down 1 row, you need to write `\r` as well
		 * to move the cursor to the left-most cell.
		 *
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 7577
		 * **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
7578
		 * `CustomExecution` API.
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 7661 7662 7663 7664 7665
		 *
		 * **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 已提交
7666 7667 7668 7669 7670 7671 7672
	/**
	 * 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 {

		/**
7673
		 * Show progress for the source control viewlet, as overlay for the icon and as progress bar
7674
		 * inside the viewlet (when visible). Neither supports cancellation nor discrete progress.
J
Johannes Rieken 已提交
7675
		 */
7676
		SourceControl = 1,
J
Johannes Rieken 已提交
7677 7678

		/**
7679
		 * Show progress in the status bar of the editor. Neither supports cancellation nor discrete progress.
J
Johannes Rieken 已提交
7680
		 */
7681 7682 7683
		Window = 10,

		/**
7684
		 * Show progress as notification with an optional cancel button. Supports to show infinite and discrete progress.
7685 7686
		 */
		Notification = 15
J
Johannes Rieken 已提交
7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703
	}

	/**
	 * 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;
7704 7705 7706 7707 7708 7709 7710 7711

		/**
		 * 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 已提交
7712 7713
	}

C
Christof Marti 已提交
7714
	/**
7715
	 * A light-weight user input UI that is initially not visible. After
C
Christof Marti 已提交
7716 7717 7718 7719 7720
	 * 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).
7721
	 * (Examples include: an explicit call to [QuickInput.hide](#QuickInput.hide),
C
Christof Marti 已提交
7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789
	 * 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).
7790
		 * (Examples include: an explicit call to [QuickInput.hide](#QuickInput.hide),
C
Christof Marti 已提交
7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873
		 * 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.
		 */
7874
		readonly onDidChangeActive: Event<T[]>;
C
Christof Marti 已提交
7875 7876 7877 7878 7879 7880 7881 7882 7883

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

		/**
		 * An event signaling when the selected items have changed.
		 */
7884
		readonly onDidChangeSelection: Event<T[]>;
C
Christof Marti 已提交
7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949
	}

	/**
	 * 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.
		 */
7950
		readonly iconPath: Uri | { light: Uri; dark: Uri } | ThemeIcon;
C
Christof Marti 已提交
7951 7952 7953 7954 7955 7956 7957 7958 7959 7960

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

	/**
	 * Predefined buttons for [QuickPick](#QuickPick) and [InputBox](#InputBox).
	 */
7961
	export class QuickInputButtons {
C
Christof Marti 已提交
7962 7963 7964 7965 7966 7967 7968

		/**
		 * 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.
		 */
7969 7970 7971 7972 7973 7974
		static readonly Back: QuickInputButton;

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

E
Erich Gamma 已提交
7977
	/**
A
Alex Dima 已提交
7978
	 * An event describing an individual change in the text of a [document](#TextDocument).
E
Erich Gamma 已提交
7979 7980 7981 7982 7983 7984
	 */
	export interface TextDocumentContentChangeEvent {
		/**
		 * The range that got replaced.
		 */
		range: Range;
7985 7986 7987 7988
		/**
		 * The offset of the range that got replaced.
		 */
		rangeOffset: number;
E
Erich Gamma 已提交
7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999
		/**
		 * The length of the range that got replaced.
		 */
		rangeLength: number;
		/**
		 * The new text for the range.
		 */
		text: string;
	}

	/**
A
Alex Dima 已提交
8000
	 * An event describing a transactional [document](#TextDocument) change.
E
Erich Gamma 已提交
8001 8002 8003 8004 8005 8006
	 */
	export interface TextDocumentChangeEvent {

		/**
		 * The affected document.
		 */
8007
		readonly document: TextDocument;
E
Erich Gamma 已提交
8008 8009 8010 8011

		/**
		 * An array of content changes.
		 */
8012
		readonly contentChanges: ReadonlyArray<TextDocumentContentChangeEvent>;
E
Erich Gamma 已提交
8013 8014
	}

8015 8016 8017 8018 8019 8020
	/**
	 * Represents reasons why a text document is saved.
	 */
	export enum TextDocumentSaveReason {

		/**
8021 8022
		 * Manually triggered, e.g. by the user pressing save, by starting debugging,
		 * or by an API call.
8023
		 */
8024
		Manual = 1,
8025 8026 8027 8028

		/**
		 * Automatic after a delay.
		 */
8029
		AfterDelay = 2,
8030 8031 8032 8033 8034 8035 8036

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

8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048
	/**
	 * 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.
		 */
8049
		readonly document: TextDocument;
8050

8051 8052 8053
		/**
		 * The reason why save was triggered.
		 */
8054
		readonly reason: TextDocumentSaveReason;
8055

8056 8057 8058 8059 8060 8061 8062 8063 8064 8065
		/**
		 * 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 => {
8066 8067 8068 8069 8070
		 * 	// async, will *throw* an error
		 * 	setTimeout(() => event.waitUntil(promise));
		 *
		 * 	// sync, OK
		 * 	event.waitUntil(promise);
8071 8072 8073 8074 8075
		 * })
		 * ```
		 *
		 * @param thenable A thenable that resolves to [pre-save-edits](#TextEdit).
		 */
8076
		waitUntil(thenable: Thenable<TextEdit[]>): void;
8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087

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

J
Johannes Rieken 已提交
8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253
	/**
	 * An event that is fired when files are going to be created.
	 *
	 * To make modifications to the workspace before the files are created,
	 * call the [`waitUntil](#FileWillCreateEvent.waitUntil)-function with a
	 * thenable that resolves to a [workspace edit](#WorkspaceEdit).
	 */
	export interface FileWillCreateEvent {

		/**
		 * The files that are going to be created.
		 */
		readonly files: ReadonlyArray<Uri>;

		/**
		 * Allows to pause the event and to apply a [workspace edit](#WorkspaceEdit).
		 *
		 * *Note:* This function can only be called during event dispatch and not
		 * in an asynchronous manner:
		 *
		 * ```ts
		 * workspace.onWillCreateFiles(event => {
		 * 	// async, will *throw* an error
		 * 	setTimeout(() => event.waitUntil(promise));
		 *
		 * 	// sync, OK
		 * 	event.waitUntil(promise);
		 * })
		 * ```
		 *
		 * @param thenable A thenable that delays saving.
		 */
		waitUntil(thenable: Thenable<WorkspaceEdit>): void;

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

	/**
	 * An event that is fired after files are created.
	 */
	export interface FileCreateEvent {

		/**
		 * The files that got created.
		 */
		readonly files: ReadonlyArray<Uri>;
	}

	/**
	 * An event that is fired when files are going to be deleted.
	 *
	 * To make modifications to the workspace before the files are deleted,
	 * call the [`waitUntil](#FileWillCreateEvent.waitUntil)-function with a
	 * thenable that resolves to a [workspace edit](#WorkspaceEdit).
	 */
	export interface FileWillDeleteEvent {

		/**
		 * The files that are going to be deleted.
		 */
		readonly files: ReadonlyArray<Uri>;

		/**
		 * Allows to pause the event and to apply a [workspace edit](#WorkspaceEdit).
		 *
		 * *Note:* This function can only be called during event dispatch and not
		 * in an asynchronous manner:
		 *
		 * ```ts
		 * workspace.onWillCreateFiles(event => {
		 * 	// async, will *throw* an error
		 * 	setTimeout(() => event.waitUntil(promise));
		 *
		 * 	// sync, OK
		 * 	event.waitUntil(promise);
		 * })
		 * ```
		 *
		 * @param thenable A thenable that delays saving.
		 */
		waitUntil(thenable: Thenable<WorkspaceEdit>): void;

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

	/**
	 * An event that is fired after files are deleted.
	 */
	export interface FileDeleteEvent {

		/**
		 * The files that got deleted.
		 */
		readonly files: ReadonlyArray<Uri>;
	}

	/**
	 * An event that is fired when files are going to be renamed.
	 *
	 * To make modifications to the workspace before the files are renamed,
	 * call the [`waitUntil](#FileWillCreateEvent.waitUntil)-function with a
	 * thenable that resolves to a [workspace edit](#WorkspaceEdit).
	 */
	export interface FileWillRenameEvent {

		/**
		 * The files that are going to be renamed.
		 */
		readonly files: ReadonlyArray<{ oldUri: Uri, newUri: Uri }>;

		/**
		 * Allows to pause the event and to apply a [workspace edit](#WorkspaceEdit).
		 *
		 * *Note:* This function can only be called during event dispatch and not
		 * in an asynchronous manner:
		 *
		 * ```ts
		 * workspace.onWillCreateFiles(event => {
		 * 	// async, will *throw* an error
		 * 	setTimeout(() => event.waitUntil(promise));
		 *
		 * 	// sync, OK
		 * 	event.waitUntil(promise);
		 * })
		 * ```
		 *
		 * @param thenable A thenable that delays saving.
		 */
		waitUntil(thenable: Thenable<WorkspaceEdit>): void;

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

	/**
	 * An event that is fired after files are renamed.
	 */
	export interface FileRenameEvent {

		/**
		 * The files that got renamed.
		 */
		readonly files: ReadonlyArray<{ oldUri: Uri, newUri: Uri }>;
	}


8254 8255 8256 8257 8258 8259 8260
	/**
	 * An event describing a change to the set of [workspace folders](#workspace.workspaceFolders).
	 */
	export interface WorkspaceFoldersChangeEvent {
		/**
		 * Added workspace folders.
		 */
8261
		readonly added: ReadonlyArray<WorkspaceFolder>;
8262 8263 8264 8265

		/**
		 * Removed workspace folders.
		 */
8266
		readonly removed: ReadonlyArray<WorkspaceFolder>;
8267 8268 8269 8270
	}

	/**
	 * A workspace folder is one of potentially many roots opened by the editor. All workspace folders
8271
	 * are equal which means there is no notion of an active or master workspace folder.
8272 8273 8274 8275
	 */
	export interface WorkspaceFolder {

		/**
J
Johannes Rieken 已提交
8276 8277 8278 8279
		 * 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`.
8280 8281 8282 8283 8284
		 */
		readonly uri: Uri;

		/**
		 * The name of this workspace folder. Defaults to
J
Johannes Rieken 已提交
8285
		 * the basename of its [uri-path](#Uri.path)
8286 8287 8288 8289 8290 8291 8292 8293 8294
		 */
		readonly name: string;

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

E
Erich Gamma 已提交
8295
	/**
8296 8297 8298 8299 8300
	 * 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
8301
	 * events and for [finding](#workspace.findFiles) files. Both perform well and run _outside_
S
Steven Clarke 已提交
8302
	 * the editor-process so that they should be always used instead of nodejs-equivalents.
E
Erich Gamma 已提交
8303 8304 8305
	 */
	export namespace workspace {

8306 8307 8308 8309 8310 8311 8312 8313
		/**
		 * 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 已提交
8314
		/**
8315 8316
		 * ~~The folder that is open in the editor. `undefined` when no folder
		 * has been opened.~~
J
Johannes Rieken 已提交
8317
		 *
8318
		 * @deprecated Use [`workspaceFolders`](#workspace.workspaceFolders) instead.
E
Erich Gamma 已提交
8319
		 */
8320
		export const rootPath: string | undefined;
E
Erich Gamma 已提交
8321 8322

		/**
J
Johannes Rieken 已提交
8323 8324
		 * 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 已提交
8325
		 */
8326
		export const workspaceFolders: WorkspaceFolder[] | undefined;
8327

8328 8329 8330 8331
		/**
		 * The name of the workspace. `undefined` when no folder
		 * has been opened.
		 */
8332
		export const name: string | undefined;
8333

8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364
		/**
		 * 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;

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

		/**
8371 8372 8373
		 * 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
8374 8375 8376 8377 8378
		 *
		 * @param uri An uri.
		 * @return A workspace folder or `undefined`
		 */
		export function getWorkspaceFolder(uri: Uri): WorkspaceFolder | undefined;
E
Erich Gamma 已提交
8379 8380

		/**
8381
		 * Returns a path that is relative to the workspace folder or folders.
J
Johannes Rieken 已提交
8382
		 *
8383
		 * When there are no [workspace folders](#workspace.workspaceFolders) or when the path
J
Johannes Rieken 已提交
8384
		 * is not contained in them, the input is returned.
J
Johannes Rieken 已提交
8385 8386
		 *
		 * @param pathOrUri A path or uri. When a uri is given its [fsPath](#Uri.fsPath) is used.
J
Johannes Rieken 已提交
8387 8388 8389
		 * @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 已提交
8390
		 * @return A path relative to the root or the input.
E
Erich Gamma 已提交
8391
		 */
J
Johannes Rieken 已提交
8392
		export function asRelativePath(pathOrUri: string | Uri, includeWorkspaceFolder?: boolean): string;
E
Erich Gamma 已提交
8393

8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436
		/**
		 * 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;

8437 8438 8439
		/**
		 * Creates a file system watcher.
		 *
8440 8441
		 * 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.
8442
		 *
8443
		 * *Note* that only files within the current [workspace folders](#workspace.workspaceFolders) can be watched.
8444
		 *
8445
		 * @param globPattern A [glob pattern](#GlobPattern) that is applied to the absolute paths of created, changed,
B
Benjamin Pasero 已提交
8446
		 * and deleted files. Use a [relative pattern](#RelativePattern) to limit events to a certain [workspace folder](#WorkspaceFolder).
8447 8448 8449 8450 8451
		 * @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.
		 */
8452
		export function createFileSystemWatcher(globPattern: GlobPattern, ignoreCreateEvents?: boolean, ignoreChangeEvents?: boolean, ignoreDeleteEvents?: boolean): FileSystemWatcher;
8453

J
Johannes Rieken 已提交
8454
		/**
B
Benjamin Pasero 已提交
8455
		 * Find files across all [workspace folders](#workspace.workspaceFolders) in the workspace.
J
Johannes Rieken 已提交
8456
		 *
8457
		 * @sample `findFiles('**​/*.js', '**​/node_modules/**', 10)`
8458
		 * @param include A [glob pattern](#GlobPattern) that defines the files to search for. The glob pattern
B
Benjamin Pasero 已提交
8459 8460
		 * 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).
8461
		 * @param exclude  A [glob pattern](#GlobPattern) that defines files and folders to exclude. The glob pattern
J
Johannes Rieken 已提交
8462
		 * will be matched against the file paths of resulting matches relative to their workspace. When `undefined` only default excludes will
8463
		 * apply, when `null` no excludes will apply.
J
Johannes Rieken 已提交
8464
		 * @param maxResults An upper-bound for the result.
8465
		 * @param token A token that can be used to signal cancellation to the underlying search engine.
B
Benjamin Pasero 已提交
8466 8467
		 * @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 已提交
8468
		 */
J
Johannes Rieken 已提交
8469
		export function findFiles(include: GlobPattern, exclude?: GlobPattern | null, maxResults?: number, token?: CancellationToken): Thenable<Uri[]>;
E
Erich Gamma 已提交
8470 8471

		/**
J
Johannes Rieken 已提交
8472 8473 8474
		 * Save all dirty files.
		 *
		 * @param includeUntitled Also save files that have been created during this session.
S
Steven Clarke 已提交
8475
		 * @return A thenable that resolves when the files have been saved.
E
Erich Gamma 已提交
8476 8477 8478 8479
		 */
		export function saveAll(includeUntitled?: boolean): Thenable<boolean>;

		/**
8480
		 * Make changes to one or many resources or create, delete, and rename resources as defined by the given
J
Johannes Rieken 已提交
8481 8482
		 * [workspace edit](#WorkspaceEdit).
		 *
8483 8484
		 * All changes of a workspace edit are applied in the same order in which they have been added. If
		 * multiple textual inserts are made at the same position, these strings appear in the resulting text
J
Johannes Rieken 已提交
8485 8486
		 * in the order the 'inserts' were made, unless that are interleaved with resource edits. Invalid sequences
		 * like 'delete file a' -> 'insert text in file a' cause failure of the operation.
8487 8488
		 *
		 * When applying a workspace edit that consists only of text edits an 'all-or-nothing'-strategy is used.
8489
		 * A workspace edit with resource creations or deletions aborts the operation, e.g. consecutive edits will
8490
		 * not be attempted, when a single edit fails.
J
Johannes Rieken 已提交
8491 8492 8493
		 *
		 * @param edit A workspace edit.
		 * @return A thenable that resolves when the edit could be applied.
E
Erich Gamma 已提交
8494 8495 8496 8497 8498 8499
		 */
		export function applyEdit(edit: WorkspaceEdit): Thenable<boolean>;

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

		/**
8503 8504 8505 8506 8507 8508 8509 8510
		 * 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 已提交
8511 8512
		 * * For all other schemes contributed [text document content providers](#TextDocumentContentProvider) and
		 * [file system providers](#FileSystemProvider) are consulted.
8513 8514 8515
		 *
		 * *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 已提交
8516 8517 8518 8519 8520 8521 8522
		 *
		 * @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 已提交
8523 8524 8525
		 * A short-hand for `openTextDocument(Uri.file(fileName))`.
		 *
		 * @see [openTextDocument](#openTextDocument)
A
Andre Weinand 已提交
8526 8527
		 * @param fileName A name of a file on disk.
		 * @return A promise that resolves to a [document](#TextDocument).
E
Erich Gamma 已提交
8528 8529 8530
		 */
		export function openTextDocument(fileName: string): Thenable<TextDocument>;

B
Benjamin Pasero 已提交
8531
		/**
J
Johannes Rieken 已提交
8532 8533
		 * 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
8534
		 * specify the *language* and/or the *content* of the document.
B
Benjamin Pasero 已提交
8535
		 *
J
Johannes Rieken 已提交
8536
		 * @param options Options to control how the document will be created.
B
Benjamin Pasero 已提交
8537 8538
		 * @return A promise that resolves to a [document](#TextDocument).
		 */
8539
		export function openTextDocument(options?: { language?: string; content?: string; }): Thenable<TextDocument>;
B
Benjamin Pasero 已提交
8540

J
Johannes Rieken 已提交
8541
		/**
8542 8543 8544
		 * Register a text document content provider.
		 *
		 * Only one provider can be registered per scheme.
J
Johannes Rieken 已提交
8545
		 *
8546 8547 8548
		 * @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 已提交
8549 8550 8551
		 */
		export function registerTextDocumentContentProvider(scheme: string, provider: TextDocumentContentProvider): Disposable;

A
Alex Dima 已提交
8552
		/**
J
Johannes Rieken 已提交
8553 8554
		 * 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).
8555 8556
		 *
		 * To add an event listener when a visible text document is opened, use the [TextEditor](#TextEditor) events in the
J
Johannes Rieken 已提交
8557
		 * [window](#window) namespace. Note that:
8558 8559 8560 8561 8562
		 *
		 * - 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 已提交
8563
		 */
E
Erich Gamma 已提交
8564 8565
		export const onDidOpenTextDocument: Event<TextDocument>;

A
Alex Dima 已提交
8566
		/**
J
Johannes Rieken 已提交
8567 8568
		 * 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).
8569 8570
		 *
		 * To add an event listener when a visible text document is closed, use the [TextEditor](#TextEditor) events in the
J
Johannes Rieken 已提交
8571
		 * [window](#window) namespace. Note that this event is not emitted when a [TextEditor](#TextEditor) is closed
S
Sean Poulter 已提交
8572
		 * but the document remains open in another [visible text editor](#window.visibleTextEditors).
A
Alex Dima 已提交
8573
		 */
E
Erich Gamma 已提交
8574 8575
		export const onDidCloseTextDocument: Event<TextDocument>;

A
Alex Dima 已提交
8576
		/**
8577 8578
		 * 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
8579
		 * [dirty](#TextDocument.isDirty)-state changes.
A
Alex Dima 已提交
8580
		 */
E
Erich Gamma 已提交
8581 8582
		export const onDidChangeTextDocument: Event<TextDocumentChangeEvent>;

8583 8584
		/**
		 * An event that is emitted when a [text document](#TextDocument) will be saved to disk.
8585
		 *
J
Johannes Rieken 已提交
8586
		 * *Note 1:* Subscribers can delay saving by registering asynchronous work. For the sake of data integrity the editor
8587 8588 8589 8590 8591 8592 8593 8594
		 * 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.
8595 8596 8597
		 */
		export const onWillSaveTextDocument: Event<TextDocumentWillSaveEvent>;

A
Alex Dima 已提交
8598 8599 8600
		/**
		 * An event that is emitted when a [text document](#TextDocument) is saved to disk.
		 */
E
Erich Gamma 已提交
8601 8602
		export const onDidSaveTextDocument: Event<TextDocument>;

J
Johannes Rieken 已提交
8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672
		/**
		 * An event that is emitted when files are being created.
		 *
		 * *Note 1:* This event is triggered by user gestures, like creating a file from the
		 * explorer, or from the [`workspace.applyEdit`](#workspace.applyEdit)-api. This event is *not* fired when
		 * files change on disk, e.g triggered by another application, or when using the
		 * [`workspace.fs`](#FileSystem)-api.
		 *
		 * *Note 2:* When this event is fired, edits to files thare are being created cannot be applied.
		 */
		export const onWillCreateFiles: Event<FileWillCreateEvent>;

		/**
		 * An event that is emitted when files have been created.
		 *
		 * *Note:* This event is triggered by user gestures, like creating a file from the
		 * explorer, or from the [`workspace.applyEdit`](#workspace.applyEdit)-api, but this event is *not* fired when
		 * files change on disk, e.g triggered by another application, or when using the
		 * [`workspace.fs`](#FileSystem)-api.
		 */
		export const onDidCreateFiles: Event<FileCreateEvent>;

		/**
		 * An event that is emitted when files are being deleted.
		 *
		 * *Note 1:* This event is triggered by user gestures, like deleting a file from the
		 * explorer, or from the [`workspace.applyEdit`](#workspace.applyEdit)-api, but this event is *not* fired when
		 * files change on disk, e.g triggered by another application, or when using the
		 * [`workspace.fs`](#FileSystem)-api.
		 *
		 * *Note 2:* When deleting a folder with children only one event is fired.
		 */
		export const onWillDeleteFiles: Event<FileWillDeleteEvent>;

		/**
		 * An event that is emitted when files have been deleted.
		 *
		 * *Note 1:* This event is triggered by user gestures, like deleting a file from the
		 * explorer, or from the [`workspace.applyEdit`](#workspace.applyEdit)-api, but this event is *not* fired when
		 * files change on disk, e.g triggered by another application, or when using the
		 * [`workspace.fs`](#FileSystem)-api.
		 *
		 * *Note 2:* When deleting a folder with children only one event is fired.
		 */
		export const onDidDeleteFiles: Event<FileDeleteEvent>;

		/**
		 * An event that is emitted when files are being renamed.
		 *
		 * *Note 1:* This event is triggered by user gestures, like renaming a file from the
		 * explorer, and from the [`workspace.applyEdit`](#workspace.applyEdit)-api, but this event is *not* fired when
		 * files change on disk, e.g triggered by another application, or when using the
		 * [`workspace.fs`](#FileSystem)-api.
		 *
		 * *Note 2:* When renaming a folder with children only one event is fired.
		 */
		export const onWillRenameFiles: Event<FileWillRenameEvent>;

		/**
		 * An event that is emitted when files have been renamed.
		 *
		 * *Note 1:* This event is triggered by user gestures, like renaming a file from the
		 * explorer, and from the [`workspace.applyEdit`](#workspace.applyEdit)-api, but this event is *not* fired when
		 * files change on disk, e.g triggered by another application, or when using the
		 * [`workspace.fs`](#FileSystem)-api.
		 *
		 * *Note 2:* When renaming a folder with children only one event is fired.
		 */
		export const onDidRenameFiles: Event<FileRenameEvent>;

E
Erich Gamma 已提交
8673
		/**
S
Sandeep Somavarapu 已提交
8674
		 * Get a workspace configuration object.
J
Johannes Rieken 已提交
8675 8676
		 *
		 * When a section-identifier is provided only that part of the configuration
A
Andre Weinand 已提交
8677
		 * is returned. Dots in the section-identifier are interpreted as child-access,
J
Johannes Rieken 已提交
8678
		 * like `{ myExt: { setting: { doIt: true }}}` and `getConfiguration('myExt.setting').get('doIt') === true`.
J
Johannes Rieken 已提交
8679
		 *
S
Sandeep Somavarapu 已提交
8680
		 * When a resource is provided, configuration scoped to that resource is returned.
S
Sandeep Somavarapu 已提交
8681 8682
		 *
		 * @param section A dot-separated identifier.
S
Sandeep Somavarapu 已提交
8683
		 * @param resource A resource for which the configuration is asked for
S
Sandeep Somavarapu 已提交
8684 8685
		 * @return The full configuration or a subset.
		 */
S
Sandeep Somavarapu 已提交
8686
		export function getConfiguration(section?: string, resource?: Uri | null): WorkspaceConfiguration;
E
Erich Gamma 已提交
8687

J
Johannes Rieken 已提交
8688 8689 8690
		/**
		 * An event that is emitted when the [configuration](#WorkspaceConfiguration) changed.
		 */
S
Sandeep Somavarapu 已提交
8691
		export const onDidChangeConfiguration: Event<ConfigurationChangeEvent>;
8692 8693

		/**
J
Johannes Rieken 已提交
8694 8695 8696
		 * ~~Register a task provider.~~
		 *
		 * @deprecated Use the corresponding function on the `tasks` namespace instead
8697 8698 8699 8700 8701 8702
		 *
		 * @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;
8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714

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

S
Sandeep Somavarapu 已提交
8718 8719 8720 8721 8722 8723
	/**
	 * An event describing the change in Configuration
	 */
	export interface ConfigurationChangeEvent {

		/**
S
Sandeep Somavarapu 已提交
8724
		 * Returns `true` if the given section for the given resource (if provided) is affected.
S
Sandeep Somavarapu 已提交
8725 8726 8727
		 *
		 * @param section Configuration name, supports _dotted_ names.
		 * @param resource A resource Uri.
S
Sandeep Somavarapu 已提交
8728
		 * @return `true` if the given section for the given resource (if provided) is affected.
S
Sandeep Somavarapu 已提交
8729 8730 8731 8732
		 */
		affectsConfiguration(section: string, resource?: Uri): boolean;
	}

J
Johannes Rieken 已提交
8733
	/**
8734 8735 8736 8737 8738 8739 8740
	 * 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 已提交
8741
	 * The editor provides an API that makes it simple to provide such common features by having all UI and actions already in place and
8742 8743 8744 8745 8746 8747
	 * 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', {
8748 8749 8750
	 * 	provideHover(document, position, token) {
	 * 		return new Hover('I am a hover!');
	 * 	}
8751 8752
	 * });
	 * ```
8753 8754 8755
	 *
	 * 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 已提交
8756
	 * a selector will result in a [score](#languages.match) that is used to determine if and how a provider shall be used. When
8757 8758 8759
	 * 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 已提交
8760
	 */
E
Erich Gamma 已提交
8761 8762 8763 8764 8765 8766 8767 8768
	export namespace languages {

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

8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781
		/**
		 * 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 已提交
8782
		/**
J
Johannes Rieken 已提交
8783
		 * Compute the match between a document [selector](#DocumentSelector) and a document. Values
8784 8785 8786
		 * greater than zero mean the selector matches the document.
		 *
		 * A match is computed according to these rules:
8787 8788
		 * 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" }`.
8789 8790
		 * 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`
8791 8792
		 *  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`
8793
		 *  4. The result is the maximum value of each match
8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809
		 *
		 * 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'
8810
		 * match('javascript', doc); // 10;
8811 8812
		 * match({language: 'javascript', scheme: 'git'}, doc); // 10;
		 * match('*', doc); // 5
8813
		 * ```
J
Johannes Rieken 已提交
8814 8815 8816
		 *
		 * @param selector A document selector.
		 * @param document A text document.
J
Johannes Rieken 已提交
8817
		 * @return A number `>0` when the selector matches and `0` when the selector does not match.
E
Erich Gamma 已提交
8818 8819 8820
		 */
		export function match(selector: DocumentSelector, document: TextDocument): number;

8821 8822 8823 8824 8825 8826 8827
		/**
		 * An [event](#Event) which fires when the global set of diagnostics changes. This is
		 * newly added and removed diagnostics.
		 */
		export const onDidChangeDiagnostics: Event<DiagnosticChangeEvent>;

		/**
8828
		 * Get all diagnostics for a given resource.
8829 8830
		 *
		 * @param resource A resource
8831
		 * @returns An array of [diagnostics](#Diagnostic) objects or an empty array.
8832 8833 8834 8835
		 */
		export function getDiagnostics(resource: Uri): Diagnostic[];

		/**
8836
		 * Get all diagnostics.
8837 8838 8839 8840 8841
		 *
		 * @returns An array of uri-diagnostics tuples or an empty array.
		 */
		export function getDiagnostics(): [Uri, Diagnostic[]][];

E
Erich Gamma 已提交
8842
		/**
S
Steven Clarke 已提交
8843
		 * Create a diagnostics collection.
J
Johannes Rieken 已提交
8844 8845 8846
		 *
		 * @param name The [name](#DiagnosticCollection.name) of the collection.
		 * @return A new diagnostic collection.
E
Erich Gamma 已提交
8847 8848 8849 8850
		 */
		export function createDiagnosticCollection(name?: string): DiagnosticCollection;

		/**
J
Johannes Rieken 已提交
8851 8852 8853
		 * Register a completion provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
8854
		 * by their [score](#languages.match) and groups of equal score are sequentially asked for
J
Johannes Rieken 已提交
8855
		 * completion items. The process stops when one or many providers of a group return a
8856 8857
		 * result. A failing provider (rejected promise or exception) will not fail the whole
		 * operation.
E
Erich Gamma 已提交
8858
		 *
8859 8860 8861 8862 8863
		 * 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 已提交
8864 8865
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A completion provider.
8866
		 * @param triggerCharacters Trigger completion when the user types one of the characters.
J
Johannes Rieken 已提交
8867 8868 8869 8870 8871
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerCompletionItemProvider(selector: DocumentSelector, provider: CompletionItemProvider, ...triggerCharacters: string[]): Disposable;

		/**
J
Johannes Rieken 已提交
8872 8873 8874
		 * Register a code action provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
8875 8876
		 * 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 已提交
8877 8878
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
J
Johannes Rieken 已提交
8879
		 * @param provider A code action provider.
8880
		 * @param metadata Metadata about the kind of code actions the provider providers.
J
Johannes Rieken 已提交
8881
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
8882
		 */
8883
		export function registerCodeActionsProvider(selector: DocumentSelector, provider: CodeActionProvider, metadata?: CodeActionProviderMetadata): Disposable;
E
Erich Gamma 已提交
8884 8885

		/**
J
Johannes Rieken 已提交
8886 8887 8888
		 * Register a code lens provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
8889 8890
		 * 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 已提交
8891
		 *
J
Johannes Rieken 已提交
8892 8893 8894
		 * @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 已提交
8895
		 */
J
Johannes Rieken 已提交
8896
		export function registerCodeLensProvider(selector: DocumentSelector, provider: CodeLensProvider): Disposable;
E
Erich Gamma 已提交
8897 8898

		/**
J
Johannes Rieken 已提交
8899 8900 8901
		 * Register a definition provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
8902 8903
		 * 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 已提交
8904
		 *
J
Johannes Rieken 已提交
8905 8906 8907
		 * @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 已提交
8908 8909 8910
		 */
		export function registerDefinitionProvider(selector: DocumentSelector, provider: DefinitionProvider): Disposable;

8911
		/**
8912
		 * Register an implementation provider.
8913
		 *
8914 8915 8916
		 * 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.
8917 8918 8919 8920 8921
		 *
		 * @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 已提交
8922
		export function registerImplementationProvider(selector: DocumentSelector, provider: ImplementationProvider): Disposable;
8923

8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934 8935 8936
		/**
		 * 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;

8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949
		/**
		 * 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 已提交
8950
		/**
J
Johannes Rieken 已提交
8951 8952 8953
		 * Register a hover provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
8954 8955
		 * 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 已提交
8956
		 *
J
Johannes Rieken 已提交
8957 8958 8959
		 * @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 已提交
8960 8961 8962 8963
		 */
		export function registerHoverProvider(selector: DocumentSelector, provider: HoverProvider): Disposable;

		/**
J
Johannes Rieken 已提交
8964 8965 8966 8967
		 * 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.
8968
		 * The process stops when a provider returns a `non-falsy` or `non-failure` result.
E
Erich Gamma 已提交
8969
		 *
J
Johannes Rieken 已提交
8970 8971 8972
		 * @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 已提交
8973 8974 8975 8976
		 */
		export function registerDocumentHighlightProvider(selector: DocumentSelector, provider: DocumentHighlightProvider): Disposable;

		/**
J
Johannes Rieken 已提交
8977 8978 8979
		 * Register a document symbol provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
8980 8981
		 * 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 已提交
8982
		 *
J
Johannes Rieken 已提交
8983 8984
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A document symbol provider.
8985
		 * @param metaData metadata about the provider
J
Johannes Rieken 已提交
8986
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
8987
		 */
8988
		export function registerDocumentSymbolProvider(selector: DocumentSelector, provider: DocumentSymbolProvider, metaData?: DocumentSymbolProviderMetadata): Disposable;
E
Erich Gamma 已提交
8989 8990

		/**
J
Johannes Rieken 已提交
8991 8992
		 * Register a workspace symbol provider.
		 *
8993 8994 8995
		 * 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 已提交
8996
		 *
J
Johannes Rieken 已提交
8997 8998
		 * @param provider A workspace symbol provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
8999 9000 9001 9002
		 */
		export function registerWorkspaceSymbolProvider(provider: WorkspaceSymbolProvider): Disposable;

		/**
J
Johannes Rieken 已提交
9003 9004 9005
		 * Register a reference provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
9006 9007
		 * 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 已提交
9008
		 *
J
Johannes Rieken 已提交
9009 9010 9011
		 * @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 已提交
9012 9013 9014 9015
		 */
		export function registerReferenceProvider(selector: DocumentSelector, provider: ReferenceProvider): Disposable;

		/**
9016
		 * Register a rename provider.
J
Johannes Rieken 已提交
9017 9018
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
9019
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
9020
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
9021
		 *
J
Johannes Rieken 已提交
9022 9023 9024
		 * @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 已提交
9025 9026 9027 9028
		 */
		export function registerRenameProvider(selector: DocumentSelector, provider: RenameProvider): Disposable;

		/**
A
Andre Weinand 已提交
9029
		 * Register a formatting provider for a document.
J
Johannes Rieken 已提交
9030 9031
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
9032
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
9033
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
9034
		 *
J
Johannes Rieken 已提交
9035 9036 9037
		 * @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 已提交
9038 9039 9040 9041
		 */
		export function registerDocumentFormattingEditProvider(selector: DocumentSelector, provider: DocumentFormattingEditProvider): Disposable;

		/**
J
Johannes Rieken 已提交
9042 9043
		 * Register a formatting provider for a document range.
		 *
9044
		 * *Note:* A document range provider is also a [document formatter](#DocumentFormattingEditProvider)
M
Matthew J. Clemente 已提交
9045
		 * which means there is no need to [register](#languages.registerDocumentFormattingEditProvider) a document
9046 9047
		 * formatter when also registering a range provider.
		 *
J
Johannes Rieken 已提交
9048
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
9049
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
9050
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
9051
		 *
J
Johannes Rieken 已提交
9052 9053 9054
		 * @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 已提交
9055 9056 9057 9058
		 */
		export function registerDocumentRangeFormattingEditProvider(selector: DocumentSelector, provider: DocumentRangeFormattingEditProvider): Disposable;

		/**
E
Erich Gamma 已提交
9059
		 * Register a formatting provider that works on type. The provider is active when the user enables the setting `editor.formatOnType`.
J
Johannes Rieken 已提交
9060 9061
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
9062
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
9063
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
9064
		 *
J
Johannes Rieken 已提交
9065 9066 9067
		 * @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 已提交
9068
		 * @param moreTriggerCharacter More trigger characters.
J
Johannes Rieken 已提交
9069
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
9070 9071 9072 9073
		 */
		export function registerOnTypeFormattingEditProvider(selector: DocumentSelector, provider: OnTypeFormattingEditProvider, firstTriggerCharacter: string, ...moreTriggerCharacter: string[]): Disposable;

		/**
J
Johannes Rieken 已提交
9074 9075 9076
		 * Register a signature help provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
9077 9078
		 * by their [score](#languages.match) and called sequentially until a provider returns a
		 * valid result.
E
Erich Gamma 已提交
9079
		 *
J
Johannes Rieken 已提交
9080 9081 9082
		 * @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 `(`.
9083
		 * @param metadata Information about the provider.
J
Johannes Rieken 已提交
9084
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
9085 9086
		 */
		export function registerSignatureHelpProvider(selector: DocumentSelector, provider: SignatureHelpProvider, ...triggerCharacters: string[]): Disposable;
9087
		export function registerSignatureHelpProvider(selector: DocumentSelector, provider: SignatureHelpProvider, metadata: SignatureHelpProviderMetadata): Disposable;
E
Erich Gamma 已提交
9088

J
Johannes Rieken 已提交
9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101
		/**
		 * 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;

9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114
		/**
		 * 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;

9115 9116 9117
		/**
		 * Register a folding range provider.
		 *
9118 9119 9120 9121 9122 9123 9124
		 * 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.
9125 9126 9127 9128 9129
		 *
		 * @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.
		 */
9130
		export function registerFoldingRangeProvider(selector: DocumentSelector, provider: FoldingRangeProvider): Disposable;
9131

9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144
		/**
		 * 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;

9145 9146 9147 9148 9149 9150 9151 9152 9153
		/**
		 * Register a call hierarchy provider.
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A call hierarchy provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerCallHierarchyProvider(selector: DocumentSelector, provider: CallHierarchyProvider): Disposable;

E
Erich Gamma 已提交
9154
		/**
J
Johannes Rieken 已提交
9155
		 * Set a [language configuration](#LanguageConfiguration) for a language.
E
Erich Gamma 已提交
9156
		 *
A
Andre Weinand 已提交
9157
		 * @param language A language identifier like `typescript`.
J
Johannes Rieken 已提交
9158 9159
		 * @param configuration Language configuration.
		 * @return A [disposable](#Disposable) that unsets this configuration.
E
Erich Gamma 已提交
9160 9161 9162 9163
		 */
		export function setLanguageConfiguration(language: string, configuration: LanguageConfiguration): Disposable;
	}

J
Joao Moreno 已提交
9164
	/**
J
Joao Moreno 已提交
9165
	 * Represents the input box in the Source Control viewlet.
J
Joao Moreno 已提交
9166
	 */
J
Joao Moreno 已提交
9167
	export interface SourceControlInputBox {
J
Joao Moreno 已提交
9168 9169

		/**
J
Joao Moreno 已提交
9170
		 * Setter and getter for the contents of the input box.
J
Joao Moreno 已提交
9171
		 */
J
Joao Moreno 已提交
9172
		value: string;
9173 9174 9175 9176 9177

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

J
Joao Moreno 已提交
9180
	interface QuickDiffProvider {
J
Joao Moreno 已提交
9181 9182

		/**
J
Joao Moreno 已提交
9183 9184 9185 9186 9187
		 * 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 已提交
9188
		 */
J
Joao Moreno 已提交
9189 9190
		provideOriginalResource?(uri: Uri, token: CancellationToken): ProviderResult<Uri>;
	}
J
Joao Moreno 已提交
9191

J
Joao Moreno 已提交
9192 9193 9194 9195 9196
	/**
	 * The theme-aware decorations for a
	 * [source control resource state](#SourceControlResourceState).
	 */
	export interface SourceControlResourceThemableDecorations {
J
Joao Moreno 已提交
9197 9198

		/**
J
Joao Moreno 已提交
9199 9200
		 * The icon path for a specific
		 * [source control resource state](#SourceControlResourceState).
J
Joao Moreno 已提交
9201
		 */
J
Joao Moreno 已提交
9202
		readonly iconPath?: string | Uri;
J
Joao Moreno 已提交
9203 9204 9205
	}

	/**
J
Joao Moreno 已提交
9206 9207
	 * The decorations for a [source control resource state](#SourceControlResourceState).
	 * Can be independently specified for light and dark themes.
J
Joao Moreno 已提交
9208
	 */
J
Joao Moreno 已提交
9209
	export interface SourceControlResourceDecorations extends SourceControlResourceThemableDecorations {
J
Joao Moreno 已提交
9210 9211

		/**
J
Joao Moreno 已提交
9212 9213
		 * Whether the [source control resource state](#SourceControlResourceState) should
		 * be striked-through in the UI.
J
Joao Moreno 已提交
9214
		 */
J
Joao Moreno 已提交
9215
		readonly strikeThrough?: boolean;
J
Joao Moreno 已提交
9216

9217 9218
		/**
		 * Whether the [source control resource state](#SourceControlResourceState) should
I
Ilie Halip 已提交
9219
		 * be faded in the UI.
9220 9221 9222
		 */
		readonly faded?: boolean;

9223 9224 9225 9226 9227 9228
		/**
		 * The title for a specific
		 * [source control resource state](#SourceControlResourceState).
		 */
		readonly tooltip?: string;

J
Joao Moreno 已提交
9229
		/**
J
Joao Moreno 已提交
9230
		 * The light theme decorations.
J
Joao Moreno 已提交
9231
		 */
J
Joao Moreno 已提交
9232
		readonly light?: SourceControlResourceThemableDecorations;
J
Joao Moreno 已提交
9233 9234

		/**
J
Joao Moreno 已提交
9235
		 * The dark theme decorations.
J
Joao Moreno 已提交
9236
		 */
J
Joao Moreno 已提交
9237
		readonly dark?: SourceControlResourceThemableDecorations;
J
Joao Moreno 已提交
9238 9239 9240
	}

	/**
J
Joao Moreno 已提交
9241 9242
	 * An source control resource state represents the state of an underlying workspace
	 * resource within a certain [source control group](#SourceControlResourceGroup).
J
Joao Moreno 已提交
9243
	 */
J
Joao Moreno 已提交
9244
	export interface SourceControlResourceState {
J
Joao Moreno 已提交
9245 9246

		/**
J
Joao Moreno 已提交
9247
		 * The [uri](#Uri) of the underlying resource inside the workspace.
J
Joao Moreno 已提交
9248
		 */
J
Joao Moreno 已提交
9249
		readonly resourceUri: Uri;
J
Joao Moreno 已提交
9250 9251

		/**
J
Joao Moreno 已提交
9252 9253
		 * The [command](#Command) which should be run when the resource
		 * state is open in the Source Control viewlet.
J
Joao Moreno 已提交
9254
		 */
9255
		readonly command?: Command;
J
Joao Moreno 已提交
9256 9257

		/**
J
Joao Moreno 已提交
9258 9259
		 * The [decorations](#SourceControlResourceDecorations) for this source control
		 * resource state.
J
Joao Moreno 已提交
9260
		 */
J
Joao Moreno 已提交
9261
		readonly decorations?: SourceControlResourceDecorations;
J
Joao Moreno 已提交
9262 9263 9264
	}

	/**
J
Joao Moreno 已提交
9265 9266
	 * A source control resource group is a collection of
	 * [source control resource states](#SourceControlResourceState).
J
Joao Moreno 已提交
9267
	 */
J
Joao Moreno 已提交
9268 9269 9270 9271 9272 9273
	export interface SourceControlResourceGroup {

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

		/**
J
Joao Moreno 已提交
9276
		 * The label of this source control resource group.
J
Joao Moreno 已提交
9277
		 */
9278
		label: string;
J
Joao Moreno 已提交
9279 9280

		/**
J
Joao Moreno 已提交
9281 9282
		 * Whether this source control resource group is hidden when it contains
		 * no [source control resource states](#SourceControlResourceState).
J
Joao Moreno 已提交
9283
		 */
J
Joao Moreno 已提交
9284
		hideWhenEmpty?: boolean;
J
Joao Moreno 已提交
9285 9286

		/**
J
Joao Moreno 已提交
9287 9288
		 * This group's collection of
		 * [source control resource states](#SourceControlResourceState).
J
Joao Moreno 已提交
9289
		 */
J
Joao Moreno 已提交
9290
		resourceStates: SourceControlResourceState[];
J
Joao Moreno 已提交
9291 9292

		/**
J
Joao Moreno 已提交
9293
		 * Dispose this source control resource group.
J
Joao Moreno 已提交
9294
		 */
J
Joao Moreno 已提交
9295 9296 9297 9298 9299 9300 9301 9302
		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 已提交
9303 9304

		/**
J
Joao Moreno 已提交
9305
		 * The id of this source control.
J
Joao Moreno 已提交
9306
		 */
J
Joao Moreno 已提交
9307
		readonly id: string;
J
Joao Moreno 已提交
9308 9309

		/**
J
Joao Moreno 已提交
9310
		 * The human-readable label of this source control.
J
Joao Moreno 已提交
9311
		 */
J
Joao Moreno 已提交
9312
		readonly label: string;
J
Joao Moreno 已提交
9313

J
Joao Moreno 已提交
9314 9315 9316 9317 9318
		/**
		 * The (optional) Uri of the root of this source control.
		 */
		readonly rootUri: Uri | undefined;

J
Joao Moreno 已提交
9319 9320 9321 9322 9323
		/**
		 * The [input box](#SourceControlInputBox) for this source control.
		 */
		readonly inputBox: SourceControlInputBox;

J
Joao Moreno 已提交
9324
		/**
J
Joao Moreno 已提交
9325 9326
		 * The UI-visible count of [resource states](#SourceControlResourceState) of
		 * this source control.
J
Joao Moreno 已提交
9327
		 *
J
Joao Moreno 已提交
9328 9329
		 * Equals to the total number of [resource state](#SourceControlResourceState)
		 * of this source control, if undefined.
J
Joao Moreno 已提交
9330
		 */
J
Joao Moreno 已提交
9331
		count?: number;
J
Joao Moreno 已提交
9332 9333

		/**
J
Joao Moreno 已提交
9334
		 * An optional [quick diff provider](#QuickDiffProvider).
J
Joao Moreno 已提交
9335
		 */
J
Joao Moreno 已提交
9336
		quickDiffProvider?: QuickDiffProvider;
J
Joao Moreno 已提交
9337

J
Joao Moreno 已提交
9338
		/**
9339 9340 9341 9342
		 * Optional commit template string.
		 *
		 * The Source Control viewlet will populate the Source Control
		 * input with this value when appropriate.
J
Joao Moreno 已提交
9343
		 */
9344
		commitTemplate?: string;
J
Joao Moreno 已提交
9345 9346

		/**
9347 9348 9349 9350
		 * Optional accept input command.
		 *
		 * This command will be invoked when the user accepts the value
		 * in the Source Control input.
J
Joao Moreno 已提交
9351
		 */
9352
		acceptInputCommand?: Command;
J
Joao Moreno 已提交
9353 9354

		/**
9355 9356 9357
		 * Optional status bar commands.
		 *
		 * These commands will be displayed in the editor's status bar.
J
Joao Moreno 已提交
9358
		 */
9359
		statusBarCommands?: Command[];
J
Joao Moreno 已提交
9360 9361

		/**
9362
		 * Create a new [resource group](#SourceControlResourceGroup).
J
Joao Moreno 已提交
9363
		 */
9364
		createResourceGroup(id: string, label: string): SourceControlResourceGroup;
J
Joao Moreno 已提交
9365 9366

		/**
9367
		 * Dispose this source control.
J
Joao Moreno 已提交
9368
		 */
9369 9370 9371 9372
		dispose(): void;
	}

	export namespace scm {
J
Joao Moreno 已提交
9373 9374

		/**
J
Joao 已提交
9375 9376
		 * ~~The [input box](#SourceControlInputBox) for the last source control
		 * created by the extension.~~
J
Joao Moreno 已提交
9377
		 *
J
Joao Moreno 已提交
9378
		 * @deprecated Use SourceControl.inputBox instead
J
Joao Moreno 已提交
9379
		 */
9380
		export const inputBox: SourceControlInputBox;
J
Joao Moreno 已提交
9381 9382

		/**
J
Joao Moreno 已提交
9383
		 * Creates a new [source control](#SourceControl) instance.
J
Joao Moreno 已提交
9384
		 *
9385 9386 9387
		 * @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 已提交
9388
		 * @return An instance of [source control](#SourceControl).
J
Joao Moreno 已提交
9389
		 */
J
Joao Moreno 已提交
9390
		export function createSourceControl(id: string, label: string, rootUri?: Uri): SourceControl;
J
Joao Moreno 已提交
9391 9392
	}

9393 9394 9395 9396 9397
	/**
	 * Configuration for a debug session.
	 */
	export interface DebugConfiguration {
		/**
9398
		 * The type of the debug session.
9399 9400 9401 9402
		 */
		type: string;

		/**
9403
		 * The name of the debug session.
9404
		 */
9405
		name: string;
9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422

		/**
		 * 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 已提交
9423 9424 9425 9426 9427
		/**
		 * The unique ID of this debug session.
		 */
		readonly id: string;

9428
		/**
A
Andre Weinand 已提交
9429
		 * The debug session's type from the [debug configuration](#DebugConfiguration).
A
Andre Weinand 已提交
9430
		 */
9431 9432 9433
		readonly type: string;

		/**
9434 9435
		 * The debug session's name is initially taken from the [debug configuration](#DebugConfiguration).
		 * Any changes will be properly reflected in the UI.
9436
		 */
9437
		name: string;
9438

9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451
		/**
		 * 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;

9452 9453 9454 9455 9456 9457 9458
		/**
		 * Send a custom request to the debug adapter.
		 */
		customRequest(command: string, args?: any): Thenable<any>;
	}

	/**
A
Andre Weinand 已提交
9459
	 * A custom Debug Adapter Protocol event received from a [debug session](#DebugSession).
9460
	 */
A
Andre Weinand 已提交
9461 9462 9463 9464
	export interface DebugSessionCustomEvent {
		/**
		 * The [debug session](#DebugSession) for which the custom event was received.
		 */
9465
		readonly session: DebugSession;
9466 9467

		/**
A
Andre Weinand 已提交
9468
		 * Type of event.
9469
		 */
9470
		readonly event: string;
A
Andre Weinand 已提交
9471 9472 9473 9474

		/**
		 * Event specific information.
		 */
9475
		readonly body?: any;
A
Andre Weinand 已提交
9476 9477
	}

A
Andre Weinand 已提交
9478 9479
	/**
	 * A debug configuration provider allows to add the initial debug configurations to a newly created launch.json
9480 9481
	 * 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 已提交
9482 9483 9484 9485 9486 9487
	 */
	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 已提交
9488
		 * @param folder The workspace folder for which the configurations are used or `undefined` for a folderless setup.
A
Andre Weinand 已提交
9489 9490 9491 9492 9493 9494 9495 9496 9497
		 * @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.
9498
		 * Returning the value 'undefined' prevents the debug session from starting.
9499
		 * Returning the value 'null' prevents the debug session from starting and opens the underlying debug configuration instead.
A
Andre Weinand 已提交
9500
		 *
A
Andre Weinand 已提交
9501
		 * @param folder The workspace folder from which the configuration originates from or `undefined` for a folderless setup.
A
Andre Weinand 已提交
9502 9503
		 * @param debugConfiguration The [debug configuration](#DebugConfiguration) to resolve.
		 * @param token A cancellation token.
9504
		 * @return The resolved debug configuration or undefined or null.
A
Andre Weinand 已提交
9505 9506 9507 9508
		 */
		resolveDebugConfiguration?(folder: WorkspaceFolder | undefined, debugConfiguration: DebugConfiguration, token?: CancellationToken): ProviderResult<DebugConfiguration>;
	}

9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580
	/**
	 * 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);
	}

9581 9582 9583 9584 9585 9586 9587 9588 9589 9590 9591 9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619
	/**
	 * A debug adapter that implements the Debug Adapter Protocol can be registered with VS Code if it implements the DebugAdapter interface.
	 */
	export interface DebugAdapter extends Disposable {

		/**
		 * An event which fires after the debug adapter has sent a Debug Adapter Protocol message to VS Code.
		 * Messages can be requests, responses, or events.
		 */
		readonly onDidSendMessage: Event<DebugProtocolMessage>;

		/**
		 * Handle a Debug Adapter Protocol message.
		 * Messages can be requests, responses, or events.
		 * Results or errors are returned via onSendMessage events.
		 * @param message A Debug Adapter Protocol message
		 */
		handleMessage(message: DebugProtocolMessage): void;
	}

	/**
	 * A DebugProtocolMessage is an opaque stand-in type for the [ProtocolMessage](https://microsoft.github.io/debug-adapter-protocol/specification#Base_Protocol_ProtocolMessage) type defined in the Debug Adapter Protocol.
	 */
	export interface DebugProtocolMessage {
		// Properties: see details [here](https://microsoft.github.io/debug-adapter-protocol/specification#Base_Protocol_ProtocolMessage).
	}

	/**
	 * A debug adapter descriptor for an inline implementation.
	 */
	export class DebugAdapterInlineImplementation {

		/**
		 * Create a descriptor for an inline implementation of a debug adapter.
		 */
		constructor(implementation: DebugAdapter);
	}

	export type DebugAdapterDescriptor = DebugAdapterExecutable | DebugAdapterServer | DebugAdapterInlineImplementation;
9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641

	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 已提交
9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662
	/**
	 * 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;
		/**
9663
		 * An error with the debug adapter has occurred.
A
Andre Weinand 已提交
9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682
		 */
		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>;
	}

9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702
	/**
	 * 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 已提交
9703
	/**
9704
	 * An event describing the changes to the set of [breakpoints](#Breakpoint).
A
Andre Weinand 已提交
9705
	 */
9706 9707 9708 9709
	export interface BreakpointsChangeEvent {
		/**
		 * Added breakpoints.
		 */
9710
		readonly added: ReadonlyArray<Breakpoint>;
9711 9712

		/**
9713
		 * Removed breakpoints.
9714
		 */
9715
		readonly removed: ReadonlyArray<Breakpoint>;
9716 9717 9718 9719

		/**
		 * Changed breakpoints.
		 */
9720
		readonly changed: ReadonlyArray<Breakpoint>;
9721 9722 9723 9724 9725 9726
	}

	/**
	 * The base class of all breakpoint types.
	 */
	export class Breakpoint {
9727 9728 9729 9730
		/**
		 * The unique ID of the breakpoint.
		 */
		readonly id: string;
9731 9732 9733 9734 9735 9736 9737 9738 9739 9740 9741 9742
		/**
		 * 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;
9743 9744 9745 9746
		/**
		 * An optional message that gets logged when this breakpoint is hit. Embedded expressions within {} are interpolated by the debug adapter.
		 */
		readonly logMessage?: string;
9747

9748
		protected constructor(enabled?: boolean, condition?: string, hitCondition?: string, logMessage?: string);
9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762
	}

	/**
	 * 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.
		 */
9763
		constructor(location: Location, enabled?: boolean, condition?: string, hitCondition?: string, logMessage?: string);
9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777
	}

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

I
isidor 已提交
9781 9782 9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815
	/**
	 * 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;
	}

9816 9817 9818 9819 9820 9821 9822
	/**
	 * A DebugProtocolSource is an opaque stand-in type for the [Source](https://microsoft.github.io/debug-adapter-protocol/specification#Types_Source) type defined in the Debug Adapter Protocol.
	 */
	export interface DebugProtocolSource {
		// Properties: see details [here](https://microsoft.github.io/debug-adapter-protocol/specification#Types_Source).
	}

9823 9824 9825 9826
	/**
	 * Namespace for debug functionality.
	 */
	export namespace debug {
A
Andre Weinand 已提交
9827 9828

		/**
A
Andre Weinand 已提交
9829
		 * The currently active [debug session](#DebugSession) or `undefined`. The active debug session is the one
A
Andre Weinand 已提交
9830 9831 9832 9833 9834
		 * 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;

9835 9836
		/**
		 * The currently active [debug console](#DebugConsole).
9837
		 * If no debug session is active, output sent to the debug console is not shown.
9838 9839 9840
		 */
		export let activeDebugConsole: DebugConsole;

9841 9842 9843 9844 9845 9846
		/**
		 * List of breakpoints.
		 */
		export let breakpoints: Breakpoint[];


A
Andre Weinand 已提交
9847 9848 9849 9850 9851 9852 9853
		/**
		 * 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>;

9854
		/**
A
Andre Weinand 已提交
9855
		 * An [event](#Event) which fires when a new [debug session](#DebugSession) has been started.
9856 9857 9858
		 */
		export const onDidStartDebugSession: Event<DebugSession>;

A
Andre Weinand 已提交
9859
		/**
A
Andre Weinand 已提交
9860
		 * An [event](#Event) which fires when a custom DAP event is received from the [debug session](#DebugSession).
A
Andre Weinand 已提交
9861 9862 9863 9864
		 */
		export const onDidReceiveDebugSessionCustomEvent: Event<DebugSessionCustomEvent>;

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

9869 9870 9871 9872 9873 9874
		/**
		 * An [event](#Event) that is emitted when the set of breakpoints is added, removed, or changed.
		 */
		export const onDidChangeBreakpoints: Event<BreakpointsChangeEvent>;


A
Andre Weinand 已提交
9875
		/**
9876
		 * Register a [debug configuration provider](#DebugConfigurationProvider) for a specific debug type.
A
Andre Weinand 已提交
9877 9878 9879 9880 9881 9882 9883
		 * 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;
9884

9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895
		/**
		 * 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 已提交
9896 9897 9898 9899 9900 9901 9902 9903 9904
		/**
		 * 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;

9905 9906 9907 9908 9909 9910 9911 9912
		/**
		 * 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 已提交
9913
		 * @param parentSessionOrOptions Debug sesison options. When passed a parent [debug session](#DebugSession), assumes options with just this parent session.
9914 9915
		 * @return A thenable that resolves when debugging could be successfully started.
		 */
I
isidor 已提交
9916
		export function startDebugging(folder: WorkspaceFolder | undefined, nameOrConfiguration: string | DebugConfiguration, parentSessionOrOptions?: DebugSession | DebugSessionOptions): Thenable<boolean>;
9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928

		/**
		 * 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;
9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941

		/**
		 * Converts a "Source" descriptor object received via the Debug Adapter Protocol into a Uri that can be used to load its contents.
		 * If the source descriptor is based on a path, a file Uri is returned.
		 * If the source descriptor uses a reference number, a specific debug Uri (scheme 'debug') is constructed that requires a corresponding VS Code ContentProvider and a running debug session
		 *
		 * If the "Source" descriptor has insufficient information for creating the Uri, an error is thrown.
		 *
		 * @param source An object conforming to the [Source](https://microsoft.github.io/debug-adapter-protocol/specification#Types_Source) type defined in the Debug Adapter Protocol.
		 * @param session An optional debug session that will be used when the source descriptor uses a reference number to load the contents from an active debug session.
		 * @return A uri that can be used to load the contents of the source.
		 */
		export function asDebugSourceUri(source: DebugProtocolSource, session?: DebugSession): Uri;
9942 9943
	}

J
Johannes Rieken 已提交
9944
	/**
9945
	 * Namespace for dealing with installed extensions. Extensions are represented
J
Jon Malmaud 已提交
9946
	 * by an [extension](#Extension)-interface which enables reflection on them.
9947
	 *
S
Steven Clarke 已提交
9948
	 * Extension writers can provide APIs to other extensions by returning their API public
9949 9950 9951 9952
	 * surface from the `activate`-call.
	 *
	 * ```javascript
	 * export function activate(context: vscode.ExtensionContext) {
9953 9954 9955 9956 9957 9958 9959 9960 9961 9962
	 * 	let api = {
	 * 		sum(a, b) {
	 * 			return a + b;
	 * 		},
	 * 		mul(a, b) {
	 * 			return a * b;
	 * 		}
	 * 	};
	 * 	// 'export' public api-surface
	 * 	return api;
9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974
	 * }
	 * ```
	 * 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 已提交
9975
	 */
E
Erich Gamma 已提交
9976 9977
	export namespace extensions {

J
Johannes Rieken 已提交
9978
		/**
9979
		 * Get an extension by its full identifier in the form of: `publisher.name`.
J
Johannes Rieken 已提交
9980
		 *
J
Johannes Rieken 已提交
9981
		 * @param extensionId An extension identifier.
J
Johannes Rieken 已提交
9982 9983
		 * @return An extension or `undefined`.
		 */
9984
		export function getExtension(extensionId: string): Extension<any> | undefined;
E
Erich Gamma 已提交
9985

J
Johannes Rieken 已提交
9986
		/**
A
Andre Weinand 已提交
9987
		 * Get an extension its full identifier in the form of: `publisher.name`.
J
Johannes Rieken 已提交
9988 9989 9990
		 *
		 * @param extensionId An extension identifier.
		 * @return An extension or `undefined`.
J
Johannes Rieken 已提交
9991
		 */
9992
		export function getExtension<T>(extensionId: string): Extension<T> | undefined;
E
Erich Gamma 已提交
9993 9994 9995 9996

		/**
		 * All extensions currently known to the system.
		 */
M
Matt Bierner 已提交
9997
		export const all: ReadonlyArray<Extension<any>>;
9998 9999 10000 10001 10002 10003

		/**
		 * 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 已提交
10004
	}
P
Peng Lyu 已提交
10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022

	//#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 已提交
10023 10024 10025
	/**
	 * Comment mode of a [comment](#Comment)
	 */
P
Peng Lyu 已提交
10026
	export enum CommentMode {
P
Peng Lyu 已提交
10027 10028 10029
		/**
		 * Displays the comment editor
		 */
P
Peng Lyu 已提交
10030
		Editing = 0,
P
Peng Lyu 已提交
10031 10032 10033 10034

		/**
		 * Displays the preview of the comment
		 */
P
Peng Lyu 已提交
10035 10036 10037 10038 10039 10040 10041 10042 10043 10044
		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.
		 */
10045
		readonly uri: Uri;
P
Peng Lyu 已提交
10046 10047 10048 10049 10050

		/**
		 * 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 已提交
10051
		range: Range;
P
Peng Lyu 已提交
10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062 10063

		/**
		 * 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 已提交
10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077 10078 10079 10080 10081 10082 10083
		/**
		 * 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 已提交
10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111
		/**
		 * 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 已提交
10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133 10134 10135 10136
	/**
	 * 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 已提交
10137 10138 10139 10140 10141 10142 10143 10144 10145
	/**
	 * 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 已提交
10146 10147 10148
		/**
		 * [Comment mode](#CommentMode) of the comment
		 */
P
Peng Lyu 已提交
10149 10150 10151
		mode: CommentMode;

		/**
P
Peng Lyu 已提交
10152
		 * The [author information](#CommentAuthorInformation) of the comment
P
Peng Lyu 已提交
10153 10154 10155
		 */
		author: CommentAuthorInformation;

P
Peng Lyu 已提交
10156 10157 10158 10159
		/**
		 * 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`.
10160
		 * ```json
P
Peng Lyu 已提交
10161 10162 10163 10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175
		 *	"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 已提交
10176 10177 10178 10179 10180
		/**
		 * Optional reactions of the [comment](#Comment)
		 */
		reactions?: CommentReaction[];

P
Peng Lyu 已提交
10181 10182 10183 10184 10185 10186 10187
		/**
		 * Optional label describing the [Comment](#Comment)
		 * Label will be rendered next to authorName if exists.
		 */
		label?: string;
	}

P
Peng Lyu 已提交
10188
	/**
10189
	 * Command argument for actions registered in `comments/commentThread/context`.
P
Peng Lyu 已提交
10190
	 */
P
Peng Lyu 已提交
10191
	export interface CommentReply {
P
Peng Lyu 已提交
10192 10193 10194
		/**
		 * The active [comment thread](#CommentThread)
		 */
P
Peng Lyu 已提交
10195 10196
		thread: CommentThread;

P
Peng Lyu 已提交
10197 10198 10199
		/**
		 * The value in the comment editor
		 */
P
Peng Lyu 已提交
10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230
		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 已提交
10231
		 * If not provided, users can leave comments in any document opened in the editor.
P
Peng Lyu 已提交
10232 10233 10234 10235 10236 10237 10238
		 */
		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.
		 *
10239
		 * @param uri The uri of the document the thread has been created on.
P
Peng Lyu 已提交
10240 10241 10242
		 * @param range The range the comment thread is located within the document.
		 * @param comments The ordered comments of the thread.
		 */
10243
		createCommentThread(uri: Uri, range: Range, comments: Comment[]): CommentThread;
P
Peng Lyu 已提交
10244

P
Peng Lyu 已提交
10245 10246 10247 10248 10249
		/**
		 * Optional reaction handler for creating and deleting reactions on a [comment](#Comment).
		 */
		reactionHandler?: (comment: Comment, reaction: CommentReaction) => Promise<void>;

P
Peng Lyu 已提交
10250 10251 10252 10253 10254 10255 10256 10257 10258
		/**
		 * 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 已提交
10259
	namespace comments {
P
Peng Lyu 已提交
10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270
		/**
		 * 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 已提交
10271 10272 10273 10274
}

/**
 * Thenable is a common denominator between ES6 promises, Q, jquery.Deferred, WinJS.Promise,
10275
 * and others. This API makes no assumption about what promise library is being used which
E
Erich Gamma 已提交
10276
 * enables reusing existing code without migrating to a specific promise implementation. Still,
J
Johannes Rieken 已提交
10277
 * we recommend the use of native promises which are available in this editor.
E
Erich Gamma 已提交
10278
 */
10279
interface Thenable<T> {
E
Erich Gamma 已提交
10280 10281 10282 10283 10284 10285
	/**
	* 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.
	*/
10286 10287
	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 已提交
10288
}