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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

		/**
J
Johannes Rieken 已提交
91 92 93
		 * The associated URI for this document. Most documents have the __file__-scheme, indicating that they
		 * represent files on disk. However, some documents may have other schemes indicating that they are not
		 * available on disk.
E
Erich Gamma 已提交
94
		 */
Y
Yuki Ueda 已提交
95
		readonly uri: Uri;
E
Erich Gamma 已提交
96 97

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

		/**
J
Johannes Rieken 已提交
221 222 223 224
		 * Ensure a range is completely contained in this document.
		 *
		 * @param range A range.
		 * @return The given range or a new, adjusted range.
E
Erich Gamma 已提交
225 226 227 228
		 */
		validateRange(range: Range): Range;

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

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

		/**
		 * The zero-based line value.
		 */
Y
Yuki Ueda 已提交
250
		readonly line: number;
E
Erich Gamma 已提交
251 252 253 254

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

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

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

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

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

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

		/**
A
Alex Dima 已提交
300 301 302
		 * Check if `other` equals this position.
		 *
		 * @param other A position.
E
Erich Gamma 已提交
303 304 305 306 307 308
		 * @return `true` if the line and character of the given position are equal to
		 * the line and character of this position.
		 */
		isEqual(other: Position): boolean;

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

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

328 329 330 331 332 333 334 335 336
		/**
		 * Derived a new position relative to this position.
		 *
		 * @param change An object that describes a delta to this position.
		 * @return A position that reflects the given delta. Will return `this` position if the change
		 * is not changing anything.
		 */
		translate(change: { lineDelta?: number; characterDelta?: number; }): Position;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

		/**
A
Alex Dima 已提交
488
		 * Create a selection from four coordinates.
J
Johannes Rieken 已提交
489
		 *
A
Alex Dima 已提交
490 491 492 493
		 * @param anchorLine A zero-based line value.
		 * @param anchorCharacter A zero-based character value.
		 * @param activeLine A zero-based line value.
		 * @param activeCharacter A zero-based character value.
E
Erich Gamma 已提交
494
		 */
J
Johannes Rieken 已提交
495
		constructor(anchorLine: number, anchorCharacter: number, activeLine: number, activeCharacter: number);
A
Alex Dima 已提交
496

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

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

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

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

554 555 556 557 558 559 560 561 562 563 564 565 566 567
	/**
	 * Represents an event describing the change of a [text editor's view column](#TextEditor.viewColumn).
	 */
	export interface TextEditorViewColumnChangeEvent {
		/**
		 * The [text editor](#TextEditor) for which the options have changed.
		 */
		textEditor: TextEditor;
		/**
		 * The new value for the [text editor's view column](#TextEditor.viewColumn).
		 */
		viewColumn: ViewColumn;
	}

A
Alex Dima 已提交
568 569 570 571 572
	/**
	 * Rendering style of the cursor.
	 */
	export enum TextEditorCursorStyle {
		/**
573
		 * Render the cursor as a vertical thick line.
A
Alex Dima 已提交
574 575 576
		 */
		Line = 1,
		/**
577
		 * Render the cursor as a block filled.
A
Alex Dima 已提交
578
		 */
A
Alex Dima 已提交
579 580
		Block = 2,
		/**
581
		 * Render the cursor as a thick horizontal line.
A
Alex Dima 已提交
582
		 */
583
		Underline = 3,
584
		/**
585
		 * Render the cursor as a vertical thin line.
586
		 */
587
		LineThin = 4,
588
		/**
589
		 * Render the cursor as a block outlined.
590
		 */
591
		BlockOutline = 5,
592 593 594 595
		/**
		 * Render the cursor as a thin horizontal line.
		 */
		UnderlineThin = 6
A
Alex Dima 已提交
596 597
	}

598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
	/**
	 * Rendering style of the line numbers.
	 */
	export enum TextEditorLineNumbersStyle {
		/**
		 * Do not render the line numbers.
		 */
		Off = 0,
		/**
		 * Render the line numbers.
		 */
		On = 1,
		/**
		 * Render the line numbers with values relative to the primary cursor location.
		 */
		Relative = 2
	}

E
Erich Gamma 已提交
616
	/**
A
Alex Dima 已提交
617
	 * Represents a [text editor](#TextEditor)'s [options](#TextEditor.options).
E
Erich Gamma 已提交
618 619 620 621
	 */
	export interface TextEditorOptions {

		/**
A
Alex Dima 已提交
622 623 624
		 * The size in spaces a tab takes. This is used for two purposes:
		 *  - the rendering width of a tab character;
		 *  - the number of spaces to insert when [insertSpaces](#TextEditorOptions.insertSpaces) is true.
J
Johannes Rieken 已提交
625
		 *
626 627
		 * When getting a text editor's options, this property will always be a number (resolved).
		 * When setting a text editor's options, this property is optional and it can be a number or `"auto"`.
E
Erich Gamma 已提交
628
		 */
629
		tabSize?: number | string;
E
Erich Gamma 已提交
630 631 632

		/**
		 * When pressing Tab insert [n](#TextEditorOptions.tabSize) spaces.
633 634
		 * When getting a text editor's options, this property will always be a boolean (resolved).
		 * When setting a text editor's options, this property is optional and it can be a boolean or `"auto"`.
E
Erich Gamma 已提交
635
		 */
636
		insertSpaces?: boolean | string;
A
Alex Dima 已提交
637 638 639 640 641 642 643

		/**
		 * The rendering style of the cursor in this editor.
		 * When getting a text editor's options, this property will always be present.
		 * When setting a text editor's options, this property is optional.
		 */
		cursorStyle?: TextEditorCursorStyle;
644 645 646 647 648 649

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

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

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

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

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

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

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

729 730 731
	/**
	 * Represents options to configure the behavior of showing a [document](#TextDocument) in an [editor](#TextEditor).
	 */
732
	export interface TextDocumentShowOptions {
733
		/**
734 735 736
		 * An optional view column in which the [editor](#TextEditor) should be shown.
		 * The default is the [one](#ViewColumn.One), other values are adjusted to
		 * be __Min(column, columnCount + 1)__.
737
		 */
J
Johannes Rieken 已提交
738
		viewColumn?: ViewColumn;
739 740 741 742

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

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

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

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

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

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

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
783 784 785 786 787 788
		outline?: string;

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

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

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

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

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

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

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

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

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

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

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

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
851
		color?: string | ThemeColor;
E
Erich Gamma 已提交
852

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

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

863 864 865 866 867 868 869
		/**
		 * Specifies the size of the gutter icon.
		 * Available values are 'auto', 'contain', 'cover' and any percentage value.
		 * For further information: https://msdn.microsoft.com/en-us/library/jj127316(v=vs.85).aspx
		 */
		gutterIconSize?: string;

E
Erich Gamma 已提交
870 871 872
		/**
		 * The color of the decoration in the overview ruler. Use rgba() and define transparent colors to play well with other decorations.
		 */
873
		overviewRulerColor?: string | ThemeColor;
M
Martin Aeschlimann 已提交
874 875 876 877 878 879 880 881 882 883 884 885 886

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

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

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

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

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

E
Erich Gamma 已提交
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961
		/**
		 * The position in the overview ruler where the decoration should be rendered.
		 */
		overviewRulerLane?: OverviewRulerLane;

		/**
		 * Overwrite options for light themes.
		 */
		light?: ThemableDecorationRenderOptions;

		/**
		 * Overwrite options for dark themes.
		 */
		dark?: ThemableDecorationRenderOptions;
	}

A
Alex Dima 已提交
962 963 964
	/**
	 * Represents options for a specific decoration in a [decoration set](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
965 966 967
	export interface DecorationOptions {

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

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

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

	export interface ThemableDecorationInstanceRenderOptions {
		/**
		 * Defines the rendering options of the attachment that is inserted before the decorated text
		 */
988
		before?: ThemableDecorationAttachmentRenderOptions;
M
Martin Aeschlimann 已提交
989 990 991 992

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

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

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

A
Alex Dima 已提交
1008 1009 1010
	/**
	 * Represents an editor that is attached to a [document](#TextDocument).
	 */
E
Erich Gamma 已提交
1011 1012 1013 1014 1015 1016 1017 1018
	export interface TextEditor {

		/**
		 * The document associated with this text editor. The document will be the same for the entire lifetime of this text editor.
		 */
		document: TextDocument;

		/**
J
Johannes Rieken 已提交
1019
		 * The primary selection on this text editor. Shorthand for `TextEditor.selections[0]`.
E
Erich Gamma 已提交
1020 1021 1022 1023
		 */
		selection: Selection;

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

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

1033 1034 1035 1036
		/**
		 * The column in which this editor shows. Will be `undefined` in case this
		 * isn't one of the three main editors, e.g an embedded editor.
		 */
1037
		viewColumn?: ViewColumn;
1038

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

J
Joel Day 已提交
1052
		/**
J
Johannes Rieken 已提交
1053 1054 1055
		 * Insert a [snippet](#SnippetString) and put the editor into snippet mode. "Snippet mode"
		 * means the editor adds placeholders and additionals cursors so that the user can complete
		 * or accept the snippet.
J
Joel Day 已提交
1056
		 *
1057
		 * @param snippet The snippet to insert in this edit.
J
Johannes Rieken 已提交
1058
		 * @param location Position or range at which to insert the snippet, defaults to the current editor selection or selections.
1059
		 * @param options The undo/redo behavior around this edit. By default, undo stops will be created before and after this edit.
J
Johannes Rieken 已提交
1060 1061
		 * @return A promise that resolves with a value indicating if the snippet could be inserted. Note that the promise does not signal
		 * that the snippet is completely filled-in or accepted.
J
Joel Day 已提交
1062
		 */
J
Johannes Rieken 已提交
1063
		insertSnippet(snippet: SnippetString, location?: Position | Range | Position[] | Range[], options?: { undoStopBefore: boolean; undoStopAfter: boolean; }): Thenable<boolean>;
E
Erich Gamma 已提交
1064 1065

		/**
J
Johannes Rieken 已提交
1066 1067 1068
		 * Adds a set of decorations to the text editor. If a set of decorations already exists with
		 * the given [decoration type](#TextEditorDecorationType), they will be replaced.
		 *
S
Sofian Hnaide 已提交
1069
		 * @see [createTextEditorDecorationType](#window.createTextEditorDecorationType).
A
Alex Dima 已提交
1070
		 *
J
Johannes Rieken 已提交
1071 1072
		 * @param decorationType A decoration type.
		 * @param rangesOrOptions Either [ranges](#Range) or more detailed [options](#DecorationOptions).
E
Erich Gamma 已提交
1073
		 */
J
Johannes Rieken 已提交
1074
		setDecorations(decorationType: TextEditorDecorationType, rangesOrOptions: Range[] | DecorationOptions[]): void;
E
Erich Gamma 已提交
1075 1076

		/**
A
Alex Dima 已提交
1077 1078 1079 1080
		 * Scroll as indicated by `revealType` in order to reveal the given range.
		 *
		 * @param range A range.
		 * @param revealType The scrolling strategy for revealing `range`.
E
Erich Gamma 已提交
1081 1082 1083 1084
		 */
		revealRange(range: Range, revealType?: TextEditorRevealType): void;

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

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

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

E
Erich Gamma 已提交
1117
	/**
A
Alex Dima 已提交
1118 1119
	 * A complex edit that will be applied in one transaction on a TextEditor.
	 * This holds a description of the edits and if the edits are valid (i.e. no overlapping regions, document was not changed in the meantime, etc.)
1120
	 * they can be applied on a [document](#TextDocument) associated with a [text editor](#TextEditor).
E
Erich Gamma 已提交
1121 1122 1123 1124
	 *
	 */
	export interface TextEditorEdit {
		/**
A
Alex Dima 已提交
1125
		 * Replace a certain text region with a new value.
1126
		 * You can use \r\n or \n in `value` and they will be normalized to the current [document](#TextDocument).
A
Alex Dima 已提交
1127 1128 1129
		 *
		 * @param location The range this operation should remove.
		 * @param value The new text this operation should insert after removing `location`.
E
Erich Gamma 已提交
1130 1131 1132 1133
		 */
		replace(location: Position | Range | Selection, value: string): void;

		/**
A
Alex Dima 已提交
1134
		 * Insert text at a location.
1135
		 * You can use \r\n or \n in `value` and they will be normalized to the current [document](#TextDocument).
A
Alex Dima 已提交
1136 1137 1138 1139
		 * Although the equivalent text edit can be made with [replace](#TextEditorEdit.replace), `insert` will produce a different resulting selection (it will get moved).
		 *
		 * @param location The position where the new text should be inserted.
		 * @param value The new text this operation should insert.
E
Erich Gamma 已提交
1140 1141 1142 1143 1144
		 */
		insert(location: Position, value: string): void;

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

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

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

		/**
J
Johannes Rieken 已提交
1165 1166 1167 1168 1169
		 * Create an URI from a file system path. The [scheme](#Uri.scheme)
		 * will be `file`.
		 *
		 * @param path A file system or UNC path.
		 * @return A new Uri instance.
E
Erich Gamma 已提交
1170 1171 1172 1173
		 */
		static file(path: string): Uri;

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

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

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

		/**
J
Johannes Rieken 已提交
1195
		 * Path is the `/some/path` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1196
		 */
J
Johannes Rieken 已提交
1197
		readonly path: string;
E
Erich Gamma 已提交
1198 1199

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

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

		/**
1210
		 * The string representing the corresponding file system path of this Uri.
J
Johannes Rieken 已提交
1211
		 *
E
Erich Gamma 已提交
1212 1213
		 * Will handle UNC paths and normalize windows drive letters to lower-case. Also
		 * uses the platform specific path separator. Will *not* validate the path for
1214
		 * invalid characters and semantics. Will *not* look at the scheme of this Uri.
E
Erich Gamma 已提交
1215
		 */
J
Johannes Rieken 已提交
1216
		readonly fsPath: string;
E
Erich Gamma 已提交
1217

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

E
Erich Gamma 已提交
1234
		/**
1235 1236 1237
		 * Returns a string representation of this Uri. The representation and normalization
		 * of a URI depends on the scheme. The resulting string can be safely used with
		 * [Uri.parse](#Uri.parse).
J
Johannes Rieken 已提交
1238
		 *
1239 1240 1241
		 * @param skipEncoding Do not percentage-encode the result, defaults to `false`. Note that
		 *	the `#` and `?` characters occuring in the path will always be encoded.
		 * @returns A string representation of this Uri.
E
Erich Gamma 已提交
1242
		 */
1243
		toString(skipEncoding?: boolean): string;
E
Erich Gamma 已提交
1244

J
Johannes Rieken 已提交
1245 1246 1247 1248 1249
		/**
		 * Returns a JSON representation of this Uri.
		 *
		 * @return An object.
		 */
E
Erich Gamma 已提交
1250 1251 1252 1253
		toJSON(): any;
	}

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

		/**
J
Johannes Rieken 已提交
1264
		 * Is `true` when the token has been cancelled, `false` otherwise.
E
Erich Gamma 已提交
1265 1266 1267 1268
		 */
		isCancellationRequested: boolean;

		/**
J
Johannes Rieken 已提交
1269
		 * An [event](#Event) which fires upon cancellation.
E
Erich Gamma 已提交
1270 1271 1272 1273 1274
		 */
		onCancellationRequested: Event<any>;
	}

	/**
J
Johannes Rieken 已提交
1275
	 * A cancellation source creates and controls a [cancellation token](#CancellationToken).
E
Erich Gamma 已提交
1276 1277 1278 1279
	 */
	export class CancellationTokenSource {

		/**
J
Johannes Rieken 已提交
1280
		 * The cancellation token of this source.
E
Erich Gamma 已提交
1281 1282 1283 1284 1285 1286 1287 1288 1289
		 */
		token: CancellationToken;

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

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

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

	/**
	 * Represents a typed event.
J
Johannes Rieken 已提交
1327 1328 1329 1330 1331
	 *
	 * 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 已提交
1332 1333 1334 1335
	 */
	export interface Event<T> {

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

1347 1348 1349 1350 1351
	/**
	 * 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 已提交
1352
	 * inside a [TextDocumentContentProvider](#TextDocumentContentProvider) or when providing
1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375
	 * API to other extensions.
	 */
	export class EventEmitter<T> {

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

		/**
		 * Notify all subscribers of the [event](EventEmitter#event). Failure
		 * of one or more listener will not fail this function call.
		 *
		 * @param data The event object.
		 */
		fire(data?: T): void;

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

E
Erich Gamma 已提交
1376 1377
	/**
	 * A file system watcher notifies about changes to files and folders
J
Johannes Rieken 已提交
1378 1379 1380
	 * on disk.
	 *
	 * To get an instance of a `FileSystemWatcher` use
J
Johannes Rieken 已提交
1381
	 * [createFileSystemWatcher](#workspace.createFileSystemWatcher).
E
Erich Gamma 已提交
1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400
	 */
	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 已提交
1401
		ignoreDeleteEvents: boolean;
E
Erich Gamma 已提交
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418

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

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

1430 1431 1432 1433
		/**
		 * An event to signal a resource has changed.
		 */
		onDidChange?: Event<Uri>;
J
Johannes Rieken 已提交
1434

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

E
Erich Gamma 已提交
1449 1450
	/**
	 * Represents an item that can be selected from
A
Andre Weinand 已提交
1451
	 * a list of items.
E
Erich Gamma 已提交
1452 1453 1454 1455
	 */
	export interface QuickPickItem {

		/**
J
Johannes Rieken 已提交
1456
		 * A human readable string which is rendered prominent.
E
Erich Gamma 已提交
1457 1458 1459 1460
		 */
		label: string;

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

		/**
		 * A human readable string which is rendered less prominent.
		 */
		detail?: string;
E
Erich Gamma 已提交
1469 1470 1471
	}

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

J
Johannes Rieken 已提交
1480 1481 1482 1483 1484
		/**
		 * An optional flag to include the detail when filtering the picks.
		 */
		matchOnDetail?: boolean;

E
Erich Gamma 已提交
1485
		/**
S
Steven Clarke 已提交
1486
		 * An optional string to show as place holder in the input box to guide the user what to pick on.
J
Johannes Rieken 已提交
1487
		 */
E
Erich Gamma 已提交
1488
		placeHolder?: string;
1489

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

1495 1496 1497
		/**
		 * An optional function that is invoked whenever an item is selected.
		 */
A
Amadare42 已提交
1498
		onDidSelectItem?(item: QuickPickItem | string): any;
E
Erich Gamma 已提交
1499 1500 1501
	}

	/**
J
Johannes Rieken 已提交
1502
	 * Represents an action that is shown with an information, warning, or
A
Andre Weinand 已提交
1503
	 * error message.
E
Erich Gamma 已提交
1504
	 *
S
Sofian Hnaide 已提交
1505 1506 1507
	 * @see [showInformationMessage](#window.showInformationMessage)
	 * @see [showWarningMessage](#window.showWarningMessage)
	 * @see [showErrorMessage](#window.showErrorMessage)
E
Erich Gamma 已提交
1508 1509 1510 1511
	 */
	export interface MessageItem {

		/**
A
Andre Weinand 已提交
1512
		 * A short title like 'Retry', 'Open Log' etc.
E
Erich Gamma 已提交
1513 1514
		 */
		title: string;
1515 1516 1517 1518 1519 1520

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

J
Joao Moreno 已提交
1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537
	/**
	 * 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 已提交
1538
	/**
J
Johannes Rieken 已提交
1539
	 * Options to configure the behavior of the input box UI.
E
Erich Gamma 已提交
1540 1541
	 */
	export interface InputBoxOptions {
J
Johannes Rieken 已提交
1542

E
Erich Gamma 已提交
1543
		/**
J
Johannes Rieken 已提交
1544 1545
		 * The value to prefill in the input box.
		 */
E
Erich Gamma 已提交
1546 1547
		value?: string;

1548
		/**
1549 1550 1551 1552
		 * 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.
1553
		 */
1554
		valueSelection?: [number, number];
1555

E
Erich Gamma 已提交
1556
		/**
J
Johannes Rieken 已提交
1557 1558
		 * The text to display underneath the input box.
		 */
E
Erich Gamma 已提交
1559 1560 1561
		prompt?: string;

		/**
J
Johannes Rieken 已提交
1562 1563
		 * An optional string to show as place holder in the input box to guide the user what to type.
		 */
E
Erich Gamma 已提交
1564 1565 1566
		placeHolder?: string;

		/**
1567
		 * Set to `true` to show a password prompt that will not show the typed value.
J
Johannes Rieken 已提交
1568
		 */
E
Erich Gamma 已提交
1569
		password?: boolean;
1570

1571 1572 1573 1574 1575
		/**
		 * Set to `true` to keep the input box open when focus moves to another part of the editor or to another window.
		 */
		ignoreFocusOut?: boolean;

1576
		/**
P
Pine 已提交
1577
		 * An optional function that will be called to validate input and to give a hint
1578 1579 1580 1581 1582 1583
		 * 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.
		 */
1584
		validateInput?(value: string): string | undefined | null;
E
Erich Gamma 已提交
1585 1586 1587 1588
	}

	/**
	 * A document filter denotes a document by different properties like
A
Alex Dima 已提交
1589
	 * the [language](#TextDocument.languageId), the [scheme](#Uri.scheme) of
A
Andre Weinand 已提交
1590
	 * its resource, or a glob-pattern that is applied to the [path](#TextDocument.fileName).
E
Erich Gamma 已提交
1591
	 *
J
Johannes Rieken 已提交
1592
	 * @sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
M
Matan Kushner 已提交
1593
	 * @sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**∕package.json' }`
E
Erich Gamma 已提交
1594 1595 1596 1597 1598 1599 1600 1601 1602
	 */
	export interface DocumentFilter {

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

		/**
J
Johannes Rieken 已提交
1603
		 * A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
E
Erich Gamma 已提交
1604 1605 1606 1607
		 */
		scheme?: string;

		/**
J
Johannes Rieken 已提交
1608
		 * A glob pattern, like `*.{ts,js}`.
E
Erich Gamma 已提交
1609 1610 1611 1612 1613 1614
		 */
		pattern?: string;
	}

	/**
	 * A language selector is the combination of one or many language identifiers
1615
	 * and [language filters](#DocumentFilter).
J
Johannes Rieken 已提交
1616 1617
	 *
	 * @sample `let sel:DocumentSelector = 'typescript'`;
1618
	 * @sample `let sel:DocumentSelector = ['typescript', { language: 'json', pattern: '**∕tsconfig.json' }]`;
E
Erich Gamma 已提交
1619 1620 1621
	 */
	export type DocumentSelector = string | DocumentFilter | (string | DocumentFilter)[];

1622 1623 1624 1625 1626 1627 1628 1629 1630 1631

	/**
	 * A provider result represents the values a provider, like the [`HoverProvider`](#HoverProvider),
	 * may return. For once this is the actual result type `T`, like `Hover`, or a thenable that resolves
	 * to that type `T`. In addition, `null` and `undefined` can be returned - either directly or from a
	 * thenable.
	 *
	 * The snippets below are all valid implementions of the [`HoverProvider`](#HoverProvider):
	 *
	 * ```ts
1632 1633 1634 1635 1636
	 * let a: HoverProvider = {
	 * 	provideHover(doc, pos, token): ProviderResult<Hover> {
	 * 		return new Hover('Hello World');
	 * 	}
	 * }
1637
	 *
1638 1639 1640 1641 1642 1643 1644
	 * let b: HoverProvider = {
	 * 	provideHover(doc, pos, token): ProviderResult<Hover> {
	 * 		return new Promise(resolve => {
	 * 			resolve(new Hover('Hello World'));
	 * 	 	});
	 * 	}
	 * }
1645
	 *
1646 1647 1648 1649 1650 1651
	 * let c: HoverProvider = {
	 * 	provideHover(doc, pos, token): ProviderResult<Hover> {
	 * 		return; // undefined
	 * 	}
	 * }
	 * ```
1652
	 */
J
Johannes Rieken 已提交
1653
	export type ProviderResult<T> = T | undefined | null | Thenable<T | undefined | null>;
1654

E
Erich Gamma 已提交
1655 1656
	/**
	 * Contains additional diagnostic information about the context in which
J
Johannes Rieken 已提交
1657
	 * a [code action](#CodeActionProvider.provideCodeActions) is run.
E
Erich Gamma 已提交
1658 1659
	 */
	export interface CodeActionContext {
J
Johannes Rieken 已提交
1660 1661 1662 1663

		/**
		 * An array of diagnostics.
		 */
Y
Yuki Ueda 已提交
1664
		readonly diagnostics: Diagnostic[];
E
Erich Gamma 已提交
1665 1666 1667
	}

	/**
J
Johannes Rieken 已提交
1668 1669 1670 1671
	 * 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 已提交
1672 1673 1674 1675 1676 1677
	 */
	export interface CodeActionProvider {

		/**
		 * Provide commands for the given document and range.
		 *
J
Johannes Rieken 已提交
1678 1679
		 * @param document The document in which the command was invoked.
		 * @param range The range for which the command was invoked.
J
Johannes Rieken 已提交
1680 1681
		 * @param context Context carrying additional information.
		 * @param token A cancellation token.
J
Johannes Rieken 已提交
1682
		 * @return An array of commands or a thenable of such. The lack of a result can be
A
Andre Weinand 已提交
1683
		 * signaled by returning `undefined`, `null`, or an empty array.
E
Erich Gamma 已提交
1684
		 */
1685
		provideCodeActions(document: TextDocument, range: Range, context: CodeActionContext, token: CancellationToken): ProviderResult<Command[]>;
E
Erich Gamma 已提交
1686 1687 1688 1689 1690
	}

	/**
	 * 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 已提交
1691 1692 1693
	 *
	 * 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 已提交
1694 1695 1696
	 *
	 * @see [CodeLensProvider.provideCodeLenses](#CodeLensProvider.provideCodeLenses)
	 * @see [CodeLensProvider.resolveCodeLens](#CodeLensProvider.resolveCodeLens)
E
Erich Gamma 已提交
1697 1698 1699 1700 1701 1702 1703 1704 1705
	 */
	export class CodeLens {

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

		/**
J
Johannes Rieken 已提交
1706
		 * The command this code lens represents.
E
Erich Gamma 已提交
1707
		 */
1708
		command?: Command;
E
Erich Gamma 已提交
1709 1710

		/**
J
Johannes Rieken 已提交
1711
		 * `true` when there is a command associated.
E
Erich Gamma 已提交
1712
		 */
Y
Yuki Ueda 已提交
1713
		readonly isResolved: boolean;
J
Johannes Rieken 已提交
1714 1715 1716 1717 1718 1719 1720 1721

		/**
		 * 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 已提交
1722 1723 1724 1725 1726 1727 1728 1729
	}

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

1730 1731 1732
		/**
		 * An optional event to signal that the code lenses from this provider have changed.
		 */
1733
		onDidChangeCodeLenses?: Event<void>;
1734

E
Erich Gamma 已提交
1735 1736
		/**
		 * Compute a list of [lenses](#CodeLens). This call should return as fast as possible and if
A
Andre Weinand 已提交
1737
		 * computing the commands is expensive implementors should only return code lens objects with the
E
Erich Gamma 已提交
1738
		 * range set and implement [resolve](#CodeLensProvider.resolveCodeLens).
J
Johannes Rieken 已提交
1739 1740 1741
		 *
		 * @param document The document in which the command was invoked.
		 * @param token A cancellation token.
A
Andre Weinand 已提交
1742 1743
		 * @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 已提交
1744
		 */
1745
		provideCodeLenses(document: TextDocument, token: CancellationToken): ProviderResult<CodeLens[]>;
E
Erich Gamma 已提交
1746 1747 1748 1749

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

	/**
J
Johannes Rieken 已提交
1759 1760 1761
	 * 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 已提交
1762 1763 1764
	 */
	export type Definition = Location | Location[];

J
Johannes Rieken 已提交
1765 1766 1767 1768 1769
	/**
	 * 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 已提交
1770
	export interface DefinitionProvider {
J
Johannes Rieken 已提交
1771 1772 1773 1774 1775 1776 1777

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

1784
	/**
1785
	 * The implemenetation provider interface defines the contract between extensions and
1786 1787
	 * the go to implementation feature.
	 */
M
Matt Bierner 已提交
1788
	export interface ImplementationProvider {
1789 1790 1791 1792 1793 1794 1795 1796 1797 1798

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

1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819
	/**
	 * The type definition provider defines the contract between extensions and
	 * the go to type definition feature.
	 */
	export interface TypeDefinitionProvider {

		/**
		 * Provide the type definition of the symbol at the given position and document.
		 *
		 * @param document The document in which the command was invoked.
		 * @param position The position at which the command was invoked.
		 * @param token A cancellation token.
		 * @return A definition or a thenable that resolves to such. The lack of a result can be
		 * signaled by returning `undefined` or `null`.
		 */
		provideTypeDefinition(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Definition>;
	}

E
Erich Gamma 已提交
1820
	/**
1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858
	 * The MarkdownString represents human readable text that supports formatting via the
	 * markdown syntax. Standard markdown is supported, also tables, but no embedded html.
	 */
	export class MarkdownString {

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

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

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

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

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

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

J
Johannes Rieken 已提交
1866 1867 1868 1869
	/**
	 * A hover represents additional information for a symbol or word. Hovers are
	 * rendered in a tooltip-like widget.
	 */
E
Erich Gamma 已提交
1870 1871
	export class Hover {

J
Johannes Rieken 已提交
1872 1873 1874
		/**
		 * The contents of this hover.
		 */
E
Erich Gamma 已提交
1875 1876
		contents: MarkedString[];

J
Johannes Rieken 已提交
1877
		/**
A
Andre Weinand 已提交
1878
		 * The range to which this hover applies. When missing, the
J
Johannes Rieken 已提交
1879
		 * editor will use the range at the current position or the
A
Andre Weinand 已提交
1880
		 * current position itself.
J
Johannes Rieken 已提交
1881
		 */
1882
		range?: Range;
E
Erich Gamma 已提交
1883

J
Johannes Rieken 已提交
1884 1885 1886 1887
		/**
		 * Creates a new hover object.
		 *
		 * @param contents The contents of the hover.
A
Andre Weinand 已提交
1888
		 * @param range The range to which the hover applies.
J
Johannes Rieken 已提交
1889
		 */
E
Erich Gamma 已提交
1890 1891 1892
		constructor(contents: MarkedString | MarkedString[], range?: Range);
	}

J
Johannes Rieken 已提交
1893 1894
	/**
	 * The hover provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
1895
	 * the [hover](https://code.visualstudio.com/docs/editor/intellisense)-feature.
J
Johannes Rieken 已提交
1896
	 */
E
Erich Gamma 已提交
1897
	export interface HoverProvider {
J
Johannes Rieken 已提交
1898 1899 1900

		/**
		 * Provide a hover for the given position and document. Multiple hovers at the same
A
Andre Weinand 已提交
1901 1902
		 * 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 已提交
1903 1904 1905 1906 1907
		 *
		 * @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 已提交
1908
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
1909
		 */
1910
		provideHover(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Hover>;
E
Erich Gamma 已提交
1911 1912
	}

J
Johannes Rieken 已提交
1913 1914 1915
	/**
	 * A document highlight kind.
	 */
E
Erich Gamma 已提交
1916
	export enum DocumentHighlightKind {
J
Johannes Rieken 已提交
1917 1918

		/**
A
Andre Weinand 已提交
1919
		 * A textual occurrence.
J
Johannes Rieken 已提交
1920
		 */
1921
		Text = 0,
J
Johannes Rieken 已提交
1922 1923 1924 1925

		/**
		 * Read-access of a symbol, like reading a variable.
		 */
1926
		Read = 1,
J
Johannes Rieken 已提交
1927 1928 1929 1930

		/**
		 * Write-access of a symbol, like writing to a variable.
		 */
1931
		Write = 2
E
Erich Gamma 已提交
1932 1933
	}

J
Johannes Rieken 已提交
1934 1935 1936 1937 1938
	/**
	 * 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 已提交
1939
	export class DocumentHighlight {
J
Johannes Rieken 已提交
1940 1941 1942 1943

		/**
		 * The range this highlight applies to.
		 */
E
Erich Gamma 已提交
1944
		range: Range;
J
Johannes Rieken 已提交
1945 1946 1947 1948

		/**
		 * The highlight kind, default is [text](#DocumentHighlightKind.Text).
		 */
1949
		kind?: DocumentHighlightKind;
J
Johannes Rieken 已提交
1950 1951 1952 1953 1954 1955 1956 1957

		/**
		 * 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 已提交
1958 1959
	}

J
Johannes Rieken 已提交
1960 1961 1962 1963
	/**
	 * The document highlight provider interface defines the contract between extensions and
	 * the word-highlight-feature.
	 */
E
Erich Gamma 已提交
1964
	export interface DocumentHighlightProvider {
J
Johannes Rieken 已提交
1965 1966

		/**
S
Steven Clarke 已提交
1967
		 * Provide a set of document highlights, like all occurrences of a variable or
J
Johannes Rieken 已提交
1968 1969 1970 1971 1972 1973
		 * 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 已提交
1974
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1975
		 */
1976
		provideDocumentHighlights(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<DocumentHighlight[]>;
E
Erich Gamma 已提交
1977 1978
	}

J
Johannes Rieken 已提交
1979 1980 1981
	/**
	 * A symbol kind.
	 */
E
Erich Gamma 已提交
1982
	export enum SymbolKind {
1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002
		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,
2003 2004 2005 2006
		Null = 20,
		EnumMember = 21,
		Struct = 22,
		Event = 23,
2007 2008
		Operator = 24,
		TypeParameter = 25
E
Erich Gamma 已提交
2009 2010
	}

J
Johannes Rieken 已提交
2011 2012 2013 2014
	/**
	 * Represents information about programming constructs like variables, classes,
	 * interfaces etc.
	 */
E
Erich Gamma 已提交
2015
	export class SymbolInformation {
J
Johannes Rieken 已提交
2016 2017 2018 2019

		/**
		 * The name of this symbol.
		 */
E
Erich Gamma 已提交
2020
		name: string;
J
Johannes Rieken 已提交
2021 2022 2023 2024

		/**
		 * The name of the symbol containing this symbol.
		 */
E
Erich Gamma 已提交
2025
		containerName: string;
J
Johannes Rieken 已提交
2026 2027 2028 2029

		/**
		 * The kind of this symbol.
		 */
E
Erich Gamma 已提交
2030
		kind: SymbolKind;
J
Johannes Rieken 已提交
2031 2032 2033 2034

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

2037 2038 2039 2040 2041 2042 2043 2044 2045 2046
		/**
		 * Creates a new symbol information object.
		 *
		 * @param name The name of the symbol.
		 * @param kind The kind of the symbol.
		 * @param containerName The name of the symbol containing the symbol.
		 * @param location The the location of the symbol.
		 */
		constructor(name: string, kind: SymbolKind, containerName: string, location: Location);

J
Johannes Rieken 已提交
2047
		/**
2048
		 * ~~Creates a new symbol information object.~~
2049
		 *
2050
		 * @deprecated Please use the constructor taking a [location](#Location) object.
J
Johannes Rieken 已提交
2051 2052 2053 2054 2055
		 *
		 * @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 已提交
2056
		 * @param containerName The name of the symbol containing the symbol.
J
Johannes Rieken 已提交
2057 2058
		 */
		constructor(name: string, kind: SymbolKind, range: Range, uri?: Uri, containerName?: string);
E
Erich Gamma 已提交
2059 2060
	}

J
Johannes Rieken 已提交
2061 2062
	/**
	 * The document symbol provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
2063
	 * the [go to symbol](https://code.visualstudio.com/docs/editor/editingevolved#_go-to-symbol)-feature.
J
Johannes Rieken 已提交
2064
	 */
E
Erich Gamma 已提交
2065
	export interface DocumentSymbolProvider {
J
Johannes Rieken 已提交
2066 2067 2068 2069 2070 2071 2072

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

J
Johannes Rieken 已提交
2078 2079 2080 2081
	/**
	 * 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 已提交
2082
	export interface WorkspaceSymbolProvider {
J
Johannes Rieken 已提交
2083 2084 2085

		/**
		 * Project-wide search for a symbol matching the given query string. It is up to the provider
2086 2087 2088
		 * how to search given the query string, like substring, indexOf etc. To improve performance implementors can
		 * skip the [location](#SymbolInformation.location) of symbols and implement `resolveWorkspaceSymbol` to do that
		 * later.
J
Johannes Rieken 已提交
2089 2090 2091 2092
		 *
		 * @param query A non-empty query string.
		 * @param token A cancellation token.
		 * @return An array of document highlights or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
2093
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2094
		 */
2095
		provideWorkspaceSymbols(query: string, token: CancellationToken): ProviderResult<SymbolInformation[]>;
2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108

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

J
Johannes Rieken 已提交
2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127
	/**
	 * 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 已提交
2128
	export interface ReferenceProvider {
J
Johannes Rieken 已提交
2129 2130 2131 2132 2133 2134 2135 2136 2137

		/**
		 * Provide a set of project-wide references for the given position and document.
		 *
		 * @param document The document in which the command was invoked.
		 * @param position The position at which the command was invoked.
		 * @param context
		 * @param token A cancellation token.
		 * @return An array of locations or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
2138
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2139
		 */
2140
		provideReferences(document: TextDocument, position: Position, context: ReferenceContext, token: CancellationToken): ProviderResult<Location[]>;
E
Erich Gamma 已提交
2141 2142
	}

J
Johannes Rieken 已提交
2143
	/**
S
Steven Clarke 已提交
2144
	 * A text edit represents edits that should be applied
J
Johannes Rieken 已提交
2145
	 * to a document.
J
Johannes Rieken 已提交
2146
	 */
E
Erich Gamma 已提交
2147
	export class TextEdit {
J
Johannes Rieken 已提交
2148 2149 2150 2151 2152 2153 2154 2155

		/**
		 * Utility to create a replace edit.
		 *
		 * @param range A range.
		 * @param newText A string.
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
2156
		static replace(range: Range, newText: string): TextEdit;
J
Johannes Rieken 已提交
2157 2158 2159 2160

		/**
		 * Utility to create an insert edit.
		 *
S
Steven Clarke 已提交
2161
		 * @param position A position, will become an empty range.
J
Johannes Rieken 已提交
2162 2163 2164
		 * @param newText A string.
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
2165
		static insert(position: Position, newText: string): TextEdit;
J
Johannes Rieken 已提交
2166 2167 2168 2169

		/**
		 * Utility to create a delete edit.
		 *
J
Johannes Rieken 已提交
2170
		 * @param range A range.
J
Johannes Rieken 已提交
2171 2172
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
2173
		static delete(range: Range): TextEdit;
J
Johannes Rieken 已提交
2174

2175 2176 2177 2178 2179 2180 2181 2182
		/**
		 * 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 已提交
2183 2184 2185
		/**
		 * The range this edit applies to.
		 */
E
Erich Gamma 已提交
2186
		range: Range;
J
Johannes Rieken 已提交
2187 2188 2189 2190

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

2193 2194
		/**
		 * The eol-sequence used in the document.
J
Johannes Rieken 已提交
2195 2196 2197
		 *
		 * *Note* that the eol-sequence will be applied to the
		 * whole document.
2198 2199 2200
		 */
		newEol: EndOfLine;

J
Johannes Rieken 已提交
2201 2202 2203 2204 2205 2206 2207
		/**
		 * Create a new TextEdit.
		 *
		 * @param range A range.
		 * @param newText A string.
		 */
		constructor(range: Range, newText: string);
E
Erich Gamma 已提交
2208 2209 2210
	}

	/**
J
Johannes Rieken 已提交
2211
	 * A workspace edit represents textual changes for many documents.
E
Erich Gamma 已提交
2212 2213 2214 2215 2216 2217
	 */
	export class WorkspaceEdit {

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

J
Johannes Rieken 已提交
2220 2221 2222 2223 2224 2225 2226 2227
		/**
		 * 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 已提交
2228

J
Johannes Rieken 已提交
2229 2230 2231 2232 2233 2234 2235 2236
		/**
		 * 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 已提交
2237

J
Johannes Rieken 已提交
2238
		/**
S
Steven Clarke 已提交
2239
		 * Delete the text at the given range.
J
Johannes Rieken 已提交
2240 2241 2242
		 *
		 * @param uri A resource identifier.
		 * @param range A range.
J
Johannes Rieken 已提交
2243 2244
		 */
		delete(uri: Uri, range: Range): void;
E
Erich Gamma 已提交
2245

J
Johannes Rieken 已提交
2246 2247 2248
		/**
		 * Check if this edit affects the given resource.
		 * @param uri A resource identifier.
A
Andre Weinand 已提交
2249
		 * @return `true` if the given resource will be touched by this edit.
J
Johannes Rieken 已提交
2250
		 */
E
Erich Gamma 已提交
2251 2252
		has(uri: Uri): boolean;

J
Johannes Rieken 已提交
2253 2254 2255 2256 2257 2258
		/**
		 * Set (and replace) text edits for a resource.
		 *
		 * @param uri A resource identifier.
		 * @param edits An array of text edits.
		 */
E
Erich Gamma 已提交
2259 2260
		set(uri: Uri, edits: TextEdit[]): void;

J
Johannes Rieken 已提交
2261 2262 2263 2264 2265 2266
		/**
		 * Get the text edits for a resource.
		 *
		 * @param uri A resource identifier.
		 * @return An array of text edits.
		 */
E
Erich Gamma 已提交
2267 2268
		get(uri: Uri): TextEdit[];

J
Johannes Rieken 已提交
2269 2270 2271 2272 2273
		/**
		 * Get all text edits grouped by resource.
		 *
		 * @return An array of `[Uri, TextEdit[]]`-tuples.
		 */
E
Erich Gamma 已提交
2274 2275 2276
		entries(): [Uri, TextEdit[]][];
	}

2277 2278 2279 2280 2281 2282
	/**
	 * 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
2283 2284
	 * the end of the snippet. Variables are defined with `$name` and
	 * `${name:default value}`. The full snippet syntax is documented
G
Greg Van Liew 已提交
2285
	 * [here](http://code.visualstudio.com/docs/editor/userdefinedsnippets#_creating-your-own-snippets).
2286 2287 2288 2289 2290 2291 2292 2293
	 */
	export class SnippetString {

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

2294 2295 2296 2297 2298 2299 2300
		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.
2301
		 * @return This snippet string.
2302 2303 2304 2305 2306 2307 2308 2309 2310
		 */
		appendText(string: string): SnippetString;

		/**
		 * Builder-function that appends a tabstop (`$1`, `$2` etc) to
		 * the [`value`](#SnippetString.value) of this snippet string.
		 *
		 * @param number The number of this tabstop, defaults to an auto-incremet
		 * value starting at 1.
2311
		 * @return This snippet string.
2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322
		 */
		appendTabstop(number?: number): SnippetString;

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

		/**
J
Johannes Rieken 已提交
2328
		 * Builder-function that appends a variable (`${VAR}`) to
2329 2330 2331 2332 2333 2334 2335 2336
		 * 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;
2337 2338
	}

E
Erich Gamma 已提交
2339
	/**
J
Johannes Rieken 已提交
2340 2341
	 * 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 已提交
2342 2343
	 */
	export interface RenameProvider {
J
Johannes Rieken 已提交
2344 2345 2346 2347 2348 2349 2350 2351 2352 2353

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

J
Johannes Rieken 已提交
2359 2360 2361
	/**
	 * Value-object describing what options formatting should use.
	 */
E
Erich Gamma 已提交
2362
	export interface FormattingOptions {
J
Johannes Rieken 已提交
2363 2364 2365 2366

		/**
		 * Size of a tab in spaces.
		 */
E
Erich Gamma 已提交
2367
		tabSize: number;
J
Johannes Rieken 已提交
2368 2369 2370 2371

		/**
		 * Prefer spaces over tabs.
		 */
E
Erich Gamma 已提交
2372
		insertSpaces: boolean;
J
Johannes Rieken 已提交
2373 2374 2375 2376 2377

		/**
		 * Signature for further properties.
		 */
		[key: string]: boolean | number | string;
E
Erich Gamma 已提交
2378 2379 2380
	}

	/**
J
Johannes Rieken 已提交
2381 2382
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
2383 2384
	 */
	export interface DocumentFormattingEditProvider {
J
Johannes Rieken 已提交
2385 2386 2387 2388 2389 2390 2391 2392

		/**
		 * 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 已提交
2393
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2394
		 */
2395
		provideDocumentFormattingEdits(document: TextDocument, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
2396 2397 2398
	}

	/**
J
Johannes Rieken 已提交
2399 2400
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
2401 2402
	 */
	export interface DocumentRangeFormattingEditProvider {
J
Johannes Rieken 已提交
2403 2404 2405 2406 2407

		/**
		 * 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 已提交
2408 2409
		 * or larger range. Often this is done by adjusting the start and end
		 * of the range to full syntax nodes.
J
Johannes Rieken 已提交
2410 2411 2412 2413 2414 2415
		 *
		 * @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 已提交
2416
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2417
		 */
2418
		provideDocumentRangeFormattingEdits(document: TextDocument, range: Range, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
2419 2420 2421
	}

	/**
J
Johannes Rieken 已提交
2422 2423
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
2424 2425
	 */
	export interface OnTypeFormattingEditProvider {
J
Johannes Rieken 已提交
2426 2427 2428 2429 2430 2431 2432 2433 2434 2435

		/**
		 * 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 已提交
2436
		 * @param ch The character that has been typed.
J
Johannes Rieken 已提交
2437 2438 2439
		 * @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 已提交
2440
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2441
		 */
2442
		provideOnTypeFormattingEdits(document: TextDocument, position: Position, ch: string, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
2443 2444
	}

J
Johannes Rieken 已提交
2445 2446 2447 2448
	/**
	 * Represents a parameter of a callable-signature. A parameter can
	 * have a label and a doc-comment.
	 */
E
Erich Gamma 已提交
2449
	export class ParameterInformation {
J
Johannes Rieken 已提交
2450 2451 2452 2453 2454

		/**
		 * The label of this signature. Will be shown in
		 * the UI.
		 */
E
Erich Gamma 已提交
2455
		label: string;
J
Johannes Rieken 已提交
2456 2457 2458 2459 2460

		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
2461
		documentation?: string | MarkdownString;
J
Johannes Rieken 已提交
2462 2463 2464 2465 2466 2467 2468

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

J
Johannes Rieken 已提交
2472 2473 2474 2475 2476
	/**
	 * 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 已提交
2477
	export class SignatureInformation {
J
Johannes Rieken 已提交
2478 2479 2480 2481 2482

		/**
		 * The label of this signature. Will be shown in
		 * the UI.
		 */
E
Erich Gamma 已提交
2483
		label: string;
J
Johannes Rieken 已提交
2484 2485 2486 2487 2488

		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
2489
		documentation?: string | MarkdownString;
J
Johannes Rieken 已提交
2490 2491 2492 2493

		/**
		 * The parameters of this signature.
		 */
E
Erich Gamma 已提交
2494
		parameters: ParameterInformation[];
J
Johannes Rieken 已提交
2495 2496 2497 2498 2499

		/**
		 * Creates a new signature information object.
		 *
		 * @param label A label string.
J
Johannes Rieken 已提交
2500
		 * @param documentation A doc string.
J
Johannes Rieken 已提交
2501
		 */
2502
		constructor(label: string, documentation?: string | MarkdownString);
E
Erich Gamma 已提交
2503 2504
	}

J
Johannes Rieken 已提交
2505 2506
	/**
	 * Signature help represents the signature of something
S
Steven Clarke 已提交
2507
	 * callable. There can be multiple signatures but only one
J
Johannes Rieken 已提交
2508 2509
	 * active and only one active parameter.
	 */
E
Erich Gamma 已提交
2510
	export class SignatureHelp {
J
Johannes Rieken 已提交
2511 2512 2513 2514

		/**
		 * One or more signatures.
		 */
E
Erich Gamma 已提交
2515
		signatures: SignatureInformation[];
J
Johannes Rieken 已提交
2516 2517 2518 2519

		/**
		 * The active signature.
		 */
E
Erich Gamma 已提交
2520
		activeSignature: number;
J
Johannes Rieken 已提交
2521 2522 2523 2524

		/**
		 * The active parameter of the active signature.
		 */
E
Erich Gamma 已提交
2525 2526 2527
		activeParameter: number;
	}

J
Johannes Rieken 已提交
2528 2529
	/**
	 * The signature help provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
2530
	 * the [parameter hints](https://code.visualstudio.com/docs/editor/intellisense)-feature.
J
Johannes Rieken 已提交
2531
	 */
E
Erich Gamma 已提交
2532
	export interface SignatureHelpProvider {
J
Johannes Rieken 已提交
2533 2534 2535 2536 2537 2538 2539 2540

		/**
		 * Provide help for the signature at the given position and document.
		 *
		 * @param document The document in which the command was invoked.
		 * @param position The position at which the command was invoked.
		 * @param token A cancellation token.
		 * @return Signature help or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
2541
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
2542
		 */
2543
		provideSignatureHelp(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<SignatureHelp>;
E
Erich Gamma 已提交
2544 2545
	}

J
Johannes Rieken 已提交
2546 2547 2548
	/**
	 * Completion item kinds.
	 */
E
Erich Gamma 已提交
2549
	export enum CompletionItemKind {
2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565
		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,
2566
		Reference = 17,
2567
		File = 16,
2568 2569 2570 2571 2572
		Folder = 18,
		EnumMember = 19,
		Constant = 20,
		Struct = 21,
		Event = 22,
2573 2574
		Operator = 23,
		TypeParameter = 24
E
Erich Gamma 已提交
2575 2576
	}

J
Johannes Rieken 已提交
2577
	/**
2578
	 * A completion item represents a text snippet that is proposed to complete text that is being typed.
J
Johannes Rieken 已提交
2579
	 *
2580 2581 2582 2583
	 * It is suffient to create a completion item from just a [label](#CompletionItem.label). In that
	 * case the completion item will replace the [word](#TextDocument.getWordRangeAtPosition)
	 * until the cursor with the given label or [insertText](#CompletionItem.insertText). Otherwise the
	 * the given [edit](#CompletionItem.textEdit) is used.
2584
	 *
2585 2586 2587
	 * When selecting a completion item in the editor its defined or synthesized text edit will be applied
	 * to *all* cursors/selections whereas [additionalTextEdits](CompletionItem.additionalTextEdits) will be
	 * applied as provided.
2588
	 *
J
Johannes Rieken 已提交
2589 2590
	 * @see [CompletionItemProvider.provideCompletionItems](#CompletionItemProvider.provideCompletionItems)
	 * @see [CompletionItemProvider.resolveCompletionItem](#CompletionItemProvider.resolveCompletionItem)
J
Johannes Rieken 已提交
2591
	 */
E
Erich Gamma 已提交
2592
	export class CompletionItem {
J
Johannes Rieken 已提交
2593 2594 2595

		/**
		 * The label of this completion item. By default
A
Andre Weinand 已提交
2596
		 * this is also the text that is inserted when selecting
J
Johannes Rieken 已提交
2597 2598
		 * this completion.
		 */
E
Erich Gamma 已提交
2599
		label: string;
J
Johannes Rieken 已提交
2600 2601

		/**
S
Steven Clarke 已提交
2602
		 * The kind of this completion item. Based on the kind
J
Johannes Rieken 已提交
2603 2604
		 * an icon is chosen by the editor.
		 */
2605
		kind?: CompletionItemKind;
J
Johannes Rieken 已提交
2606 2607 2608 2609 2610

		/**
		 * A human-readable string with additional information
		 * about this item, like type or symbol information.
		 */
2611
		detail?: string;
J
Johannes Rieken 已提交
2612 2613 2614 2615

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

		/**
A
Andre Weinand 已提交
2619
		 * A string that should be used when comparing this item
J
Johannes Rieken 已提交
2620 2621 2622
		 * with other items. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
2623
		sortText?: string;
J
Johannes Rieken 已提交
2624 2625 2626 2627 2628 2629

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

		/**
2633
		 * A string or snippet that should be inserted in a document when selecting
J
Johannes Rieken 已提交
2634 2635 2636
		 * this completion. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
2637
		insertText?: string | SnippetString;
2638 2639 2640 2641 2642 2643 2644 2645 2646 2647

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

2650 2651
		/**
		 * An optional set of characters that when pressed while this completion is active will accept it first and
J
Johannes Rieken 已提交
2652
		 * then type that character. *Note* that all commit characters should have `length=1` and that superfluous
2653 2654 2655 2656
		 * characters will be ignored.
		 */
		commitCharacters?: string[];

J
Johannes Rieken 已提交
2657
		/**
2658
		 * @deprecated Use `CompletionItem.insertText` and `CompletionItem.range` instead.
2659 2660
		 *
		 * ~~An [edit](#TextEdit) which is applied to a document when selecting
J
Johannes Rieken 已提交
2661
		 * this completion. When an edit is provided the value of
2662
		 * [insertText](#CompletionItem.insertText) is ignored.~~
2663
		 *
2664 2665
		 * ~~The [range](#Range) of the edit must be single-line and on the same
		 * line completions were [requested](#CompletionItemProvider.provideCompletionItems) at.~~
J
Johannes Rieken 已提交
2666
		 */
2667
		textEdit?: TextEdit;
J
Johannes Rieken 已提交
2668

2669 2670 2671 2672 2673
		/**
		 * 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.
		 */
2674
		additionalTextEdits?: TextEdit[];
2675 2676

		/**
2677 2678
		 * An optional [command](#Command) that is executed *after* inserting this completion. *Note* that
		 * additional modifications to the current document should be described with the
2679 2680
		 * [additionalTextEdits](#CompletionItem.additionalTextEdits)-property.
		 */
2681
		command?: Command;
2682

J
Johannes Rieken 已提交
2683 2684 2685 2686 2687 2688 2689
		/**
		 * 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.
2690
		 * @param kind The [kind](#CompletionItemKind) of the completion.
J
Johannes Rieken 已提交
2691
		 */
2692
		constructor(label: string, kind?: CompletionItemKind);
E
Erich Gamma 已提交
2693 2694
	}

2695 2696 2697 2698
	/**
	 * Represents a collection of [completion items](#CompletionItem) to be presented
	 * in the editor.
	 */
J
Johannes Rieken 已提交
2699
	export class CompletionList {
2700 2701 2702 2703 2704

		/**
		 * This list it not complete. Further typing should result in recomputing
		 * this list.
		 */
2705
		isIncomplete?: boolean;
2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720

		/**
		 * The completion items.
		 */
		items: CompletionItem[];

		/**
		 * Creates a new completion list.
		 *
		 * @param items The completion items.
		 * @param isIncomplete The list is not complete.
		 */
		constructor(items?: CompletionItem[], isIncomplete?: boolean);
	}

J
Johannes Rieken 已提交
2721 2722
	/**
	 * The completion item provider interface defines the contract between extensions and
G
Greg Van Liew 已提交
2723
	 * [IntelliSense](https://code.visualstudio.com/docs/editor/intellisense).
J
Johannes Rieken 已提交
2724 2725 2726 2727
	 *
	 * When computing *complete* completion items is expensive, providers can optionally implement
	 * the `resolveCompletionItem`-function. In that case it is enough to return completion
	 * items with a [label](#CompletionItem.label) from the
J
Johannes Rieken 已提交
2728
	 * [provideCompletionItems](#CompletionItemProvider.provideCompletionItems)-function. Subsequently,
S
Steven Clarke 已提交
2729
	 * when a completion item is shown in the UI and gains focus this provider is asked to resolve
J
Johannes Rieken 已提交
2730
	 * the item, like adding [doc-comment](#CompletionItem.documentation) or [details](#CompletionItem.detail).
2731 2732 2733
	 *
	 * 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 已提交
2734
	 */
E
Erich Gamma 已提交
2735
	export interface CompletionItemProvider {
J
Johannes Rieken 已提交
2736 2737

		/**
J
Johannes Rieken 已提交
2738
		 * Provide completion items for the given position and document.
J
Johannes Rieken 已提交
2739
		 *
J
Johannes Rieken 已提交
2740 2741 2742
		 * @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.
2743 2744
		 * @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 已提交
2745
		 */
2746
		provideCompletionItems(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<CompletionItem[] | CompletionList>;
J
Johannes Rieken 已提交
2747 2748

		/**
J
Johannes Rieken 已提交
2749 2750 2751 2752
		 * 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 已提交
2753
		 *
J
Johannes Rieken 已提交
2754 2755
		 * @param item A completion item currently active in the UI.
		 * @param token A cancellation token.
S
Steven Clarke 已提交
2756
		 * @return The resolved completion item or a thenable that resolves to of such. It is OK to return the given
J
Johannes Rieken 已提交
2757
		 * `item`. When no result is returned, the given `item` will be used.
J
Johannes Rieken 已提交
2758
		 */
2759
		resolveCompletionItem?(item: CompletionItem, token: CancellationToken): ProviderResult<CompletionItem>;
E
Erich Gamma 已提交
2760 2761
	}

J
Johannes Rieken 已提交
2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776

	/**
	 * 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.
		 */
2777
		target?: Uri;
J
Johannes Rieken 已提交
2778 2779 2780 2781 2782 2783 2784

		/**
		 * 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.
		 */
2785
		constructor(range: Range, target?: Uri);
J
Johannes Rieken 已提交
2786 2787 2788 2789 2790 2791 2792 2793 2794
	}

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

		/**
2795 2796 2797
		 * 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 已提交
2798 2799 2800
		 * @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
2801
		 * can be signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2802
		 */
2803
		provideDocumentLinks(document: TextDocument, token: CancellationToken): ProviderResult<DocumentLink[]>;
2804 2805 2806 2807 2808 2809 2810 2811 2812 2813

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

J
Johannes Rieken 已提交
2817 2818 2819 2820
	/**
	 * A tuple of two characters, like a pair of
	 * opening and closing brackets.
	 */
E
Erich Gamma 已提交
2821 2822
	export type CharacterPair = [string, string];

J
Johannes Rieken 已提交
2823 2824 2825
	/**
	 * Describes how comments for a language work.
	 */
E
Erich Gamma 已提交
2826
	export interface CommentRule {
J
Johannes Rieken 已提交
2827 2828 2829 2830

		/**
		 * The line comment token, like `// this is a comment`
		 */
E
Erich Gamma 已提交
2831
		lineComment?: string;
J
Johannes Rieken 已提交
2832 2833 2834 2835 2836

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

A
Alex Dima 已提交
2839 2840 2841
	/**
	 * Describes indentation rules for a language.
	 */
E
Erich Gamma 已提交
2842
	export interface IndentationRule {
A
Alex Dima 已提交
2843 2844 2845
		/**
		 * If a line matches this pattern, then all the lines after it should be unindendented once (until another rule matches).
		 */
E
Erich Gamma 已提交
2846
		decreaseIndentPattern: RegExp;
A
Alex Dima 已提交
2847 2848 2849
		/**
		 * If a line matches this pattern, then all the lines after it should be indented once (until another rule matches).
		 */
E
Erich Gamma 已提交
2850
		increaseIndentPattern: RegExp;
A
Alex Dima 已提交
2851 2852 2853
		/**
		 * If a line matches this pattern, then **only the next line** after it should be indented once.
		 */
E
Erich Gamma 已提交
2854
		indentNextLinePattern?: RegExp;
A
Alex Dima 已提交
2855 2856 2857
		/**
		 * 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 已提交
2858 2859 2860
		unIndentedLinePattern?: RegExp;
	}

A
Alex Dima 已提交
2861 2862 2863
	/**
	 * Describes what to do with the indentation when pressing Enter.
	 */
E
Erich Gamma 已提交
2864
	export enum IndentAction {
A
Alex Dima 已提交
2865 2866 2867
		/**
		 * Insert new line and copy the previous line's indentation.
		 */
2868
		None = 0,
A
Alex Dima 已提交
2869 2870 2871
		/**
		 * Insert new line and indent once (relative to the previous line's indentation).
		 */
2872
		Indent = 1,
A
Alex Dima 已提交
2873 2874 2875 2876 2877
		/**
		 * Insert two new lines:
		 *  - the first one indented which will hold the cursor
		 *  - the second one at the same indentation level
		 */
2878
		IndentOutdent = 2,
A
Alex Dima 已提交
2879 2880 2881
		/**
		 * Insert new line and outdent once (relative to the previous line's indentation).
		 */
2882
		Outdent = 3
E
Erich Gamma 已提交
2883 2884
	}

A
Alex Dima 已提交
2885 2886 2887
	/**
	 * Describes what to do when pressing Enter.
	 */
E
Erich Gamma 已提交
2888
	export interface EnterAction {
A
Alex Dima 已提交
2889 2890 2891 2892 2893 2894 2895
		/**
		 * 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 已提交
2896
		appendText?: string;
A
Alex Dima 已提交
2897 2898 2899 2900
		/**
		 * Describes the number of characters to remove from the new line's indentation.
		 */
		removeText?: number;
E
Erich Gamma 已提交
2901 2902
	}

A
Alex Dima 已提交
2903 2904 2905
	/**
	 * Describes a rule to be evaluated when pressing Enter.
	 */
E
Erich Gamma 已提交
2906
	export interface OnEnterRule {
A
Alex Dima 已提交
2907 2908 2909
		/**
		 * This rule will only execute if the text before the cursor matches this regular expression.
		 */
E
Erich Gamma 已提交
2910
		beforeText: RegExp;
A
Alex Dima 已提交
2911 2912 2913
		/**
		 * This rule will only execute if the text after the cursor matches this regular expression.
		 */
E
Erich Gamma 已提交
2914
		afterText?: RegExp;
A
Alex Dima 已提交
2915 2916 2917
		/**
		 * The action to execute.
		 */
E
Erich Gamma 已提交
2918 2919 2920
		action: EnterAction;
	}

J
Johannes Rieken 已提交
2921
	/**
A
Andre Weinand 已提交
2922
	 * The language configuration interfaces defines the contract between extensions
S
Steven Clarke 已提交
2923
	 * and various editor features, like automatic bracket insertion, automatic indentation etc.
J
Johannes Rieken 已提交
2924
	 */
E
Erich Gamma 已提交
2925
	export interface LanguageConfiguration {
A
Alex Dima 已提交
2926 2927 2928
		/**
		 * The language's comment settings.
		 */
E
Erich Gamma 已提交
2929
		comments?: CommentRule;
A
Alex Dima 已提交
2930 2931 2932 2933
		/**
		 * The language's brackets.
		 * This configuration implicitly affects pressing Enter around these brackets.
		 */
E
Erich Gamma 已提交
2934
		brackets?: CharacterPair[];
A
Alex Dima 已提交
2935 2936 2937 2938 2939 2940 2941
		/**
		 * 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 已提交
2942
		wordPattern?: RegExp;
A
Alex Dima 已提交
2943 2944 2945
		/**
		 * The language's indentation settings.
		 */
E
Erich Gamma 已提交
2946
		indentationRules?: IndentationRule;
A
Alex Dima 已提交
2947 2948 2949
		/**
		 * The language's rules to be evaluated when pressing Enter.
		 */
E
Erich Gamma 已提交
2950 2951 2952
		onEnterRules?: OnEnterRule[];

		/**
A
Alex Dima 已提交
2953
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
2954 2955
		 *
		 * @deprecated Will be replaced by a better API soon.
E
Erich Gamma 已提交
2956 2957
		 */
		__electricCharacterSupport?: {
2958 2959 2960 2961 2962 2963
			/**
			 * This property is deprecated and will be **ignored** from
			 * the editor.
			 * @deprecated
			 */
			brackets?: any;
2964 2965 2966 2967 2968 2969
			/**
			 * This property is deprecated and not fully supported anymore by
			 * the editor (scope and lineStart are ignored).
			 * Use the the autoClosingPairs property in the language configuration file instead.
			 * @deprecated
			 */
E
Erich Gamma 已提交
2970
			docComment?: {
A
Alex Dima 已提交
2971 2972 2973 2974
				scope: string;
				open: string;
				lineStart: string;
				close?: string;
E
Erich Gamma 已提交
2975 2976 2977 2978
			};
		};

		/**
A
Alex Dima 已提交
2979
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
2980
		 *
2981
		 * @deprecated * Use the the autoClosingPairs property in the language configuration file instead.
E
Erich Gamma 已提交
2982 2983 2984 2985 2986 2987 2988 2989 2990 2991
		 */
		__characterPairSupport?: {
			autoClosingPairs: {
				open: string;
				close: string;
				notIn?: string[];
			}[];
		};
	}

J
Johannes Rieken 已提交
2992
	/**
S
Sandeep Somavarapu 已提交
2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013
	 * 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
3014
	 *
S
Sandeep Somavarapu 已提交
3015 3016 3017 3018
	 * - Default configuration
	 * - Global configuration
	 * - Workspace configuration (if available)
	 * - Workspace folder configuration of the requested resource (if available)
3019
	 *
S
Sandeep Somavarapu 已提交
3020
	 * *Global configuration* comes from User Settings and shadows Defaults.
S
Sandeep Somavarapu 已提交
3021
	 *
S
Sandeep Somavarapu 已提交
3022
	 * *Workspace configuration* comes from Workspace Settings and shadows Global configuration.
S
Sandeep Somavarapu 已提交
3023
	 *
S
Sandeep Somavarapu 已提交
3024
	 * *Workspace Folder configuration* comes from `.vscode` folder under one of the [workspace folders](#workspace.workspaceFolders).
S
Sandeep Somavarapu 已提交
3025 3026
	 *
	 * *Note:* Workspace and Workspace Folder configurations contains `launch` and `tasks` settings. Their basename will be
3027 3028 3029
	 * part of the section identifier. The following snippets shows how to retrieve all configurations
	 * from `launch.json`:
	 *
3030
	 * ```ts
D
Daniel Imms 已提交
3031
	 * // launch.json configuration
S
Sandeep Somavarapu 已提交
3032
	 * const config = workspace.getConfiguration('launch', vscode.window.activeTextEditor.document.uri);
3033 3034
	 *
	 * // retrieve values
D
Daniel Imms 已提交
3035 3036
	 * const values = config.get('configurations');
	 * ```
S
Sandeep Somavarapu 已提交
3037 3038
	 *
	 * Refer to [Settings](https://code.visualstudio.com/docs/getstarted/settings) for more information.
J
Johannes Rieken 已提交
3039
	 */
E
Erich Gamma 已提交
3040 3041
	export interface WorkspaceConfiguration {

3042 3043 3044 3045 3046 3047 3048 3049
		/**
		 * 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 已提交
3050
		/**
J
Johannes Rieken 已提交
3051 3052 3053
		 * Return a value from this configuration.
		 *
		 * @param section Configuration name, supports _dotted_ names.
J
Johannes Rieken 已提交
3054
		 * @param defaultValue A value should be returned when no value could be found, is `undefined`.
J
Johannes Rieken 已提交
3055
		 * @return The value `section` denotes or the default.
E
Erich Gamma 已提交
3056
		 */
3057 3058
		get<T>(section: string, defaultValue: T): T;

E
Erich Gamma 已提交
3059
		/**
J
Johannes Rieken 已提交
3060 3061
		 * Check if this configuration has a certain value.
		 *
3062
		 * @param section Configuration name, supports _dotted_ names.
G
Gama11 已提交
3063
		 * @return `true` if the section doesn't resolve to `undefined`.
E
Erich Gamma 已提交
3064 3065 3066
		 */
		has(section: string): boolean;

3067 3068
		/**
		 * Retrieve all information about a configuration setting. A configuration value
S
Sandeep Somavarapu 已提交
3069 3070 3071 3072
		 * 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))
3073
		 * is computed like this: `defaultValue` overwritten by `globalValue`,
S
Sandeep Somavarapu 已提交
3074
		 * `globalValue` overwritten by `workspaceValue`. `workspaceValue` overwritten by `workspaceFolderValue`.
S
Sandeep Somavarapu 已提交
3075
		 * Refer to [Settings Inheritence](https://code.visualstudio.com/docs/getstarted/settings)
S
Sandeep Somavarapu 已提交
3076
		 * for more information.
3077 3078 3079 3080 3081 3082 3083
		 *
		 * *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 已提交
3084
		inspect<T>(section: string): { key: string; defaultValue?: T; globalValue?: T; workspaceValue?: T, workspaceFolderValue?: T } | undefined;
S
Sandeep Somavarapu 已提交
3085 3086

		/**
S
Sandeep Somavarapu 已提交
3087
		 * Update a configuration value. The updated configuration values are persisted.
S
Sandeep Somavarapu 已提交
3088
		 *
S
Sandeep Somavarapu 已提交
3089
		 * A value can be changed in
S
Sandeep Somavarapu 已提交
3090
		 *
S
Sandeep Somavarapu 已提交
3091 3092 3093 3094
		 * - [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 已提交
3095
		 *
S
Sandeep Somavarapu 已提交
3096 3097 3098 3099 3100
		 * *Note 1:* Setting a global value in the presence of a more specific workspace value
		 * has no observable effect in that workspace, but in others. Setting a workspace value
		 * in the presence of a more specific folder value has no observable effect for the resources
		 * under respective [folder](#workspace.workspaceFolders), but in others. Refer to
		 * [Settings Inheritence](https://code.visualstudio.com/docs/getstarted/settings) for more information.
3101
		 *
3102 3103
		 * *Note 2:* To remove a configuration value use `undefined`, like so: `config.update('somekey', undefined)`
		 *
S
Sandeep Somavarapu 已提交
3104 3105 3106
		 * 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 已提交
3107
		 * - Writing a configuration to folder target when there is no folder settings
S
Sandeep Somavarapu 已提交
3108 3109 3110
		 * - Writing to folder target without passing a resource when getting the configuration (`workspace.getConfiguration(section, resource)`)
		 * - Writing a window configuration to folder target
		 *
3111 3112
		 * @param section Configuration name, supports _dotted_ names.
		 * @param value The new value.
S
Sandeep Somavarapu 已提交
3113
		 * @param configurationTarget The [configuration target](#ConfigurationTarget) or a boolean value.
S
Sandeep Somavarapu 已提交
3114 3115 3116 3117 3118
		 *	- 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.
3119
		 */
S
Sandeep Somavarapu 已提交
3120
		update(section: string, value: any, configurationTarget?: ConfigurationTarget | boolean): Thenable<void>;
3121

E
Erich Gamma 已提交
3122 3123 3124
		/**
		 * Readable dictionary that backs this configuration.
		 */
3125
		readonly [key: string]: any;
E
Erich Gamma 已提交
3126 3127
	}

J
Johannes Rieken 已提交
3128 3129 3130 3131 3132
	/**
	 * Represents a location inside a resource, such as a line
	 * inside a text file.
	 */
	export class Location {
J
Johannes Rieken 已提交
3133 3134 3135 3136

		/**
		 * The resource identifier of this location.
		 */
J
Johannes Rieken 已提交
3137
		uri: Uri;
J
Johannes Rieken 已提交
3138 3139 3140 3141

		/**
		 * The document range of this locations.
		 */
J
Johannes Rieken 已提交
3142
		range: Range;
J
Johannes Rieken 已提交
3143 3144 3145 3146 3147 3148 3149 3150

		/**
		 * 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 已提交
3151 3152
	}

E
Erich Gamma 已提交
3153 3154 3155 3156
	/**
	 * Represents the severity of diagnostics.
	 */
	export enum DiagnosticSeverity {
J
Johannes Rieken 已提交
3157 3158

		/**
S
Steven Clarke 已提交
3159
		 * Something not allowed by the rules of a language or other means.
J
Johannes Rieken 已提交
3160 3161 3162 3163 3164 3165
		 */
		Error = 0,

		/**
		 * Something suspicious but allowed.
		 */
E
Erich Gamma 已提交
3166
		Warning = 1,
J
Johannes Rieken 已提交
3167 3168 3169 3170 3171 3172 3173

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

		/**
A
Andre Weinand 已提交
3174
		 * Something to hint to a better way of doing it, like proposing
J
Johannes Rieken 已提交
3175 3176 3177
		 * a refactoring.
		 */
		Hint = 3
E
Erich Gamma 已提交
3178 3179 3180
	}

	/**
J
Johannes Rieken 已提交
3181 3182
	 * Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
	 * are only valid in the scope of a file.
E
Erich Gamma 已提交
3183
	 */
J
Johannes Rieken 已提交
3184 3185 3186 3187 3188
	export class Diagnostic {

		/**
		 * The range to which this diagnostic applies.
		 */
E
Erich Gamma 已提交
3189
		range: Range;
J
Johannes Rieken 已提交
3190 3191 3192 3193 3194 3195

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

3196 3197 3198 3199 3200 3201
		/**
		 * A human-readable string describing the source of this
		 * diagnostic, e.g. 'typescript' or 'super lint'.
		 */
		source: string;

J
Johannes Rieken 已提交
3202 3203 3204 3205 3206 3207
		/**
		 * The severity, default is [error](#DiagnosticSeverity.Error).
		 */
		severity: DiagnosticSeverity;

		/**
S
Steven Clarke 已提交
3208
		 * A code or identifier for this diagnostics. Will not be surfaced
A
Andre Weinand 已提交
3209
		 * to the user, but should be used for later processing, e.g. when
J
Johannes Rieken 已提交
3210 3211 3212 3213 3214
		 * providing [code actions](#CodeActionContext).
		 */
		code: string | number;

		/**
A
Andre Weinand 已提交
3215
		 * Creates a new diagnostic object.
J
Johannes Rieken 已提交
3216 3217 3218
		 *
		 * @param range The range to which this diagnostic applies.
		 * @param message The human-readable message.
A
Andre Weinand 已提交
3219
		 * @param severity The severity, default is [error](#DiagnosticSeverity.Error).
J
Johannes Rieken 已提交
3220 3221
		 */
		constructor(range: Range, message: string, severity?: DiagnosticSeverity);
E
Erich Gamma 已提交
3222 3223
	}

J
Johannes Rieken 已提交
3224 3225 3226
	/**
	 * A diagnostics collection is a container that manages a set of
	 * [diagnostics](#Diagnostic). Diagnostics are always scopes to a
3227
	 * diagnostics collection and a resource.
J
Johannes Rieken 已提交
3228 3229 3230 3231
	 *
	 * To get an instance of a `DiagnosticCollection` use
	 * [createDiagnosticCollection](#languages.createDiagnosticCollection).
	 */
E
Erich Gamma 已提交
3232 3233 3234
	export interface DiagnosticCollection {

		/**
J
Johannes Rieken 已提交
3235 3236 3237
		 * 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 已提交
3238
		 */
Y
Yuki Ueda 已提交
3239
		readonly name: string;
E
Erich Gamma 已提交
3240 3241 3242

		/**
		 * Assign diagnostics for given resource. Will replace
J
Johannes Rieken 已提交
3243 3244 3245 3246
		 * existing diagnostics for that resource.
		 *
		 * @param uri A resource identifier.
		 * @param diagnostics Array of diagnostics or `undefined`
E
Erich Gamma 已提交
3247
		 */
3248
		set(uri: Uri, diagnostics: Diagnostic[] | undefined): void;
E
Erich Gamma 已提交
3249 3250

		/**
3251
		 * Replace all entries in this collection.
J
Johannes Rieken 已提交
3252
		 *
3253 3254 3255 3256 3257 3258
		 * 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 已提交
3259
		 */
3260
		set(entries: [Uri, Diagnostic[] | undefined][]): void;
E
Erich Gamma 已提交
3261 3262

		/**
3263 3264
		 * Remove all diagnostics from this collection that belong
		 * to the provided `uri`. The same as `#set(uri, undefined)`.
J
Johannes Rieken 已提交
3265
		 *
3266
		 * @param uri A resource identifier.
E
Erich Gamma 已提交
3267
		 */
3268
		delete(uri: Uri): void;
E
Erich Gamma 已提交
3269 3270 3271 3272 3273 3274 3275

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

3276 3277 3278 3279 3280 3281 3282 3283
		/**
		 * Iterate over each entry in this collection.
		 *
		 * @param callback Function to execute for each entry.
		 * @param thisArg The `this` context used when invoking the handler function.
		 */
		forEach(callback: (uri: Uri, diagnostics: Diagnostic[], collection: DiagnosticCollection) => any, thisArg?: any): void;

3284 3285 3286 3287 3288 3289 3290
		/**
		 * Get the diagnostics for a given resource. *Note* that you cannot
		 * modify the diagnostics-array returned from this call.
		 *
		 * @param uri A resource identifier.
		 * @returns An immutable array of [diagnostics](#Diagnostic) or `undefined`.
		 */
3291
		get(uri: Uri): Diagnostic[] | undefined;
3292 3293 3294 3295 3296 3297 3298 3299 3300 3301

		/**
		 * 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 已提交
3302 3303 3304 3305
		/**
		 * Dispose and free associated resources. Calls
		 * [clear](#DiagnosticCollection.clear).
		 */
E
Erich Gamma 已提交
3306 3307 3308
		dispose(): void;
	}

J
Johannes Rieken 已提交
3309
	/**
J
Johannes Rieken 已提交
3310
	 * Denotes a column in the editor window. Columns are
J
Johannes Rieken 已提交
3311
	 * used to show editors side by side.
J
Johannes Rieken 已提交
3312 3313 3314 3315 3316 3317 3318
	 */
	export enum ViewColumn {
		One = 1,
		Two = 2,
		Three = 3
	}

E
Erich Gamma 已提交
3319
	/**
J
Johannes Rieken 已提交
3320 3321 3322 3323
	 * An output channel is a container for readonly textual information.
	 *
	 * To get an instance of an `OutputChannel` use
	 * [createOutputChannel](#window.createOutputChannel).
E
Erich Gamma 已提交
3324
	 */
J
Johannes Rieken 已提交
3325
	export interface OutputChannel {
E
Erich Gamma 已提交
3326

J
Johannes Rieken 已提交
3327 3328 3329
		/**
		 * The human-readable name of this output channel.
		 */
Y
Yuki Ueda 已提交
3330
		readonly name: string;
E
Erich Gamma 已提交
3331 3332

		/**
J
Johannes Rieken 已提交
3333
		 * Append the given value to the channel.
E
Erich Gamma 已提交
3334
		 *
J
Johannes Rieken 已提交
3335
		 * @param value A string, falsy values will not be printed.
E
Erich Gamma 已提交
3336
		 */
J
Johannes Rieken 已提交
3337
		append(value: string): void;
E
Erich Gamma 已提交
3338 3339

		/**
J
Johannes Rieken 已提交
3340 3341
		 * Append the given value and a line feed character
		 * to the channel.
E
Erich Gamma 已提交
3342
		 *
J
Johannes Rieken 已提交
3343
		 * @param value A string, falsy values will be printed.
E
Erich Gamma 已提交
3344 3345 3346
		 */
		appendLine(value: string): void;

J
Johannes Rieken 已提交
3347 3348 3349
		/**
		 * Removes all output from the channel.
		 */
E
Erich Gamma 已提交
3350 3351
		clear(): void;

J
Johannes Rieken 已提交
3352 3353
		/**
		 * Reveal this channel in the UI.
3354
		 *
3355
		 * @param preserveFocus When `true` the channel will not take focus.
J
Johannes Rieken 已提交
3356
		 */
J
Johannes Rieken 已提交
3357
		show(preserveFocus?: boolean): void;
E
Erich Gamma 已提交
3358

3359
		/**
3360
		 * ~~Reveal this channel in the UI.~~
3361
		 *
3362
		 * @deprecated Use the overload with just one parameter (`show(preserveFocus?: boolean): void`).
J
Johannes Rieken 已提交
3363 3364
		 *
		 * @param column This argument is **deprecated** and will be ignored.
3365 3366
		 * @param preserveFocus When `true` the channel will not take focus.
		 */
J
Johannes Rieken 已提交
3367
		show(column?: ViewColumn, preserveFocus?: boolean): void;
3368

J
Johannes Rieken 已提交
3369 3370 3371
		/**
		 * Hide this channel from the UI.
		 */
E
Erich Gamma 已提交
3372 3373
		hide(): void;

J
Johannes Rieken 已提交
3374 3375 3376
		/**
		 * Dispose and free associated resources.
		 */
E
Erich Gamma 已提交
3377 3378 3379 3380
		dispose(): void;
	}

	/**
J
Johannes Rieken 已提交
3381
	 * Represents the alignment of status bar items.
E
Erich Gamma 已提交
3382 3383
	 */
	export enum StatusBarAlignment {
J
Johannes Rieken 已提交
3384 3385 3386 3387

		/**
		 * Aligned to the left side.
		 */
3388
		Left = 1,
J
Johannes Rieken 已提交
3389 3390 3391 3392

		/**
		 * Aligned to the right side.
		 */
3393
		Right = 2
E
Erich Gamma 已提交
3394 3395 3396 3397 3398 3399 3400 3401 3402
	}

	/**
	 * 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 已提交
3403
		 * The alignment of this item.
E
Erich Gamma 已提交
3404
		 */
Y
Yuki Ueda 已提交
3405
		readonly alignment: StatusBarAlignment;
E
Erich Gamma 已提交
3406 3407

		/**
J
Johannes Rieken 已提交
3408 3409
		 * The priority of this item. Higher value means the item should
		 * be shown more to the left.
E
Erich Gamma 已提交
3410
		 */
Y
Yuki Ueda 已提交
3411
		readonly priority: number;
E
Erich Gamma 已提交
3412 3413

		/**
J
Johannes Rieken 已提交
3414 3415
		 * The text to show for the entry. You can embed icons in the text by leveraging the syntax:
		 *
3416
		 * `My text $(icon-name) contains icons like $(icon'name) this one.`
J
Johannes Rieken 已提交
3417
		 *
3418 3419
		 * Where the icon-name is taken from the [octicon](https://octicons.github.com) icon set, e.g.
		 * `light-bulb`, `thumbsup`, `zap` etc.
J
Johannes Rieken 已提交
3420
		 */
E
Erich Gamma 已提交
3421 3422 3423
		text: string;

		/**
J
Johannes Rieken 已提交
3424 3425
		 * The tooltip text when you hover over this entry.
		 */
3426
		tooltip: string | undefined;
E
Erich Gamma 已提交
3427 3428

		/**
J
Johannes Rieken 已提交
3429 3430
		 * The foreground color for this entry.
		 */
3431
		color: string | ThemeColor | undefined;
E
Erich Gamma 已提交
3432 3433

		/**
J
Johannes Rieken 已提交
3434 3435 3436
		 * The identifier of a command to run on click. The command must be
		 * [known](#commands.getCommands).
		 */
3437
		command: string | undefined;
E
Erich Gamma 已提交
3438 3439 3440 3441 3442 3443 3444

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

		/**
J
Johannes Rieken 已提交
3445
		 * Hide the entry in the status bar.
E
Erich Gamma 已提交
3446 3447 3448 3449
		 */
		hide(): void;

		/**
J
Johannes Rieken 已提交
3450 3451
		 * Dispose and free associated resources. Call
		 * [hide](#StatusBarItem.hide).
E
Erich Gamma 已提交
3452 3453 3454 3455
		 */
		dispose(): void;
	}

3456 3457 3458 3459 3460 3461 3462 3463 3464
	/**
	 * Defines a generalized way of reporting progress updates.
	 */
	export interface Progress<T> {

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

D
Daniel Imms 已提交
3468 3469 3470
	/**
	 * An individual terminal instance within the integrated terminal.
	 */
D
Daniel Imms 已提交
3471
	export interface Terminal {
D
Daniel Imms 已提交
3472

3473 3474 3475
		/**
		 * The name of the terminal.
		 */
Y
Yuki Ueda 已提交
3476
		readonly name: string;
3477

3478 3479 3480
		/**
		 * The process ID of the shell process.
		 */
Y
Yuki Ueda 已提交
3481
		readonly processId: Thenable<number>;
3482

D
Daniel Imms 已提交
3483
		/**
D
Daniel Imms 已提交
3484
		 * Send text to the terminal. The text is written to the stdin of the underlying pty process
3485
		 * (shell) of the terminal.
D
Daniel Imms 已提交
3486
		 *
D
Daniel Imms 已提交
3487
		 * @param text The text to send.
D
Daniel Imms 已提交
3488
		 * @param addNewLine Whether to add a new line to the text being sent, this is normally
3489 3490
		 * 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 已提交
3491
		 */
3492
		sendText(text: string, addNewLine?: boolean): void;
D
Daniel Imms 已提交
3493 3494

		/**
D
Daniel Imms 已提交
3495
		 * Show the terminal panel and reveal this terminal in the UI.
D
Daniel Imms 已提交
3496
		 *
D
Daniel Imms 已提交
3497
		 * @param preserveFocus When `true` the terminal will not take focus.
D
Daniel Imms 已提交
3498
		 */
D
Daniel Imms 已提交
3499
		show(preserveFocus?: boolean): void;
D
Daniel Imms 已提交
3500 3501

		/**
D
Daniel Imms 已提交
3502
		 * Hide the terminal panel if this terminal is currently showing.
D
Daniel Imms 已提交
3503 3504 3505 3506 3507 3508 3509
		 */
		hide(): void;

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

J
Johannes Rieken 已提交
3512 3513 3514
	/**
	 * Represents an extension.
	 *
A
Alex Dima 已提交
3515
	 * To get an instance of an `Extension` use [getExtension](#extensions.getExtension).
J
Johannes Rieken 已提交
3516
	 */
E
Erich Gamma 已提交
3517
	export interface Extension<T> {
J
Johannes Rieken 已提交
3518

E
Erich Gamma 已提交
3519
		/**
J
Johannes Rieken 已提交
3520
		 * The canonical extension identifier in the form of: `publisher.name`.
E
Erich Gamma 已提交
3521
		 */
Y
Yuki Ueda 已提交
3522
		readonly id: string;
E
Erich Gamma 已提交
3523 3524

		/**
J
Johannes Rieken 已提交
3525
		 * The absolute file path of the directory containing this extension.
E
Erich Gamma 已提交
3526
		 */
Y
Yuki Ueda 已提交
3527
		readonly extensionPath: string;
E
Erich Gamma 已提交
3528 3529

		/**
3530
		 * `true` if the extension has been activated.
E
Erich Gamma 已提交
3531
		 */
Y
Yuki Ueda 已提交
3532
		readonly isActive: boolean;
E
Erich Gamma 已提交
3533 3534 3535 3536

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

		/**
A
Alex Dima 已提交
3540
		 * The public API exported by this extension. It is an invalid action
J
Johannes Rieken 已提交
3541
		 * to access this field before this extension has been activated.
E
Erich Gamma 已提交
3542
		 */
Y
Yuki Ueda 已提交
3543
		readonly exports: T;
E
Erich Gamma 已提交
3544 3545 3546

		/**
		 * Activates this extension and returns its public API.
J
Johannes Rieken 已提交
3547
		 *
S
Steven Clarke 已提交
3548
		 * @return A promise that will resolve when this extension has been activated.
E
Erich Gamma 已提交
3549 3550 3551 3552
		 */
		activate(): Thenable<T>;
	}

J
Johannes Rieken 已提交
3553
	/**
S
Steven Clarke 已提交
3554 3555
	 * An extension context is a collection of utilities private to an
	 * extension.
J
Johannes Rieken 已提交
3556
	 *
S
Steven Clarke 已提交
3557
	 * An instance of an `ExtensionContext` is provided as the first
J
Johannes Rieken 已提交
3558 3559
	 * parameter to the `activate`-call of an extension.
	 */
E
Erich Gamma 已提交
3560 3561 3562 3563
	export interface ExtensionContext {

		/**
		 * An array to which disposables can be added. When this
J
Johannes Rieken 已提交
3564
		 * extension is deactivated the disposables will be disposed.
E
Erich Gamma 已提交
3565 3566 3567 3568 3569
		 */
		subscriptions: { dispose(): any }[];

		/**
		 * A memento object that stores state in the context
3570
		 * of the currently opened [workspace](#workspace.workspaceFolders).
E
Erich Gamma 已提交
3571 3572 3573 3574 3575
		 */
		workspaceState: Memento;

		/**
		 * A memento object that stores state independent
3576
		 * of the current opened [workspace](#workspace.workspaceFolders).
E
Erich Gamma 已提交
3577 3578 3579 3580
		 */
		globalState: Memento;

		/**
J
Johannes Rieken 已提交
3581
		 * The absolute file path of the directory containing the extension.
E
Erich Gamma 已提交
3582 3583 3584 3585
		 */
		extensionPath: string;

		/**
A
Alex Dima 已提交
3586 3587 3588 3589
		 * 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 已提交
3590 3591
		 */
		asAbsolutePath(relativePath: string): string;
D
Dirk Baeumer 已提交
3592 3593

		/**
J
Johannes Rieken 已提交
3594 3595 3596
		 * 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 已提交
3597
		 *
3598 3599
		 * Use [`workspaceState`](#ExtensionContext.workspaceState) or
		 * [`globalState`](#ExtensionContext.globalState) to store key value data.
D
Dirk Baeumer 已提交
3600
		 */
3601
		storagePath: string | undefined;
E
Erich Gamma 已提交
3602 3603 3604 3605 3606 3607 3608 3609
	}

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

3610 3611 3612 3613 3614 3615 3616 3617
		/**
		 * Return a value.
		 *
		 * @param key A string.
		 * @return The stored value or `undefined`.
		 */
		get<T>(key: string): T | undefined;

E
Erich Gamma 已提交
3618
		/**
J
Johannes Rieken 已提交
3619 3620 3621 3622 3623
		 * 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.
3624
		 * @return The stored value or the defaultValue.
E
Erich Gamma 已提交
3625
		 */
3626
		get<T>(key: string, defaultValue: T): T;
E
Erich Gamma 已提交
3627 3628

		/**
S
Steven Clarke 已提交
3629
		 * Store a value. The value must be JSON-stringifyable.
J
Johannes Rieken 已提交
3630 3631 3632
		 *
		 * @param key A string.
		 * @param value A value. MUST not contain cyclic references.
E
Erich Gamma 已提交
3633 3634 3635 3636
		 */
		update(key: string, value: any): Thenable<void>;
	}

3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744
	/**
	 * Controls the behaviour of the terminal's visibility.
	 */
	export enum TaskRevealKind {
		/**
		 * Always brings the terminal to front if the task is executed.
		 */
		Always = 1,

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

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

	/**
	 * Controls how the task channel is used between tasks
	 */
	export enum TaskPanelKind {

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

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

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

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

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

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

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

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

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

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

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

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

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


	/**
	 * A structure that defines a task kind in the system.
	 * The value must be JSON-stringifyable.
	 */
	export interface TaskDefinition {
		/**
3745
		 * The task definition describing the task provided by an extension.
3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782
		 * Usually a task provider defines more properties to identify
		 * a task. They need to be defined in the package.json of the
		 * extension under the 'taskDefinitions' extension point. The npm
		 * task definition for example looks like this
		 * ```typescript
		 * interface NpmTaskDefinition extends TaskDefinition {
		 *     script: string;
		 * }
		 * ```
		 */
		readonly type: string;

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

	/**
	 * Options for a process execution
	 */
	export interface ProcessExecutionOptions {
		/**
		 * The current working directory of the executed program or shell.
		 * If omitted the tools current workspace root is used.
		 */
		cwd?: string;

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

	/**
3783
	 * The execution of a task happens as an external process
3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879
	 * without shell interaction.
	 */
	export class ProcessExecution {

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

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

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

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

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

	/**
	 * Options for a shell execution
	 */
	export interface ShellExecutionOptions {
		/**
		 * The shell executable.
		 */
		executable?: string;

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

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

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


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

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

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

	/**
	 * A task to execute
	 */
	export class Task {

		/**
		 * Creates a new task.
		 *
3880
		 * @param definition The task definition as defined in the taskDefinitions extension point.
3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937
		 * @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.
		 */
		constructor(taskDefinition: TaskDefinition, name: string, source: string, execution?: ProcessExecution | ShellExecution, problemMatchers?: string | string[]);

		/**
		 * The task's definition.
		 */
		definition: TaskDefinition;

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

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

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

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

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

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

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

	/**
	 * A task provider allows to add tasks to the task service.
D
David Lechner 已提交
3938
	 * A task provider is registered via #workspace.registerTaskProvider.
3939 3940 3941 3942 3943 3944 3945 3946 3947 3948
	 */
	export interface TaskProvider {
		/**
		 * Provides tasks.
		 * @param token A cancellation token.
		 * @return an array of tasks
		 */
		provideTasks(token?: CancellationToken): ProviderResult<Task[]>;

		/**
3949 3950 3951 3952 3953
		 * Resolves a task that has no [`execution`](#Task.execution) set. Tasks are
		 * often created from information found in the `task.json`-file. Such tasks miss
		 * the information on how to execute them and a task provider must fill in
		 * the missing information in the `resolveTask`-method.
		 *
3954 3955
		 * @param task The task to resolve.
		 * @param token A cancellation token.
3956
		 * @return The resolved task
3957 3958 3959 3960
		 */
		resolveTask(task: Task, token?: CancellationToken): ProviderResult<Task>;
	}

3961 3962 3963 3964 3965
	/**
	 * Namespace describing the environment the editor runs in.
	 */
	export namespace env {

3966 3967 3968 3969 3970 3971 3972
		/**
		 * The application name of the editor, like 'VS Code'.
		 *
		 * @readonly
		 */
		export let appName: string;

J
Johannes Rieken 已提交
3973 3974 3975 3976 3977 3978 3979
		/**
		 * The application root folder from which the editor is running.
		 *
		 * @readonly
		 */
		export let appRoot: string;

J
Johannes Rieken 已提交
3980 3981 3982 3983 3984 3985 3986
		/**
		 * Represents the preferred user-language, like `de-CH`, `fr`, or `en-US`.
		 *
		 * @readonly
		 */
		export let language: string;

3987 3988
		/**
		 * A unique identifier for the computer.
J
Johannes Rieken 已提交
3989 3990
		 *
		 * @readonly
3991 3992 3993 3994 3995 3996
		 */
		export let machineId: string;

		/**
		 * A unique identifier for the current session.
		 * Changes each time the editor is started.
J
Johannes Rieken 已提交
3997 3998
		 *
		 * @readonly
3999 4000 4001 4002
		 */
		export let sessionId: string;
	}

E
Erich Gamma 已提交
4003
	/**
4004 4005 4006 4007 4008 4009 4010 4011
	 * 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 已提交
4012
	 * the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette).
4013
	 * * keybinding - Use the `keybindings`-section in `package.json` to enable
G
Greg Van Liew 已提交
4014
	 * [keybindings](https://code.visualstudio.com/docs/getstarted/keybindings#_customizing-shortcuts)
4015 4016
	 * for your extension.
	 *
S
Steven Clarke 已提交
4017
	 * Commands from other extensions and from the editor itself are accessible to an extension. However,
4018 4019 4020
	 * 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 已提交
4021
	 * register a command handler with the identifier `extension.sayHello`.
4022 4023
	 * ```javascript
	 * commands.registerCommand('extension.sayHello', () => {
4024
	 * 	window.showInformationMessage('Hello World!');
4025 4026
	 * });
	 * ```
G
Gama11 已提交
4027
	 * Second, bind the command identifier to a title under which it will show in the palette (`package.json`).
4028 4029
	 * ```json
	 * {
4030 4031 4032 4033 4034 4035
	 * 	"contributes": {
	 * 		"commands": [{
	 * 			"command": "extension.sayHello",
	 * 			"title": "Hello World"
	 * 		}]
	 * 	}
4036 4037
	 * }
	 * ```
E
Erich Gamma 已提交
4038 4039 4040 4041 4042
	 */
	export namespace commands {

		/**
		 * Registers a command that can be invoked via a keyboard shortcut,
S
Steven Clarke 已提交
4043
		 * a menu item, an action, or directly.
E
Erich Gamma 已提交
4044
		 *
J
Johannes Rieken 已提交
4045 4046 4047 4048 4049
		 * 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 已提交
4050
		 * @param thisArg The `this` context used when invoking the handler function.
J
Johannes Rieken 已提交
4051
		 * @return Disposable which unregisters this command on disposal.
E
Erich Gamma 已提交
4052 4053 4054 4055
		 */
		export function registerCommand(command: string, callback: (...args: any[]) => any, thisArg?: any): Disposable;

		/**
J
Johannes Rieken 已提交
4056
		 * Registers a text editor command that can be invoked via a keyboard shortcut,
S
Steven Clarke 已提交
4057
		 * a menu item, an action, or directly.
E
Erich Gamma 已提交
4058
		 *
J
Johannes Rieken 已提交
4059
		 * Text editor commands are different from ordinary [commands](#commands.registerCommand) as
S
Steven Clarke 已提交
4060
		 * they only execute when there is an active editor when the command is called. Also, the
J
Johannes Rieken 已提交
4061 4062 4063 4064 4065
		 * 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 已提交
4066
		 * @param thisArg The `this` context used when invoking the handler function.
J
Johannes Rieken 已提交
4067
		 * @return Disposable which unregisters this command on disposal.
E
Erich Gamma 已提交
4068
		 */
J
Johannes Rieken 已提交
4069
		export function registerTextEditorCommand(command: string, callback: (textEditor: TextEditor, edit: TextEditorEdit, ...args: any[]) => void, thisArg?: any): Disposable;
E
Erich Gamma 已提交
4070 4071

		/**
J
Johannes Rieken 已提交
4072 4073
		 * Executes the command denoted by the given command identifier.
		 *
J
Johannes Rieken 已提交
4074
		 * * *Note 1:* When executing an editor command not all types are allowed to
4075
		 * be passed as arguments. Allowed are the primitive types `string`, `boolean`,
J
Johannes Rieken 已提交
4076 4077
		 * `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 已提交
4078
		 * by extensions.
E
Erich Gamma 已提交
4079
		 *
J
Johannes Rieken 已提交
4080
		 * @param command Identifier of the command to execute.
J
Johannes Rieken 已提交
4081 4082 4083
		 * @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 已提交
4084
		 */
4085
		export function executeCommand<T>(command: string, ...rest: any[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
4086 4087

		/**
4088 4089
		 * Retrieve the list of all available commands. Commands starting an underscore are
		 * treated as internal commands.
E
Erich Gamma 已提交
4090
		 *
4091
		 * @param filterInternal Set `true` to not see internal commands (starting with an underscore)
E
Erich Gamma 已提交
4092 4093
		 * @return Thenable that resolves to a list of command ids.
		 */
4094
		export function getCommands(filterInternal?: boolean): Thenable<string[]>;
E
Erich Gamma 已提交
4095 4096
	}

J
Joao 已提交
4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107
	/**
	 * Represents the state of a window.
	 */
	export interface WindowState {

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

E
Erich Gamma 已提交
4108
	/**
4109 4110 4111
	 * 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 已提交
4112 4113 4114 4115
	 */
	export namespace window {

		/**
4116
		 * The currently active editor or `undefined`. The active editor is the one
S
Steven Clarke 已提交
4117
		 * that currently has focus or, when none has focus, the one that has changed
E
Erich Gamma 已提交
4118 4119
		 * input most recently.
		 */
4120
		export let activeTextEditor: TextEditor | undefined;
E
Erich Gamma 已提交
4121 4122

		/**
4123
		 * The currently visible editors or an empty array.
E
Erich Gamma 已提交
4124 4125 4126 4127
		 */
		export let visibleTextEditors: TextEditor[];

		/**
4128
		 * An [event](#Event) which fires when the [active editor](#window.activeTextEditor)
J
Johannes Rieken 已提交
4129
		 * has changed. *Note* that the event also fires when the active editor changes
4130
		 * to `undefined`.
E
Erich Gamma 已提交
4131 4132 4133
		 */
		export const onDidChangeActiveTextEditor: Event<TextEditor>;

4134 4135 4136 4137 4138 4139
		/**
		 * An [event](#Event) which fires when the array of [visible editors](#window.visibleTextEditors)
		 * has changed.
		 */
		export const onDidChangeVisibleTextEditors: Event<TextEditor[]>;

E
Erich Gamma 已提交
4140
		/**
A
Andre Weinand 已提交
4141
		 * An [event](#Event) which fires when the selection in an editor has changed.
E
Erich Gamma 已提交
4142 4143 4144 4145 4146 4147 4148 4149
		 */
		export const onDidChangeTextEditorSelection: Event<TextEditorSelectionChangeEvent>;

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

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

4155
		/**
4156
		 * An [event](#Event) which fires when a terminal is disposed.
4157 4158 4159
		 */
		export const onDidCloseTerminal: Event<Terminal>;

J
Joao 已提交
4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172
		/**
		 * Represents the current window's state.
		 *
		 * @readonly
		 */
		export let state: WindowState;

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

E
Erich Gamma 已提交
4173 4174 4175 4176 4177 4178 4179
		/**
		 * Show the given document in a text editor. A [column](#ViewColumn) can be provided
		 * to control where the editor is being shown. Might change the [active editor](#window.activeTextEditor).
		 *
		 * @param document A text document to be shown.
		 * @param column A view column in which the editor should be shown. The default is the [one](#ViewColumn.One), other values
		 * are adjusted to be __Min(column, columnCount + 1)__.
4180
		 * @param preserveFocus When `true` the editor will not take focus.
E
Erich Gamma 已提交
4181 4182
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
4183
		export function showTextDocument(document: TextDocument, column?: ViewColumn, preserveFocus?: boolean): Thenable<TextEditor>;
E
Erich Gamma 已提交
4184

4185
		/**
B
Benjamin Pasero 已提交
4186 4187
		 * 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).
4188 4189
		 *
		 * @param document A text document to be shown.
4190
		 * @param options [Editor options](#ShowTextDocumentOptions) to configure the behavior of showing the [editor](#TextEditor).
4191 4192
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
4193
		export function showTextDocument(document: TextDocument, options?: TextDocumentShowOptions): Thenable<TextEditor>;
4194

B
Benjamin Pasero 已提交
4195
		/**
J
Johannes Rieken 已提交
4196
		 * A short-hand for `openTextDocument(uri).then(document => showTextDocument(document, options))`.
B
Benjamin Pasero 已提交
4197
		 *
J
Johannes Rieken 已提交
4198
		 * @see [openTextDocument](#openTextDocument)
B
Benjamin Pasero 已提交
4199 4200 4201 4202 4203 4204 4205
		 *
		 * @param uri A resource identifier.
		 * @param options [Editor options](#ShowTextDocumentOptions) to configure the behavior of showing the [editor](#TextEditor).
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
		export function showTextDocument(uri: Uri, options?: TextDocumentShowOptions): Thenable<TextEditor>;

E
Erich Gamma 已提交
4206
		/**
J
Johannes Rieken 已提交
4207 4208 4209 4210
		 * 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 已提交
4211 4212 4213 4214 4215 4216 4217
		 */
		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 已提交
4218 4219
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
4220
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
4221
		 */
4222
		export function showInformationMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
4223

J
Joao Moreno 已提交
4224 4225 4226 4227 4228 4229 4230 4231 4232
		/**
		 * 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 已提交
4233
		export function showInformationMessage(message: string, options: MessageOptions, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
4234 4235

		/**
J
Johannes Rieken 已提交
4236
		 * Show an information message.
J
Johannes Rieken 已提交
4237
		 *
E
Erich Gamma 已提交
4238
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
4239 4240 4241
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
4242
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
4243
		 */
4244
		export function showInformationMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
4245

J
Joao Moreno 已提交
4246 4247 4248 4249 4250 4251 4252 4253 4254 4255
		/**
		 * 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 已提交
4256
		export function showInformationMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
4257 4258

		/**
J
Johannes Rieken 已提交
4259
		 * Show a warning message.
J
Johannes Rieken 已提交
4260
		 *
E
Erich Gamma 已提交
4261
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
4262 4263 4264
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
4265
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
4266
		 */
4267
		export function showWarningMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
4268

J
Joao Moreno 已提交
4269 4270 4271 4272 4273 4274 4275 4276 4277 4278
		/**
		 * 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 已提交
4279
		export function showWarningMessage(message: string, options: MessageOptions, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
4280 4281

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

J
Joao Moreno 已提交
4292 4293 4294 4295 4296 4297 4298 4299 4300 4301
		/**
		 * 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 已提交
4302
		export function showWarningMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
4303 4304

		/**
J
Johannes Rieken 已提交
4305
		 * Show an error message.
J
Johannes Rieken 已提交
4306
		 *
E
Erich Gamma 已提交
4307
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
4308 4309 4310
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
4311
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
4312
		 */
4313
		export function showErrorMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
4314

J
Joao Moreno 已提交
4315 4316 4317 4318 4319 4320 4321 4322 4323 4324
		/**
		 * 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 已提交
4325
		export function showErrorMessage(message: string, options: MessageOptions, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
4326 4327

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

J
Joao Moreno 已提交
4338 4339 4340 4341 4342 4343 4344 4345 4346 4347
		/**
		 * 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 已提交
4348
		export function showErrorMessage<T extends MessageItem>(message: string, options: MessageOptions, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
4349 4350 4351 4352

		/**
		 * Shows a selection list.
		 *
J
Johannes Rieken 已提交
4353 4354
		 * @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.
4355
		 * @param token A token that can be used to signal cancellation.
4356
		 * @return A promise that resolves to the selection or `undefined`.
E
Erich Gamma 已提交
4357
		 */
4358
		export function showQuickPick(items: string[] | Thenable<string[]>, options?: QuickPickOptions, token?: CancellationToken): Thenable<string | undefined>;
E
Erich Gamma 已提交
4359 4360 4361 4362

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

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

		/**
J
Johannes Rieken 已提交
4384 4385
		 * Create a new [output channel](#OutputChannel) with the given name.
		 *
4386
		 * @param name Human-readable string which will be used to represent the channel in the UI.
E
Erich Gamma 已提交
4387
		 */
4388
		export function createOutputChannel(name: string): OutputChannel;
E
Erich Gamma 已提交
4389 4390

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

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

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

4422
		/**
J
Johannes Rieken 已提交
4423 4424
		 * ~~Show progress in the Source Control viewlet while running the given callback and while
		 * its returned promise isn't resolve or rejected.~~
4425
		 *
4426 4427
		 * @deprecated Use `withProgress` instead.
		 *
4428 4429
		 * @param task A callback returning a promise. Progress increments can be reported with
		 * the provided [progress](#Progress)-object.
J
Johannes Rieken 已提交
4430
		 * @return The thenable the task did rseturn.
4431 4432 4433
		 */
		export function withScmProgress<R>(task: (progress: Progress<number>) => Thenable<R>): Thenable<R>;

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

E
Erich Gamma 已提交
4445
		/**
J
Johannes Rieken 已提交
4446 4447
		 * Creates a status bar [item](#StatusBarItem).
		 *
J
Johannes Rieken 已提交
4448
		 * @param alignment The alignment of the item.
J
Johannes Rieken 已提交
4449
		 * @param priority The priority of the item. Higher values mean the item should be shown more to the left.
J
Johannes Rieken 已提交
4450 4451
		 * @return A new status bar item.
		 */
E
Erich Gamma 已提交
4452
		export function createStatusBarItem(alignment?: StatusBarAlignment, priority?: number): StatusBarItem;
D
Daniel Imms 已提交
4453

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

		/**
		 * Creates a [Terminal](#Terminal). The cwd of the terminal will be the workspace directory
		 * if it exists, regardless of whether an explicit customStartPath setting exists.
		 *
		 * @param options A TerminalOptions object describing the characteristics of the new terminal.
		 * @return A new Terminal.
		 */
		export function createTerminal(options: TerminalOptions): Terminal;
S
Sandeep Somavarapu 已提交
4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572

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

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

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

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

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

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

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

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

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

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

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

	/**
J
Johannes Rieken 已提交
4576
	 * Value-object describing what options a terminal should use.
4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592
	 */
	export interface TerminalOptions {
		/**
		 * A human-readable string which will be used to represent the terminal in the UI.
		 */
		name?: string;

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

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

J
Johannes Rieken 已提交
4595 4596 4597 4598 4599 4600 4601
	/**
	 * 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 {

		/**
4602
		 * Show progress for the source control viewlet, as overlay for the icon and as progress bar
J
Johannes Rieken 已提交
4603 4604
		 * inside the viewlet (when visible).
		 */
4605
		SourceControl = 1,
J
Johannes Rieken 已提交
4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629

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

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

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

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

E
Erich Gamma 已提交
4630
	/**
A
Alex Dima 已提交
4631
	 * An event describing an individual change in the text of a [document](#TextDocument).
E
Erich Gamma 已提交
4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648
	 */
	export interface TextDocumentContentChangeEvent {
		/**
		 * The range that got replaced.
		 */
		range: Range;
		/**
		 * The length of the range that got replaced.
		 */
		rangeLength: number;
		/**
		 * The new text for the range.
		 */
		text: string;
	}

	/**
A
Alex Dima 已提交
4649
	 * An event describing a transactional [document](#TextDocument) change.
E
Erich Gamma 已提交
4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663
	 */
	export interface TextDocumentChangeEvent {

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

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

4664 4665 4666 4667 4668 4669
	/**
	 * Represents reasons why a text document is saved.
	 */
	export enum TextDocumentSaveReason {

		/**
4670 4671
		 * Manually triggered, e.g. by the user pressing save, by starting debugging,
		 * or by an API call.
4672
		 */
4673
		Manual = 1,
4674 4675 4676 4677

		/**
		 * Automatic after a delay.
		 */
4678
		AfterDelay = 2,
4679 4680 4681 4682 4683 4684 4685

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

4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697
	/**
	 * 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.
		 */
4698
		document: TextDocument;
4699

4700 4701 4702 4703 4704
		/**
		 * The reason why save was triggered.
		 */
		reason: TextDocumentSaveReason;

4705 4706 4707 4708 4709 4710 4711 4712 4713 4714
		/**
		 * 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 => {
4715 4716 4717 4718 4719
		 * 	// async, will *throw* an error
		 * 	setTimeout(() => event.waitUntil(promise));
		 *
		 * 	// sync, OK
		 * 	event.waitUntil(promise);
4720 4721 4722 4723 4724
		 * })
		 * ```
		 *
		 * @param thenable A thenable that resolves to [pre-save-edits](#TextEdit).
		 */
4725
		waitUntil(thenable: Thenable<TextEdit[]>): void;
4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736

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

4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753
	/**
	 * An event describing a change to the set of [workspace folders](#workspace.workspaceFolders).
	 */
	export interface WorkspaceFoldersChangeEvent {
		/**
		 * Added workspace folders.
		 */
		readonly added: WorkspaceFolder[];

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

	/**
	 * A workspace folder is one of potentially many roots opened by the editor. All workspace folders
4754
	 * are equal which means there is no notion of an active or master workspace folder.
4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774
	 */
	export interface WorkspaceFolder {

		/**
		 * The associated URI for this workspace folder.
		 */
		readonly uri: Uri;

		/**
		 * The name of this workspace folder. Defaults to
		 * the basename its [uri-path](#Uri.path)
		 */
		readonly name: string;

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

E
Erich Gamma 已提交
4775
	/**
4776 4777 4778 4779 4780
	 * 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
4781
	 * events and for [finding](#workspace.findFiles) files. Both perform well and run _outside_
S
Steven Clarke 已提交
4782
	 * the editor-process so that they should be always used instead of nodejs-equivalents.
E
Erich Gamma 已提交
4783 4784 4785 4786
	 */
	export namespace workspace {

		/**
4787 4788
		 * ~~The folder that is open in the editor. `undefined` when no folder
		 * has been opened.~~
J
Johannes Rieken 已提交
4789
		 *
4790
		 * @deprecated Use [`workspaceFolders`](#workspace.workspaceFolders) instead.
4791 4792
		 *
		 * @readonly
E
Erich Gamma 已提交
4793
		 */
4794
		export let rootPath: string | undefined;
E
Erich Gamma 已提交
4795 4796

		/**
J
Johannes Rieken 已提交
4797 4798
		 * List of workspace folders or `undefined` when no folder is open.
		 * *Note* that the first entry corresponds to the value of `rootPath`.
Y
Yuki Ueda 已提交
4799 4800
		 *
		 * @readonly
E
Erich Gamma 已提交
4801
		 */
4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816
		export let workspaceFolders: WorkspaceFolder[] | undefined;

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

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

		/**
4819
		 * Returns a path that is relative to the workspace folder or folders.
J
Johannes Rieken 已提交
4820
		 *
4821
		 * When there are no [workspace folders](#workspace.workspaceFolders) or when the path
J
Johannes Rieken 已提交
4822
		 * is not contained in them, the input is returned.
J
Johannes Rieken 已提交
4823 4824
		 *
		 * @param pathOrUri A path or uri. When a uri is given its [fsPath](#Uri.fsPath) is used.
J
Johannes Rieken 已提交
4825 4826 4827
		 * @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 已提交
4828
		 * @return A path relative to the root or the input.
E
Erich Gamma 已提交
4829
		 */
J
Johannes Rieken 已提交
4830
		export function asRelativePath(pathOrUri: string | Uri, includeWorkspaceFolder?: boolean): string;
E
Erich Gamma 已提交
4831

4832 4833 4834 4835 4836 4837
		/**
		 * Creates a file system watcher.
		 *
		 * A glob pattern that filters the file events must be provided. Optionally, flags to ignore certain
		 * kinds of events can be provided. To stop listening to events the watcher must be disposed.
		 *
4838
		 * *Note* that only files within the current [workspace folders](#workspace.workspaceFolders) can be watched.
4839 4840 4841 4842 4843 4844 4845 4846 4847
		 *
		 * @param globPattern A glob pattern that is applied to the names of created, changed, and deleted files.
		 * @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.
		 */
		export function createFileSystemWatcher(globPattern: string, ignoreCreateEvents?: boolean, ignoreChangeEvents?: boolean, ignoreDeleteEvents?: boolean): FileSystemWatcher;

J
Johannes Rieken 已提交
4848 4849 4850
		/**
		 * Find files in the workspace.
		 *
4851
		 * @sample `findFiles('**∕*.js', '**∕node_modules∕**', 10)`
J
Johannes Rieken 已提交
4852
		 * @param include A glob pattern that defines the files to search for.
S
Steven Clarke 已提交
4853
		 * @param exclude A glob pattern that defines files and folders to exclude.
J
Johannes Rieken 已提交
4854
		 * @param maxResults An upper-bound for the result.
4855
		 * @param token A token that can be used to signal cancellation to the underlying search engine.
J
Johannes Rieken 已提交
4856 4857
		 * @return A thenable that resolves to an array of resource identifiers.
		 */
4858
		export function findFiles(include: string, exclude?: string, maxResults?: number, token?: CancellationToken): Thenable<Uri[]>;
E
Erich Gamma 已提交
4859 4860

		/**
J
Johannes Rieken 已提交
4861 4862 4863
		 * Save all dirty files.
		 *
		 * @param includeUntitled Also save files that have been created during this session.
S
Steven Clarke 已提交
4864
		 * @return A thenable that resolves when the files have been saved.
E
Erich Gamma 已提交
4865 4866 4867 4868
		 */
		export function saveAll(includeUntitled?: boolean): Thenable<boolean>;

		/**
J
Johannes Rieken 已提交
4869 4870 4871
		 * Make changes to one or many resources as defined by the given
		 * [workspace edit](#WorkspaceEdit).
		 *
S
Steven Clarke 已提交
4872 4873 4874
		 * When applying a workspace edit, the editor implements an 'all-or-nothing'-strategy,
		 * that means failure to load one document or make changes to one document will cause
		 * the edit to be rejected.
J
Johannes Rieken 已提交
4875 4876 4877
		 *
		 * @param edit A workspace edit.
		 * @return A thenable that resolves when the edit could be applied.
E
Erich Gamma 已提交
4878 4879 4880 4881 4882
		 */
		export function applyEdit(edit: WorkspaceEdit): Thenable<boolean>;

		/**
		 * All text documents currently known to the system.
J
Johannes Rieken 已提交
4883 4884
		 *
		 * @readonly
E
Erich Gamma 已提交
4885 4886 4887 4888
		 */
		export let textDocuments: TextDocument[];

		/**
4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900
		 * Opens a document. Will return early if this document is already open. Otherwise
		 * the document is loaded and the [didOpen](#workspace.onDidOpenTextDocument)-event fires.
		 *
		 * The document is denoted by an [uri](#Uri). Depending on the [scheme](#Uri.scheme) the
		 * following rules apply:
		 * * `file`-scheme: Open a file on disk, will be rejected if the file does not exist or cannot be loaded.
		 * * `untitled`-scheme: A new file that should be saved on disk, e.g. `untitled:c:\frodo\new.js`. The language
		 * will be derived from the file name.
		 * * For all other schemes the registered text document content [providers](#TextDocumentContentProvider) are consulted.
		 *
		 * *Note* that the lifecycle of the returned document is owned by the editor and not by the extension. That means an
		 * [`onDidClose`](#workspace.onDidCloseTextDocument)-event can occur at any time after opening it.
E
Erich Gamma 已提交
4901 4902 4903 4904 4905 4906 4907
		 *
		 * @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 已提交
4908 4909 4910
		 * A short-hand for `openTextDocument(Uri.file(fileName))`.
		 *
		 * @see [openTextDocument](#openTextDocument)
A
Andre Weinand 已提交
4911 4912
		 * @param fileName A name of a file on disk.
		 * @return A promise that resolves to a [document](#TextDocument).
E
Erich Gamma 已提交
4913 4914 4915
		 */
		export function openTextDocument(fileName: string): Thenable<TextDocument>;

B
Benjamin Pasero 已提交
4916
		/**
J
Johannes Rieken 已提交
4917 4918
		 * 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
4919
		 * specify the *language* and/or the *content* of the document.
B
Benjamin Pasero 已提交
4920
		 *
J
Johannes Rieken 已提交
4921
		 * @param options Options to control how the document will be created.
B
Benjamin Pasero 已提交
4922 4923
		 * @return A promise that resolves to a [document](#TextDocument).
		 */
4924
		export function openTextDocument(options?: { language?: string; content?: string; }): Thenable<TextDocument>;
B
Benjamin Pasero 已提交
4925

J
Johannes Rieken 已提交
4926
		/**
4927 4928 4929
		 * Register a text document content provider.
		 *
		 * Only one provider can be registered per scheme.
J
Johannes Rieken 已提交
4930
		 *
4931 4932 4933
		 * @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 已提交
4934 4935 4936
		 */
		export function registerTextDocumentContentProvider(scheme: string, provider: TextDocumentContentProvider): Disposable;

A
Alex Dima 已提交
4937
		/**
J
Johannes Rieken 已提交
4938
		 * An event that is emitted when a [text document](#TextDocument) is opened.
A
Alex Dima 已提交
4939
		 */
E
Erich Gamma 已提交
4940 4941
		export const onDidOpenTextDocument: Event<TextDocument>;

A
Alex Dima 已提交
4942 4943 4944
		/**
		 * An event that is emitted when a [text document](#TextDocument) is disposed.
		 */
E
Erich Gamma 已提交
4945 4946
		export const onDidCloseTextDocument: Event<TextDocument>;

A
Alex Dima 已提交
4947
		/**
4948 4949 4950
		 * 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
		 * [dirty](TextDocument#isDirty)-state changes.
A
Alex Dima 已提交
4951
		 */
E
Erich Gamma 已提交
4952 4953
		export const onDidChangeTextDocument: Event<TextDocumentChangeEvent>;

4954 4955
		/**
		 * An event that is emitted when a [text document](#TextDocument) will be saved to disk.
4956
		 *
J
Johannes Rieken 已提交
4957
		 * *Note 1:* Subscribers can delay saving by registering asynchronous work. For the sake of data integrity the editor
4958 4959 4960 4961 4962 4963 4964 4965
		 * 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.
4966 4967 4968
		 */
		export const onWillSaveTextDocument: Event<TextDocumentWillSaveEvent>;

A
Alex Dima 已提交
4969 4970 4971
		/**
		 * An event that is emitted when a [text document](#TextDocument) is saved to disk.
		 */
E
Erich Gamma 已提交
4972 4973 4974
		export const onDidSaveTextDocument: Event<TextDocument>;

		/**
S
Sandeep Somavarapu 已提交
4975
		 * Get a workspace configuration object.
J
Johannes Rieken 已提交
4976 4977
		 *
		 * When a section-identifier is provided only that part of the configuration
A
Andre Weinand 已提交
4978
		 * is returned. Dots in the section-identifier are interpreted as child-access,
J
Johannes Rieken 已提交
4979
		 * like `{ myExt: { setting: { doIt: true }}}` and `getConfiguration('myExt.setting').get('doIt') === true`.
J
Johannes Rieken 已提交
4980
		 *
S
Sandeep Somavarapu 已提交
4981
		 * When a resource is provided, configuration scoped to that resource is returned.
S
Sandeep Somavarapu 已提交
4982 4983
		 *
		 * @param section A dot-separated identifier.
S
Sandeep Somavarapu 已提交
4984
		 * @param resource A resource for which the configuration is asked for
S
Sandeep Somavarapu 已提交
4985 4986
		 * @return The full configuration or a subset.
		 */
S
Sandeep Somavarapu 已提交
4987
		export function getConfiguration(section?: string, resource?: Uri): WorkspaceConfiguration;
E
Erich Gamma 已提交
4988

J
Johannes Rieken 已提交
4989 4990 4991
		/**
		 * An event that is emitted when the [configuration](#WorkspaceConfiguration) changed.
		 */
E
Erich Gamma 已提交
4992
		export const onDidChangeConfiguration: Event<void>;
4993 4994 4995 4996 4997 4998 4999 5000 5001

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

J
Johannes Rieken 已提交
5004
	/**
5005 5006 5007 5008 5009 5010 5011
	 * 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 已提交
5012
	 * The editor provides an API that makes it simple to provide such common features by having all UI and actions already in place and
5013 5014 5015 5016 5017 5018
	 * 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', {
5019 5020 5021
	 * 	provideHover(document, position, token) {
	 * 		return new Hover('I am a hover!');
	 * 	}
5022 5023
	 * });
	 * ```
5024 5025 5026
	 *
	 * 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 已提交
5027
	 * a selector will result in a [score](#languages.match) that is used to determine if and how a provider shall be used. When
5028 5029 5030
	 * 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 已提交
5031
	 */
E
Erich Gamma 已提交
5032 5033 5034 5035 5036 5037 5038 5039 5040
	export namespace languages {

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

		/**
J
Johannes Rieken 已提交
5041
		 * Compute the match between a document [selector](#DocumentSelector) and a document. Values
5042 5043 5044
		 * greater than zero mean the selector matches the document.
		 *
		 * A match is computed according to these rules:
5045 5046
		 * 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" }`.
5047 5048
		 * 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`
5049 5050 5051
		 *  2. When `scheme`, `language`, or `pattern` are defined but one doesn’t match, the result is `0`
		 *  3. Matching against `*` gives a score of `5`, matching via equality or via a glob-pattern gives a score of `10`
		 *  4. The result is the maximun value of each match
5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067
		 *
		 * 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'
5068
		 * match('javascript', doc); // 10;
5069 5070
		 * match({language: 'javascript', scheme: 'git'}, doc); // 10;
		 * match('*', doc); // 5
5071
		 * ```
J
Johannes Rieken 已提交
5072 5073 5074
		 *
		 * @param selector A document selector.
		 * @param document A text document.
J
Johannes Rieken 已提交
5075
		 * @return A number `>0` when the selector matches and `0` when the selector does not match.
E
Erich Gamma 已提交
5076 5077 5078 5079
		 */
		export function match(selector: DocumentSelector, document: TextDocument): number;

		/**
S
Steven Clarke 已提交
5080
		 * Create a diagnostics collection.
J
Johannes Rieken 已提交
5081 5082 5083
		 *
		 * @param name The [name](#DiagnosticCollection.name) of the collection.
		 * @return A new diagnostic collection.
E
Erich Gamma 已提交
5084 5085 5086 5087
		 */
		export function createDiagnosticCollection(name?: string): DiagnosticCollection;

		/**
J
Johannes Rieken 已提交
5088 5089 5090
		 * Register a completion provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
5091
		 * by their [score](#languages.match) and groups of equal score are sequentially asked for
J
Johannes Rieken 已提交
5092
		 * completion items. The process stops when one or many providers of a group return a
5093 5094
		 * result. A failing provider (rejected promise or exception) will not fail the whole
		 * operation.
E
Erich Gamma 已提交
5095
		 *
J
Johannes Rieken 已提交
5096 5097 5098 5099 5100 5101 5102 5103
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A completion provider.
		 * @param triggerCharacters Trigger completion when the user types one of the characters, like `.` or `:`.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerCompletionItemProvider(selector: DocumentSelector, provider: CompletionItemProvider, ...triggerCharacters: string[]): Disposable;

		/**
J
Johannes Rieken 已提交
5104 5105 5106
		 * Register a code action provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
5107 5108
		 * 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 已提交
5109 5110
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
J
Johannes Rieken 已提交
5111
		 * @param provider A code action provider.
J
Johannes Rieken 已提交
5112
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
5113
		 */
J
Johannes Rieken 已提交
5114
		export function registerCodeActionsProvider(selector: DocumentSelector, provider: CodeActionProvider): Disposable;
E
Erich Gamma 已提交
5115 5116

		/**
J
Johannes Rieken 已提交
5117 5118 5119
		 * Register a code lens provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
5120 5121
		 * 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 已提交
5122
		 *
J
Johannes Rieken 已提交
5123 5124 5125
		 * @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 已提交
5126
		 */
J
Johannes Rieken 已提交
5127
		export function registerCodeLensProvider(selector: DocumentSelector, provider: CodeLensProvider): Disposable;
E
Erich Gamma 已提交
5128 5129

		/**
J
Johannes Rieken 已提交
5130 5131 5132
		 * Register a definition provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
5133 5134
		 * 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 已提交
5135
		 *
J
Johannes Rieken 已提交
5136 5137 5138
		 * @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 已提交
5139 5140 5141
		 */
		export function registerDefinitionProvider(selector: DocumentSelector, provider: DefinitionProvider): Disposable;

5142
		/**
5143
		 * Register an implementation provider.
5144
		 *
5145 5146 5147
		 * 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.
5148 5149 5150 5151 5152
		 *
		 * @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 已提交
5153
		export function registerImplementationProvider(selector: DocumentSelector, provider: ImplementationProvider): Disposable;
5154

5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167
		/**
		 * Register a type definition provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
		 * parallel and the results are merged. A failing provider (rejected promise or exception) will
		 * not cause a failure of the whole operation.
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A type definition provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerTypeDefinitionProvider(selector: DocumentSelector, provider: TypeDefinitionProvider): Disposable;

E
Erich Gamma 已提交
5168
		/**
J
Johannes Rieken 已提交
5169 5170 5171
		 * Register a hover provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
5172 5173
		 * 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 已提交
5174
		 *
J
Johannes Rieken 已提交
5175 5176 5177
		 * @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 已提交
5178 5179 5180 5181
		 */
		export function registerHoverProvider(selector: DocumentSelector, provider: HoverProvider): Disposable;

		/**
J
Johannes Rieken 已提交
5182 5183 5184 5185
		 * 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.
5186
		 * The process stops when a provider returns a `non-falsy` or `non-failure` result.
E
Erich Gamma 已提交
5187
		 *
J
Johannes Rieken 已提交
5188 5189 5190
		 * @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 已提交
5191 5192 5193 5194
		 */
		export function registerDocumentHighlightProvider(selector: DocumentSelector, provider: DocumentHighlightProvider): Disposable;

		/**
J
Johannes Rieken 已提交
5195 5196 5197
		 * Register a document symbol provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
5198 5199
		 * 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 已提交
5200
		 *
J
Johannes Rieken 已提交
5201 5202 5203
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A document symbol provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
5204 5205 5206 5207
		 */
		export function registerDocumentSymbolProvider(selector: DocumentSelector, provider: DocumentSymbolProvider): Disposable;

		/**
J
Johannes Rieken 已提交
5208 5209
		 * Register a workspace symbol provider.
		 *
5210 5211 5212
		 * 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 已提交
5213
		 *
J
Johannes Rieken 已提交
5214 5215
		 * @param provider A workspace symbol provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
5216 5217 5218 5219
		 */
		export function registerWorkspaceSymbolProvider(provider: WorkspaceSymbolProvider): Disposable;

		/**
J
Johannes Rieken 已提交
5220 5221 5222
		 * Register a reference provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
5223 5224
		 * 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 已提交
5225
		 *
J
Johannes Rieken 已提交
5226 5227 5228
		 * @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 已提交
5229 5230 5231 5232
		 */
		export function registerReferenceProvider(selector: DocumentSelector, provider: ReferenceProvider): Disposable;

		/**
J
Johannes Rieken 已提交
5233 5234 5235
		 * Register a reference provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
5236
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
5237
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
5238
		 *
J
Johannes Rieken 已提交
5239 5240 5241
		 * @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 已提交
5242 5243 5244 5245
		 */
		export function registerRenameProvider(selector: DocumentSelector, provider: RenameProvider): Disposable;

		/**
A
Andre Weinand 已提交
5246
		 * Register a formatting provider for a document.
J
Johannes Rieken 已提交
5247 5248
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
5249
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
5250
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
5251
		 *
J
Johannes Rieken 已提交
5252 5253 5254
		 * @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 已提交
5255 5256 5257 5258
		 */
		export function registerDocumentFormattingEditProvider(selector: DocumentSelector, provider: DocumentFormattingEditProvider): Disposable;

		/**
J
Johannes Rieken 已提交
5259 5260
		 * Register a formatting provider for a document range.
		 *
5261 5262 5263 5264
		 * *Note:* A document range provider is also a [document formatter](#DocumentFormattingEditProvider)
		 * which means there is no need to [register](registerDocumentFormattingEditProvider) a document
		 * formatter when also registering a range provider.
		 *
J
Johannes Rieken 已提交
5265
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
5266
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
5267
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
5268
		 *
J
Johannes Rieken 已提交
5269 5270 5271
		 * @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 已提交
5272 5273 5274 5275
		 */
		export function registerDocumentRangeFormattingEditProvider(selector: DocumentSelector, provider: DocumentRangeFormattingEditProvider): Disposable;

		/**
E
Erich Gamma 已提交
5276
		 * Register a formatting provider that works on type. The provider is active when the user enables the setting `editor.formatOnType`.
J
Johannes Rieken 已提交
5277 5278
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
5279
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
5280
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
5281
		 *
J
Johannes Rieken 已提交
5282 5283 5284
		 * @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 已提交
5285
		 * @param moreTriggerCharacter More trigger characters.
J
Johannes Rieken 已提交
5286
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
5287 5288 5289 5290
		 */
		export function registerOnTypeFormattingEditProvider(selector: DocumentSelector, provider: OnTypeFormattingEditProvider, firstTriggerCharacter: string, ...moreTriggerCharacter: string[]): Disposable;

		/**
J
Johannes Rieken 已提交
5291 5292 5293
		 * Register a signature help provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
5294 5295
		 * by their [score](#languages.match) and called sequentially until a provider returns a
		 * valid result.
E
Erich Gamma 已提交
5296
		 *
J
Johannes Rieken 已提交
5297 5298 5299 5300
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A signature help provider.
		 * @param triggerCharacters Trigger signature help when the user types one of the characters, like `,` or `(`.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
5301 5302 5303
		 */
		export function registerSignatureHelpProvider(selector: DocumentSelector, provider: SignatureHelpProvider, ...triggerCharacters: string[]): Disposable;

J
Johannes Rieken 已提交
5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316
		/**
		 * Register a document link provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
		 * parallel and the results are merged. A failing provider (rejected promise or exception) will
		 * not cause a failure of the whole operation.
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A document link provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerDocumentLinkProvider(selector: DocumentSelector, provider: DocumentLinkProvider): Disposable;

E
Erich Gamma 已提交
5317
		/**
J
Johannes Rieken 已提交
5318
		 * Set a [language configuration](#LanguageConfiguration) for a language.
E
Erich Gamma 已提交
5319
		 *
A
Andre Weinand 已提交
5320
		 * @param language A language identifier like `typescript`.
J
Johannes Rieken 已提交
5321 5322
		 * @param configuration Language configuration.
		 * @return A [disposable](#Disposable) that unsets this configuration.
E
Erich Gamma 已提交
5323 5324 5325 5326
		 */
		export function setLanguageConfiguration(language: string, configuration: LanguageConfiguration): Disposable;
	}

J
Joao Moreno 已提交
5327
	/**
J
Joao Moreno 已提交
5328
	 * Represents the input box in the Source Control viewlet.
J
Joao Moreno 已提交
5329
	 */
J
Joao Moreno 已提交
5330
	export interface SourceControlInputBox {
J
Joao Moreno 已提交
5331 5332

		/**
J
Joao Moreno 已提交
5333
		 * Setter and getter for the contents of the input box.
J
Joao Moreno 已提交
5334
		 */
J
Joao Moreno 已提交
5335
		value: string;
J
Joao Moreno 已提交
5336 5337
	}

J
Joao Moreno 已提交
5338
	interface QuickDiffProvider {
J
Joao Moreno 已提交
5339 5340

		/**
J
Joao Moreno 已提交
5341 5342 5343 5344 5345
		 * 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 已提交
5346
		 */
J
Joao Moreno 已提交
5347 5348
		provideOriginalResource?(uri: Uri, token: CancellationToken): ProviderResult<Uri>;
	}
J
Joao Moreno 已提交
5349

J
Joao Moreno 已提交
5350 5351 5352 5353 5354
	/**
	 * The theme-aware decorations for a
	 * [source control resource state](#SourceControlResourceState).
	 */
	export interface SourceControlResourceThemableDecorations {
J
Joao Moreno 已提交
5355 5356

		/**
J
Joao Moreno 已提交
5357 5358
		 * The icon path for a specific
		 * [source control resource state](#SourceControlResourceState).
J
Joao Moreno 已提交
5359
		 */
J
Joao Moreno 已提交
5360
		readonly iconPath?: string | Uri;
J
Joao Moreno 已提交
5361 5362 5363
	}

	/**
J
Joao Moreno 已提交
5364 5365
	 * The decorations for a [source control resource state](#SourceControlResourceState).
	 * Can be independently specified for light and dark themes.
J
Joao Moreno 已提交
5366
	 */
J
Joao Moreno 已提交
5367
	export interface SourceControlResourceDecorations extends SourceControlResourceThemableDecorations {
J
Joao Moreno 已提交
5368 5369

		/**
J
Joao Moreno 已提交
5370 5371
		 * Whether the [source control resource state](#SourceControlResourceState) should
		 * be striked-through in the UI.
J
Joao Moreno 已提交
5372
		 */
J
Joao Moreno 已提交
5373
		readonly strikeThrough?: boolean;
J
Joao Moreno 已提交
5374

5375 5376
		/**
		 * Whether the [source control resource state](#SourceControlResourceState) should
I
Ilie Halip 已提交
5377
		 * be faded in the UI.
5378 5379 5380
		 */
		readonly faded?: boolean;

5381 5382 5383 5384 5385 5386
		/**
		 * The title for a specific
		 * [source control resource state](#SourceControlResourceState).
		 */
		readonly tooltip?: string;

J
Joao Moreno 已提交
5387
		/**
J
Joao Moreno 已提交
5388
		 * The light theme decorations.
J
Joao Moreno 已提交
5389
		 */
J
Joao Moreno 已提交
5390
		readonly light?: SourceControlResourceThemableDecorations;
J
Joao Moreno 已提交
5391 5392

		/**
J
Joao Moreno 已提交
5393
		 * The dark theme decorations.
J
Joao Moreno 已提交
5394
		 */
J
Joao Moreno 已提交
5395
		readonly dark?: SourceControlResourceThemableDecorations;
J
Joao Moreno 已提交
5396 5397 5398
	}

	/**
J
Joao Moreno 已提交
5399 5400
	 * An source control resource state represents the state of an underlying workspace
	 * resource within a certain [source control group](#SourceControlResourceGroup).
J
Joao Moreno 已提交
5401
	 */
J
Joao Moreno 已提交
5402
	export interface SourceControlResourceState {
J
Joao Moreno 已提交
5403 5404

		/**
J
Joao Moreno 已提交
5405
		 * The [uri](#Uri) of the underlying resource inside the workspace.
J
Joao Moreno 已提交
5406
		 */
J
Joao Moreno 已提交
5407
		readonly resourceUri: Uri;
J
Joao Moreno 已提交
5408 5409

		/**
J
Joao Moreno 已提交
5410 5411
		 * The [command](#Command) which should be run when the resource
		 * state is open in the Source Control viewlet.
J
Joao Moreno 已提交
5412
		 */
5413
		readonly command?: Command;
J
Joao Moreno 已提交
5414 5415

		/**
J
Joao Moreno 已提交
5416 5417
		 * The [decorations](#SourceControlResourceDecorations) for this source control
		 * resource state.
J
Joao Moreno 已提交
5418
		 */
J
Joao Moreno 已提交
5419
		readonly decorations?: SourceControlResourceDecorations;
J
Joao Moreno 已提交
5420 5421 5422
	}

	/**
J
Joao Moreno 已提交
5423 5424
	 * A source control resource group is a collection of
	 * [source control resource states](#SourceControlResourceState).
J
Joao Moreno 已提交
5425
	 */
J
Joao Moreno 已提交
5426 5427 5428 5429 5430 5431
	export interface SourceControlResourceGroup {

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

		/**
J
Joao Moreno 已提交
5434
		 * The label of this source control resource group.
J
Joao Moreno 已提交
5435
		 */
5436
		label: string;
J
Joao Moreno 已提交
5437 5438

		/**
J
Joao Moreno 已提交
5439 5440
		 * Whether this source control resource group is hidden when it contains
		 * no [source control resource states](#SourceControlResourceState).
J
Joao Moreno 已提交
5441
		 */
J
Joao Moreno 已提交
5442
		hideWhenEmpty?: boolean;
J
Joao Moreno 已提交
5443 5444

		/**
J
Joao Moreno 已提交
5445 5446
		 * This group's collection of
		 * [source control resource states](#SourceControlResourceState).
J
Joao Moreno 已提交
5447
		 */
J
Joao Moreno 已提交
5448
		resourceStates: SourceControlResourceState[];
J
Joao Moreno 已提交
5449 5450

		/**
J
Joao Moreno 已提交
5451
		 * Dispose this source control resource group.
J
Joao Moreno 已提交
5452
		 */
J
Joao Moreno 已提交
5453 5454 5455 5456 5457 5458 5459 5460
		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 已提交
5461 5462

		/**
J
Joao Moreno 已提交
5463
		 * The id of this source control.
J
Joao Moreno 已提交
5464
		 */
J
Joao Moreno 已提交
5465
		readonly id: string;
J
Joao Moreno 已提交
5466 5467

		/**
J
Joao Moreno 已提交
5468
		 * The human-readable label of this source control.
J
Joao Moreno 已提交
5469
		 */
J
Joao Moreno 已提交
5470
		readonly label: string;
J
Joao Moreno 已提交
5471

J
Joao Moreno 已提交
5472 5473 5474 5475 5476
		/**
		 * The [input box](#SourceControlInputBox) for this source control.
		 */
		readonly inputBox: SourceControlInputBox;

J
Joao Moreno 已提交
5477
		/**
J
Joao Moreno 已提交
5478 5479
		 * The UI-visible count of [resource states](#SourceControlResourceState) of
		 * this source control.
J
Joao Moreno 已提交
5480
		 *
J
Joao Moreno 已提交
5481 5482
		 * Equals to the total number of [resource state](#SourceControlResourceState)
		 * of this source control, if undefined.
J
Joao Moreno 已提交
5483
		 */
J
Joao Moreno 已提交
5484
		count?: number;
J
Joao Moreno 已提交
5485 5486

		/**
J
Joao Moreno 已提交
5487
		 * An optional [quick diff provider](#QuickDiffProvider).
J
Joao Moreno 已提交
5488
		 */
J
Joao Moreno 已提交
5489
		quickDiffProvider?: QuickDiffProvider;
J
Joao Moreno 已提交
5490

J
Joao Moreno 已提交
5491
		/**
5492 5493 5494 5495
		 * Optional commit template string.
		 *
		 * The Source Control viewlet will populate the Source Control
		 * input with this value when appropriate.
J
Joao Moreno 已提交
5496
		 */
5497
		commitTemplate?: string;
J
Joao Moreno 已提交
5498 5499

		/**
5500 5501 5502 5503
		 * Optional accept input command.
		 *
		 * This command will be invoked when the user accepts the value
		 * in the Source Control input.
J
Joao Moreno 已提交
5504
		 */
5505
		acceptInputCommand?: Command;
J
Joao Moreno 已提交
5506 5507

		/**
5508 5509 5510
		 * Optional status bar commands.
		 *
		 * These commands will be displayed in the editor's status bar.
J
Joao Moreno 已提交
5511
		 */
5512
		statusBarCommands?: Command[];
J
Joao Moreno 已提交
5513 5514

		/**
5515
		 * Create a new [resource group](#SourceControlResourceGroup).
J
Joao Moreno 已提交
5516
		 */
5517
		createResourceGroup(id: string, label: string): SourceControlResourceGroup;
J
Joao Moreno 已提交
5518 5519

		/**
5520
		 * Dispose this source control.
J
Joao Moreno 已提交
5521
		 */
5522 5523 5524 5525
		dispose(): void;
	}

	export namespace scm {
J
Joao Moreno 已提交
5526 5527

		/**
J
Joao 已提交
5528 5529
		 * ~~The [input box](#SourceControlInputBox) for the last source control
		 * created by the extension.~~
J
Joao Moreno 已提交
5530 5531
		 *
		 * @deprecated Use [SourceControl.inputBox](#SourceControl.inputBox) instead
J
Joao Moreno 已提交
5532
		 */
5533
		export const inputBox: SourceControlInputBox;
J
Joao Moreno 已提交
5534 5535

		/**
J
Joao Moreno 已提交
5536
		 * Creates a new [source control](#SourceControl) instance.
J
Joao Moreno 已提交
5537
		 *
5538
		 * @param id An `id` for the source control. Something short, eg: `git`.
J
Joao Moreno 已提交
5539 5540
		 * @param label A human-readable string for the source control. Eg: `Git`.
		 * @return An instance of [source control](#SourceControl).
J
Joao Moreno 已提交
5541
		 */
J
Joao Moreno 已提交
5542
		export function createSourceControl(id: string, label: string): SourceControl;
J
Joao Moreno 已提交
5543 5544
	}

5545 5546 5547 5548 5549
	/**
	 * Configuration for a debug session.
	 */
	export interface DebugConfiguration {
		/**
5550
		 * The type of the debug session.
5551 5552 5553 5554
		 */
		type: string;

		/**
5555
		 * The name of the debug session.
5556
		 */
5557
		name: string;
5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574

		/**
		 * 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 已提交
5575 5576 5577 5578 5579
		/**
		 * The unique ID of this debug session.
		 */
		readonly id: string;

5580
		/**
A
Andre Weinand 已提交
5581
		 * The debug session's type from the [debug configuration](#DebugConfiguration).
A
Andre Weinand 已提交
5582
		 */
5583 5584 5585
		readonly type: string;

		/**
A
Andre Weinand 已提交
5586
		 * The debug session's name from the [debug configuration](#DebugConfiguration).
5587 5588 5589 5590 5591 5592 5593 5594 5595 5596
		 */
		readonly name: string;

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

	/**
A
Andre Weinand 已提交
5597
	 * A custom Debug Adapter Protocol event received from a [debug session](#DebugSession).
5598
	 */
A
Andre Weinand 已提交
5599 5600 5601 5602 5603
	export interface DebugSessionCustomEvent {
		/**
		 * The [debug session](#DebugSession) for which the custom event was received.
		 */
		session: DebugSession;
5604 5605

		/**
A
Andre Weinand 已提交
5606
		 * Type of event.
5607
		 */
A
Andre Weinand 已提交
5608 5609 5610 5611 5612 5613 5614 5615
		event: string;

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

A
Andre Weinand 已提交
5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644
	/**
	 * A debug configuration provider allows to add the initial debug configurations to a newly created launch.json
	 * and allows to resolve a launch configuration before it is used to start a new debug session.
	 * A debug configuration provider is registered via #workspace.registerDebugConfigurationProvider.
	 */
	export interface DebugConfigurationProvider {
		/**
		 * Provides initial [debug configuration](#DebugConfiguration). If more than one debug configuration provider is
		 * registered for the same type, debug configurations are concatenated in arbitrary order.
		 *
		 * @param folder The workspace folder for which the configurations are used or undefined for a folderless setup.
		 * @param token A cancellation token.
		 * @return An array of [debug configurations](#DebugConfiguration).
		 */
		provideDebugConfigurations?(folder: WorkspaceFolder | undefined, token?: CancellationToken): ProviderResult<DebugConfiguration[]>;

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

A
Andre Weinand 已提交
5645 5646 5647 5648
	/**
	 * Namespace for dealing with debug sessions.
	 */
	export namespace debug {
5649 5650

		/**
5651
		 * Start debugging by using either a named launch or named compound configuration,
A
Andre Weinand 已提交
5652
		 * or by directly passing a [DebugConfiguration](#DebugConfiguration).
5653 5654
		 * 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.
A
Andre Weinand 已提交
5655 5656 5657
		 * Folder specific variables used in the configuration (e.g. '${workspaceRoot}') 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.
5658 5659 5660
		 * @return A thenable that resolves when debugging could be successfully started.
		 */
		export function startDebugging(folder: WorkspaceFolder | undefined, nameOrConfiguration: string | DebugConfiguration): Thenable<boolean>;
A
Andre Weinand 已提交
5661 5662

		/**
A
Andre Weinand 已提交
5663
		 * The currently active [debug session](#DebugSession) or `undefined`. The active debug session is the one
A
Andre Weinand 已提交
5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675
		 * represented by the debug action floating window or the one currently shown in the drop down menu of the debug action floating window.
		 * If no debug session is active, the value is `undefined`.
		 */
		export let activeDebugSession: DebugSession | undefined;

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

5676
		/**
A
Andre Weinand 已提交
5677
		 * An [event](#Event) which fires when a new [debug session](#DebugSession) has been started.
5678 5679 5680
		 */
		export const onDidStartDebugSession: Event<DebugSession>;

A
Andre Weinand 已提交
5681
		/**
A
Andre Weinand 已提交
5682
		 * An [event](#Event) which fires when a custom DAP event is received from the [debug session](#DebugSession).
A
Andre Weinand 已提交
5683 5684 5685 5686
		 */
		export const onDidReceiveDebugSessionCustomEvent: Event<DebugSessionCustomEvent>;

		/**
A
Andre Weinand 已提交
5687
		 * An [event](#Event) which fires when a [debug session](#DebugSession) has terminated.
A
Andre Weinand 已提交
5688 5689
		 */
		export const onDidTerminateDebugSession: Event<DebugSession>;
A
Andre Weinand 已提交
5690 5691 5692 5693 5694 5695 5696 5697 5698 5699

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

J
Johannes Rieken 已提交
5702
	/**
5703 5704 5705
	 * Namespace for dealing with installed extensions. Extensions are represented
	 * by an [extension](#Extension)-interface which allows to reflect on them.
	 *
S
Steven Clarke 已提交
5706
	 * Extension writers can provide APIs to other extensions by returning their API public
5707 5708 5709 5710
	 * surface from the `activate`-call.
	 *
	 * ```javascript
	 * export function activate(context: vscode.ExtensionContext) {
5711 5712 5713 5714 5715 5716 5717 5718 5719 5720
	 * 	let api = {
	 * 		sum(a, b) {
	 * 			return a + b;
	 * 		},
	 * 		mul(a, b) {
	 * 			return a * b;
	 * 		}
	 * 	};
	 * 	// 'export' public api-surface
	 * 	return api;
5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732
	 * }
	 * ```
	 * 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 已提交
5733
	 */
E
Erich Gamma 已提交
5734 5735
	export namespace extensions {

J
Johannes Rieken 已提交
5736
		/**
5737
		 * Get an extension by its full identifier in the form of: `publisher.name`.
J
Johannes Rieken 已提交
5738
		 *
J
Johannes Rieken 已提交
5739
		 * @param extensionId An extension identifier.
J
Johannes Rieken 已提交
5740 5741
		 * @return An extension or `undefined`.
		 */
5742
		export function getExtension(extensionId: string): Extension<any> | undefined;
E
Erich Gamma 已提交
5743

J
Johannes Rieken 已提交
5744
		/**
A
Andre Weinand 已提交
5745
		 * Get an extension its full identifier in the form of: `publisher.name`.
J
Johannes Rieken 已提交
5746 5747 5748
		 *
		 * @param extensionId An extension identifier.
		 * @return An extension or `undefined`.
J
Johannes Rieken 已提交
5749
		 */
5750
		export function getExtension<T>(extensionId: string): Extension<T> | undefined;
E
Erich Gamma 已提交
5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762

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

/**
 * Thenable is a common denominator between ES6 promises, Q, jquery.Deferred, WinJS.Promise,
 * and others. This API makes no assumption about what promise libary is being used which
 * enables reusing existing code without migrating to a specific promise implementation. Still,
J
Johannes Rieken 已提交
5763
 * we recommend the use of native promises which are available in this editor.
E
Erich Gamma 已提交
5764
 */
5765
interface Thenable<T> {
E
Erich Gamma 已提交
5766 5767 5768 5769 5770 5771
	/**
	* 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.
	*/
5772 5773
	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 已提交
5774
}