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

declare namespace vscode {

	/**
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 31
		 */
		command: string;

		/**
A
Andre Weinand 已提交
32
		 * Arguments that the command handler should be
A
Alex Dima 已提交
33
		 * invoked with.
E
Erich Gamma 已提交
34 35 36 37 38
		 */
		arguments?: any[];
	}

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

		/**
A
Alex Dima 已提交
47
		 * The zero-based line number.
E
Erich Gamma 已提交
48 49 50 51 52 53
		 *
		 * @readonly
		 */
		lineNumber: number;

		/**
J
Johannes Rieken 已提交
54
		 * The text of this line without the line separator characters.
E
Erich Gamma 已提交
55 56 57 58 59 60
		 *
		 * @readonly
		 */
		text: string;

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

		/**
J
Johannes Rieken 已提交
68
		 * The range this line covers with the line separator characters.
E
Erich Gamma 已提交
69 70 71 72 73 74
		 *
		 * @readonly
		 */
		rangeIncludingLineBreak: Range;

		/**
J
Johannes Rieken 已提交
75
		 * The offset of the first character which is not a whitespace character as defined
76
		 * by `/\s/`. **Note** that if a line is all whitespaces the length of the line is returned.
E
Erich Gamma 已提交
77 78 79 80 81 82 83
		 *
		 * @readonly
		 */
		firstNonWhitespaceCharacterIndex: number;

		/**
		 * Whether this line is whitespace only, shorthand
84
		 * for [TextLine.firstNonWhitespaceCharacterIndex](#TextLine.firstNonWhitespaceCharacterIndex) === [TextLine.text.length](#TextLine.text).
E
Erich Gamma 已提交
85 86 87 88 89 90 91 92 93 94 95 96 97
		 *
		 * @readonly
		 */
		isEmptyOrWhitespace: boolean;
	}

	/**
	 * 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 已提交
98 99 100
		 * 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 已提交
101 102 103 104 105 106
		 *
		 * @readonly
		 */
		uri: Uri;

		/**
J
Johannes Rieken 已提交
107
		 * The file system path of the associated resource. Shorthand
108
		 * notation for [TextDocument.uri.fsPath](#TextDocument.uri). Independent of the uri scheme.
E
Erich Gamma 已提交
109 110 111 112 113 114 115 116 117 118 119 120 121
		 *
		 * @readonly
		 */
		fileName: string;

		/**
		 * Is this document representing an untitled file.
		 *
		 * @readonly
		 */
		isUntitled: boolean;

		/**
J
Johannes Rieken 已提交
122
		 * The identifier of the language associated with this document.
E
Erich Gamma 已提交
123 124 125 126 127 128 129 130 131 132 133 134 135 136
		 *
		 * @readonly
		 */
		languageId: string;

		/**
		 * The version number of this document (it will strictly increase after each
		 * change, including undo/redo).
		 *
		 * @readonly
		 */
		version: number;

		/**
A
Andre Weinand 已提交
137
		 * true if there are unpersisted changes.
E
Erich Gamma 已提交
138 139 140 141 142 143 144 145 146
		 *
		 * @readonly
		 */
		isDirty: boolean;

		/**
		 * Save the underlying file.
		 *
		 * @return A promise that will resolve to true when the file
147 148
		 * has been saved. If the file was not dirty or the save failed,
		 * will return false.
E
Erich Gamma 已提交
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
		 */
		save(): Thenable<boolean>;

		/**
		 * The number of lines in this document.
		 *
		 * @readonly
		 */
		lineCount: number;

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

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

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

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

		/**
J
Johannes Rieken 已提交
210 211 212 213
		 * Get a word-range at the given position. By default words are defined by
		 * common separators, like space, -, _, etc. In addition, per languge custom
		 * [word definitions](#LanguageConfiguration.wordPattern) can be defined.
		 *
A
Alex Dima 已提交
214 215
		 * The position will be [adjusted](#TextDocument.validatePosition).
		 *
J
Johannes Rieken 已提交
216 217
		 * @param position A position.
		 * @return A range spanning a word, or `undefined`.
E
Erich Gamma 已提交
218 219 220 221
		 */
		getWordRangeAtPosition(position: Position): Range;

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

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

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

		/**
		 * The zero-based character value.
		 * @readonly
		 */
		character: number;

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

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

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

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

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

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

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

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

		/**
		 * 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 已提交
357 358 359 360
	}

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

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

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

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

		/**
		 * `true` iff `start` and `end` are equal.
		 */
		isEmpty: boolean;

		/**
A
Alex Dima 已提交
407
		 * `true` iff `start.line` and `end.line` are equal.
E
Erich Gamma 已提交
408 409 410 411
		 */
		isSingleLine: boolean;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

559 560 561 562 563 564 565 566 567 568 569 570 571 572
	/**
	 * 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 已提交
573 574 575 576 577 578 579 580 581 582 583
	/**
	 * Rendering style of the cursor.
	 */
	export enum TextEditorCursorStyle {
		/**
		 * Render the cursor as a vertical line.
		 */
		Line = 1,
		/**
		 * Render the cursor as a block.
		 */
A
Alex Dima 已提交
584 585 586 587 588
		Block = 2,
		/**
		 * Render the cursor as a horizontal line under the character.
		 */
		Underline = 3
A
Alex Dima 已提交
589 590
	}

E
Erich Gamma 已提交
591
	/**
A
Alex Dima 已提交
592
	 * Represents a [text editor](#TextEditor)'s [options](#TextEditor.options).
E
Erich Gamma 已提交
593 594 595 596
	 */
	export interface TextEditorOptions {

		/**
A
Alex Dima 已提交
597 598 599
		 * 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 已提交
600
		 *
601 602
		 * 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 已提交
603
		 */
604
		tabSize?: number | string;
E
Erich Gamma 已提交
605 606 607

		/**
		 * When pressing Tab insert [n](#TextEditorOptions.tabSize) spaces.
608 609
		 * 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 已提交
610
		 */
611
		insertSpaces?: boolean | string;
A
Alex Dima 已提交
612 613 614 615 616 617 618

		/**
		 * 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;
E
Erich Gamma 已提交
619 620
	}

J
Johannes Rieken 已提交
621
	/**
A
Alex Dima 已提交
622 623
	 * Represents a handle to a set of decorations
	 * sharing the same [styling options](#DecorationRenderOptions) in a [text editor](#TextEditor).
J
Johannes Rieken 已提交
624 625 626 627
	 *
	 * To get an instance of a `TextEditorDecorationType` use
	 * [createTextEditorDecorationType](#window.createTextEditorDecorationType).
	 */
E
Erich Gamma 已提交
628 629 630
	export interface TextEditorDecorationType {

		/**
A
Alex Dima 已提交
631
		 * Internal representation of the handle.
E
Erich Gamma 已提交
632 633 634 635
		 * @readonly
		 */
		key: string;

A
Alex Dima 已提交
636 637 638
		/**
		 * Remove this decoration type and all decorations on all text editors using it.
		 */
E
Erich Gamma 已提交
639 640 641
		dispose(): void;
	}

A
Alex Dima 已提交
642 643 644
	/**
	 * Represents different [reveal](#TextEditor.revealRange) strategies in a text editor.
	 */
E
Erich Gamma 已提交
645
	export enum TextEditorRevealType {
A
Alex Dima 已提交
646 647 648 649 650 651 652
		/**
		 * The range will be revealed with as little scrolling as possible.
		 */
		Default,
		/**
		 * The range will always be revealed in the center of the viewport.
		 */
E
Erich Gamma 已提交
653
		InCenter,
A
Alex Dima 已提交
654 655 656 657
		/**
		 * 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.
		 */
E
Erich Gamma 已提交
658 659 660
		InCenterIfOutsideViewport
	}

A
Alex Dima 已提交
661
	/**
S
Sofian Hnaide 已提交
662
	 * Represents different positions for rendering a decoration in an [overview ruler](#DecorationRenderOptions.overviewRulerLane).
A
Alex Dima 已提交
663 664
	 * The overview ruler supports three lanes.
	 */
E
Erich Gamma 已提交
665 666 667 668 669 670 671
	export enum OverviewRulerLane {
		Left = 1,
		Center = 2,
		Right = 4,
		Full = 7
	}

A
Alex Dima 已提交
672 673 674
	/**
	 * Represents theme specific rendering styles for a [text editor decoration](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
675 676 677 678 679 680 681 682 683
	export interface ThemableDecorationRenderOptions {
		/**
		 * Background color of the decoration. Use rgba() and define transparent background colors to play well with other decorations.
		 */
		backgroundColor?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
684 685 686 687 688 689
		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.
		 */
E
Erich Gamma 已提交
690 691 692 693
		outlineColor?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
694
		 * Better use 'outline' for setting one or more of the individual outline properties.
E
Erich Gamma 已提交
695 696 697 698 699
		 */
		outlineStyle?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
700
		 * Better use 'outline' for setting one or more of the individual outline properties.
E
Erich Gamma 已提交
701 702 703 704 705 706
		 */
		outlineWidth?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
707 708 709 710 711 712
		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.
		 */
E
Erich Gamma 已提交
713 714 715 716
		borderColor?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
717
		 * Better use 'border' for setting one or more of the individual border properties.
E
Erich Gamma 已提交
718 719 720 721 722
		 */
		borderRadius?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
723
		 * Better use 'border' for setting one or more of the individual border properties.
E
Erich Gamma 已提交
724 725 726 727 728
		 */
		borderSpacing?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
729
		 * Better use 'border' for setting one or more of the individual border properties.
E
Erich Gamma 已提交
730 731 732 733 734
		 */
		borderStyle?: string;

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
735
		 * Better use 'border' for setting one or more of the individual border properties.
E
Erich Gamma 已提交
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
		 */
		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.
		 */
		color?: string;

754 755 756 757 758
		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		letterSpacing?: string;

E
Erich Gamma 已提交
759
		/**
A
Alex Dima 已提交
760
		 * An **absolute path** to an image to be rendered in the gutterIconPath.
E
Erich Gamma 已提交
761 762 763
		 */
		gutterIconPath?: string;

764 765 766 767 768 769 770
		/**
		 * 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 已提交
771 772 773 774
		/**
		 * The color of the decoration in the overview ruler. Use rgba() and define transparent colors to play well with other decorations.
		 */
		overviewRulerColor?: string;
M
Martin Aeschlimann 已提交
775 776 777 778 779 780 781 782 783 784 785 786 787

		/**
		 * 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 {
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
		/**
		 * Defines a text content that is shown in the attachment. Either an icon or a text can be shown, but not both.
		 */
		contentText?: string;
		/**
		 * An **absolute path** to an image to be rendered in the attachment. Either an icon or a text can be shown, but not both.
		 */
		contentIconPath?: string;
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
		border?: string;
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
M
Martin Aeschlimann 已提交
803
		textDecoration?: string;
804 805 806
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
M
Martin Aeschlimann 已提交
807
		color?: string;
808 809 810
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
M
Martin Aeschlimann 已提交
811
		backgroundColor?: string;
812 813 814
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
M
Martin Aeschlimann 已提交
815
		margin?: string;
816 817 818
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
M
Martin Aeschlimann 已提交
819
		width?: string;
820 821 822
		/**
		 * CSS styling property that will be applied to the decoration attachment.
		 */
M
Martin Aeschlimann 已提交
823
		height?: string;
E
Erich Gamma 已提交
824 825
	}

A
Alex Dima 已提交
826 827 828
	/**
	 * Represents rendering styles for a [text editor decoration](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
	export interface DecorationRenderOptions extends ThemableDecorationRenderOptions {
		/**
		 * Should the decoration be rendered also on the whitespace after the line text.
		 * Defaults to `false`.
		 */
		isWholeLine?: boolean;

		/**
		 * 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 已提交
852 853 854
	/**
	 * Represents options for a specific decoration in a [decoration set](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
855 856 857
	export interface DecorationOptions {

		/**
858
		 * Range to which this decoration is applied. The range must not be empty.
E
Erich Gamma 已提交
859 860 861 862 863 864
		 */
		range: Range;

		/**
		 * A message that should be rendered when hovering over the decoration.
		 */
865
		hoverMessage?: MarkedString | MarkedString[];
M
Martin Aeschlimann 已提交
866 867 868 869 870 871 872 873 874 875 876 877

		/**
		 * 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
		 */
878
		before?: ThemableDecorationAttachmentRenderOptions;
M
Martin Aeschlimann 已提交
879 880 881 882

		/**
		 * Defines the rendering options of the attachment that is inserted after the decorated text
		 */
883
		after?: ThemableDecorationAttachmentRenderOptions;
M
Martin Aeschlimann 已提交
884 885 886 887 888 889 890 891 892 893 894 895
	}

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

		/**
		 * Overwrite options for dark themes.
		 */
		dark?: ThemableDecorationInstanceRenderOptions
E
Erich Gamma 已提交
896 897
	}

A
Alex Dima 已提交
898 899 900
	/**
	 * Represents an editor that is attached to a [document](#TextDocument).
	 */
E
Erich Gamma 已提交
901 902 903 904 905 906 907 908
	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 已提交
909
		 * The primary selection on this text editor. Shorthand for `TextEditor.selections[0]`.
E
Erich Gamma 已提交
910 911 912 913
		 */
		selection: Selection;

		/**
J
Johannes Rieken 已提交
914
		 * The selections in this text editor. The primary selection is always at index 0.
E
Erich Gamma 已提交
915 916 917 918 919 920 921 922
		 */
		selections: Selection[];

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

923 924 925 926 927 928
		/**
		 * 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.
		 */
		viewColumn: ViewColumn;

E
Erich Gamma 已提交
929 930
		/**
		 * Perform an edit on the document associated with this text editor.
J
Johannes Rieken 已提交
931 932
		 *
		 * The given callback-function is invoked with an [edit-builder](#TextEditorEdit) which must
A
Andre Weinand 已提交
933
		 * be used to make edits. Note that the edit-builder is only valid while the
J
Johannes Rieken 已提交
934 935
		 * callback executes.
		 *
936 937
		 * @param callback A function which can create edits using an [edit-builder](#TextEditorEdit).
		 * @param options The undo/redo behaviour around this edit. By default, undo stops will be created before and after this edit.
A
Alex Dima 已提交
938
		 * @return A promise that resolves with a value indicating if the edits could be applied.
E
Erich Gamma 已提交
939
		 */
940
		edit(callback: (editBuilder: TextEditorEdit) => void, options?:{ undoStopBefore: boolean; undoStopAfter: boolean; }): Thenable<boolean>;
E
Erich Gamma 已提交
941 942

		/**
J
Johannes Rieken 已提交
943 944 945
		 * 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 已提交
946
		 * @see [createTextEditorDecorationType](#window.createTextEditorDecorationType).
A
Alex Dima 已提交
947
		 *
J
Johannes Rieken 已提交
948 949
		 * @param decorationType A decoration type.
		 * @param rangesOrOptions Either [ranges](#Range) or more detailed [options](#DecorationOptions).
E
Erich Gamma 已提交
950
		 */
J
Johannes Rieken 已提交
951
		setDecorations(decorationType: TextEditorDecorationType, rangesOrOptions: Range[] | DecorationOptions[]): void;
E
Erich Gamma 已提交
952 953

		/**
A
Alex Dima 已提交
954 955 956 957
		 * 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 已提交
958 959 960 961
		 */
		revealRange(range: Range, revealType?: TextEditorRevealType): void;

		/**
J
Johannes Rieken 已提交
962 963 964
		 * Show the text editor.
		 *
		 * @deprecated **This method is deprecated.** Use [window.showTextDocument](#window.showTextDocument)
S
Steven Clarke 已提交
965
		 * instead. This method shows unexpected behavior and will be removed in the next major update.
E
Erich Gamma 已提交
966
		 *
J
Johannes Rieken 已提交
967
		 * @param column The [column](#ViewColumn) in which to show this editor.
E
Erich Gamma 已提交
968 969 970 971 972
		 */
		show(column?: ViewColumn): void;

		/**
		 * Hide the text editor.
J
Johannes Rieken 已提交
973 974
		 *
		 * @deprecated **This method is deprecated.** Use the command 'workbench.action.closeActiveEditor' instead.
S
Steven Clarke 已提交
975
		 * This method shows unexpected behavior and will be removed in the next major update.
E
Erich Gamma 已提交
976 977 978 979
		 */
		hide(): void;
	}

980
	/**
981
	 * Represents an end of line character sequence in a [document](#TextDocument).
982 983 984 985 986 987 988 989 990 991 992 993
	 */
	export enum EndOfLine {
		/**
		 * The line feed `\n` character.
		 */
		LF = 1,
		/**
		 * The carriage return line feed `\r\n` sequence.
		 */
		CRLF = 2
	}

E
Erich Gamma 已提交
994
	/**
A
Alex Dima 已提交
995 996
	 * 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.)
997
	 * they can be applied on a [document](#TextDocument) associated with a [text editor](#TextEditor).
E
Erich Gamma 已提交
998 999 1000 1001
	 *
	 */
	export interface TextEditorEdit {
		/**
A
Alex Dima 已提交
1002
		 * Replace a certain text region with a new value.
1003
		 * You can use \r\n or \n in `value` and they will be normalized to the current [document](#TextDocument).
A
Alex Dima 已提交
1004 1005 1006
		 *
		 * @param location The range this operation should remove.
		 * @param value The new text this operation should insert after removing `location`.
E
Erich Gamma 已提交
1007 1008 1009 1010
		 */
		replace(location: Position | Range | Selection, value: string): void;

		/**
A
Alex Dima 已提交
1011
		 * Insert text at a location.
1012
		 * You can use \r\n or \n in `value` and they will be normalized to the current [document](#TextDocument).
A
Alex Dima 已提交
1013 1014 1015 1016
		 * 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 已提交
1017 1018 1019 1020 1021
		 */
		insert(location: Position, value: string): void;

		/**
		 * Delete a certain text region.
A
Alex Dima 已提交
1022 1023
		 *
		 * @param location The range this operation should remove.
E
Erich Gamma 已提交
1024 1025
		 */
		delete(location: Range | Selection): void;
1026 1027 1028 1029

		/**
		 * Set the end of line sequence.
		 *
1030
		 * @param endOfLine The new end of line for the [document](#TextDocument).
1031
		 */
A
Format  
Alex Dima 已提交
1032
		setEndOfLine(endOfLine: EndOfLine): void;
E
Erich Gamma 已提交
1033 1034 1035
	}

	/**
S
Steven Clarke 已提交
1036
	 * A universal resource identifier representing either a file on disk
J
Johannes Rieken 已提交
1037
	 * or another resource, like untitled resources.
E
Erich Gamma 已提交
1038 1039 1040 1041
	 */
	export class Uri {

		/**
J
Johannes Rieken 已提交
1042 1043 1044 1045 1046
		 * 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 已提交
1047 1048 1049 1050
		 */
		static file(path: string): Uri;

		/**
J
Johannes Rieken 已提交
1051 1052
		 * Create an URI from a string. Will throw if the given value is not
		 * valid.
E
Erich Gamma 已提交
1053
		 *
J
Johannes Rieken 已提交
1054
		 * @param value The string value of an Uri.
J
Johannes Rieken 已提交
1055
		 * @return A new Uri instance.
E
Erich Gamma 已提交
1056 1057 1058 1059
		 */
		static parse(value: string): Uri;

		/**
J
Johannes Rieken 已提交
1060
		 * Scheme is the `http` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1061 1062 1063 1064 1065
		 * The part before the first colon.
		 */
		scheme: string;

		/**
J
Johannes Rieken 已提交
1066
		 * Authority is the `www.msft.com` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1067 1068 1069 1070 1071
		 * The part between the first double slashes and the next slash.
		 */
		authority: string;

		/**
J
Johannes Rieken 已提交
1072
		 * Path is the `/some/path` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1073 1074 1075 1076
		 */
		path: string;

		/**
J
Johannes Rieken 已提交
1077
		 * Query is the `query` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1078 1079 1080 1081
		 */
		query: string;

		/**
J
Johannes Rieken 已提交
1082
		 * Fragment is the `fragment` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1083 1084 1085 1086
		 */
		fragment: string;

		/**
1087
		 * The string representing the corresponding file system path of this Uri.
J
Johannes Rieken 已提交
1088
		 *
E
Erich Gamma 已提交
1089 1090
		 * 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
1091
		 * invalid characters and semantics. Will *not* look at the scheme of this Uri.
E
Erich Gamma 已提交
1092 1093 1094
		 */
		fsPath: string;

1095 1096 1097
		/**
		 * Derive a new Uri from this Uri.
		 *
1098 1099
		 * @param change An object that describes a change to this Uri. To unset components use `null` or
		 *  the empty string.
1100
		 * @return A new Uri that reflects the given change. Will return `this` Uri if the change
1101 1102 1103 1104 1105 1106 1107 1108 1109
		 *  is not changing anything.
		 * @sample ```
			let file = Uri.parse('before:some/file/path');
			let other = file.with({ scheme: 'after' });
			assert.ok(other.toString() === 'after:some/file/path');
		 * ```
		 */
		with(change: { scheme?: string; authority?: string; path?: string; query?: string; fragment?: string }): Uri;

E
Erich Gamma 已提交
1110
		/**
1111 1112 1113
		 * 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 已提交
1114
		 *
1115 1116 1117
		 * @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 已提交
1118
		 */
1119
		toString(skipEncoding?: boolean): string;
E
Erich Gamma 已提交
1120

J
Johannes Rieken 已提交
1121 1122 1123 1124 1125
		/**
		 * Returns a JSON representation of this Uri.
		 *
		 * @return An object.
		 */
E
Erich Gamma 已提交
1126 1127 1128 1129
		toJSON(): any;
	}

	/**
S
Steven Clarke 已提交
1130
	 * A cancellation token is passed to an asynchronous or long running
E
Erich Gamma 已提交
1131 1132
	 * operation to request cancellation, like cancelling a request
	 * for completion items because the user continued to type.
1133 1134 1135
	 *
	 * To get an instance of a `CancellationToken` use a
	 * [CancellationTokenSource](#CancellationTokenSource).
E
Erich Gamma 已提交
1136 1137 1138 1139
	 */
	export interface CancellationToken {

		/**
J
Johannes Rieken 已提交
1140
		 * Is `true` when the token has been cancelled, `false` otherwise.
E
Erich Gamma 已提交
1141 1142 1143 1144
		 */
		isCancellationRequested: boolean;

		/**
J
Johannes Rieken 已提交
1145
		 * An [event](#Event) which fires upon cancellation.
E
Erich Gamma 已提交
1146 1147 1148 1149 1150
		 */
		onCancellationRequested: Event<any>;
	}

	/**
J
Johannes Rieken 已提交
1151
	 * A cancellation source creates and controls a [cancellation token](#CancellationToken).
E
Erich Gamma 已提交
1152 1153 1154 1155
	 */
	export class CancellationTokenSource {

		/**
J
Johannes Rieken 已提交
1156
		 * The cancellation token of this source.
E
Erich Gamma 已提交
1157 1158 1159 1160 1161 1162 1163 1164 1165
		 */
		token: CancellationToken;

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

		/**
J
Johannes Rieken 已提交
1166
		 * Dispose object and free resources. Will call [cancel](#CancellationTokenSource.cancel).
E
Erich Gamma 已提交
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181
		 */
		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 已提交
1182
		 * @param disposableLikes Objects that have at least a `dispose`-function member.
E
Erich Gamma 已提交
1183 1184 1185 1186 1187 1188 1189 1190
		 * @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 已提交
1191
		 * @param callOnDispose Function that disposes something.
E
Erich Gamma 已提交
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202
		 */
		constructor(callOnDispose: Function);

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

	/**
	 * Represents a typed event.
J
Johannes Rieken 已提交
1203 1204 1205 1206 1207
	 *
	 * 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 已提交
1208 1209 1210 1211
	 */
	export interface Event<T> {

		/**
J
Johannes Rieken 已提交
1212 1213
		 * A function that represents an event to which you subscribe by calling it with
		 * a listener function as argument.
E
Erich Gamma 已提交
1214 1215
		 *
		 * @param listener The listener function will be called when the event happens.
J
Johannes Rieken 已提交
1216 1217
		 * @param thisArgs The `this`-argument which will be used when calling the event listener.
		 * @param disposables An array to which a [disposeable](#Disposable) will be added.
A
Andre Weinand 已提交
1218
		 * @return A disposable which unsubscribes the event listener.
E
Erich Gamma 已提交
1219 1220 1221 1222
		 */
		(listener: (e: T) => any, thisArgs?: any, disposables?: Disposable[]): Disposable;
	}

1223 1224 1225 1226 1227
	/**
	 * 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 已提交
1228
	 * inside a [TextDocumentContentProvider](#TextDocumentContentProvider) or when providing
1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
	 * 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 已提交
1252 1253
	/**
	 * A file system watcher notifies about changes to files and folders
J
Johannes Rieken 已提交
1254 1255 1256
	 * on disk.
	 *
	 * To get an instance of a `FileSystemWatcher` use
J
Johannes Rieken 已提交
1257
	 * [createFileSystemWatcher](#workspace.createFileSystemWatcher).
E
Erich Gamma 已提交
1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276
	 */
	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 已提交
1277
		ignoreDeleteEvents: boolean;
E
Erich Gamma 已提交
1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294

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

1295 1296 1297 1298
	/**
	 * A text document content provider allows to add readonly documents
	 * to the editor, such as source from a dll or generated html from md.
	 *
1299
	 * Content providers are [registered](#workspace.registerTextDocumentContentProvider)
1300
	 * for a [uri-scheme](#Uri.scheme). When a uri with that scheme is to
1301
	 * be [loaded](#workspace.openTextDocument) the content provider is
1302 1303
	 * asked.
	 */
J
Johannes Rieken 已提交
1304 1305
	export interface TextDocumentContentProvider {

1306 1307 1308 1309
		/**
		 * An event to signal a resource has changed.
		 */
		onDidChange?: Event<Uri>;
J
Johannes Rieken 已提交
1310

1311
		/**
1312
		 * Provide textual content for a given uri.
1313
		 *
1314 1315
		 * The editor will use the returned string-content to create a readonly
		 * [document](TextDocument). Resources allocated should be released when
1316
		 * the corresponding document has been [closed](#workspace.onDidCloseTextDocument).
1317
		 *
1318 1319 1320
		 * @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.
1321
		 */
1322
		provideTextDocumentContent(uri: Uri, token: CancellationToken): string | Thenable<string>;
J
Johannes Rieken 已提交
1323 1324
	}

E
Erich Gamma 已提交
1325 1326
	/**
	 * Represents an item that can be selected from
A
Andre Weinand 已提交
1327
	 * a list of items.
E
Erich Gamma 已提交
1328 1329 1330 1331
	 */
	export interface QuickPickItem {

		/**
J
Johannes Rieken 已提交
1332
		 * A human readable string which is rendered prominent.
E
Erich Gamma 已提交
1333 1334 1335 1336
		 */
		label: string;

		/**
J
Johannes Rieken 已提交
1337
		 * A human readable string which is rendered less prominent.
E
Erich Gamma 已提交
1338 1339
		 */
		description: string;
J
Johannes Rieken 已提交
1340 1341 1342 1343 1344

		/**
		 * A human readable string which is rendered less prominent.
		 */
		detail?: string;
E
Erich Gamma 已提交
1345 1346 1347
	}

	/**
J
Johannes Rieken 已提交
1348
	 * Options to configure the behavior of the quick pick UI.
E
Erich Gamma 已提交
1349 1350 1351
	 */
	export interface QuickPickOptions {
		/**
J
Johannes Rieken 已提交
1352 1353
		 * An optional flag to include the description when filtering the picks.
		 */
E
Erich Gamma 已提交
1354 1355
		matchOnDescription?: boolean;

J
Johannes Rieken 已提交
1356 1357 1358 1359 1360
		/**
		 * An optional flag to include the detail when filtering the picks.
		 */
		matchOnDetail?: boolean;

E
Erich Gamma 已提交
1361
		/**
S
Steven Clarke 已提交
1362
		 * An optional string to show as place holder in the input box to guide the user what to pick on.
J
Johannes Rieken 已提交
1363
		 */
E
Erich Gamma 已提交
1364
		placeHolder?: string;
1365

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

1371 1372 1373 1374
		/**
		 * An optional function that is invoked whenever an item is selected.
		 */
		onDidSelectItem?: <T extends QuickPickItem>(item: T | string) => any;
E
Erich Gamma 已提交
1375 1376 1377
	}

	/**
J
Johannes Rieken 已提交
1378
	 * Represents an action that is shown with an information, warning, or
A
Andre Weinand 已提交
1379
	 * error message.
E
Erich Gamma 已提交
1380
	 *
S
Sofian Hnaide 已提交
1381 1382 1383
	 * @see [showInformationMessage](#window.showInformationMessage)
	 * @see [showWarningMessage](#window.showWarningMessage)
	 * @see [showErrorMessage](#window.showErrorMessage)
E
Erich Gamma 已提交
1384 1385 1386 1387
	 */
	export interface MessageItem {

		/**
A
Andre Weinand 已提交
1388
		 * A short title like 'Retry', 'Open Log' etc.
E
Erich Gamma 已提交
1389 1390
		 */
		title: string;
1391 1392 1393 1394 1395 1396

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

	/**
J
Johannes Rieken 已提交
1400
	 * Options to configure the behavior of the input box UI.
E
Erich Gamma 已提交
1401 1402
	 */
	export interface InputBoxOptions {
J
Johannes Rieken 已提交
1403

E
Erich Gamma 已提交
1404
		/**
J
Johannes Rieken 已提交
1405 1406
		 * The value to prefill in the input box.
		 */
E
Erich Gamma 已提交
1407 1408 1409
		value?: string;

		/**
J
Johannes Rieken 已提交
1410 1411
		 * The text to display underneath the input box.
		 */
E
Erich Gamma 已提交
1412 1413 1414
		prompt?: string;

		/**
J
Johannes Rieken 已提交
1415 1416
		 * An optional string to show as place holder in the input box to guide the user what to type.
		 */
E
Erich Gamma 已提交
1417 1418 1419
		placeHolder?: string;

		/**
1420
		 * Set to `true` to show a password prompt that will not show the typed value.
J
Johannes Rieken 已提交
1421
		 */
E
Erich Gamma 已提交
1422
		password?: boolean;
1423

1424 1425 1426 1427 1428
		/**
		 * Set to `true` to keep the input box open when focus moves to another part of the editor or to another window.
		 */
		ignoreFocusOut?: boolean;

1429
		/**
P
Pine 已提交
1430
		 * An optional function that will be called to validate input and to give a hint
1431 1432 1433 1434 1435 1436
		 * 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.
		 */
1437
		validateInput?(value: string): string;
E
Erich Gamma 已提交
1438 1439 1440 1441
	}

	/**
	 * A document filter denotes a document by different properties like
A
Alex Dima 已提交
1442
	 * the [language](#TextDocument.languageId), the [scheme](#Uri.scheme) of
A
Andre Weinand 已提交
1443
	 * its resource, or a glob-pattern that is applied to the [path](#TextDocument.fileName).
E
Erich Gamma 已提交
1444
	 *
J
Johannes Rieken 已提交
1445
	 * @sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
1446
	 * @sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**∕project.json' }`
E
Erich Gamma 已提交
1447 1448 1449 1450 1451 1452 1453 1454 1455
	 */
	export interface DocumentFilter {

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

		/**
J
Johannes Rieken 已提交
1456
		 * A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
E
Erich Gamma 已提交
1457 1458 1459 1460
		 */
		scheme?: string;

		/**
J
Johannes Rieken 已提交
1461
		 * A glob pattern, like `*.{ts,js}`.
E
Erich Gamma 已提交
1462 1463 1464 1465 1466 1467
		 */
		pattern?: string;
	}

	/**
	 * A language selector is the combination of one or many language identifiers
1468
	 * and [language filters](#DocumentFilter).
J
Johannes Rieken 已提交
1469 1470
	 *
	 * @sample `let sel:DocumentSelector = 'typescript'`;
1471
	 * @sample `let sel:DocumentSelector = ['typescript', { language: 'json', pattern: '**∕tsconfig.json' }]`;
E
Erich Gamma 已提交
1472 1473 1474 1475 1476
	 */
	export type DocumentSelector = string | DocumentFilter | (string | DocumentFilter)[];

	/**
	 * Contains additional diagnostic information about the context in which
J
Johannes Rieken 已提交
1477
	 * a [code action](#CodeActionProvider.provideCodeActions) is run.
E
Erich Gamma 已提交
1478 1479
	 */
	export interface CodeActionContext {
J
Johannes Rieken 已提交
1480 1481 1482

		/**
		 * An array of diagnostics.
J
Johannes Rieken 已提交
1483 1484
		 *
		 * @readonly
J
Johannes Rieken 已提交
1485
		 */
E
Erich Gamma 已提交
1486 1487 1488 1489
		diagnostics: Diagnostic[];
	}

	/**
J
Johannes Rieken 已提交
1490 1491 1492 1493
	 * 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 已提交
1494 1495 1496 1497 1498 1499
	 */
	export interface CodeActionProvider {

		/**
		 * Provide commands for the given document and range.
		 *
J
Johannes Rieken 已提交
1500 1501
		 * @param document The document in which the command was invoked.
		 * @param range The range for which the command was invoked.
J
Johannes Rieken 已提交
1502 1503
		 * @param context Context carrying additional information.
		 * @param token A cancellation token.
J
Johannes Rieken 已提交
1504
		 * @return An array of commands or a thenable of such. The lack of a result can be
A
Andre Weinand 已提交
1505
		 * signaled by returning `undefined`, `null`, or an empty array.
E
Erich Gamma 已提交
1506 1507 1508 1509 1510 1511 1512
		 */
		provideCodeActions(document: TextDocument, range: Range, context: CodeActionContext, token: CancellationToken): Command[] | Thenable<Command[]>;
	}

	/**
	 * 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 已提交
1513 1514 1515
	 *
	 * 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 已提交
1516 1517 1518
	 *
	 * @see [CodeLensProvider.provideCodeLenses](#CodeLensProvider.provideCodeLenses)
	 * @see [CodeLensProvider.resolveCodeLens](#CodeLensProvider.resolveCodeLens)
E
Erich Gamma 已提交
1519 1520 1521 1522 1523 1524 1525 1526 1527
	 */
	export class CodeLens {

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

		/**
J
Johannes Rieken 已提交
1528
		 * The command this code lens represents.
E
Erich Gamma 已提交
1529 1530 1531 1532
		 */
		command: Command;

		/**
J
Johannes Rieken 已提交
1533
		 * `true` when there is a command associated.
E
Erich Gamma 已提交
1534 1535
		 */
		isResolved: boolean;
J
Johannes Rieken 已提交
1536 1537 1538 1539 1540 1541 1542 1543

		/**
		 * 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 已提交
1544 1545 1546 1547 1548 1549 1550 1551 1552 1553
	}

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

		/**
		 * Compute a list of [lenses](#CodeLens). This call should return as fast as possible and if
A
Andre Weinand 已提交
1554
		 * computing the commands is expensive implementors should only return code lens objects with the
E
Erich Gamma 已提交
1555
		 * range set and implement [resolve](#CodeLensProvider.resolveCodeLens).
J
Johannes Rieken 已提交
1556 1557 1558
		 *
		 * @param document The document in which the command was invoked.
		 * @param token A cancellation token.
A
Andre Weinand 已提交
1559 1560
		 * @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 已提交
1561 1562 1563 1564 1565 1566
		 */
		provideCodeLenses(document: TextDocument, token: CancellationToken): CodeLens[] | Thenable<CodeLens[]>;

		/**
		 * This function will be called for each visible code lens, usually when scrolling and after
		 * calls to [compute](#CodeLensProvider.provideCodeLenses)-lenses.
J
Johannes Rieken 已提交
1567
		 *
A
Andre Weinand 已提交
1568
		 * @param codeLens code lens that must be resolved.
J
Johannes Rieken 已提交
1569
		 * @param token A cancellation token.
S
Steven Clarke 已提交
1570
		 * @return The given, resolved code lens or thenable that resolves to such.
E
Erich Gamma 已提交
1571 1572 1573 1574 1575
		 */
		resolveCodeLens?(codeLens: CodeLens, token: CancellationToken): CodeLens | Thenable<CodeLens>;
	}

	/**
J
Johannes Rieken 已提交
1576 1577 1578
	 * 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 已提交
1579 1580 1581
	 */
	export type Definition = Location | Location[];

J
Johannes Rieken 已提交
1582 1583 1584 1585 1586
	/**
	 * 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 已提交
1587
	export interface DefinitionProvider {
J
Johannes Rieken 已提交
1588 1589 1590 1591 1592 1593 1594

		/**
		 * 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 已提交
1595
		 * @return A definition or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
1596
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
1597 1598
		 */
		provideDefinition(document: TextDocument, position: Position, token: CancellationToken): Definition | Thenable<Definition>;
E
Erich Gamma 已提交
1599 1600 1601
	}

	/**
J
Johannes Rieken 已提交
1602 1603 1604
	 * MarkedString can be used to render human readable text. It is either a markdown string
	 * or a code-block that provides a language and a code snippet. Note that
	 * markdown strings will be sanitized - that means html will be escaped.
E
Erich Gamma 已提交
1605 1606 1607
	 */
	export type MarkedString = string | { language: string; value: string };

J
Johannes Rieken 已提交
1608 1609 1610 1611
	/**
	 * A hover represents additional information for a symbol or word. Hovers are
	 * rendered in a tooltip-like widget.
	 */
E
Erich Gamma 已提交
1612 1613
	export class Hover {

J
Johannes Rieken 已提交
1614 1615 1616
		/**
		 * The contents of this hover.
		 */
E
Erich Gamma 已提交
1617 1618
		contents: MarkedString[];

J
Johannes Rieken 已提交
1619
		/**
A
Andre Weinand 已提交
1620
		 * The range to which this hover applies. When missing, the
J
Johannes Rieken 已提交
1621
		 * editor will use the range at the current position or the
A
Andre Weinand 已提交
1622
		 * current position itself.
J
Johannes Rieken 已提交
1623
		 */
E
Erich Gamma 已提交
1624 1625
		range: Range;

J
Johannes Rieken 已提交
1626 1627 1628 1629
		/**
		 * Creates a new hover object.
		 *
		 * @param contents The contents of the hover.
A
Andre Weinand 已提交
1630
		 * @param range The range to which the hover applies.
J
Johannes Rieken 已提交
1631
		 */
E
Erich Gamma 已提交
1632 1633 1634
		constructor(contents: MarkedString | MarkedString[], range?: Range);
	}

J
Johannes Rieken 已提交
1635 1636 1637 1638
	/**
	 * The hover provider interface defines the contract between extensions and
	 * the [hover](https://code.visualstudio.com/docs/editor/editingevolved#_hover)-feature.
	 */
E
Erich Gamma 已提交
1639
	export interface HoverProvider {
J
Johannes Rieken 已提交
1640 1641 1642

		/**
		 * Provide a hover for the given position and document. Multiple hovers at the same
A
Andre Weinand 已提交
1643 1644
		 * 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 已提交
1645 1646 1647 1648 1649
		 *
		 * @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 已提交
1650
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
1651
		 */
E
Erich Gamma 已提交
1652 1653 1654
		provideHover(document: TextDocument, position: Position, token: CancellationToken): Hover | Thenable<Hover>;
	}

J
Johannes Rieken 已提交
1655 1656 1657
	/**
	 * A document highlight kind.
	 */
E
Erich Gamma 已提交
1658
	export enum DocumentHighlightKind {
J
Johannes Rieken 已提交
1659 1660

		/**
A
Andre Weinand 已提交
1661
		 * A textual occurrence.
J
Johannes Rieken 已提交
1662
		 */
E
Erich Gamma 已提交
1663
		Text,
J
Johannes Rieken 已提交
1664 1665 1666 1667

		/**
		 * Read-access of a symbol, like reading a variable.
		 */
E
Erich Gamma 已提交
1668
		Read,
J
Johannes Rieken 已提交
1669 1670 1671 1672

		/**
		 * Write-access of a symbol, like writing to a variable.
		 */
E
Erich Gamma 已提交
1673 1674 1675
		Write
	}

J
Johannes Rieken 已提交
1676 1677 1678 1679 1680
	/**
	 * 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 已提交
1681
	export class DocumentHighlight {
J
Johannes Rieken 已提交
1682 1683 1684 1685

		/**
		 * The range this highlight applies to.
		 */
E
Erich Gamma 已提交
1686
		range: Range;
J
Johannes Rieken 已提交
1687 1688 1689 1690

		/**
		 * The highlight kind, default is [text](#DocumentHighlightKind.Text).
		 */
E
Erich Gamma 已提交
1691
		kind: DocumentHighlightKind;
J
Johannes Rieken 已提交
1692 1693 1694 1695 1696 1697 1698 1699

		/**
		 * 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 已提交
1700 1701
	}

J
Johannes Rieken 已提交
1702 1703 1704 1705
	/**
	 * The document highlight provider interface defines the contract between extensions and
	 * the word-highlight-feature.
	 */
E
Erich Gamma 已提交
1706
	export interface DocumentHighlightProvider {
J
Johannes Rieken 已提交
1707 1708

		/**
S
Steven Clarke 已提交
1709
		 * Provide a set of document highlights, like all occurrences of a variable or
J
Johannes Rieken 已提交
1710 1711 1712 1713 1714 1715
		 * 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 已提交
1716
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1717
		 */
E
Erich Gamma 已提交
1718 1719 1720
		provideDocumentHighlights(document: TextDocument, position: Position, token: CancellationToken): DocumentHighlight[] | Thenable<DocumentHighlight[]>;
	}

J
Johannes Rieken 已提交
1721 1722 1723
	/**
	 * A symbol kind.
	 */
E
Erich Gamma 已提交
1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741
	export enum SymbolKind {
		File,
		Module,
		Namespace,
		Package,
		Class,
		Method,
		Property,
		Field,
		Constructor,
		Enum,
		Interface,
		Function,
		Variable,
		Constant,
		String,
		Number,
		Boolean,
1742 1743 1744 1745
		Array,
		Object,
		Key,
		Null
E
Erich Gamma 已提交
1746 1747
	}

J
Johannes Rieken 已提交
1748 1749 1750 1751
	/**
	 * Represents information about programming constructs like variables, classes,
	 * interfaces etc.
	 */
E
Erich Gamma 已提交
1752
	export class SymbolInformation {
J
Johannes Rieken 已提交
1753 1754 1755 1756

		/**
		 * The name of this symbol.
		 */
E
Erich Gamma 已提交
1757
		name: string;
J
Johannes Rieken 已提交
1758 1759 1760 1761

		/**
		 * The name of the symbol containing this symbol.
		 */
E
Erich Gamma 已提交
1762
		containerName: string;
J
Johannes Rieken 已提交
1763 1764 1765 1766

		/**
		 * The kind of this symbol.
		 */
E
Erich Gamma 已提交
1767
		kind: SymbolKind;
J
Johannes Rieken 已提交
1768 1769 1770 1771

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

1774 1775 1776 1777 1778 1779 1780 1781 1782 1783
		/**
		 * 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 已提交
1784
		/**
1785 1786
		 * @deprecated Please use the constructor taking a [location](#Location) object.
		 *
J
Johannes Rieken 已提交
1787 1788 1789 1790 1791 1792
		 * Creates a new symbol information object.
		 *
		 * @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 已提交
1793
		 * @param containerName The name of the symbol containing the symbol.
J
Johannes Rieken 已提交
1794 1795
		 */
		constructor(name: string, kind: SymbolKind, range: Range, uri?: Uri, containerName?: string);
E
Erich Gamma 已提交
1796 1797
	}

J
Johannes Rieken 已提交
1798 1799 1800 1801
	/**
	 * The document symbol provider interface defines the contract between extensions and
	 * the [go to symbol](https://code.visualstudio.com/docs/editor/editingevolved#_goto-symbol)-feature.
	 */
E
Erich Gamma 已提交
1802
	export interface DocumentSymbolProvider {
J
Johannes Rieken 已提交
1803 1804 1805 1806 1807 1808 1809

		/**
		 * 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 已提交
1810
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1811
		 */
E
Erich Gamma 已提交
1812 1813 1814
		provideDocumentSymbols(document: TextDocument, token: CancellationToken): SymbolInformation[] | Thenable<SymbolInformation[]>;
	}

J
Johannes Rieken 已提交
1815 1816 1817 1818
	/**
	 * 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 已提交
1819
	export interface WorkspaceSymbolProvider {
J
Johannes Rieken 已提交
1820 1821 1822

		/**
		 * Project-wide search for a symbol matching the given query string. It is up to the provider
1823 1824 1825
		 * 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 已提交
1826 1827 1828 1829
		 *
		 * @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 已提交
1830
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1831
		 */
E
Erich Gamma 已提交
1832
		provideWorkspaceSymbols(query: string, token: CancellationToken): SymbolInformation[] | Thenable<SymbolInformation[]>;
1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845

		/**
		 * 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.
		 */
1846
		resolveWorkspaceSymbol?(symbol: SymbolInformation, token: CancellationToken): SymbolInformation | Thenable<SymbolInformation>;
E
Erich Gamma 已提交
1847 1848
	}

J
Johannes Rieken 已提交
1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864
	/**
	 * 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 已提交
1865
	export interface ReferenceProvider {
J
Johannes Rieken 已提交
1866 1867 1868 1869 1870 1871 1872 1873 1874

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

J
Johannes Rieken 已提交
1880
	/**
S
Steven Clarke 已提交
1881
	 * A text edit represents edits that should be applied
J
Johannes Rieken 已提交
1882
	 * to a document.
J
Johannes Rieken 已提交
1883
	 */
E
Erich Gamma 已提交
1884
	export class TextEdit {
J
Johannes Rieken 已提交
1885 1886 1887 1888 1889 1890 1891 1892

		/**
		 * Utility to create a replace edit.
		 *
		 * @param range A range.
		 * @param newText A string.
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
1893
		static replace(range: Range, newText: string): TextEdit;
J
Johannes Rieken 已提交
1894 1895 1896 1897

		/**
		 * Utility to create an insert edit.
		 *
S
Steven Clarke 已提交
1898
		 * @param position A position, will become an empty range.
J
Johannes Rieken 已提交
1899 1900 1901
		 * @param newText A string.
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
1902
		static insert(position: Position, newText: string): TextEdit;
J
Johannes Rieken 已提交
1903 1904 1905 1906

		/**
		 * Utility to create a delete edit.
		 *
J
Johannes Rieken 已提交
1907
		 * @param range A range.
J
Johannes Rieken 已提交
1908 1909
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
1910
		static delete(range: Range): TextEdit;
J
Johannes Rieken 已提交
1911 1912 1913 1914

		/**
		 * The range this edit applies to.
		 */
E
Erich Gamma 已提交
1915
		range: Range;
J
Johannes Rieken 已提交
1916 1917 1918 1919

		/**
		 * The string this edit will insert.
		 */
E
Erich Gamma 已提交
1920
		newText: string;
J
Johannes Rieken 已提交
1921 1922 1923 1924 1925 1926 1927 1928

		/**
		 * Create a new TextEdit.
		 *
		 * @param range A range.
		 * @param newText A string.
		 */
		constructor(range: Range, newText: string);
E
Erich Gamma 已提交
1929 1930 1931
	}

	/**
J
Johannes Rieken 已提交
1932
	 * A workspace edit represents textual changes for many documents.
E
Erich Gamma 已提交
1933 1934 1935 1936 1937 1938 1939 1940 1941 1942
	 */
	export class WorkspaceEdit {

		/**
		 * The number of affected resources.
		 *
		 * @readonly
		 */
		size: number;

J
Johannes Rieken 已提交
1943 1944 1945 1946 1947 1948 1949 1950
		/**
		 * 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 已提交
1951

J
Johannes Rieken 已提交
1952 1953 1954 1955 1956 1957 1958 1959
		/**
		 * 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 已提交
1960

J
Johannes Rieken 已提交
1961
		/**
S
Steven Clarke 已提交
1962
		 * Delete the text at the given range.
J
Johannes Rieken 已提交
1963 1964 1965
		 *
		 * @param uri A resource identifier.
		 * @param range A range.
J
Johannes Rieken 已提交
1966 1967
		 */
		delete(uri: Uri, range: Range): void;
E
Erich Gamma 已提交
1968

J
Johannes Rieken 已提交
1969 1970 1971
		/**
		 * Check if this edit affects the given resource.
		 * @param uri A resource identifier.
A
Andre Weinand 已提交
1972
		 * @return `true` if the given resource will be touched by this edit.
J
Johannes Rieken 已提交
1973
		 */
E
Erich Gamma 已提交
1974 1975
		has(uri: Uri): boolean;

J
Johannes Rieken 已提交
1976 1977 1978 1979 1980 1981
		/**
		 * Set (and replace) text edits for a resource.
		 *
		 * @param uri A resource identifier.
		 * @param edits An array of text edits.
		 */
E
Erich Gamma 已提交
1982 1983
		set(uri: Uri, edits: TextEdit[]): void;

J
Johannes Rieken 已提交
1984 1985 1986 1987 1988 1989
		/**
		 * Get the text edits for a resource.
		 *
		 * @param uri A resource identifier.
		 * @return An array of text edits.
		 */
E
Erich Gamma 已提交
1990 1991
		get(uri: Uri): TextEdit[];

J
Johannes Rieken 已提交
1992 1993 1994 1995 1996
		/**
		 * Get all text edits grouped by resource.
		 *
		 * @return An array of `[Uri, TextEdit[]]`-tuples.
		 */
E
Erich Gamma 已提交
1997 1998 1999 2000
		entries(): [Uri, TextEdit[]][];
	}

	/**
J
Johannes Rieken 已提交
2001 2002
	 * 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 已提交
2003 2004
	 */
	export interface RenameProvider {
J
Johannes Rieken 已提交
2005 2006 2007 2008 2009 2010 2011 2012 2013 2014

		/**
		 * 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 已提交
2015
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
2016
		 */
E
Erich Gamma 已提交
2017 2018 2019
		provideRenameEdits(document: TextDocument, position: Position, newName: string, token: CancellationToken): WorkspaceEdit | Thenable<WorkspaceEdit>;
	}

J
Johannes Rieken 已提交
2020 2021 2022
	/**
	 * Value-object describing what options formatting should use.
	 */
E
Erich Gamma 已提交
2023
	export interface FormattingOptions {
J
Johannes Rieken 已提交
2024 2025 2026 2027

		/**
		 * Size of a tab in spaces.
		 */
E
Erich Gamma 已提交
2028
		tabSize: number;
J
Johannes Rieken 已提交
2029 2030 2031 2032

		/**
		 * Prefer spaces over tabs.
		 */
E
Erich Gamma 已提交
2033
		insertSpaces: boolean;
J
Johannes Rieken 已提交
2034 2035 2036 2037 2038

		/**
		 * Signature for further properties.
		 */
		[key: string]: boolean | number | string;
E
Erich Gamma 已提交
2039 2040 2041
	}

	/**
J
Johannes Rieken 已提交
2042 2043
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
2044 2045
	 */
	export interface DocumentFormattingEditProvider {
J
Johannes Rieken 已提交
2046 2047 2048 2049 2050 2051 2052 2053

		/**
		 * 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 已提交
2054
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2055
		 */
E
Erich Gamma 已提交
2056 2057 2058 2059
		provideDocumentFormattingEdits(document: TextDocument, options: FormattingOptions, token: CancellationToken): TextEdit[] | Thenable<TextEdit[]>;
	}

	/**
J
Johannes Rieken 已提交
2060 2061
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
2062 2063
	 */
	export interface DocumentRangeFormattingEditProvider {
J
Johannes Rieken 已提交
2064 2065 2066 2067 2068

		/**
		 * 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 已提交
2069 2070
		 * or larger range. Often this is done by adjusting the start and end
		 * of the range to full syntax nodes.
J
Johannes Rieken 已提交
2071 2072 2073 2074 2075 2076
		 *
		 * @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 已提交
2077
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2078
		 */
E
Erich Gamma 已提交
2079 2080 2081 2082
		provideDocumentRangeFormattingEdits(document: TextDocument, range: Range, options: FormattingOptions, token: CancellationToken): TextEdit[] | Thenable<TextEdit[]>;
	}

	/**
J
Johannes Rieken 已提交
2083 2084
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
2085 2086
	 */
	export interface OnTypeFormattingEditProvider {
J
Johannes Rieken 已提交
2087 2088 2089 2090 2091 2092 2093 2094 2095 2096

		/**
		 * 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 已提交
2097
		 * @param ch The character that has been typed.
J
Johannes Rieken 已提交
2098 2099 2100
		 * @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 已提交
2101
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2102
		 */
E
Erich Gamma 已提交
2103 2104 2105
		provideOnTypeFormattingEdits(document: TextDocument, position: Position, ch: string, options: FormattingOptions, token: CancellationToken): TextEdit[] | Thenable<TextEdit[]>;
	}

J
Johannes Rieken 已提交
2106 2107 2108 2109
	/**
	 * Represents a parameter of a callable-signature. A parameter can
	 * have a label and a doc-comment.
	 */
E
Erich Gamma 已提交
2110
	export class ParameterInformation {
J
Johannes Rieken 已提交
2111 2112 2113 2114 2115

		/**
		 * The label of this signature. Will be shown in
		 * the UI.
		 */
E
Erich Gamma 已提交
2116
		label: string;
J
Johannes Rieken 已提交
2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129

		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
		documentation: string;

		/**
		 * Creates a new parameter information object.
		 *
		 * @param label A label string.
		 * @param documentation A doc string.
		 */
E
Erich Gamma 已提交
2130 2131 2132
		constructor(label: string, documentation?: string);
	}

J
Johannes Rieken 已提交
2133 2134 2135 2136 2137
	/**
	 * 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 已提交
2138
	export class SignatureInformation {
J
Johannes Rieken 已提交
2139 2140 2141 2142 2143

		/**
		 * The label of this signature. Will be shown in
		 * the UI.
		 */
E
Erich Gamma 已提交
2144
		label: string;
J
Johannes Rieken 已提交
2145 2146 2147 2148 2149 2150 2151 2152 2153 2154

		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
		documentation: string;

		/**
		 * The parameters of this signature.
		 */
E
Erich Gamma 已提交
2155
		parameters: ParameterInformation[];
J
Johannes Rieken 已提交
2156 2157 2158 2159 2160

		/**
		 * Creates a new signature information object.
		 *
		 * @param label A label string.
J
Johannes Rieken 已提交
2161
		 * @param documentation A doc string.
J
Johannes Rieken 已提交
2162
		 */
E
Erich Gamma 已提交
2163 2164 2165
		constructor(label: string, documentation?: string);
	}

J
Johannes Rieken 已提交
2166 2167
	/**
	 * Signature help represents the signature of something
S
Steven Clarke 已提交
2168
	 * callable. There can be multiple signatures but only one
J
Johannes Rieken 已提交
2169 2170
	 * active and only one active parameter.
	 */
E
Erich Gamma 已提交
2171
	export class SignatureHelp {
J
Johannes Rieken 已提交
2172 2173 2174 2175

		/**
		 * One or more signatures.
		 */
E
Erich Gamma 已提交
2176
		signatures: SignatureInformation[];
J
Johannes Rieken 已提交
2177 2178 2179 2180

		/**
		 * The active signature.
		 */
E
Erich Gamma 已提交
2181
		activeSignature: number;
J
Johannes Rieken 已提交
2182 2183 2184 2185

		/**
		 * The active parameter of the active signature.
		 */
E
Erich Gamma 已提交
2186 2187 2188
		activeParameter: number;
	}

J
Johannes Rieken 已提交
2189 2190 2191 2192
	/**
	 * The signature help provider interface defines the contract between extensions and
	 * the [parameter hints](https://code.visualstudio.com/docs/editor/editingevolved#_parameter-hints)-feature.
	 */
E
Erich Gamma 已提交
2193
	export interface SignatureHelpProvider {
J
Johannes Rieken 已提交
2194 2195 2196 2197 2198 2199 2200 2201

		/**
		 * 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 已提交
2202
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
2203
		 */
E
Erich Gamma 已提交
2204 2205 2206
		provideSignatureHelp(document: TextDocument, position: Position, token: CancellationToken): SignatureHelp | Thenable<SignatureHelp>;
	}

J
Johannes Rieken 已提交
2207 2208 2209
	/**
	 * Completion item kinds.
	 */
E
Erich Gamma 已提交
2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230
	export enum CompletionItemKind {
		Text,
		Method,
		Function,
		Constructor,
		Field,
		Variable,
		Class,
		Interface,
		Module,
		Property,
		Unit,
		Value,
		Enum,
		Keyword,
		Snippet,
		Color,
		File,
		Reference
	}

J
Johannes Rieken 已提交
2231
	/**
2232
	 * A completion item represents a text snippet that is proposed to complete text that is being typed.
J
Johannes Rieken 已提交
2233
	 *
2234 2235 2236 2237
	 * 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.
2238
	 *
2239 2240 2241
	 * 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.
2242
	 *
J
Johannes Rieken 已提交
2243 2244
	 * @see [CompletionItemProvider.provideCompletionItems](#CompletionItemProvider.provideCompletionItems)
	 * @see [CompletionItemProvider.resolveCompletionItem](#CompletionItemProvider.resolveCompletionItem)
J
Johannes Rieken 已提交
2245
	 */
E
Erich Gamma 已提交
2246
	export class CompletionItem {
J
Johannes Rieken 已提交
2247 2248 2249

		/**
		 * The label of this completion item. By default
A
Andre Weinand 已提交
2250
		 * this is also the text that is inserted when selecting
J
Johannes Rieken 已提交
2251 2252
		 * this completion.
		 */
E
Erich Gamma 已提交
2253
		label: string;
J
Johannes Rieken 已提交
2254 2255

		/**
S
Steven Clarke 已提交
2256
		 * The kind of this completion item. Based on the kind
J
Johannes Rieken 已提交
2257 2258
		 * an icon is chosen by the editor.
		 */
E
Erich Gamma 已提交
2259
		kind: CompletionItemKind;
J
Johannes Rieken 已提交
2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272

		/**
		 * A human-readable string with additional information
		 * about this item, like type or symbol information.
		 */
		detail: string;

		/**
		 * A human-readable string that represents a doc-comment.
		 */
		documentation: string;

		/**
A
Andre Weinand 已提交
2273
		 * A string that should be used when comparing this item
J
Johannes Rieken 已提交
2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286
		 * with other items. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
		sortText: string;

		/**
		 * A string that should be used when filtering a set of
		 * completion items. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
		filterText: string;

		/**
S
Steven Clarke 已提交
2287
		 * A string that should be inserted in a document when selecting
J
Johannes Rieken 已提交
2288 2289 2290
		 * this completion. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
E
Erich Gamma 已提交
2291
		insertText: string;
J
Johannes Rieken 已提交
2292 2293 2294 2295 2296

		/**
		 * An [edit](#TextEdit) which is applied to a document when selecting
		 * this completion. When an edit is provided the value of
		 * [insertText](#CompletionItem.insertText) is ignored.
2297
		 *
2298 2299
		 * The [range](#Range) of the edit must be single-line and on the same
		 * line completions were [requested](#CompletionItemProvider.provideCompletionItems) at.
J
Johannes Rieken 已提交
2300 2301 2302
		 */
		textEdit: TextEdit;

2303 2304 2305 2306 2307 2308 2309 2310
		/**
		 * 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.
		 */
		additionalTextEdits: TextEdit[];

		/**
2311 2312
		 * An optional [command](#Command) that is executed *after* inserting this completion. *Note* that
		 * additional modifications to the current document should be described with the
2313 2314 2315 2316
		 * [additionalTextEdits](#CompletionItem.additionalTextEdits)-property.
		 */
		command: Command;

J
Johannes Rieken 已提交
2317 2318 2319 2320 2321 2322 2323
		/**
		 * 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.
2324
		 * @param kind The [kind](#CompletionItemKind) of the completion.
J
Johannes Rieken 已提交
2325
		 */
2326
		constructor(label: string, kind?: CompletionItemKind);
E
Erich Gamma 已提交
2327 2328
	}

2329 2330 2331 2332
	/**
	 * Represents a collection of [completion items](#CompletionItem) to be presented
	 * in the editor.
	 */
J
Johannes Rieken 已提交
2333
	export class CompletionList {
2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354

		/**
		 * This list it not complete. Further typing should result in recomputing
		 * this list.
		 */
		isIncomplete: boolean;

		/**
		 * 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 已提交
2355 2356
	/**
	 * The completion item provider interface defines the contract between extensions and
2357
	 * [IntelliSense](https://code.visualstudio.com/docs/editor/editingevolved#_intellisense).
J
Johannes Rieken 已提交
2358 2359 2360 2361
	 *
	 * 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 已提交
2362
	 * [provideCompletionItems](#CompletionItemProvider.provideCompletionItems)-function. Subsequently,
S
Steven Clarke 已提交
2363
	 * when a completion item is shown in the UI and gains focus this provider is asked to resolve
J
Johannes Rieken 已提交
2364
	 * the item, like adding [doc-comment](#CompletionItem.documentation) or [details](#CompletionItem.detail).
2365 2366 2367
	 *
	 * 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 已提交
2368
	 */
E
Erich Gamma 已提交
2369
	export interface CompletionItemProvider {
J
Johannes Rieken 已提交
2370 2371

		/**
J
Johannes Rieken 已提交
2372
		 * Provide completion items for the given position and document.
J
Johannes Rieken 已提交
2373
		 *
J
Johannes Rieken 已提交
2374 2375 2376
		 * @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.
2377 2378
		 * @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 已提交
2379
		 */
2380
		provideCompletionItems(document: TextDocument, position: Position, token: CancellationToken): CompletionItem[] | Thenable<CompletionItem[]> | CompletionList | Thenable<CompletionList>;
J
Johannes Rieken 已提交
2381 2382

		/**
J
Johannes Rieken 已提交
2383 2384 2385 2386
		 * 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 已提交
2387
		 *
J
Johannes Rieken 已提交
2388 2389
		 * @param item A completion item currently active in the UI.
		 * @param token A cancellation token.
S
Steven Clarke 已提交
2390
		 * @return The resolved completion item or a thenable that resolves to of such. It is OK to return the given
J
Johannes Rieken 已提交
2391
		 * `item`. When no result is returned, the given `item` will be used.
J
Johannes Rieken 已提交
2392
		 */
E
Erich Gamma 已提交
2393 2394 2395
		resolveCompletionItem?(item: CompletionItem, token: CancellationToken): CompletionItem | Thenable<CompletionItem>;
	}

J
Johannes Rieken 已提交
2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428

	/**
	 * 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.
		 */
		target: Uri;

		/**
		 * 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.
		 */
		constructor(range: Range, target: Uri);
	}

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

		/**
2429 2430 2431
		 * 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 已提交
2432 2433 2434 2435 2436 2437
		 * @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
		 *  can be signaled by returning `undefined`, `null`, or an empty array.
		 */
		provideDocumentLinks(document: TextDocument, token: CancellationToken): DocumentLink[] | Thenable<DocumentLink[]>;
2438 2439 2440 2441 2442 2443 2444 2445 2446 2447

		/**
		 * 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.
		 */
2448
		resolveDocumentLink?(link: DocumentLink, token: CancellationToken): DocumentLink | Thenable<DocumentLink>;
J
Johannes Rieken 已提交
2449 2450
	}

J
Johannes Rieken 已提交
2451 2452 2453 2454
	/**
	 * A tuple of two characters, like a pair of
	 * opening and closing brackets.
	 */
E
Erich Gamma 已提交
2455 2456
	export type CharacterPair = [string, string];

J
Johannes Rieken 已提交
2457 2458 2459
	/**
	 * Describes how comments for a language work.
	 */
E
Erich Gamma 已提交
2460
	export interface CommentRule {
J
Johannes Rieken 已提交
2461 2462 2463 2464

		/**
		 * The line comment token, like `// this is a comment`
		 */
E
Erich Gamma 已提交
2465
		lineComment?: string;
J
Johannes Rieken 已提交
2466 2467 2468 2469 2470

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

A
Alex Dima 已提交
2473 2474 2475
	/**
	 * Describes indentation rules for a language.
	 */
E
Erich Gamma 已提交
2476
	export interface IndentationRule {
A
Alex Dima 已提交
2477 2478 2479
		/**
		 * If a line matches this pattern, then all the lines after it should be unindendented once (until another rule matches).
		 */
E
Erich Gamma 已提交
2480
		decreaseIndentPattern: RegExp;
A
Alex Dima 已提交
2481 2482 2483
		/**
		 * If a line matches this pattern, then all the lines after it should be indented once (until another rule matches).
		 */
E
Erich Gamma 已提交
2484
		increaseIndentPattern: RegExp;
A
Alex Dima 已提交
2485 2486 2487
		/**
		 * If a line matches this pattern, then **only the next line** after it should be indented once.
		 */
E
Erich Gamma 已提交
2488
		indentNextLinePattern?: RegExp;
A
Alex Dima 已提交
2489 2490 2491
		/**
		 * 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 已提交
2492 2493 2494
		unIndentedLinePattern?: RegExp;
	}

A
Alex Dima 已提交
2495 2496 2497
	/**
	 * Describes what to do with the indentation when pressing Enter.
	 */
E
Erich Gamma 已提交
2498
	export enum IndentAction {
A
Alex Dima 已提交
2499 2500 2501
		/**
		 * Insert new line and copy the previous line's indentation.
		 */
E
Erich Gamma 已提交
2502
		None,
A
Alex Dima 已提交
2503 2504 2505
		/**
		 * Insert new line and indent once (relative to the previous line's indentation).
		 */
E
Erich Gamma 已提交
2506
		Indent,
A
Alex Dima 已提交
2507 2508 2509 2510 2511
		/**
		 * Insert two new lines:
		 *  - the first one indented which will hold the cursor
		 *  - the second one at the same indentation level
		 */
E
Erich Gamma 已提交
2512
		IndentOutdent,
A
Alex Dima 已提交
2513 2514 2515
		/**
		 * Insert new line and outdent once (relative to the previous line's indentation).
		 */
E
Erich Gamma 已提交
2516 2517 2518
		Outdent
	}

A
Alex Dima 已提交
2519 2520 2521
	/**
	 * Describes what to do when pressing Enter.
	 */
E
Erich Gamma 已提交
2522
	export interface EnterAction {
A
Alex Dima 已提交
2523 2524 2525 2526 2527 2528 2529
		/**
		 * 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 已提交
2530
		appendText?: string;
A
Alex Dima 已提交
2531 2532 2533 2534
		/**
		 * Describes the number of characters to remove from the new line's indentation.
		 */
		removeText?: number;
E
Erich Gamma 已提交
2535 2536
	}

A
Alex Dima 已提交
2537 2538 2539
	/**
	 * Describes a rule to be evaluated when pressing Enter.
	 */
E
Erich Gamma 已提交
2540
	export interface OnEnterRule {
A
Alex Dima 已提交
2541 2542 2543
		/**
		 * This rule will only execute if the text before the cursor matches this regular expression.
		 */
E
Erich Gamma 已提交
2544
		beforeText: RegExp;
A
Alex Dima 已提交
2545 2546 2547
		/**
		 * This rule will only execute if the text after the cursor matches this regular expression.
		 */
E
Erich Gamma 已提交
2548
		afterText?: RegExp;
A
Alex Dima 已提交
2549 2550 2551
		/**
		 * The action to execute.
		 */
E
Erich Gamma 已提交
2552 2553 2554
		action: EnterAction;
	}

J
Johannes Rieken 已提交
2555
	/**
A
Andre Weinand 已提交
2556
	 * The language configuration interfaces defines the contract between extensions
S
Steven Clarke 已提交
2557
	 * and various editor features, like automatic bracket insertion, automatic indentation etc.
J
Johannes Rieken 已提交
2558
	 */
E
Erich Gamma 已提交
2559
	export interface LanguageConfiguration {
A
Alex Dima 已提交
2560 2561 2562
		/**
		 * The language's comment settings.
		 */
E
Erich Gamma 已提交
2563
		comments?: CommentRule;
A
Alex Dima 已提交
2564 2565 2566 2567
		/**
		 * The language's brackets.
		 * This configuration implicitly affects pressing Enter around these brackets.
		 */
E
Erich Gamma 已提交
2568
		brackets?: CharacterPair[];
A
Alex Dima 已提交
2569 2570 2571 2572 2573 2574 2575
		/**
		 * 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 已提交
2576
		wordPattern?: RegExp;
A
Alex Dima 已提交
2577 2578 2579
		/**
		 * The language's indentation settings.
		 */
E
Erich Gamma 已提交
2580
		indentationRules?: IndentationRule;
A
Alex Dima 已提交
2581 2582 2583
		/**
		 * The language's rules to be evaluated when pressing Enter.
		 */
E
Erich Gamma 已提交
2584 2585 2586
		onEnterRules?: OnEnterRule[];

		/**
A
Alex Dima 已提交
2587
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
2588 2589
		 *
		 * @deprecated Will be replaced by a better API soon.
E
Erich Gamma 已提交
2590 2591
		 */
		__electricCharacterSupport?: {
2592 2593 2594 2595 2596 2597
			/**
			 * This property is deprecated and will be **ignored** from
			 * the editor.
			 * @deprecated
			 */
			brackets?: any;
2598 2599 2600 2601 2602 2603
			/**
			 * 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 已提交
2604
			docComment?: {
A
Alex Dima 已提交
2605 2606 2607 2608
				scope: string;
				open: string;
				lineStart: string;
				close?: string;
E
Erich Gamma 已提交
2609 2610 2611 2612
			};
		};

		/**
A
Alex Dima 已提交
2613
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
2614
		 *
2615
		 * @deprecated * Use the the autoClosingPairs property in the language configuration file instead.
E
Erich Gamma 已提交
2616 2617 2618 2619 2620 2621 2622 2623 2624 2625
		 */
		__characterPairSupport?: {
			autoClosingPairs: {
				open: string;
				close: string;
				notIn?: string[];
			}[];
		};
	}

J
Johannes Rieken 已提交
2626 2627 2628 2629 2630
	/**
	 * Represents the workspace configuration. The workspace configuration
	 * is always a merged view of the configuration of the current [workspace](#workspace.rootPath)
	 * and the installation-wide configuration.
	 */
E
Erich Gamma 已提交
2631 2632 2633
	export interface WorkspaceConfiguration {

		/**
J
Johannes Rieken 已提交
2634 2635 2636
		 * Return a value from this configuration.
		 *
		 * @param section Configuration name, supports _dotted_ names.
J
Johannes Rieken 已提交
2637
		 * @param defaultValue A value should be returned when no value could be found, is `undefined`.
J
Johannes Rieken 已提交
2638
		 * @return The value `section` denotes or the default.
E
Erich Gamma 已提交
2639 2640 2641 2642
		 */
		get<T>(section: string, defaultValue?: T): T;

		/**
J
Johannes Rieken 已提交
2643 2644
		 * Check if this configuration has a certain value.
		 *
2645
		 * @param section Configuration name, supports _dotted_ names.
A
Andre Weinand 已提交
2646
		 * @return `true` iff the section doesn't resolve to `undefined`.
E
Erich Gamma 已提交
2647 2648 2649 2650 2651 2652 2653 2654 2655 2656
		 */
		has(section: string): boolean;

		/**
		 * Readable dictionary that backs this configuration.
		 * @readonly
		 */
		[key: string]: any;
	}

J
Johannes Rieken 已提交
2657 2658 2659 2660 2661
	/**
	 * Represents a location inside a resource, such as a line
	 * inside a text file.
	 */
	export class Location {
J
Johannes Rieken 已提交
2662 2663 2664 2665

		/**
		 * The resource identifier of this location.
		 */
J
Johannes Rieken 已提交
2666
		uri: Uri;
J
Johannes Rieken 已提交
2667 2668 2669 2670

		/**
		 * The document range of this locations.
		 */
J
Johannes Rieken 已提交
2671
		range: Range;
J
Johannes Rieken 已提交
2672 2673 2674 2675 2676 2677 2678 2679

		/**
		 * 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 已提交
2680 2681
	}

E
Erich Gamma 已提交
2682 2683 2684 2685
	/**
	 * Represents the severity of diagnostics.
	 */
	export enum DiagnosticSeverity {
J
Johannes Rieken 已提交
2686 2687

		/**
S
Steven Clarke 已提交
2688
		 * Something not allowed by the rules of a language or other means.
J
Johannes Rieken 已提交
2689 2690 2691 2692 2693 2694
		 */
		Error = 0,

		/**
		 * Something suspicious but allowed.
		 */
E
Erich Gamma 已提交
2695
		Warning = 1,
J
Johannes Rieken 已提交
2696 2697 2698 2699 2700 2701 2702

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

		/**
A
Andre Weinand 已提交
2703
		 * Something to hint to a better way of doing it, like proposing
J
Johannes Rieken 已提交
2704 2705 2706
		 * a refactoring.
		 */
		Hint = 3
E
Erich Gamma 已提交
2707 2708 2709
	}

	/**
J
Johannes Rieken 已提交
2710 2711
	 * Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
	 * are only valid in the scope of a file.
E
Erich Gamma 已提交
2712
	 */
J
Johannes Rieken 已提交
2713 2714 2715 2716 2717
	export class Diagnostic {

		/**
		 * The range to which this diagnostic applies.
		 */
E
Erich Gamma 已提交
2718
		range: Range;
J
Johannes Rieken 已提交
2719 2720 2721 2722 2723 2724

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

2725 2726 2727 2728 2729 2730
		/**
		 * A human-readable string describing the source of this
		 * diagnostic, e.g. 'typescript' or 'super lint'.
		 */
		source: string;

J
Johannes Rieken 已提交
2731 2732 2733 2734 2735 2736
		/**
		 * The severity, default is [error](#DiagnosticSeverity.Error).
		 */
		severity: DiagnosticSeverity;

		/**
S
Steven Clarke 已提交
2737
		 * A code or identifier for this diagnostics. Will not be surfaced
A
Andre Weinand 已提交
2738
		 * to the user, but should be used for later processing, e.g. when
J
Johannes Rieken 已提交
2739 2740 2741 2742 2743
		 * providing [code actions](#CodeActionContext).
		 */
		code: string | number;

		/**
A
Andre Weinand 已提交
2744
		 * Creates a new diagnostic object.
J
Johannes Rieken 已提交
2745 2746 2747
		 *
		 * @param range The range to which this diagnostic applies.
		 * @param message The human-readable message.
A
Andre Weinand 已提交
2748
		 * @param severity The severity, default is [error](#DiagnosticSeverity.Error).
J
Johannes Rieken 已提交
2749 2750
		 */
		constructor(range: Range, message: string, severity?: DiagnosticSeverity);
E
Erich Gamma 已提交
2751 2752
	}

J
Johannes Rieken 已提交
2753 2754 2755
	/**
	 * A diagnostics collection is a container that manages a set of
	 * [diagnostics](#Diagnostic). Diagnostics are always scopes to a
2756
	 * diagnostics collection and a resource.
J
Johannes Rieken 已提交
2757 2758 2759 2760
	 *
	 * To get an instance of a `DiagnosticCollection` use
	 * [createDiagnosticCollection](#languages.createDiagnosticCollection).
	 */
E
Erich Gamma 已提交
2761 2762 2763
	export interface DiagnosticCollection {

		/**
J
Johannes Rieken 已提交
2764 2765 2766
		 * 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).
2767
		 * @readonly
E
Erich Gamma 已提交
2768 2769 2770 2771 2772
		 */
		name: string;

		/**
		 * Assign diagnostics for given resource. Will replace
J
Johannes Rieken 已提交
2773 2774 2775 2776
		 * existing diagnostics for that resource.
		 *
		 * @param uri A resource identifier.
		 * @param diagnostics Array of diagnostics or `undefined`
E
Erich Gamma 已提交
2777 2778 2779 2780
		 */
		set(uri: Uri, diagnostics: Diagnostic[]): void;

		/**
2781
		 * Replace all entries in this collection.
J
Johannes Rieken 已提交
2782
		 *
2783 2784 2785 2786 2787 2788
		 * 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 已提交
2789
		 */
2790
		set(entries: [Uri, Diagnostic[]][]): void;
E
Erich Gamma 已提交
2791 2792

		/**
2793 2794
		 * Remove all diagnostics from this collection that belong
		 * to the provided `uri`. The same as `#set(uri, undefined)`.
J
Johannes Rieken 已提交
2795
		 *
2796
		 * @param uri A resource identifier.
E
Erich Gamma 已提交
2797
		 */
2798
		delete(uri: Uri): void;
E
Erich Gamma 已提交
2799 2800 2801 2802 2803 2804 2805

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

2806 2807 2808 2809 2810 2811 2812 2813
		/**
		 * 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;

2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831
		/**
		 * 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`.
		 */
		get(uri: Uri): Diagnostic[];

		/**
		 * 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 已提交
2832 2833 2834 2835
		/**
		 * Dispose and free associated resources. Calls
		 * [clear](#DiagnosticCollection.clear).
		 */
E
Erich Gamma 已提交
2836 2837 2838
		dispose(): void;
	}

J
Johannes Rieken 已提交
2839
	/**
J
Johannes Rieken 已提交
2840 2841
	 * Denotes a column in the VS Code window. Columns are
	 * used to show editors side by side.
J
Johannes Rieken 已提交
2842 2843 2844 2845 2846 2847 2848
	 */
	export enum ViewColumn {
		One = 1,
		Two = 2,
		Three = 3
	}

E
Erich Gamma 已提交
2849
	/**
J
Johannes Rieken 已提交
2850 2851 2852 2853
	 * An output channel is a container for readonly textual information.
	 *
	 * To get an instance of an `OutputChannel` use
	 * [createOutputChannel](#window.createOutputChannel).
E
Erich Gamma 已提交
2854
	 */
J
Johannes Rieken 已提交
2855
	export interface OutputChannel {
E
Erich Gamma 已提交
2856

J
Johannes Rieken 已提交
2857 2858 2859 2860 2861
		/**
		 * The human-readable name of this output channel.
		 * @readonly
		 */
		name: string;
E
Erich Gamma 已提交
2862 2863

		/**
J
Johannes Rieken 已提交
2864
		 * Append the given value to the channel.
E
Erich Gamma 已提交
2865
		 *
J
Johannes Rieken 已提交
2866
		 * @param value A string, falsy values will not be printed.
E
Erich Gamma 已提交
2867
		 */
J
Johannes Rieken 已提交
2868
		append(value: string): void;
E
Erich Gamma 已提交
2869 2870

		/**
J
Johannes Rieken 已提交
2871 2872
		 * Append the given value and a line feed character
		 * to the channel.
E
Erich Gamma 已提交
2873
		 *
J
Johannes Rieken 已提交
2874
		 * @param value A string, falsy values will be printed.
E
Erich Gamma 已提交
2875 2876 2877
		 */
		appendLine(value: string): void;

J
Johannes Rieken 已提交
2878 2879 2880
		/**
		 * Removes all output from the channel.
		 */
E
Erich Gamma 已提交
2881 2882
		clear(): void;

J
Johannes Rieken 已提交
2883 2884
		/**
		 * Reveal this channel in the UI.
2885
		 *
2886
		 * @param preserveFocus When `true` the channel will not take focus.
J
Johannes Rieken 已提交
2887
		 */
J
Johannes Rieken 已提交
2888
		show(preserveFocus?: boolean): void;
E
Erich Gamma 已提交
2889

2890 2891 2892
		/**
		 * Reveal this channel in the UI.
		 *
J
Johannes Rieken 已提交
2893 2894 2895 2896
		 * @deprecated This method is **deprecated** and the overload with
		 * just one parameter should be used (`show(preserveFocus?: boolean): void`).
		 *
		 * @param column This argument is **deprecated** and will be ignored.
2897 2898
		 * @param preserveFocus When `true` the channel will not take focus.
		 */
J
Johannes Rieken 已提交
2899
		show(column?: ViewColumn, preserveFocus?: boolean): void;
2900

J
Johannes Rieken 已提交
2901 2902 2903
		/**
		 * Hide this channel from the UI.
		 */
E
Erich Gamma 已提交
2904 2905
		hide(): void;

J
Johannes Rieken 已提交
2906 2907 2908
		/**
		 * Dispose and free associated resources.
		 */
E
Erich Gamma 已提交
2909 2910 2911 2912
		dispose(): void;
	}

	/**
J
Johannes Rieken 已提交
2913
	 * Represents the alignment of status bar items.
E
Erich Gamma 已提交
2914 2915
	 */
	export enum StatusBarAlignment {
J
Johannes Rieken 已提交
2916 2917 2918 2919

		/**
		 * Aligned to the left side.
		 */
E
Erich Gamma 已提交
2920
		Left,
J
Johannes Rieken 已提交
2921 2922 2923 2924

		/**
		 * Aligned to the right side.
		 */
E
Erich Gamma 已提交
2925 2926 2927 2928 2929 2930 2931 2932 2933 2934
		Right
	}

	/**
	 * 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 已提交
2935 2936
		 * The alignment of this item.
		 *
E
Erich Gamma 已提交
2937 2938 2939 2940 2941
		 * @readonly
		 */
		alignment: StatusBarAlignment;

		/**
J
Johannes Rieken 已提交
2942 2943 2944
		 * The priority of this item. Higher value means the item should
		 * be shown more to the left.
		 *
E
Erich Gamma 已提交
2945 2946 2947 2948 2949
		 * @readonly
		 */
		priority: number;

		/**
J
Johannes Rieken 已提交
2950 2951
		 * The text to show for the entry. You can embed icons in the text by leveraging the syntax:
		 *
2952
		 * `My text $(icon-name) contains icons like $(icon'name) this one.`
J
Johannes Rieken 已提交
2953
		 *
2954 2955
		 * 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 已提交
2956
		 */
E
Erich Gamma 已提交
2957 2958 2959
		text: string;

		/**
J
Johannes Rieken 已提交
2960 2961
		 * The tooltip text when you hover over this entry.
		 */
E
Erich Gamma 已提交
2962 2963 2964
		tooltip: string;

		/**
J
Johannes Rieken 已提交
2965 2966
		 * The foreground color for this entry.
		 */
E
Erich Gamma 已提交
2967 2968 2969
		color: string;

		/**
J
Johannes Rieken 已提交
2970 2971 2972
		 * The identifier of a command to run on click. The command must be
		 * [known](#commands.getCommands).
		 */
E
Erich Gamma 已提交
2973 2974 2975 2976 2977 2978 2979 2980
		command: string;

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

		/**
J
Johannes Rieken 已提交
2981
		 * Hide the entry in the status bar.
E
Erich Gamma 已提交
2982 2983 2984 2985
		 */
		hide(): void;

		/**
J
Johannes Rieken 已提交
2986 2987
		 * Dispose and free associated resources. Call
		 * [hide](#StatusBarItem.hide).
E
Erich Gamma 已提交
2988 2989 2990 2991
		 */
		dispose(): void;
	}

D
Daniel Imms 已提交
2992 2993 2994
	/**
	 * An individual terminal instance within the integrated terminal.
	 */
D
Daniel Imms 已提交
2995
	export interface Terminal {
D
Daniel Imms 已提交
2996

2997 2998 2999 3000 3001 3002 3003
		/**
		 * The name of the terminal.
		 *
		 * @readonly
		 */
		name: string;

D
Daniel Imms 已提交
3004
		/**
D
Daniel Imms 已提交
3005
		 * Send text to the terminal. The text is written to the stdin of the underlying pty process
3006 3007 3008
		 * (shell) of the terminal. Note that this will currently force the terminal panel to the
		 * foreground, this is changing in v1.6 such that it will require an explicit call to
		 * [Terminal.show](#Terminal.show) in order to show the terminal panel.
D
Daniel Imms 已提交
3009
		 *
D
Daniel Imms 已提交
3010
		 * @param text The text to send.
D
Daniel Imms 已提交
3011
		 * @param addNewLine Whether to add a new line to the text being sent, this is normally
3012 3013
		 * 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 已提交
3014
		 */
3015
		sendText(text: string, addNewLine?: boolean): void;
D
Daniel Imms 已提交
3016 3017

		/**
D
Daniel Imms 已提交
3018
		 * Show the terminal panel and reveal this terminal in the UI.
D
Daniel Imms 已提交
3019
		 *
D
Daniel Imms 已提交
3020
		 * @param preserveFocus When `true` the terminal will not take focus.
D
Daniel Imms 已提交
3021
		 */
D
Daniel Imms 已提交
3022
		show(preserveFocus?: boolean): void;
D
Daniel Imms 已提交
3023 3024

		/**
D
Daniel Imms 已提交
3025
		 * Hide the terminal panel if this terminal is currently showing.
D
Daniel Imms 已提交
3026 3027 3028 3029 3030 3031 3032
		 */
		hide(): void;

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

J
Johannes Rieken 已提交
3035 3036 3037
	/**
	 * Represents an extension.
	 *
A
Alex Dima 已提交
3038
	 * To get an instance of an `Extension` use [getExtension](#extensions.getExtension).
J
Johannes Rieken 已提交
3039
	 */
E
Erich Gamma 已提交
3040
	export interface Extension<T> {
J
Johannes Rieken 已提交
3041

E
Erich Gamma 已提交
3042
		/**
J
Johannes Rieken 已提交
3043
		 * The canonical extension identifier in the form of: `publisher.name`.
3044 3045
		 *
		 * @readonly
E
Erich Gamma 已提交
3046 3047 3048 3049
		 */
		id: string;

		/**
J
Johannes Rieken 已提交
3050
		 * The absolute file path of the directory containing this extension.
3051 3052
		 *
		 * @readonly
E
Erich Gamma 已提交
3053 3054 3055 3056
		 */
		extensionPath: string;

		/**
3057 3058 3059
		 * `true` if the extension has been activated.
		 *
		 * @readonly
E
Erich Gamma 已提交
3060 3061 3062 3063 3064
		 */
		isActive: boolean;

		/**
		 * The parsed contents of the extension's package.json.
3065 3066
		 *
		 * @readonly
E
Erich Gamma 已提交
3067 3068 3069 3070
		 */
		packageJSON: any;

		/**
A
Alex Dima 已提交
3071
		 * The public API exported by this extension. It is an invalid action
J
Johannes Rieken 已提交
3072
		 * to access this field before this extension has been activated.
3073 3074
		 *
		 * @readonly
E
Erich Gamma 已提交
3075 3076 3077 3078 3079
		 */
		exports: T;

		/**
		 * Activates this extension and returns its public API.
J
Johannes Rieken 已提交
3080
		 *
S
Steven Clarke 已提交
3081
		 * @return A promise that will resolve when this extension has been activated.
E
Erich Gamma 已提交
3082 3083 3084 3085
		 */
		activate(): Thenable<T>;
	}

J
Johannes Rieken 已提交
3086
	/**
S
Steven Clarke 已提交
3087 3088
	 * An extension context is a collection of utilities private to an
	 * extension.
J
Johannes Rieken 已提交
3089
	 *
S
Steven Clarke 已提交
3090
	 * An instance of an `ExtensionContext` is provided as the first
J
Johannes Rieken 已提交
3091 3092
	 * parameter to the `activate`-call of an extension.
	 */
E
Erich Gamma 已提交
3093 3094 3095 3096
	export interface ExtensionContext {

		/**
		 * An array to which disposables can be added. When this
J
Johannes Rieken 已提交
3097
		 * extension is deactivated the disposables will be disposed.
E
Erich Gamma 已提交
3098 3099 3100 3101 3102
		 */
		subscriptions: { dispose(): any }[];

		/**
		 * A memento object that stores state in the context
3103
		 * of the currently opened [workspace](#workspace.rootPath).
E
Erich Gamma 已提交
3104 3105 3106 3107 3108
		 */
		workspaceState: Memento;

		/**
		 * A memento object that stores state independent
3109
		 * of the current opened [workspace](#workspace.rootPath).
E
Erich Gamma 已提交
3110 3111 3112 3113
		 */
		globalState: Memento;

		/**
J
Johannes Rieken 已提交
3114
		 * The absolute file path of the directory containing the extension.
E
Erich Gamma 已提交
3115 3116 3117 3118
		 */
		extensionPath: string;

		/**
A
Alex Dima 已提交
3119 3120 3121 3122
		 * 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 已提交
3123 3124
		 */
		asAbsolutePath(relativePath: string): string;
D
Dirk Baeumer 已提交
3125 3126

		/**
J
Johannes Rieken 已提交
3127 3128 3129
		 * 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 已提交
3130
		 *
J
Johannes Rieken 已提交
3131 3132
		 * Use [`workspaceState`](ExtensionContext#workspaceState) or
		 * [`globalState`](ExtensionContext#globalState) to store key value data.
D
Dirk Baeumer 已提交
3133 3134
		 */
		storagePath: string;
E
Erich Gamma 已提交
3135 3136 3137 3138 3139 3140 3141 3142 3143
	}

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

		/**
J
Johannes Rieken 已提交
3144 3145 3146 3147 3148
		 * 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.
A
Andre Weinand 已提交
3149
		 * @return The stored value, `undefined`, or the defaultValue.
E
Erich Gamma 已提交
3150 3151 3152 3153
		 */
		get<T>(key: string, defaultValue?: T): T;

		/**
S
Steven Clarke 已提交
3154
		 * Store a value. The value must be JSON-stringifyable.
J
Johannes Rieken 已提交
3155 3156 3157
		 *
		 * @param key A string.
		 * @param value A value. MUST not contain cyclic references.
E
Erich Gamma 已提交
3158 3159 3160 3161
		 */
		update(key: string, value: any): Thenable<void>;
	}

3162 3163 3164 3165 3166
	/**
	 * Namespace describing the environment the editor runs in.
	 */
	export namespace env {

3167 3168 3169 3170 3171 3172 3173
		/**
		 * The application name of the editor, like 'VS Code'.
		 *
		 * @readonly
		 */
		export let appName: string;

J
Johannes Rieken 已提交
3174 3175 3176 3177 3178 3179 3180
		/**
		 * Represents the preferred user-language, like `de-CH`, `fr`, or `en-US`.
		 *
		 * @readonly
		 */
		export let language: string;

3181 3182
		/**
		 * A unique identifier for the computer.
J
Johannes Rieken 已提交
3183 3184
		 *
		 * @readonly
3185 3186 3187 3188 3189 3190
		 */
		export let machineId: string;

		/**
		 * A unique identifier for the current session.
		 * Changes each time the editor is started.
J
Johannes Rieken 已提交
3191 3192
		 *
		 * @readonly
3193 3194 3195 3196
		 */
		export let sessionId: string;
	}

E
Erich Gamma 已提交
3197
	/**
3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210
	 * 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
	 * the [command palette](https://code.visualstudio.com/docs/editor/codebasics#_command-palette).
	 * * keybinding - Use the `keybindings`-section in `package.json` to enable
	 * [keybindings](https://code.visualstudio.com/docs/customization/keybindings#_customizing-shortcuts)
	 * for your extension.
	 *
S
Steven Clarke 已提交
3211
	 * Commands from other extensions and from the editor itself are accessible to an extension. However,
3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230
	 * 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
	 * register a command handler with the identfier `extension.sayHello`.
	 * ```javascript
	 * commands.registerCommand('extension.sayHello', () => {
	 * 		window.showInformationMessage('Hello World!');
	 * });
	 * ```
	 * Second, bind the command identfier to a title under which it will show in the palette (`package.json`).
	 * ```json
	 * {
	 * "contributes": {
	 * 		"commands": [{
	 * 		"command": "extension.sayHello",
	 * 		"title": "Hello World"
	 * 	}]
	 * }
	 * ```
E
Erich Gamma 已提交
3231 3232 3233 3234 3235
	 */
	export namespace commands {

		/**
		 * Registers a command that can be invoked via a keyboard shortcut,
S
Steven Clarke 已提交
3236
		 * a menu item, an action, or directly.
E
Erich Gamma 已提交
3237
		 *
J
Johannes Rieken 已提交
3238 3239 3240 3241 3242
		 * 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 已提交
3243
		 * @param thisArg The `this` context used when invoking the handler function.
J
Johannes Rieken 已提交
3244
		 * @return Disposable which unregisters this command on disposal.
E
Erich Gamma 已提交
3245 3246 3247 3248
		 */
		export function registerCommand(command: string, callback: (...args: any[]) => any, thisArg?: any): Disposable;

		/**
J
Johannes Rieken 已提交
3249
		 * Registers a text editor command that can be invoked via a keyboard shortcut,
S
Steven Clarke 已提交
3250
		 * a menu item, an action, or directly.
E
Erich Gamma 已提交
3251
		 *
J
Johannes Rieken 已提交
3252
		 * Text editor commands are different from ordinary [commands](#commands.registerCommand) as
S
Steven Clarke 已提交
3253
		 * they only execute when there is an active editor when the command is called. Also, the
J
Johannes Rieken 已提交
3254 3255 3256 3257 3258
		 * 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 已提交
3259
		 * @param thisArg The `this` context used when invoking the handler function.
J
Johannes Rieken 已提交
3260
		 * @return Disposable which unregisters this command on disposal.
E
Erich Gamma 已提交
3261
		 */
J
Johannes Rieken 已提交
3262
		export function registerTextEditorCommand(command: string, callback: (textEditor: TextEditor, edit: TextEditorEdit, ...args: any[]) => void, thisArg?: any): Disposable;
E
Erich Gamma 已提交
3263 3264

		/**
J
Johannes Rieken 已提交
3265 3266 3267
		 * Executes the command denoted by the given command identifier.
		 *
		 * When executing an editor command not all types are allowed to
3268
		 * be passed as arguments. Allowed are the primitive types `string`, `boolean`,
J
Johannes Rieken 已提交
3269
		 * `number`, `undefined`, and `null`, as well as classes defined in this API.
S
Steven Clarke 已提交
3270
		 * There are no restrictions when executing commands that have been contributed
J
Johannes Rieken 已提交
3271
		 * by extensions.
E
Erich Gamma 已提交
3272
		 *
J
Johannes Rieken 已提交
3273
		 * @param command Identifier of the command to execute.
J
Johannes Rieken 已提交
3274 3275 3276
		 * @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 已提交
3277 3278 3279 3280
		 */
		export function executeCommand<T>(command: string, ...rest: any[]): Thenable<T>;

		/**
3281 3282
		 * Retrieve the list of all available commands. Commands starting an underscore are
		 * treated as internal commands.
E
Erich Gamma 已提交
3283
		 *
3284
		 * @param filterInternal Set `true` to not see internal commands (starting with an underscore)
E
Erich Gamma 已提交
3285 3286
		 * @return Thenable that resolves to a list of command ids.
		 */
3287
		export function getCommands(filterInternal?: boolean): Thenable<string[]>;
E
Erich Gamma 已提交
3288 3289 3290
	}

	/**
3291 3292 3293
	 * 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 已提交
3294 3295 3296 3297
	 */
	export namespace window {

		/**
3298
		 * The currently active editor or `undefined`. The active editor is the one
S
Steven Clarke 已提交
3299
		 * that currently has focus or, when none has focus, the one that has changed
E
Erich Gamma 已提交
3300 3301 3302 3303 3304
		 * input most recently.
		 */
		export let activeTextEditor: TextEditor;

		/**
3305
		 * The currently visible editors or an empty array.
E
Erich Gamma 已提交
3306 3307 3308 3309
		 */
		export let visibleTextEditors: TextEditor[];

		/**
3310
		 * An [event](#Event) which fires when the [active editor](#window.activeTextEditor)
J
Johannes Rieken 已提交
3311
		 * has changed. *Note* that the event also fires when the active editor changes
3312
		 * to `undefined`.
E
Erich Gamma 已提交
3313 3314 3315 3316
		 */
		export const onDidChangeActiveTextEditor: Event<TextEditor>;

		/**
A
Andre Weinand 已提交
3317
		 * An [event](#Event) which fires when the selection in an editor has changed.
E
Erich Gamma 已提交
3318 3319 3320 3321 3322 3323 3324 3325
		 */
		export const onDidChangeTextEditorSelection: Event<TextEditorSelectionChangeEvent>;

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

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

E
Erich Gamma 已提交
3331 3332 3333 3334 3335 3336 3337
		/**
		 * 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)__.
3338
		 * @param preserveFocus When `true` the editor will not take focus.
E
Erich Gamma 已提交
3339 3340
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
3341
		export function showTextDocument(document: TextDocument, column?: ViewColumn, preserveFocus?: boolean): Thenable<TextEditor>;
E
Erich Gamma 已提交
3342 3343

		/**
J
Johannes Rieken 已提交
3344 3345 3346 3347
		 * 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 已提交
3348 3349 3350 3351 3352 3353 3354
		 */
		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 已提交
3355 3356
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
3357
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
3358 3359 3360 3361
		 */
		export function showInformationMessage(message: string, ...items: string[]): Thenable<string>;

		/**
J
Johannes Rieken 已提交
3362
		 * Show an information message.
J
Johannes Rieken 已提交
3363
		 *
E
Erich Gamma 已提交
3364
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
3365 3366 3367
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
3368
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
3369 3370 3371 3372
		 */
		export function showInformationMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T>;

		/**
J
Johannes Rieken 已提交
3373
		 * Show a warning message.
J
Johannes Rieken 已提交
3374
		 *
E
Erich Gamma 已提交
3375
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
3376 3377 3378
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
3379
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
3380 3381 3382 3383
		 */
		export function showWarningMessage(message: string, ...items: string[]): Thenable<string>;

		/**
J
Johannes Rieken 已提交
3384
		 * Show a warning message.
J
Johannes Rieken 已提交
3385
		 *
E
Erich Gamma 已提交
3386
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
3387 3388 3389
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
3390
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
3391 3392 3393 3394
		 */
		export function showWarningMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T>;

		/**
J
Johannes Rieken 已提交
3395
		 * Show an error message.
J
Johannes Rieken 已提交
3396
		 *
E
Erich Gamma 已提交
3397
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
3398 3399 3400
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
3401
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
3402 3403 3404 3405
		 */
		export function showErrorMessage(message: string, ...items: string[]): Thenable<string>;

		/**
J
Johannes Rieken 已提交
3406
		 * Show an error message.
J
Johannes Rieken 已提交
3407
		 *
E
Erich Gamma 已提交
3408
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
3409 3410 3411
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
3412
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
3413 3414 3415 3416 3417 3418
		 */
		export function showErrorMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T>;

		/**
		 * Shows a selection list.
		 *
J
Johannes Rieken 已提交
3419 3420
		 * @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.
3421
		 * @param token A token that can be used to signal cancellation.
J
Johannes Rieken 已提交
3422
		 * @return A promise that resolves to the selection or undefined.
E
Erich Gamma 已提交
3423
		 */
3424
		export function showQuickPick(items: string[] | Thenable<string[]>, options?: QuickPickOptions, token?: CancellationToken): Thenable<string>;
E
Erich Gamma 已提交
3425 3426 3427 3428

		/**
		 * Shows a selection list.
		 *
J
Johannes Rieken 已提交
3429 3430
		 * @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.
3431
		 * @param token A token that can be used to signal cancellation.
J
Johannes Rieken 已提交
3432
		 * @return A promise that resolves to the selected item or undefined.
E
Erich Gamma 已提交
3433
		 */
3434
		export function showQuickPick<T extends QuickPickItem>(items: T[] | Thenable<T[]>, options?: QuickPickOptions, token?: CancellationToken): Thenable<T>;
E
Erich Gamma 已提交
3435 3436 3437 3438

		/**
		 * Opens an input box to ask the user for input.
		 *
S
Steven Clarke 已提交
3439
		 * The returned value will be undefined if the input box was canceled (e.g. pressing ESC). Otherwise the
A
Andre Weinand 已提交
3440
		 * returned value will be the string typed by the user or an empty string if the user did not type
S
Steven Clarke 已提交
3441
		 * anything but dismissed the input box with OK.
E
Erich Gamma 已提交
3442
		 *
J
Johannes Rieken 已提交
3443
		 * @param options Configures the behavior of the input box.
3444
		 * @param token A token that can be used to signal cancellation.
J
Johannes Rieken 已提交
3445
		 * @return A promise that resolves to a string the user provided or to `undefined` in case of dismissal.
E
Erich Gamma 已提交
3446
		 */
3447
		export function showInputBox(options?: InputBoxOptions, token?: CancellationToken): Thenable<string>;
E
Erich Gamma 已提交
3448 3449

		/**
J
Johannes Rieken 已提交
3450 3451
		 * Create a new [output channel](#OutputChannel) with the given name.
		 *
3452
		 * @param name Human-readable string which will be used to represent the channel in the UI.
E
Erich Gamma 已提交
3453
		 */
3454
		export function createOutputChannel(name: string): OutputChannel;
E
Erich Gamma 已提交
3455 3456

		/**
S
Steven Clarke 已提交
3457
		 * Set a message to the status bar. This is a short hand for the more powerful
E
Erich Gamma 已提交
3458
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
3459
		 *
A
Andre Weinand 已提交
3460
		 * @param text The message to show, support icon subtitution as in status bar [items](#StatusBarItem.text).
J
Johannes Rieken 已提交
3461
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
3462 3463 3464 3465
		 */
		export function setStatusBarMessage(text: string): Disposable;

		/**
S
Steven Clarke 已提交
3466
		 * Set a message to the status bar. This is a short hand for the more powerful
J
Johannes Rieken 已提交
3467
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
3468
		 *
A
Andre Weinand 已提交
3469
		 * @param text The message to show, support icon subtitution as in status bar [items](#StatusBarItem.text).
E
Erich Gamma 已提交
3470
		 * @param hideAfterTimeout Timeout in milliseconds after which the message will be disposed.
J
Johannes Rieken 已提交
3471
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
3472 3473 3474 3475
		 */
		export function setStatusBarMessage(text: string, hideAfterTimeout: number): Disposable;

		/**
S
Steven Clarke 已提交
3476
		 * Set a message to the status bar. This is a short hand for the more powerful
J
Johannes Rieken 已提交
3477
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
3478
		 *
A
Andre Weinand 已提交
3479
		 * @param text The message to show, support icon subtitution as in status bar [items](#StatusBarItem.text).
E
Erich Gamma 已提交
3480
		 * @param hideWhenDone Thenable on which completion (resolve or reject) the message will be disposed.
J
Johannes Rieken 已提交
3481
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
3482 3483 3484 3485
		 */
		export function setStatusBarMessage(text: string, hideWhenDone: Thenable<any>): Disposable;

		/**
J
Johannes Rieken 已提交
3486 3487
		 * Creates a status bar [item](#StatusBarItem).
		 *
J
Johannes Rieken 已提交
3488
		 * @param alignment The alignment of the item.
J
Johannes Rieken 已提交
3489
		 * @param priority The priority of the item. Higher values mean the item should be shown more to the left.
J
Johannes Rieken 已提交
3490 3491
		 * @return A new status bar item.
		 */
E
Erich Gamma 已提交
3492
		export function createStatusBarItem(alignment?: StatusBarAlignment, priority?: number): StatusBarItem;
D
Daniel Imms 已提交
3493

D
Daniel Imms 已提交
3494
		/**
3495 3496 3497
		 * Creates a [Terminal](#Terminal). Note that this will currently force the terminal panel
		 * to the foreground, this is changing in v1.6 such that it will require an explicit call to
		 * [Terminal.show](#Terminal.show) in order to show the terminal panel.
D
Daniel Imms 已提交
3498
		 *
3499
		 * @param name Optional human-readable string which will be used to represent the terminal in the UI.
3500
		 * @param shellPath Optional path to a custom shell executable to be used in the terminal.
D
Daniel Imms 已提交
3501 3502
		 * @return A new Terminal.
		 */
3503
		export function createTerminal(name?: string, shellPath?: string): Terminal;
E
Erich Gamma 已提交
3504 3505 3506
	}

	/**
A
Alex Dima 已提交
3507
	 * An event describing an individual change in the text of a [document](#TextDocument).
E
Erich Gamma 已提交
3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524
	 */
	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 已提交
3525
	 * An event describing a transactional [document](#TextDocument) change.
E
Erich Gamma 已提交
3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540
	 */
	export interface TextDocumentChangeEvent {

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

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

	/**
3541 3542 3543 3544 3545
	 * 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
3546
	 * events and for [finding](#workspace.findFiles) files. Both perform well and run _outside_
S
Steven Clarke 已提交
3547
	 * the editor-process so that they should be always used instead of nodejs-equivalents.
E
Erich Gamma 已提交
3548 3549 3550 3551
	 */
	export namespace workspace {

		/**
J
Johannes Rieken 已提交
3552 3553 3554
		 * Creates a file system watcher.
		 *
		 * A glob pattern that filters the file events must be provided. Optionally, flags to ignore certain
S
Steven Clarke 已提交
3555
		 * kinds of events can be provided. To stop listening to events the watcher must be disposed.
E
Erich Gamma 已提交
3556
		 *
A
Andre Weinand 已提交
3557
		 * @param globPattern A glob pattern that is applied to the names of created, changed, and deleted files.
J
Johannes Rieken 已提交
3558 3559 3560 3561
		 * @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.
E
Erich Gamma 已提交
3562 3563 3564 3565
		 */
		export function createFileSystemWatcher(globPattern: string, ignoreCreateEvents?: boolean, ignoreChangeEvents?: boolean, ignoreDeleteEvents?: boolean): FileSystemWatcher;

		/**
J
Johannes Rieken 已提交
3566 3567
		 * The folder that is open in VS Code. `undefined` when no folder
		 * has been opened.
3568
		 *
S
Steve Baker 已提交
3569
		 * @readonly
E
Erich Gamma 已提交
3570 3571 3572 3573
		 */
		export let rootPath: string;

		/**
J
Johannes Rieken 已提交
3574 3575 3576 3577 3578 3579 3580
		 * Returns a path that is relative to the workspace root.
		 *
		 * When there is no [workspace root](#workspace.rootPath) or when the path
		 * is not a child of that folder, the input is returned.
		 *
		 * @param pathOrUri A path or uri. When a uri is given its [fsPath](#Uri.fsPath) is used.
		 * @return A path relative to the root or the input.
E
Erich Gamma 已提交
3581 3582 3583
		 */
		export function asRelativePath(pathOrUri: string | Uri): string;

J
Johannes Rieken 已提交
3584 3585 3586
		/**
		 * Find files in the workspace.
		 *
3587
		 * @sample `findFiles('**∕*.js', '**∕node_modules∕**', 10)`
J
Johannes Rieken 已提交
3588
		 * @param include A glob pattern that defines the files to search for.
S
Steven Clarke 已提交
3589
		 * @param exclude A glob pattern that defines files and folders to exclude.
J
Johannes Rieken 已提交
3590
		 * @param maxResults An upper-bound for the result.
3591
		 * @param token A token that can be used to signal cancellation to the underlying search engine.
J
Johannes Rieken 已提交
3592 3593
		 * @return A thenable that resolves to an array of resource identifiers.
		 */
3594
		export function findFiles(include: string, exclude: string, maxResults?: number, token?: CancellationToken): Thenable<Uri[]>;
E
Erich Gamma 已提交
3595 3596

		/**
J
Johannes Rieken 已提交
3597 3598 3599
		 * Save all dirty files.
		 *
		 * @param includeUntitled Also save files that have been created during this session.
S
Steven Clarke 已提交
3600
		 * @return A thenable that resolves when the files have been saved.
E
Erich Gamma 已提交
3601 3602 3603 3604
		 */
		export function saveAll(includeUntitled?: boolean): Thenable<boolean>;

		/**
J
Johannes Rieken 已提交
3605 3606 3607
		 * Make changes to one or many resources as defined by the given
		 * [workspace edit](#WorkspaceEdit).
		 *
S
Steven Clarke 已提交
3608 3609 3610
		 * 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 已提交
3611 3612 3613
		 *
		 * @param edit A workspace edit.
		 * @return A thenable that resolves when the edit could be applied.
E
Erich Gamma 已提交
3614 3615 3616 3617 3618
		 */
		export function applyEdit(edit: WorkspaceEdit): Thenable<boolean>;

		/**
		 * All text documents currently known to the system.
J
Johannes Rieken 已提交
3619 3620
		 *
		 * @readonly
E
Erich Gamma 已提交
3621 3622 3623 3624 3625 3626 3627 3628
		 */
		export let textDocuments: TextDocument[];

		/**
		 * Opens the denoted document from disk. Will return early if the
		 * document is already open, otherwise the document is loaded and the
		 * [open document](#workspace.onDidOpenTextDocument)-event fires.
		 * The document to open is denoted by the [uri](#Uri). Two schemes are supported:
J
Johannes Rieken 已提交
3629
		 *
3630 3631
		 * file: A file on disk, will be rejected if the file does not exist or cannot be loaded, e.g. `file:///Users/frodo/r.ini`.
		 * untitled: A new file that should be saved on disk, e.g. `untitled:c:\frodo\new.js`. The language will be derived from the file name.
J
Johannes Rieken 已提交
3632
		 *
A
Andre Weinand 已提交
3633
		 * Uris with other schemes will make this method return a rejected promise.
E
Erich Gamma 已提交
3634 3635 3636 3637 3638 3639 3640
		 *
		 * @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 已提交
3641 3642 3643
		 * A short-hand for `openTextDocument(Uri.file(fileName))`.
		 *
		 * @see [openTextDocument](#openTextDocument)
A
Andre Weinand 已提交
3644 3645
		 * @param fileName A name of a file on disk.
		 * @return A promise that resolves to a [document](#TextDocument).
E
Erich Gamma 已提交
3646 3647 3648
		 */
		export function openTextDocument(fileName: string): Thenable<TextDocument>;

J
Johannes Rieken 已提交
3649
		/**
3650 3651 3652
		 * Register a text document content provider.
		 *
		 * Only one provider can be registered per scheme.
J
Johannes Rieken 已提交
3653
		 *
3654 3655 3656
		 * @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 已提交
3657 3658 3659
		 */
		export function registerTextDocumentContentProvider(scheme: string, provider: TextDocumentContentProvider): Disposable;

A
Alex Dima 已提交
3660
		/**
J
Johannes Rieken 已提交
3661
		 * An event that is emitted when a [text document](#TextDocument) is opened.
A
Alex Dima 已提交
3662
		 */
E
Erich Gamma 已提交
3663 3664
		export const onDidOpenTextDocument: Event<TextDocument>;

A
Alex Dima 已提交
3665 3666 3667
		/**
		 * An event that is emitted when a [text document](#TextDocument) is disposed.
		 */
E
Erich Gamma 已提交
3668 3669
		export const onDidCloseTextDocument: Event<TextDocument>;

A
Alex Dima 已提交
3670 3671 3672
		/**
		 * An event that is emitted when a [text document](#TextDocument) is changed.
		 */
E
Erich Gamma 已提交
3673 3674
		export const onDidChangeTextDocument: Event<TextDocumentChangeEvent>;

A
Alex Dima 已提交
3675 3676 3677
		/**
		 * An event that is emitted when a [text document](#TextDocument) is saved to disk.
		 */
E
Erich Gamma 已提交
3678 3679 3680
		export const onDidSaveTextDocument: Event<TextDocument>;

		/**
J
Johannes Rieken 已提交
3681 3682 3683
		 * Get a configuration object.
		 *
		 * When a section-identifier is provided only that part of the configuration
A
Andre Weinand 已提交
3684
		 * is returned. Dots in the section-identifier are interpreted as child-access,
J
Johannes Rieken 已提交
3685
		 * like `{ myExt: { setting: { doIt: true }}}` and `getConfiguration('myExt.setting.doIt') === true`.
E
Erich Gamma 已提交
3686
		 *
J
Johannes Rieken 已提交
3687 3688 3689
		 *
		 * @param section A dot-separated identifier.
		 * @return The full workspace configuration or a subset.
E
Erich Gamma 已提交
3690 3691 3692
		 */
		export function getConfiguration(section?: string): WorkspaceConfiguration;

J
Johannes Rieken 已提交
3693 3694 3695
		/**
		 * An event that is emitted when the [configuration](#WorkspaceConfiguration) changed.
		 */
E
Erich Gamma 已提交
3696 3697 3698
		export const onDidChangeConfiguration: Event<void>;
	}

J
Johannes Rieken 已提交
3699
	/**
3700 3701 3702 3703 3704 3705 3706
	 * 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 已提交
3707
	 * The editor provides an API that makes it simple to provide such common features by having all UI and actions already in place and
3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718
	 * 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', {
	 * 		provideHover(document, position, token) {
	 * 			return new Hover('I am a hover!');
	 * 		}
	 * });
	 * ```
3719 3720 3721
	 *
	 * 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 已提交
3722
	 * a selector will result in a [score](#languages.match) that is used to determine if and how a provider shall be used. When
3723 3724 3725
	 * 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 已提交
3726
	 */
E
Erich Gamma 已提交
3727 3728 3729 3730 3731 3732 3733 3734 3735
	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 已提交
3736
		 * Compute the match between a document [selector](#DocumentSelector) and a document. Values
S
Steven Clarke 已提交
3737
		 * greater than zero mean the selector matches the document. The more individual matches a selector
3738 3739 3740
		 * and a document have, the higher the score is. These are the abstract rules given a `selector`:
		 *
		 * ```
S
Steven Clarke 已提交
3741
		 * (1) When selector is an array, return the maximum individual result.
3742 3743 3744 3745
		 * (2) When selector is a string match that against the [languageId](#TextDocument.languageId).
		 * 	(2.1) When both are equal score is `10`,
		 * 	(2.2) When the selector is `*` score is `5`,
		 * 	(2.3) Else score is `0`.
3746
		 * (3) When selector is a [filter](#DocumentFilter) return the maximum individual score given that each score is `>0`.
3747
		 *	(3.1) When [language](#DocumentFilter.language) is set apply rules from #2, when `0` the total score is `0`.
3748 3749
		 *	(3.2) When [scheme](#DocumentFilter.scheme) is set and equals the [uri](#TextDocument.uri)-scheme score with `10`, else the total score is `0`.
		 *	(3.3) When [pattern](#DocumentFilter.pattern) is set
3750 3751
		 * 		(3.3.1) pattern equals the [uri](#TextDocument.uri)-fsPath score with `10`,
		 *		(3.3.1) if the pattern matches as glob-pattern score with `5`,
3752 3753
		 *		(3.3.1) the total score is `0`
		 * ```
J
Johannes Rieken 已提交
3754 3755 3756
		 *
		 * @param selector A document selector.
		 * @param document A text document.
J
Johannes Rieken 已提交
3757
		 * @return A number `>0` when the selector matches and `0` when the selector does not match.
E
Erich Gamma 已提交
3758 3759 3760 3761
		 */
		export function match(selector: DocumentSelector, document: TextDocument): number;

		/**
S
Steven Clarke 已提交
3762
		 * Create a diagnostics collection.
J
Johannes Rieken 已提交
3763 3764 3765
		 *
		 * @param name The [name](#DiagnosticCollection.name) of the collection.
		 * @return A new diagnostic collection.
E
Erich Gamma 已提交
3766 3767 3768 3769
		 */
		export function createDiagnosticCollection(name?: string): DiagnosticCollection;

		/**
J
Johannes Rieken 已提交
3770 3771 3772
		 * Register a completion provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
3773
		 * by their [score](#languages.match) and groups of equal score are sequentially asked for
J
Johannes Rieken 已提交
3774
		 * completion items. The process stops when one or many providers of a group return a
3775 3776
		 * result. A failing provider (rejected promise or exception) will not fail the whole
		 * operation.
E
Erich Gamma 已提交
3777
		 *
J
Johannes Rieken 已提交
3778 3779 3780 3781 3782 3783 3784 3785
		 * @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 已提交
3786 3787 3788
		 * Register a code action provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
3789 3790
		 * 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 已提交
3791 3792
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
J
Johannes Rieken 已提交
3793
		 * @param provider A code action provider.
J
Johannes Rieken 已提交
3794
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
3795
		 */
J
Johannes Rieken 已提交
3796
		export function registerCodeActionsProvider(selector: DocumentSelector, provider: CodeActionProvider): Disposable;
E
Erich Gamma 已提交
3797 3798

		/**
J
Johannes Rieken 已提交
3799 3800 3801
		 * Register a code lens provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
3802 3803
		 * 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 已提交
3804
		 *
J
Johannes Rieken 已提交
3805 3806 3807
		 * @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 已提交
3808
		 */
J
Johannes Rieken 已提交
3809
		export function registerCodeLensProvider(selector: DocumentSelector, provider: CodeLensProvider): Disposable;
E
Erich Gamma 已提交
3810 3811

		/**
J
Johannes Rieken 已提交
3812 3813 3814
		 * Register a definition provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
3815 3816
		 * 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 已提交
3817
		 *
J
Johannes Rieken 已提交
3818 3819 3820
		 * @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 已提交
3821 3822 3823 3824
		 */
		export function registerDefinitionProvider(selector: DocumentSelector, provider: DefinitionProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3825 3826 3827
		 * Register a hover provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
3828 3829
		 * 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 已提交
3830
		 *
J
Johannes Rieken 已提交
3831 3832 3833
		 * @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 已提交
3834 3835 3836 3837
		 */
		export function registerHoverProvider(selector: DocumentSelector, provider: HoverProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3838 3839 3840 3841
		 * 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.
3842
		 * The process stops when a provider returns a `non-falsy` or `non-failure` result.
E
Erich Gamma 已提交
3843
		 *
J
Johannes Rieken 已提交
3844 3845 3846
		 * @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 已提交
3847 3848 3849 3850
		 */
		export function registerDocumentHighlightProvider(selector: DocumentSelector, provider: DocumentHighlightProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3851 3852 3853
		 * Register a document symbol provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
3854 3855
		 * 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 已提交
3856
		 *
J
Johannes Rieken 已提交
3857 3858 3859
		 * @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 已提交
3860 3861 3862 3863
		 */
		export function registerDocumentSymbolProvider(selector: DocumentSelector, provider: DocumentSymbolProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3864 3865
		 * Register a workspace symbol provider.
		 *
3866 3867 3868
		 * 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 已提交
3869
		 *
J
Johannes Rieken 已提交
3870 3871
		 * @param provider A workspace symbol provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
3872 3873 3874 3875
		 */
		export function registerWorkspaceSymbolProvider(provider: WorkspaceSymbolProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3876 3877 3878
		 * Register a reference provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
3879 3880
		 * 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 已提交
3881
		 *
J
Johannes Rieken 已提交
3882 3883 3884
		 * @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 已提交
3885 3886 3887 3888
		 */
		export function registerReferenceProvider(selector: DocumentSelector, provider: ReferenceProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3889 3890 3891
		 * Register a reference provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
3892
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
3893
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
3894
		 *
J
Johannes Rieken 已提交
3895 3896 3897
		 * @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 已提交
3898 3899 3900 3901
		 */
		export function registerRenameProvider(selector: DocumentSelector, provider: RenameProvider): Disposable;

		/**
A
Andre Weinand 已提交
3902
		 * Register a formatting provider for a document.
J
Johannes Rieken 已提交
3903 3904
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
3905
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
3906
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
3907
		 *
J
Johannes Rieken 已提交
3908 3909 3910
		 * @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 已提交
3911 3912 3913 3914
		 */
		export function registerDocumentFormattingEditProvider(selector: DocumentSelector, provider: DocumentFormattingEditProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3915 3916 3917
		 * Register a formatting provider for a document range.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
3918
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
3919
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
3920
		 *
J
Johannes Rieken 已提交
3921 3922 3923
		 * @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 已提交
3924 3925 3926 3927
		 */
		export function registerDocumentRangeFormattingEditProvider(selector: DocumentSelector, provider: DocumentRangeFormattingEditProvider): Disposable;

		/**
E
Erich Gamma 已提交
3928
		 * Register a formatting provider that works on type. The provider is active when the user enables the setting `editor.formatOnType`.
J
Johannes Rieken 已提交
3929 3930
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
3931
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
3932
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
3933
		 *
J
Johannes Rieken 已提交
3934 3935 3936
		 * @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 已提交
3937
		 * @param moreTriggerCharacter More trigger characters.
J
Johannes Rieken 已提交
3938
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
3939 3940 3941 3942
		 */
		export function registerOnTypeFormattingEditProvider(selector: DocumentSelector, provider: OnTypeFormattingEditProvider, firstTriggerCharacter: string, ...moreTriggerCharacter: string[]): Disposable;

		/**
J
Johannes Rieken 已提交
3943 3944 3945
		 * Register a signature help provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
3946
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
3947
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
3948
		 *
J
Johannes Rieken 已提交
3949 3950 3951 3952
		 * @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 已提交
3953 3954 3955
		 */
		export function registerSignatureHelpProvider(selector: DocumentSelector, provider: SignatureHelpProvider, ...triggerCharacters: string[]): Disposable;

J
Johannes Rieken 已提交
3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968
		/**
		 * 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 已提交
3969
		/**
J
Johannes Rieken 已提交
3970
		 * Set a [language configuration](#LanguageConfiguration) for a language.
E
Erich Gamma 已提交
3971
		 *
A
Andre Weinand 已提交
3972
		 * @param language A language identifier like `typescript`.
J
Johannes Rieken 已提交
3973 3974
		 * @param configuration Language configuration.
		 * @return A [disposable](#Disposable) that unsets this configuration.
E
Erich Gamma 已提交
3975 3976 3977 3978
		 */
		export function setLanguageConfiguration(language: string, configuration: LanguageConfiguration): Disposable;
	}

J
Johannes Rieken 已提交
3979
	/**
3980 3981 3982
	 * Namespace for dealing with installed extensions. Extensions are represented
	 * by an [extension](#Extension)-interface which allows to reflect on them.
	 *
S
Steven Clarke 已提交
3983
	 * Extension writers can provide APIs to other extensions by returning their API public
3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009
	 * surface from the `activate`-call.
	 *
	 * ```javascript
	 * export function activate(context: vscode.ExtensionContext) {
	 * 		let api = {
	 * 			sum(a, b) {
	 * 				return a + b;
	 * 			},
	 * 			mul(a, b) {
	 * 				return a * b;
	 * 			}
	 * 		};
	 * 		// 'export' public api-surface
	 *		return api;
	 * }
	 * ```
	 * 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 已提交
4010
	 */
E
Erich Gamma 已提交
4011 4012
	export namespace extensions {

J
Johannes Rieken 已提交
4013
		/**
4014
		 * Get an extension by its full identifier in the form of: `publisher.name`.
J
Johannes Rieken 已提交
4015
		 *
J
Johannes Rieken 已提交
4016
		 * @param extensionId An extension identifier.
J
Johannes Rieken 已提交
4017 4018
		 * @return An extension or `undefined`.
		 */
E
Erich Gamma 已提交
4019 4020
		export function getExtension(extensionId: string): Extension<any>;

J
Johannes Rieken 已提交
4021
		/**
A
Andre Weinand 已提交
4022
		 * Get an extension its full identifier in the form of: `publisher.name`.
J
Johannes Rieken 已提交
4023 4024 4025
		 *
		 * @param extensionId An extension identifier.
		 * @return An extension or `undefined`.
J
Johannes Rieken 已提交
4026
		 */
E
Erich Gamma 已提交
4027 4028 4029 4030 4031 4032 4033 4034 4035
		export function getExtension<T>(extensionId: string): Extension<T>;

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

4036 4037
// TS 1.6 & node_module
// export = vscode;
J
Johannes Rieken 已提交
4038 4039

// when used for JS*
B
Benjamin Pasero 已提交
4040
// !!! DO NOT MODIFY ABOVE COMMENT ("when used for JS*") IT IS BEING USED TO DETECT JS* ONLY CHANGES !!!
J
Johannes Rieken 已提交
4041 4042 4043
declare module 'vscode' {
	export = vscode;
}
J
Johannes Rieken 已提交
4044

E
Erich Gamma 已提交
4045 4046 4047 4048
/**
 * 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,
A
Andre Weinand 已提交
4049
 * we recommend the use of native promises which are available in VS Code.
E
Erich Gamma 已提交
4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064
 */
interface Thenable<R> {
	/**
	* 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.
	*/
	then<TResult>(onfulfilled?: (value: R) => TResult | Thenable<TResult>, onrejected?: (reason: any) => TResult | Thenable<TResult>): Thenable<TResult>;
	then<TResult>(onfulfilled?: (value: R) => TResult | Thenable<TResult>, onrejected?: (reason: any) => void): Thenable<TResult>;
}

// ---- ES6 promise ------------------------------------------------------

/**
A
Andre Weinand 已提交
4065
 * Represents the completion of an asynchronous operation.
E
Erich Gamma 已提交
4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095
 */
interface Promise<T> extends Thenable<T> {
	/**
	* 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.
	*/
	then<TResult>(onfulfilled?: (value: T) => TResult | Thenable<TResult>, onrejected?: (reason: any) => TResult | Thenable<TResult>): Promise<TResult>;
	then<TResult>(onfulfilled?: (value: T) => TResult | Thenable<TResult>, onrejected?: (reason: any) => void): Promise<TResult>;

	/**
	 * Attaches a callback for only the rejection of the Promise.
	 * @param onrejected The callback to execute when the Promise is rejected.
	 * @returns A Promise for the completion of the callback.
	 */
	catch(onrejected?: (reason: any) => T | Thenable<T>): Promise<T>;

	// [Symbol.toStringTag]: string;
}

interface PromiseConstructor {
	// /**
	//   * A reference to the prototype.
	//   */
	// prototype: Promise<any>;

	/**
	 * Creates a new Promise.
	 * @param executor A callback used to initialize the promise. This callback is passed two arguments:
A
Andre Weinand 已提交
4096
	 * a resolve callback used to resolve the promise with a value or the result of another promise,
E
Erich Gamma 已提交
4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131
	 * and a reject callback used to reject the promise with a provided reason or error.
	 */
	new <T>(executor: (resolve: (value?: T | Thenable<T>) => void, reject: (reason?: any) => void) => void): Promise<T>;

	/**
	 * Creates a Promise that is resolved with an array of results when all of the provided Promises
	 * resolve, or rejected when any Promise is rejected.
	 * @param values An array of Promises.
	 * @returns A new Promise.
	 */
	all<T>(values: Array<T | Thenable<T>>): Promise<T[]>;

	/**
	 * Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
	 * or rejected.
	 * @param values An array of Promises.
	 * @returns A new Promise.
	 */
	race<T>(values: Array<T | Thenable<T>>): Promise<T>;

	/**
	 * Creates a new rejected promise for the provided reason.
	 * @param reason The reason the promise was rejected.
	 * @returns A new rejected Promise.
	 */
	reject(reason: any): Promise<void>;

	/**
	 * Creates a new rejected promise for the provided reason.
	 * @param reason The reason the promise was rejected.
	 * @returns A new rejected Promise.
	 */
	reject<T>(reason: any): Promise<T>;

	/**
A
Alex Dima 已提交
4132 4133 4134 4135
	 * Creates a new resolved promise for the provided value.
	 * @param value A promise.
	 * @returns A promise whose internal state matches the provided promise.
	 */
E
Erich Gamma 已提交
4136 4137 4138
	resolve<T>(value: T | Thenable<T>): Promise<T>;

	/**
A
Andre Weinand 已提交
4139
	 * Creates a new resolved promise.
E
Erich Gamma 已提交
4140 4141 4142 4143 4144 4145 4146 4147
	 * @returns A resolved promise.
	 */
	resolve(): Promise<void>;

	// [Symbol.species]: Function;
}

declare var Promise: PromiseConstructor;