@xterm/xterm 5.6.0-beta.7 → 5.6.0-beta.70

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/thenable.d.ts

@@ -0,0 +1,12 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+/**
+ * Thenable is a common denominator between ES6 promises, Q, jquery.Deferred, WinJS.Promise,
+ * and others. This API makes no assumption about what promise library is being used which
+ * enables reusing existing code without migrating to a specific promise implementation. Still,
+ * we recommend the use of native promises which are available in VS Code.
+ */
+interface Thenable<T> extends PromiseLike<T> { }

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

@@ -47,11 +47,13 @@ declare module '@xterm/xterm' {
 
     /**
      * When enabled the cursor will be set to the beginning of the next line
-     * with every new line. This is equivalent to sending '\r\n' for each '\n'.
-     * Normally the termios settings of the underlying PTY deals with the
-     * translation of '\n' to '\r\n' and this setting should not be used. If you
+     * with every new line. This is equivalent to sending `\r\n` for each `\n`.
+     * Normally the settings of the underlying PTY (`termios`) deal with the
+     * translation of `\n` to `\r\n` and this setting should not be used. If you
      * deal with data from a non-PTY related source, this settings might be
      * useful.
+     *
+     * @see https://pubs.opengroup.org/onlinepubs/007904975/basedefs/termios.h.html
      */
     convertEol?: boolean;
 
@@ -107,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;
 
@@ -323,10 +327,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;
   }
 
   /**
@@ -366,6 +370,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`) */
@@ -586,16 +611,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.
      */
@@ -618,6 +640,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`).
@@ -1090,7 +1134,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
@@ -1102,7 +1146,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;
@@ -1241,7 +1285,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/common/EventEmitter.ts

@@ -1,78 +0,0 @@
-/**
- * Copyright (c) 2019 The xterm.js authors. All rights reserved.
- * @license MIT
- */
-
-import { IDisposable } from 'common/Types';
-
-interface IListener<T, U = void> {
-  (arg1: T, arg2: U): void;
-}
-
-export interface IEvent<T, U = void> {
-  (listener: (arg1: T, arg2: U) => any): IDisposable;
-}
-
-export interface IEventEmitter<T, U = void> {
-  event: IEvent<T, U>;
-  fire(arg1: T, arg2: U): void;
-  dispose(): void;
-}
-
-export class EventEmitter<T, U = void> implements IEventEmitter<T, U> {
-  private _listeners: IListener<T, U>[] = [];
-  private _event?: IEvent<T, U>;
-  private _disposed: boolean = false;
-
-  public get event(): IEvent<T, U> {
-    if (!this._event) {
-      this._event = (listener: (arg1: T, arg2: U) => any) => {
-        this._listeners.push(listener);
-        const disposable = {
-          dispose: () => {
-            if (!this._disposed) {
-              for (let i = 0; i < this._listeners.length; i++) {
-                if (this._listeners[i] === listener) {
-                  this._listeners.splice(i, 1);
-                  return;
-                }
-              }
-            }
-          }
-        };
-        return disposable;
-      };
-    }
-    return this._event;
-  }
-
-  public fire(arg1: T, arg2: U): void {
-    const queue: IListener<T, U>[] = [];
-    for (let i = 0; i < this._listeners.length; i++) {
-      queue.push(this._listeners[i]);
-    }
-    for (let i = 0; i < queue.length; i++) {
-      queue[i].call(undefined, arg1, arg2);
-    }
-  }
-
-  public dispose(): void {
-    this.clearListeners();
-    this._disposed = true;
-  }
-
-  public clearListeners(): void {
-    if (this._listeners) {
-      this._listeners.length = 0;
-    }
-  }
-}
-
-export function forwardEvent<T>(from: IEvent<T>, to: IEventEmitter<T>): IDisposable {
-  return from(e => to.fire(e));
-}
-
-export function runAndSubscribe<T>(event: IEvent<T>, handler: (e: T | undefined) => any): IDisposable {
-  handler(undefined);
-  return event(e => handler(e));
-}

package/src/common/Lifecycle.ts

@@ -1,108 +0,0 @@
-/**
- * Copyright (c) 2018 The xterm.js authors. All rights reserved.
- * @license MIT
- */
-
-import { IDisposable } from 'common/Types';
-
-/**
- * A base class that can be extended to provide convenience methods for managing the lifecycle of an
- * object and its components.
- */
-export abstract class Disposable implements IDisposable {
-  protected _disposables: IDisposable[] = [];
-  protected _isDisposed: boolean = false;
-
-  /**
-   * Disposes the object, triggering the `dispose` method on all registered IDisposables.
-   */
-  public dispose(): void {
-    this._isDisposed = true;
-    for (const d of this._disposables) {
-      d.dispose();
-    }
-    this._disposables.length = 0;
-  }
-
-  /**
-   * Registers a disposable object.
-   * @param d The disposable to register.
-   * @returns The disposable.
-   */
-  public register<T extends IDisposable>(d: T): T {
-    this._disposables.push(d);
-    return d;
-  }
-
-  /**
-   * Unregisters a disposable object if it has been registered, if not do
-   * nothing.
-   * @param d The disposable to unregister.
-   */
-  public unregister<T extends IDisposable>(d: T): void {
-    const index = this._disposables.indexOf(d);
-    if (index !== -1) {
-      this._disposables.splice(index, 1);
-    }
-  }
-}
-
-export class MutableDisposable<T extends IDisposable> implements IDisposable {
-  private _value?: T;
-  private _isDisposed = false;
-
-  /**
-   * Gets the value if it exists.
-   */
-  public get value(): T | undefined {
-    return this._isDisposed ? undefined : this._value;
-  }
-
-  /**
-   * Sets the value, disposing of the old value if it exists.
-   */
-  public set value(value: T | undefined) {
-    if (this._isDisposed || value === this._value) {
-      return;
-    }
-    this._value?.dispose();
-    this._value = value;
-  }
-
-  /**
-   * Resets the stored value and disposes of the previously stored value.
-   */
-  public clear(): void {
-    this.value = undefined;
-  }
-
-  public dispose(): void {
-    this._isDisposed = true;
-    this._value?.dispose();
-    this._value = undefined;
-  }
-}
-
-/**
- * Wrap a function in a disposable.
- */
-export function toDisposable(f: () => void): IDisposable {
-  return { dispose: f };
-}
-
-/**
- * Dispose of all disposables in an array and set its length to 0.
- */
-export function disposeArray(disposables: IDisposable[]): void {
-  for (const d of disposables) {
-    d.dispose();
-  }
-  disposables.length = 0;
-}
-
-/**
- * Creates a disposable that will dispose of an array of disposables when disposed.
- */
-export function getDisposeArrayDisposable(array: IDisposable[]): IDisposable {
-  return { dispose: () => disposeArray(array) };
-}