/**

* Title of the command, like `save`.

*/

title: string;

/**

* The identifier of the actual command handler.

* @see [commands.registerCommand](#commands.registerCommand).

*/

command: string;

/**

* A tooltip for for command, when represented in the UI.

*/

tooltip?: string;

/**

* Arguments that the command handler should be

* invoked with.

*/

arguments?: any[];

/**

* The zero-based line number.

*/

readonly lineNumber: number;

/**

* The text of this line without the line separator characters.

*/

readonly text: string;

/**

* The range this line covers without the line separator characters.

*/

readonly range: Range;

/**

* The range this line covers with the line separator characters.

*/

readonly rangeIncludingLineBreak: Range;

/**

* The offset of the first character which is not a whitespace character as defined

* by `/\s/`. **Note** that if a line is all whitespaces the length of the line is returned.

*/

readonly firstNonWhitespaceCharacterIndex: number;

/**

* Whether this line is whitespace only, shorthand

* for [TextLine.firstNonWhitespaceCharacterIndex](#TextLine.firstNonWhitespaceCharacterIndex) === [TextLine.text.length](#TextLine.text).

*/

readonly isEmptyOrWhitespace: boolean;

/**

* The associated uri for this document.

*

* *Note* that most documents use the `file`-scheme, which means they are files on disk. However, **not** all documents are

* saved on disk and therefore the `scheme` must be checked before trying to access the underlying file or siblings on disk.

*

* @see [FileSystemProvider](#FileSystemProvider)

* @see [TextDocumentContentProvider](#TextDocumentContentProvider)

*/

readonly uri: Uri;

/**

* The file system path of the associated resource. Shorthand

* notation for [TextDocument.uri.fsPath](#TextDocument.uri). Independent of the uri scheme.

*/

readonly fileName: string;

/**

* Is this document representing an untitled file which has never been saved yet. *Note* that

* this does not mean the document will be saved to disk, use [`uri.scheme`](#Uri.scheme)

* to figure out where a document will be [saved](#FileSystemProvider), e.g. `file`, `ftp` etc.

*/

readonly isUntitled: boolean;

/**

* The identifier of the language associated with this document.

*/

readonly languageId: string;

/**

* The version number of this document (it will strictly increase after each

* change, including undo/redo).

*/

readonly version: number;

/**

* `true` if there are unpersisted changes.

*/

readonly isDirty: boolean;

/**

* `true` if the document have been closed. A closed document isn't synchronized anymore

* and won't be re-used when the same resource is opened again.

*/

readonly isClosed: boolean;

/**

* Save the underlying file.

*

* @return A promise that will resolve to true when the file

* has been saved. If the file was not dirty or the save failed,

* will return false.

*/

save(): Thenable<boolean>;

/**

* The [end of line](#EndOfLine) sequence that is predominately

* used in this document.

*/

readonly eol: EndOfLine;

/**

* The number of lines in this document.

*/

readonly lineCount: number;

/**

* Returns a text line denoted by the line number. Note

* that the returned object is *not* live and changes to the

* document are not reflected.

*

* @param line A line number in [0, lineCount).

* @return A [line](#TextLine).

*/

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.

*

* The position will be [adjusted](#TextDocument.validatePosition).

*

* @see [TextDocument.lineAt](#TextDocument.lineAt)

* @param position A position.

* @return A [line](#TextLine).

*/

lineAt(position: Position): TextLine;

/**

* Converts the position to a zero-based offset.

*

* The position will be [adjusted](#TextDocument.validatePosition).

*

* @param position A position.

* @return A valid zero-based offset.

*/

offsetAt(position: Position): number;

/**

* Converts a zero-based offset to a position.

*

* @param offset A zero-based offset.

* @return A valid [position](#Position).

*/

positionAt(offset: number): Position;

/**

* 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.

* @return The text inside the provided range or the entire text.

*/

getText(range?: Range): string;

/**

* Get a word-range at the given position. By default words are defined by

* common separators, like space, -, _, etc. In addition, per language custom

* [word definitions](#LanguageConfiguration.wordPattern) can be defined. It

* is also possible to provide a custom regular expression.

*

* * *Note 1:* A custom regular expression must not match the empty string and

* if it does, it will be ignored.

* * *Note 2:* A custom regular expression will fail to match multiline strings

* and in the name of speed regular expressions should not match words with

* spaces. Use [`TextLine.text`](#TextLine.text) for more complex, non-wordy, scenarios.

*

* The position will be [adjusted](#TextDocument.validatePosition).

*

* @param position A position.

* @param regex Optional regular expression that describes what a word is.

* @return A range spanning a word, or `undefined`.

*/

getWordRangeAtPosition(position: Position, regex?: RegExp): Range | undefined;

/**

* Ensure a range is completely contained in this document.

*

* @param range A range.

* @return The given range or a new, adjusted range.

*/

validateRange(range: Range): Range;

/**

* Ensure a position is contained in the range of this document.

*

* @param position A position.

* @return The given position or a new, adjusted position.

*/

validatePosition(position: Position): Position;

/**

* The zero-based line value.

*/

readonly line: number;

/**

* The zero-based character value.

*/

readonly character: number;

/**

* @param line A zero-based line value.

* @param character A zero-based character value.

*/

constructor(line: number, character: number);

/**

* Check if this position is before `other`.

*

* @param other A position.

* @return `true` if position is on a smaller line

* or on the same line on a smaller character.

*/

isBefore(other: Position): boolean;

/**

* Check if this position is before or equal to `other`.

*

* @param other A position.

* @return `true` if position is on a smaller line

* or on the same line on a smaller or equal character.

*/

isBeforeOrEqual(other: Position): boolean;

/**

* Check if this position is after `other`.

*

* @param other A position.

* @return `true` if position is on a greater line

* or on the same line on a greater character.

*/

isAfter(other: Position): boolean;

/**

* Check if this position is after or equal to `other`.

*

* @param other A position.

* @return `true` if position is on a greater line

* or on the same line on a greater or equal character.

*/

isAfterOrEqual(other: Position): boolean;

/**

* Check if this position is equal to `other`.

*

* @param other A position.

* @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;

/**

* 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

* this and the given position are equal.

*/

compareTo(other: Position): number;

/**

* Create a new position relative to this position.

*

* @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;

/**

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

/**

* Create a new position derived from this position.

*

* @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)

* @return A position where line and character are replaced by the given values.

*/

with(line?: number, character?: number): Position;

/**

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

/**

* The start position. It is before or equal to [end](#Range.end).

*/

readonly start: Position;

/**

* The end position. It is after or equal to [start](#Range.start).

*/

readonly end: Position;

/**

* Create a new range from two positions. If `start` is not

* before or equal to `end`, the values will be swapped.

*

* @param start A position.

* @param end A position.

*/

constructor(start: Position, end: Position);

/**

* Create a new range from number coordinates. It is a shorter equivalent of

* using `new Range(new Position(startLine, startCharacter), new Position(endLine, endCharacter))`

*

* @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.

*/

constructor(startLine: number, startCharacter: number, endLine: number, endCharacter: number);

/**

* `true` if `start` and `end` are equal.

*/

isEmpty: boolean;

/**

* `true` if `start.line` and `end.line` are equal.

*/

isSingleLine: boolean;

/**

* Check if a position or a range is contained in this range.

*

* @param positionOrRange A position or a range.

* @return `true` if the position or range is inside or equal

* to this range.

*/

contains(positionOrRange: Position | Range): boolean;

/**

* Check if `other` equals this range.

*

* @param other A range.

* @return `true` when start and end are [equal](#Position.isEqual) to

* start and end of this range.

*/

isEqual(other: Range): boolean;

/**

* Intersect `range` with this range and returns a new range or `undefined`

* if the ranges have no overlap.

*

* @param range A range.

* @return A range of the greater start and smaller end positions. Will

* return undefined when there is no overlap.

*/

intersection(range: Range): Range | undefined;

/**

* Compute the union of `other` with this range.

*

* @param other A range.

* @return A range of smaller start position and the greater end position.

*/

union(other: Range): Range;

/**

* Derived a new range from this range.

*

* @param start A position that should be used as start. The default value is the [current start](#Range.start).

* @param end A position that should be used as end. The default value is the [current end](#Range.end).

* @return A range derived from this range with the given start and end position.

* If start and end are not different `this` range will be returned.

*/

with(start?: Position, end?: Position): Range;

/**

* Derived a new range from this range.

*

* @param change An object that describes a change to this range.

* @return A range that reflects the given change. Will return `this` range if the change

* is not changing anything.

*/

with(change: { start?: Position, end?: Position }): Range;

/**

* The position at which the selection starts.

* This position might be before or after [active](#Selection.active).

*/

anchor: Position;

/**

* The position of the cursor.

* This position might be before or after [anchor](#Selection.anchor).

*/

active: Position;

/**

* Create a selection from two positions.

*

* @param anchor A position.

* @param active A position.

*/

constructor(anchor: Position, active: Position);

/**

* Create a selection from four coordinates.

*

* @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.

*/

constructor(anchorLine: number, anchorCharacter: number, activeLine: number, activeCharacter: number);

/**

* A selection is reversed if [active](#Selection.active).isBefore([anchor](#Selection.anchor)).

*/

isReversed: boolean;

/**

* 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

/**

* The [text editor](#TextEditor) for which the selections have changed.

*/

textEditor: TextEditor;

/**

* The new value for the [text editor's selections](#TextEditor.selections).

*/

selections: Selection[];

/**

* The [change kind](#TextEditorSelectionChangeKind) which has triggered this

* event. Can be `undefined`.

*/

kind?: TextEditorSelectionChangeKind;

/**

* The [text editor](#TextEditor) for which the visible ranges have changed.

*/

textEditor: TextEditor;

/**

* The new value for the [text editor's visible ranges](#TextEditor.visibleRanges).

*/

visibleRanges: Range[];

/**

* The [text editor](#TextEditor) for which the options have changed.

*/

textEditor: TextEditor;

/**

* The new value for the [text editor's options](#TextEditor.options).

*/

options: TextEditorOptions;

/**

* The [text editor](#TextEditor) for which the view column has changed.

*/

textEditor: TextEditor;

/**

* The new value for the [text editor's view column](#TextEditor.viewColumn).

*/

viewColumn: ViewColumn;

/**

* Render the cursor as a vertical thick line.

*/

Line = 1,

/**

* Render the cursor as a block filled.

*/

Block = 2,

/**

* Render the cursor as a thick horizontal line.

*/

Underline = 3,

/**

* Render the cursor as a vertical thin line.

*/

LineThin = 4,

/**

* Render the cursor as a block outlined.

*/

BlockOutline = 5,

/**

* Render the cursor as a thin horizontal line.

*/

UnderlineThin = 6

/**

* 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

/**

* 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.

*

* 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"`.

*/

tabSize?: number | string;

/**

* When pressing Tab insert [n](#TextEditorOptions.tabSize) spaces.

* 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"`.

*/

insertSpaces?: boolean | string;

/**

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

/**

* 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.

*/

lineNumbers?: TextEditorLineNumbersStyle;

/**

* Internal representation of the handle.

*/

readonly key: string;

/**

* Remove this decoration type and all decorations on all text editors using it.

*/

dispose(): void;

/**

* The range will be revealed with as little scrolling as possible.

*/

Default = 0,

/**

* The range will always be revealed in the center of the viewport.

*/

InCenter = 1,

/**

* 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.

*/

InCenterIfOutsideViewport = 2,

/**

* The range will always be revealed at the top of the viewport.

*/

AtTop = 3

Left = 1,

Center = 2,

Right = 4,

Full = 7

/**

* The decoration's range will widen when edits occur at the start or end.

*/

OpenOpen = 0,

/**

* The decoration's range will not widen when edits occur at the start of end.

*/

ClosedClosed = 1,

/**

* The decoration's range will widen when edits occur at the start, but not at the end.

*/

OpenClosed = 2,

/**

* The decoration's range will widen when edits occur at the end, but not at the start.

*/

ClosedOpen = 3

/**

* An optional view column in which the [editor](#TextEditor) should be shown.

* The default is the [active](#ViewColumn.Active), other values are adjusted to

* be `Min(column, columnCount + 1)`, the [active](#ViewColumn.Active)-column is

* not adjusted. Use [`ViewColumn.Beside`](#ViewColumn.Beside) to open the

* editor to the side of the currently active one.

*/

viewColumn?: ViewColumn;

/**

* An optional flag that when `true` will stop the [editor](#TextEditor) from taking focus.

*/

preserveFocus?: boolean;

/**

* An optional flag that controls if an [editor](#TextEditor)-tab will be replaced

* with the next editor or if it will be kept.

*/

preview?: boolean;

/**

* An optional selection to apply for the document in the [editor](#TextEditor).

*/

selection?: Range;

/**

* Creates a reference to a theme color.

* @param id of the color. The available colors are listed in https://code.visualstudio.com/docs/getstarted/theme-color-reference.

*/

constructor(id: string);

/**

* Reference to a icon representing a file. The icon is taken from the current file icon theme or a placeholder icon.

*/

static readonly File: ThemeIcon;

/**

* Reference to a icon representing a folder. The icon is taken from the current file icon theme or a placeholder icon.

*/

static readonly Folder: ThemeIcon;

private constructor(id: string);

/**

* Background color of the decoration. Use rgba() and define transparent background colors to play well with other decorations.

* Alternatively a color from the color registry can be [referenced](#ThemeColor).

*/

backgroundColor?: string | ThemeColor;

/**

* CSS styling property that will be applied to text enclosed by a decoration.

*/

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.

*/

outlineColor?: string | ThemeColor;

/**

* 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.

*/

outlineStyle?: 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.

*/

outlineWidth?: string;

/**

* CSS styling property that will be applied to text enclosed by a decoration.

*/

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.

*/

borderColor?: string | ThemeColor;

/**

* 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.

*/

borderRadius?: 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.

*/

borderSpacing?: 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.

*/

borderStyle?: 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.

*/

borderWidth?: string;

/**

* CSS styling property that will be applied to text enclosed by a decoration.

*/

fontStyle?: string;

/**

* CSS styling property that will be applied to text enclosed by a decoration.

*/

fontWeight?: 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 | ThemeColor;

/**

* CSS styling property that will be applied to text enclosed by a decoration.

*/

opacity?: string;

/**

* CSS styling property that will be applied to text enclosed by a decoration.

*/

letterSpacing?: string;

/**

* An **absolute path** or an URI to an image to be rendered in the gutter.

*/

gutterIconPath?: string | Uri;

/**

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

/**

* The color of the decoration in the overview ruler. Use rgba() and define transparent colors to play well with other decorations.

*/

overviewRulerColor?: string | ThemeColor;

/**

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

/**

* Defines a text content that is shown in the attachment. Either an icon or a text can be shown, but not both.

*/

contentText?: string;

/**

* An **absolute path** or an URI to an image to be rendered in the attachment. Either an icon

* or a text can be shown, but not both.

*/

contentIconPath?: string | Uri;

/**

* CSS styling property that will be applied to the decoration attachment.

*/

border?: string;

/**

* CSS styling property that will be applied to text enclosed by a decoration.

*/

borderColor?: string | ThemeColor;

/**

* CSS styling property that will be applied to the decoration attachment.

*/

fontStyle?: string;

/**

* CSS styling property that will be applied to the decoration attachment.

*/

fontWeight?: string;

/**

* CSS styling property that will be applied to the decoration attachment.

*/

textDecoration?: string;

/**

* CSS styling property that will be applied to the decoration attachment.

*/

color?: string | ThemeColor;

/**

* CSS styling property that will be applied to the decoration attachment.

*/

backgroundColor?: string | ThemeColor;

/**

* CSS styling property that will be applied to the decoration attachment.

*/

margin?: string;

/**

* CSS styling property that will be applied to the decoration attachment.

*/

width?: string;

/**

* CSS styling property that will be applied to the decoration attachment.

*/

height?: string;

/**

* Should the decoration be rendered also on the whitespace after the line text.

* Defaults to `false`.

*/