@xterm/xterm 5.6.0-beta.50 → 5.6.0-beta.52

package/src/common/InputHandler.ts

@@ -8,7 +8,7 @@ import { IInputHandler, IAttributeData, IDisposable, IWindowOptions, IColorEvent
 import { C0, C1 } from 'common/data/EscapeSequences';
 import { CHARSETS, DEFAULT_CHARSET } from 'common/data/Charsets';
 import { EscapeSequenceParser } from 'common/parser/EscapeSequenceParser';
-import { Disposable } from 'common/Lifecycle';
+import { Disposable } from 'vs/base/common/lifecycle';
 import { StringToUtf32, stringFromCodePoint, Utf8ToUtf32 } from 'common/input/TextDecoder';
 import { BufferLine, DEFAULT_ATTR_DATA } from 'common/buffer/BufferLine';
 import { IParsingState, IEscapeSequenceParser, IParams, IFunctionIdentifier } from 'common/parser/Types';
@@ -131,32 +131,32 @@ export class InputHandler extends Disposable implements IInputHandler {
 
   private _activeBuffer: IBuffer;
 
-  private readonly _onRequestBell = this.register(new Emitter<void>());
+  private readonly _onRequestBell = this._register(new Emitter<void>());
   public readonly onRequestBell = this._onRequestBell.event;
-  private readonly _onRequestRefreshRows = this.register(new Emitter<{ start: number, end: number } | undefined>());
+  private readonly _onRequestRefreshRows = this._register(new Emitter<{ start: number, end: number } | undefined>());
   public readonly onRequestRefreshRows = this._onRequestRefreshRows.event;
-  private readonly _onRequestReset = this.register(new Emitter<void>());
+  private readonly _onRequestReset = this._register(new Emitter<void>());
   public readonly onRequestReset = this._onRequestReset.event;
-  private readonly _onRequestSendFocus = this.register(new Emitter<void>());
+  private readonly _onRequestSendFocus = this._register(new Emitter<void>());
   public readonly onRequestSendFocus = this._onRequestSendFocus.event;
-  private readonly _onRequestSyncScrollBar = this.register(new Emitter<void>());
+  private readonly _onRequestSyncScrollBar = this._register(new Emitter<void>());
   public readonly onRequestSyncScrollBar = this._onRequestSyncScrollBar.event;
-  private readonly _onRequestWindowsOptionsReport = this.register(new Emitter<WindowsOptionsReportType>());
+  private readonly _onRequestWindowsOptionsReport = this._register(new Emitter<WindowsOptionsReportType>());
   public readonly onRequestWindowsOptionsReport = this._onRequestWindowsOptionsReport.event;
 
-  private readonly _onA11yChar = this.register(new Emitter<string>());
+  private readonly _onA11yChar = this._register(new Emitter<string>());
   public readonly onA11yChar = this._onA11yChar.event;
-  private readonly _onA11yTab = this.register(new Emitter<number>());
+  private readonly _onA11yTab = this._register(new Emitter<number>());
   public readonly onA11yTab = this._onA11yTab.event;
-  private readonly _onCursorMove = this.register(new Emitter<void>());
+  private readonly _onCursorMove = this._register(new Emitter<void>());
   public readonly onCursorMove = this._onCursorMove.event;
-  private readonly _onLineFeed = this.register(new Emitter<void>());
+  private readonly _onLineFeed = this._register(new Emitter<void>());
   public readonly onLineFeed = this._onLineFeed.event;
-  private readonly _onScroll = this.register(new Emitter<number>());
+  private readonly _onScroll = this._register(new Emitter<number>());
   public readonly onScroll = this._onScroll.event;
-  private readonly _onTitleChange = this.register(new Emitter<string>());
+  private readonly _onTitleChange = this._register(new Emitter<string>());
   public readonly onTitleChange = this._onTitleChange.event;
-  private readonly _onColor = this.register(new Emitter<IColorEvent>());
+  private readonly _onColor = this._register(new Emitter<IColorEvent>());
   public readonly onColor = this._onColor.event;
 
   private _parseStack: IParseStack = {
@@ -179,12 +179,12 @@ export class InputHandler extends Disposable implements IInputHandler {
     private readonly _parser: IEscapeSequenceParser = new EscapeSequenceParser()
   ) {
     super();
-    this.register(this._parser);
+    this._register(this._parser);
     this._dirtyRowTracker = new DirtyRowTracker(this._bufferService);
 
     // Track properties used in performance critical code manually to avoid using slow getters
     this._activeBuffer = this._bufferService.buffer;
-    this.register(this._bufferService.buffers.onBufferActivate(e => this._activeBuffer = e.activeBuffer));
+    this._register(this._bufferService.buffers.onBufferActivate(e => this._activeBuffer = e.activeBuffer));
 
     /**
      * custom fallback handlers

package/src/common/buffer/BufferSet.ts

@@ -3,7 +3,7 @@
  * @license MIT
  */
 
-import { Disposable } from 'common/Lifecycle';
+import { Disposable } from 'vs/base/common/lifecycle';
 import { IAttributeData } from 'common/Types';
 import { Buffer } from 'common/buffer/Buffer';
 import { IBuffer, IBufferSet } from 'common/buffer/Types';
@@ -19,7 +19,7 @@ export class BufferSet extends Disposable implements IBufferSet {
   private _alt!: Buffer;
   private _activeBuffer!: Buffer;
 
-  private readonly _onBufferActivate = this.register(new Emitter<{ activeBuffer: IBuffer, inactiveBuffer: IBuffer }>());
+  private readonly _onBufferActivate = this._register(new Emitter<{ activeBuffer: IBuffer, inactiveBuffer: IBuffer }>());
   public readonly onBufferActivate = this._onBufferActivate.event;
 
   /**
@@ -31,8 +31,8 @@ export class BufferSet extends Disposable implements IBufferSet {
   ) {
     super();
     this.reset();
-    this.register(this._optionsService.onSpecificOptionChange('scrollback', () => this.resize(this._bufferService.cols, this._bufferService.rows)));
-    this.register(this._optionsService.onSpecificOptionChange('tabStopWidth', () => this.setupTabStops()));
+    this._register(this._optionsService.onSpecificOptionChange('scrollback', () => this.resize(this._bufferService.cols, this._bufferService.rows)));
+    this._register(this._optionsService.onSpecificOptionChange('tabStopWidth', () => this.setupTabStops()));
   }
 
   public reset(): void {

package/src/common/buffer/Marker.ts

@@ -3,9 +3,9 @@
  * @license MIT
  */
 
-import { disposeArray } from 'common/Lifecycle';
 import { IDisposable, IMarker } from 'common/Types';
 import { Emitter } from 'vs/base/common/event';
+import { dispose } from 'vs/base/common/lifecycle';
 
 export class Marker implements IMarker {
   private static _nextId = 1;
@@ -32,7 +32,7 @@ export class Marker implements IMarker {
     this.line = -1;
     // Emit before super.dispose such that dispose listeners get a change to react
     this._onDispose.fire();
-    disposeArray(this._disposables);
+    dispose(this._disposables);
     this._disposables.length = 0;
   }
 

package/src/common/input/WriteBuffer.ts

@@ -4,7 +4,7 @@
  * @license MIT
  */
 
-import { Disposable } from 'common/Lifecycle';
+import { Disposable } from 'vs/base/common/lifecycle';
 import { Emitter } from 'vs/base/common/event';
 
 declare const setTimeout: (handler: () => void, timeout?: number) => void;
@@ -43,7 +43,7 @@ export class WriteBuffer extends Disposable {
   private _syncCalls = 0;
   private _didUserInput = false;
 
-  private readonly _onWriteParsed = this.register(new Emitter<void>());
+  private readonly _onWriteParsed = this._register(new Emitter<void>());
   public readonly onWriteParsed = this._onWriteParsed.event;
 
   constructor(private _action: (data: string | Uint8Array, promiseResult?: boolean) => void | Promise<boolean>) {

package/src/common/parser/EscapeSequenceParser.ts

@@ -5,7 +5,7 @@
 
 import { IParsingState, IDcsHandler, IEscapeSequenceParser, IParams, IOscHandler, IHandlerCollection, CsiHandlerType, OscFallbackHandlerType, IOscParser, EscHandlerType, IDcsParser, DcsFallbackHandlerType, IFunctionIdentifier, ExecuteFallbackHandlerType, CsiFallbackHandlerType, EscFallbackHandlerType, PrintHandlerType, PrintFallbackHandlerType, ExecuteHandlerType, IParserStackState, ParserStackType, ResumableHandlersType } from 'common/parser/Types';
 import { ParserState, ParserAction } from 'common/parser/Constants';
-import { Disposable, toDisposable } from 'common/Lifecycle';
+import { Disposable, toDisposable } from 'vs/base/common/lifecycle';
 import { IDisposable } from 'common/Types';
 import { Params } from 'common/parser/Params';
 import { OscParser } from 'common/parser/OscParser';
@@ -283,13 +283,13 @@ export class EscapeSequenceParser extends Disposable implements IEscapeSequenceP
     this._executeHandlers = Object.create(null);
     this._csiHandlers = Object.create(null);
     this._escHandlers = Object.create(null);
-    this.register(toDisposable(() => {
+    this._register(toDisposable(() => {
       this._csiHandlers = Object.create(null);
       this._executeHandlers = Object.create(null);
       this._escHandlers = Object.create(null);
     }));
-    this._oscParser = this.register(new OscParser());
-    this._dcsParser = this.register(new DcsParser());
+    this._oscParser = this._register(new OscParser());
+    this._dcsParser = this._register(new DcsParser());
     this._errorHandler = this._errorHandlerFb;
 
     // swallow 7bit ST (ESC+\)

package/src/common/public/BufferNamespaceApi.ts

@@ -6,14 +6,14 @@
 import { IBuffer as IBufferApi, IBufferNamespace as IBufferNamespaceApi } from '@xterm/xterm';
 import { BufferApiView } from 'common/public/BufferApiView';
 import { ICoreTerminal } from 'common/Types';
-import { Disposable } from 'common/Lifecycle';
+import { Disposable } from 'vs/base/common/lifecycle';
 import { Emitter } from 'vs/base/common/event';
 
 export class BufferNamespaceApi extends Disposable implements IBufferNamespaceApi {
   private _normal: BufferApiView;
   private _alternate: BufferApiView;
 
-  private readonly _onBufferChange = this.register(new Emitter<IBufferApi>());
+  private readonly _onBufferChange = this._register(new Emitter<IBufferApi>());
   public readonly onBufferChange = this._onBufferChange.event;
 
   constructor(private _core: ICoreTerminal) {

package/src/common/services/BufferService.ts

@@ -3,7 +3,7 @@
  * @license MIT
  */
 
-import { Disposable } from 'common/Lifecycle';
+import { Disposable } from 'vs/base/common/lifecycle';
 import { IAttributeData, IBufferLine } from 'common/Types';
 import { BufferSet } from 'common/buffer/BufferSet';
 import { IBuffer, IBufferSet } from 'common/buffer/Types';
@@ -22,9 +22,9 @@ export class BufferService extends Disposable implements IBufferService {
   /** Whether the user is scrolling (locks the scroll position) */
   public isUserScrolling: boolean = false;
 
-  private readonly _onResize = this.register(new Emitter<{ cols: number, rows: number }>());
+  private readonly _onResize = this._register(new Emitter<{ cols: number, rows: number }>());
   public readonly onResize = this._onResize.event;
-  private readonly _onScroll = this.register(new Emitter<number>());
+  private readonly _onScroll = this._register(new Emitter<number>());
   public readonly onScroll = this._onScroll.event;
 
   public get buffer(): IBuffer { return this.buffers.active; }
@@ -36,7 +36,7 @@ export class BufferService extends Disposable implements IBufferService {
     super();
     this.cols = Math.max(optionsService.rawOptions.cols || 0, MINIMUM_COLS);
     this.rows = Math.max(optionsService.rawOptions.rows || 0, MINIMUM_ROWS);
-    this.buffers = this.register(new BufferSet(optionsService, this));
+    this.buffers = this._register(new BufferSet(optionsService, this));
   }
 
   public resize(cols: number, rows: number): void {

package/src/common/services/CoreMouseService.ts

@@ -4,7 +4,7 @@
  */
 import { IBufferService, ICoreService, ICoreMouseService } from 'common/services/Services';
 import { ICoreMouseProtocol, ICoreMouseEvent, CoreMouseEncoding, CoreMouseEventType, CoreMouseButton, CoreMouseAction } from 'common/Types';
-import { Disposable } from 'common/Lifecycle';
+import { Disposable } from 'vs/base/common/lifecycle';
 import { Emitter } from 'vs/base/common/event';
 
 /**
@@ -175,7 +175,7 @@ export class CoreMouseService extends Disposable implements ICoreMouseService {
   private _activeEncoding: string = '';
   private _lastEvent: ICoreMouseEvent | null = null;
 
-  private readonly _onProtocolChange = this.register(new Emitter<CoreMouseEventType>());
+  private readonly _onProtocolChange = this._register(new Emitter<CoreMouseEventType>());
   public readonly onProtocolChange =  this._onProtocolChange.event;
 
   constructor(

package/src/common/services/CoreService.ts

@@ -4,7 +4,7 @@
  */
 
 import { clone } from 'common/Clone';
-import { Disposable } from 'common/Lifecycle';
+import { Disposable } from 'vs/base/common/lifecycle';
 import { IDecPrivateModes, IModes } from 'common/Types';
 import { IBufferService, ICoreService, ILogService, IOptionsService } from 'common/services/Services';
 import { Emitter } from 'vs/base/common/event';
@@ -31,13 +31,13 @@ export class CoreService extends Disposable implements ICoreService {
   public modes: IModes;
   public decPrivateModes: IDecPrivateModes;
 
-  private readonly _onData = this.register(new Emitter<string>());
+  private readonly _onData = this._register(new Emitter<string>());
   public readonly onData = this._onData.event;
-  private readonly _onUserInput = this.register(new Emitter<void>());
+  private readonly _onUserInput = this._register(new Emitter<void>());
   public readonly onUserInput = this._onUserInput.event;
-  private readonly _onBinary = this.register(new Emitter<string>());
+  private readonly _onBinary = this._register(new Emitter<string>());
   public readonly onBinary = this._onBinary.event;
-  private readonly _onRequestScrollToBottom = this.register(new Emitter<void>());
+  private readonly _onRequestScrollToBottom = this._register(new Emitter<void>());
   public readonly onRequestScrollToBottom = this._onRequestScrollToBottom.event;
 
   constructor(

package/src/common/services/DecorationService.ts

@@ -4,7 +4,7 @@
  */
 
 import { css } from 'common/Color';
-import { Disposable, toDisposable } from 'common/Lifecycle';
+import { Disposable, DisposableStore, toDisposable } from 'vs/base/common/lifecycle';
 import { IDecorationService, IInternalDecoration } from 'common/services/Services';
 import { SortedList } from 'common/SortedList';
 import { IColor } from 'common/Types';
@@ -25,9 +25,9 @@ export class DecorationService extends Disposable implements IDecorationService
    */
   private readonly _decorations: SortedList<IInternalDecoration> = new SortedList(e => e?.marker.line);
 
-  private readonly _onDecorationRegistered = this.register(new Emitter<IInternalDecoration>());
+  private readonly _onDecorationRegistered = this._register(new Emitter<IInternalDecoration>());
   public readonly onDecorationRegistered = this._onDecorationRegistered.event;
-  private readonly _onDecorationRemoved = this.register(new Emitter<IInternalDecoration>());
+  private readonly _onDecorationRemoved = this._register(new Emitter<IInternalDecoration>());
   public readonly onDecorationRemoved = this._onDecorationRemoved.event;
 
   public get decorations(): IterableIterator<IInternalDecoration> { return this._decorations.values(); }
@@ -35,7 +35,7 @@ export class DecorationService extends Disposable implements IDecorationService
   constructor() {
     super();
 
-    this.register(toDisposable(() => this.reset()));
+    this._register(toDisposable(() => this.reset()));
   }
 
   public registerDecoration(options: IDecorationOptions): IDecoration | undefined {
@@ -90,14 +90,13 @@ export class DecorationService extends Disposable implements IDecorationService
   }
 }
 
-class Decoration extends Disposable implements IInternalDecoration {
+class Decoration extends DisposableStore implements IInternalDecoration {
   public readonly marker: IMarker;
   public element: HTMLElement | undefined;
-  public get isDisposed(): boolean { return this._isDisposed; }
 
-  public readonly onRenderEmitter = this.register(new Emitter<HTMLElement>());
+  public readonly onRenderEmitter = this.add(new Emitter<HTMLElement>());
   public readonly onRender = this.onRenderEmitter.event;
-  private readonly _onDispose = this.register(new Emitter<void>());
+  private readonly _onDispose = this.add(new Emitter<void>());
   public readonly onDispose = this._onDispose.event;
 
   private _cachedBg: IColor | undefined | null = null;

package/src/common/services/LogService.ts

@@ -3,7 +3,7 @@
  * @license MIT
  */
 
-import { Disposable } from 'common/Lifecycle';
+import { Disposable } from 'vs/base/common/lifecycle';
 import { ILogService, IOptionsService, LogLevelEnum } from 'common/services/Services';
 
 type LogType = (message?: any, ...optionalParams: any[]) => void;
@@ -42,7 +42,7 @@ export class LogService extends Disposable implements ILogService {
   ) {
     super();
     this._updateLogLevel();
-    this.register(this._optionsService.onSpecificOptionChange('logLevel', () => this._updateLogLevel()));
+    this._register(this._optionsService.onSpecificOptionChange('logLevel', () => this._updateLogLevel()));
 
     // For trace logging, assume the latest created log service is valid
     traceLogger = this;

package/src/common/services/OptionsService.ts

@@ -3,7 +3,7 @@
  * @license MIT
  */
 
-import { Disposable, toDisposable } from 'common/Lifecycle';
+import { Disposable, toDisposable } from 'vs/base/common/lifecycle';
 import { isMac } from 'common/Platform';
 import { CursorStyle, IDisposable } from 'common/Types';
 import { FontWeight, IOptionsService, ITerminalOptions } from 'common/services/Services';
@@ -65,7 +65,7 @@ export class OptionsService extends Disposable implements IOptionsService {
   public readonly rawOptions: Required<ITerminalOptions>;
   public options: Required<ITerminalOptions>;
 
-  private readonly _onOptionChange = this.register(new Emitter<keyof ITerminalOptions>());
+  private readonly _onOptionChange = this._register(new Emitter<keyof ITerminalOptions>());
   public readonly onOptionChange = this._onOptionChange.event;
 
   constructor(options: Partial<ITerminalOptions>) {
@@ -90,7 +90,7 @@ export class OptionsService extends Disposable implements IOptionsService {
 
     // Clear out options that could link outside xterm.js as they could easily cause an embedder
     // memory leak
-    this.register(toDisposable(() => {
+    this._register(toDisposable(() => {
       this.rawOptions.linkHandler = null;
       this.rawOptions.documentOverride = null;
     }));

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/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) };
-}