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

A
Alex Dima 已提交
6 7 8 9
/*
	This is the Type Definition file for VSCode version 0.10.1
*/

E
Erich Gamma 已提交
10 11 12
declare namespace vscode {

	/**
13
	 * The version of the editor.
E
Erich Gamma 已提交
14 15 16 17 18 19
	 */
	export var version: string;

	/**
	 * 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 已提交
20
	 * an array of arguments which will be passed to the command handler
E
Erich Gamma 已提交
21 22 23 24
	 * function when invoked.
	 */
	export interface Command {
		/**
J
Johannes Rieken 已提交
25
		 * Title of the command, like `save`.
E
Erich Gamma 已提交
26 27 28 29
		 */
		title: string;

		/**
A
Alex Dima 已提交
30
		 * The identifier of the actual command handler.
J
Johannes Rieken 已提交
31
		 * @see [commands.registerCommand](#commands.registerCommand).
E
Erich Gamma 已提交
32 33 34 35
		 */
		command: string;

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

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

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

		/**
J
Johannes Rieken 已提交
58
		 * The text of this line without the line separator characters.
E
Erich Gamma 已提交
59 60 61 62 63 64
		 *
		 * @readonly
		 */
		text: string;

		/**
J
Johannes Rieken 已提交
65
		 * The range this line covers without the line separator characters.
E
Erich Gamma 已提交
66 67 68 69 70 71
		 *
		 * @readonly
		 */
		range: Range;

		/**
J
Johannes Rieken 已提交
72
		 * The range this line covers with the line separator characters.
E
Erich Gamma 已提交
73 74 75 76 77 78
		 *
		 * @readonly
		 */
		rangeIncludingLineBreak: Range;

		/**
J
Johannes Rieken 已提交
79 80
		 * The offset of the first character which is not a whitespace character as defined
		 * by `/\s/`.
E
Erich Gamma 已提交
81 82 83 84 85 86 87
		 *
		 * @readonly
		 */
		firstNonWhitespaceCharacterIndex: number;

		/**
		 * Whether this line is whitespace only, shorthand
J
Johannes Rieken 已提交
88
		 * for [TextLine.firstNonWhitespaceCharacterIndex](#TextLine.firstNonWhitespaceCharacterIndex]) === [TextLine.text.length](#TextLine.text.length).
E
Erich Gamma 已提交
89 90 91 92 93 94 95 96 97 98 99 100 101
		 *
		 * @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 已提交
102 103 104
		 * 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 已提交
105 106 107 108 109 110
		 *
		 * @readonly
		 */
		uri: Uri;

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

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

		/**
J
Johannes Rieken 已提交
126
		 * The identifier of the language associated with this document.
E
Erich Gamma 已提交
127 128 129 130 131 132 133 134 135 136 137 138 139 140
		 *
		 * @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 已提交
141
		 * true if there are unpersisted changes.
E
Erich Gamma 已提交
142 143 144 145 146 147 148 149 150
		 *
		 * @readonly
		 */
		isDirty: boolean;

		/**
		 * Save the underlying file.
		 *
		 * @return A promise that will resolve to true when the file
A
Andre Weinand 已提交
151
		 * has been saved.
E
Erich Gamma 已提交
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
		 */
		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 已提交
167 168
		 * @param line A line number in [0, lineCount).
		 * @return A [line](#TextLine).
E
Erich Gamma 已提交
169 170 171 172 173 174 175 176
		 */
		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 已提交
177 178
		 * The position will be [adjusted](#TextDocument.validatePosition).
		 *
J
Johannes Rieken 已提交
179
		 * @see [TextDocument.lineAt](#TextDocument.lineAt)
A
Alex Dima 已提交
180 181
		 * @param position A position.
		 * @return A [line](#TextLine).
E
Erich Gamma 已提交
182 183 184 185 186
		 */
		lineAt(position: Position): TextLine;

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

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

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

		/**
J
Johannes Rieken 已提交
213 214 215 216
		 * 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 已提交
217 218
		 * The position will be [adjusted](#TextDocument.validatePosition).
		 *
J
Johannes Rieken 已提交
219 220
		 * @param position A position.
		 * @return A range spanning a word, or `undefined`.
E
Erich Gamma 已提交
221 222 223 224
		 */
		getWordRangeAtPosition(position: Position): Range;

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

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

	/**
	 * Represents a line and character position, such as
A
Alex Dima 已提交
243
	 * the position of the cursor.
E
Erich Gamma 已提交
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
	 *
	 * 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 已提交
264 265
		 * @param line A zero-based line value.
		 * @param character A zero-based character value.
E
Erich Gamma 已提交
266 267 268 269
		 */
		constructor(line: number, character: number);

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

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

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

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

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

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

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

		/**
A
Alex Dima 已提交
335 336
		 * Create a new position derived from this position.
		 *
E
Erich Gamma 已提交
337 338
		 * @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 已提交
339
		 * @return A position where line and character are replaced by the given values.
E
Erich Gamma 已提交
340 341 342 343 344 345
		 */
		with(line?: number, character?: number): Position;
	}

	/**
	 * A range represents an ordered pair of two positions.
A
Alex Dima 已提交
346
	 * It is guaranteed that [start](#Range.start).isBeforeOrEqual([end](#Range.end))
E
Erich Gamma 已提交
347 348 349 350 351 352 353 354
	 *
	 * 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 已提交
355
		 * The start position. It is before or equal to [end](#Range.end).
E
Erich Gamma 已提交
356 357 358 359 360
		 * @readonly
		 */
		start: Position;

		/**
A
Andre Weinand 已提交
361
		 * The end position. It is after or equal to [start](#Range.start).
E
Erich Gamma 已提交
362 363 364 365 366
		 * @readonly
		 */
		end: Position;

		/**
S
Steven Clarke 已提交
367
		 * Create a new range from two positions. If `start` is not
A
Alex Dima 已提交
368
		 * before or equal to `end`, the values will be swapped.
E
Erich Gamma 已提交
369
		 *
J
Johannes Rieken 已提交
370 371
		 * @param start A position.
		 * @param end A position.
E
Erich Gamma 已提交
372 373 374 375
		 */
		constructor(start: Position, end: Position);

		/**
A
Alex Dima 已提交
376 377
		 * 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 已提交
378
		 *
A
Alex Dima 已提交
379 380 381 382
		 * @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 已提交
383
		 */
J
Johannes Rieken 已提交
384
		constructor(startLine: number, startCharacter: number, endLine: number, endCharacter: number);
E
Erich Gamma 已提交
385 386 387 388 389 390 391

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

		/**
A
Alex Dima 已提交
392
		 * `true` iff `start.line` and `end.line` are equal.
E
Erich Gamma 已提交
393 394 395 396
		 */
		isSingleLine: boolean;

		/**
A
Alex Dima 已提交
397 398 399
		 * Check if a position or a range is contained in this range.
		 *
		 * @param positionOrRange A position or a range.
E
Erich Gamma 已提交
400 401 402 403 404 405
		 * @return `true` iff the position or range is inside or equal
		 * to this range.
		 */
		contains(positionOrRange: Position | Range): boolean;

		/**
A
Alex Dima 已提交
406 407 408
		 * Check if `other` equals this range.
		 *
		 * @param other A range.
E
Erich Gamma 已提交
409
		 * @return `true` when start and end are [equal](#Position.isEqual) to
A
Andre Weinand 已提交
410
		 * start and end of this range.
E
Erich Gamma 已提交
411 412 413 414
		 */
		isEqual(other: Range): boolean;

		/**
A
Alex Dima 已提交
415 416 417 418
		 * 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 已提交
419 420 421 422 423 424
		 * @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 已提交
425 426 427
		 * Compute the union of `other` with this range.
		 *
		 * @param other A range.
E
Erich Gamma 已提交
428 429 430 431 432
		 * @return A range of smaller start position and the greater end position.
		 */
		union(other: Range): Range;

		/**
A
Alex Dima 已提交
433 434
		 * Create a new range derived from this range.
		 *
E
Erich Gamma 已提交
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
		 * @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.
		 * If start and end are not different this range will be returned.
		 */
		with(start?: Position, end?: Position): Range;
	}

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

		/**
		 * The position at which the selection starts.
A
Andre Weinand 已提交
450
		 * This position might be before or after [active](#Selection.active).
E
Erich Gamma 已提交
451
		 */
A
Alex Dima 已提交
452
		anchor: Position;
E
Erich Gamma 已提交
453 454 455

		/**
		 * The position of the cursor.
A
Andre Weinand 已提交
456
		 * This position might be before or after [anchor](#Selection.anchor).
E
Erich Gamma 已提交
457
		 */
A
Alex Dima 已提交
458
		active: Position;
E
Erich Gamma 已提交
459 460 461

		/**
		 * Create a selection from two postions.
J
Johannes Rieken 已提交
462 463 464
		 *
		 * @param anchor A position.
		 * @param active A position.
E
Erich Gamma 已提交
465 466 467 468
		 */
		constructor(anchor: Position, active: Position);

		/**
A
Alex Dima 已提交
469
		 * Create a selection from four coordinates.
J
Johannes Rieken 已提交
470
		 *
A
Alex Dima 已提交
471 472 473 474
		 * @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 已提交
475
		 */
J
Johannes Rieken 已提交
476
		constructor(anchorLine: number, anchorCharacter: number, activeLine: number, activeCharacter: number);
A
Alex Dima 已提交
477

E
Erich Gamma 已提交
478
		/**
A
Andre Weinand 已提交
479
		 * A selection is reversed if [active](#Selection.active).isBefore([anchor](#Selection.anchor)).
E
Erich Gamma 已提交
480 481 482 483
		 */
		isReversed: boolean;
	}

A
Alex Dima 已提交
484 485 486
	/**
	 * Represents an event describing the change in a [text editor's selections](#TextEditor.selections).
	 */
J
Johannes Rieken 已提交
487
	export interface TextEditorSelectionChangeEvent {
A
Alex Dima 已提交
488 489 490
		/**
		 * The [text editor](#TextEditor) for which the selections have changed.
		 */
J
Johannes Rieken 已提交
491
		textEditor: TextEditor;
A
Alex Dima 已提交
492 493 494
		/**
		 * The new value for the [text editor's selections](#TextEditor.selections).
		 */
J
Johannes Rieken 已提交
495 496 497
		selections: Selection[];
	}

A
Alex Dima 已提交
498 499 500
	/**
	 * Represents an event describing the change in a [text editor's options](#TextEditor.options).
	 */
J
Johannes Rieken 已提交
501
	export interface TextEditorOptionsChangeEvent {
A
Alex Dima 已提交
502 503 504
		/**
		 * The [text editor](#TextEditor) for which the options have changed.
		 */
J
Johannes Rieken 已提交
505
		textEditor: TextEditor;
A
Alex Dima 已提交
506 507 508
		/**
		 * The new value for the [text editor's options](#TextEditor.options).
		 */
J
Johannes Rieken 已提交
509 510 511
		options: TextEditorOptions;
	}

E
Erich Gamma 已提交
512
	/**
A
Alex Dima 已提交
513
	 * Represents a [text editor](#TextEditor)'s [options](#TextEditor.options).
E
Erich Gamma 已提交
514 515 516 517
	 */
	export interface TextEditorOptions {

		/**
A
Alex Dima 已提交
518 519 520
		 * 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.
E
Erich Gamma 已提交
521 522 523 524 525 526 527 528 529
		 */
		tabSize: number;

		/**
		 * When pressing Tab insert [n](#TextEditorOptions.tabSize) spaces.
		 */
		insertSpaces: boolean;
	}

J
Johannes Rieken 已提交
530
	/**
A
Alex Dima 已提交
531 532
	 * Represents a handle to a set of decorations
	 * sharing the same [styling options](#DecorationRenderOptions) in a [text editor](#TextEditor).
J
Johannes Rieken 已提交
533 534 535 536
	 *
	 * To get an instance of a `TextEditorDecorationType` use
	 * [createTextEditorDecorationType](#window.createTextEditorDecorationType).
	 */
E
Erich Gamma 已提交
537 538 539
	export interface TextEditorDecorationType {

		/**
A
Alex Dima 已提交
540
		 * Internal representation of the handle.
E
Erich Gamma 已提交
541 542 543 544
		 * @readonly
		 */
		key: string;

A
Alex Dima 已提交
545 546 547
		/**
		 * Remove this decoration type and all decorations on all text editors using it.
		 */
E
Erich Gamma 已提交
548 549 550
		dispose(): void;
	}

A
Alex Dima 已提交
551 552 553
	/**
	 * Represents different [reveal](#TextEditor.revealRange) strategies in a text editor.
	 */
E
Erich Gamma 已提交
554
	export enum TextEditorRevealType {
A
Alex Dima 已提交
555 556 557 558 559 560 561
		/**
		 * 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 已提交
562
		InCenter,
A
Alex Dima 已提交
563 564 565 566
		/**
		 * 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 已提交
567 568 569
		InCenterIfOutsideViewport
	}

A
Alex Dima 已提交
570
	/**
S
Sofian Hnaide 已提交
571
	 * Represents different positions for rendering a decoration in an [overview ruler](#DecorationRenderOptions.overviewRulerLane).
A
Alex Dima 已提交
572 573
	 * The overview ruler supports three lanes.
	 */
E
Erich Gamma 已提交
574 575 576 577 578 579 580
	export enum OverviewRulerLane {
		Left = 1,
		Center = 2,
		Right = 4,
		Full = 7
	}

A
Alex Dima 已提交
581 582 583
	/**
	 * Represents theme specific rendering styles for a [text editor decoration](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
	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.
		 */
		outlineColor?: string;

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

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

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

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

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

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

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		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;

645 646 647 648 649
		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		letterSpacing?: string;

E
Erich Gamma 已提交
650
		/**
A
Alex Dima 已提交
651
		 * An **absolute path** to an image to be rendered in the gutterIconPath.
E
Erich Gamma 已提交
652 653 654 655 656 657 658 659 660
		 */
		gutterIconPath?: string;

		/**
		 * The color of the decoration in the overview ruler. Use rgba() and define transparent colors to play well with other decorations.
		 */
		overviewRulerColor?: string;
	}

A
Alex Dima 已提交
661 662 663
	/**
	 * Represents rendering styles for a [text editor decoration](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
	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 已提交
687 688 689
	/**
	 * Represents options for a specific decoration in a [decoration set](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
690 691 692 693 694 695 696 697 698 699 700 701 702
	export interface DecorationOptions {

		/**
		 * Range to which this decoration is applied.
		 */
		range: Range;

		/**
		 * A message that should be rendered when hovering over the decoration.
		 */
		hoverMessage: MarkedString | MarkedString[];
	}

A
Alex Dima 已提交
703 704 705
	/**
	 * Represents an editor that is attached to a [document](#TextDocument).
	 */
E
Erich Gamma 已提交
706 707 708 709 710 711 712 713
	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 已提交
714
		 * The primary selection on this text editor. Shorthand for `TextEditor.selections[0]`.
E
Erich Gamma 已提交
715 716 717 718
		 */
		selection: Selection;

		/**
J
Johannes Rieken 已提交
719
		 * The selections in this text editor. The primary selection is always at index 0.
E
Erich Gamma 已提交
720 721 722 723 724 725 726 727 728 729
		 */
		selections: Selection[];

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

		/**
		 * Perform an edit on the document associated with this text editor.
J
Johannes Rieken 已提交
730 731
		 *
		 * The given callback-function is invoked with an [edit-builder](#TextEditorEdit) which must
A
Andre Weinand 已提交
732
		 * be used to make edits. Note that the edit-builder is only valid while the
J
Johannes Rieken 已提交
733 734 735
		 * callback executes.
		 *
		 * @param callback A function which can make edits using an [edit-builder](#TextEditorEdit).
A
Alex Dima 已提交
736
		 * @return A promise that resolves with a value indicating if the edits could be applied.
E
Erich Gamma 已提交
737 738 739 740
		 */
		edit(callback: (editBuilder: TextEditorEdit) => void): Thenable<boolean>;

		/**
J
Johannes Rieken 已提交
741 742 743
		 * 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 已提交
744
		 * @see [createTextEditorDecorationType](#window.createTextEditorDecorationType).
A
Alex Dima 已提交
745
		 *
J
Johannes Rieken 已提交
746 747
		 * @param decorationType A decoration type.
		 * @param rangesOrOptions Either [ranges](#Range) or more detailed [options](#DecorationOptions).
E
Erich Gamma 已提交
748
		 */
J
Johannes Rieken 已提交
749
		setDecorations(decorationType: TextEditorDecorationType, rangesOrOptions: Range[] | DecorationOptions[]): void;
E
Erich Gamma 已提交
750 751

		/**
A
Alex Dima 已提交
752 753 754 755
		 * 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 已提交
756 757 758 759
		 */
		revealRange(range: Range, revealType?: TextEditorRevealType): void;

		/**
J
Johannes Rieken 已提交
760 761 762
		 * Show the text editor.
		 *
		 * @deprecated **This method is deprecated.** Use [window.showTextDocument](#window.showTextDocument)
S
Steven Clarke 已提交
763
		 * instead. This method shows unexpected behavior and will be removed in the next major update.
E
Erich Gamma 已提交
764
		 *
J
Johannes Rieken 已提交
765
		 * @param column The [column](#ViewColumn) in which to show this editor.
E
Erich Gamma 已提交
766 767 768 769 770
		 */
		show(column?: ViewColumn): void;

		/**
		 * Hide the text editor.
J
Johannes Rieken 已提交
771 772
		 *
		 * @deprecated **This method is deprecated.** Use the command 'workbench.action.closeActiveEditor' instead.
S
Steven Clarke 已提交
773
		 * This method shows unexpected behavior and will be removed in the next major update.
E
Erich Gamma 已提交
774 775 776 777 778
		 */
		hide(): void;
	}

	/**
A
Alex Dima 已提交
779 780 781
	 * 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.)
	 * they can be applied on a [document](#Document) associated with a [text editor](#TextEditor).
E
Erich Gamma 已提交
782 783 784 785
	 *
	 */
	export interface TextEditorEdit {
		/**
A
Alex Dima 已提交
786 787 788 789 790
		 * Replace a certain text region with a new value.
		 * You can use \r\n or \n in `value` and they will be normalized to the current [document](#Document).
		 *
		 * @param location The range this operation should remove.
		 * @param value The new text this operation should insert after removing `location`.
E
Erich Gamma 已提交
791 792 793 794
		 */
		replace(location: Position | Range | Selection, value: string): void;

		/**
A
Alex Dima 已提交
795 796 797 798 799 800
		 * Insert text at a location.
		 * You can use \r\n or \n in `value` and they will be normalized to the current [document](#Document).
		 * 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 已提交
801 802 803 804 805
		 */
		insert(location: Position, value: string): void;

		/**
		 * Delete a certain text region.
A
Alex Dima 已提交
806 807
		 *
		 * @param location The range this operation should remove.
E
Erich Gamma 已提交
808 809 810 811 812
		 */
		delete(location: Range | Selection): void;
	}

	/**
S
Steven Clarke 已提交
813
	 * A universal resource identifier representing either a file on disk
J
Johannes Rieken 已提交
814
	 * or another resource, like untitled resources.
E
Erich Gamma 已提交
815 816 817 818
	 */
	export class Uri {

		/**
J
Johannes Rieken 已提交
819 820 821 822 823
		 * 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 已提交
824 825 826 827
		 */
		static file(path: string): Uri;

		/**
J
Johannes Rieken 已提交
828 829
		 * Create an URI from a string. Will throw if the given value is not
		 * valid.
E
Erich Gamma 已提交
830
		 *
J
Johannes Rieken 已提交
831
		 * @param value The string value of an Uri.
J
Johannes Rieken 已提交
832
		 * @return A new Uri instance.
E
Erich Gamma 已提交
833 834 835 836
		 */
		static parse(value: string): Uri;

		/**
J
Johannes Rieken 已提交
837
		 * Scheme is the `http` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
838 839 840 841 842
		 * The part before the first colon.
		 */
		scheme: string;

		/**
J
Johannes Rieken 已提交
843
		 * Authority is the `www.msft.com` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
844 845 846 847 848
		 * The part between the first double slashes and the next slash.
		 */
		authority: string;

		/**
J
Johannes Rieken 已提交
849
		 * Path is the `/some/path` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
850 851 852 853
		 */
		path: string;

		/**
J
Johannes Rieken 已提交
854
		 * Query is the `query` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
855 856 857 858
		 */
		query: string;

		/**
J
Johannes Rieken 已提交
859
		 * Fragment is the `fragment` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
860 861 862 863
		 */
		fragment: string;

		/**
J
Johannes Rieken 已提交
864 865
		 * The string representing the corresponding file system path of this URI.
		 *
E
Erich Gamma 已提交
866 867 868 869 870 871 872 873 874
		 * 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
		 * invalid characters and semantics. Will *not* look at the scheme of this URI.
		 */
		fsPath: string;

		/**
		 * Returns a canonical representation of this URI. The representation and normalization
		 * of a URI depends on the scheme.
J
Johannes Rieken 已提交
875 876
		 *
		 * @returns A string that is the encoded version of this Uri.
E
Erich Gamma 已提交
877 878 879
		 */
		toString(): string;

J
Johannes Rieken 已提交
880 881 882 883 884
		/**
		 * Returns a JSON representation of this Uri.
		 *
		 * @return An object.
		 */
E
Erich Gamma 已提交
885 886 887 888
		toJSON(): any;
	}

	/**
S
Steven Clarke 已提交
889
	 * A cancellation token is passed to an asynchronous or long running
E
Erich Gamma 已提交
890 891
	 * operation to request cancellation, like cancelling a request
	 * for completion items because the user continued to type.
892 893 894
	 *
	 * To get an instance of a `CancellationToken` use a
	 * [CancellationTokenSource](#CancellationTokenSource).
E
Erich Gamma 已提交
895 896 897 898
	 */
	export interface CancellationToken {

		/**
J
Johannes Rieken 已提交
899
		 * Is `true` when the token has been cancelled, `false` otherwise.
E
Erich Gamma 已提交
900 901 902 903
		 */
		isCancellationRequested: boolean;

		/**
J
Johannes Rieken 已提交
904
		 * An [event](#Event) which fires upon cancellation.
E
Erich Gamma 已提交
905 906 907 908 909
		 */
		onCancellationRequested: Event<any>;
	}

	/**
J
Johannes Rieken 已提交
910
	 * A cancellation source creates and controls a [cancellation token](#CancellationToken).
E
Erich Gamma 已提交
911 912 913 914
	 */
	export class CancellationTokenSource {

		/**
J
Johannes Rieken 已提交
915
		 * The cancellation token of this source.
E
Erich Gamma 已提交
916 917 918 919 920 921 922 923 924
		 */
		token: CancellationToken;

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

		/**
J
Johannes Rieken 已提交
925
		 * Dispose object and free resources. Will call [cancel](#CancellationTokenSource.cancel).
E
Erich Gamma 已提交
926 927 928 929 930 931 932 933 934 935 936 937 938 939 940
		 */
		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 已提交
941
		 * @param disposableLikes Objects that have at least a `dispose`-function member.
E
Erich Gamma 已提交
942 943 944 945 946 947 948 949
		 * @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 已提交
950
		 * @param callOnDispose Function that disposes something.
E
Erich Gamma 已提交
951 952 953 954 955 956 957 958 959 960 961
		 */
		constructor(callOnDispose: Function);

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

	/**
	 * Represents a typed event.
J
Johannes Rieken 已提交
962 963 964 965 966
	 *
	 * 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 已提交
967 968 969 970
	 */
	export interface Event<T> {

		/**
J
Johannes Rieken 已提交
971 972
		 * A function that represents an event to which you subscribe by calling it with
		 * a listener function as argument.
E
Erich Gamma 已提交
973 974
		 *
		 * @param listener The listener function will be called when the event happens.
J
Johannes Rieken 已提交
975 976
		 * @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 已提交
977
		 * @return A disposable which unsubscribes the event listener.
E
Erich Gamma 已提交
978 979 980 981 982 983
		 */
		(listener: (e: T) => any, thisArgs?: any, disposables?: Disposable[]): Disposable;
	}

	/**
	 * A file system watcher notifies about changes to files and folders
J
Johannes Rieken 已提交
984 985 986
	 * on disk.
	 *
	 * To get an instance of a `FileSystemWatcher` use
J
Johannes Rieken 已提交
987
	 * [createFileSystemWatcher](#workspace.createFileSystemWatcher).
E
Erich Gamma 已提交
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
	 */
	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.
		 */
		ignoreDeleteEvents: boolean

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

1025 1026 1027 1028 1029 1030 1031 1032 1033
	/**
	 * A text document content provider allows to add readonly documents
	 * to the editor, such as source from a dll or generated html from md.
	 *
	 * Content providers are [registered](#workbench.registerTextDocumentContentProvider)
	 * for a [uri-scheme](#Uri.scheme). When a uri with that scheme is to
	 * be [loaded](#workbench.openTextDocument) the content provider is
	 * asked.
	 */
J
Johannes Rieken 已提交
1034 1035
	export interface TextDocumentContentProvider {

1036 1037 1038 1039
		/**
		 * An event to signal a resource has changed.
		 */
		onDidChange?: Event<Uri>;
J
Johannes Rieken 已提交
1040

1041
		/**
1042
		 * Provide textual content for a given uri.
1043
		 *
1044 1045 1046 1047
		 * The editor will use the returned string-content to create a readonly
		 * [document](TextDocument). Resources allocated should be released when
		 * the corresponding document has been [closed](#workbench.onDidCloseTextDocument).
		 *
1048 1049 1050
		 * @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.
1051
		 */
1052
		provideTextDocumentContent(uri: Uri, token: CancellationToken): string | Thenable<string>;
J
Johannes Rieken 已提交
1053 1054
	}

E
Erich Gamma 已提交
1055 1056
	/**
	 * Represents an item that can be selected from
A
Andre Weinand 已提交
1057
	 * a list of items.
E
Erich Gamma 已提交
1058 1059 1060 1061
	 */
	export interface QuickPickItem {

		/**
J
Johannes Rieken 已提交
1062
		 * A label. Will be rendered prominent.
E
Erich Gamma 已提交
1063 1064 1065 1066
		 */
		label: string;

		/**
J
Johannes Rieken 已提交
1067
		 * A description. Will be rendered less prominent.
E
Erich Gamma 已提交
1068 1069 1070 1071 1072
		 */
		description: string;
	}

	/**
J
Johannes Rieken 已提交
1073
	 * Options to configure the behavior of the quick pick UI.
E
Erich Gamma 已提交
1074 1075 1076
	 */
	export interface QuickPickOptions {
		/**
J
Johannes Rieken 已提交
1077 1078
		 * An optional flag to include the description when filtering the picks.
		 */
E
Erich Gamma 已提交
1079 1080 1081
		matchOnDescription?: boolean;

		/**
S
Steven Clarke 已提交
1082
		 * An optional string to show as place holder in the input box to guide the user what to pick on.
J
Johannes Rieken 已提交
1083
		 */
E
Erich Gamma 已提交
1084
		placeHolder?: string;
1085 1086 1087 1088 1089

		/**
		 * An optional function that is invoked whenever an item is selected.
		 */
		onDidSelectItem?: <T extends QuickPickItem>(item: T | string) => any;
E
Erich Gamma 已提交
1090 1091 1092
	}

	/**
J
Johannes Rieken 已提交
1093
	 * Represents an action that is shown with an information, warning, or
A
Andre Weinand 已提交
1094
	 * error message.
E
Erich Gamma 已提交
1095
	 *
S
Sofian Hnaide 已提交
1096 1097 1098
	 * @see [showInformationMessage](#window.showInformationMessage)
	 * @see [showWarningMessage](#window.showWarningMessage)
	 * @see [showErrorMessage](#window.showErrorMessage)
E
Erich Gamma 已提交
1099 1100 1101 1102
	 */
	export interface MessageItem {

		/**
A
Andre Weinand 已提交
1103
		 * A short title like 'Retry', 'Open Log' etc.
E
Erich Gamma 已提交
1104 1105 1106 1107 1108
		 */
		title: string;
	}

	/**
J
Johannes Rieken 已提交
1109
	 * Options to configure the behavior of the input box UI.
E
Erich Gamma 已提交
1110 1111
	 */
	export interface InputBoxOptions {
J
Johannes Rieken 已提交
1112

E
Erich Gamma 已提交
1113
		/**
J
Johannes Rieken 已提交
1114 1115
		 * The value to prefill in the input box.
		 */
E
Erich Gamma 已提交
1116 1117 1118
		value?: string;

		/**
J
Johannes Rieken 已提交
1119 1120
		 * The text to display underneath the input box.
		 */
E
Erich Gamma 已提交
1121 1122 1123
		prompt?: string;

		/**
J
Johannes Rieken 已提交
1124 1125
		 * An optional string to show as place holder in the input box to guide the user what to type.
		 */
E
Erich Gamma 已提交
1126 1127 1128
		placeHolder?: string;

		/**
J
Johannes Rieken 已提交
1129 1130
		 * Set to true to show a password prompt that will not show the typed value.
		 */
E
Erich Gamma 已提交
1131 1132 1133 1134 1135
		password?: boolean;
	}

	/**
	 * A document filter denotes a document by different properties like
A
Alex Dima 已提交
1136
	 * the [language](#TextDocument.languageId), the [scheme](#Uri.scheme) of
A
Andre Weinand 已提交
1137
	 * its resource, or a glob-pattern that is applied to the [path](#TextDocument.fileName).
E
Erich Gamma 已提交
1138
	 *
J
Johannes Rieken 已提交
1139
	 * @sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
1140
	 * @sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**∕project.json' }`
E
Erich Gamma 已提交
1141 1142 1143 1144 1145 1146 1147 1148 1149
	 */
	export interface DocumentFilter {

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

		/**
J
Johannes Rieken 已提交
1150
		 * A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
E
Erich Gamma 已提交
1151 1152 1153 1154
		 */
		scheme?: string;

		/**
J
Johannes Rieken 已提交
1155
		 * A glob pattern, like `*.{ts,js}`.
E
Erich Gamma 已提交
1156 1157 1158 1159 1160 1161
		 */
		pattern?: string;
	}

	/**
	 * A language selector is the combination of one or many language identifiers
J
Johannes Rieken 已提交
1162 1163 1164
	 * and [language filters](#LanguageFilter).
	 *
	 * @sample `let sel:DocumentSelector = 'typescript'`;
1165
	 * @sample `let sel:DocumentSelector = ['typescript', { language: 'json', pattern: '**∕tsconfig.json' }]`;
E
Erich Gamma 已提交
1166 1167 1168 1169 1170
	 */
	export type DocumentSelector = string | DocumentFilter | (string | DocumentFilter)[];

	/**
	 * Contains additional diagnostic information about the context in which
J
Johannes Rieken 已提交
1171
	 * a [code action](#CodeActionProvider.provideCodeActions) is run.
E
Erich Gamma 已提交
1172 1173
	 */
	export interface CodeActionContext {
J
Johannes Rieken 已提交
1174 1175 1176

		/**
		 * An array of diagnostics.
J
Johannes Rieken 已提交
1177 1178
		 *
		 * @readonly
J
Johannes Rieken 已提交
1179
		 */
E
Erich Gamma 已提交
1180 1181 1182 1183
		diagnostics: Diagnostic[];
	}

	/**
J
Johannes Rieken 已提交
1184 1185 1186 1187
	 * 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 已提交
1188 1189 1190 1191 1192 1193
	 */
	export interface CodeActionProvider {

		/**
		 * Provide commands for the given document and range.
		 *
J
Johannes Rieken 已提交
1194 1195
		 * @param document The document in which the command was invoked.
		 * @param range The range for which the command was invoked.
J
Johannes Rieken 已提交
1196 1197
		 * @param context Context carrying additional information.
		 * @param token A cancellation token.
J
Johannes Rieken 已提交
1198
		 * @return An array of commands or a thenable of such. The lack of a result can be
A
Andre Weinand 已提交
1199
		 * signaled by returning `undefined`, `null`, or an empty array.
E
Erich Gamma 已提交
1200 1201 1202 1203 1204 1205 1206
		 */
		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 已提交
1207 1208 1209
	 *
	 * 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 已提交
1210 1211 1212
	 *
	 * @see [CodeLensProvider.provideCodeLenses](#CodeLensProvider.provideCodeLenses)
	 * @see [CodeLensProvider.resolveCodeLens](#CodeLensProvider.resolveCodeLens)
E
Erich Gamma 已提交
1213 1214 1215 1216 1217 1218 1219 1220 1221
	 */
	export class CodeLens {

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

		/**
J
Johannes Rieken 已提交
1222
		 * The command this code lens represents.
E
Erich Gamma 已提交
1223 1224 1225 1226
		 */
		command: Command;

		/**
J
Johannes Rieken 已提交
1227
		 * `true` when there is a command associated.
E
Erich Gamma 已提交
1228 1229
		 */
		isResolved: boolean;
J
Johannes Rieken 已提交
1230 1231 1232 1233 1234 1235 1236 1237

		/**
		 * 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 已提交
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247
	}

	/**
	 * 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 已提交
1248
		 * computing the commands is expensive implementors should only return code lens objects with the
E
Erich Gamma 已提交
1249
		 * range set and implement [resolve](#CodeLensProvider.resolveCodeLens).
J
Johannes Rieken 已提交
1250 1251 1252
		 *
		 * @param document The document in which the command was invoked.
		 * @param token A cancellation token.
A
Andre Weinand 已提交
1253 1254
		 * @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 已提交
1255 1256 1257 1258 1259 1260
		 */
		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 已提交
1261
		 *
A
Andre Weinand 已提交
1262
		 * @param codeLens code lens that must be resolved.
J
Johannes Rieken 已提交
1263
		 * @param token A cancellation token.
S
Steven Clarke 已提交
1264
		 * @return The given, resolved code lens or thenable that resolves to such.
E
Erich Gamma 已提交
1265 1266 1267 1268 1269
		 */
		resolveCodeLens?(codeLens: CodeLens, token: CancellationToken): CodeLens | Thenable<CodeLens>;
	}

	/**
J
Johannes Rieken 已提交
1270 1271 1272
	 * 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 已提交
1273 1274 1275
	 */
	export type Definition = Location | Location[];

J
Johannes Rieken 已提交
1276 1277 1278 1279 1280
	/**
	 * 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 已提交
1281
	export interface DefinitionProvider {
J
Johannes Rieken 已提交
1282 1283 1284 1285 1286 1287 1288

		/**
		 * 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 已提交
1289
		 * @return A definition or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
1290
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
1291 1292
		 */
		provideDefinition(document: TextDocument, position: Position, token: CancellationToken): Definition | Thenable<Definition>;
E
Erich Gamma 已提交
1293 1294 1295 1296 1297 1298 1299 1300 1301
	}

	/**
	 * FormattedString can be used to render text with a tiny subset of markdown. FormattedString
	 * is either a string that supports **bold** and __italic__ or a code-block that
	 * provides a language and a code Snippet.
	 */
	export type MarkedString = string | { language: string; value: string };

J
Johannes Rieken 已提交
1302 1303 1304 1305
	/**
	 * A hover represents additional information for a symbol or word. Hovers are
	 * rendered in a tooltip-like widget.
	 */
E
Erich Gamma 已提交
1306 1307
	export class Hover {

J
Johannes Rieken 已提交
1308 1309 1310
		/**
		 * The contents of this hover.
		 */
E
Erich Gamma 已提交
1311 1312
		contents: MarkedString[];

J
Johannes Rieken 已提交
1313
		/**
A
Andre Weinand 已提交
1314
		 * The range to which this hover applies. When missing, the
J
Johannes Rieken 已提交
1315
		 * editor will use the range at the current position or the
A
Andre Weinand 已提交
1316
		 * current position itself.
J
Johannes Rieken 已提交
1317
		 */
E
Erich Gamma 已提交
1318 1319
		range: Range;

J
Johannes Rieken 已提交
1320 1321 1322 1323
		/**
		 * Creates a new hover object.
		 *
		 * @param contents The contents of the hover.
A
Andre Weinand 已提交
1324
		 * @param range The range to which the hover applies.
J
Johannes Rieken 已提交
1325
		 */
E
Erich Gamma 已提交
1326 1327 1328
		constructor(contents: MarkedString | MarkedString[], range?: Range);
	}

J
Johannes Rieken 已提交
1329 1330 1331 1332
	/**
	 * The hover provider interface defines the contract between extensions and
	 * the [hover](https://code.visualstudio.com/docs/editor/editingevolved#_hover)-feature.
	 */
E
Erich Gamma 已提交
1333
	export interface HoverProvider {
J
Johannes Rieken 已提交
1334 1335 1336

		/**
		 * Provide a hover for the given position and document. Multiple hovers at the same
A
Andre Weinand 已提交
1337 1338
		 * 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 已提交
1339 1340 1341 1342 1343
		 *
		 * @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 已提交
1344
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
1345
		 */
E
Erich Gamma 已提交
1346 1347 1348
		provideHover(document: TextDocument, position: Position, token: CancellationToken): Hover | Thenable<Hover>;
	}

J
Johannes Rieken 已提交
1349 1350 1351
	/**
	 * A document highlight kind.
	 */
E
Erich Gamma 已提交
1352
	export enum DocumentHighlightKind {
J
Johannes Rieken 已提交
1353 1354

		/**
A
Andre Weinand 已提交
1355
		 * A textual occurrence.
J
Johannes Rieken 已提交
1356
		 */
E
Erich Gamma 已提交
1357
		Text,
J
Johannes Rieken 已提交
1358 1359 1360 1361

		/**
		 * Read-access of a symbol, like reading a variable.
		 */
E
Erich Gamma 已提交
1362
		Read,
J
Johannes Rieken 已提交
1363 1364 1365 1366

		/**
		 * Write-access of a symbol, like writing to a variable.
		 */
E
Erich Gamma 已提交
1367 1368 1369
		Write
	}

J
Johannes Rieken 已提交
1370 1371 1372 1373 1374
	/**
	 * 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 已提交
1375
	export class DocumentHighlight {
J
Johannes Rieken 已提交
1376 1377 1378 1379

		/**
		 * The range this highlight applies to.
		 */
E
Erich Gamma 已提交
1380
		range: Range;
J
Johannes Rieken 已提交
1381 1382 1383 1384

		/**
		 * The highlight kind, default is [text](#DocumentHighlightKind.Text).
		 */
E
Erich Gamma 已提交
1385
		kind: DocumentHighlightKind;
J
Johannes Rieken 已提交
1386 1387 1388 1389 1390 1391 1392 1393

		/**
		 * 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 已提交
1394 1395
	}

J
Johannes Rieken 已提交
1396 1397 1398 1399
	/**
	 * The document highlight provider interface defines the contract between extensions and
	 * the word-highlight-feature.
	 */
E
Erich Gamma 已提交
1400
	export interface DocumentHighlightProvider {
J
Johannes Rieken 已提交
1401 1402

		/**
S
Steven Clarke 已提交
1403
		 * Provide a set of document highlights, like all occurrences of a variable or
J
Johannes Rieken 已提交
1404 1405 1406 1407 1408 1409
		 * 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 已提交
1410
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1411
		 */
E
Erich Gamma 已提交
1412 1413 1414
		provideDocumentHighlights(document: TextDocument, position: Position, token: CancellationToken): DocumentHighlight[] | Thenable<DocumentHighlight[]>;
	}

J
Johannes Rieken 已提交
1415 1416 1417
	/**
	 * A symbol kind.
	 */
E
Erich Gamma 已提交
1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435
	export enum SymbolKind {
		File,
		Module,
		Namespace,
		Package,
		Class,
		Method,
		Property,
		Field,
		Constructor,
		Enum,
		Interface,
		Function,
		Variable,
		Constant,
		String,
		Number,
		Boolean,
J
Johannes Rieken 已提交
1436
		Array
E
Erich Gamma 已提交
1437 1438
	}

J
Johannes Rieken 已提交
1439 1440 1441 1442
	/**
	 * Represents information about programming constructs like variables, classes,
	 * interfaces etc.
	 */
E
Erich Gamma 已提交
1443
	export class SymbolInformation {
J
Johannes Rieken 已提交
1444 1445 1446 1447

		/**
		 * The name of this symbol.
		 */
E
Erich Gamma 已提交
1448
		name: string;
J
Johannes Rieken 已提交
1449 1450 1451 1452

		/**
		 * The name of the symbol containing this symbol.
		 */
E
Erich Gamma 已提交
1453
		containerName: string;
J
Johannes Rieken 已提交
1454 1455 1456 1457

		/**
		 * The kind of this symbol.
		 */
E
Erich Gamma 已提交
1458
		kind: SymbolKind;
J
Johannes Rieken 已提交
1459 1460 1461 1462

		/**
		 * The location of this symbol.
		 */
E
Erich Gamma 已提交
1463
		location: Location;
J
Johannes Rieken 已提交
1464 1465 1466 1467 1468 1469 1470 1471

		/**
		 * 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 已提交
1472
		 * @param containerName The name of the symbol containing the symbol.
J
Johannes Rieken 已提交
1473 1474
		 */
		constructor(name: string, kind: SymbolKind, range: Range, uri?: Uri, containerName?: string);
E
Erich Gamma 已提交
1475 1476
	}

J
Johannes Rieken 已提交
1477 1478 1479 1480
	/**
	 * 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 已提交
1481
	export interface DocumentSymbolProvider {
J
Johannes Rieken 已提交
1482 1483 1484 1485 1486 1487 1488

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

J
Johannes Rieken 已提交
1494 1495 1496 1497
	/**
	 * 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 已提交
1498
	export interface WorkspaceSymbolProvider {
J
Johannes Rieken 已提交
1499 1500 1501 1502 1503 1504 1505 1506

		/**
		 * Project-wide search for a symbol matching the given query string. It is up to the provider
		 * how to search given the query string, like substring, indexOf etc.
		 *
		 * @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 已提交
1507
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1508
		 */
E
Erich Gamma 已提交
1509 1510 1511
		provideWorkspaceSymbols(query: string, token: CancellationToken): SymbolInformation[] | Thenable<SymbolInformation[]>;
	}

J
Johannes Rieken 已提交
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527
	/**
	 * 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 已提交
1528
	export interface ReferenceProvider {
J
Johannes Rieken 已提交
1529 1530 1531 1532 1533 1534 1535 1536 1537

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

J
Johannes Rieken 已提交
1543
	/**
S
Steven Clarke 已提交
1544
	 * A text edit represents edits that should be applied
J
Johannes Rieken 已提交
1545
	 * to a document.
J
Johannes Rieken 已提交
1546
	 */
E
Erich Gamma 已提交
1547
	export class TextEdit {
J
Johannes Rieken 已提交
1548 1549 1550 1551 1552 1553 1554 1555

		/**
		 * Utility to create a replace edit.
		 *
		 * @param range A range.
		 * @param newText A string.
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
1556
		static replace(range: Range, newText: string): TextEdit;
J
Johannes Rieken 已提交
1557 1558 1559 1560

		/**
		 * Utility to create an insert edit.
		 *
S
Steven Clarke 已提交
1561
		 * @param position A position, will become an empty range.
J
Johannes Rieken 已提交
1562 1563 1564
		 * @param newText A string.
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
1565
		static insert(position: Position, newText: string): TextEdit;
J
Johannes Rieken 已提交
1566 1567 1568 1569

		/**
		 * Utility to create a delete edit.
		 *
J
Johannes Rieken 已提交
1570
		 * @param range A range.
J
Johannes Rieken 已提交
1571 1572
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
1573
		static delete(range: Range): TextEdit;
J
Johannes Rieken 已提交
1574 1575 1576 1577

		/**
		 * The range this edit applies to.
		 */
E
Erich Gamma 已提交
1578
		range: Range;
J
Johannes Rieken 已提交
1579 1580 1581 1582

		/**
		 * The string this edit will insert.
		 */
E
Erich Gamma 已提交
1583
		newText: string;
J
Johannes Rieken 已提交
1584 1585 1586 1587 1588 1589 1590 1591

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

	/**
J
Johannes Rieken 已提交
1595
	 * A workspace edit represents textual changes for many documents.
E
Erich Gamma 已提交
1596 1597 1598 1599 1600 1601 1602 1603 1604 1605
	 */
	export class WorkspaceEdit {

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

J
Johannes Rieken 已提交
1606 1607 1608 1609 1610 1611 1612 1613
		/**
		 * 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 已提交
1614

J
Johannes Rieken 已提交
1615 1616 1617 1618 1619 1620 1621 1622
		/**
		 * 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 已提交
1623

J
Johannes Rieken 已提交
1624
		/**
S
Steven Clarke 已提交
1625
		 * Delete the text at the given range.
J
Johannes Rieken 已提交
1626 1627 1628
		 *
		 * @param uri A resource identifier.
		 * @param range A range.
J
Johannes Rieken 已提交
1629 1630
		 */
		delete(uri: Uri, range: Range): void;
E
Erich Gamma 已提交
1631

J
Johannes Rieken 已提交
1632 1633 1634
		/**
		 * Check if this edit affects the given resource.
		 * @param uri A resource identifier.
A
Andre Weinand 已提交
1635
		 * @return `true` if the given resource will be touched by this edit.
J
Johannes Rieken 已提交
1636
		 */
E
Erich Gamma 已提交
1637 1638
		has(uri: Uri): boolean;

J
Johannes Rieken 已提交
1639 1640 1641 1642 1643 1644
		/**
		 * Set (and replace) text edits for a resource.
		 *
		 * @param uri A resource identifier.
		 * @param edits An array of text edits.
		 */
E
Erich Gamma 已提交
1645 1646
		set(uri: Uri, edits: TextEdit[]): void;

J
Johannes Rieken 已提交
1647 1648 1649 1650 1651 1652
		/**
		 * Get the text edits for a resource.
		 *
		 * @param uri A resource identifier.
		 * @return An array of text edits.
		 */
E
Erich Gamma 已提交
1653 1654
		get(uri: Uri): TextEdit[];

J
Johannes Rieken 已提交
1655 1656 1657 1658 1659
		/**
		 * Get all text edits grouped by resource.
		 *
		 * @return An array of `[Uri, TextEdit[]]`-tuples.
		 */
E
Erich Gamma 已提交
1660 1661 1662 1663
		entries(): [Uri, TextEdit[]][];
	}

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

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

J
Johannes Rieken 已提交
1683 1684 1685
	/**
	 * Value-object describing what options formatting should use.
	 */
E
Erich Gamma 已提交
1686
	export interface FormattingOptions {
J
Johannes Rieken 已提交
1687 1688 1689 1690

		/**
		 * Size of a tab in spaces.
		 */
E
Erich Gamma 已提交
1691
		tabSize: number;
J
Johannes Rieken 已提交
1692 1693 1694 1695

		/**
		 * Prefer spaces over tabs.
		 */
E
Erich Gamma 已提交
1696
		insertSpaces: boolean;
J
Johannes Rieken 已提交
1697 1698 1699 1700 1701

		/**
		 * Signature for further properties.
		 */
		[key: string]: boolean | number | string;
E
Erich Gamma 已提交
1702 1703 1704
	}

	/**
J
Johannes Rieken 已提交
1705 1706
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
1707 1708
	 */
	export interface DocumentFormattingEditProvider {
J
Johannes Rieken 已提交
1709 1710 1711 1712 1713 1714 1715 1716

		/**
		 * 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 已提交
1717
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1718
		 */
E
Erich Gamma 已提交
1719 1720 1721 1722
		provideDocumentFormattingEdits(document: TextDocument, options: FormattingOptions, token: CancellationToken): TextEdit[] | Thenable<TextEdit[]>;
	}

	/**
J
Johannes Rieken 已提交
1723 1724
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
1725 1726
	 */
	export interface DocumentRangeFormattingEditProvider {
J
Johannes Rieken 已提交
1727 1728 1729 1730 1731

		/**
		 * 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 已提交
1732 1733
		 * or larger range. Often this is done by adjusting the start and end
		 * of the range to full syntax nodes.
J
Johannes Rieken 已提交
1734 1735 1736 1737 1738 1739
		 *
		 * @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 已提交
1740
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1741
		 */
E
Erich Gamma 已提交
1742 1743 1744 1745
		provideDocumentRangeFormattingEdits(document: TextDocument, range: Range, options: FormattingOptions, token: CancellationToken): TextEdit[] | Thenable<TextEdit[]>;
	}

	/**
J
Johannes Rieken 已提交
1746 1747
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
1748 1749
	 */
	export interface OnTypeFormattingEditProvider {
J
Johannes Rieken 已提交
1750 1751 1752 1753 1754 1755 1756 1757 1758 1759

		/**
		 * 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 已提交
1760
		 * @param ch The character that has been typed.
J
Johannes Rieken 已提交
1761 1762 1763
		 * @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 已提交
1764
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1765
		 */
E
Erich Gamma 已提交
1766 1767 1768
		provideOnTypeFormattingEdits(document: TextDocument, position: Position, ch: string, options: FormattingOptions, token: CancellationToken): TextEdit[] | Thenable<TextEdit[]>;
	}

J
Johannes Rieken 已提交
1769 1770 1771 1772
	/**
	 * Represents a parameter of a callable-signature. A parameter can
	 * have a label and a doc-comment.
	 */
E
Erich Gamma 已提交
1773
	export class ParameterInformation {
J
Johannes Rieken 已提交
1774 1775 1776 1777 1778

		/**
		 * The label of this signature. Will be shown in
		 * the UI.
		 */
E
Erich Gamma 已提交
1779
		label: string;
J
Johannes Rieken 已提交
1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792

		/**
		 * 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 已提交
1793 1794 1795
		constructor(label: string, documentation?: string);
	}

J
Johannes Rieken 已提交
1796 1797 1798 1799 1800
	/**
	 * 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 已提交
1801
	export class SignatureInformation {
J
Johannes Rieken 已提交
1802 1803 1804 1805 1806

		/**
		 * The label of this signature. Will be shown in
		 * the UI.
		 */
E
Erich Gamma 已提交
1807
		label: string;
J
Johannes Rieken 已提交
1808 1809 1810 1811 1812 1813 1814 1815 1816 1817

		/**
		 * 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 已提交
1818
		parameters: ParameterInformation[];
J
Johannes Rieken 已提交
1819 1820 1821 1822 1823

		/**
		 * Creates a new signature information object.
		 *
		 * @param label A label string.
J
Johannes Rieken 已提交
1824
		 * @param documentation A doc string.
J
Johannes Rieken 已提交
1825
		 */
E
Erich Gamma 已提交
1826 1827 1828
		constructor(label: string, documentation?: string);
	}

J
Johannes Rieken 已提交
1829 1830
	/**
	 * Signature help represents the signature of something
S
Steven Clarke 已提交
1831
	 * callable. There can be multiple signatures but only one
J
Johannes Rieken 已提交
1832 1833
	 * active and only one active parameter.
	 */
E
Erich Gamma 已提交
1834
	export class SignatureHelp {
J
Johannes Rieken 已提交
1835 1836 1837 1838

		/**
		 * One or more signatures.
		 */
E
Erich Gamma 已提交
1839
		signatures: SignatureInformation[];
J
Johannes Rieken 已提交
1840 1841 1842 1843

		/**
		 * The active signature.
		 */
E
Erich Gamma 已提交
1844
		activeSignature: number;
J
Johannes Rieken 已提交
1845 1846 1847 1848

		/**
		 * The active parameter of the active signature.
		 */
E
Erich Gamma 已提交
1849 1850 1851
		activeParameter: number;
	}

J
Johannes Rieken 已提交
1852 1853 1854 1855
	/**
	 * 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 已提交
1856
	export interface SignatureHelpProvider {
J
Johannes Rieken 已提交
1857 1858 1859 1860 1861 1862 1863 1864

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

J
Johannes Rieken 已提交
1870 1871 1872
	/**
	 * Completion item kinds.
	 */
E
Erich Gamma 已提交
1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893
	export enum CompletionItemKind {
		Text,
		Method,
		Function,
		Constructor,
		Field,
		Variable,
		Class,
		Interface,
		Module,
		Property,
		Unit,
		Value,
		Enum,
		Keyword,
		Snippet,
		Color,
		File,
		Reference
	}

J
Johannes Rieken 已提交
1894 1895 1896
	/**
	 * A completion item represents a text snippet that is
	 * proposed to complete text that is being typed.
J
Johannes Rieken 已提交
1897 1898 1899
	 *
	 * @see [CompletionItemProvider.provideCompletionItems](#CompletionItemProvider.provideCompletionItems)
	 * @see [CompletionItemProvider.resolveCompletionItem](#CompletionItemProvider.resolveCompletionItem)
J
Johannes Rieken 已提交
1900
	 */
E
Erich Gamma 已提交
1901
	export class CompletionItem {
J
Johannes Rieken 已提交
1902 1903 1904

		/**
		 * The label of this completion item. By default
A
Andre Weinand 已提交
1905
		 * this is also the text that is inserted when selecting
J
Johannes Rieken 已提交
1906 1907
		 * this completion.
		 */
E
Erich Gamma 已提交
1908
		label: string;
J
Johannes Rieken 已提交
1909 1910

		/**
S
Steven Clarke 已提交
1911
		 * The kind of this completion item. Based on the kind
J
Johannes Rieken 已提交
1912 1913
		 * an icon is chosen by the editor.
		 */
E
Erich Gamma 已提交
1914
		kind: CompletionItemKind;
J
Johannes Rieken 已提交
1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927

		/**
		 * 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 已提交
1928
		 * A string that should be used when comparing this item
J
Johannes Rieken 已提交
1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941
		 * 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 已提交
1942
		 * A string that should be inserted in a document when selecting
J
Johannes Rieken 已提交
1943 1944 1945
		 * this completion. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
E
Erich Gamma 已提交
1946
		insertText: string;
J
Johannes Rieken 已提交
1947 1948 1949 1950 1951

		/**
		 * 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.
1952 1953 1954
		 *
		 * The [range](#Range) of the edit must be single-line and one the same
		 * line completions where [requested](#CompletionItemProvider.provideCompletionItems) at.
J
Johannes Rieken 已提交
1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965
		 */
		textEdit: TextEdit;

		/**
		 * 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.
		 */
E
Erich Gamma 已提交
1966 1967 1968
		constructor(label: string);
	}

J
Johannes Rieken 已提交
1969 1970 1971
	/**
	 * The completion item provider interface defines the contract between extensions and
	 * the [IntelliSense](https://code.visualstudio.com/docs/editor/editingevolved#_intellisense).
J
Johannes Rieken 已提交
1972 1973 1974 1975
	 *
	 * 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 已提交
1976
	 * [provideCompletionItems](#CompletionItemProvider.provideCompletionItems)-function. Subsequently,
S
Steven Clarke 已提交
1977
	 * when a completion item is shown in the UI and gains focus this provider is asked to resolve
J
Johannes Rieken 已提交
1978
	 * the item, like adding [doc-comment](#CompletionItem.documentation) or [details](#CompletionItem.detail).
J
Johannes Rieken 已提交
1979
	 */
E
Erich Gamma 已提交
1980
	export interface CompletionItemProvider {
J
Johannes Rieken 已提交
1981 1982

		/**
J
Johannes Rieken 已提交
1983
		 * Provide completion items for the given position and document.
J
Johannes Rieken 已提交
1984
		 *
J
Johannes Rieken 已提交
1985 1986 1987 1988
		 * @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 completions or a thenable that resolves to such. The lack of a result can be
A
Andre Weinand 已提交
1989
		 * signaled by returning `undefined`, `null`, an empty array.
J
Johannes Rieken 已提交
1990
		 */
E
Erich Gamma 已提交
1991
		provideCompletionItems(document: TextDocument, position: Position, token: CancellationToken): CompletionItem[] | Thenable<CompletionItem[]>;
J
Johannes Rieken 已提交
1992 1993

		/**
J
Johannes Rieken 已提交
1994 1995 1996 1997
		 * 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 已提交
1998
		 *
J
Johannes Rieken 已提交
1999 2000
		 * @param item A completion item currently active in the UI.
		 * @param token A cancellation token.
S
Steven Clarke 已提交
2001
		 * @return The resolved completion item or a thenable that resolves to of such. It is OK to return the given
J
Johannes Rieken 已提交
2002
		 * `item`. When no result is returned, the given `item` will be used.
J
Johannes Rieken 已提交
2003
		 */
E
Erich Gamma 已提交
2004 2005 2006
		resolveCompletionItem?(item: CompletionItem, token: CancellationToken): CompletionItem | Thenable<CompletionItem>;
	}

J
Johannes Rieken 已提交
2007 2008 2009 2010
	/**
	 * A tuple of two characters, like a pair of
	 * opening and closing brackets.
	 */
E
Erich Gamma 已提交
2011 2012
	export type CharacterPair = [string, string];

J
Johannes Rieken 已提交
2013 2014 2015
	/**
	 * Describes how comments for a language work.
	 */
E
Erich Gamma 已提交
2016
	export interface CommentRule {
J
Johannes Rieken 已提交
2017 2018 2019 2020

		/**
		 * The line comment token, like `// this is a comment`
		 */
E
Erich Gamma 已提交
2021
		lineComment?: string;
J
Johannes Rieken 已提交
2022 2023 2024 2025 2026

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

A
Alex Dima 已提交
2029 2030 2031
	/**
	 * Describes indentation rules for a language.
	 */
E
Erich Gamma 已提交
2032
	export interface IndentationRule {
A
Alex Dima 已提交
2033 2034 2035
		/**
		 * If a line matches this pattern, then all the lines after it should be unindendented once (until another rule matches).
		 */
E
Erich Gamma 已提交
2036
		decreaseIndentPattern: RegExp;
A
Alex Dima 已提交
2037 2038 2039
		/**
		 * If a line matches this pattern, then all the lines after it should be indented once (until another rule matches).
		 */
E
Erich Gamma 已提交
2040
		increaseIndentPattern: RegExp;
A
Alex Dima 已提交
2041 2042 2043
		/**
		 * If a line matches this pattern, then **only the next line** after it should be indented once.
		 */
E
Erich Gamma 已提交
2044
		indentNextLinePattern?: RegExp;
A
Alex Dima 已提交
2045 2046 2047
		/**
		 * 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 已提交
2048 2049 2050
		unIndentedLinePattern?: RegExp;
	}

A
Alex Dima 已提交
2051 2052 2053
	/**
	 * Describes what to do with the indentation when pressing Enter.
	 */
E
Erich Gamma 已提交
2054
	export enum IndentAction {
A
Alex Dima 已提交
2055 2056 2057
		/**
		 * Insert new line and copy the previous line's indentation.
		 */
E
Erich Gamma 已提交
2058
		None,
A
Alex Dima 已提交
2059 2060 2061
		/**
		 * Insert new line and indent once (relative to the previous line's indentation).
		 */
E
Erich Gamma 已提交
2062
		Indent,
A
Alex Dima 已提交
2063 2064 2065 2066 2067
		/**
		 * Insert two new lines:
		 *  - the first one indented which will hold the cursor
		 *  - the second one at the same indentation level
		 */
E
Erich Gamma 已提交
2068
		IndentOutdent,
A
Alex Dima 已提交
2069 2070 2071
		/**
		 * Insert new line and outdent once (relative to the previous line's indentation).
		 */
E
Erich Gamma 已提交
2072 2073 2074
		Outdent
	}

A
Alex Dima 已提交
2075 2076 2077
	/**
	 * Describes what to do when pressing Enter.
	 */
E
Erich Gamma 已提交
2078
	export interface EnterAction {
A
Alex Dima 已提交
2079 2080 2081 2082 2083 2084 2085
		/**
		 * 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 已提交
2086
		appendText?: string;
A
Alex Dima 已提交
2087 2088 2089 2090
		/**
		 * Describes the number of characters to remove from the new line's indentation.
		 */
		removeText?: number;
E
Erich Gamma 已提交
2091 2092
	}

A
Alex Dima 已提交
2093 2094 2095
	/**
	 * Describes a rule to be evaluated when pressing Enter.
	 */
E
Erich Gamma 已提交
2096
	export interface OnEnterRule {
A
Alex Dima 已提交
2097 2098 2099
		/**
		 * This rule will only execute if the text before the cursor matches this regular expression.
		 */
E
Erich Gamma 已提交
2100
		beforeText: RegExp;
A
Alex Dima 已提交
2101 2102 2103
		/**
		 * This rule will only execute if the text after the cursor matches this regular expression.
		 */
E
Erich Gamma 已提交
2104
		afterText?: RegExp;
A
Alex Dima 已提交
2105 2106 2107
		/**
		 * The action to execute.
		 */
E
Erich Gamma 已提交
2108 2109 2110
		action: EnterAction;
	}

J
Johannes Rieken 已提交
2111
	/**
A
Andre Weinand 已提交
2112
	 * The language configuration interfaces defines the contract between extensions
S
Steven Clarke 已提交
2113
	 * and various editor features, like automatic bracket insertion, automatic indentation etc.
J
Johannes Rieken 已提交
2114
	 */
E
Erich Gamma 已提交
2115
	export interface LanguageConfiguration {
A
Alex Dima 已提交
2116 2117 2118
		/**
		 * The language's comment settings.
		 */
E
Erich Gamma 已提交
2119
		comments?: CommentRule;
A
Alex Dima 已提交
2120 2121 2122 2123
		/**
		 * The language's brackets.
		 * This configuration implicitly affects pressing Enter around these brackets.
		 */
E
Erich Gamma 已提交
2124
		brackets?: CharacterPair[];
A
Alex Dima 已提交
2125 2126 2127 2128 2129 2130 2131
		/**
		 * 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 已提交
2132
		wordPattern?: RegExp;
A
Alex Dima 已提交
2133 2134 2135
		/**
		 * The language's indentation settings.
		 */
E
Erich Gamma 已提交
2136
		indentationRules?: IndentationRule;
A
Alex Dima 已提交
2137 2138 2139
		/**
		 * The language's rules to be evaluated when pressing Enter.
		 */
E
Erich Gamma 已提交
2140 2141 2142
		onEnterRules?: OnEnterRule[];

		/**
A
Alex Dima 已提交
2143
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
2144 2145
		 *
		 * @deprecated Will be replaced by a better API soon.
E
Erich Gamma 已提交
2146 2147 2148 2149 2150 2151 2152 2153 2154
		 */
		__electricCharacterSupport?: {
			brackets: {
				tokenType: string;
				open: string;
				close: string;
				isElectric: boolean;
			}[];
			docComment?: {
A
Alex Dima 已提交
2155 2156 2157 2158
				scope: string;
				open: string;
				lineStart: string;
				close?: string;
E
Erich Gamma 已提交
2159 2160 2161 2162
			};
		};

		/**
A
Alex Dima 已提交
2163
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
2164
		 *
J
Johannes Rieken 已提交
2165
		 * @deprecated Will be replaced by a better API soon.
E
Erich Gamma 已提交
2166 2167 2168 2169 2170 2171 2172 2173 2174 2175
		 */
		__characterPairSupport?: {
			autoClosingPairs: {
				open: string;
				close: string;
				notIn?: string[];
			}[];
		};
	}

J
Johannes Rieken 已提交
2176 2177 2178 2179 2180
	/**
	 * 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 已提交
2181 2182 2183
	export interface WorkspaceConfiguration {

		/**
J
Johannes Rieken 已提交
2184 2185 2186
		 * Return a value from this configuration.
		 *
		 * @param section Configuration name, supports _dotted_ names.
J
Johannes Rieken 已提交
2187
		 * @param defaultValue A value should be returned when no value could be found, is `undefined`.
J
Johannes Rieken 已提交
2188
		 * @return The value `section` denotes or the default.
E
Erich Gamma 已提交
2189 2190 2191 2192
		 */
		get<T>(section: string, defaultValue?: T): T;

		/**
J
Johannes Rieken 已提交
2193 2194
		 * Check if this configuration has a certain value.
		 *
A
Andre Weinand 已提交
2195 2196
		 * @param section configuration name, supports _dotted_ names.
		 * @return `true` iff the section doesn't resolve to `undefined`.
E
Erich Gamma 已提交
2197 2198 2199 2200 2201 2202 2203 2204 2205 2206
		 */
		has(section: string): boolean;

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

J
Johannes Rieken 已提交
2207 2208 2209 2210 2211
	/**
	 * Represents a location inside a resource, such as a line
	 * inside a text file.
	 */
	export class Location {
J
Johannes Rieken 已提交
2212 2213 2214 2215

		/**
		 * The resource identifier of this location.
		 */
J
Johannes Rieken 已提交
2216
		uri: Uri;
J
Johannes Rieken 已提交
2217 2218 2219 2220

		/**
		 * The document range of this locations.
		 */
J
Johannes Rieken 已提交
2221
		range: Range;
J
Johannes Rieken 已提交
2222 2223 2224 2225 2226 2227 2228 2229

		/**
		 * 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 已提交
2230 2231
	}

E
Erich Gamma 已提交
2232 2233 2234 2235
	/**
	 * Represents the severity of diagnostics.
	 */
	export enum DiagnosticSeverity {
J
Johannes Rieken 已提交
2236 2237

		/**
S
Steven Clarke 已提交
2238
		 * Something not allowed by the rules of a language or other means.
J
Johannes Rieken 已提交
2239 2240 2241 2242 2243 2244
		 */
		Error = 0,

		/**
		 * Something suspicious but allowed.
		 */
E
Erich Gamma 已提交
2245
		Warning = 1,
J
Johannes Rieken 已提交
2246 2247 2248 2249 2250 2251 2252

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

		/**
A
Andre Weinand 已提交
2253
		 * Something to hint to a better way of doing it, like proposing
J
Johannes Rieken 已提交
2254 2255 2256
		 * a refactoring.
		 */
		Hint = 3
E
Erich Gamma 已提交
2257 2258 2259
	}

	/**
J
Johannes Rieken 已提交
2260 2261
	 * Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
	 * are only valid in the scope of a file.
E
Erich Gamma 已提交
2262
	 */
J
Johannes Rieken 已提交
2263 2264 2265 2266 2267
	export class Diagnostic {

		/**
		 * The range to which this diagnostic applies.
		 */
E
Erich Gamma 已提交
2268
		range: Range;
J
Johannes Rieken 已提交
2269 2270 2271 2272 2273 2274

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

2275 2276 2277 2278 2279 2280
		/**
		 * A human-readable string describing the source of this
		 * diagnostic, e.g. 'typescript' or 'super lint'.
		 */
		source: string;

J
Johannes Rieken 已提交
2281 2282 2283 2284 2285 2286
		/**
		 * The severity, default is [error](#DiagnosticSeverity.Error).
		 */
		severity: DiagnosticSeverity;

		/**
S
Steven Clarke 已提交
2287
		 * A code or identifier for this diagnostics. Will not be surfaced
A
Andre Weinand 已提交
2288
		 * to the user, but should be used for later processing, e.g. when
J
Johannes Rieken 已提交
2289 2290 2291 2292 2293
		 * providing [code actions](#CodeActionContext).
		 */
		code: string | number;

		/**
A
Andre Weinand 已提交
2294
		 * Creates a new diagnostic object.
J
Johannes Rieken 已提交
2295 2296 2297
		 *
		 * @param range The range to which this diagnostic applies.
		 * @param message The human-readable message.
A
Andre Weinand 已提交
2298
		 * @param severity The severity, default is [error](#DiagnosticSeverity.Error).
J
Johannes Rieken 已提交
2299 2300
		 */
		constructor(range: Range, message: string, severity?: DiagnosticSeverity);
E
Erich Gamma 已提交
2301 2302
	}

J
Johannes Rieken 已提交
2303 2304 2305 2306 2307 2308 2309 2310
	/**
	 * A diagnostics collection is a container that manages a set of
	 * [diagnostics](#Diagnostic). Diagnostics are always scopes to a
	 * a diagnostics collection and a resource.
	 *
	 * To get an instance of a `DiagnosticCollection` use
	 * [createDiagnosticCollection](#languages.createDiagnosticCollection).
	 */
E
Erich Gamma 已提交
2311 2312 2313
	export interface DiagnosticCollection {

		/**
J
Johannes Rieken 已提交
2314 2315 2316
		 * The name of this diagnostic collection, for instance `typescript`. Every diagnostic
		 * from this collection will be associated with this name. Also, the task framework uses this
		 * name when defining [problem matchers](https://code.visualstudio.com/docs/editor/tasks#_defining-a-problem-matcher).
E
Erich Gamma 已提交
2317 2318 2319 2320 2321
		 */
		name: string;

		/**
		 * Assign diagnostics for given resource. Will replace
J
Johannes Rieken 已提交
2322 2323 2324 2325
		 * existing diagnostics for that resource.
		 *
		 * @param uri A resource identifier.
		 * @param diagnostics Array of diagnostics or `undefined`
E
Erich Gamma 已提交
2326 2327 2328 2329 2330
		 */
		set(uri: Uri, diagnostics: Diagnostic[]): void;

		/**
		 * Remove all diagnostics from this collection that belong
J
Johannes Rieken 已提交
2331 2332 2333
		 * to the provided `uri`. The same as `#set(uri, undefined)`.
		 *
		 * @param uri A resource identifier.
E
Erich Gamma 已提交
2334 2335 2336 2337
		 */
		delete(uri: Uri): void;

		/**
A
Andre Weinand 已提交
2338
		 * Replace all entries in this collection.
J
Johannes Rieken 已提交
2339
		 *
A
Andre Weinand 已提交
2340
		 * @param entries An array of tuples, like `[[file1, [d1, d2]], [file2, [d3, d4, d5]]]`, or `undefined`.
E
Erich Gamma 已提交
2341 2342 2343 2344 2345 2346 2347 2348 2349
		 */
		set(entries: [Uri, Diagnostic[]][]): void;

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

J
Johannes Rieken 已提交
2350 2351 2352 2353
		/**
		 * Dispose and free associated resources. Calls
		 * [clear](#DiagnosticCollection.clear).
		 */
E
Erich Gamma 已提交
2354 2355 2356
		dispose(): void;
	}

J
Johannes Rieken 已提交
2357
	/**
J
Johannes Rieken 已提交
2358 2359
	 * Denotes a column in the VS Code window. Columns are
	 * used to show editors side by side.
J
Johannes Rieken 已提交
2360 2361 2362 2363 2364 2365 2366
	 */
	export enum ViewColumn {
		One = 1,
		Two = 2,
		Three = 3
	}

E
Erich Gamma 已提交
2367
	/**
J
Johannes Rieken 已提交
2368 2369 2370 2371
	 * An output channel is a container for readonly textual information.
	 *
	 * To get an instance of an `OutputChannel` use
	 * [createOutputChannel](#window.createOutputChannel).
E
Erich Gamma 已提交
2372
	 */
J
Johannes Rieken 已提交
2373
	export interface OutputChannel {
E
Erich Gamma 已提交
2374

J
Johannes Rieken 已提交
2375 2376 2377 2378 2379
		/**
		 * The human-readable name of this output channel.
		 * @readonly
		 */
		name: string;
E
Erich Gamma 已提交
2380 2381

		/**
J
Johannes Rieken 已提交
2382
		 * Append the given value to the channel.
E
Erich Gamma 已提交
2383
		 *
J
Johannes Rieken 已提交
2384
		 * @param value A string, falsy values will not be printed.
E
Erich Gamma 已提交
2385
		 */
J
Johannes Rieken 已提交
2386
		append(value: string): void;
E
Erich Gamma 已提交
2387 2388

		/**
J
Johannes Rieken 已提交
2389 2390
		 * Append the given value and a line feed character
		 * to the channel.
E
Erich Gamma 已提交
2391
		 *
J
Johannes Rieken 已提交
2392
		 * @param value A string, falsy values will be printed.
E
Erich Gamma 已提交
2393 2394 2395
		 */
		appendLine(value: string): void;

J
Johannes Rieken 已提交
2396 2397 2398
		/**
		 * Removes all output from the channel.
		 */
E
Erich Gamma 已提交
2399 2400
		clear(): void;

J
Johannes Rieken 已提交
2401 2402 2403
		/**
		 * Reveal this channel in the UI.
		 *
J
Johannes Rieken 已提交
2404
		 * @param column The column in which to show the channel, default in [one](#ViewColumn.One).
2405
		 * @param preserveFocus When `true` the channel will not take focus.
J
Johannes Rieken 已提交
2406
		 */
2407
		show(column?: ViewColumn, preserveFocus?: boolean): void;
E
Erich Gamma 已提交
2408

J
Johannes Rieken 已提交
2409 2410 2411
		/**
		 * Hide this channel from the UI.
		 */
E
Erich Gamma 已提交
2412 2413
		hide(): void;

J
Johannes Rieken 已提交
2414 2415 2416
		/**
		 * Dispose and free associated resources.
		 */
E
Erich Gamma 已提交
2417 2418 2419 2420
		dispose(): void;
	}

	/**
J
Johannes Rieken 已提交
2421
	 * Represents the alignment of status bar items.
E
Erich Gamma 已提交
2422 2423
	 */
	export enum StatusBarAlignment {
J
Johannes Rieken 已提交
2424 2425 2426 2427

		/**
		 * Aligned to the left side.
		 */
E
Erich Gamma 已提交
2428
		Left,
J
Johannes Rieken 已提交
2429 2430 2431 2432

		/**
		 * Aligned to the right side.
		 */
E
Erich Gamma 已提交
2433 2434 2435 2436 2437 2438 2439 2440 2441 2442
		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 已提交
2443 2444
		 * The alignment of this item.
		 *
E
Erich Gamma 已提交
2445 2446 2447 2448 2449
		 * @readonly
		 */
		alignment: StatusBarAlignment;

		/**
J
Johannes Rieken 已提交
2450 2451 2452
		 * The priority of this item. Higher value means the item should
		 * be shown more to the left.
		 *
E
Erich Gamma 已提交
2453 2454 2455 2456 2457
		 * @readonly
		 */
		priority: number;

		/**
J
Johannes Rieken 已提交
2458 2459
		 * The text to show for the entry. You can embed icons in the text by leveraging the syntax:
		 *
2460
		 * `My text $(icon-name) contains icons like $(icon'name) this one.`
J
Johannes Rieken 已提交
2461
		 *
2462 2463
		 * 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 已提交
2464
		 */
E
Erich Gamma 已提交
2465 2466 2467
		text: string;

		/**
J
Johannes Rieken 已提交
2468 2469
		 * The tooltip text when you hover over this entry.
		 */
E
Erich Gamma 已提交
2470 2471 2472
		tooltip: string;

		/**
J
Johannes Rieken 已提交
2473 2474
		 * The foreground color for this entry.
		 */
E
Erich Gamma 已提交
2475 2476 2477
		color: string;

		/**
J
Johannes Rieken 已提交
2478 2479 2480
		 * The identifier of a command to run on click. The command must be
		 * [known](#commands.getCommands).
		 */
E
Erich Gamma 已提交
2481 2482 2483 2484 2485 2486 2487 2488
		command: string;

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

		/**
J
Johannes Rieken 已提交
2489
		 * Hide the entry in the status bar.
E
Erich Gamma 已提交
2490 2491 2492 2493
		 */
		hide(): void;

		/**
J
Johannes Rieken 已提交
2494 2495
		 * Dispose and free associated resources. Call
		 * [hide](#StatusBarItem.hide).
E
Erich Gamma 已提交
2496 2497 2498 2499
		 */
		dispose(): void;
	}

J
Johannes Rieken 已提交
2500 2501 2502
	/**
	 * Represents an extension.
	 *
A
Alex Dima 已提交
2503
	 * To get an instance of an `Extension` use [getExtension](#extensions.getExtension).
J
Johannes Rieken 已提交
2504
	 */
E
Erich Gamma 已提交
2505
	export interface Extension<T> {
J
Johannes Rieken 已提交
2506

E
Erich Gamma 已提交
2507
		/**
J
Johannes Rieken 已提交
2508
		 * The canonical extension identifier in the form of: `publisher.name`.
2509 2510
		 *
		 * @readonly
E
Erich Gamma 已提交
2511 2512 2513 2514
		 */
		id: string;

		/**
J
Johannes Rieken 已提交
2515
		 * The absolute file path of the directory containing this extension.
2516 2517
		 *
		 * @readonly
E
Erich Gamma 已提交
2518 2519 2520 2521
		 */
		extensionPath: string;

		/**
2522 2523 2524
		 * `true` if the extension has been activated.
		 *
		 * @readonly
E
Erich Gamma 已提交
2525 2526 2527 2528 2529
		 */
		isActive: boolean;

		/**
		 * The parsed contents of the extension's package.json.
2530 2531
		 *
		 * @readonly
E
Erich Gamma 已提交
2532 2533 2534 2535
		 */
		packageJSON: any;

		/**
A
Alex Dima 已提交
2536
		 * The public API exported by this extension. It is an invalid action
J
Johannes Rieken 已提交
2537
		 * to access this field before this extension has been activated.
2538 2539
		 *
		 * @readonly
E
Erich Gamma 已提交
2540 2541 2542 2543 2544
		 */
		exports: T;

		/**
		 * Activates this extension and returns its public API.
J
Johannes Rieken 已提交
2545
		 *
S
Steven Clarke 已提交
2546
		 * @return A promise that will resolve when this extension has been activated.
E
Erich Gamma 已提交
2547 2548 2549 2550
		 */
		activate(): Thenable<T>;
	}

J
Johannes Rieken 已提交
2551
	/**
S
Steven Clarke 已提交
2552 2553
	 * An extension context is a collection of utilities private to an
	 * extension.
J
Johannes Rieken 已提交
2554
	 *
S
Steven Clarke 已提交
2555
	 * An instance of an `ExtensionContext` is provided as the first
J
Johannes Rieken 已提交
2556 2557
	 * parameter to the `activate`-call of an extension.
	 */
E
Erich Gamma 已提交
2558 2559 2560 2561
	export interface ExtensionContext {

		/**
		 * An array to which disposables can be added. When this
J
Johannes Rieken 已提交
2562
		 * extension is deactivated the disposables will be disposed.
E
Erich Gamma 已提交
2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573
		 */
		subscriptions: { dispose(): any }[];

		/**
		 * A memento object that stores state in the context
		 * of the currently opened [workspace](#workspace.path).
		 */
		workspaceState: Memento;

		/**
		 * A memento object that stores state independent
A
Andre Weinand 已提交
2574
		 * of the current opened [workspace](#workspace.path).
E
Erich Gamma 已提交
2575 2576 2577 2578
		 */
		globalState: Memento;

		/**
J
Johannes Rieken 已提交
2579
		 * The absolute file path of the directory containing the extension.
E
Erich Gamma 已提交
2580 2581 2582 2583
		 */
		extensionPath: string;

		/**
A
Alex Dima 已提交
2584 2585 2586 2587
		 * 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 已提交
2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598
		 */
		asAbsolutePath(relativePath: string): string;
	}

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

		/**
J
Johannes Rieken 已提交
2599 2600 2601 2602 2603
		 * 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 已提交
2604
		 * @return The stored value, `undefined`, or the defaultValue.
E
Erich Gamma 已提交
2605 2606 2607 2608
		 */
		get<T>(key: string, defaultValue?: T): T;

		/**
S
Steven Clarke 已提交
2609
		 * Store a value. The value must be JSON-stringifyable.
J
Johannes Rieken 已提交
2610 2611 2612
		 *
		 * @param key A string.
		 * @param value A value. MUST not contain cyclic references.
E
Erich Gamma 已提交
2613 2614 2615 2616 2617
		 */
		update(key: string, value: any): Thenable<void>;
	}

	/**
2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630
	 * 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 已提交
2631
	 * Commands from other extensions and from the editor itself are accessible to an extension. However,
2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650
	 * 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 已提交
2651 2652 2653 2654 2655
	 */
	export namespace commands {

		/**
		 * Registers a command that can be invoked via a keyboard shortcut,
S
Steven Clarke 已提交
2656
		 * a menu item, an action, or directly.
E
Erich Gamma 已提交
2657
		 *
J
Johannes Rieken 已提交
2658 2659 2660 2661 2662
		 * 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 已提交
2663
		 * @param thisArg The `this` context used when invoking the handler function.
J
Johannes Rieken 已提交
2664
		 * @return Disposable which unregisters this command on disposal.
E
Erich Gamma 已提交
2665 2666 2667 2668
		 */
		export function registerCommand(command: string, callback: (...args: any[]) => any, thisArg?: any): Disposable;

		/**
J
Johannes Rieken 已提交
2669
		 * Registers a text editor command that can be invoked via a keyboard shortcut,
S
Steven Clarke 已提交
2670
		 * a menu item, an action, or directly.
E
Erich Gamma 已提交
2671
		 *
J
Johannes Rieken 已提交
2672
		 * Text editor commands are different from ordinary [commands](#commands.registerCommand) as
S
Steven Clarke 已提交
2673
		 * they only execute when there is an active editor when the command is called. Also, the
J
Johannes Rieken 已提交
2674 2675 2676 2677 2678
		 * 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 已提交
2679
		 * @param thisArg The `this` context used when invoking the handler function.
J
Johannes Rieken 已提交
2680
		 * @return Disposable which unregisters this command on disposal.
E
Erich Gamma 已提交
2681 2682 2683 2684
		 */
		export function registerTextEditorCommand(command: string, callback: (textEditor: TextEditor, edit: TextEditorEdit) => void, thisArg?: any): Disposable;

		/**
J
Johannes Rieken 已提交
2685 2686 2687
		 * Executes the command denoted by the given command identifier.
		 *
		 * When executing an editor command not all types are allowed to
2688
		 * be passed as arguments. Allowed are the primitive types `string`, `boolean`,
J
Johannes Rieken 已提交
2689
		 * `number`, `undefined`, and `null`, as well as classes defined in this API.
S
Steven Clarke 已提交
2690
		 * There are no restrictions when executing commands that have been contributed
J
Johannes Rieken 已提交
2691
		 * by extensions.
E
Erich Gamma 已提交
2692
		 *
J
Johannes Rieken 已提交
2693
		 * @param command Identifier of the command to execute.
J
Johannes Rieken 已提交
2694 2695 2696
		 * @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 已提交
2697 2698 2699 2700
		 */
		export function executeCommand<T>(command: string, ...rest: any[]): Thenable<T>;

		/**
2701 2702
		 * Retrieve the list of all available commands. Commands starting an underscore are
		 * treated as internal commands.
E
Erich Gamma 已提交
2703
		 *
2704
		 * @param filterInternal Set `true` to not see internal commands (starting with an underscore)
E
Erich Gamma 已提交
2705 2706
		 * @return Thenable that resolves to a list of command ids.
		 */
2707
		export function getCommands(filterInternal?: boolean): Thenable<string[]>;
E
Erich Gamma 已提交
2708 2709 2710
	}

	/**
2711 2712 2713
	 * 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 已提交
2714 2715 2716 2717 2718
	 */
	export namespace window {

		/**
		 * The currently active editor or undefined. The active editor is the one
S
Steven Clarke 已提交
2719
		 * that currently has focus or, when none has focus, the one that has changed
E
Erich Gamma 已提交
2720 2721 2722 2723 2724
		 * input most recently.
		 */
		export let activeTextEditor: TextEditor;

		/**
2725
		 * The currently visible editors or an empty array.
E
Erich Gamma 已提交
2726 2727 2728 2729
		 */
		export let visibleTextEditors: TextEditor[];

		/**
2730
		 * An [event](#Event) which fires when the [active editor](#window.activeTextEditor)
E
Erich Gamma 已提交
2731 2732 2733 2734 2735
		 * has changed.
		 */
		export const onDidChangeActiveTextEditor: Event<TextEditor>;

		/**
A
Andre Weinand 已提交
2736
		 * An [event](#Event) which fires when the selection in an editor has changed.
E
Erich Gamma 已提交
2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751
		 */
		export const onDidChangeTextEditorSelection: Event<TextEditorSelectionChangeEvent>;

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

		/**
		 * 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)__.
2752
		 * @param preserveFocus When `true` the editor will not take focus.
E
Erich Gamma 已提交
2753 2754
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
2755
		export function showTextDocument(document: TextDocument, column?: ViewColumn, preserveFocus?: boolean): Thenable<TextEditor>;
E
Erich Gamma 已提交
2756 2757

		/**
J
Johannes Rieken 已提交
2758 2759 2760 2761
		 * 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 已提交
2762 2763 2764 2765 2766 2767 2768
		 */
		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 已提交
2769 2770
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
2771
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
2772 2773 2774 2775
		 */
		export function showInformationMessage(message: string, ...items: string[]): Thenable<string>;

		/**
J
Johannes Rieken 已提交
2776
		 * Show an information message.
J
Johannes Rieken 已提交
2777
		 *
E
Erich Gamma 已提交
2778
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
2779 2780 2781
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
2782
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
2783 2784 2785 2786
		 */
		export function showInformationMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T>;

		/**
J
Johannes Rieken 已提交
2787
		 * Show a warning message.
J
Johannes Rieken 已提交
2788
		 *
E
Erich Gamma 已提交
2789
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
2790 2791 2792
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
2793
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
2794 2795 2796 2797
		 */
		export function showWarningMessage(message: string, ...items: string[]): Thenable<string>;

		/**
J
Johannes Rieken 已提交
2798
		 * Show a warning message.
J
Johannes Rieken 已提交
2799
		 *
E
Erich Gamma 已提交
2800
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
2801 2802 2803
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
2804
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
2805 2806 2807 2808
		 */
		export function showWarningMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T>;

		/**
J
Johannes Rieken 已提交
2809
		 * Show an error message.
J
Johannes Rieken 已提交
2810
		 *
E
Erich Gamma 已提交
2811
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
2812 2813 2814
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
2815
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
2816 2817 2818 2819
		 */
		export function showErrorMessage(message: string, ...items: string[]): Thenable<string>;

		/**
J
Johannes Rieken 已提交
2820
		 * Show an error message.
J
Johannes Rieken 已提交
2821
		 *
E
Erich Gamma 已提交
2822
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
2823 2824 2825
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
2826
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
2827 2828 2829 2830 2831 2832
		 */
		export function showErrorMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T>;

		/**
		 * Shows a selection list.
		 *
J
Johannes Rieken 已提交
2833 2834 2835
		 * @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.
		 * @return A promise that resolves to the selection or undefined.
E
Erich Gamma 已提交
2836 2837 2838 2839 2840 2841
		 */
		export function showQuickPick(items: string[] | Thenable<string[]>, options?: QuickPickOptions): Thenable<string>;

		/**
		 * Shows a selection list.
		 *
J
Johannes Rieken 已提交
2842 2843 2844
		 * @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.
		 * @return A promise that resolves to the selected item or undefined.
E
Erich Gamma 已提交
2845 2846 2847 2848 2849 2850
		 */
		export function showQuickPick<T extends QuickPickItem>(items: T[] | Thenable<T[]>, options?: QuickPickOptions): Thenable<T>;

		/**
		 * Opens an input box to ask the user for input.
		 *
S
Steven Clarke 已提交
2851
		 * The returned value will be undefined if the input box was canceled (e.g. pressing ESC). Otherwise the
A
Andre Weinand 已提交
2852
		 * returned value will be the string typed by the user or an empty string if the user did not type
S
Steven Clarke 已提交
2853
		 * anything but dismissed the input box with OK.
E
Erich Gamma 已提交
2854
		 *
J
Johannes Rieken 已提交
2855 2856
		 * @param options Configures the behavior of the input box.
		 * @return A promise that resolves to a string the user provided or to `undefined` in case of dismissal.
E
Erich Gamma 已提交
2857 2858 2859 2860
		 */
		export function showInputBox(options?: InputBoxOptions): Thenable<string>;

		/**
J
Johannes Rieken 已提交
2861 2862
		 * Create a new [output channel](#OutputChannel) with the given name.
		 *
S
Steven Clarke 已提交
2863
		 * @param name Human-readable string which will be used to represent the channel in the UI.
E
Erich Gamma 已提交
2864 2865 2866 2867
		 */
		export function createOutputChannel(name: string): OutputChannel;

		/**
S
Steven Clarke 已提交
2868
		 * Set a message to the status bar. This is a short hand for the more powerful
E
Erich Gamma 已提交
2869
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
2870
		 *
A
Andre Weinand 已提交
2871
		 * @param text The message to show, support icon subtitution as in status bar [items](#StatusBarItem.text).
J
Johannes Rieken 已提交
2872
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
2873 2874 2875 2876
		 */
		export function setStatusBarMessage(text: string): Disposable;

		/**
S
Steven Clarke 已提交
2877
		 * Set a message to the status bar. This is a short hand for the more powerful
J
Johannes Rieken 已提交
2878
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
2879
		 *
A
Andre Weinand 已提交
2880
		 * @param text The message to show, support icon subtitution as in status bar [items](#StatusBarItem.text).
E
Erich Gamma 已提交
2881
		 * @param hideAfterTimeout Timeout in milliseconds after which the message will be disposed.
J
Johannes Rieken 已提交
2882
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
2883 2884 2885 2886
		 */
		export function setStatusBarMessage(text: string, hideAfterTimeout: number): Disposable;

		/**
S
Steven Clarke 已提交
2887
		 * Set a message to the status bar. This is a short hand for the more powerful
J
Johannes Rieken 已提交
2888
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
2889
		 *
A
Andre Weinand 已提交
2890
		 * @param text The message to show, support icon subtitution as in status bar [items](#StatusBarItem.text).
E
Erich Gamma 已提交
2891
		 * @param hideWhenDone Thenable on which completion (resolve or reject) the message will be disposed.
J
Johannes Rieken 已提交
2892
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
2893 2894 2895 2896
		 */
		export function setStatusBarMessage(text: string, hideWhenDone: Thenable<any>): Disposable;

		/**
J
Johannes Rieken 已提交
2897 2898
		 * Creates a status bar [item](#StatusBarItem).
		 *
J
Johannes Rieken 已提交
2899
		 * @param alignment The alignment of the item.
J
Johannes Rieken 已提交
2900
		 * @param priority The priority of the item. Higher values mean the item should be shown more to the left.
J
Johannes Rieken 已提交
2901 2902
		 * @return A new status bar item.
		 */
E
Erich Gamma 已提交
2903 2904 2905 2906
		export function createStatusBarItem(alignment?: StatusBarAlignment, priority?: number): StatusBarItem;
	}

	/**
A
Alex Dima 已提交
2907
	 * An event describing an individual change in the text of a [document](#TextDocument).
E
Erich Gamma 已提交
2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924
	 */
	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 已提交
2925
	 * An event describing a transactional [document](#TextDocument) change.
E
Erich Gamma 已提交
2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940
	 */
	export interface TextDocumentChangeEvent {

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

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

	/**
2941 2942 2943 2944 2945 2946
	 * 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
	 * events and for [finding](#workspace#findFiles) files. Both perform well and run _outside_
S
Steven Clarke 已提交
2947
	 * the editor-process so that they should be always used instead of nodejs-equivalents.
E
Erich Gamma 已提交
2948 2949 2950 2951
	 */
	export namespace workspace {

		/**
J
Johannes Rieken 已提交
2952 2953 2954
		 * Creates a file system watcher.
		 *
		 * A glob pattern that filters the file events must be provided. Optionally, flags to ignore certain
S
Steven Clarke 已提交
2955
		 * kinds of events can be provided. To stop listening to events the watcher must be disposed.
E
Erich Gamma 已提交
2956
		 *
A
Andre Weinand 已提交
2957
		 * @param globPattern A glob pattern that is applied to the names of created, changed, and deleted files.
J
Johannes Rieken 已提交
2958 2959 2960 2961
		 * @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 已提交
2962 2963 2964 2965
		 */
		export function createFileSystemWatcher(globPattern: string, ignoreCreateEvents?: boolean, ignoreChangeEvents?: boolean, ignoreDeleteEvents?: boolean): FileSystemWatcher;

		/**
J
Johannes Rieken 已提交
2966 2967
		 * The folder that is open in VS Code. `undefined` when no folder
		 * has been opened.
E
Erich Gamma 已提交
2968 2969 2970 2971
		 */
		export let rootPath: string;

		/**
J
Johannes Rieken 已提交
2972 2973 2974 2975 2976 2977 2978
		 * 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 已提交
2979 2980 2981
		 */
		export function asRelativePath(pathOrUri: string | Uri): string;

J
Johannes Rieken 已提交
2982 2983 2984
		/**
		 * Find files in the workspace.
		 *
2985
		 * @sample `findFiles('**∕*.js', '**∕node_modules∕**', 10)`
J
Johannes Rieken 已提交
2986
		 * @param include A glob pattern that defines the files to search for.
S
Steven Clarke 已提交
2987
		 * @param exclude A glob pattern that defines files and folders to exclude.
J
Johannes Rieken 已提交
2988
		 * @param maxResults An upper-bound for the result.
2989
		 * @param token A token that can be used to signal cancellation to the underlying search engine.
J
Johannes Rieken 已提交
2990 2991
		 * @return A thenable that resolves to an array of resource identifiers.
		 */
2992
		export function findFiles(include: string, exclude: string, maxResults?: number, token?: CancellationToken): Thenable<Uri[]>;
E
Erich Gamma 已提交
2993 2994

		/**
J
Johannes Rieken 已提交
2995 2996 2997
		 * Save all dirty files.
		 *
		 * @param includeUntitled Also save files that have been created during this session.
S
Steven Clarke 已提交
2998
		 * @return A thenable that resolves when the files have been saved.
E
Erich Gamma 已提交
2999 3000 3001 3002
		 */
		export function saveAll(includeUntitled?: boolean): Thenable<boolean>;

		/**
J
Johannes Rieken 已提交
3003 3004 3005
		 * Make changes to one or many resources as defined by the given
		 * [workspace edit](#WorkspaceEdit).
		 *
S
Steven Clarke 已提交
3006 3007 3008
		 * 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 已提交
3009 3010 3011
		 *
		 * @param edit A workspace edit.
		 * @return A thenable that resolves when the edit could be applied.
E
Erich Gamma 已提交
3012 3013 3014 3015 3016
		 */
		export function applyEdit(edit: WorkspaceEdit): Thenable<boolean>;

		/**
		 * All text documents currently known to the system.
J
Johannes Rieken 已提交
3017 3018
		 *
		 * @readonly
E
Erich Gamma 已提交
3019 3020 3021 3022 3023 3024 3025 3026
		 */
		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 已提交
3027 3028 3029
		 *
		 * 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:/Users/frodo/new.js'. The language will be derived from the file name.
J
Johannes Rieken 已提交
3030
		 *
A
Andre Weinand 已提交
3031
		 * Uris with other schemes will make this method return a rejected promise.
E
Erich Gamma 已提交
3032 3033 3034 3035 3036 3037 3038
		 *
		 * @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 已提交
3039 3040 3041
		 * A short-hand for `openTextDocument(Uri.file(fileName))`.
		 *
		 * @see [openTextDocument](#openTextDocument)
A
Andre Weinand 已提交
3042 3043
		 * @param fileName A name of a file on disk.
		 * @return A promise that resolves to a [document](#TextDocument).
E
Erich Gamma 已提交
3044 3045 3046
		 */
		export function openTextDocument(fileName: string): Thenable<TextDocument>;

J
Johannes Rieken 已提交
3047
		/**
3048 3049 3050
		 * Register a text document content provider.
		 *
		 * Only one provider can be registered per scheme.
J
Johannes Rieken 已提交
3051
		 *
3052 3053 3054
		 * @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 已提交
3055 3056 3057
		 */
		export function registerTextDocumentContentProvider(scheme: string, provider: TextDocumentContentProvider): Disposable;

A
Alex Dima 已提交
3058
		/**
J
Johannes Rieken 已提交
3059
		 * An event that is emitted when a [text document](#TextDocument) is opened.
A
Alex Dima 已提交
3060
		 */
E
Erich Gamma 已提交
3061 3062
		export const onDidOpenTextDocument: Event<TextDocument>;

A
Alex Dima 已提交
3063 3064 3065
		/**
		 * An event that is emitted when a [text document](#TextDocument) is disposed.
		 */
E
Erich Gamma 已提交
3066 3067
		export const onDidCloseTextDocument: Event<TextDocument>;

A
Alex Dima 已提交
3068 3069 3070
		/**
		 * An event that is emitted when a [text document](#TextDocument) is changed.
		 */
E
Erich Gamma 已提交
3071 3072
		export const onDidChangeTextDocument: Event<TextDocumentChangeEvent>;

A
Alex Dima 已提交
3073 3074 3075
		/**
		 * An event that is emitted when a [text document](#TextDocument) is saved to disk.
		 */
E
Erich Gamma 已提交
3076 3077 3078
		export const onDidSaveTextDocument: Event<TextDocument>;

		/**
J
Johannes Rieken 已提交
3079 3080 3081
		 * Get a configuration object.
		 *
		 * When a section-identifier is provided only that part of the configuration
A
Andre Weinand 已提交
3082
		 * is returned. Dots in the section-identifier are interpreted as child-access,
J
Johannes Rieken 已提交
3083
		 * like `{ myExt: { setting: { doIt: true }}}` and `getConfiguration('myExt.setting.doIt') === true`.
E
Erich Gamma 已提交
3084
		 *
J
Johannes Rieken 已提交
3085 3086 3087
		 *
		 * @param section A dot-separated identifier.
		 * @return The full workspace configuration or a subset.
E
Erich Gamma 已提交
3088 3089 3090
		 */
		export function getConfiguration(section?: string): WorkspaceConfiguration;

J
Johannes Rieken 已提交
3091 3092 3093
		/**
		 * An event that is emitted when the [configuration](#WorkspaceConfiguration) changed.
		 */
E
Erich Gamma 已提交
3094 3095 3096
		export const onDidChangeConfiguration: Event<void>;
	}

J
Johannes Rieken 已提交
3097
	/**
3098 3099 3100 3101 3102 3103 3104
	 * 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 已提交
3105
	 * The editor provides an API that makes it simple to provide such common features by having all UI and actions already in place and
3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116
	 * 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!');
	 * 		}
	 * });
	 * ```
3117 3118 3119
	 *
	 * 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 已提交
3120
	 * a selector will result in a [score](#languages.match) that is used to determine if and how a provider shall be used. When
3121 3122 3123
	 * 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 已提交
3124
	 */
E
Erich Gamma 已提交
3125 3126 3127 3128 3129 3130 3131 3132 3133
	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 已提交
3134
		 * Compute the match between a document [selector](#DocumentSelector) and a document. Values
S
Steven Clarke 已提交
3135
		 * greater than zero mean the selector matches the document. The more individual matches a selector
3136 3137 3138
		 * and a document have, the higher the score is. These are the abstract rules given a `selector`:
		 *
		 * ```
S
Steven Clarke 已提交
3139
		 * (1) When selector is an array, return the maximum individual result.
3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151
		 * (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`.
		 * (3) When selector is a [filter](#DocumentFilter) every property must score higher `0`. Iff the score is the sum of the following:
		 *	(3.1) When [language](#DocumentFilter.language) is set apply rules from #2, when `0` the total score is `0`.
		 *	(3.2) When [scheme](#Document.scheme) is set and equals the [uri](#TextDocument.uri)-scheme add `10` to the score, else the total score is `0`.
		 *	(3.3) When [pattern](#Document.pattern) is set
		 * 		(3.3.1) pattern eqauls the [uri](#TextDocument.uri)-fsPath add `10` to the score,
		 *		(3.3.1) if the pattern matches as glob-pattern add `5` to the score,
		 *		(3.3.1) the total score is `0`
		 * ```
J
Johannes Rieken 已提交
3152 3153 3154
		 *
		 * @param selector A document selector.
		 * @param document A text document.
J
Johannes Rieken 已提交
3155
		 * @return A number `>0` when the selector matches and `0` when the selector does not match.
E
Erich Gamma 已提交
3156 3157 3158 3159
		 */
		export function match(selector: DocumentSelector, document: TextDocument): number;

		/**
S
Steven Clarke 已提交
3160
		 * Create a diagnostics collection.
J
Johannes Rieken 已提交
3161 3162 3163
		 *
		 * @param name The [name](#DiagnosticCollection.name) of the collection.
		 * @return A new diagnostic collection.
E
Erich Gamma 已提交
3164 3165 3166 3167
		 */
		export function createDiagnosticCollection(name?: string): DiagnosticCollection;

		/**
J
Johannes Rieken 已提交
3168 3169 3170
		 * Register a completion provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
3171
		 * by their [score](#languages.match) and groups of equal score are sequentially asked for
J
Johannes Rieken 已提交
3172
		 * completion items. The process stops when one or many providers of a group return a
3173 3174
		 * result. A failing provider (rejected promise or exception) will not fail the whole
		 * operation.
E
Erich Gamma 已提交
3175
		 *
J
Johannes Rieken 已提交
3176 3177 3178 3179 3180 3181 3182 3183
		 * @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 已提交
3184 3185 3186
		 * Register a code action provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
3187 3188
		 * 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 已提交
3189 3190
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
J
Johannes Rieken 已提交
3191
		 * @param provider A code action provider.
J
Johannes Rieken 已提交
3192
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
3193
		 */
J
Johannes Rieken 已提交
3194
		export function registerCodeActionsProvider(selector: DocumentSelector, provider: CodeActionProvider): Disposable;
E
Erich Gamma 已提交
3195 3196

		/**
J
Johannes Rieken 已提交
3197 3198 3199
		 * Register a code lens provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
3200 3201
		 * 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 已提交
3202
		 *
J
Johannes Rieken 已提交
3203 3204 3205
		 * @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 已提交
3206
		 */
J
Johannes Rieken 已提交
3207
		export function registerCodeLensProvider(selector: DocumentSelector, provider: CodeLensProvider): Disposable;
E
Erich Gamma 已提交
3208 3209

		/**
J
Johannes Rieken 已提交
3210 3211 3212
		 * Register a definition provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
3213 3214
		 * 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 已提交
3215
		 *
J
Johannes Rieken 已提交
3216 3217 3218
		 * @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 已提交
3219 3220 3221 3222
		 */
		export function registerDefinitionProvider(selector: DocumentSelector, provider: DefinitionProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3223 3224 3225
		 * Register a hover provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
3226 3227
		 * 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 已提交
3228
		 *
J
Johannes Rieken 已提交
3229 3230 3231
		 * @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 已提交
3232 3233 3234 3235
		 */
		export function registerHoverProvider(selector: DocumentSelector, provider: HoverProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3236 3237 3238 3239
		 * 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.
3240
		 * The process stops when a provider returns a `non-falsy` or `non-failure` result.
E
Erich Gamma 已提交
3241
		 *
J
Johannes Rieken 已提交
3242 3243 3244
		 * @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 已提交
3245 3246 3247 3248
		 */
		export function registerDocumentHighlightProvider(selector: DocumentSelector, provider: DocumentHighlightProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3249 3250 3251
		 * Register a document symbol provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
3252 3253
		 * 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 已提交
3254
		 *
J
Johannes Rieken 已提交
3255 3256 3257
		 * @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 已提交
3258 3259 3260 3261
		 */
		export function registerDocumentSymbolProvider(selector: DocumentSelector, provider: DocumentSymbolProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3262 3263 3264
		 * Register a workspace symbol provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
3265 3266
		 * 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 已提交
3267
		 *
J
Johannes Rieken 已提交
3268 3269
		 * @param provider A workspace symbol provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
3270 3271 3272 3273
		 */
		export function registerWorkspaceSymbolProvider(provider: WorkspaceSymbolProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3274 3275 3276
		 * Register a reference provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
3277 3278
		 * 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 已提交
3279
		 *
J
Johannes Rieken 已提交
3280 3281 3282
		 * @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 已提交
3283 3284 3285 3286
		 */
		export function registerReferenceProvider(selector: DocumentSelector, provider: ReferenceProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3287 3288 3289
		 * Register a reference provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
3290 3291
		 * by their [score](#languages.match) and the result of best-matching provider is used. Failure
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
3292
		 *
J
Johannes Rieken 已提交
3293 3294 3295
		 * @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 已提交
3296 3297 3298 3299
		 */
		export function registerRenameProvider(selector: DocumentSelector, provider: RenameProvider): Disposable;

		/**
A
Andre Weinand 已提交
3300
		 * Register a formatting provider for a document.
J
Johannes Rieken 已提交
3301 3302
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
3303 3304
		 * by their [score](#languages.match) and the result of best-matching provider is used. Failure
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
3305
		 *
J
Johannes Rieken 已提交
3306 3307 3308
		 * @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 已提交
3309 3310 3311 3312
		 */
		export function registerDocumentFormattingEditProvider(selector: DocumentSelector, provider: DocumentFormattingEditProvider): Disposable;

		/**
J
Johannes Rieken 已提交
3313 3314 3315
		 * Register a formatting provider for a document range.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
3316 3317
		 * by their [score](#languages.match) and the result of best-matching provider is used. Failure
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
3318
		 *
J
Johannes Rieken 已提交
3319 3320 3321
		 * @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 已提交
3322 3323 3324 3325
		 */
		export function registerDocumentRangeFormattingEditProvider(selector: DocumentSelector, provider: DocumentRangeFormattingEditProvider): Disposable;

		/**
A
Andre Weinand 已提交
3326
		 * Register a formatting provider that works on type.
J
Johannes Rieken 已提交
3327 3328
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
3329 3330
		 * by their [score](#languages.match) and the result of best-matching provider is used. Failure
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
3331
		 *
J
Johannes Rieken 已提交
3332 3333 3334
		 * @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 已提交
3335
		 * @param moreTriggerCharacter More trigger characters.
J
Johannes Rieken 已提交
3336
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
3337 3338 3339 3340
		 */
		export function registerOnTypeFormattingEditProvider(selector: DocumentSelector, provider: OnTypeFormattingEditProvider, firstTriggerCharacter: string, ...moreTriggerCharacter: string[]): Disposable;

		/**
J
Johannes Rieken 已提交
3341 3342 3343
		 * Register a signature help provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
3344 3345
		 * by their [score](#languages.match) and the result of best-matching provider is used. Failure
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
3346
		 *
J
Johannes Rieken 已提交
3347 3348 3349 3350
		 * @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 已提交
3351 3352 3353 3354
		 */
		export function registerSignatureHelpProvider(selector: DocumentSelector, provider: SignatureHelpProvider, ...triggerCharacters: string[]): Disposable;

		/**
J
Johannes Rieken 已提交
3355
		 * Set a [language configuration](#LanguageConfiguration) for a language.
E
Erich Gamma 已提交
3356
		 *
A
Andre Weinand 已提交
3357
		 * @param language A language identifier like `typescript`.
J
Johannes Rieken 已提交
3358 3359
		 * @param configuration Language configuration.
		 * @return A [disposable](#Disposable) that unsets this configuration.
E
Erich Gamma 已提交
3360 3361 3362 3363
		 */
		export function setLanguageConfiguration(language: string, configuration: LanguageConfiguration): Disposable;
	}

J
Johannes Rieken 已提交
3364
	/**
3365 3366 3367
	 * Namespace for dealing with installed extensions. Extensions are represented
	 * by an [extension](#Extension)-interface which allows to reflect on them.
	 *
S
Steven Clarke 已提交
3368
	 * Extension writers can provide APIs to other extensions by returning their API public
3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394
	 * 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 已提交
3395
	 */
E
Erich Gamma 已提交
3396 3397
	export namespace extensions {

J
Johannes Rieken 已提交
3398
		/**
3399
		 * Get an extension by its full identifier in the form of: `publisher.name`.
J
Johannes Rieken 已提交
3400
		 *
J
Johannes Rieken 已提交
3401
		 * @param extensionId An extension identifier.
J
Johannes Rieken 已提交
3402 3403
		 * @return An extension or `undefined`.
		 */
E
Erich Gamma 已提交
3404 3405
		export function getExtension(extensionId: string): Extension<any>;

J
Johannes Rieken 已提交
3406
		/**
A
Andre Weinand 已提交
3407
		 * Get an extension its full identifier in the form of: `publisher.name`.
J
Johannes Rieken 已提交
3408 3409 3410
		 *
		 * @param extensionId An extension identifier.
		 * @return An extension or `undefined`.
J
Johannes Rieken 已提交
3411
		 */
E
Erich Gamma 已提交
3412 3413 3414 3415 3416 3417 3418 3419 3420
		export function getExtension<T>(extensionId: string): Extension<T>;

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

3421 3422
// TS 1.6 & node_module
// export = vscode;
J
Johannes Rieken 已提交
3423 3424

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

E
Erich Gamma 已提交
3430 3431 3432 3433
/**
 * 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 已提交
3434
 * we recommend the use of native promises which are available in VS Code.
E
Erich Gamma 已提交
3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449
 */
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 已提交
3450
 * Represents the completion of an asynchronous operation.
E
Erich Gamma 已提交
3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480
 */
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 已提交
3481
	 * a resolve callback used to resolve the promise with a value or the result of another promise,
E
Erich Gamma 已提交
3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523
	 * 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>;

	/**
	  * Creates a new resolved promise for the provided value.
	  * @param value A promise.
	  * @returns A promise whose internal state matches the provided promise.
	  */
	resolve<T>(value: T | Thenable<T>): Promise<T>;

	/**
A
Andre Weinand 已提交
3524
	 * Creates a new resolved promise.
E
Erich Gamma 已提交
3525 3526 3527 3528 3529 3530 3531 3532
	 * @returns A resolved promise.
	 */
	resolve(): Promise<void>;

	// [Symbol.species]: Function;
}

declare var Promise: PromiseConstructor;