@xterm/xterm 5.6.0-beta.14 → 5.6.0-beta.140

package/src/vs/typings/base-common.d.ts

@@ -0,0 +1,20 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+// Declare types that we probe for to implement util and/or polyfill functions
+
+declare global {
+
+	interface IdleDeadline {
+		readonly didTimeout: boolean;
+		timeRemaining(): number;
+	}
+
+	function requestIdleCallback(callback: (args: IdleDeadline) => void, options?: { timeout: number }): number;
+	function cancelIdleCallback(handle: number): void;
+
+}
+
+export { }

package/src/vs/typings/require.d.ts

@@ -0,0 +1,42 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+declare class LoaderEvent {
+	readonly type: number;
+	readonly timestamp: number;
+	readonly detail: string;
+}
+
+declare const define: {
+	(moduleName: string, dependencies: string[], callback: (...args: any[]) => any): any;
+	(moduleName: string, dependencies: string[], definition: any): any;
+	(moduleName: string, callback: (...args: any[]) => any): any;
+	(moduleName: string, definition: any): any;
+	(dependencies: string[], callback: (...args: any[]) => any): any;
+	(dependencies: string[], definition: any): any;
+};
+
+interface NodeRequire {
+	/**
+	 * @deprecated use `FileAccess.asFileUri()` for node.js contexts or `FileAccess.asBrowserUri` for browser contexts.
+	 */
+	toUrl(path: string): string;
+
+	/**
+	 * @deprecated MUST not be used anymore
+	 *
+	 * With the move from AMD to ESM we cannot use this anymore. There will be NO MORE node require like this.
+	 */
+	__$__nodeRequire<T>(moduleName: string): T;
+
+	(dependencies: string[], callback: (...args: any[]) => any, errorback?: (err: any) => void): any;
+	config(data: any): any;
+	onError: Function;
+	getStats?(): ReadonlyArray<LoaderEvent>;
+	hasDependencyCycle?(): boolean;
+	define(amdModuleId: string, dependencies: string[], callback: (...args: any[]) => any): any;
+}
+
+declare var require: NodeRequire;

package/src/vs/typings/vscode-globals-nls.d.ts

@@ -0,0 +1,36 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+// AMD2ESM mirgation relevant
+
+/**
+ * NLS Globals: these need to be defined in all contexts that make
+ * use of our `nls.localize` and `nls.localize2` functions. This includes:
+ * - Electron main process
+ * - Electron window (renderer) process
+ * - Utility Process
+ * - Node.js
+ * - Browser
+ * - Web worker
+ *
+ * That is because during build time we strip out all english strings from
+ * the resulting JS code and replace it with a <number> that is then looked
+ * up from the `_VSCODE_NLS_MESSAGES` array.
+ */
+declare global {
+	/**
+	 * All NLS messages produced by `localize` and `localize2` calls
+	 * under `src/vs` translated to the language as indicated by
+	 * `_VSCODE_NLS_LANGUAGE`.
+	 */
+	var _VSCODE_NLS_MESSAGES: string[];
+	/**
+	 * The actual language of the NLS messages (e.g. 'en', de' or 'pt-br').
+	 */
+	var _VSCODE_NLS_LANGUAGE: string | undefined;
+}
+
+// fake export to make global work
+export { }

package/src/vs/typings/vscode-globals-product.d.ts

@@ -0,0 +1,33 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+// AMD2ESM mirgation relevant
+
+declare global {
+
+	/**
+	 * Holds the file root for resources.
+	 */
+	var _VSCODE_FILE_ROOT: string;
+
+	/**
+	 * CSS loader that's available during development time.
+	 * DO NOT call directly, instead just import css modules, like `import 'some.css'`
+	 */
+	var _VSCODE_CSS_LOAD: (module: string) => void;
+
+	/**
+	 * @deprecated You MUST use `IProductService` whenever possible.
+	 */
+	var _VSCODE_PRODUCT_JSON: Record<string, any>;
+	/**
+	 * @deprecated You MUST use `IProductService` whenever possible.
+	 */
+	var _VSCODE_PACKAGE_JSON: Record<string, any>;
+
+}
+
+// fake export to make global work
+export { }

package/typings/xterm.d.ts

@@ -109,11 +109,13 @@ declare module '@xterm/xterm' {
 
     /**
      * The modifier key hold to multiply scroll speed.
+     * @deprecated This option is no longer available and will always use alt.
+     * Setting this will be ignored.
      */
     fastScrollModifier?: 'none' | 'alt' | 'ctrl' | 'shift';
 
     /**
-     * The scroll speed multiplier used for fast scrolling.
+     * The scroll speed multiplier used for fast scrolling when `Alt` is held.
      */
     fastScrollSensitivity?: number;
 
@@ -211,6 +213,13 @@ declare module '@xterm/xterm' {
      */
     minimumContrastRatio?: number;
 
+    /**
+     * Whether to reflow the line containing the cursor when the terminal is
+     * resized. Defaults to false, because shells usually handle this
+     * themselves.
+     */
+    reflowCursorLine?: boolean;
+
     /**
      * Whether to rescale glyphs horizontally that are a single cell wide but
      * have glyphs that would overlap following cell(s). This typically happens
@@ -248,6 +257,13 @@ declare module '@xterm/xterm' {
      */
     scrollback?: number;
 
+    /**
+     * If enabled the Erase in Display All (ED2) escape sequence will push
+     * erased text to scrollback, instead of clearing only the viewport portion.
+     * This emulates PuTTY's default clear screen behavior.
+     */
+    scrollOnEraseInDisplay?: boolean;
+
     /**
      * Whether to scroll to the bottom whenever there is some user input. The
      * default is true.
@@ -325,10 +341,10 @@ declare module '@xterm/xterm' {
     windowOptions?: IWindowOptions;
 
     /**
-     * The width, in pixels, of the canvas for the overview ruler. The overview
-     * ruler will be hidden when not set.
+     * Controls the visibility and style of the overview ruler which visualizes
+     * decorations underneath the scroll bar.
      */
-    overviewRulerWidth?: number;
+    overviewRuler?: IOverviewRulerOptions;
   }
 
   /**
@@ -368,6 +384,27 @@ declare module '@xterm/xterm' {
      * be transparent)
      */
     selectionInactiveBackground?: string;
+    /**
+     * The scrollbar slider background color. Defaults to
+     * {@link ITerminalOptions.foreground foreground} with 20% opacity.
+     */
+    scrollbarSliderBackground?: string;
+    /**
+     * The scrollbar slider background color when hovered. Defaults to
+     * {@link ITerminalOptions.foreground foreground} with 40% opacity.
+     */
+    scrollbarSliderHoverBackground?: string;
+    /**
+     * The scrollbar slider background color when clicked. Defaults to
+     * {@link ITerminalOptions.foreground foreground} with 50% opacity.
+     */
+    scrollbarSliderActiveBackground?: string;
+    /**
+     * The border color of the overview ruler. This visually separates the
+     * terminal from the scroll bar when {@link IOverviewRulerOptions.width} is
+     * set. When this is not set it defaults to black (`#000000`).
+     */
+    overviewRulerBorder?: string;
     /** ANSI black (eg. `\x1b[30m`) */
     black?: string;
     /** ANSI red (eg. `\x1b[31m`) */
@@ -588,16 +625,13 @@ declare module '@xterm/xterm' {
      * What layer to render the decoration at when {@link backgroundColor} or
      * {@link foregroundColor} are used. `'bottom'` will render under the
      * selection, `'top`' will render above the selection\*.
-     *
-     * *\* The selection will render on top regardless of layer on the canvas
-     * renderer due to how it renders selection separately.*
      */
     readonly layer?: 'bottom' | 'top';
 
     /**
      * When defined, renders the decoration in the overview ruler to the right
-     * of the terminal. {@link ITerminalOptions.overviewRulerWidth} must be set
-     * in order to see the overview ruler.
+     * of the terminal. {@link IOverviewRulerOptions.width} must be set in order
+     * to see the overview ruler.
      * @param color The color of the decoration.
      * @param position The position of the decoration.
      */
@@ -620,6 +654,28 @@ declare module '@xterm/xterm' {
     tooMuchOutput: string;
   }
 
+  export interface IOverviewRulerOptions {
+    /**
+     * When defined, renders decorations in the overview ruler to the right of
+     * the terminal. This must be set in order to see the overview ruler.
+     * @param color The color of the decoration.
+     * @param position The position of the decoration.
+     */
+    width?: number;
+
+    /**
+     * Whether to show the top border of the overview ruler, which uses the
+     * {@link ITheme.overviewRulerBorder} color.
+     */
+    showTopBorder?: boolean;
+
+    /**
+     * Whether to show the bottom border of the overview ruler, which uses the
+     * {@link ITheme.overviewRulerBorder} color.
+     */
+    showBottomBorder?: boolean;
+  }
+
   /**
    * Enable various window manipulation and report features
    * (`CSI Ps ; Ps ; Ps t`).
@@ -1092,7 +1148,7 @@ declare module '@xterm/xterm' {
      * render together, since they aren't drawn as optimally as individual
      * characters.
      *
-     * NOTE: character joiners are only used by the canvas renderer.
+     * NOTE: character joiners are only used by the webgl renderer.
      *
      * @param handler The function that determines character joins. It is called
      * with a string of text that is eligible for joining and returns an array
@@ -1104,7 +1160,7 @@ declare module '@xterm/xterm' {
 
     /**
      * (EXPERIMENTAL) Deregisters the character joiner if one was registered.
-     * NOTE: character joiners are only used by the canvas renderer.
+     * NOTE: character joiners are only used by the webgl renderer.
      * @param joinerId The character joiner's ID (returned after register)
      */
     deregisterCharacterJoiner(joinerId: number): void;
@@ -1209,21 +1265,31 @@ declare module '@xterm/xterm' {
 
     /**
      * Write data to the terminal.
+     *
+     * Note that the change will not be reflected in the {@link buffer}
+     * immediately as the data is processed asynchronously. Provide a
+     * {@link callback} to know when the data was processed.
      * @param data The data to write to the terminal. This can either be raw
      * bytes given as Uint8Array from the pty or a string. Raw bytes will always
      * be treated as UTF-8 encoded, string data as UTF-16.
      * @param callback Optional callback that fires when the data was processed
-     * by the parser.
+     * by the parser. This callback must be provided and awaited in order for
+     * {@link buffer} to reflect the change in the write.
      */
     write(data: string | Uint8Array, callback?: () => void): void;
 
     /**
      * Writes data to the terminal, followed by a break line character (\n).
+     *
+     * Note that the change will not be reflected in the {@link buffer}
+     * immediately as the data is processed asynchronously. Provide a
+     * {@link callback} to know when the data was processed.
      * @param data The data to write to the terminal. This can either be raw
      * bytes given as Uint8Array from the pty or a string. Raw bytes will always
      * be treated as UTF-8 encoded, string data as UTF-16.
      * @param callback Optional callback that fires when the data was processed
-     * by the parser.
+     * by the parser. This callback must be provided and awaited in order for
+     * {@link buffer} to reflect the change in the write.
      */
     writeln(data: string | Uint8Array, callback?: () => void): void;
 
@@ -1243,7 +1309,7 @@ declare module '@xterm/xterm' {
     refresh(start: number, end: number): void;
 
     /**
-     * Clears the texture atlas of the canvas renderer if it's active. Doing
+     * Clears the texture atlas of the webgl renderer if it's active. Doing
      * this will force a redraw of all glyphs which can workaround issues
      * causing the texture to become corrupt, for example Chromium/Nvidia has an
      * issue where the texture gets messed up when resuming the OS from sleep.

package/src/browser/Lifecycle.ts

@@ -1,33 +0,0 @@
-/**
- * Copyright (c) 2018 The xterm.js authors. All rights reserved.
- * @license MIT
- */
-
-import { IDisposable } from 'common/Types';
-
-/**
- * Adds a disposable listener to a node in the DOM, returning the disposable.
- * @param node The node to add a listener to.
- * @param type The event type.
- * @param handler The handler for the listener.
- * @param options The boolean or options object to pass on to the event
- * listener.
- */
-export function addDisposableDomListener(
-  node: Element | Window | Document,
-  type: string,
-  handler: (e: any) => void,
-  options?: boolean | AddEventListenerOptions
-): IDisposable {
-  node.addEventListener(type, handler, options);
-  let disposed = false;
-  return {
-    dispose: () => {
-      if (disposed) {
-        return;
-      }
-      disposed = true;
-      node.removeEventListener(type, handler, options);
-    }
-  };
-}

package/src/browser/renderer/shared/CellColorResolver.ts

@@ -1,236 +0,0 @@
-import { ISelectionRenderModel } from 'browser/renderer/shared/Types';
-import { ICoreBrowserService, IThemeService } from 'browser/services/Services';
-import { ReadonlyColorSet } from 'browser/Types';
-import { Attributes, BgFlags, ExtFlags, FgFlags, NULL_CELL_CODE, UnderlineStyle } from 'common/buffer/Constants';
-import { IDecorationService, IOptionsService } from 'common/services/Services';
-import { ICellData } from 'common/Types';
-import { Terminal } from '@xterm/xterm';
-import { rgba } from 'common/Color';
-import { treatGlyphAsBackgroundColor } from 'browser/renderer/shared/RendererUtils';
-
-// Work variables to avoid garbage collection
-let $fg = 0;
-let $bg = 0;
-let $hasFg = false;
-let $hasBg = false;
-let $isSelected = false;
-let $colors: ReadonlyColorSet | undefined;
-let $variantOffset = 0;
-
-export class CellColorResolver {
-  /**
-   * The shared result of the {@link resolve} call. This is only safe to use immediately after as
-   * any other calls will share object.
-   */
-  public readonly result: { fg: number, bg: number, ext: number } = {
-    fg: 0,
-    bg: 0,
-    ext: 0
-  };
-
-  constructor(
-    private readonly _terminal: Terminal,
-    private readonly _optionService: IOptionsService,
-    private readonly _selectionRenderModel: ISelectionRenderModel,
-    private readonly _decorationService: IDecorationService,
-    private readonly _coreBrowserService: ICoreBrowserService,
-    private readonly _themeService: IThemeService
-  ) {
-  }
-
-  /**
-   * Resolves colors for the cell, putting the result into the shared {@link result}. This resolves
-   * overrides, inverse and selection for the cell which can then be used to feed into the renderer.
-   */
-  public resolve(cell: ICellData, x: number, y: number, deviceCellWidth: number): void {
-    this.result.bg = cell.bg;
-    this.result.fg = cell.fg;
-    this.result.ext = cell.bg & BgFlags.HAS_EXTENDED ? cell.extended.ext : 0;
-    // Get any foreground/background overrides, this happens on the model to avoid spreading
-    // override logic throughout the different sub-renderers
-
-    // Reset overrides work variables
-    $bg = 0;
-    $fg = 0;
-    $hasBg = false;
-    $hasFg = false;
-    $isSelected = false;
-    $colors = this._themeService.colors;
-    $variantOffset = 0;
-
-    const code = cell.getCode();
-    if (code !== NULL_CELL_CODE && cell.extended.underlineStyle === UnderlineStyle.DOTTED) {
-      const lineWidth = Math.max(1, Math.floor(this._optionService.rawOptions.fontSize * this._coreBrowserService.dpr / 15));
-      $variantOffset = x * deviceCellWidth % (Math.round(lineWidth) * 2);
-    }
-
-    // Apply decorations on the bottom layer
-    this._decorationService.forEachDecorationAtCell(x, y, 'bottom', d => {
-      if (d.backgroundColorRGB) {
-        $bg = d.backgroundColorRGB.rgba >> 8 & Attributes.RGB_MASK;
-        $hasBg = true;
-      }
-      if (d.foregroundColorRGB) {
-        $fg = d.foregroundColorRGB.rgba >> 8 & Attributes.RGB_MASK;
-        $hasFg = true;
-      }
-    });
-
-    // Apply the selection color if needed
-    $isSelected = this._selectionRenderModel.isCellSelected(this._terminal, x, y);
-    if ($isSelected) {
-      // If the cell has a bg color, retain the color by blending it with the selection color
-      if (
-        (this.result.fg & FgFlags.INVERSE) ||
-        (this.result.bg & Attributes.CM_MASK) !== Attributes.CM_DEFAULT
-      ) {
-        // Resolve the standard bg color
-        if (this.result.fg & FgFlags.INVERSE) {
-          switch (this.result.fg & Attributes.CM_MASK) {
-            case Attributes.CM_P16:
-            case Attributes.CM_P256:
-              $bg = this._themeService.colors.ansi[this.result.fg & Attributes.PCOLOR_MASK].rgba;
-              break;
-            case Attributes.CM_RGB:
-              $bg = ((this.result.fg & Attributes.RGB_MASK) << 8) | 0xFF;
-              break;
-            case Attributes.CM_DEFAULT:
-            default:
-              $bg = this._themeService.colors.foreground.rgba;
-          }
-        } else {
-          switch (this.result.bg & Attributes.CM_MASK) {
-            case Attributes.CM_P16:
-            case Attributes.CM_P256:
-              $bg = this._themeService.colors.ansi[this.result.bg & Attributes.PCOLOR_MASK].rgba;
-              break;
-            case Attributes.CM_RGB:
-              $bg = ((this.result.bg & Attributes.RGB_MASK) << 8) | 0xFF;
-              break;
-            // No need to consider default bg color here as it's not possible
-          }
-        }
-        // Blend with selection bg color
-        $bg = rgba.blend(
-          $bg,
-          ((this._coreBrowserService.isFocused ? $colors.selectionBackgroundOpaque : $colors.selectionInactiveBackgroundOpaque).rgba & 0xFFFFFF00) | 0x80
-        ) >> 8 & Attributes.RGB_MASK;
-      } else {
-        $bg = (this._coreBrowserService.isFocused ? $colors.selectionBackgroundOpaque : $colors.selectionInactiveBackgroundOpaque).rgba >> 8 & Attributes.RGB_MASK;
-      }
-      $hasBg = true;
-
-      // Apply explicit selection foreground if present
-      if ($colors.selectionForeground) {
-        $fg = $colors.selectionForeground.rgba >> 8 & Attributes.RGB_MASK;
-        $hasFg = true;
-      }
-
-      // Overwrite fg as bg if it's a special decorative glyph (eg. powerline)
-      if (treatGlyphAsBackgroundColor(cell.getCode())) {
-        // Inverse default background should be treated as transparent
-        if (
-          (this.result.fg & FgFlags.INVERSE) &&
-          (this.result.bg & Attributes.CM_MASK) === Attributes.CM_DEFAULT
-        ) {
-          $fg = (this._coreBrowserService.isFocused ? $colors.selectionBackgroundOpaque : $colors.selectionInactiveBackgroundOpaque).rgba >> 8 & Attributes.RGB_MASK;
-        } else {
-
-          if (this.result.fg & FgFlags.INVERSE) {
-            switch (this.result.bg & Attributes.CM_MASK) {
-              case Attributes.CM_P16:
-              case Attributes.CM_P256:
-                $fg = this._themeService.colors.ansi[this.result.bg & Attributes.PCOLOR_MASK].rgba;
-                break;
-              case Attributes.CM_RGB:
-                $fg = ((this.result.bg & Attributes.RGB_MASK) << 8) | 0xFF;
-                break;
-              // No need to consider default bg color here as it's not possible
-            }
-          } else {
-            switch (this.result.fg & Attributes.CM_MASK) {
-              case Attributes.CM_P16:
-              case Attributes.CM_P256:
-                $fg = this._themeService.colors.ansi[this.result.fg & Attributes.PCOLOR_MASK].rgba;
-                break;
-              case Attributes.CM_RGB:
-                $fg = ((this.result.fg & Attributes.RGB_MASK) << 8) | 0xFF;
-                break;
-              case Attributes.CM_DEFAULT:
-              default:
-                $fg = this._themeService.colors.foreground.rgba;
-            }
-          }
-
-          $fg = rgba.blend(
-            $fg,
-            ((this._coreBrowserService.isFocused ? $colors.selectionBackgroundOpaque : $colors.selectionInactiveBackgroundOpaque).rgba & 0xFFFFFF00) | 0x80
-          ) >> 8 & Attributes.RGB_MASK;
-        }
-        $hasFg = true;
-      }
-    }
-
-    // Apply decorations on the top layer
-    this._decorationService.forEachDecorationAtCell(x, y, 'top', d => {
-      if (d.backgroundColorRGB) {
-        $bg = d.backgroundColorRGB.rgba >> 8 & Attributes.RGB_MASK;
-        $hasBg = true;
-      }
-      if (d.foregroundColorRGB) {
-        $fg = d.foregroundColorRGB.rgba >> 8 & Attributes.RGB_MASK;
-        $hasFg = true;
-      }
-    });
-
-    // Convert any overrides from rgba to the fg/bg packed format. This resolves the inverse flag
-    // ahead of time in order to use the correct cache key
-    if ($hasBg) {
-      if ($isSelected) {
-        // Non-RGB attributes from model + force non-dim + override + force RGB color mode
-        $bg = (cell.bg & ~Attributes.RGB_MASK & ~BgFlags.DIM) | $bg | Attributes.CM_RGB;
-      } else {
-        // Non-RGB attributes from model + override + force RGB color mode
-        $bg = (cell.bg & ~Attributes.RGB_MASK) | $bg | Attributes.CM_RGB;
-      }
-    }
-    if ($hasFg) {
-      // Non-RGB attributes from model + force disable inverse + override + force RGB color mode
-      $fg = (cell.fg & ~Attributes.RGB_MASK & ~FgFlags.INVERSE) | $fg | Attributes.CM_RGB;
-    }
-
-    // Handle case where inverse was specified by only one of bg override or fg override was set,
-    // resolving the other inverse color and setting the inverse flag if needed.
-    if (this.result.fg & FgFlags.INVERSE) {
-      if ($hasBg && !$hasFg) {
-        // Resolve bg color type (default color has a different meaning in fg vs bg)
-        if ((this.result.bg & Attributes.CM_MASK) === Attributes.CM_DEFAULT) {
-          $fg = (this.result.fg & ~(Attributes.RGB_MASK | FgFlags.INVERSE | Attributes.CM_MASK)) | (($colors.background.rgba >> 8 & Attributes.RGB_MASK) & Attributes.RGB_MASK) | Attributes.CM_RGB;
-        } else {
-          $fg = (this.result.fg & ~(Attributes.RGB_MASK | FgFlags.INVERSE | Attributes.CM_MASK)) | this.result.bg & (Attributes.RGB_MASK | Attributes.CM_MASK);
-        }
-        $hasFg = true;
-      }
-      if (!$hasBg && $hasFg) {
-        // Resolve bg color type (default color has a different meaning in fg vs bg)
-        if ((this.result.fg & Attributes.CM_MASK) === Attributes.CM_DEFAULT) {
-          $bg = (this.result.bg & ~(Attributes.RGB_MASK | Attributes.CM_MASK)) | (($colors.foreground.rgba >> 8 & Attributes.RGB_MASK) & Attributes.RGB_MASK) | Attributes.CM_RGB;
-        } else {
-          $bg = (this.result.bg & ~(Attributes.RGB_MASK | Attributes.CM_MASK)) | this.result.fg & (Attributes.RGB_MASK | Attributes.CM_MASK);
-        }
-        $hasBg = true;
-      }
-    }
-
-    // Release object
-    $colors = undefined;
-
-    // Use the override if it exists
-    this.result.bg = $hasBg ? $bg : this.result.bg;
-    this.result.fg = $hasFg ? $fg : this.result.fg;
-
-    // Reset overrides variantOffset
-    this.result.ext &= ~ExtFlags.VARIANT_OFFSET;
-    this.result.ext |= ($variantOffset << 29) & ExtFlags.VARIANT_OFFSET;
-  }
-}