@opensumi/sumi 2.12.1-next-079c1930

package/sumi-worker/worker.editor.d.ts

@@ -0,0 +1,725 @@
+declare module 'sumi-worker' {
+  /**
+   * 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,
+  }
+
+  /**
+   * Represents an event describing the change in a [text editor's selections](#TextEditor.selections).
+   */
+  export interface TextEditorSelectionChangeEvent {
+    /**
+     * The [text editor](#TextEditor) for which the selections have changed.
+     */
+    readonly textEditor: TextEditor;
+    /**
+     * The new value for the [text editor's selections](#TextEditor.selections).
+     */
+    readonly selections: ReadonlyArray<Selection>;
+    /**
+     * The [change kind](#TextEditorSelectionChangeKind) which has triggered this
+     * event. Can be `undefined`.
+     */
+    readonly kind?: TextEditorSelectionChangeKind;
+  }
+
+  /**
+   * Represents an event describing the change in a [text editor's visible ranges](#TextEditor.visibleRanges).
+   */
+  export interface TextEditorVisibleRangesChangeEvent {
+    /**
+     * The [text editor](#TextEditor) for which the visible ranges have changed.
+     */
+    readonly textEditor: TextEditor;
+    /**
+     * The new value for the [text editor's visible ranges](#TextEditor.visibleRanges).
+     */
+    readonly visibleRanges: ReadonlyArray<Range>;
+  }
+
+  /**
+   * Represents an event describing the change in a [text editor's options](#TextEditor.options).
+   */
+  export interface TextEditorOptionsChangeEvent {
+    /**
+     * The [text editor](#TextEditor) for which the options have changed.
+     */
+    readonly textEditor: TextEditor;
+    /**
+     * The new value for the [text editor's options](#TextEditor.options).
+     */
+    readonly options: TextEditorOptions;
+  }
+
+  /**
+   * 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 view column has changed.
+     */
+    readonly textEditor: TextEditor;
+    /**
+     * The new value for the [text editor's view column](#TextEditor.viewColumn).
+     */
+    readonly viewColumn: ViewColumn;
+  }
+
+  /**
+   * Rendering style of the cursor.
+   */
+  export enum TextEditorCursorStyle {
+    /**
+     * 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,
+  }
+
+  /**
+   * 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,
+  }
+
+  /**
+   * Represents a [text editor](#TextEditor)'s [options](#TextEditor.options).
+   */
+  export interface TextEditorOptions {
+    /**
+     * 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;
+  }
+
+  /**
+   * Represents a handle to a set of decorations
+   * sharing the same [styling options](#DecorationRenderOptions) in a [text editor](#TextEditor).
+   *
+   * To get an instance of a `TextEditorDecorationType` use
+   * [createTextEditorDecorationType](#window.createTextEditorDecorationType).
+   */
+  export interface TextEditorDecorationType {
+    /**
+     * Internal representation of the handle.
+     */
+    readonly key: string;
+
+    /**
+     * Remove this decoration type and all decorations on all text editors using it.
+     */
+    dispose(): void;
+  }
+
+  /**
+   * Represents different [reveal](#TextEditor.revealRange) strategies in a text editor.
+   */
+  export enum TextEditorRevealType {
+    /**
+     * 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,
+  }
+
+  /**
+   * Represents different positions for rendering a decoration in an [overview ruler](#DecorationRenderOptions.overviewRulerLane).
+   * The overview ruler supports three lanes.
+   */
+  export enum OverviewRulerLane {
+    Left = 1,
+    Center = 2,
+    Right = 4,
+    Full = 7,
+  }
+
+  /**
+   * Describes the behavior of decorations when typing/editing at their edges.
+   */
+  export enum DecorationRangeBehavior {
+    /**
+     * 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,
+  }
+
+  /**
+   * Represents options to configure the behavior of showing a [document](#TextDocument) in an [editor](#TextEditor).
+   */
+  export interface TextDocumentShowOptions {
+    /**
+     * 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;
+  }
+
+  /**
+   * Represents rendering styles for a [text editor decoration](#TextEditorDecorationType).
+   */
+  export interface DecorationRenderOptions
+    extends ThemableDecorationRenderOptions {
+    /**
+     * Should the decoration be rendered also on the whitespace after the line text.
+     * Defaults to `false`.
+     */
+    isWholeLine?: boolean;
+
+    /**
+     * Customize the growing behavior of the decoration when edits occur at the edges of the decoration's range.
+     * Defaults to `DecorationRangeBehavior.OpenOpen`.
+     */
+    rangeBehavior?: DecorationRangeBehavior;
+
+    /**
+     * 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;
+  }
+
+  /**
+   * Represents options for a specific decoration in a [decoration set](#TextEditorDecorationType).
+   */
+  export interface DecorationOptions {
+    /**
+     * Range to which this decoration is applied. The range must not be empty.
+     */
+    range: Range;
+
+    /**
+     * A message that should be rendered when hovering over the decoration.
+     */
+    hoverMessage?: MarkedString | MarkedString[];
+
+    /**
+     * Render options applied to the current decoration. For performance reasons, keep the
+     * number of decoration specific options small, and use decoration types wherever possible.
+     */
+    renderOptions?: DecorationInstanceRenderOptions;
+  }
+
+  export interface ThemableDecorationInstanceRenderOptions {
+    /**
+     * 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 DecorationInstanceRenderOptions
+    extends ThemableDecorationInstanceRenderOptions {
+    /**
+     * Overwrite options for light themes.
+     */
+    light?: ThemableDecorationInstanceRenderOptions;
+
+    /**
+     * Overwrite options for dark themes.
+     */
+    dark?: ThemableDecorationInstanceRenderOptions;
+  }
+
+  /**
+   * Represents an editor that is attached to a [document](#TextDocument).
+   */
+  export interface TextEditor {
+    /**
+     * The document associated with this text editor. The document will be the same for the entire lifetime of this text editor.
+     */
+    readonly document: TextDocument;
+
+    /**
+     * The primary selection on this text editor. Shorthand for `TextEditor.selections[0]`.
+     */
+    selection: Selection;
+
+    /**
+     * The selections in this text editor. The primary selection is always at index 0.
+     */
+    selections: Selection[];
+
+    /**
+     * The current visible ranges in the editor (vertically).
+     * This accounts only for vertical scrolling, and not for horizontal scrolling.
+     */
+    readonly visibleRanges: Range[];
+
+    /**
+     * Text editor options.
+     */
+    options: TextEditorOptions;
+
+    /**
+     * The column in which this editor shows. Will be `undefined` in case this
+     * isn't one of the main editors, e.g. an embedded editor, or when the editor
+     * column is larger than three.
+     */
+    viewColumn?: ViewColumn;
+
+    /**
+     * Perform an edit on the document associated with this text editor.
+     *
+     * The given callback-function is invoked with an [edit-builder](#TextEditorEdit) which must
+     * be used to make edits. Note that the edit-builder is only valid while the
+     * callback executes.
+     *
+     * @param callback A function which can create edits using an [edit-builder](#TextEditorEdit).
+     * @param options The undo/redo behavior around this edit. By default, undo stops will be created before and after this edit.
+     * @return A promise that resolves with a value indicating if the edits could be applied.
+     */
+    edit(
+      callback: (editBuilder: TextEditorEdit) => void,
+      options?: { undoStopBefore: boolean; undoStopAfter: boolean },
+    ): Thenable<boolean>;
+
+    /**
+     * Insert a [snippet](#SnippetString) and put the editor into snippet mode. "Snippet mode"
+     * means the editor adds placeholders and additional cursors so that the user can complete
+     * or accept the snippet.
+     *
+     * @param snippet The snippet to insert in this edit.
+     * @param location Position or range at which to insert the snippet, defaults to the current editor selection or selections.
+     * @param options The undo/redo behavior around this edit. By default, undo stops will be created before and after this edit.
+     * @return A promise that resolves with a value indicating if the snippet could be inserted. Note that the promise does not signal
+     * that the snippet is completely filled-in or accepted.
+     */
+    insertSnippet(
+      snippet: SnippetString,
+      location?:
+        | Position
+        | Range
+        | ReadonlyArray<Position>
+        | ReadonlyArray<Range>,
+      options?: { undoStopBefore: boolean; undoStopAfter: boolean },
+    ): Thenable<boolean>;
+
+    /**
+     * 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.
+     *
+     * @see [createTextEditorDecorationType](#window.createTextEditorDecorationType).
+     *
+     * @param decorationType A decoration type.
+     * @param rangesOrOptions Either [ranges](#Range) or more detailed [options](#DecorationOptions).
+     */
+    setDecorations(
+      decorationType: TextEditorDecorationType,
+      rangesOrOptions: Range[] | DecorationOptions[],
+    ): void;
+
+    /**
+     * Scroll as indicated by `revealType` in order to reveal the given range.
+     *
+     * @param range A range.
+     * @param revealType The scrolling strategy for revealing `range`.
+     */
+    revealRange(range: Range, revealType?: TextEditorRevealType): void;
+
+    /**
+     * ~~Show the text editor.~~
+     *
+     * @deprecated Use [window.showTextDocument](#window.showTextDocument) instead.
+     *
+     * @param column The [column](#ViewColumn) in which to show this editor.
+     * This method shows unexpected behavior and will be removed in the next major update.
+     */
+    show(column?: ViewColumn): void;
+
+    /**
+     * ~~Hide the text editor.~~
+     *
+     * @deprecated Use the command `workbench.action.closeActiveEditor` instead.
+     * This method shows unexpected behavior and will be removed in the next major update.
+     */
+    hide(): void;
+  }
+
+  export interface TextEditorEdit {
+    /**
+     * Replace a certain text region with a new value.
+     * You can use \r\n or \n in `value` and they will be normalized to the current [document](#TextDocument).
+     *
+     * @param location The range this operation should remove.
+     * @param value The new text this operation should insert after removing `location`.
+     */
+    replace(location: Position | Range | Selection, value: string): void;
+
+    /**
+     * Insert text at a location.
+     * You can use \r\n or \n in `value` and they will be normalized to the current [document](#TextDocument).
+     * 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.
+     */
+    insert(location: Position, value: string): void;
+
+    /**
+     * Delete a certain text region.
+     *
+     * @param location The range this operation should remove.
+     */
+    delete(location: Range | Selection): void;
+
+    /**
+     * Set the end of line sequence.
+     *
+     * @param endOfLine The new end of line for the [document](#TextDocument).
+     */
+    setEndOfLine(endOfLine: EndOfLine): void;
+  }
+
+  /**
+   * Denotes a location of an editor in the window. Editors can be arranged in a grid
+   * and each column represents one editor location in that grid by counting the editors
+   * in order of their appearance.
+   */
+  export enum ViewColumn {
+    /**
+     * A *symbolic* editor column representing the currently active column. This value
+     * can be used when opening editors, but the *resolved* [viewColumn](#TextEditor.viewColumn)-value
+     * of editors will always be `One`, `Two`, `Three`,... or `undefined` but never `Active`.
+     */
+    Active = -1,
+    /**
+     * A *symbolic* editor column representing the column to the side of the active one. This value
+     * can be used when opening editors, but the *resolved* [viewColumn](#TextEditor.viewColumn)-value
+     * of editors will always be `One`, `Two`, `Three`,... or `undefined` but never `Beside`.
+     */
+    Beside = -2,
+    /**
+     * The first editor column.
+     */
+    One = 1,
+    /**
+     * The second editor column.
+     */
+    Two = 2,
+    /**
+     * The third editor column.
+     */
+    Three = 3,
+    /**
+     * The fourth editor column.
+     */
+    Four = 4,
+    /**
+     * The fifth editor column.
+     */
+    Five = 5,
+    /**
+     * The sixth editor column.
+     */
+    Six = 6,
+    /**
+     * The seventh editor column.
+     */
+    Seven = 7,
+    /**
+     * The eighth editor column.
+     */
+    Eight = 8,
+    /**
+     * The ninth editor column.
+     */
+    Nine = 9,
+  }
+
+  export namespace workspace {
+    /**
+     * Make changes to one or many resources or create, delete, and rename resources as defined by the given
+     * [workspace edit](#WorkspaceEdit).
+     *
+     * All changes of a workspace edit are applied in the same order in which they have been added. If
+     * multiple textual inserts are made at the same position, these strings appear in the resulting text
+     * in the order the 'inserts' were made. Invalid sequences like 'delete file a' -> 'insert text in file a'
+     * cause failure of the operation.
+     *
+     * When applying a workspace edit that consists only of text edits an 'all-or-nothing'-strategy is used.
+     * A workspace edit with resource creations or deletions aborts the operation, e.g. consecutive edits will
+     * not be attempted, when a single edit fails.
+     *
+     * @param edit A workspace edit.
+     * @return A thenable that resolves when the edit could be applied.
+     * @Owner 吭头
+     */
+    export function applyEdit(edit: WorkspaceEdit): Thenable<boolean>;
+  }
+
+  export namespace window {
+    /**
+     * The currently active editor or `undefined`. The active editor is the one
+     * that currently has focus or, when none has focus, the one that has changed
+     * input most recently.
+     */
+    export let activeTextEditor: TextEditor | undefined;
+
+    /**
+     * The currently visible editors or an empty array.
+     */
+    export let visibleTextEditors: TextEditor[];
+
+    /**
+     * An [event](#Event) which fires when the [active editor](#window.activeTextEditor)
+     * has changed. *Note* that the event also fires when the active editor changes
+     * to `undefined`.
+     */
+    export const onDidChangeActiveTextEditor: Event<TextEditor | undefined>;
+
+    /**
+     * An [event](#Event) which fires when the array of [visible editors](#window.visibleTextEditors)
+     * has changed.
+     */
+    export const onDidChangeVisibleTextEditors: Event<TextEditor[]>;
+
+    /**
+     * An [event](#Event) which fires when the selection in an editor has changed.
+     */
+    export const onDidChangeTextEditorSelection: Event<TextEditorSelectionChangeEvent>;
+
+    /**
+     * An [event](#Event) which fires when the visible ranges of an editor has changed.
+     */
+    export const onDidChangeTextEditorVisibleRanges: Event<TextEditorVisibleRangesChangeEvent>;
+
+    /**
+     * An [event](#Event) which fires when the options of an editor have changed.
+     */
+    export const onDidChangeTextEditorOptions: Event<TextEditorOptionsChangeEvent>;
+
+    /**
+     * An [event](#Event) which fires when the view column of an editor has changed.
+     */
+    export const onDidChangeTextEditorViewColumn: Event<TextEditorViewColumnChangeEvent>;
+
+    /**
+     * 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](#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.
+     * @param preserveFocus When `true` the editor will not take focus.
+     * @return A promise that resolves to an [editor](#TextEditor).
+     */
+    export function showTextDocument(
+      document: TextDocument,
+      column?: ViewColumn,
+      preserveFocus?: boolean,
+    ): Thenable<TextEditor>;
+
+    /**
+     * A short-hand for `openTextDocument(uri).then(document => showTextDocument(document, options))`.
+     *
+     * @see [openTextDocument](#openTextDocument)
+     *
+     * @param document A resource identifier.
+     * @param options [Editor options](#TextDocumentShowOptions) to configure the behavior of showing the [editor](#TextEditor).
+     * @return A promise that resolves to an [editor](#TextEditor).
+     */
+    export function showTextDocument(
+      document: Uri | TextDocument,
+      options?: TextDocumentShowOptions,
+    ): Thenable<TextEditor>;
+
+    /**
+     * 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.
+     */
+    export function createTextEditorDecorationType(
+      options: DecorationRenderOptions,
+    ): TextEditorDecorationType;
+  }
+
+  export class TextEdit {
+    /**
+     * Utility to create a replace edit.
+     *
+     * @param range A range.
+     * @param newText A string.
+     * @return A new text edit object.
+     */
+    static replace(range: Range, newText: string): TextEdit;
+
+    /**
+     * Utility to create an insert edit.
+     *
+     * @param position A position, will become an empty range.
+     * @param newText A string.
+     * @return A new text edit object.
+     */
+    static insert(position: Position, newText: string): TextEdit;
+
+    /**
+     * Utility to create a delete edit.
+     *
+     * @param range A range.
+     * @return A new text edit object.
+     */
+    static delete(range: Range): TextEdit;
+
+    /**
+     * Utility to create an eol-edit.
+     *
+     * @param eol An eol-sequence
+     * @return A new text edit object.
+     */
+    static setEndOfLine(eol: EndOfLine): TextEdit;
+
+    /**
+     * The range this edit applies to.
+     */
+    range: Range;
+
+    /**
+     * The string this edit will insert.
+     */
+    newText: string;
+
+    /**
+     * The eol-sequence used in the document.
+     *
+     * *Note* that the eol-sequence will be applied to the
+     * whole document.
+     */
+    newEol: EndOfLine;
+
+    /**
+     * Create a new TextEdit.
+     *
+     * @param range A range.
+     * @param newText A string.
+     */
+    constructor(range: Range, newText: string);
+  }
+}