@codingame/monaco-vscode-xterm-addons-common 24.1.0

package/vscode/src/vs/workbench/contrib/terminal/browser/xterm/xtermTerminal.d.ts

@@ -0,0 +1,187 @@
+import type { ITheme, Terminal as RawXtermTerminal, IMarker as IXtermMarker } from "@xterm/xterm";
+import type { ISearchOptions } from "@xterm/addon-search";
+import { IConfigurationService } from "@codingame/monaco-vscode-api/vscode/vs/platform/configuration/common/configuration.service";
+import { Disposable } from "@codingame/monaco-vscode-api/vscode/vs/base/common/lifecycle";
+import { IShellIntegration, type IDecorationAddon } from "@codingame/monaco-vscode-api/vscode/vs/platform/terminal/common/terminal";
+import { ITerminalLogService } from "@codingame/monaco-vscode-api/vscode/vs/platform/terminal/common/terminal.service";
+import { ITerminalFont } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/terminal/common/terminal";
+import { IMarkTracker, IInternalXtermTerminal, IXtermTerminal, IXtermColorProvider, IXtermAttachToElementOptions, IDetachedXtermTerminal } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/terminal/browser/terminal";
+import { ITerminalConfigurationService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/terminal/browser/terminal.service";
+import { INotificationService } from "@codingame/monaco-vscode-api/vscode/vs/platform/notification/common/notification.service";
+import { ScrollPosition } from "./markNavigationAddon.js";
+import { IColorTheme } from "@codingame/monaco-vscode-api/vscode/vs/platform/theme/common/themeService";
+import { IThemeService } from "@codingame/monaco-vscode-api/vscode/vs/platform/theme/common/themeService.service";
+import { IInstantiationService } from "@codingame/monaco-vscode-api/vscode/vs/platform/instantiation/common/instantiation";
+import { ITerminalCapabilityStore, ITerminalCommand } from "@codingame/monaco-vscode-api/vscode/vs/platform/terminal/common/capabilities/capabilities";
+import { Event } from "@codingame/monaco-vscode-api/vscode/vs/base/common/event";
+import { ITelemetryService } from "@codingame/monaco-vscode-api/vscode/vs/platform/telemetry/common/telemetry.service";
+import { IContextKeyService } from "@codingame/monaco-vscode-api/vscode/vs/platform/contextkey/common/contextkey.service";
+import { IClipboardService } from "@codingame/monaco-vscode-api/vscode/vs/platform/clipboard/common/clipboardService.service";
+import { ILayoutService } from "@codingame/monaco-vscode-api/vscode/vs/platform/layout/browser/layoutService.service";
+import { IAccessibilitySignalService } from "@codingame/monaco-vscode-api/vscode/vs/platform/accessibilitySignal/browser/accessibilitySignalService.service";
+import { XtermAddonImporter } from "./xtermAddonImporter.js";
+import type { IProgressState } from "@xterm/addon-progress";
+import { URI } from "@codingame/monaco-vscode-api/vscode/vs/base/common/uri";
+export interface IXtermTerminalOptions {
+    /** The columns to initialize the terminal with. */
+    cols: number;
+    /** The rows to initialize the terminal with. */
+    rows: number;
+    /** The color provider for the terminal. */
+    xtermColorProvider: IXtermColorProvider;
+    /** The capabilities of the terminal. */
+    capabilities: ITerminalCapabilityStore;
+    /** The shell integration nonce to verify data coming from SI is trustworthy. */
+    shellIntegrationNonce?: string;
+    /** Whether to disable shell integration telemetry reporting. */
+    disableShellIntegrationReporting?: boolean;
+    /** The object that imports xterm addons, set this to inject an importer in tests. */
+    xtermAddonImporter?: XtermAddonImporter;
+    /** Whether to disable the overview ruler. */
+    disableOverviewRuler?: boolean;
+}
+/**
+ * Wraps the xterm object with additional functionality. Interaction with the backing process is out
+ * of the scope of this class.
+ */
+export declare class XtermTerminal extends Disposable implements IXtermTerminal, IDetachedXtermTerminal, IInternalXtermTerminal {
+    private readonly _onDidExecuteText;
+    private readonly _configurationService;
+    private readonly _instantiationService;
+    private readonly _logService;
+    private readonly _notificationService;
+    private readonly _themeService;
+    private readonly _telemetryService;
+    private readonly _terminalConfigurationService;
+    private readonly _clipboardService;
+    private readonly _accessibilitySignalService;
+    /** The raw xterm.js instance */
+    readonly raw: RawXtermTerminal;
+    private _core;
+    private readonly _xtermAddonLoader;
+    private readonly _xtermColorProvider;
+    private readonly _capabilities;
+    private static _suggestedRendererType;
+    private _attached?;
+    private _isPhysicalMouseWheel;
+    private _lastInputEvent;
+    get lastInputEvent(): string | undefined;
+    private _progressState;
+    get progressState(): IProgressState;
+    private _markNavigationAddon;
+    private _shellIntegrationAddon;
+    private _decorationAddon;
+    private _clipboardAddon?;
+    private _searchAddon?;
+    private _unicode11Addon?;
+    private _webglAddon?;
+    private _serializeAddon?;
+    private _imageAddon?;
+    private readonly _ligaturesAddon;
+    private readonly _ligaturesAddonConfig?;
+    private readonly _attachedDisposables;
+    private readonly _anyTerminalFocusContextKey;
+    private readonly _anyFocusedTerminalHasSelection;
+    private _lastFindResult;
+    get findResult(): {
+        resultIndex: number;
+        resultCount: number;
+    } | undefined;
+    get isStdinDisabled(): boolean;
+    get isGpuAccelerated(): boolean;
+    private readonly _onDidRequestRunCommand;
+    readonly onDidRequestRunCommand: Event<{
+        command: ITerminalCommand;
+        noNewLine?: boolean;
+    }>;
+    private readonly _onDidRequestCopyAsHtml;
+    readonly onDidRequestCopyAsHtml: Event<{
+        command: ITerminalCommand;
+    }>;
+    private readonly _onDidRequestRefreshDimensions;
+    readonly onDidRequestRefreshDimensions: Event<void>;
+    private readonly _onDidChangeFindResults;
+    readonly onDidChangeFindResults: Event<{
+        resultIndex: number;
+        resultCount: number;
+    }>;
+    private readonly _onDidChangeSelection;
+    readonly onDidChangeSelection: Event<void>;
+    private readonly _onDidChangeFocus;
+    readonly onDidChangeFocus: Event<boolean>;
+    private readonly _onDidDispose;
+    readonly onDidDispose: Event<void>;
+    private readonly _onDidChangeProgress;
+    readonly onDidChangeProgress: Event<IProgressState>;
+    get markTracker(): IMarkTracker;
+    get shellIntegration(): IShellIntegration;
+    get decorationAddon(): IDecorationAddon;
+    get textureAtlas(): Promise<ImageBitmap> | undefined;
+    get isFocused(): boolean;
+    /**
+     * @param xtermCtor The xterm.js constructor, this is passed in so it can be fetched lazily
+     * outside of this class such that {@link raw} is not nullable.
+     */
+    constructor(resource: URI | undefined, xtermCtor: typeof RawXtermTerminal, options: IXtermTerminalOptions, _onDidExecuteText: Event<void> | undefined, _configurationService: IConfigurationService, _instantiationService: IInstantiationService, _logService: ITerminalLogService, _notificationService: INotificationService, _themeService: IThemeService, _telemetryService: ITelemetryService, _terminalConfigurationService: ITerminalConfigurationService, _clipboardService: IClipboardService, contextKeyService: IContextKeyService, _accessibilitySignalService: IAccessibilitySignalService, layoutService: ILayoutService);
+    getBufferReverseIterator(): IterableIterator<string>;
+    getContentsAsText(startMarker?: IXtermMarker, endMarker?: IXtermMarker): string;
+    getContentsAsHtml(): Promise<string>;
+    getCommandOutputAsHtml(command: ITerminalCommand, maxLines: number): Promise<{
+        text: string;
+        truncated?: boolean;
+    }>;
+    getSelectionAsHtml(command?: ITerminalCommand): Promise<string>;
+    attachToElement(container: HTMLElement, partialOptions?: Partial<IXtermAttachToElementOptions>): HTMLElement;
+    private _setFocused;
+    write(data: string | Uint8Array, callback?: () => void): void;
+    resize(columns: number, rows: number): void;
+    updateConfig(): void;
+    private _updateSmoothScrolling;
+    private _shouldLoadWebgl;
+    forceRedraw(): void;
+    clearDecorations(): void;
+    forceRefresh(): void;
+    findNext(term: string, searchOptions: ISearchOptions): Promise<boolean>;
+    findPrevious(term: string, searchOptions: ISearchOptions): Promise<boolean>;
+    private _updateFindColors;
+    private _searchAddonPromise;
+    private _getSearchAddon;
+    clearSearchDecorations(): void;
+    clearActiveSearchDecoration(): void;
+    getFont(): ITerminalFont;
+    getLongestViewportWrappedLineLength(): number;
+    private _getWrappedLineCount;
+    scrollDownLine(): void;
+    scrollDownPage(): void;
+    scrollToBottom(): void;
+    scrollUpLine(): void;
+    scrollUpPage(): void;
+    scrollToTop(): void;
+    scrollToLine(line: number, position?: ScrollPosition): void;
+    clearBuffer(): void;
+    hasSelection(): boolean;
+    clearSelection(): void;
+    selectMarkedRange(fromMarkerId: string, toMarkerId: string, scrollIntoView?: boolean): void;
+    selectAll(): void;
+    focus(): void;
+    copySelection(asHtml?: boolean, command?: ITerminalCommand): Promise<void>;
+    private _setCursorBlink;
+    private _setCursorStyle;
+    private _setCursorStyleInactive;
+    private _setCursorWidth;
+    private _enableWebglRenderer;
+    private _refreshLigaturesAddon;
+    private _refreshImageAddon;
+    private _disposeOfWebglRenderer;
+    getRangeAsVT(startMarker: IXtermMarker, endMarker?: IXtermMarker, skipLastLine?: boolean): Promise<string>;
+    getXtermTheme(theme?: IColorTheme): ITheme;
+    private _updateTheme;
+    refresh(): void;
+    private _updateUnicodeVersion;
+    _writeText(data: string): void;
+    dispose(): void;
+}
+export declare function getXtermScaledDimensions(w: Window, font: ITerminalFont, width: number, height: number): {
+    rows: number;
+    cols: number;
+} | null;