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

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

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

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

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

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

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

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

		/**
J
Johannes Rieken 已提交
52
		 * The text of this line without the line separator characters.
E
Erich Gamma 已提交
53
		 */
Y
Yuki Ueda 已提交
54
		readonly text: string;
E
Erich Gamma 已提交
55 56

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

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

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

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

	/**
	 * 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 已提交
86 87 88
		 * 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 已提交
89
		 */
Y
Yuki Ueda 已提交
90
		readonly uri: Uri;
E
Erich Gamma 已提交
91 92

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

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

		/**
J
Johannes Rieken 已提交
104
		 * The identifier of the language associated with this document.
E
Erich Gamma 已提交
105
		 */
Y
Yuki Ueda 已提交
106
		readonly languageId: string;
E
Erich Gamma 已提交
107 108 109 110 111

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

		/**
A
Andre Weinand 已提交
115
		 * true if there are unpersisted changes.
E
Erich Gamma 已提交
116
		 */
Y
Yuki Ueda 已提交
117
		readonly isDirty: boolean;
E
Erich Gamma 已提交
118 119 120 121 122

		/**
		 * Save the underlying file.
		 *
		 * @return A promise that will resolve to true when the file
123 124
		 * has been saved. If the file was not dirty or the save failed,
		 * will return false.
E
Erich Gamma 已提交
125 126 127 128 129 130
		 */
		save(): Thenable<boolean>;

		/**
		 * The number of lines in this document.
		 */
Y
Yuki Ueda 已提交
131
		readonly lineCount: number;
E
Erich Gamma 已提交
132 133 134 135 136 137

		/**
		 * 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 已提交
138 139
		 * @param line A line number in [0, lineCount).
		 * @return A [line](#TextLine).
E
Erich Gamma 已提交
140 141 142 143 144 145 146 147
		 */
		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 已提交
148 149
		 * The position will be [adjusted](#TextDocument.validatePosition).
		 *
J
Johannes Rieken 已提交
150
		 * @see [TextDocument.lineAt](#TextDocument.lineAt)
A
Alex Dima 已提交
151 152
		 * @param position A position.
		 * @return A [line](#TextLine).
E
Erich Gamma 已提交
153 154 155 156 157
		 */
		lineAt(position: Position): TextLine;

		/**
		 * Converts the position to a zero-based offset.
A
Alex Dima 已提交
158 159 160 161 162
		 *
		 * The position will be [adjusted](#TextDocument.validatePosition).
		 *
		 * @param position A position.
		 * @return A valid zero-based offset.
E
Erich Gamma 已提交
163 164 165 166 167
		 */
		offsetAt(position: Position): number;

		/**
		 * Converts a zero-based offset to a position.
A
Alex Dima 已提交
168 169 170
		 *
		 * @param offset A zero-based offset.
		 * @return A valid [position](#Position).
E
Erich Gamma 已提交
171 172 173 174
		 */
		positionAt(offset: number): Position;

		/**
J
Johannes Rieken 已提交
175 176 177 178
		 * 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 已提交
179
		 * @return The text inside the provided range or the entire text.
E
Erich Gamma 已提交
180 181 182 183
		 */
		getText(range?: Range): string;

		/**
J
Johannes Rieken 已提交
184 185
		 * Get a word-range at the given position. By default words are defined by
		 * common separators, like space, -, _, etc. In addition, per languge custom
186 187
		 * [word definitions](#LanguageConfiguration.wordPattern) can be defined. It
		 * is also possible to provide a custom regular expression.
J
Johannes Rieken 已提交
188
		 *
A
Alex Dima 已提交
189 190
		 * The position will be [adjusted](#TextDocument.validatePosition).
		 *
J
Johannes Rieken 已提交
191
		 * @param position A position.
192
		 * @param regex Optional regular expression that describes what a word is.
J
Johannes Rieken 已提交
193
		 * @return A range spanning a word, or `undefined`.
E
Erich Gamma 已提交
194
		 */
195
		getWordRangeAtPosition(position: Position, regex?: RegExp): Range | undefined;
E
Erich Gamma 已提交
196 197

		/**
J
Johannes Rieken 已提交
198 199 200 201
		 * 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 已提交
202 203 204 205
		 */
		validateRange(range: Range): Range;

		/**
A
Andre Weinand 已提交
206
		 * Ensure a position is contained in the range of this document.
J
Johannes Rieken 已提交
207 208 209
		 *
		 * @param position A position.
		 * @return The given position or a new, adjusted position.
E
Erich Gamma 已提交
210 211 212 213 214 215
		 */
		validatePosition(position: Position): Position;
	}

	/**
	 * Represents a line and character position, such as
A
Alex Dima 已提交
216
	 * the position of the cursor.
E
Erich Gamma 已提交
217 218 219 220 221 222 223 224 225 226
	 *
	 * Position objects are __immutable__. Use the [with](#Position.with) or
	 * [translate](#Position.translate) methods to derive new positions
	 * from an existing position.
	 */
	export class Position {

		/**
		 * The zero-based line value.
		 */
Y
Yuki Ueda 已提交
227
		readonly line: number;
E
Erich Gamma 已提交
228 229 230 231

		/**
		 * The zero-based character value.
		 */
Y
Yuki Ueda 已提交
232
		readonly character: number;
E
Erich Gamma 已提交
233 234

		/**
A
Alex Dima 已提交
235 236
		 * @param line A zero-based line value.
		 * @param character A zero-based character value.
E
Erich Gamma 已提交
237 238 239 240
		 */
		constructor(line: number, character: number);

		/**
A
Alex Dima 已提交
241 242 243
		 * Check if `other` is before this position.
		 *
		 * @param other A position.
E
Erich Gamma 已提交
244
		 * @return `true` if position is on a smaller line
A
Alex Dima 已提交
245
		 * or on the same line on a smaller character.
E
Erich Gamma 已提交
246 247 248 249
		 */
		isBefore(other: Position): boolean;

		/**
A
Alex Dima 已提交
250 251 252 253 254
		 * 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 已提交
255 256 257 258
		 */
		isBeforeOrEqual(other: Position): boolean;

		/**
A
Alex Dima 已提交
259 260 261
		 * Check if `other` is after this position.
		 *
		 * @param other A position.
E
Erich Gamma 已提交
262
		 * @return `true` if position is on a greater line
A
Alex Dima 已提交
263
		 * or on the same line on a greater character.
E
Erich Gamma 已提交
264 265 266 267
		 */
		isAfter(other: Position): boolean;

		/**
A
Alex Dima 已提交
268 269 270 271 272
		 * 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 已提交
273 274 275 276
		 */
		isAfterOrEqual(other: Position): boolean;

		/**
A
Alex Dima 已提交
277 278 279
		 * Check if `other` equals this position.
		 *
		 * @param other A position.
E
Erich Gamma 已提交
280 281 282 283 284 285
		 * @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 已提交
286 287 288 289 290
		 * 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 已提交
291 292 293 294 295
		 * this and the given position are equal.
		 */
		compareTo(other: Position): number;

		/**
A
Alex Dima 已提交
296
		 * Create a new position relative to this position.
E
Erich Gamma 已提交
297 298 299 300 301 302 303 304
		 *
		 * @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;

305 306 307 308 309 310 311 312 313
		/**
		 * Derived a new position relative to this position.
		 *
		 * @param change An object that describes a delta to this position.
		 * @return A position that reflects the given delta. Will return `this` position if the change
		 * is not changing anything.
		 */
		translate(change: { lineDelta?: number; characterDelta?: number; }): Position;

E
Erich Gamma 已提交
314
		/**
A
Alex Dima 已提交
315 316
		 * Create a new position derived from this position.
		 *
E
Erich Gamma 已提交
317 318
		 * @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 已提交
319
		 * @return A position where line and character are replaced by the given values.
E
Erich Gamma 已提交
320 321
		 */
		with(line?: number, character?: number): Position;
322 323 324 325 326 327 328 329 330

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

	/**
	 * A range represents an ordered pair of two positions.
A
Alex Dima 已提交
335
	 * It is guaranteed that [start](#Range.start).isBeforeOrEqual([end](#Range.end))
E
Erich Gamma 已提交
336 337 338 339 340 341 342 343
	 *
	 * 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 已提交
344
		 * The start position. It is before or equal to [end](#Range.end).
E
Erich Gamma 已提交
345
		 */
Y
Yuki Ueda 已提交
346
		readonly start: Position;
E
Erich Gamma 已提交
347 348

		/**
A
Andre Weinand 已提交
349
		 * The end position. It is after or equal to [start](#Range.start).
E
Erich Gamma 已提交
350
		 */
Y
Yuki Ueda 已提交
351
		readonly end: Position;
E
Erich Gamma 已提交
352 353

		/**
S
Steven Clarke 已提交
354
		 * Create a new range from two positions. If `start` is not
A
Alex Dima 已提交
355
		 * before or equal to `end`, the values will be swapped.
E
Erich Gamma 已提交
356
		 *
J
Johannes Rieken 已提交
357 358
		 * @param start A position.
		 * @param end A position.
E
Erich Gamma 已提交
359 360 361 362
		 */
		constructor(start: Position, end: Position);

		/**
A
Alex Dima 已提交
363 364
		 * 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 已提交
365
		 *
A
Alex Dima 已提交
366 367 368 369
		 * @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 已提交
370
		 */
J
Johannes Rieken 已提交
371
		constructor(startLine: number, startCharacter: number, endLine: number, endCharacter: number);
E
Erich Gamma 已提交
372 373 374 375 376 377 378

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

		/**
A
Alex Dima 已提交
379
		 * `true` iff `start.line` and `end.line` are equal.
E
Erich Gamma 已提交
380 381 382 383
		 */
		isSingleLine: boolean;

		/**
A
Alex Dima 已提交
384 385 386
		 * Check if a position or a range is contained in this range.
		 *
		 * @param positionOrRange A position or a range.
E
Erich Gamma 已提交
387 388 389 390 391 392
		 * @return `true` iff the position or range is inside or equal
		 * to this range.
		 */
		contains(positionOrRange: Position | Range): boolean;

		/**
A
Alex Dima 已提交
393 394 395
		 * Check if `other` equals this range.
		 *
		 * @param other A range.
E
Erich Gamma 已提交
396
		 * @return `true` when start and end are [equal](#Position.isEqual) to
A
Andre Weinand 已提交
397
		 * start and end of this range.
E
Erich Gamma 已提交
398 399 400 401
		 */
		isEqual(other: Range): boolean;

		/**
A
Alex Dima 已提交
402 403 404 405
		 * 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 已提交
406 407 408
		 * @return A range of the greater start and smaller end positions. Will
		 * return undefined when there is no overlap.
		 */
409
		intersection(range: Range): Range | undefined;
E
Erich Gamma 已提交
410 411

		/**
A
Alex Dima 已提交
412 413 414
		 * Compute the union of `other` with this range.
		 *
		 * @param other A range.
E
Erich Gamma 已提交
415 416 417 418 419
		 * @return A range of smaller start position and the greater end position.
		 */
		union(other: Range): Range;

		/**
420
		 * Derived a new range from this range.
A
Alex Dima 已提交
421
		 *
E
Erich Gamma 已提交
422 423 424
		 * @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.
425
		 * If start and end are not different `this` range will be returned.
E
Erich Gamma 已提交
426 427
		 */
		with(start?: Position, end?: Position): Range;
428 429 430 431 432 433 434 435

		/**
		 * Derived a new range from this range.
		 *
		 * @param change An object that describes a change to this range.
		 * @return A range that reflects the given change. Will return `this` range if the change
		 * is not changing anything.
		 */
J
Johannes Rieken 已提交
436
		with(change: { start?: Position, end?: Position }): Range;
E
Erich Gamma 已提交
437 438 439 440 441 442 443 444 445
	}

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

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

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

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

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

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

480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
	/**
	 * Represents sources that can cause [selection change events](#window.onDidChangeTextEditorSelection).
	*/
	export enum TextEditorSelectionChangeKind {
		/**
		 * Selection changed due to typing in the editor.
		 */
		Keyboard = 1,
		/**
		 * Selection change due to clicking in the editor.
		 */
		Mouse = 2,
		/**
		 * Selection changed because a command ran.
		 */
		Command = 3
	}

A
Alex Dima 已提交
498 499 500
	/**
	 * Represents an event describing the change in a [text editor's selections](#TextEditor.selections).
	 */
J
Johannes Rieken 已提交
501
	export interface TextEditorSelectionChangeEvent {
A
Alex Dima 已提交
502 503 504
		/**
		 * The [text editor](#TextEditor) for which the selections have changed.
		 */
J
Johannes Rieken 已提交
505
		textEditor: TextEditor;
A
Alex Dima 已提交
506 507 508
		/**
		 * The new value for the [text editor's selections](#TextEditor.selections).
		 */
J
Johannes Rieken 已提交
509
		selections: Selection[];
510 511 512 513 514
		/**
		 * The [change kind](#TextEditorSelectionChangeKind) which has triggered this
		 * event. Can be `undefined`.
		 */
		kind?: TextEditorSelectionChangeKind;
J
Johannes Rieken 已提交
515 516
	}

A
Alex Dima 已提交
517 518 519
	/**
	 * Represents an event describing the change in a [text editor's options](#TextEditor.options).
	 */
J
Johannes Rieken 已提交
520
	export interface TextEditorOptionsChangeEvent {
A
Alex Dima 已提交
521 522 523
		/**
		 * The [text editor](#TextEditor) for which the options have changed.
		 */
J
Johannes Rieken 已提交
524
		textEditor: TextEditor;
A
Alex Dima 已提交
525 526 527
		/**
		 * The new value for the [text editor's options](#TextEditor.options).
		 */
J
Johannes Rieken 已提交
528 529 530
		options: TextEditorOptions;
	}

531 532 533 534 535 536 537 538 539 540 541 542 543 544
	/**
	 * Represents an event describing the change of a [text editor's view column](#TextEditor.viewColumn).
	 */
	export interface TextEditorViewColumnChangeEvent {
		/**
		 * The [text editor](#TextEditor) for which the options have changed.
		 */
		textEditor: TextEditor;
		/**
		 * The new value for the [text editor's view column](#TextEditor.viewColumn).
		 */
		viewColumn: ViewColumn;
	}

A
Alex Dima 已提交
545 546 547 548 549 550 551 552 553 554 555
	/**
	 * Rendering style of the cursor.
	 */
	export enum TextEditorCursorStyle {
		/**
		 * Render the cursor as a vertical line.
		 */
		Line = 1,
		/**
		 * Render the cursor as a block.
		 */
A
Alex Dima 已提交
556 557 558 559 560
		Block = 2,
		/**
		 * Render the cursor as a horizontal line under the character.
		 */
		Underline = 3
A
Alex Dima 已提交
561 562
	}

563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
	/**
	 * Rendering style of the line numbers.
	 */
	export enum TextEditorLineNumbersStyle {
		/**
		 * Do not render the line numbers.
		 */
		Off = 0,
		/**
		 * Render the line numbers.
		 */
		On = 1,
		/**
		 * Render the line numbers with values relative to the primary cursor location.
		 */
		Relative = 2
	}

E
Erich Gamma 已提交
581
	/**
A
Alex Dima 已提交
582
	 * Represents a [text editor](#TextEditor)'s [options](#TextEditor.options).
E
Erich Gamma 已提交
583 584 585 586
	 */
	export interface TextEditorOptions {

		/**
A
Alex Dima 已提交
587 588 589
		 * The size in spaces a tab takes. This is used for two purposes:
		 *  - the rendering width of a tab character;
		 *  - the number of spaces to insert when [insertSpaces](#TextEditorOptions.insertSpaces) is true.
J
Johannes Rieken 已提交
590
		 *
591 592
		 * When getting a text editor's options, this property will always be a number (resolved).
		 * When setting a text editor's options, this property is optional and it can be a number or `"auto"`.
E
Erich Gamma 已提交
593
		 */
594
		tabSize?: number | string;
E
Erich Gamma 已提交
595 596 597

		/**
		 * When pressing Tab insert [n](#TextEditorOptions.tabSize) spaces.
598 599
		 * When getting a text editor's options, this property will always be a boolean (resolved).
		 * When setting a text editor's options, this property is optional and it can be a boolean or `"auto"`.
E
Erich Gamma 已提交
600
		 */
601
		insertSpaces?: boolean | string;
A
Alex Dima 已提交
602 603 604 605 606 607 608

		/**
		 * The rendering style of the cursor in this editor.
		 * When getting a text editor's options, this property will always be present.
		 * When setting a text editor's options, this property is optional.
		 */
		cursorStyle?: TextEditorCursorStyle;
609 610 611 612 613 614

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

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

		/**
A
Alex Dima 已提交
628
		 * Internal representation of the handle.
E
Erich Gamma 已提交
629
		 */
Y
Yuki Ueda 已提交
630
		readonly key: string;
E
Erich Gamma 已提交
631

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

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

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

A
Alex Dima 已提交
668 669 670
	/**
	 * Represents theme specific rendering styles for a [text editor decoration](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
671 672 673 674 675 676 677 678 679
	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.
		 */
680 681 682 683 684 685
		outline?: string;

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

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

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

		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
703 704 705 706 707 708
		border?: string;

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

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

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

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

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

750 751 752 753 754
		/**
		 * CSS styling property that will be applied to text enclosed by a decoration.
		 */
		letterSpacing?: string;

E
Erich Gamma 已提交
755
		/**
756
		 * An **absolute path** or an URI to an image to be rendered in the gutter.
E
Erich Gamma 已提交
757
		 */
758
		gutterIconPath?: string | Uri;
E
Erich Gamma 已提交
759

760 761 762 763 764 765 766
		/**
		 * Specifies the size of the gutter icon.
		 * Available values are 'auto', 'contain', 'cover' and any percentage value.
		 * For further information: https://msdn.microsoft.com/en-us/library/jj127316(v=vs.85).aspx
		 */
		gutterIconSize?: string;

E
Erich Gamma 已提交
767 768 769 770
		/**
		 * The color of the decoration in the overview ruler. Use rgba() and define transparent colors to play well with other decorations.
		 */
		overviewRulerColor?: string;
M
Martin Aeschlimann 已提交
771 772 773 774 775 776 777 778 779 780 781 782 783

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

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

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

A
Alex Dima 已提交
823 824 825
	/**
	 * Represents rendering styles for a [text editor decoration](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848
	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 已提交
849 850 851
	/**
	 * Represents options for a specific decoration in a [decoration set](#TextEditorDecorationType).
	 */
E
Erich Gamma 已提交
852 853 854
	export interface DecorationOptions {

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

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

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

	export interface ThemableDecorationInstanceRenderOptions {
		/**
		 * Defines the rendering options of the attachment that is inserted before the decorated text
		 */
875
		before?: ThemableDecorationAttachmentRenderOptions;
M
Martin Aeschlimann 已提交
876 877 878 879

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

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

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

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

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

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

920 921 922 923
		/**
		 * The column in which this editor shows. Will be `undefined` in case this
		 * isn't one of the three main editors, e.g an embedded editor.
		 */
924
		viewColumn?: ViewColumn;
925

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

J
Joel Day 已提交
939 940 941 942 943 944 945 946 947 948 949
		/**
		 * Inserts the given snippet template and enters snippet mode.
		 *
		 * If the editor is already in snippet mode, insertion fails and the returned promise resolves to false.
		 *
		 * @param template The snippet template to insert
		 * @param posOrRange The position or replacement range representing the location of the insertion.
		 * @return A promise that resolves with a value indicating if the snippet could be inserted.
		 */
		insertSnippet(template: string, posOrRange: Position | Range): Thenable<boolean>;

E
Erich Gamma 已提交
950
		/**
J
Johannes Rieken 已提交
951 952 953
		 * 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 已提交
954
		 * @see [createTextEditorDecorationType](#window.createTextEditorDecorationType).
A
Alex Dima 已提交
955
		 *
J
Johannes Rieken 已提交
956 957
		 * @param decorationType A decoration type.
		 * @param rangesOrOptions Either [ranges](#Range) or more detailed [options](#DecorationOptions).
E
Erich Gamma 已提交
958
		 */
J
Johannes Rieken 已提交
959
		setDecorations(decorationType: TextEditorDecorationType, rangesOrOptions: Range[] | DecorationOptions[]): void;
E
Erich Gamma 已提交
960 961

		/**
A
Alex Dima 已提交
962 963 964 965
		 * 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 已提交
966 967 968 969
		 */
		revealRange(range: Range, revealType?: TextEditorRevealType): void;

		/**
J
Johannes Rieken 已提交
970 971 972
		 * Show the text editor.
		 *
		 * @deprecated **This method is deprecated.** Use [window.showTextDocument](#window.showTextDocument)
S
Steven Clarke 已提交
973
		 * instead. This method shows unexpected behavior and will be removed in the next major update.
E
Erich Gamma 已提交
974
		 *
J
Johannes Rieken 已提交
975
		 * @param column The [column](#ViewColumn) in which to show this editor.
E
Erich Gamma 已提交
976 977 978 979 980
		 */
		show(column?: ViewColumn): void;

		/**
		 * Hide the text editor.
J
Johannes Rieken 已提交
981 982
		 *
		 * @deprecated **This method is deprecated.** Use the command 'workbench.action.closeActiveEditor' instead.
S
Steven Clarke 已提交
983
		 * This method shows unexpected behavior and will be removed in the next major update.
E
Erich Gamma 已提交
984 985 986 987
		 */
		hide(): void;
	}

988
	/**
989
	 * Represents an end of line character sequence in a [document](#TextDocument).
990 991 992 993 994 995 996 997 998 999 1000 1001
	 */
	export enum EndOfLine {
		/**
		 * The line feed `\n` character.
		 */
		LF = 1,
		/**
		 * The carriage return line feed `\r\n` sequence.
		 */
		CRLF = 2
	}

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

		/**
A
Alex Dima 已提交
1019
		 * Insert text at a location.
1020
		 * You can use \r\n or \n in `value` and they will be normalized to the current [document](#TextDocument).
A
Alex Dima 已提交
1021 1022 1023 1024
		 * 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 已提交
1025 1026 1027 1028 1029
		 */
		insert(location: Position, value: string): void;

		/**
		 * Delete a certain text region.
A
Alex Dima 已提交
1030 1031
		 *
		 * @param location The range this operation should remove.
E
Erich Gamma 已提交
1032 1033
		 */
		delete(location: Range | Selection): void;
1034 1035 1036 1037

		/**
		 * Set the end of line sequence.
		 *
1038
		 * @param endOfLine The new end of line for the [document](#TextDocument).
1039
		 */
A
Format  
Alex Dima 已提交
1040
		setEndOfLine(endOfLine: EndOfLine): void;
E
Erich Gamma 已提交
1041 1042 1043
	}

	/**
S
Steven Clarke 已提交
1044
	 * A universal resource identifier representing either a file on disk
J
Johannes Rieken 已提交
1045
	 * or another resource, like untitled resources.
E
Erich Gamma 已提交
1046 1047 1048 1049
	 */
	export class Uri {

		/**
J
Johannes Rieken 已提交
1050 1051 1052 1053 1054
		 * 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 已提交
1055 1056 1057 1058
		 */
		static file(path: string): Uri;

		/**
J
Johannes Rieken 已提交
1059 1060
		 * Create an URI from a string. Will throw if the given value is not
		 * valid.
E
Erich Gamma 已提交
1061
		 *
J
Johannes Rieken 已提交
1062
		 * @param value The string value of an Uri.
J
Johannes Rieken 已提交
1063
		 * @return A new Uri instance.
E
Erich Gamma 已提交
1064 1065 1066 1067
		 */
		static parse(value: string): Uri;

		/**
J
Johannes Rieken 已提交
1068
		 * Scheme is the `http` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1069 1070
		 * The part before the first colon.
		 */
J
Johannes Rieken 已提交
1071
		readonly scheme: string;
E
Erich Gamma 已提交
1072 1073

		/**
J
Johannes Rieken 已提交
1074
		 * Authority is the `www.msft.com` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1075 1076
		 * The part between the first double slashes and the next slash.
		 */
J
Johannes Rieken 已提交
1077
		readonly authority: string;
E
Erich Gamma 已提交
1078 1079

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

		/**
J
Johannes Rieken 已提交
1085
		 * Query is the `query` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1086
		 */
J
Johannes Rieken 已提交
1087
		readonly query: string;
E
Erich Gamma 已提交
1088 1089

		/**
J
Johannes Rieken 已提交
1090
		 * Fragment is the `fragment` part of `http://www.msft.com/some/path?query#fragment`.
E
Erich Gamma 已提交
1091
		 */
J
Johannes Rieken 已提交
1092
		readonly fragment: string;
E
Erich Gamma 已提交
1093 1094

		/**
1095
		 * The string representing the corresponding file system path of this Uri.
J
Johannes Rieken 已提交
1096
		 *
E
Erich Gamma 已提交
1097 1098
		 * 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
1099
		 * invalid characters and semantics. Will *not* look at the scheme of this Uri.
E
Erich Gamma 已提交
1100
		 */
J
Johannes Rieken 已提交
1101
		readonly fsPath: string;
E
Erich Gamma 已提交
1102

1103 1104 1105
		/**
		 * Derive a new Uri from this Uri.
		 *
1106 1107 1108 1109 1110 1111
		 * ```ts
		 * let file = Uri.parse('before:some/file/path');
		 * let other = file.with({ scheme: 'after' });
		 * assert.ok(other.toString() === 'after:some/file/path');
		 * ```
		 *
1112 1113
		 * @param change An object that describes a change to this Uri. To unset components use `null` or
		 *  the empty string.
1114
		 * @return A new Uri that reflects the given change. Will return `this` Uri if the change
1115 1116 1117 1118
		 *  is not changing anything.
		 */
		with(change: { scheme?: string; authority?: string; path?: string; query?: string; fragment?: string }): Uri;

E
Erich Gamma 已提交
1119
		/**
1120 1121 1122
		 * Returns a string representation of this Uri. The representation and normalization
		 * of a URI depends on the scheme. The resulting string can be safely used with
		 * [Uri.parse](#Uri.parse).
J
Johannes Rieken 已提交
1123
		 *
1124 1125 1126
		 * @param skipEncoding Do not percentage-encode the result, defaults to `false`. Note that
		 *	the `#` and `?` characters occuring in the path will always be encoded.
		 * @returns A string representation of this Uri.
E
Erich Gamma 已提交
1127
		 */
1128
		toString(skipEncoding?: boolean): string;
E
Erich Gamma 已提交
1129

J
Johannes Rieken 已提交
1130 1131 1132 1133 1134
		/**
		 * Returns a JSON representation of this Uri.
		 *
		 * @return An object.
		 */
E
Erich Gamma 已提交
1135 1136 1137 1138
		toJSON(): any;
	}

	/**
S
Steven Clarke 已提交
1139
	 * A cancellation token is passed to an asynchronous or long running
E
Erich Gamma 已提交
1140 1141
	 * operation to request cancellation, like cancelling a request
	 * for completion items because the user continued to type.
1142 1143 1144
	 *
	 * To get an instance of a `CancellationToken` use a
	 * [CancellationTokenSource](#CancellationTokenSource).
E
Erich Gamma 已提交
1145 1146 1147 1148
	 */
	export interface CancellationToken {

		/**
J
Johannes Rieken 已提交
1149
		 * Is `true` when the token has been cancelled, `false` otherwise.
E
Erich Gamma 已提交
1150 1151 1152 1153
		 */
		isCancellationRequested: boolean;

		/**
J
Johannes Rieken 已提交
1154
		 * An [event](#Event) which fires upon cancellation.
E
Erich Gamma 已提交
1155 1156 1157 1158 1159
		 */
		onCancellationRequested: Event<any>;
	}

	/**
J
Johannes Rieken 已提交
1160
	 * A cancellation source creates and controls a [cancellation token](#CancellationToken).
E
Erich Gamma 已提交
1161 1162 1163 1164
	 */
	export class CancellationTokenSource {

		/**
J
Johannes Rieken 已提交
1165
		 * The cancellation token of this source.
E
Erich Gamma 已提交
1166 1167 1168 1169 1170 1171 1172 1173 1174
		 */
		token: CancellationToken;

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

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

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

	/**
	 * Represents a typed event.
J
Johannes Rieken 已提交
1212 1213 1214 1215 1216
	 *
	 * 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 已提交
1217 1218 1219 1220
	 */
	export interface Event<T> {

		/**
J
Johannes Rieken 已提交
1221 1222
		 * A function that represents an event to which you subscribe by calling it with
		 * a listener function as argument.
E
Erich Gamma 已提交
1223 1224
		 *
		 * @param listener The listener function will be called when the event happens.
J
Johannes Rieken 已提交
1225
		 * @param thisArgs The `this`-argument which will be used when calling the event listener.
D
Daniel Imms 已提交
1226
		 * @param disposables An array to which a [disposable](#Disposable) will be added.
A
Andre Weinand 已提交
1227
		 * @return A disposable which unsubscribes the event listener.
E
Erich Gamma 已提交
1228 1229 1230 1231
		 */
		(listener: (e: T) => any, thisArgs?: any, disposables?: Disposable[]): Disposable;
	}

1232 1233 1234 1235 1236
	/**
	 * An event emitter can be used to create and manage an [event](#Event) for others
	 * to subscribe to. One emitter always owns one event.
	 *
	 * Use this class if you want to provide event from within your extension, for instance
J
Johannes Rieken 已提交
1237
	 * inside a [TextDocumentContentProvider](#TextDocumentContentProvider) or when providing
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
	 * API to other extensions.
	 */
	export class EventEmitter<T> {

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

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

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

E
Erich Gamma 已提交
1261 1262
	/**
	 * A file system watcher notifies about changes to files and folders
J
Johannes Rieken 已提交
1263 1264 1265
	 * on disk.
	 *
	 * To get an instance of a `FileSystemWatcher` use
J
Johannes Rieken 已提交
1266
	 * [createFileSystemWatcher](#workspace.createFileSystemWatcher).
E
Erich Gamma 已提交
1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285
	 */
	export interface FileSystemWatcher extends Disposable {

		/**
		 * true if this file system watcher has been created such that
		 * it ignores creation file system events.
		 */
		ignoreCreateEvents: boolean;

		/**
		 * true if this file system watcher has been created such that
		 * it ignores change file system events.
		 */
		ignoreChangeEvents: boolean;

		/**
		 * true if this file system watcher has been created such that
		 * it ignores delete file system events.
		 */
J
Johannes Rieken 已提交
1286
		ignoreDeleteEvents: boolean;
E
Erich Gamma 已提交
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303

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

1304 1305 1306 1307
	/**
	 * A text document content provider allows to add readonly documents
	 * to the editor, such as source from a dll or generated html from md.
	 *
1308
	 * Content providers are [registered](#workspace.registerTextDocumentContentProvider)
1309
	 * for a [uri-scheme](#Uri.scheme). When a uri with that scheme is to
1310
	 * be [loaded](#workspace.openTextDocument) the content provider is
1311 1312
	 * asked.
	 */
J
Johannes Rieken 已提交
1313 1314
	export interface TextDocumentContentProvider {

1315 1316 1317 1318
		/**
		 * An event to signal a resource has changed.
		 */
		onDidChange?: Event<Uri>;
J
Johannes Rieken 已提交
1319

1320
		/**
1321
		 * Provide textual content for a given uri.
1322
		 *
1323 1324
		 * The editor will use the returned string-content to create a readonly
		 * [document](TextDocument). Resources allocated should be released when
1325
		 * the corresponding document has been [closed](#workspace.onDidCloseTextDocument).
1326
		 *
1327 1328 1329
		 * @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.
1330
		 */
1331
		provideTextDocumentContent(uri: Uri, token: CancellationToken): ProviderResult<string>;
J
Johannes Rieken 已提交
1332 1333
	}

E
Erich Gamma 已提交
1334 1335
	/**
	 * Represents an item that can be selected from
A
Andre Weinand 已提交
1336
	 * a list of items.
E
Erich Gamma 已提交
1337 1338 1339 1340
	 */
	export interface QuickPickItem {

		/**
J
Johannes Rieken 已提交
1341
		 * A human readable string which is rendered prominent.
E
Erich Gamma 已提交
1342 1343 1344 1345
		 */
		label: string;

		/**
J
Johannes Rieken 已提交
1346
		 * A human readable string which is rendered less prominent.
E
Erich Gamma 已提交
1347 1348
		 */
		description: string;
J
Johannes Rieken 已提交
1349 1350 1351 1352 1353

		/**
		 * A human readable string which is rendered less prominent.
		 */
		detail?: string;
E
Erich Gamma 已提交
1354 1355 1356
	}

	/**
J
Johannes Rieken 已提交
1357
	 * Options to configure the behavior of the quick pick UI.
E
Erich Gamma 已提交
1358 1359 1360
	 */
	export interface QuickPickOptions {
		/**
J
Johannes Rieken 已提交
1361 1362
		 * An optional flag to include the description when filtering the picks.
		 */
E
Erich Gamma 已提交
1363 1364
		matchOnDescription?: boolean;

J
Johannes Rieken 已提交
1365 1366 1367 1368 1369
		/**
		 * An optional flag to include the detail when filtering the picks.
		 */
		matchOnDetail?: boolean;

E
Erich Gamma 已提交
1370
		/**
S
Steven Clarke 已提交
1371
		 * An optional string to show as place holder in the input box to guide the user what to pick on.
J
Johannes Rieken 已提交
1372
		 */
E
Erich Gamma 已提交
1373
		placeHolder?: string;
1374

1375 1376 1377 1378 1379
		/**
		 * Set to `true` to keep the picker open when focus moves to another part of the editor or to another window.
		 */
		ignoreFocusOut?: boolean;

1380 1381 1382
		/**
		 * An optional function that is invoked whenever an item is selected.
		 */
1383
		onDidSelectItem?<T extends QuickPickItem>(item: T | string): any;
E
Erich Gamma 已提交
1384 1385 1386
	}

	/**
J
Johannes Rieken 已提交
1387
	 * Represents an action that is shown with an information, warning, or
A
Andre Weinand 已提交
1388
	 * error message.
E
Erich Gamma 已提交
1389
	 *
S
Sofian Hnaide 已提交
1390 1391 1392
	 * @see [showInformationMessage](#window.showInformationMessage)
	 * @see [showWarningMessage](#window.showWarningMessage)
	 * @see [showErrorMessage](#window.showErrorMessage)
E
Erich Gamma 已提交
1393 1394 1395 1396
	 */
	export interface MessageItem {

		/**
A
Andre Weinand 已提交
1397
		 * A short title like 'Retry', 'Open Log' etc.
E
Erich Gamma 已提交
1398 1399
		 */
		title: string;
1400 1401 1402 1403 1404 1405

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

	/**
J
Johannes Rieken 已提交
1409
	 * Options to configure the behavior of the input box UI.
E
Erich Gamma 已提交
1410 1411
	 */
	export interface InputBoxOptions {
J
Johannes Rieken 已提交
1412

E
Erich Gamma 已提交
1413
		/**
J
Johannes Rieken 已提交
1414 1415
		 * The value to prefill in the input box.
		 */
E
Erich Gamma 已提交
1416 1417 1418
		value?: string;

		/**
J
Johannes Rieken 已提交
1419 1420
		 * The text to display underneath the input box.
		 */
E
Erich Gamma 已提交
1421 1422 1423
		prompt?: string;

		/**
J
Johannes Rieken 已提交
1424 1425
		 * An optional string to show as place holder in the input box to guide the user what to type.
		 */
E
Erich Gamma 已提交
1426 1427 1428
		placeHolder?: string;

		/**
1429
		 * Set to `true` to show a password prompt that will not show the typed value.
J
Johannes Rieken 已提交
1430
		 */
E
Erich Gamma 已提交
1431
		password?: boolean;
1432

1433 1434 1435 1436 1437
		/**
		 * Set to `true` to keep the input box open when focus moves to another part of the editor or to another window.
		 */
		ignoreFocusOut?: boolean;

1438
		/**
P
Pine 已提交
1439
		 * An optional function that will be called to validate input and to give a hint
1440 1441 1442 1443 1444 1445
		 * to the user.
		 *
		 * @param value The current value of the input box.
		 * @return A human readable string which is presented as diagnostic message.
		 * Return `undefined`, `null`, or the empty string when 'value' is valid.
		 */
1446
		validateInput?(value: string): string | undefined | null;
E
Erich Gamma 已提交
1447 1448 1449 1450
	}

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

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

		/**
J
Johannes Rieken 已提交
1465
		 * A Uri [scheme](#Uri.scheme), like `file` or `untitled`.
E
Erich Gamma 已提交
1466 1467 1468 1469
		 */
		scheme?: string;

		/**
J
Johannes Rieken 已提交
1470
		 * A glob pattern, like `*.{ts,js}`.
E
Erich Gamma 已提交
1471 1472 1473 1474 1475 1476
		 */
		pattern?: string;
	}

	/**
	 * A language selector is the combination of one or many language identifiers
1477
	 * and [language filters](#DocumentFilter).
J
Johannes Rieken 已提交
1478 1479
	 *
	 * @sample `let sel:DocumentSelector = 'typescript'`;
1480
	 * @sample `let sel:DocumentSelector = ['typescript', { language: 'json', pattern: '**∕tsconfig.json' }]`;
E
Erich Gamma 已提交
1481 1482 1483
	 */
	export type DocumentSelector = string | DocumentFilter | (string | DocumentFilter)[];

1484 1485 1486 1487 1488 1489 1490 1491 1492 1493

	/**
	 * A provider result represents the values a provider, like the [`HoverProvider`](#HoverProvider),
	 * may return. For once this is the actual result type `T`, like `Hover`, or a thenable that resolves
	 * to that type `T`. In addition, `null` and `undefined` can be returned - either directly or from a
	 * thenable.
	 *
	 * The snippets below are all valid implementions of the [`HoverProvider`](#HoverProvider):
	 *
	 * ```ts
1494 1495 1496 1497 1498
	 * let a: HoverProvider = {
	 * 	provideHover(doc, pos, token): ProviderResult<Hover> {
	 * 		return new Hover('Hello World');
	 * 	}
	 * }
1499
	 *
1500 1501 1502 1503 1504 1505 1506
	 * let b: HoverProvider = {
	 * 	provideHover(doc, pos, token): ProviderResult<Hover> {
	 * 		return new Promise(resolve => {
	 * 			resolve(new Hover('Hello World'));
	 * 	 	});
	 * 	}
	 * }
1507
	 *
1508 1509 1510 1511 1512 1513
	 * let c: HoverProvider = {
	 * 	provideHover(doc, pos, token): ProviderResult<Hover> {
	 * 		return; // undefined
	 * 	}
	 * }
	 * ```
1514 1515 1516
	 */
	export type ProviderResult<T> = T | undefined | null | Thenable<T | undefined | null>

E
Erich Gamma 已提交
1517 1518
	/**
	 * Contains additional diagnostic information about the context in which
J
Johannes Rieken 已提交
1519
	 * a [code action](#CodeActionProvider.provideCodeActions) is run.
E
Erich Gamma 已提交
1520 1521
	 */
	export interface CodeActionContext {
J
Johannes Rieken 已提交
1522 1523 1524 1525

		/**
		 * An array of diagnostics.
		 */
Y
Yuki Ueda 已提交
1526
		readonly diagnostics: Diagnostic[];
E
Erich Gamma 已提交
1527 1528 1529
	}

	/**
J
Johannes Rieken 已提交
1530 1531 1532 1533
	 * 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 已提交
1534 1535 1536 1537 1538 1539
	 */
	export interface CodeActionProvider {

		/**
		 * Provide commands for the given document and range.
		 *
J
Johannes Rieken 已提交
1540 1541
		 * @param document The document in which the command was invoked.
		 * @param range The range for which the command was invoked.
J
Johannes Rieken 已提交
1542 1543
		 * @param context Context carrying additional information.
		 * @param token A cancellation token.
J
Johannes Rieken 已提交
1544
		 * @return An array of commands or a thenable of such. The lack of a result can be
A
Andre Weinand 已提交
1545
		 * signaled by returning `undefined`, `null`, or an empty array.
E
Erich Gamma 已提交
1546
		 */
1547
		provideCodeActions(document: TextDocument, range: Range, context: CodeActionContext, token: CancellationToken): ProviderResult<Command[]>;
E
Erich Gamma 已提交
1548 1549 1550 1551 1552
	}

	/**
	 * 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 已提交
1553 1554 1555
	 *
	 * 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 已提交
1556 1557 1558
	 *
	 * @see [CodeLensProvider.provideCodeLenses](#CodeLensProvider.provideCodeLenses)
	 * @see [CodeLensProvider.resolveCodeLens](#CodeLensProvider.resolveCodeLens)
E
Erich Gamma 已提交
1559 1560 1561 1562 1563 1564 1565 1566 1567
	 */
	export class CodeLens {

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

		/**
J
Johannes Rieken 已提交
1568
		 * The command this code lens represents.
E
Erich Gamma 已提交
1569
		 */
1570
		command?: Command;
E
Erich Gamma 已提交
1571 1572

		/**
J
Johannes Rieken 已提交
1573
		 * `true` when there is a command associated.
E
Erich Gamma 已提交
1574
		 */
Y
Yuki Ueda 已提交
1575
		readonly isResolved: boolean;
J
Johannes Rieken 已提交
1576 1577 1578 1579 1580 1581 1582 1583

		/**
		 * 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 已提交
1584 1585 1586 1587 1588 1589 1590 1591
	}

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

1592 1593 1594 1595 1596
		/**
		 * An optional event to signal that the code lenses from this provider have changed.
		 */
		onDidChangeCodeLenses?: Event<this>;

E
Erich Gamma 已提交
1597 1598
		/**
		 * Compute a list of [lenses](#CodeLens). This call should return as fast as possible and if
A
Andre Weinand 已提交
1599
		 * computing the commands is expensive implementors should only return code lens objects with the
E
Erich Gamma 已提交
1600
		 * range set and implement [resolve](#CodeLensProvider.resolveCodeLens).
J
Johannes Rieken 已提交
1601 1602 1603
		 *
		 * @param document The document in which the command was invoked.
		 * @param token A cancellation token.
A
Andre Weinand 已提交
1604 1605
		 * @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 已提交
1606
		 */
1607
		provideCodeLenses(document: TextDocument, token: CancellationToken): ProviderResult<CodeLens[]>;
E
Erich Gamma 已提交
1608 1609 1610 1611

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

	/**
J
Johannes Rieken 已提交
1621 1622 1623
	 * 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 已提交
1624 1625 1626
	 */
	export type Definition = Location | Location[];

J
Johannes Rieken 已提交
1627 1628 1629 1630 1631
	/**
	 * 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 已提交
1632
	export interface DefinitionProvider {
J
Johannes Rieken 已提交
1633 1634 1635 1636 1637 1638 1639

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

1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663
	/**
	 * The type definition provider interface defines the contract between extensions and
	 * the go to implementation feature.
	 */
	export interface TypeDefinitionProvider {

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

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

J
Johannes Rieken 已提交
1671 1672 1673 1674
	/**
	 * A hover represents additional information for a symbol or word. Hovers are
	 * rendered in a tooltip-like widget.
	 */
E
Erich Gamma 已提交
1675 1676
	export class Hover {

J
Johannes Rieken 已提交
1677 1678 1679
		/**
		 * The contents of this hover.
		 */
E
Erich Gamma 已提交
1680 1681
		contents: MarkedString[];

J
Johannes Rieken 已提交
1682
		/**
A
Andre Weinand 已提交
1683
		 * The range to which this hover applies. When missing, the
J
Johannes Rieken 已提交
1684
		 * editor will use the range at the current position or the
A
Andre Weinand 已提交
1685
		 * current position itself.
J
Johannes Rieken 已提交
1686
		 */
1687
		range?: Range;
E
Erich Gamma 已提交
1688

J
Johannes Rieken 已提交
1689 1690 1691 1692
		/**
		 * Creates a new hover object.
		 *
		 * @param contents The contents of the hover.
A
Andre Weinand 已提交
1693
		 * @param range The range to which the hover applies.
J
Johannes Rieken 已提交
1694
		 */
E
Erich Gamma 已提交
1695 1696 1697
		constructor(contents: MarkedString | MarkedString[], range?: Range);
	}

J
Johannes Rieken 已提交
1698 1699 1700 1701
	/**
	 * The hover provider interface defines the contract between extensions and
	 * the [hover](https://code.visualstudio.com/docs/editor/editingevolved#_hover)-feature.
	 */
E
Erich Gamma 已提交
1702
	export interface HoverProvider {
J
Johannes Rieken 已提交
1703 1704 1705

		/**
		 * Provide a hover for the given position and document. Multiple hovers at the same
A
Andre Weinand 已提交
1706 1707
		 * 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 已提交
1708 1709 1710 1711 1712
		 *
		 * @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 已提交
1713
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
1714
		 */
1715
		provideHover(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Hover>;
E
Erich Gamma 已提交
1716 1717
	}

J
Johannes Rieken 已提交
1718 1719 1720
	/**
	 * A document highlight kind.
	 */
E
Erich Gamma 已提交
1721
	export enum DocumentHighlightKind {
J
Johannes Rieken 已提交
1722 1723

		/**
A
Andre Weinand 已提交
1724
		 * A textual occurrence.
J
Johannes Rieken 已提交
1725
		 */
1726
		Text = 0,
J
Johannes Rieken 已提交
1727 1728 1729 1730

		/**
		 * Read-access of a symbol, like reading a variable.
		 */
1731
		Read = 1,
J
Johannes Rieken 已提交
1732 1733 1734 1735

		/**
		 * Write-access of a symbol, like writing to a variable.
		 */
1736
		Write = 2
E
Erich Gamma 已提交
1737 1738
	}

J
Johannes Rieken 已提交
1739 1740 1741 1742 1743
	/**
	 * 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 已提交
1744
	export class DocumentHighlight {
J
Johannes Rieken 已提交
1745 1746 1747 1748

		/**
		 * The range this highlight applies to.
		 */
E
Erich Gamma 已提交
1749
		range: Range;
J
Johannes Rieken 已提交
1750 1751 1752 1753

		/**
		 * The highlight kind, default is [text](#DocumentHighlightKind.Text).
		 */
1754
		kind?: DocumentHighlightKind;
J
Johannes Rieken 已提交
1755 1756 1757 1758 1759 1760 1761 1762

		/**
		 * 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 已提交
1763 1764
	}

J
Johannes Rieken 已提交
1765 1766 1767 1768
	/**
	 * The document highlight provider interface defines the contract between extensions and
	 * the word-highlight-feature.
	 */
E
Erich Gamma 已提交
1769
	export interface DocumentHighlightProvider {
J
Johannes Rieken 已提交
1770 1771

		/**
S
Steven Clarke 已提交
1772
		 * Provide a set of document highlights, like all occurrences of a variable or
J
Johannes Rieken 已提交
1773 1774 1775 1776 1777 1778
		 * 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 已提交
1779
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1780
		 */
1781
		provideDocumentHighlights(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<DocumentHighlight[]>;
E
Erich Gamma 已提交
1782 1783
	}

J
Johannes Rieken 已提交
1784 1785 1786
	/**
	 * A symbol kind.
	 */
E
Erich Gamma 已提交
1787
	export enum SymbolKind {
1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808
		File = 0,
		Module = 1,
		Namespace = 2,
		Package = 3,
		Class = 4,
		Method = 5,
		Property = 6,
		Field = 7,
		Constructor = 8,
		Enum = 9,
		Interface = 10,
		Function = 11,
		Variable = 12,
		Constant = 13,
		String = 14,
		Number = 15,
		Boolean = 16,
		Array = 17,
		Object = 18,
		Key = 19,
		Null = 20
E
Erich Gamma 已提交
1809 1810
	}

J
Johannes Rieken 已提交
1811 1812 1813 1814
	/**
	 * Represents information about programming constructs like variables, classes,
	 * interfaces etc.
	 */
E
Erich Gamma 已提交
1815
	export class SymbolInformation {
J
Johannes Rieken 已提交
1816 1817 1818 1819

		/**
		 * The name of this symbol.
		 */
E
Erich Gamma 已提交
1820
		name: string;
J
Johannes Rieken 已提交
1821 1822 1823 1824

		/**
		 * The name of the symbol containing this symbol.
		 */
E
Erich Gamma 已提交
1825
		containerName: string;
J
Johannes Rieken 已提交
1826 1827 1828 1829

		/**
		 * The kind of this symbol.
		 */
E
Erich Gamma 已提交
1830
		kind: SymbolKind;
J
Johannes Rieken 已提交
1831 1832 1833 1834

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

1837 1838 1839 1840 1841 1842 1843 1844 1845 1846
		/**
		 * Creates a new symbol information object.
		 *
		 * @param name The name of the symbol.
		 * @param kind The kind of the symbol.
		 * @param containerName The name of the symbol containing the symbol.
		 * @param location The the location of the symbol.
		 */
		constructor(name: string, kind: SymbolKind, containerName: string, location: Location);

J
Johannes Rieken 已提交
1847
		/**
1848 1849
		 * @deprecated Please use the constructor taking a [location](#Location) object.
		 *
J
Johannes Rieken 已提交
1850 1851 1852 1853 1854 1855
		 * 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 已提交
1856
		 * @param containerName The name of the symbol containing the symbol.
J
Johannes Rieken 已提交
1857 1858
		 */
		constructor(name: string, kind: SymbolKind, range: Range, uri?: Uri, containerName?: string);
E
Erich Gamma 已提交
1859 1860
	}

J
Johannes Rieken 已提交
1861 1862 1863 1864
	/**
	 * 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 已提交
1865
	export interface DocumentSymbolProvider {
J
Johannes Rieken 已提交
1866 1867 1868 1869 1870 1871 1872

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

J
Johannes Rieken 已提交
1878 1879 1880 1881
	/**
	 * 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 已提交
1882
	export interface WorkspaceSymbolProvider {
J
Johannes Rieken 已提交
1883 1884 1885

		/**
		 * Project-wide search for a symbol matching the given query string. It is up to the provider
1886 1887 1888
		 * how to search given the query string, like substring, indexOf etc. To improve performance implementors can
		 * skip the [location](#SymbolInformation.location) of symbols and implement `resolveWorkspaceSymbol` to do that
		 * later.
J
Johannes Rieken 已提交
1889 1890 1891 1892
		 *
		 * @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 已提交
1893
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1894
		 */
1895
		provideWorkspaceSymbols(query: string, token: CancellationToken): ProviderResult<SymbolInformation[]>;
1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908

		/**
		 * Given a symbol fill in its [location](#SymbolInformation.location). This method is called whenever a symbol
		 * is selected in the UI. Providers can implement this method and return incomplete symbols from
		 * [`provideWorkspaceSymbols`](#WorkspaceSymbolProvider.provideWorkspaceSymbols) which often helps to improve
		 * performance.
		 *
		 * @param symbol The symbol that is to be resolved. Guaranteed to be an instance of an object returned from an
		 * earlier call to `provideWorkspaceSymbols`.
		 * @param token A cancellation token.
		 * @return The resolved symbol or a thenable that resolves to that. When no result is returned,
		 * the given `symbol` is used.
		 */
1909
		resolveWorkspaceSymbol?(symbol: SymbolInformation, token: CancellationToken): ProviderResult<SymbolInformation>;
E
Erich Gamma 已提交
1910 1911
	}

J
Johannes Rieken 已提交
1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927
	/**
	 * 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 已提交
1928
	export interface ReferenceProvider {
J
Johannes Rieken 已提交
1929 1930 1931 1932 1933 1934 1935 1936 1937

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

J
Johannes Rieken 已提交
1943
	/**
S
Steven Clarke 已提交
1944
	 * A text edit represents edits that should be applied
J
Johannes Rieken 已提交
1945
	 * to a document.
J
Johannes Rieken 已提交
1946
	 */
E
Erich Gamma 已提交
1947
	export class TextEdit {
J
Johannes Rieken 已提交
1948 1949 1950 1951 1952 1953 1954 1955

		/**
		 * Utility to create a replace edit.
		 *
		 * @param range A range.
		 * @param newText A string.
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
1956
		static replace(range: Range, newText: string): TextEdit;
J
Johannes Rieken 已提交
1957 1958 1959 1960

		/**
		 * Utility to create an insert edit.
		 *
S
Steven Clarke 已提交
1961
		 * @param position A position, will become an empty range.
J
Johannes Rieken 已提交
1962 1963 1964
		 * @param newText A string.
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
1965
		static insert(position: Position, newText: string): TextEdit;
J
Johannes Rieken 已提交
1966 1967 1968 1969

		/**
		 * Utility to create a delete edit.
		 *
J
Johannes Rieken 已提交
1970
		 * @param range A range.
J
Johannes Rieken 已提交
1971 1972
		 * @return A new text edit object.
		 */
E
Erich Gamma 已提交
1973
		static delete(range: Range): TextEdit;
J
Johannes Rieken 已提交
1974 1975 1976 1977

		/**
		 * The range this edit applies to.
		 */
E
Erich Gamma 已提交
1978
		range: Range;
J
Johannes Rieken 已提交
1979 1980 1981 1982

		/**
		 * The string this edit will insert.
		 */
E
Erich Gamma 已提交
1983
		newText: string;
J
Johannes Rieken 已提交
1984 1985 1986 1987 1988 1989 1990 1991

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

	/**
J
Johannes Rieken 已提交
1995
	 * A workspace edit represents textual changes for many documents.
E
Erich Gamma 已提交
1996 1997 1998 1999 2000 2001
	 */
	export class WorkspaceEdit {

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

J
Johannes Rieken 已提交
2004 2005 2006 2007 2008 2009 2010 2011
		/**
		 * 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 已提交
2012

J
Johannes Rieken 已提交
2013 2014 2015 2016 2017 2018 2019 2020
		/**
		 * 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 已提交
2021

J
Johannes Rieken 已提交
2022
		/**
S
Steven Clarke 已提交
2023
		 * Delete the text at the given range.
J
Johannes Rieken 已提交
2024 2025 2026
		 *
		 * @param uri A resource identifier.
		 * @param range A range.
J
Johannes Rieken 已提交
2027 2028
		 */
		delete(uri: Uri, range: Range): void;
E
Erich Gamma 已提交
2029

J
Johannes Rieken 已提交
2030 2031 2032
		/**
		 * Check if this edit affects the given resource.
		 * @param uri A resource identifier.
A
Andre Weinand 已提交
2033
		 * @return `true` if the given resource will be touched by this edit.
J
Johannes Rieken 已提交
2034
		 */
E
Erich Gamma 已提交
2035 2036
		has(uri: Uri): boolean;

J
Johannes Rieken 已提交
2037 2038 2039 2040 2041 2042
		/**
		 * Set (and replace) text edits for a resource.
		 *
		 * @param uri A resource identifier.
		 * @param edits An array of text edits.
		 */
E
Erich Gamma 已提交
2043 2044
		set(uri: Uri, edits: TextEdit[]): void;

J
Johannes Rieken 已提交
2045 2046 2047 2048 2049 2050
		/**
		 * Get the text edits for a resource.
		 *
		 * @param uri A resource identifier.
		 * @return An array of text edits.
		 */
E
Erich Gamma 已提交
2051 2052
		get(uri: Uri): TextEdit[];

J
Johannes Rieken 已提交
2053 2054 2055 2056 2057
		/**
		 * Get all text edits grouped by resource.
		 *
		 * @return An array of `[Uri, TextEdit[]]`-tuples.
		 */
E
Erich Gamma 已提交
2058 2059 2060
		entries(): [Uri, TextEdit[]][];
	}

2061 2062 2063 2064 2065 2066
	/**
	 * A snippet string is a template which allows to insert text
	 * and to control the editor cursor when insertion happens.
	 *
	 * A snippet can define tab stops and placeholders with `$1`, `$2`
	 * and `${3:foo}`. `$0` defines the final tab stop, it defaults to
2067 2068 2069
	 * the end of the snippet. Variables are defined with `$name` and
	 * `${name:default value}`. The full snippet syntax is documented
	 * [here](http://code.visualstudio.com/docs/customization/userdefinedsnippets#_creating-your-own-snippets).
2070 2071 2072 2073 2074 2075 2076 2077
	 */
	export class SnippetString {

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

2078 2079 2080 2081 2082 2083 2084
		constructor(value?: string);

		/**
		 * Builder-function that appends the given string to
		 * the [`value`](#SnippetString.value) of this snippet string.
		 *
		 * @param string A value to append 'as given'. The string will be escaped.
2085
		 * @return This snippet string.
2086 2087 2088 2089 2090 2091 2092 2093 2094
		 */
		appendText(string: string): SnippetString;

		/**
		 * Builder-function that appends a tabstop (`$1`, `$2` etc) to
		 * the [`value`](#SnippetString.value) of this snippet string.
		 *
		 * @param number The number of this tabstop, defaults to an auto-incremet
		 * value starting at 1.
2095
		 * @return This snippet string.
2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106
		 */
		appendTabstop(number?: number): SnippetString;

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

		/**
J
Johannes Rieken 已提交
2112
		 * Builder-function that appends a variable (`${VAR}`) to
2113 2114 2115 2116 2117 2118 2119 2120
		 * the [`value`](#SnippetString.value) of this snippet string.
		 *
		 * @param name The name of the variable - excluding the `$`.
		 * @param defaultValue The default value which is used when the variable name cannot
		 * be resolved - either a string or a function with which a nested snippet can be created.
		 * @return This snippet string.
		 */
		appendVariable(name: string, defaultValue: string | ((snippet: SnippetString) => any)): SnippetString;
2121 2122
	}

E
Erich Gamma 已提交
2123
	/**
J
Johannes Rieken 已提交
2124 2125
	 * 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 已提交
2126 2127
	 */
	export interface RenameProvider {
J
Johannes Rieken 已提交
2128 2129 2130 2131 2132 2133 2134 2135 2136 2137

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

J
Johannes Rieken 已提交
2143 2144 2145
	/**
	 * Value-object describing what options formatting should use.
	 */
E
Erich Gamma 已提交
2146
	export interface FormattingOptions {
J
Johannes Rieken 已提交
2147 2148 2149 2150

		/**
		 * Size of a tab in spaces.
		 */
E
Erich Gamma 已提交
2151
		tabSize: number;
J
Johannes Rieken 已提交
2152 2153 2154 2155

		/**
		 * Prefer spaces over tabs.
		 */
E
Erich Gamma 已提交
2156
		insertSpaces: boolean;
J
Johannes Rieken 已提交
2157 2158 2159 2160 2161

		/**
		 * Signature for further properties.
		 */
		[key: string]: boolean | number | string;
E
Erich Gamma 已提交
2162 2163 2164
	}

	/**
J
Johannes Rieken 已提交
2165 2166
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
2167 2168
	 */
	export interface DocumentFormattingEditProvider {
J
Johannes Rieken 已提交
2169 2170 2171 2172 2173 2174 2175 2176

		/**
		 * 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 已提交
2177
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2178
		 */
2179
		provideDocumentFormattingEdits(document: TextDocument, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
2180 2181 2182
	}

	/**
J
Johannes Rieken 已提交
2183 2184
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
2185 2186
	 */
	export interface DocumentRangeFormattingEditProvider {
J
Johannes Rieken 已提交
2187 2188 2189 2190 2191

		/**
		 * 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 已提交
2192 2193
		 * or larger range. Often this is done by adjusting the start and end
		 * of the range to full syntax nodes.
J
Johannes Rieken 已提交
2194 2195 2196 2197 2198 2199
		 *
		 * @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 已提交
2200
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2201
		 */
2202
		provideDocumentRangeFormattingEdits(document: TextDocument, range: Range, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
2203 2204 2205
	}

	/**
J
Johannes Rieken 已提交
2206 2207
	 * The document formatting provider interface defines the contract between extensions and
	 * the formatting-feature.
E
Erich Gamma 已提交
2208 2209
	 */
	export interface OnTypeFormattingEditProvider {
J
Johannes Rieken 已提交
2210 2211 2212 2213 2214 2215 2216 2217 2218 2219

		/**
		 * 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 已提交
2220
		 * @param ch The character that has been typed.
J
Johannes Rieken 已提交
2221 2222 2223
		 * @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 已提交
2224
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2225
		 */
2226
		provideOnTypeFormattingEdits(document: TextDocument, position: Position, ch: string, options: FormattingOptions, token: CancellationToken): ProviderResult<TextEdit[]>;
E
Erich Gamma 已提交
2227 2228
	}

J
Johannes Rieken 已提交
2229 2230 2231 2232
	/**
	 * Represents a parameter of a callable-signature. A parameter can
	 * have a label and a doc-comment.
	 */
E
Erich Gamma 已提交
2233
	export class ParameterInformation {
J
Johannes Rieken 已提交
2234 2235 2236 2237 2238

		/**
		 * The label of this signature. Will be shown in
		 * the UI.
		 */
E
Erich Gamma 已提交
2239
		label: string;
J
Johannes Rieken 已提交
2240 2241 2242 2243 2244

		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
2245
		documentation?: string;
J
Johannes Rieken 已提交
2246 2247 2248 2249 2250 2251 2252

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

J
Johannes Rieken 已提交
2256 2257 2258 2259 2260
	/**
	 * 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 已提交
2261
	export class SignatureInformation {
J
Johannes Rieken 已提交
2262 2263 2264 2265 2266

		/**
		 * The label of this signature. Will be shown in
		 * the UI.
		 */
E
Erich Gamma 已提交
2267
		label: string;
J
Johannes Rieken 已提交
2268 2269 2270 2271 2272

		/**
		 * The human-readable doc-comment of this signature. Will be shown
		 * in the UI but can be omitted.
		 */
2273
		documentation?: string;
J
Johannes Rieken 已提交
2274 2275 2276 2277

		/**
		 * The parameters of this signature.
		 */
E
Erich Gamma 已提交
2278
		parameters: ParameterInformation[];
J
Johannes Rieken 已提交
2279 2280 2281 2282 2283

		/**
		 * Creates a new signature information object.
		 *
		 * @param label A label string.
J
Johannes Rieken 已提交
2284
		 * @param documentation A doc string.
J
Johannes Rieken 已提交
2285
		 */
E
Erich Gamma 已提交
2286 2287 2288
		constructor(label: string, documentation?: string);
	}

J
Johannes Rieken 已提交
2289 2290
	/**
	 * Signature help represents the signature of something
S
Steven Clarke 已提交
2291
	 * callable. There can be multiple signatures but only one
J
Johannes Rieken 已提交
2292 2293
	 * active and only one active parameter.
	 */
E
Erich Gamma 已提交
2294
	export class SignatureHelp {
J
Johannes Rieken 已提交
2295 2296 2297 2298

		/**
		 * One or more signatures.
		 */
E
Erich Gamma 已提交
2299
		signatures: SignatureInformation[];
J
Johannes Rieken 已提交
2300 2301 2302 2303

		/**
		 * The active signature.
		 */
E
Erich Gamma 已提交
2304
		activeSignature: number;
J
Johannes Rieken 已提交
2305 2306 2307 2308

		/**
		 * The active parameter of the active signature.
		 */
E
Erich Gamma 已提交
2309 2310 2311
		activeParameter: number;
	}

J
Johannes Rieken 已提交
2312 2313 2314 2315
	/**
	 * 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 已提交
2316
	export interface SignatureHelpProvider {
J
Johannes Rieken 已提交
2317 2318 2319 2320 2321 2322 2323 2324

		/**
		 * 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 已提交
2325
		 * signaled by returning `undefined` or `null`.
J
Johannes Rieken 已提交
2326
		 */
2327
		provideSignatureHelp(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<SignatureHelp>;
E
Erich Gamma 已提交
2328 2329
	}

J
Johannes Rieken 已提交
2330 2331 2332
	/**
	 * Completion item kinds.
	 */
E
Erich Gamma 已提交
2333
	export enum CompletionItemKind {
2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350
		Text = 0,
		Method = 1,
		Function = 2,
		Constructor = 3,
		Field = 4,
		Variable = 5,
		Class = 6,
		Interface = 7,
		Module = 8,
		Property = 9,
		Unit = 10,
		Value = 11,
		Enum = 12,
		Keyword = 13,
		Snippet = 14,
		Color = 15,
		File = 16,
2351 2352
		Reference = 17,
		Folder = 18
E
Erich Gamma 已提交
2353 2354
	}

J
Johannes Rieken 已提交
2355
	/**
2356
	 * A completion item represents a text snippet that is proposed to complete text that is being typed.
J
Johannes Rieken 已提交
2357
	 *
2358 2359 2360 2361
	 * It is suffient to create a completion item from just a [label](#CompletionItem.label). In that
	 * case the completion item will replace the [word](#TextDocument.getWordRangeAtPosition)
	 * until the cursor with the given label or [insertText](#CompletionItem.insertText). Otherwise the
	 * the given [edit](#CompletionItem.textEdit) is used.
2362
	 *
2363 2364 2365
	 * When selecting a completion item in the editor its defined or synthesized text edit will be applied
	 * to *all* cursors/selections whereas [additionalTextEdits](CompletionItem.additionalTextEdits) will be
	 * applied as provided.
2366
	 *
J
Johannes Rieken 已提交
2367 2368
	 * @see [CompletionItemProvider.provideCompletionItems](#CompletionItemProvider.provideCompletionItems)
	 * @see [CompletionItemProvider.resolveCompletionItem](#CompletionItemProvider.resolveCompletionItem)
J
Johannes Rieken 已提交
2369
	 */
E
Erich Gamma 已提交
2370
	export class CompletionItem {
J
Johannes Rieken 已提交
2371 2372 2373

		/**
		 * The label of this completion item. By default
A
Andre Weinand 已提交
2374
		 * this is also the text that is inserted when selecting
J
Johannes Rieken 已提交
2375 2376
		 * this completion.
		 */
E
Erich Gamma 已提交
2377
		label: string;
J
Johannes Rieken 已提交
2378 2379

		/**
S
Steven Clarke 已提交
2380
		 * The kind of this completion item. Based on the kind
J
Johannes Rieken 已提交
2381 2382
		 * an icon is chosen by the editor.
		 */
2383
		kind?: CompletionItemKind;
J
Johannes Rieken 已提交
2384 2385 2386 2387 2388

		/**
		 * A human-readable string with additional information
		 * about this item, like type or symbol information.
		 */
2389
		detail?: string;
J
Johannes Rieken 已提交
2390 2391 2392 2393

		/**
		 * A human-readable string that represents a doc-comment.
		 */
2394
		documentation?: string;
J
Johannes Rieken 已提交
2395 2396

		/**
A
Andre Weinand 已提交
2397
		 * A string that should be used when comparing this item
J
Johannes Rieken 已提交
2398 2399 2400
		 * with other items. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
2401
		sortText?: string;
J
Johannes Rieken 已提交
2402 2403 2404 2405 2406 2407

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

		/**
2411
		 * A string or snippet that should be inserted in a document when selecting
J
Johannes Rieken 已提交
2412 2413 2414
		 * this completion. When `falsy` the [label](#CompletionItem.label)
		 * is used.
		 */
2415
		insertText?: string | SnippetString;
2416 2417 2418 2419 2420 2421 2422 2423 2424 2425

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

2428 2429
		/**
		 * An optional set of characters that when pressed while this completion is active will accept it first and
J
Johannes Rieken 已提交
2430
		 * then type that character. *Note* that all commit characters should have `length=1` and that superfluous
2431 2432 2433 2434
		 * characters will be ignored.
		 */
		commitCharacters?: string[];

J
Johannes Rieken 已提交
2435
		/**
2436 2437 2438
		 * @deprecated **Deprecated** in favor of `CompletionItem.insertText` and `CompletionItem.range`.
		 *
		 * ~~An [edit](#TextEdit) which is applied to a document when selecting
J
Johannes Rieken 已提交
2439
		 * this completion. When an edit is provided the value of
2440
		 * [insertText](#CompletionItem.insertText) is ignored.~~
2441
		 *
2442 2443
		 * ~~The [range](#Range) of the edit must be single-line and on the same
		 * line completions were [requested](#CompletionItemProvider.provideCompletionItems) at.~~
J
Johannes Rieken 已提交
2444
		 */
2445
		textEdit?: TextEdit;
J
Johannes Rieken 已提交
2446

2447 2448 2449 2450 2451
		/**
		 * An optional array of additional [text edits](#TextEdit) that are applied when
		 * selecting this completion. Edits must not overlap with the main [edit](#CompletionItem.textEdit)
		 * nor with themselves.
		 */
2452
		additionalTextEdits?: TextEdit[];
2453 2454

		/**
2455 2456
		 * An optional [command](#Command) that is executed *after* inserting this completion. *Note* that
		 * additional modifications to the current document should be described with the
2457 2458
		 * [additionalTextEdits](#CompletionItem.additionalTextEdits)-property.
		 */
2459
		command?: Command;
2460

J
Johannes Rieken 已提交
2461 2462 2463 2464 2465 2466 2467
		/**
		 * 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.
2468
		 * @param kind The [kind](#CompletionItemKind) of the completion.
J
Johannes Rieken 已提交
2469
		 */
2470
		constructor(label: string, kind?: CompletionItemKind);
E
Erich Gamma 已提交
2471 2472
	}

2473 2474 2475 2476
	/**
	 * Represents a collection of [completion items](#CompletionItem) to be presented
	 * in the editor.
	 */
J
Johannes Rieken 已提交
2477
	export class CompletionList {
2478 2479 2480 2481 2482

		/**
		 * This list it not complete. Further typing should result in recomputing
		 * this list.
		 */
2483
		isIncomplete?: boolean;
2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498

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

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

J
Johannes Rieken 已提交
2499 2500
	/**
	 * The completion item provider interface defines the contract between extensions and
2501
	 * [IntelliSense](https://code.visualstudio.com/docs/editor/editingevolved#_intellisense).
J
Johannes Rieken 已提交
2502 2503 2504 2505
	 *
	 * 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 已提交
2506
	 * [provideCompletionItems](#CompletionItemProvider.provideCompletionItems)-function. Subsequently,
S
Steven Clarke 已提交
2507
	 * when a completion item is shown in the UI and gains focus this provider is asked to resolve
J
Johannes Rieken 已提交
2508
	 * the item, like adding [doc-comment](#CompletionItem.documentation) or [details](#CompletionItem.detail).
2509 2510 2511
	 *
	 * Providers are asked for completions either explicitly by a user gesture or -depending on the configuration-
	 * implicitly when typing words or trigger characters.
J
Johannes Rieken 已提交
2512
	 */
E
Erich Gamma 已提交
2513
	export interface CompletionItemProvider {
J
Johannes Rieken 已提交
2514 2515

		/**
J
Johannes Rieken 已提交
2516
		 * Provide completion items for the given position and document.
J
Johannes Rieken 已提交
2517
		 *
J
Johannes Rieken 已提交
2518 2519 2520
		 * @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.
2521 2522
		 * @return An array of completions, a [completion list](#CompletionList), or a thenable that resolves to either.
		 * The lack of a result can be signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2523
		 */
2524
		provideCompletionItems(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<CompletionItem[] | CompletionList>;
J
Johannes Rieken 已提交
2525 2526

		/**
J
Johannes Rieken 已提交
2527 2528 2529 2530
		 * 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 已提交
2531
		 *
J
Johannes Rieken 已提交
2532 2533
		 * @param item A completion item currently active in the UI.
		 * @param token A cancellation token.
S
Steven Clarke 已提交
2534
		 * @return The resolved completion item or a thenable that resolves to of such. It is OK to return the given
J
Johannes Rieken 已提交
2535
		 * `item`. When no result is returned, the given `item` will be used.
J
Johannes Rieken 已提交
2536
		 */
2537
		resolveCompletionItem?(item: CompletionItem, token: CancellationToken): ProviderResult<CompletionItem>;
E
Erich Gamma 已提交
2538 2539
	}

J
Johannes Rieken 已提交
2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554

	/**
	 * A document link is a range in a text document that links to an internal or external resource, like another
	 * text document or a web site.
	 */
	export class DocumentLink {

		/**
		 * The range this link applies to.
		 */
		range: Range;

		/**
		 * The uri this link points to.
		 */
2555
		target?: Uri;
J
Johannes Rieken 已提交
2556 2557 2558 2559 2560 2561 2562

		/**
		 * Creates a new document link.
		 *
		 * @param range The range the document link applies to. Must not be empty.
		 * @param target The uri the document link points to.
		 */
2563
		constructor(range: Range, target?: Uri);
J
Johannes Rieken 已提交
2564 2565 2566 2567 2568 2569 2570 2571 2572
	}

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

		/**
2573 2574 2575
		 * Provide links for the given document. Note that the editor ships with a default provider that detects
		 * `http(s)` and `file` links.
		 *
J
Johannes Rieken 已提交
2576 2577 2578
		 * @param document The document in which the command was invoked.
		 * @param token A cancellation token.
		 * @return An array of [document links](#DocumentLink) or a thenable that resolves to such. The lack of a result
2579
		 * can be signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2580
		 */
2581
		provideDocumentLinks(document: TextDocument, token: CancellationToken): ProviderResult<DocumentLink[]>;
2582 2583 2584 2585 2586 2587 2588 2589 2590 2591

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

J
Johannes Rieken 已提交
2595 2596 2597 2598
	/**
	 * A tuple of two characters, like a pair of
	 * opening and closing brackets.
	 */
E
Erich Gamma 已提交
2599 2600
	export type CharacterPair = [string, string];

J
Johannes Rieken 已提交
2601 2602 2603
	/**
	 * Describes how comments for a language work.
	 */
E
Erich Gamma 已提交
2604
	export interface CommentRule {
J
Johannes Rieken 已提交
2605 2606 2607 2608

		/**
		 * The line comment token, like `// this is a comment`
		 */
E
Erich Gamma 已提交
2609
		lineComment?: string;
J
Johannes Rieken 已提交
2610 2611 2612 2613 2614

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

A
Alex Dima 已提交
2617 2618 2619
	/**
	 * Describes indentation rules for a language.
	 */
E
Erich Gamma 已提交
2620
	export interface IndentationRule {
A
Alex Dima 已提交
2621 2622 2623
		/**
		 * If a line matches this pattern, then all the lines after it should be unindendented once (until another rule matches).
		 */
E
Erich Gamma 已提交
2624
		decreaseIndentPattern: RegExp;
A
Alex Dima 已提交
2625 2626 2627
		/**
		 * If a line matches this pattern, then all the lines after it should be indented once (until another rule matches).
		 */
E
Erich Gamma 已提交
2628
		increaseIndentPattern: RegExp;
A
Alex Dima 已提交
2629 2630 2631
		/**
		 * If a line matches this pattern, then **only the next line** after it should be indented once.
		 */
E
Erich Gamma 已提交
2632
		indentNextLinePattern?: RegExp;
A
Alex Dima 已提交
2633 2634 2635
		/**
		 * 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 已提交
2636 2637 2638
		unIndentedLinePattern?: RegExp;
	}

A
Alex Dima 已提交
2639 2640 2641
	/**
	 * Describes what to do with the indentation when pressing Enter.
	 */
E
Erich Gamma 已提交
2642
	export enum IndentAction {
A
Alex Dima 已提交
2643 2644 2645
		/**
		 * Insert new line and copy the previous line's indentation.
		 */
2646
		None = 0,
A
Alex Dima 已提交
2647 2648 2649
		/**
		 * Insert new line and indent once (relative to the previous line's indentation).
		 */
2650
		Indent = 1,
A
Alex Dima 已提交
2651 2652 2653 2654 2655
		/**
		 * Insert two new lines:
		 *  - the first one indented which will hold the cursor
		 *  - the second one at the same indentation level
		 */
2656
		IndentOutdent = 2,
A
Alex Dima 已提交
2657 2658 2659
		/**
		 * Insert new line and outdent once (relative to the previous line's indentation).
		 */
2660
		Outdent = 3
E
Erich Gamma 已提交
2661 2662
	}

A
Alex Dima 已提交
2663 2664 2665
	/**
	 * Describes what to do when pressing Enter.
	 */
E
Erich Gamma 已提交
2666
	export interface EnterAction {
A
Alex Dima 已提交
2667 2668 2669 2670 2671 2672 2673
		/**
		 * 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 已提交
2674
		appendText?: string;
A
Alex Dima 已提交
2675 2676 2677 2678
		/**
		 * Describes the number of characters to remove from the new line's indentation.
		 */
		removeText?: number;
E
Erich Gamma 已提交
2679 2680
	}

A
Alex Dima 已提交
2681 2682 2683
	/**
	 * Describes a rule to be evaluated when pressing Enter.
	 */
E
Erich Gamma 已提交
2684
	export interface OnEnterRule {
A
Alex Dima 已提交
2685 2686 2687
		/**
		 * This rule will only execute if the text before the cursor matches this regular expression.
		 */
E
Erich Gamma 已提交
2688
		beforeText: RegExp;
A
Alex Dima 已提交
2689 2690 2691
		/**
		 * This rule will only execute if the text after the cursor matches this regular expression.
		 */
E
Erich Gamma 已提交
2692
		afterText?: RegExp;
A
Alex Dima 已提交
2693 2694 2695
		/**
		 * The action to execute.
		 */
E
Erich Gamma 已提交
2696 2697 2698
		action: EnterAction;
	}

J
Johannes Rieken 已提交
2699
	/**
A
Andre Weinand 已提交
2700
	 * The language configuration interfaces defines the contract between extensions
S
Steven Clarke 已提交
2701
	 * and various editor features, like automatic bracket insertion, automatic indentation etc.
J
Johannes Rieken 已提交
2702
	 */
E
Erich Gamma 已提交
2703
	export interface LanguageConfiguration {
A
Alex Dima 已提交
2704 2705 2706
		/**
		 * The language's comment settings.
		 */
E
Erich Gamma 已提交
2707
		comments?: CommentRule;
A
Alex Dima 已提交
2708 2709 2710 2711
		/**
		 * The language's brackets.
		 * This configuration implicitly affects pressing Enter around these brackets.
		 */
E
Erich Gamma 已提交
2712
		brackets?: CharacterPair[];
A
Alex Dima 已提交
2713 2714 2715 2716 2717 2718 2719
		/**
		 * 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 已提交
2720
		wordPattern?: RegExp;
A
Alex Dima 已提交
2721 2722 2723
		/**
		 * The language's indentation settings.
		 */
E
Erich Gamma 已提交
2724
		indentationRules?: IndentationRule;
A
Alex Dima 已提交
2725 2726 2727
		/**
		 * The language's rules to be evaluated when pressing Enter.
		 */
E
Erich Gamma 已提交
2728 2729 2730
		onEnterRules?: OnEnterRule[];

		/**
A
Alex Dima 已提交
2731
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
2732 2733
		 *
		 * @deprecated Will be replaced by a better API soon.
E
Erich Gamma 已提交
2734 2735
		 */
		__electricCharacterSupport?: {
2736 2737 2738 2739 2740 2741
			/**
			 * This property is deprecated and will be **ignored** from
			 * the editor.
			 * @deprecated
			 */
			brackets?: any;
2742 2743 2744 2745 2746 2747
			/**
			 * This property is deprecated and not fully supported anymore by
			 * the editor (scope and lineStart are ignored).
			 * Use the the autoClosingPairs property in the language configuration file instead.
			 * @deprecated
			 */
E
Erich Gamma 已提交
2748
			docComment?: {
A
Alex Dima 已提交
2749 2750 2751 2752
				scope: string;
				open: string;
				lineStart: string;
				close?: string;
E
Erich Gamma 已提交
2753 2754 2755 2756
			};
		};

		/**
A
Alex Dima 已提交
2757
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
2758
		 *
2759
		 * @deprecated * Use the the autoClosingPairs property in the language configuration file instead.
E
Erich Gamma 已提交
2760 2761 2762 2763 2764 2765 2766 2767 2768 2769
		 */
		__characterPairSupport?: {
			autoClosingPairs: {
				open: string;
				close: string;
				notIn?: string[];
			}[];
		};
	}

J
Johannes Rieken 已提交
2770
	/**
2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781
	 * Represents the workspace configuration.
	 *
	 * The workspace configuration is a merged view: Configurations of the current [workspace](#workspace.rootPath)
	 * (if available), files like `launch.json`, and the installation-wide configuration. Workspace specific values
	 * shadow installation-wide values.
	 *
	 * *Note:* The merged configuration of the current [workspace](#workspace.rootPath)
	 * also contains settings from files like `launch.json` and `tasks.json`. Their basename will be
	 * part of the section identifier. The following snippets shows how to retrieve all configurations
	 * from `launch.json`:
	 *
2782
	 * ```ts
D
Daniel Imms 已提交
2783 2784
	 * // launch.json configuration
	 * const config = workspace.getConfiguration('launch');
2785 2786
	 *
	 * // retrieve values
D
Daniel Imms 已提交
2787 2788
	 * const values = config.get('configurations');
	 * ```
J
Johannes Rieken 已提交
2789
	 */
E
Erich Gamma 已提交
2790 2791
	export interface WorkspaceConfiguration {

2792 2793 2794 2795 2796 2797 2798 2799
		/**
		 * Return a value from this configuration.
		 *
		 * @param section Configuration name, supports _dotted_ names.
		 * @return The value `section` denotes or `undefined`.
		 */
		get<T>(section: string): T | undefined;

E
Erich Gamma 已提交
2800
		/**
J
Johannes Rieken 已提交
2801 2802 2803
		 * Return a value from this configuration.
		 *
		 * @param section Configuration name, supports _dotted_ names.
J
Johannes Rieken 已提交
2804
		 * @param defaultValue A value should be returned when no value could be found, is `undefined`.
J
Johannes Rieken 已提交
2805
		 * @return The value `section` denotes or the default.
E
Erich Gamma 已提交
2806
		 */
2807 2808
		get<T>(section: string, defaultValue: T): T;

E
Erich Gamma 已提交
2809 2810

		/**
J
Johannes Rieken 已提交
2811 2812
		 * Check if this configuration has a certain value.
		 *
2813
		 * @param section Configuration name, supports _dotted_ names.
A
Andre Weinand 已提交
2814
		 * @return `true` iff the section doesn't resolve to `undefined`.
E
Erich Gamma 已提交
2815 2816 2817
		 */
		has(section: string): boolean;

2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830
		/**
		 * Retrieve all information about a configuration setting. A configuration value
		 * often consists of a *default* value, a global or installation-wide value, and
		 * a workspace-specific value. The *effective* value (returned by [`get`](#WorkspaceConfiguration.get))
		 * is computed like this: `defaultValue` overwritten by `globalValue`,
		 * `globalValue` overwritten by `workspaceValue`.
		 *
		 * *Note:* The configuration name must denote a leaf in the configuration tree
		 * (`editor.fontSize` vs `editor`) otherwise no result is returned.
		 *
		 * @param section Configuration name, supports _dotted_ names.
		 * @return Information about a configuration setting or `undefined`.
		 */
2831
		inspect<T>(section: string): { key: string; defaultValue?: T; globalValue?: T; workspaceValue?: T } | undefined;
2832

2833 2834
		/**
		 * Update a configuration value. A value can be changed for the current
2835
		 * [workspace](#workspace.rootPath) only, or globally for all instances of the
2836 2837
		 * editor. The updated configuration values are persisted.
		 *
2838
		 * *Note 1:* Setting an installation-wide value (`global: true`) in the presence of
2839 2840 2841
		 * a more specific workspace value has no observable effect in that workspace, but
		 * in others.
		 *
2842 2843
		 * *Note 2:* To remove a configuration value use `undefined`, like so: `config.update('somekey', undefined)`
		 *
2844 2845 2846 2847
		 * @param section Configuration name, supports _dotted_ names.
		 * @param value The new value.
		 * @param global When `true` changes the configuration value for all instances of the editor.
		 */
2848
		update(section: string, value: any, global?: boolean): Thenable<void>;
2849

E
Erich Gamma 已提交
2850 2851 2852
		/**
		 * Readable dictionary that backs this configuration.
		 */
2853
		readonly[key: string]: any;
E
Erich Gamma 已提交
2854 2855
	}

J
Johannes Rieken 已提交
2856 2857 2858 2859 2860
	/**
	 * Represents a location inside a resource, such as a line
	 * inside a text file.
	 */
	export class Location {
J
Johannes Rieken 已提交
2861 2862 2863 2864

		/**
		 * The resource identifier of this location.
		 */
J
Johannes Rieken 已提交
2865
		uri: Uri;
J
Johannes Rieken 已提交
2866 2867 2868 2869

		/**
		 * The document range of this locations.
		 */
J
Johannes Rieken 已提交
2870
		range: Range;
J
Johannes Rieken 已提交
2871 2872 2873 2874 2875 2876 2877 2878

		/**
		 * 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 已提交
2879 2880
	}

E
Erich Gamma 已提交
2881 2882 2883 2884
	/**
	 * Represents the severity of diagnostics.
	 */
	export enum DiagnosticSeverity {
J
Johannes Rieken 已提交
2885 2886

		/**
S
Steven Clarke 已提交
2887
		 * Something not allowed by the rules of a language or other means.
J
Johannes Rieken 已提交
2888 2889 2890 2891 2892 2893
		 */
		Error = 0,

		/**
		 * Something suspicious but allowed.
		 */
E
Erich Gamma 已提交
2894
		Warning = 1,
J
Johannes Rieken 已提交
2895 2896 2897 2898 2899 2900 2901

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

		/**
A
Andre Weinand 已提交
2902
		 * Something to hint to a better way of doing it, like proposing
J
Johannes Rieken 已提交
2903 2904 2905
		 * a refactoring.
		 */
		Hint = 3
E
Erich Gamma 已提交
2906 2907 2908
	}

	/**
J
Johannes Rieken 已提交
2909 2910
	 * Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
	 * are only valid in the scope of a file.
E
Erich Gamma 已提交
2911
	 */
J
Johannes Rieken 已提交
2912 2913 2914 2915 2916
	export class Diagnostic {

		/**
		 * The range to which this diagnostic applies.
		 */
E
Erich Gamma 已提交
2917
		range: Range;
J
Johannes Rieken 已提交
2918 2919 2920 2921 2922 2923

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

2924 2925 2926 2927 2928 2929
		/**
		 * A human-readable string describing the source of this
		 * diagnostic, e.g. 'typescript' or 'super lint'.
		 */
		source: string;

J
Johannes Rieken 已提交
2930 2931 2932 2933 2934 2935
		/**
		 * The severity, default is [error](#DiagnosticSeverity.Error).
		 */
		severity: DiagnosticSeverity;

		/**
S
Steven Clarke 已提交
2936
		 * A code or identifier for this diagnostics. Will not be surfaced
A
Andre Weinand 已提交
2937
		 * to the user, but should be used for later processing, e.g. when
J
Johannes Rieken 已提交
2938 2939 2940 2941 2942
		 * providing [code actions](#CodeActionContext).
		 */
		code: string | number;

		/**
A
Andre Weinand 已提交
2943
		 * Creates a new diagnostic object.
J
Johannes Rieken 已提交
2944 2945 2946
		 *
		 * @param range The range to which this diagnostic applies.
		 * @param message The human-readable message.
A
Andre Weinand 已提交
2947
		 * @param severity The severity, default is [error](#DiagnosticSeverity.Error).
J
Johannes Rieken 已提交
2948 2949
		 */
		constructor(range: Range, message: string, severity?: DiagnosticSeverity);
E
Erich Gamma 已提交
2950 2951
	}

J
Johannes Rieken 已提交
2952 2953 2954
	/**
	 * A diagnostics collection is a container that manages a set of
	 * [diagnostics](#Diagnostic). Diagnostics are always scopes to a
2955
	 * diagnostics collection and a resource.
J
Johannes Rieken 已提交
2956 2957 2958 2959
	 *
	 * To get an instance of a `DiagnosticCollection` use
	 * [createDiagnosticCollection](#languages.createDiagnosticCollection).
	 */
E
Erich Gamma 已提交
2960 2961 2962
	export interface DiagnosticCollection {

		/**
J
Johannes Rieken 已提交
2963 2964 2965
		 * 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 已提交
2966
		 */
Y
Yuki Ueda 已提交
2967
		readonly name: string;
E
Erich Gamma 已提交
2968 2969 2970

		/**
		 * Assign diagnostics for given resource. Will replace
J
Johannes Rieken 已提交
2971 2972 2973 2974
		 * existing diagnostics for that resource.
		 *
		 * @param uri A resource identifier.
		 * @param diagnostics Array of diagnostics or `undefined`
E
Erich Gamma 已提交
2975
		 */
2976
		set(uri: Uri, diagnostics: Diagnostic[] | undefined): void;
E
Erich Gamma 已提交
2977 2978

		/**
2979
		 * Replace all entries in this collection.
J
Johannes Rieken 已提交
2980
		 *
2981 2982 2983 2984 2985 2986
		 * Diagnostics of multiple tuples of the same uri will be merged, e.g
		 * `[[file1, [d1]], [file1, [d2]]]` is equivalent to `[[file1, [d1, d2]]]`.
		 * If a diagnostics item is `undefined` as in `[file1, undefined]`
		 * all previous but not subsequent diagnostics are removed.
		 *
		 * @param entries An array of tuples, like `[[file1, [d1, d2]], [file2, [d3, d4, d5]]]`, or `undefined`.
E
Erich Gamma 已提交
2987
		 */
2988
		set(entries: [Uri, Diagnostic[] | undefined][]): void;
E
Erich Gamma 已提交
2989 2990

		/**
2991 2992
		 * Remove all diagnostics from this collection that belong
		 * to the provided `uri`. The same as `#set(uri, undefined)`.
J
Johannes Rieken 已提交
2993
		 *
2994
		 * @param uri A resource identifier.
E
Erich Gamma 已提交
2995
		 */
2996
		delete(uri: Uri): void;
E
Erich Gamma 已提交
2997 2998 2999 3000 3001 3002 3003

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

3004 3005 3006 3007 3008 3009 3010 3011
		/**
		 * Iterate over each entry in this collection.
		 *
		 * @param callback Function to execute for each entry.
		 * @param thisArg The `this` context used when invoking the handler function.
		 */
		forEach(callback: (uri: Uri, diagnostics: Diagnostic[], collection: DiagnosticCollection) => any, thisArg?: any): void;

3012 3013 3014 3015 3016 3017 3018
		/**
		 * Get the diagnostics for a given resource. *Note* that you cannot
		 * modify the diagnostics-array returned from this call.
		 *
		 * @param uri A resource identifier.
		 * @returns An immutable array of [diagnostics](#Diagnostic) or `undefined`.
		 */
3019
		get(uri: Uri): Diagnostic[] | undefined;
3020 3021 3022 3023 3024 3025 3026 3027 3028 3029

		/**
		 * Check if this collection contains diagnostics for a
		 * given resource.
		 *
		 * @param uri A resource identifier.
		 * @returns `true` if this collection has diagnostic for the given resource.
		 */
		has(uri: Uri): boolean;

J
Johannes Rieken 已提交
3030 3031 3032 3033
		/**
		 * Dispose and free associated resources. Calls
		 * [clear](#DiagnosticCollection.clear).
		 */
E
Erich Gamma 已提交
3034 3035 3036
		dispose(): void;
	}

J
Johannes Rieken 已提交
3037
	/**
J
Johannes Rieken 已提交
3038 3039
	 * Denotes a column in the VS Code window. Columns are
	 * used to show editors side by side.
J
Johannes Rieken 已提交
3040 3041 3042 3043 3044 3045 3046
	 */
	export enum ViewColumn {
		One = 1,
		Two = 2,
		Three = 3
	}

E
Erich Gamma 已提交
3047
	/**
J
Johannes Rieken 已提交
3048 3049 3050 3051
	 * An output channel is a container for readonly textual information.
	 *
	 * To get an instance of an `OutputChannel` use
	 * [createOutputChannel](#window.createOutputChannel).
E
Erich Gamma 已提交
3052
	 */
J
Johannes Rieken 已提交
3053
	export interface OutputChannel {
E
Erich Gamma 已提交
3054

J
Johannes Rieken 已提交
3055 3056 3057
		/**
		 * The human-readable name of this output channel.
		 */
Y
Yuki Ueda 已提交
3058
		readonly name: string;
E
Erich Gamma 已提交
3059 3060

		/**
J
Johannes Rieken 已提交
3061
		 * Append the given value to the channel.
E
Erich Gamma 已提交
3062
		 *
J
Johannes Rieken 已提交
3063
		 * @param value A string, falsy values will not be printed.
E
Erich Gamma 已提交
3064
		 */
J
Johannes Rieken 已提交
3065
		append(value: string): void;
E
Erich Gamma 已提交
3066 3067

		/**
J
Johannes Rieken 已提交
3068 3069
		 * Append the given value and a line feed character
		 * to the channel.
E
Erich Gamma 已提交
3070
		 *
J
Johannes Rieken 已提交
3071
		 * @param value A string, falsy values will be printed.
E
Erich Gamma 已提交
3072 3073 3074
		 */
		appendLine(value: string): void;

J
Johannes Rieken 已提交
3075 3076 3077
		/**
		 * Removes all output from the channel.
		 */
E
Erich Gamma 已提交
3078 3079
		clear(): void;

J
Johannes Rieken 已提交
3080 3081
		/**
		 * Reveal this channel in the UI.
3082
		 *
3083
		 * @param preserveFocus When `true` the channel will not take focus.
J
Johannes Rieken 已提交
3084
		 */
J
Johannes Rieken 已提交
3085
		show(preserveFocus?: boolean): void;
E
Erich Gamma 已提交
3086

3087 3088 3089
		/**
		 * Reveal this channel in the UI.
		 *
J
Johannes Rieken 已提交
3090 3091 3092 3093
		 * @deprecated This method is **deprecated** and the overload with
		 * just one parameter should be used (`show(preserveFocus?: boolean): void`).
		 *
		 * @param column This argument is **deprecated** and will be ignored.
3094 3095
		 * @param preserveFocus When `true` the channel will not take focus.
		 */
J
Johannes Rieken 已提交
3096
		show(column?: ViewColumn, preserveFocus?: boolean): void;
3097

J
Johannes Rieken 已提交
3098 3099 3100
		/**
		 * Hide this channel from the UI.
		 */
E
Erich Gamma 已提交
3101 3102
		hide(): void;

J
Johannes Rieken 已提交
3103 3104 3105
		/**
		 * Dispose and free associated resources.
		 */
E
Erich Gamma 已提交
3106 3107 3108 3109
		dispose(): void;
	}

	/**
J
Johannes Rieken 已提交
3110
	 * Represents the alignment of status bar items.
E
Erich Gamma 已提交
3111 3112
	 */
	export enum StatusBarAlignment {
J
Johannes Rieken 已提交
3113 3114 3115 3116

		/**
		 * Aligned to the left side.
		 */
3117
		Left = 1,
J
Johannes Rieken 已提交
3118 3119 3120 3121

		/**
		 * Aligned to the right side.
		 */
3122
		Right = 2
E
Erich Gamma 已提交
3123 3124 3125 3126 3127 3128 3129 3130 3131
	}

	/**
	 * 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 已提交
3132
		 * The alignment of this item.
E
Erich Gamma 已提交
3133
		 */
Y
Yuki Ueda 已提交
3134
		readonly alignment: StatusBarAlignment;
E
Erich Gamma 已提交
3135 3136

		/**
J
Johannes Rieken 已提交
3137 3138
		 * The priority of this item. Higher value means the item should
		 * be shown more to the left.
E
Erich Gamma 已提交
3139
		 */
Y
Yuki Ueda 已提交
3140
		readonly priority: number;
E
Erich Gamma 已提交
3141 3142

		/**
J
Johannes Rieken 已提交
3143 3144
		 * The text to show for the entry. You can embed icons in the text by leveraging the syntax:
		 *
3145
		 * `My text $(icon-name) contains icons like $(icon'name) this one.`
J
Johannes Rieken 已提交
3146
		 *
3147 3148
		 * 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 已提交
3149
		 */
E
Erich Gamma 已提交
3150 3151 3152
		text: string;

		/**
J
Johannes Rieken 已提交
3153 3154
		 * The tooltip text when you hover over this entry.
		 */
E
Erich Gamma 已提交
3155 3156 3157
		tooltip: string;

		/**
J
Johannes Rieken 已提交
3158 3159
		 * The foreground color for this entry.
		 */
E
Erich Gamma 已提交
3160 3161 3162
		color: string;

		/**
J
Johannes Rieken 已提交
3163 3164 3165
		 * The identifier of a command to run on click. The command must be
		 * [known](#commands.getCommands).
		 */
E
Erich Gamma 已提交
3166 3167 3168 3169 3170 3171 3172 3173
		command: string;

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

		/**
J
Johannes Rieken 已提交
3174
		 * Hide the entry in the status bar.
E
Erich Gamma 已提交
3175 3176 3177 3178
		 */
		hide(): void;

		/**
J
Johannes Rieken 已提交
3179 3180
		 * Dispose and free associated resources. Call
		 * [hide](#StatusBarItem.hide).
E
Erich Gamma 已提交
3181 3182 3183 3184
		 */
		dispose(): void;
	}

D
Daniel Imms 已提交
3185 3186 3187
	/**
	 * An individual terminal instance within the integrated terminal.
	 */
D
Daniel Imms 已提交
3188
	export interface Terminal {
D
Daniel Imms 已提交
3189

3190 3191 3192
		/**
		 * The name of the terminal.
		 */
Y
Yuki Ueda 已提交
3193
		readonly name: string;
3194

3195 3196 3197
		/**
		 * The process ID of the shell process.
		 */
Y
Yuki Ueda 已提交
3198
		readonly processId: Thenable<number>;
3199

D
Daniel Imms 已提交
3200
		/**
D
Daniel Imms 已提交
3201
		 * Send text to the terminal. The text is written to the stdin of the underlying pty process
3202
		 * (shell) of the terminal.
D
Daniel Imms 已提交
3203
		 *
D
Daniel Imms 已提交
3204
		 * @param text The text to send.
D
Daniel Imms 已提交
3205
		 * @param addNewLine Whether to add a new line to the text being sent, this is normally
3206 3207
		 * required to run a command in the terminal. The character(s) added are \n or \r\n
		 * depending on the platform. This defaults to `true`.
D
Daniel Imms 已提交
3208
		 */
3209
		sendText(text: string, addNewLine?: boolean): void;
D
Daniel Imms 已提交
3210 3211

		/**
D
Daniel Imms 已提交
3212
		 * Show the terminal panel and reveal this terminal in the UI.
D
Daniel Imms 已提交
3213
		 *
D
Daniel Imms 已提交
3214
		 * @param preserveFocus When `true` the terminal will not take focus.
D
Daniel Imms 已提交
3215
		 */
D
Daniel Imms 已提交
3216
		show(preserveFocus?: boolean): void;
D
Daniel Imms 已提交
3217 3218

		/**
D
Daniel Imms 已提交
3219
		 * Hide the terminal panel if this terminal is currently showing.
D
Daniel Imms 已提交
3220 3221 3222 3223 3224 3225 3226
		 */
		hide(): void;

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

J
Johannes Rieken 已提交
3229 3230 3231
	/**
	 * Represents an extension.
	 *
A
Alex Dima 已提交
3232
	 * To get an instance of an `Extension` use [getExtension](#extensions.getExtension).
J
Johannes Rieken 已提交
3233
	 */
E
Erich Gamma 已提交
3234
	export interface Extension<T> {
J
Johannes Rieken 已提交
3235

E
Erich Gamma 已提交
3236
		/**
J
Johannes Rieken 已提交
3237
		 * The canonical extension identifier in the form of: `publisher.name`.
E
Erich Gamma 已提交
3238
		 */
Y
Yuki Ueda 已提交
3239
		readonly id: string;
E
Erich Gamma 已提交
3240 3241

		/**
J
Johannes Rieken 已提交
3242
		 * The absolute file path of the directory containing this extension.
E
Erich Gamma 已提交
3243
		 */
Y
Yuki Ueda 已提交
3244
		readonly extensionPath: string;
E
Erich Gamma 已提交
3245 3246

		/**
3247
		 * `true` if the extension has been activated.
E
Erich Gamma 已提交
3248
		 */
Y
Yuki Ueda 已提交
3249
		readonly isActive: boolean;
E
Erich Gamma 已提交
3250 3251 3252 3253

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

		/**
A
Alex Dima 已提交
3257
		 * The public API exported by this extension. It is an invalid action
J
Johannes Rieken 已提交
3258
		 * to access this field before this extension has been activated.
E
Erich Gamma 已提交
3259
		 */
Y
Yuki Ueda 已提交
3260
		readonly exports: T;
E
Erich Gamma 已提交
3261 3262 3263

		/**
		 * Activates this extension and returns its public API.
J
Johannes Rieken 已提交
3264
		 *
S
Steven Clarke 已提交
3265
		 * @return A promise that will resolve when this extension has been activated.
E
Erich Gamma 已提交
3266 3267 3268 3269
		 */
		activate(): Thenable<T>;
	}

J
Johannes Rieken 已提交
3270
	/**
S
Steven Clarke 已提交
3271 3272
	 * An extension context is a collection of utilities private to an
	 * extension.
J
Johannes Rieken 已提交
3273
	 *
S
Steven Clarke 已提交
3274
	 * An instance of an `ExtensionContext` is provided as the first
J
Johannes Rieken 已提交
3275 3276
	 * parameter to the `activate`-call of an extension.
	 */
E
Erich Gamma 已提交
3277 3278 3279 3280
	export interface ExtensionContext {

		/**
		 * An array to which disposables can be added. When this
J
Johannes Rieken 已提交
3281
		 * extension is deactivated the disposables will be disposed.
E
Erich Gamma 已提交
3282 3283 3284 3285 3286
		 */
		subscriptions: { dispose(): any }[];

		/**
		 * A memento object that stores state in the context
3287
		 * of the currently opened [workspace](#workspace.rootPath).
E
Erich Gamma 已提交
3288 3289 3290 3291 3292
		 */
		workspaceState: Memento;

		/**
		 * A memento object that stores state independent
3293
		 * of the current opened [workspace](#workspace.rootPath).
E
Erich Gamma 已提交
3294 3295 3296 3297
		 */
		globalState: Memento;

		/**
J
Johannes Rieken 已提交
3298
		 * The absolute file path of the directory containing the extension.
E
Erich Gamma 已提交
3299 3300 3301 3302
		 */
		extensionPath: string;

		/**
A
Alex Dima 已提交
3303 3304 3305 3306
		 * 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 已提交
3307 3308
		 */
		asAbsolutePath(relativePath: string): string;
D
Dirk Baeumer 已提交
3309 3310

		/**
J
Johannes Rieken 已提交
3311 3312 3313
		 * An absolute file path of a workspace specific directory in which the extension
		 * can store private state. The directory might not exist on disk and creation is
		 * up to the extension. However, the parent directory is guaranteed to be existent.
D
Dirk Baeumer 已提交
3314
		 *
3315 3316
		 * Use [`workspaceState`](#ExtensionContext.workspaceState) or
		 * [`globalState`](#ExtensionContext.globalState) to store key value data.
D
Dirk Baeumer 已提交
3317
		 */
3318
		storagePath: string | undefined;
E
Erich Gamma 已提交
3319 3320 3321 3322 3323 3324 3325 3326
	}

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

3327 3328 3329 3330 3331 3332 3333 3334
		/**
		 * Return a value.
		 *
		 * @param key A string.
		 * @return The stored value or `undefined`.
		 */
		get<T>(key: string): T | undefined;

E
Erich Gamma 已提交
3335
		/**
J
Johannes Rieken 已提交
3336 3337 3338 3339 3340
		 * 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.
3341
		 * @return The stored value or the defaultValue.
E
Erich Gamma 已提交
3342
		 */
3343
		get<T>(key: string, defaultValue: T): T;
E
Erich Gamma 已提交
3344 3345

		/**
S
Steven Clarke 已提交
3346
		 * Store a value. The value must be JSON-stringifyable.
J
Johannes Rieken 已提交
3347 3348 3349
		 *
		 * @param key A string.
		 * @param value A value. MUST not contain cyclic references.
E
Erich Gamma 已提交
3350 3351 3352 3353
		 */
		update(key: string, value: any): Thenable<void>;
	}

3354 3355 3356 3357 3358
	/**
	 * Namespace describing the environment the editor runs in.
	 */
	export namespace env {

3359 3360 3361 3362 3363 3364 3365
		/**
		 * The application name of the editor, like 'VS Code'.
		 *
		 * @readonly
		 */
		export let appName: string;

J
Johannes Rieken 已提交
3366 3367 3368 3369 3370 3371 3372
		/**
		 * Represents the preferred user-language, like `de-CH`, `fr`, or `en-US`.
		 *
		 * @readonly
		 */
		export let language: string;

3373 3374
		/**
		 * A unique identifier for the computer.
J
Johannes Rieken 已提交
3375 3376
		 *
		 * @readonly
3377 3378 3379 3380 3381 3382
		 */
		export let machineId: string;

		/**
		 * A unique identifier for the current session.
		 * Changes each time the editor is started.
J
Johannes Rieken 已提交
3383 3384
		 *
		 * @readonly
3385 3386 3387 3388
		 */
		export let sessionId: string;
	}

E
Erich Gamma 已提交
3389
	/**
3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402
	 * 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 已提交
3403
	 * Commands from other extensions and from the editor itself are accessible to an extension. However,
3404 3405 3406 3407 3408 3409
	 * 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', () => {
3410
	 * 	window.showInformationMessage('Hello World!');
3411 3412 3413 3414 3415
	 * });
	 * ```
	 * Second, bind the command identfier to a title under which it will show in the palette (`package.json`).
	 * ```json
	 * {
3416 3417 3418 3419 3420 3421
	 * 	"contributes": {
	 * 		"commands": [{
	 * 			"command": "extension.sayHello",
	 * 			"title": "Hello World"
	 * 		}]
	 * 	}
3422 3423
	 * }
	 * ```
E
Erich Gamma 已提交
3424 3425 3426 3427 3428
	 */
	export namespace commands {

		/**
		 * Registers a command that can be invoked via a keyboard shortcut,
S
Steven Clarke 已提交
3429
		 * a menu item, an action, or directly.
E
Erich Gamma 已提交
3430
		 *
J
Johannes Rieken 已提交
3431 3432 3433 3434 3435
		 * 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 已提交
3436
		 * @param thisArg The `this` context used when invoking the handler function.
J
Johannes Rieken 已提交
3437
		 * @return Disposable which unregisters this command on disposal.
E
Erich Gamma 已提交
3438 3439 3440 3441
		 */
		export function registerCommand(command: string, callback: (...args: any[]) => any, thisArg?: any): Disposable;

		/**
J
Johannes Rieken 已提交
3442
		 * Registers a text editor command that can be invoked via a keyboard shortcut,
S
Steven Clarke 已提交
3443
		 * a menu item, an action, or directly.
E
Erich Gamma 已提交
3444
		 *
J
Johannes Rieken 已提交
3445
		 * Text editor commands are different from ordinary [commands](#commands.registerCommand) as
S
Steven Clarke 已提交
3446
		 * they only execute when there is an active editor when the command is called. Also, the
J
Johannes Rieken 已提交
3447 3448 3449 3450 3451
		 * 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 已提交
3452
		 * @param thisArg The `this` context used when invoking the handler function.
J
Johannes Rieken 已提交
3453
		 * @return Disposable which unregisters this command on disposal.
E
Erich Gamma 已提交
3454
		 */
J
Johannes Rieken 已提交
3455
		export function registerTextEditorCommand(command: string, callback: (textEditor: TextEditor, edit: TextEditorEdit, ...args: any[]) => void, thisArg?: any): Disposable;
E
Erich Gamma 已提交
3456 3457

		/**
J
Johannes Rieken 已提交
3458 3459 3460
		 * Executes the command denoted by the given command identifier.
		 *
		 * When executing an editor command not all types are allowed to
3461
		 * be passed as arguments. Allowed are the primitive types `string`, `boolean`,
J
Johannes Rieken 已提交
3462
		 * `number`, `undefined`, and `null`, as well as classes defined in this API.
S
Steven Clarke 已提交
3463
		 * There are no restrictions when executing commands that have been contributed
J
Johannes Rieken 已提交
3464
		 * by extensions.
E
Erich Gamma 已提交
3465
		 *
J
Johannes Rieken 已提交
3466
		 * @param command Identifier of the command to execute.
J
Johannes Rieken 已提交
3467 3468 3469
		 * @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 已提交
3470
		 */
3471
		export function executeCommand<T>(command: string, ...rest: any[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
3472 3473

		/**
3474 3475
		 * Retrieve the list of all available commands. Commands starting an underscore are
		 * treated as internal commands.
E
Erich Gamma 已提交
3476
		 *
3477
		 * @param filterInternal Set `true` to not see internal commands (starting with an underscore)
E
Erich Gamma 已提交
3478 3479
		 * @return Thenable that resolves to a list of command ids.
		 */
3480
		export function getCommands(filterInternal?: boolean): Thenable<string[]>;
E
Erich Gamma 已提交
3481 3482 3483
	}

	/**
3484 3485 3486
	 * 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 已提交
3487 3488 3489 3490
	 */
	export namespace window {

		/**
3491
		 * The currently active editor or `undefined`. The active editor is the one
S
Steven Clarke 已提交
3492
		 * that currently has focus or, when none has focus, the one that has changed
E
Erich Gamma 已提交
3493 3494
		 * input most recently.
		 */
3495
		export let activeTextEditor: TextEditor | undefined;
E
Erich Gamma 已提交
3496 3497

		/**
3498
		 * The currently visible editors or an empty array.
E
Erich Gamma 已提交
3499 3500 3501 3502
		 */
		export let visibleTextEditors: TextEditor[];

		/**
3503
		 * An [event](#Event) which fires when the [active editor](#window.activeTextEditor)
J
Johannes Rieken 已提交
3504
		 * has changed. *Note* that the event also fires when the active editor changes
3505
		 * to `undefined`.
E
Erich Gamma 已提交
3506 3507 3508
		 */
		export const onDidChangeActiveTextEditor: Event<TextEditor>;

3509 3510 3511 3512 3513 3514
		/**
		 * An [event](#Event) which fires when the array of [visible editors](#window.visibleTextEditors)
		 * has changed.
		 */
		export const onDidChangeVisibleTextEditors: Event<TextEditor[]>;

E
Erich Gamma 已提交
3515
		/**
A
Andre Weinand 已提交
3516
		 * An [event](#Event) which fires when the selection in an editor has changed.
E
Erich Gamma 已提交
3517 3518 3519 3520 3521 3522 3523 3524
		 */
		export const onDidChangeTextEditorSelection: Event<TextEditorSelectionChangeEvent>;

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

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

3530
		/**
3531
		 * An [event](#Event) which fires when a terminal is disposed.
3532 3533 3534
		 */
		export const onDidCloseTerminal: Event<Terminal>;

E
Erich Gamma 已提交
3535 3536 3537 3538 3539 3540 3541
		/**
		 * 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)__.
3542
		 * @param preserveFocus When `true` the editor will not take focus.
E
Erich Gamma 已提交
3543 3544
		 * @return A promise that resolves to an [editor](#TextEditor).
		 */
3545
		export function showTextDocument(document: TextDocument, column?: ViewColumn, preserveFocus?: boolean): Thenable<TextEditor>;
E
Erich Gamma 已提交
3546 3547

		/**
J
Johannes Rieken 已提交
3548 3549 3550 3551
		 * 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 已提交
3552 3553 3554 3555 3556 3557 3558
		 */
		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 已提交
3559 3560
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
3561
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
3562
		 */
3563
		export function showInformationMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
3564 3565

		/**
J
Johannes Rieken 已提交
3566
		 * Show an information message.
J
Johannes Rieken 已提交
3567
		 *
E
Erich Gamma 已提交
3568
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
3569 3570 3571
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
3572
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
3573
		 */
3574
		export function showInformationMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
3575 3576

		/**
J
Johannes Rieken 已提交
3577
		 * Show a warning message.
J
Johannes Rieken 已提交
3578
		 *
E
Erich Gamma 已提交
3579
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
3580 3581 3582
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
3583
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
3584
		 */
3585
		export function showWarningMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
3586 3587

		/**
J
Johannes Rieken 已提交
3588
		 * Show a warning message.
J
Johannes Rieken 已提交
3589
		 *
E
Erich Gamma 已提交
3590
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
3591 3592 3593
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
3594
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
3595
		 */
3596
		export function showWarningMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
3597 3598

		/**
J
Johannes Rieken 已提交
3599
		 * Show an error message.
J
Johannes Rieken 已提交
3600
		 *
E
Erich Gamma 已提交
3601
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
3602 3603 3604
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
3605
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
3606
		 */
3607
		export function showErrorMessage(message: string, ...items: string[]): Thenable<string | undefined>;
E
Erich Gamma 已提交
3608 3609

		/**
J
Johannes Rieken 已提交
3610
		 * Show an error message.
J
Johannes Rieken 已提交
3611
		 *
E
Erich Gamma 已提交
3612
		 * @see [showInformationMessage](#window.showInformationMessage)
J
Johannes Rieken 已提交
3613 3614 3615
		 *
		 * @param message The message to show.
		 * @param items A set of items that will be rendered as actions in the message.
3616
		 * @return A thenable that resolves to the selected item or `undefined` when being dismissed.
E
Erich Gamma 已提交
3617
		 */
3618
		export function showErrorMessage<T extends MessageItem>(message: string, ...items: T[]): Thenable<T | undefined>;
E
Erich Gamma 已提交
3619 3620 3621 3622

		/**
		 * Shows a selection list.
		 *
J
Johannes Rieken 已提交
3623 3624
		 * @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.
3625
		 * @param token A token that can be used to signal cancellation.
3626
		 * @return A promise that resolves to the selection or `undefined`.
E
Erich Gamma 已提交
3627
		 */
3628
		export function showQuickPick(items: string[] | Thenable<string[]>, options?: QuickPickOptions, token?: CancellationToken): Thenable<string | undefined>;
E
Erich Gamma 已提交
3629 3630 3631 3632

		/**
		 * Shows a selection list.
		 *
J
Johannes Rieken 已提交
3633 3634
		 * @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.
3635
		 * @param token A token that can be used to signal cancellation.
3636
		 * @return A promise that resolves to the selected item or `undefined`.
E
Erich Gamma 已提交
3637
		 */
3638
		export function showQuickPick<T extends QuickPickItem>(items: T[] | Thenable<T[]>, options?: QuickPickOptions, token?: CancellationToken): Thenable<T | undefined>;
E
Erich Gamma 已提交
3639 3640 3641 3642

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

		/**
J
Johannes Rieken 已提交
3654 3655
		 * Create a new [output channel](#OutputChannel) with the given name.
		 *
3656
		 * @param name Human-readable string which will be used to represent the channel in the UI.
E
Erich Gamma 已提交
3657
		 */
3658
		export function createOutputChannel(name: string): OutputChannel;
E
Erich Gamma 已提交
3659 3660

		/**
S
Steven Clarke 已提交
3661
		 * Set a message to the status bar. This is a short hand for the more powerful
E
Erich Gamma 已提交
3662
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
3663
		 *
A
Andre Weinand 已提交
3664
		 * @param text The message to show, support icon subtitution as in status bar [items](#StatusBarItem.text).
3665
		 * @param hideAfterTimeout Timeout in milliseconds after which the message will be disposed.
J
Johannes Rieken 已提交
3666
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
3667
		 */
3668
		export function setStatusBarMessage(text: string, hideAfterTimeout: number): Disposable;
E
Erich Gamma 已提交
3669 3670

		/**
S
Steven Clarke 已提交
3671
		 * Set a message to the status bar. This is a short hand for the more powerful
J
Johannes Rieken 已提交
3672
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
3673
		 *
A
Andre Weinand 已提交
3674
		 * @param text The message to show, support icon subtitution as in status bar [items](#StatusBarItem.text).
3675
		 * @param hideWhenDone Thenable on which completion (resolve or reject) the message will be disposed.
J
Johannes Rieken 已提交
3676
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
3677
		 */
3678
		export function setStatusBarMessage(text: string, hideWhenDone: Thenable<any>): Disposable;
E
Erich Gamma 已提交
3679 3680

		/**
S
Steven Clarke 已提交
3681
		 * Set a message to the status bar. This is a short hand for the more powerful
J
Johannes Rieken 已提交
3682
		 * status bar [items](#window.createStatusBarItem).
J
Johannes Rieken 已提交
3683
		 *
3684 3685 3686
		 * *Note* that status bar messages stack and that they must be disposed when no
		 * longer used.
		 *
A
Andre Weinand 已提交
3687
		 * @param text The message to show, support icon subtitution as in status bar [items](#StatusBarItem.text).
J
Johannes Rieken 已提交
3688
		 * @return A disposable which hides the status bar message.
E
Erich Gamma 已提交
3689
		 */
3690
		export function setStatusBarMessage(text: string): Disposable;
E
Erich Gamma 已提交
3691 3692

		/**
J
Johannes Rieken 已提交
3693 3694
		 * Creates a status bar [item](#StatusBarItem).
		 *
J
Johannes Rieken 已提交
3695
		 * @param alignment The alignment of the item.
J
Johannes Rieken 已提交
3696
		 * @param priority The priority of the item. Higher values mean the item should be shown more to the left.
J
Johannes Rieken 已提交
3697 3698
		 * @return A new status bar item.
		 */
E
Erich Gamma 已提交
3699
		export function createStatusBarItem(alignment?: StatusBarAlignment, priority?: number): StatusBarItem;
D
Daniel Imms 已提交
3700

D
Daniel Imms 已提交
3701
		/**
3702 3703
		 * Creates a [Terminal](#Terminal). The cwd of the terminal will be the workspace directory
		 * if it exists, regardless of whether an explicit customStartPath setting exists.
D
Daniel Imms 已提交
3704
		 *
3705
		 * @param name Optional human-readable string which will be used to represent the terminal in the UI.
3706
		 * @param shellPath Optional path to a custom shell executable to be used in the terminal.
D
Daniel Imms 已提交
3707
		 * @param shellArgs Optional args for the custom shell executable, this does not work on Windows (see #8429)
D
Daniel Imms 已提交
3708 3709
		 * @return A new Terminal.
		 */
P
Pine Wu 已提交
3710
		export function createTerminal(name?: string, shellPath?: string, shellArgs?: string[]): Terminal;
3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744

		/**
		 * Creates a [Terminal](#Terminal). The cwd of the terminal will be the workspace directory
		 * if it exists, regardless of whether an explicit customStartPath setting exists.
		 *
		 * @param options A TerminalOptions object describing the characteristics of the new terminal.
		 * @return A new Terminal.
		 */
		export function createTerminal(options: TerminalOptions): Terminal;
	}

	/**
	 * Value-object describing what options formatting should use.
	 */
	export interface TerminalOptions {
		/**
		 * A human-readable string which will be used to represent the terminal in the UI.
		 */
		name?: string;

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

		/**
		 * Args for the custom shell executable, this does not work on Windows (see #8429)
		 */
		shellArgs?: string[];

		/**
		 * Whether the terminal should wait on exit for a keypress before closing the instance.
		 */
		waitOnExit?: boolean;
E
Erich Gamma 已提交
3745 3746 3747
	}

	/**
A
Alex Dima 已提交
3748
	 * An event describing an individual change in the text of a [document](#TextDocument).
E
Erich Gamma 已提交
3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765
	 */
	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 已提交
3766
	 * An event describing a transactional [document](#TextDocument) change.
E
Erich Gamma 已提交
3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780
	 */
	export interface TextDocumentChangeEvent {

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

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

3781 3782 3783 3784 3785 3786
	/**
	 * Represents reasons why a text document is saved.
	 */
	export enum TextDocumentSaveReason {

		/**
3787 3788
		 * Manually triggered, e.g. by the user pressing save, by starting debugging,
		 * or by an API call.
3789
		 */
3790
		Manual = 1,
3791 3792 3793 3794

		/**
		 * Automatic after a delay.
		 */
3795
		AfterDelay = 2,
3796 3797 3798 3799 3800 3801 3802

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

3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814
	/**
	 * An event that is fired when a [document](#TextDocument) will be saved.
	 *
	 * To make modifications to the document before it is being saved, call the
	 * [`waitUntil`](#TextDocumentWillSaveEvent.waitUntil)-function with a thenable
	 * that resolves to an array of [text edits](#TextEdit).
	 */
	export interface TextDocumentWillSaveEvent {

		/**
		 * The document that will be saved.
		 */
3815
		document: TextDocument;
3816

3817 3818 3819 3820 3821
		/**
		 * The reason why save was triggered.
		 */
		reason: TextDocumentSaveReason;

3822 3823 3824 3825 3826 3827 3828 3829 3830 3831
		/**
		 * Allows to pause the event loop and to apply [pre-save-edits](#TextEdit).
		 * Edits of subsequent calls to this function will be applied in order. The
		 * edits will be *ignored* if concurrent modifications of the document happened.
		 *
		 * *Note:* This function can only be called during event dispatch and not
		 * in an asynchronous manner:
		 *
		 * ```ts
		 * workspace.onWillSaveTextDocument(event => {
3832 3833 3834 3835 3836
		 * 	// async, will *throw* an error
		 * 	setTimeout(() => event.waitUntil(promise));
		 *
		 * 	// sync, OK
		 * 	event.waitUntil(promise);
3837 3838 3839 3840 3841
		 * })
		 * ```
		 *
		 * @param thenable A thenable that resolves to [pre-save-edits](#TextEdit).
		 */
3842
		waitUntil(thenable: Thenable<TextEdit[]>): void;
3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853

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

E
Erich Gamma 已提交
3854
	/**
3855 3856 3857 3858 3859
	 * 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
3860
	 * events and for [finding](#workspace.findFiles) files. Both perform well and run _outside_
S
Steven Clarke 已提交
3861
	 * the editor-process so that they should be always used instead of nodejs-equivalents.
E
Erich Gamma 已提交
3862 3863 3864 3865
	 */
	export namespace workspace {

		/**
J
Johannes Rieken 已提交
3866 3867 3868
		 * Creates a file system watcher.
		 *
		 * A glob pattern that filters the file events must be provided. Optionally, flags to ignore certain
S
Steven Clarke 已提交
3869
		 * kinds of events can be provided. To stop listening to events the watcher must be disposed.
E
Erich Gamma 已提交
3870
		 *
A
Andre Weinand 已提交
3871
		 * @param globPattern A glob pattern that is applied to the names of created, changed, and deleted files.
J
Johannes Rieken 已提交
3872 3873 3874 3875
		 * @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 已提交
3876 3877 3878 3879
		 */
		export function createFileSystemWatcher(globPattern: string, ignoreCreateEvents?: boolean, ignoreChangeEvents?: boolean, ignoreDeleteEvents?: boolean): FileSystemWatcher;

		/**
J
Johannes Rieken 已提交
3880 3881
		 * The folder that is open in VS Code. `undefined` when no folder
		 * has been opened.
3882
		 *
S
Steve Baker 已提交
3883
		 * @readonly
E
Erich Gamma 已提交
3884
		 */
3885
		export let rootPath: string | undefined;
E
Erich Gamma 已提交
3886 3887

		/**
J
Johannes Rieken 已提交
3888 3889 3890 3891 3892 3893 3894
		 * 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 已提交
3895 3896 3897
		 */
		export function asRelativePath(pathOrUri: string | Uri): string;

J
Johannes Rieken 已提交
3898 3899 3900
		/**
		 * Find files in the workspace.
		 *
3901
		 * @sample `findFiles('**∕*.js', '**∕node_modules∕**', 10)`
J
Johannes Rieken 已提交
3902
		 * @param include A glob pattern that defines the files to search for.
S
Steven Clarke 已提交
3903
		 * @param exclude A glob pattern that defines files and folders to exclude.
J
Johannes Rieken 已提交
3904
		 * @param maxResults An upper-bound for the result.
3905
		 * @param token A token that can be used to signal cancellation to the underlying search engine.
J
Johannes Rieken 已提交
3906 3907
		 * @return A thenable that resolves to an array of resource identifiers.
		 */
3908
		export function findFiles(include: string, exclude?: string, maxResults?: number, token?: CancellationToken): Thenable<Uri[]>;
E
Erich Gamma 已提交
3909 3910

		/**
J
Johannes Rieken 已提交
3911 3912 3913
		 * Save all dirty files.
		 *
		 * @param includeUntitled Also save files that have been created during this session.
S
Steven Clarke 已提交
3914
		 * @return A thenable that resolves when the files have been saved.
E
Erich Gamma 已提交
3915 3916 3917 3918
		 */
		export function saveAll(includeUntitled?: boolean): Thenable<boolean>;

		/**
J
Johannes Rieken 已提交
3919 3920 3921
		 * Make changes to one or many resources as defined by the given
		 * [workspace edit](#WorkspaceEdit).
		 *
S
Steven Clarke 已提交
3922 3923 3924
		 * 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 已提交
3925 3926 3927
		 *
		 * @param edit A workspace edit.
		 * @return A thenable that resolves when the edit could be applied.
E
Erich Gamma 已提交
3928 3929 3930 3931 3932
		 */
		export function applyEdit(edit: WorkspaceEdit): Thenable<boolean>;

		/**
		 * All text documents currently known to the system.
J
Johannes Rieken 已提交
3933 3934
		 *
		 * @readonly
E
Erich Gamma 已提交
3935 3936 3937 3938 3939 3940 3941 3942
		 */
		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 已提交
3943
		 *
3944 3945
		 * file: A file on disk, will be rejected if the file does not exist or cannot be loaded, e.g. `file:///Users/frodo/r.ini`.
		 * untitled: A new file that should be saved on disk, e.g. `untitled:c:\frodo\new.js`. The language will be derived from the file name.
J
Johannes Rieken 已提交
3946
		 *
A
Andre Weinand 已提交
3947
		 * Uris with other schemes will make this method return a rejected promise.
E
Erich Gamma 已提交
3948 3949 3950 3951 3952 3953 3954
		 *
		 * @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 已提交
3955 3956 3957
		 * A short-hand for `openTextDocument(Uri.file(fileName))`.
		 *
		 * @see [openTextDocument](#openTextDocument)
A
Andre Weinand 已提交
3958 3959
		 * @param fileName A name of a file on disk.
		 * @return A promise that resolves to a [document](#TextDocument).
E
Erich Gamma 已提交
3960 3961 3962
		 */
		export function openTextDocument(fileName: string): Thenable<TextDocument>;

J
Johannes Rieken 已提交
3963
		/**
3964 3965 3966
		 * Register a text document content provider.
		 *
		 * Only one provider can be registered per scheme.
J
Johannes Rieken 已提交
3967
		 *
3968 3969 3970
		 * @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 已提交
3971 3972 3973
		 */
		export function registerTextDocumentContentProvider(scheme: string, provider: TextDocumentContentProvider): Disposable;

A
Alex Dima 已提交
3974
		/**
J
Johannes Rieken 已提交
3975
		 * An event that is emitted when a [text document](#TextDocument) is opened.
A
Alex Dima 已提交
3976
		 */
E
Erich Gamma 已提交
3977 3978
		export const onDidOpenTextDocument: Event<TextDocument>;

A
Alex Dima 已提交
3979 3980 3981
		/**
		 * An event that is emitted when a [text document](#TextDocument) is disposed.
		 */
E
Erich Gamma 已提交
3982 3983
		export const onDidCloseTextDocument: Event<TextDocument>;

A
Alex Dima 已提交
3984 3985 3986
		/**
		 * An event that is emitted when a [text document](#TextDocument) is changed.
		 */
E
Erich Gamma 已提交
3987 3988
		export const onDidChangeTextDocument: Event<TextDocumentChangeEvent>;

3989 3990
		/**
		 * An event that is emitted when a [text document](#TextDocument) will be saved to disk.
3991
		 *
J
Johannes Rieken 已提交
3992
		 * *Note 1:* Subscribers can delay saving by registering asynchronous work. For the sake of data integrity the editor
3993 3994 3995 3996 3997 3998 3999 4000
		 * might save without firing this event. For instance when shutting down with dirty files.
		 *
		 * *Note 2:* Subscribers are called sequentially and they can [delay](#TextDocumentWillSaveEvent.waitUntil) saving
		 * by registering asynchronous work. Protection against misbehaving listeners is implemented as such:
		 *  * there is an overall time budget that all listeners share and if that is exhausted no further listener is called
		 *  * listeners that take a long time or produce errors frequently will not be called anymore
		 *
		 * The current thresholds are 1.5 seconds as overall time budget and a listener can misbehave 3 times before being ignored.
4001 4002 4003
		 */
		export const onWillSaveTextDocument: Event<TextDocumentWillSaveEvent>;

A
Alex Dima 已提交
4004 4005 4006
		/**
		 * An event that is emitted when a [text document](#TextDocument) is saved to disk.
		 */
E
Erich Gamma 已提交
4007 4008 4009
		export const onDidSaveTextDocument: Event<TextDocument>;

		/**
J
Johannes Rieken 已提交
4010 4011 4012
		 * Get a configuration object.
		 *
		 * When a section-identifier is provided only that part of the configuration
A
Andre Weinand 已提交
4013
		 * is returned. Dots in the section-identifier are interpreted as child-access,
J
Johannes Rieken 已提交
4014
		 * like `{ myExt: { setting: { doIt: true }}}` and `getConfiguration('myExt.setting').get('doIt') === true`.
J
Johannes Rieken 已提交
4015 4016 4017
		 *
		 * @param section A dot-separated identifier.
		 * @return The full workspace configuration or a subset.
E
Erich Gamma 已提交
4018 4019 4020
		 */
		export function getConfiguration(section?: string): WorkspaceConfiguration;

J
Johannes Rieken 已提交
4021 4022 4023
		/**
		 * An event that is emitted when the [configuration](#WorkspaceConfiguration) changed.
		 */
E
Erich Gamma 已提交
4024 4025 4026
		export const onDidChangeConfiguration: Event<void>;
	}

J
Johannes Rieken 已提交
4027
	/**
4028 4029 4030 4031 4032 4033 4034
	 * 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 已提交
4035
	 * The editor provides an API that makes it simple to provide such common features by having all UI and actions already in place and
4036 4037 4038 4039 4040 4041
	 * 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', {
4042 4043 4044
	 * 	provideHover(document, position, token) {
	 * 		return new Hover('I am a hover!');
	 * 	}
4045 4046
	 * });
	 * ```
4047 4048 4049
	 *
	 * 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 已提交
4050
	 * a selector will result in a [score](#languages.match) that is used to determine if and how a provider shall be used. When
4051 4052 4053
	 * 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 已提交
4054
	 */
E
Erich Gamma 已提交
4055 4056 4057 4058 4059 4060 4061 4062 4063
	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 已提交
4064
		 * Compute the match between a document [selector](#DocumentSelector) and a document. Values
S
Steven Clarke 已提交
4065
		 * greater than zero mean the selector matches the document. The more individual matches a selector
4066 4067 4068
		 * and a document have, the higher the score is. These are the abstract rules given a `selector`:
		 *
		 * ```
S
Steven Clarke 已提交
4069
		 * (1) When selector is an array, return the maximum individual result.
4070 4071 4072 4073
		 * (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`.
4074
		 * (3) When selector is a [filter](#DocumentFilter) return the maximum individual score given that each score is `>0`.
4075
		 *	(3.1) When [language](#DocumentFilter.language) is set apply rules from #2, when `0` the total score is `0`.
4076 4077
		 *	(3.2) When [scheme](#DocumentFilter.scheme) is set and equals the [uri](#TextDocument.uri)-scheme score with `10`, else the total score is `0`.
		 *	(3.3) When [pattern](#DocumentFilter.pattern) is set
4078 4079
		 * 		(3.3.1) pattern equals the [uri](#TextDocument.uri)-fsPath score with `10`,
		 *		(3.3.1) if the pattern matches as glob-pattern score with `5`,
4080 4081
		 *		(3.3.1) the total score is `0`
		 * ```
J
Johannes Rieken 已提交
4082 4083 4084
		 *
		 * @param selector A document selector.
		 * @param document A text document.
J
Johannes Rieken 已提交
4085
		 * @return A number `>0` when the selector matches and `0` when the selector does not match.
E
Erich Gamma 已提交
4086 4087 4088 4089
		 */
		export function match(selector: DocumentSelector, document: TextDocument): number;

		/**
S
Steven Clarke 已提交
4090
		 * Create a diagnostics collection.
J
Johannes Rieken 已提交
4091 4092 4093
		 *
		 * @param name The [name](#DiagnosticCollection.name) of the collection.
		 * @return A new diagnostic collection.
E
Erich Gamma 已提交
4094 4095 4096 4097
		 */
		export function createDiagnosticCollection(name?: string): DiagnosticCollection;

		/**
J
Johannes Rieken 已提交
4098 4099 4100
		 * Register a completion provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
4101
		 * by their [score](#languages.match) and groups of equal score are sequentially asked for
J
Johannes Rieken 已提交
4102
		 * completion items. The process stops when one or many providers of a group return a
4103 4104
		 * result. A failing provider (rejected promise or exception) will not fail the whole
		 * operation.
E
Erich Gamma 已提交
4105
		 *
J
Johannes Rieken 已提交
4106 4107 4108 4109 4110 4111 4112 4113
		 * @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 已提交
4114 4115 4116
		 * Register a code action provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
4117 4118
		 * 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 已提交
4119 4120
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
J
Johannes Rieken 已提交
4121
		 * @param provider A code action provider.
J
Johannes Rieken 已提交
4122
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
4123
		 */
J
Johannes Rieken 已提交
4124
		export function registerCodeActionsProvider(selector: DocumentSelector, provider: CodeActionProvider): Disposable;
E
Erich Gamma 已提交
4125 4126

		/**
J
Johannes Rieken 已提交
4127 4128 4129
		 * Register a code lens provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
4130 4131
		 * 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 已提交
4132
		 *
J
Johannes Rieken 已提交
4133 4134 4135
		 * @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 已提交
4136
		 */
J
Johannes Rieken 已提交
4137
		export function registerCodeLensProvider(selector: DocumentSelector, provider: CodeLensProvider): Disposable;
E
Erich Gamma 已提交
4138 4139

		/**
J
Johannes Rieken 已提交
4140 4141 4142
		 * Register a definition provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
4143 4144
		 * 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 已提交
4145
		 *
J
Johannes Rieken 已提交
4146 4147 4148
		 * @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 已提交
4149 4150 4151
		 */
		export function registerDefinitionProvider(selector: DocumentSelector, provider: DefinitionProvider): Disposable;

4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163
		/**
		 * Register an type definition provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
		 * by their [score](#languages.match) and the best-matching provider is used.
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider An implementation provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerTypeDefinitionProvider(selector: DocumentSelector, provider: TypeDefinitionProvider): Disposable;

E
Erich Gamma 已提交
4164
		/**
J
Johannes Rieken 已提交
4165 4166 4167
		 * Register a hover provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
4168 4169
		 * 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 已提交
4170
		 *
J
Johannes Rieken 已提交
4171 4172 4173
		 * @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 已提交
4174 4175 4176 4177
		 */
		export function registerHoverProvider(selector: DocumentSelector, provider: HoverProvider): Disposable;

		/**
J
Johannes Rieken 已提交
4178 4179 4180 4181
		 * 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.
4182
		 * The process stops when a provider returns a `non-falsy` or `non-failure` result.
E
Erich Gamma 已提交
4183
		 *
J
Johannes Rieken 已提交
4184 4185 4186
		 * @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 已提交
4187 4188 4189 4190
		 */
		export function registerDocumentHighlightProvider(selector: DocumentSelector, provider: DocumentHighlightProvider): Disposable;

		/**
J
Johannes Rieken 已提交
4191 4192 4193
		 * Register a document symbol provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
4194 4195
		 * 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 已提交
4196
		 *
J
Johannes Rieken 已提交
4197 4198 4199
		 * @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 已提交
4200 4201 4202 4203
		 */
		export function registerDocumentSymbolProvider(selector: DocumentSelector, provider: DocumentSymbolProvider): Disposable;

		/**
J
Johannes Rieken 已提交
4204 4205
		 * Register a workspace symbol provider.
		 *
4206 4207 4208
		 * Multiple providers can be registered. In that case providers are asked in parallel and
		 * the results are merged. A failing provider (rejected promise or exception) will not cause
		 * a failure of the whole operation.
E
Erich Gamma 已提交
4209
		 *
J
Johannes Rieken 已提交
4210 4211
		 * @param provider A workspace symbol provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
4212 4213 4214 4215
		 */
		export function registerWorkspaceSymbolProvider(provider: WorkspaceSymbolProvider): Disposable;

		/**
J
Johannes Rieken 已提交
4216 4217 4218
		 * Register a reference provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
4219 4220
		 * 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 已提交
4221
		 *
J
Johannes Rieken 已提交
4222 4223 4224
		 * @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 已提交
4225 4226 4227 4228
		 */
		export function registerReferenceProvider(selector: DocumentSelector, provider: ReferenceProvider): Disposable;

		/**
J
Johannes Rieken 已提交
4229 4230 4231
		 * Register a reference provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
4232
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
4233
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
4234
		 *
J
Johannes Rieken 已提交
4235 4236 4237
		 * @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 已提交
4238 4239 4240 4241
		 */
		export function registerRenameProvider(selector: DocumentSelector, provider: RenameProvider): Disposable;

		/**
A
Andre Weinand 已提交
4242
		 * Register a formatting provider for a document.
J
Johannes Rieken 已提交
4243 4244
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
4245
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
4246
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
4247
		 *
J
Johannes Rieken 已提交
4248 4249 4250
		 * @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 已提交
4251 4252 4253 4254
		 */
		export function registerDocumentFormattingEditProvider(selector: DocumentSelector, provider: DocumentFormattingEditProvider): Disposable;

		/**
J
Johannes Rieken 已提交
4255 4256
		 * Register a formatting provider for a document range.
		 *
4257 4258 4259 4260
		 * *Note:* A document range provider is also a [document formatter](#DocumentFormattingEditProvider)
		 * which means there is no need to [register](registerDocumentFormattingEditProvider) a document
		 * formatter when also registering a range provider.
		 *
J
Johannes Rieken 已提交
4261
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
4262
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
4263
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
4264
		 *
J
Johannes Rieken 已提交
4265 4266 4267
		 * @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 已提交
4268 4269 4270 4271
		 */
		export function registerDocumentRangeFormattingEditProvider(selector: DocumentSelector, provider: DocumentRangeFormattingEditProvider): Disposable;

		/**
E
Erich Gamma 已提交
4272
		 * Register a formatting provider that works on type. The provider is active when the user enables the setting `editor.formatOnType`.
J
Johannes Rieken 已提交
4273 4274
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
J
Johannes Rieken 已提交
4275
		 * by their [score](#languages.match) and the best-matching provider is used. Failure
4276
		 * of the selected provider will cause a failure of the whole operation.
E
Erich Gamma 已提交
4277
		 *
J
Johannes Rieken 已提交
4278 4279 4280
		 * @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 已提交
4281
		 * @param moreTriggerCharacter More trigger characters.
J
Johannes Rieken 已提交
4282
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
4283 4284 4285 4286
		 */
		export function registerOnTypeFormattingEditProvider(selector: DocumentSelector, provider: OnTypeFormattingEditProvider, firstTriggerCharacter: string, ...moreTriggerCharacter: string[]): Disposable;

		/**
J
Johannes Rieken 已提交
4287 4288 4289
		 * Register a signature help provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are sorted
4290 4291
		 * by their [score](#languages.match) and called sequentially until a provider returns a
		 * valid result.
E
Erich Gamma 已提交
4292
		 *
J
Johannes Rieken 已提交
4293 4294 4295 4296
		 * @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 已提交
4297 4298 4299
		 */
		export function registerSignatureHelpProvider(selector: DocumentSelector, provider: SignatureHelpProvider, ...triggerCharacters: string[]): Disposable;

J
Johannes Rieken 已提交
4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312
		/**
		 * Register a document link provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
		 * parallel and the results are merged. A failing provider (rejected promise or exception) will
		 * not cause a failure of the whole operation.
		 *
		 * @param selector A selector that defines the documents this provider is applicable to.
		 * @param provider A document link provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
		 */
		export function registerDocumentLinkProvider(selector: DocumentSelector, provider: DocumentLinkProvider): Disposable;

E
Erich Gamma 已提交
4313
		/**
J
Johannes Rieken 已提交
4314
		 * Set a [language configuration](#LanguageConfiguration) for a language.
E
Erich Gamma 已提交
4315
		 *
A
Andre Weinand 已提交
4316
		 * @param language A language identifier like `typescript`.
J
Johannes Rieken 已提交
4317 4318
		 * @param configuration Language configuration.
		 * @return A [disposable](#Disposable) that unsets this configuration.
E
Erich Gamma 已提交
4319 4320 4321 4322
		 */
		export function setLanguageConfiguration(language: string, configuration: LanguageConfiguration): Disposable;
	}

J
Johannes Rieken 已提交
4323
	/**
4324 4325 4326
	 * Namespace for dealing with installed extensions. Extensions are represented
	 * by an [extension](#Extension)-interface which allows to reflect on them.
	 *
S
Steven Clarke 已提交
4327
	 * Extension writers can provide APIs to other extensions by returning their API public
4328 4329 4330 4331
	 * surface from the `activate`-call.
	 *
	 * ```javascript
	 * export function activate(context: vscode.ExtensionContext) {
4332 4333 4334 4335 4336 4337 4338 4339 4340 4341
	 * 	let api = {
	 * 		sum(a, b) {
	 * 			return a + b;
	 * 		},
	 * 		mul(a, b) {
	 * 			return a * b;
	 * 		}
	 * 	};
	 * 	// 'export' public api-surface
	 * 	return api;
4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353
	 * }
	 * ```
	 * 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 已提交
4354
	 */
E
Erich Gamma 已提交
4355 4356
	export namespace extensions {

J
Johannes Rieken 已提交
4357
		/**
4358
		 * Get an extension by its full identifier in the form of: `publisher.name`.
J
Johannes Rieken 已提交
4359
		 *
J
Johannes Rieken 已提交
4360
		 * @param extensionId An extension identifier.
J
Johannes Rieken 已提交
4361 4362
		 * @return An extension or `undefined`.
		 */
4363
		export function getExtension(extensionId: string): Extension<any> | undefined;
E
Erich Gamma 已提交
4364

J
Johannes Rieken 已提交
4365
		/**
A
Andre Weinand 已提交
4366
		 * Get an extension its full identifier in the form of: `publisher.name`.
J
Johannes Rieken 已提交
4367 4368 4369
		 *
		 * @param extensionId An extension identifier.
		 * @return An extension or `undefined`.
J
Johannes Rieken 已提交
4370
		 */
4371
		export function getExtension<T>(extensionId: string): Extension<T> | undefined;
E
Erich Gamma 已提交
4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383

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

/**
 * Thenable is a common denominator between ES6 promises, Q, jquery.Deferred, WinJS.Promise,
 * and others. This API makes no assumption about what promise libary is being used which
 * enables reusing existing code without migrating to a specific promise implementation. Still,
A
Andre Weinand 已提交
4384
 * we recommend the use of native promises which are available in VS Code.
E
Erich Gamma 已提交
4385
 */
4386
interface Thenable<T> {
E
Erich Gamma 已提交
4387 4388 4389 4390 4391 4392
	/**
	* 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.
	*/
4393 4394
	then<TResult>(onfulfilled?: (value: T) => TResult | Thenable<TResult>, onrejected?: (reason: any) => TResult | Thenable<TResult>): Thenable<TResult>;
	then<TResult>(onfulfilled?: (value: T) => TResult | Thenable<TResult>, onrejected?: (reason: any) => void): Thenable<TResult>;
E
Erich Gamma 已提交
4395
}