vscode.d.ts 141.1 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
		/**
J
Joel Day 已提交
940
		 * Enters snippet mode in the editor with the specified snippet.
J
Joel Day 已提交
941
		 *
942
		 * @param snippet The snippet to insert in this edit.
J
Joel Day 已提交
943
		 * @param options The undo/redo behaviour around this edit. By default, undo stops will be created before and after this edit.
J
Joel Day 已提交
944
		 */
945
		edit(snippet: SnippetString, options?: { undoStopBefore: boolean; undoStopAfter: boolean; }): void;
J
Joel Day 已提交
946

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

E
Erich Gamma 已提交
1116
		/**
1117 1118 1119
		 * 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 已提交
1120
		 *
1121 1122 1123
		 * @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 已提交
1124
		 */
1125
		toString(skipEncoding?: boolean): string;
E
Erich Gamma 已提交
1126

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

		/**
		 * A human readable string which is rendered less prominent.
		 */
		detail?: string;
E
Erich Gamma 已提交
1351 1352 1353
	}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1435
		/**
P
Pine 已提交
1436
		 * An optional function that will be called to validate input and to give a hint
1437 1438 1439 1440 1441 1442
		 * 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.
		 */
1443
		validateInput?(value: string): string | undefined | null;
E
Erich Gamma 已提交
1444 1445 1446 1447
	}

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

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

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

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

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

1481 1482 1483 1484 1485 1486 1487 1488 1489 1490

	/**
	 * 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
1491 1492 1493 1494 1495
	 * let a: HoverProvider = {
	 * 	provideHover(doc, pos, token): ProviderResult<Hover> {
	 * 		return new Hover('Hello World');
	 * 	}
	 * }
1496
	 *
1497 1498 1499 1500 1501 1502 1503
	 * let b: HoverProvider = {
	 * 	provideHover(doc, pos, token): ProviderResult<Hover> {
	 * 		return new Promise(resolve => {
	 * 			resolve(new Hover('Hello World'));
	 * 	 	});
	 * 	}
	 * }
1504
	 *
1505 1506 1507 1508 1509 1510
	 * let c: HoverProvider = {
	 * 	provideHover(doc, pos, token): ProviderResult<Hover> {
	 * 		return; // undefined
	 * 	}
	 * }
	 * ```
1511 1512 1513
	 */
	export type ProviderResult<T> = T | undefined | null | Thenable<T | undefined | null>

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

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

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

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

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

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

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

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

		/**
		 * 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 已提交
1581 1582 1583 1584 1585 1586 1587 1588
	}

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

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

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

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

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

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

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

1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660
	/**
	 * 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 已提交
1661
	/**
J
Johannes Rieken 已提交
1662 1663 1664
	 * 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 已提交
1665 1666 1667
	 */
	export type MarkedString = string | { language: string; value: string };

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

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

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

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

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

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

J
Johannes Rieken 已提交
1715 1716 1717
	/**
	 * A document highlight kind.
	 */
E
Erich Gamma 已提交
1718
	export enum DocumentHighlightKind {
J
Johannes Rieken 已提交
1719 1720

		/**
A
Andre Weinand 已提交
1721
		 * A textual occurrence.
J
Johannes Rieken 已提交
1722
		 */
1723
		Text = 0,
J
Johannes Rieken 已提交
1724 1725 1726 1727

		/**
		 * Read-access of a symbol, like reading a variable.
		 */
1728
		Read = 1,
J
Johannes Rieken 已提交
1729 1730 1731 1732

		/**
		 * Write-access of a symbol, like writing to a variable.
		 */
1733
		Write = 2
E
Erich Gamma 已提交
1734 1735
	}

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

		/**
		 * The range this highlight applies to.
		 */
E
Erich Gamma 已提交
1746
		range: Range;
J
Johannes Rieken 已提交
1747 1748 1749 1750

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

		/**
		 * 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 已提交
1760 1761
	}

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

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

J
Johannes Rieken 已提交
1781 1782 1783
	/**
	 * A symbol kind.
	 */
E
Erich Gamma 已提交
1784
	export enum SymbolKind {
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805
		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 已提交
1806 1807
	}

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

		/**
		 * The name of this symbol.
		 */
E
Erich Gamma 已提交
1817
		name: string;
J
Johannes Rieken 已提交
1818 1819 1820 1821

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

		/**
		 * The kind of this symbol.
		 */
E
Erich Gamma 已提交
1827
		kind: SymbolKind;
J
Johannes Rieken 已提交
1828 1829 1830 1831

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

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

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

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

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

		/**
		 * Project-wide search for a symbol matching the given query string. It is up to the provider
1883 1884 1885
		 * 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 已提交
1886 1887 1888 1889
		 *
		 * @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 已提交
1890
		 * signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
1891
		 */
1892
		provideWorkspaceSymbols(query: string, token: CancellationToken): ProviderResult<SymbolInformation[]>;
1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905

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

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

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

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

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

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

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

		/**
		 * The range this edit applies to.
		 */
E
Erich Gamma 已提交
1975
		range: Range;
J
Johannes Rieken 已提交
1976 1977 1978 1979

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

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

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

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

J
Johannes Rieken 已提交
2001 2002 2003 2004 2005 2006 2007 2008
		/**
		 * 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 已提交
2009

J
Johannes Rieken 已提交
2010 2011 2012 2013 2014 2015 2016 2017
		/**
		 * 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 已提交
2018

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

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

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

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

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

2058 2059 2060 2061 2062 2063
	/**
	 * 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
2064 2065 2066
	 * 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).
2067 2068 2069 2070 2071 2072 2073 2074
	 */
	export class SnippetString {

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

2075 2076 2077 2078 2079 2080 2081
		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.
2082
		 * @return This snippet string.
2083 2084 2085 2086 2087 2088 2089 2090 2091
		 */
		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.
2092
		 * @return This snippet string.
2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103
		 */
		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.
2104
		 * @return This snippet string.
2105 2106
		 */
		appendPlaceholder(value: string | ((snippet: SnippetString) => any), number?: number): SnippetString;
2107 2108

		/**
J
Johannes Rieken 已提交
2109
		 * Builder-function that appends a variable (`${VAR}`) to
2110 2111 2112 2113 2114 2115 2116 2117
		 * 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;
2118 2119
	}

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

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

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

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

		/**
		 * Prefer spaces over tabs.
		 */
E
Erich Gamma 已提交
2153
		insertSpaces: boolean;
J
Johannes Rieken 已提交
2154 2155 2156 2157 2158

		/**
		 * Signature for further properties.
		 */
		[key: string]: boolean | number | string;
E
Erich Gamma 已提交
2159 2160 2161
	}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

		/**
		 * One or more signatures.
		 */
E
Erich Gamma 已提交
2296
		signatures: SignatureInformation[];
J
Johannes Rieken 已提交
2297 2298 2299 2300

		/**
		 * The active signature.
		 */
E
Erich Gamma 已提交
2301
		activeSignature: number;
J
Johannes Rieken 已提交
2302 2303 2304 2305

		/**
		 * The active parameter of the active signature.
		 */
E
Erich Gamma 已提交
2306 2307 2308
		activeParameter: number;
	}

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

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

J
Johannes Rieken 已提交
2327 2328 2329
	/**
	 * Completion item kinds.
	 */
E
Erich Gamma 已提交
2330
	export enum CompletionItemKind {
2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347
		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,
2348 2349
		Reference = 17,
		Folder = 18
E
Erich Gamma 已提交
2350 2351
	}

J
Johannes Rieken 已提交
2352
	/**
2353
	 * A completion item represents a text snippet that is proposed to complete text that is being typed.
J
Johannes Rieken 已提交
2354
	 *
2355 2356 2357 2358
	 * 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.
2359
	 *
2360 2361 2362
	 * 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.
2363
	 *
J
Johannes Rieken 已提交
2364 2365
	 * @see [CompletionItemProvider.provideCompletionItems](#CompletionItemProvider.provideCompletionItems)
	 * @see [CompletionItemProvider.resolveCompletionItem](#CompletionItemProvider.resolveCompletionItem)
J
Johannes Rieken 已提交
2366
	 */
E
Erich Gamma 已提交
2367
	export class CompletionItem {
J
Johannes Rieken 已提交
2368 2369 2370

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

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

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

		/**
		 * A human-readable string that represents a doc-comment.
		 */
2391
		documentation?: string;
J
Johannes Rieken 已提交
2392 2393

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

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

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

		/**
		 * 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).
		 */
2423
		range?: Range;
J
Johannes Rieken 已提交
2424

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

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

2444 2445 2446 2447 2448
		/**
		 * 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.
		 */
2449
		additionalTextEdits?: TextEdit[];
2450 2451

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

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

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

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

		/**
		 * 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 已提交
2496 2497
	/**
	 * The completion item provider interface defines the contract between extensions and
2498
	 * [IntelliSense](https://code.visualstudio.com/docs/editor/editingevolved#_intellisense).
J
Johannes Rieken 已提交
2499 2500 2501 2502
	 *
	 * 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 已提交
2503
	 * [provideCompletionItems](#CompletionItemProvider.provideCompletionItems)-function. Subsequently,
S
Steven Clarke 已提交
2504
	 * when a completion item is shown in the UI and gains focus this provider is asked to resolve
J
Johannes Rieken 已提交
2505
	 * the item, like adding [doc-comment](#CompletionItem.documentation) or [details](#CompletionItem.detail).
2506 2507 2508
	 *
	 * 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 已提交
2509
	 */
E
Erich Gamma 已提交
2510
	export interface CompletionItemProvider {
J
Johannes Rieken 已提交
2511 2512

		/**
J
Johannes Rieken 已提交
2513
		 * Provide completion items for the given position and document.
J
Johannes Rieken 已提交
2514
		 *
J
Johannes Rieken 已提交
2515 2516 2517
		 * @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.
2518 2519
		 * @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 已提交
2520
		 */
2521
		provideCompletionItems(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<CompletionItem[] | CompletionList>;
J
Johannes Rieken 已提交
2522 2523

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

J
Johannes Rieken 已提交
2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551

	/**
	 * 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.
		 */
2552
		target?: Uri;
J
Johannes Rieken 已提交
2553 2554 2555 2556 2557 2558 2559

		/**
		 * 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.
		 */
2560
		constructor(range: Range, target?: Uri);
J
Johannes Rieken 已提交
2561 2562 2563 2564 2565 2566 2567 2568 2569
	}

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

		/**
2570 2571 2572
		 * 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 已提交
2573 2574 2575
		 * @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
2576
		 * can be signaled by returning `undefined`, `null`, or an empty array.
J
Johannes Rieken 已提交
2577
		 */
2578
		provideDocumentLinks(document: TextDocument, token: CancellationToken): ProviderResult<DocumentLink[]>;
2579 2580 2581 2582 2583 2584 2585 2586 2587 2588

		/**
		 * 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.
		 */
2589
		resolveDocumentLink?(link: DocumentLink, token: CancellationToken): ProviderResult<DocumentLink>;
J
Johannes Rieken 已提交
2590 2591
	}

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

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

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

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

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

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

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

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

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

		/**
A
Alex Dima 已提交
2728
		 * **Deprecated** Do not use.
J
Johannes Rieken 已提交
2729 2730
		 *
		 * @deprecated Will be replaced by a better API soon.
E
Erich Gamma 已提交
2731 2732
		 */
		__electricCharacterSupport?: {
2733 2734 2735 2736 2737 2738
			/**
			 * This property is deprecated and will be **ignored** from
			 * the editor.
			 * @deprecated
			 */
			brackets?: any;
2739 2740 2741 2742 2743 2744
			/**
			 * 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 已提交
2745
			docComment?: {
A
Alex Dima 已提交
2746 2747 2748 2749
				scope: string;
				open: string;
				lineStart: string;
				close?: string;
E
Erich Gamma 已提交
2750 2751 2752 2753
			};
		};

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

J
Johannes Rieken 已提交
2767
	/**
2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778
	 * 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`:
	 *
2779
	 * ```ts
D
Daniel Imms 已提交
2780 2781
	 * // launch.json configuration
	 * const config = workspace.getConfiguration('launch');
2782 2783
	 *
	 * // retrieve values
D
Daniel Imms 已提交
2784 2785
	 * const values = config.get('configurations');
	 * ```
J
Johannes Rieken 已提交
2786
	 */
E
Erich Gamma 已提交
2787 2788
	export interface WorkspaceConfiguration {

2789 2790 2791 2792 2793 2794 2795 2796
		/**
		 * 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 已提交
2797
		/**
J
Johannes Rieken 已提交
2798 2799 2800
		 * Return a value from this configuration.
		 *
		 * @param section Configuration name, supports _dotted_ names.
J
Johannes Rieken 已提交
2801
		 * @param defaultValue A value should be returned when no value could be found, is `undefined`.
J
Johannes Rieken 已提交
2802
		 * @return The value `section` denotes or the default.
E
Erich Gamma 已提交
2803
		 */
2804 2805
		get<T>(section: string, defaultValue: T): T;

E
Erich Gamma 已提交
2806 2807

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

2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827
		/**
		 * 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`.
		 */
2828
		inspect<T>(section: string): { key: string; defaultValue?: T; globalValue?: T; workspaceValue?: T } | undefined;
2829

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

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

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

		/**
		 * The resource identifier of this location.
		 */
J
Johannes Rieken 已提交
2862
		uri: Uri;
J
Johannes Rieken 已提交
2863 2864 2865 2866

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

		/**
		 * 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 已提交
2876 2877
	}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

		/**
2976
		 * Replace all entries in this collection.
J
Johannes Rieken 已提交
2977
		 *
2978 2979 2980 2981 2982 2983
		 * 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 已提交
2984
		 */
2985
		set(entries: [Uri, Diagnostic[] | undefined][]): void;
E
Erich Gamma 已提交
2986 2987

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

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

3001 3002 3003 3004 3005 3006 3007 3008
		/**
		 * 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;

3009 3010 3011 3012 3013 3014 3015
		/**
		 * 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`.
		 */
3016
		get(uri: Uri): Diagnostic[] | undefined;
3017 3018 3019 3020 3021 3022 3023 3024 3025 3026

		/**
		 * 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 已提交
3027 3028 3029 3030
		/**
		 * Dispose and free associated resources. Calls
		 * [clear](#DiagnosticCollection.clear).
		 */
E
Erich Gamma 已提交
3031 3032 3033
		dispose(): void;
	}

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

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

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

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

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

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

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

3084 3085 3086
		/**
		 * Reveal this channel in the UI.
		 *
J
Johannes Rieken 已提交
3087 3088 3089 3090
		 * @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.
3091 3092
		 * @param preserveFocus When `true` the channel will not take focus.
		 */
J
Johannes Rieken 已提交
3093
		show(column?: ViewColumn, preserveFocus?: boolean): void;
3094

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

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

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

		/**
		 * Aligned to the left side.
		 */
3114
		Left = 1,
J
Johannes Rieken 已提交
3115 3116 3117 3118

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

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

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

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

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

		/**
J
Johannes Rieken 已提交
3155 3156
		 * The foreground color for this entry.
		 */
E
Erich Gamma 已提交
3157 3158 3159
		color: string;

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

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

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

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

D
Daniel Imms 已提交
3182 3183 3184
	/**
	 * An individual terminal instance within the integrated terminal.
	 */
D
Daniel Imms 已提交
3185
	export interface Terminal {
D
Daniel Imms 已提交
3186

3187 3188 3189
		/**
		 * The name of the terminal.
		 */
Y
Yuki Ueda 已提交
3190
		readonly name: string;
3191

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

D
Daniel Imms 已提交
3197
		/**
D
Daniel Imms 已提交
3198
		 * Send text to the terminal. The text is written to the stdin of the underlying pty process
3199
		 * (shell) of the terminal.
D
Daniel Imms 已提交
3200
		 *
D
Daniel Imms 已提交
3201
		 * @param text The text to send.
D
Daniel Imms 已提交
3202
		 * @param addNewLine Whether to add a new line to the text being sent, this is normally
3203 3204
		 * 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 已提交
3205
		 */
3206
		sendText(text: string, addNewLine?: boolean): void;
D
Daniel Imms 已提交
3207 3208

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

		/**
J
Johannes Rieken 已提交
3308 3309 3310
		 * 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 已提交
3311
		 *
3312 3313
		 * Use [`workspaceState`](#ExtensionContext.workspaceState) or
		 * [`globalState`](#ExtensionContext.globalState) to store key value data.
D
Dirk Baeumer 已提交
3314
		 */
3315
		storagePath: string | undefined;
E
Erich Gamma 已提交
3316 3317 3318 3319 3320 3321 3322 3323
	}

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

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

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

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

3351 3352 3353 3354 3355
	/**
	 * Namespace describing the environment the editor runs in.
	 */
	export namespace env {

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

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

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

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

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

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

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

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

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

	/**
3481 3482 3483
	 * 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 已提交
3484 3485 3486 3487
	 */
	export namespace window {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

D
Daniel Imms 已提交
3698
		/**
3699 3700
		 * 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 已提交
3701
		 *
3702
		 * @param name Optional human-readable string which will be used to represent the terminal in the UI.
3703
		 * @param shellPath Optional path to a custom shell executable to be used in the terminal.
D
Daniel Imms 已提交
3704
		 * @param shellArgs Optional args for the custom shell executable, this does not work on Windows (see #8429)
D
Daniel Imms 已提交
3705 3706
		 * @return A new Terminal.
		 */
P
Pine Wu 已提交
3707
		export function createTerminal(name?: string, shellPath?: string, shellArgs?: string[]): Terminal;
3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741

		/**
		 * 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 已提交
3742 3743 3744
	}

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

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

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

3778 3779 3780 3781 3782 3783
	/**
	 * Represents reasons why a text document is saved.
	 */
	export enum TextDocumentSaveReason {

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

		/**
		 * Automatic after a delay.
		 */
3792
		AfterDelay = 2,
3793 3794 3795 3796 3797 3798 3799

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

3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811
	/**
	 * 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.
		 */
3812
		document: TextDocument;
3813

3814 3815 3816 3817 3818
		/**
		 * The reason why save was triggered.
		 */
		reason: TextDocumentSaveReason;

3819 3820 3821 3822 3823 3824 3825 3826 3827 3828
		/**
		 * 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 => {
3829 3830 3831 3832 3833
		 * 	// async, will *throw* an error
		 * 	setTimeout(() => event.waitUntil(promise));
		 *
		 * 	// sync, OK
		 * 	event.waitUntil(promise);
3834 3835 3836 3837 3838
		 * })
		 * ```
		 *
		 * @param thenable A thenable that resolves to [pre-save-edits](#TextEdit).
		 */
3839
		waitUntil(thenable: Thenable<TextEdit[]>): void;
3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850

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

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

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

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

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

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

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

		/**
		 * All text documents currently known to the system.
J
Johannes Rieken 已提交
3930 3931
		 *
		 * @readonly
E
Erich Gamma 已提交
3932 3933 3934 3935 3936 3937 3938 3939
		 */
		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 已提交
3940
		 *
3941 3942
		 * 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 已提交
3943
		 *
A
Andre Weinand 已提交
3944
		 * Uris with other schemes will make this method return a rejected promise.
E
Erich Gamma 已提交
3945 3946 3947 3948 3949 3950 3951
		 *
		 * @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 已提交
3952 3953 3954
		 * A short-hand for `openTextDocument(Uri.file(fileName))`.
		 *
		 * @see [openTextDocument](#openTextDocument)
A
Andre Weinand 已提交
3955 3956
		 * @param fileName A name of a file on disk.
		 * @return A promise that resolves to a [document](#TextDocument).
E
Erich Gamma 已提交
3957 3958 3959
		 */
		export function openTextDocument(fileName: string): Thenable<TextDocument>;

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

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

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

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

3986 3987
		/**
		 * An event that is emitted when a [text document](#TextDocument) will be saved to disk.
3988
		 *
J
Johannes Rieken 已提交
3989
		 * *Note 1:* Subscribers can delay saving by registering asynchronous work. For the sake of data integrity the editor
3990 3991 3992 3993 3994 3995 3996 3997
		 * 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.
3998 3999 4000
		 */
		export const onWillSaveTextDocument: Event<TextDocumentWillSaveEvent>;

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

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

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

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

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

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

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

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

4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160
		/**
		 * 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 已提交
4161
		/**
J
Johannes Rieken 已提交
4162 4163 4164
		 * Register a hover provider.
		 *
		 * Multiple providers can be registered for a language. In that case providers are asked in
4165 4166
		 * 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 已提交
4167
		 *
J
Johannes Rieken 已提交
4168 4169 4170
		 * @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 已提交
4171 4172 4173 4174
		 */
		export function registerHoverProvider(selector: DocumentSelector, provider: HoverProvider): Disposable;

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

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

		/**
J
Johannes Rieken 已提交
4201 4202
		 * Register a workspace symbol provider.
		 *
4203 4204 4205
		 * 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 已提交
4206
		 *
J
Johannes Rieken 已提交
4207 4208
		 * @param provider A workspace symbol provider.
		 * @return A [disposable](#Disposable) that unregisters this provider when being disposed.
E
Erich Gamma 已提交
4209 4210 4211 4212
		 */
		export function registerWorkspaceSymbolProvider(provider: WorkspaceSymbolProvider): Disposable;

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

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

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

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

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

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

J
Johannes Rieken 已提交
4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309
		/**
		 * 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 已提交
4310
		/**
J
Johannes Rieken 已提交
4311
		 * Set a [language configuration](#LanguageConfiguration) for a language.
E
Erich Gamma 已提交
4312
		 *
A
Andre Weinand 已提交
4313
		 * @param language A language identifier like `typescript`.
J
Johannes Rieken 已提交
4314 4315
		 * @param configuration Language configuration.
		 * @return A [disposable](#Disposable) that unsets this configuration.
E
Erich Gamma 已提交
4316 4317 4318 4319
		 */
		export function setLanguageConfiguration(language: string, configuration: LanguageConfiguration): Disposable;
	}

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

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

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

		/**
		 * 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 已提交
4381
 * we recommend the use of native promises which are available in VS Code.
E
Erich Gamma 已提交
4382
 */
4383
interface Thenable<T> {
E
Erich Gamma 已提交
4384 4385 4386 4387 4388 4389
	/**
	* 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.
	*/
4390 4391
	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 已提交
4392
}