From f80dbf3d03d1076b42c5a02c82253b93defdd29d Mon Sep 17 00:00:00 2001 From: Daniel Imms <2193314+Tyriar@users.noreply.github.com> Date: Fri, 30 Jan 2026 06:21:15 -0800 Subject: [PATCH] Fix lint, split up namespace and interface --- addons/addon-webgl/src/Types.ts | 6 +-- addons/addon-webgl/src/WebglAddon.ts | 10 ++-- addons/addon-webgl/src/WebglRenderer.ts | 6 +-- src/browser/CoreBrowserTerminal.ts | 22 ++++----- src/browser/TestUtils.test.ts | 54 +++++++++++----------- src/browser/Types.ts | 20 ++++---- src/browser/Viewport.ts | 6 +-- src/browser/public/Terminal.ts | 28 +++++------ src/browser/renderer/shared/Types.ts | 4 +- src/browser/services/CoreBrowserService.ts | 4 +- src/browser/services/Services.ts | 26 +++++------ src/common/CoreTerminal.ts | 14 +++--- src/common/Event.ts | 2 +- src/common/TestUtils.test.ts | 20 ++++---- src/common/Types.ts | 12 ++--- src/common/buffer/Types.ts | 4 +- src/common/services/Services.ts | 24 +++++----- src/headless/Terminal.ts | 12 ++--- src/headless/public/Terminal.ts | 22 ++++----- 19 files changed, 148 insertions(+), 148 deletions(-) diff --git a/addons/addon-webgl/src/Types.ts b/addons/addon-webgl/src/Types.ts index 3e734a0d..67c9408d 100644 --- a/addons/addon-webgl/src/Types.ts +++ b/addons/addon-webgl/src/Types.ts @@ -7,7 +7,7 @@ import { FontWeight } from '@xterm/xterm'; import { IColorSet } from 'browser/Types'; import { ISelectionRenderModel } from 'browser/renderer/shared/Types'; import { CursorInactiveStyle, CursorStyle, type IDisposable } from 'common/Types'; -import type { Event } from 'common/Event'; +import type { IEvent } from 'common/Event'; export interface IRenderModel { cells: Uint32Array; @@ -58,8 +58,8 @@ export interface ICharAtlasConfig { export interface ITextureAtlas extends IDisposable { readonly pages: { canvas: HTMLCanvasElement, version: number }[]; - onAddTextureAtlasCanvas: Event; - onRemoveTextureAtlasCanvas: Event; + onAddTextureAtlasCanvas: IEvent; + onRemoveTextureAtlasCanvas: IEvent; /** * Warm up the texture atlas, adding common glyphs to avoid slowing early frame. diff --git a/addons/addon-webgl/src/WebglAddon.ts b/addons/addon-webgl/src/WebglAddon.ts index 0bc24c90..7dc3ed35 100644 --- a/addons/addon-webgl/src/WebglAddon.ts +++ b/addons/addon-webgl/src/WebglAddon.ts @@ -13,7 +13,7 @@ import { ICoreService, IDecorationService, ILogService, IOptionsService } from ' import { IWebGL2RenderingContext } from './Types'; import { WebglRenderer } from './WebglRenderer'; import { setTraceLogger } from 'common/services/LogService'; -import { Emitter, Event } from 'common/Event'; +import { Emitter, EventUtils } from 'common/Event'; export class WebglAddon extends Disposable implements ITerminalAddon , IWebglApi { private _terminal?: Terminal; @@ -85,10 +85,10 @@ export class WebglAddon extends Disposable implements ITerminalAddon , IWebglApi this._customGlyphs, this._preserveDrawingBuffer )); - this._register(Event.forward(this._renderer.onContextLoss, this._onContextLoss)); - this._register(Event.forward(this._renderer.onChangeTextureAtlas, this._onChangeTextureAtlas)); - this._register(Event.forward(this._renderer.onAddTextureAtlasCanvas, this._onAddTextureAtlasCanvas)); - this._register(Event.forward(this._renderer.onRemoveTextureAtlasCanvas, this._onRemoveTextureAtlasCanvas)); + this._register(EventUtils.forward(this._renderer.onContextLoss, this._onContextLoss)); + this._register(EventUtils.forward(this._renderer.onChangeTextureAtlas, this._onChangeTextureAtlas)); + this._register(EventUtils.forward(this._renderer.onAddTextureAtlasCanvas, this._onAddTextureAtlasCanvas)); + this._register(EventUtils.forward(this._renderer.onRemoveTextureAtlasCanvas, this._onRemoveTextureAtlasCanvas)); renderService.setRenderer(this._renderer); this._register(toDisposable(() => { diff --git a/addons/addon-webgl/src/WebglRenderer.ts b/addons/addon-webgl/src/WebglRenderer.ts index 1bdde448..05af6527 100644 --- a/addons/addon-webgl/src/WebglRenderer.ts +++ b/addons/addon-webgl/src/WebglRenderer.ts @@ -22,7 +22,7 @@ import { COMBINED_CHAR_BIT_MASK, RENDER_MODEL_BG_OFFSET, RENDER_MODEL_EXT_OFFSET import { IWebGL2RenderingContext, type ITextureAtlas } from './Types'; import { LinkRenderLayer } from './renderLayer/LinkRenderLayer'; import { IRenderLayer } from './renderLayer/Types'; -import { Emitter, Event } from 'common/Event'; +import { Emitter, EventUtils } from 'common/Event'; import { addDisposableListener } from 'vs/base/browser/dom'; import { combinedDisposable, Disposable, MutableDisposable, toDisposable } from 'common/Lifecycle'; import { createRenderDimensions } from 'browser/renderer/shared/RendererUtils'; @@ -290,8 +290,8 @@ export class WebglRenderer extends Disposable implements IRenderer { if (this._charAtlas !== atlas) { this._onChangeTextureAtlas.fire(atlas.pages[0].canvas); this._charAtlasDisposable.value = combinedDisposable( - Event.forward(atlas.onAddTextureAtlasCanvas, this._onAddTextureAtlasCanvas), - Event.forward(atlas.onRemoveTextureAtlasCanvas, this._onRemoveTextureAtlasCanvas) + EventUtils.forward(atlas.onAddTextureAtlasCanvas, this._onAddTextureAtlasCanvas), + EventUtils.forward(atlas.onRemoveTextureAtlasCanvas, this._onRemoveTextureAtlasCanvas) ); } this._charAtlas = atlas; diff --git a/src/browser/CoreBrowserTerminal.ts b/src/browser/CoreBrowserTerminal.ts index f743bd00..869a545a 100644 --- a/src/browser/CoreBrowserTerminal.ts +++ b/src/browser/CoreBrowserTerminal.ts @@ -55,7 +55,7 @@ import { IDecorationService } from 'common/services/Services'; import { WindowsOptionsReportType } from '../common/InputHandler'; import { AccessibilityManager } from './AccessibilityManager'; import { Linkifier } from './Linkifier'; -import { Emitter, Event } from 'common/Event'; +import { Emitter, EventUtils, type IEvent } from 'common/Event'; import { addDisposableListener } from 'vs/base/browser/dom'; import { MutableDisposable, toDisposable } from 'common/Lifecycle'; @@ -135,15 +135,15 @@ export class CoreBrowserTerminal extends CoreTerminal implements ITerminal { public readonly onBell = this._onBell.event; private _onFocus = this._register(new Emitter()); - public get onFocus(): Event { return this._onFocus.event; } + public get onFocus(): IEvent { return this._onFocus.event; } private _onBlur = this._register(new Emitter()); - public get onBlur(): Event { return this._onBlur.event; } + public get onBlur(): IEvent { return this._onBlur.event; } private _onA11yCharEmitter = this._register(new Emitter()); - public get onA11yChar(): Event { return this._onA11yCharEmitter.event; } + public get onA11yChar(): IEvent { return this._onA11yCharEmitter.event; } private _onA11yTabEmitter = this._register(new Emitter()); - public get onA11yTab(): Event { return this._onA11yTabEmitter.event; } + public get onA11yTab(): IEvent { return this._onA11yTabEmitter.event; } private _onWillOpen = this._register(new Emitter()); - public get onWillOpen(): Event { return this._onWillOpen.event; } + public get onWillOpen(): IEvent { return this._onWillOpen.event; } private readonly _onDimensionsChange = this._register(new Emitter()); public readonly onDimensionsChange = this._onDimensionsChange.event; @@ -187,10 +187,10 @@ export class CoreBrowserTerminal extends CoreTerminal implements ITerminal { this._register(this._inputHandler.onRequestReset(() => this.reset())); this._register(this._inputHandler.onRequestWindowsOptionsReport(type => this._reportWindowsOptions(type))); this._register(this._inputHandler.onColor((event) => this._handleColorEvent(event))); - this._register(Event.forward(this._inputHandler.onCursorMove, this._onCursorMove)); - this._register(Event.forward(this._inputHandler.onTitleChange, this._onTitleChange)); - this._register(Event.forward(this._inputHandler.onA11yChar, this._onA11yCharEmitter)); - this._register(Event.forward(this._inputHandler.onA11yTab, this._onA11yTabEmitter)); + this._register(EventUtils.forward(this._inputHandler.onCursorMove, this._onCursorMove)); + this._register(EventUtils.forward(this._inputHandler.onTitleChange, this._onTitleChange)); + this._register(EventUtils.forward(this._inputHandler.onA11yChar, this._onA11yCharEmitter)); + this._register(EventUtils.forward(this._inputHandler.onA11yTab, this._onA11yTabEmitter)); // Setup listeners this._register(this._bufferService.onResize(e => this._afterResize(e.cols, e.rows))); @@ -566,7 +566,7 @@ export class CoreBrowserTerminal extends CoreTerminal implements ITerminal { this.textarea!.focus(); this.textarea!.select(); })); - this._register(Event.any( + this._register(EventUtils.any( this._onScroll.event, this._inputHandler.onScroll )(() => { diff --git a/src/browser/TestUtils.test.ts b/src/browser/TestUtils.test.ts index 2d83ae53..76163bad 100644 --- a/src/browser/TestUtils.test.ts +++ b/src/browser/TestUtils.test.ts @@ -18,7 +18,7 @@ import { AttributeData } from 'common/buffer/AttributeData'; import { ISelectionRedrawRequestEvent, ISelectionRequestScrollLinesEvent } from 'browser/selection/Types'; import { css } from 'common/Color'; import { createRenderDimensions } from 'browser/renderer/shared/RendererUtils'; -import { Emitter, type Event } from 'common/Event'; +import { Emitter, type IEvent } from 'common/Event'; export class TestTerminal extends CoreBrowserTerminal { public get curAttrData(): IAttributeData { return (this as any)._inputHandler._curAttrData; } @@ -30,24 +30,24 @@ export class TestTerminal extends CoreBrowserTerminal { } export class MockTerminal implements ITerminal { - public onBlur!: Event; - public onFocus!: Event; - public onA11yChar!: Event; - public onWriteParsed!: Event; - public onA11yTab!: Event; - public onCursorMove!: Event; - public onLineFeed!: Event; - public onSelectionChange!: Event; - public onData!: Event; - public onBinary!: Event; - public onTitleChange!: Event; - public onBell!: Event; - public onScroll!: Event; - public onWillOpen!: Event; - public onKey!: Event<{ key: string, domEvent: KeyboardEvent }>; - public onRender!: Event<{ start: number, end: number }>; - public onResize!: Event<{ cols: number, rows: number }>; - public onDimensionsChange!: Event; + public onBlur!: IEvent; + public onFocus!: IEvent; + public onA11yChar!: IEvent; + public onWriteParsed!: IEvent; + public onA11yTab!: IEvent; + public onCursorMove!: IEvent; + public onLineFeed!: IEvent; + public onSelectionChange!: IEvent; + public onData!: IEvent; + public onBinary!: IEvent; + public onTitleChange!: IEvent; + public onBell!: IEvent; + public onScroll!: IEvent; + public onWillOpen!: IEvent; + public onKey!: IEvent<{ key: string, domEvent: KeyboardEvent }>; + public onRender!: IEvent<{ start: number, end: number }>; + public onResize!: IEvent<{ cols: number, rows: number }>; + public onDimensionsChange!: IEvent; public dimensions: IRenderDimensionsApi | undefined; public markers!: IMarker[]; public linkifier: ILinkifier2 | undefined; @@ -273,9 +273,9 @@ export class MockBuffer implements IBuffer { } export class MockRenderer implements IRenderer { - public onRequestRedraw!: Event; - public onCanvasResize!: Event<{ width: number, height: number }>; - public onRender!: Event<{ start: number, end: number }>; + public onRequestRedraw!: IEvent; + public onCanvasResize!: IEvent<{ width: number, height: number }>; + public onRender!: IEvent<{ start: number, end: number }>; public dispose(): void { throw new Error('Method not implemented.'); } @@ -378,7 +378,7 @@ export class MockCoreBrowserService implements ICoreBrowserService { export class MockCharSizeService implements ICharSizeService { public serviceBrand: undefined; public get hasValidSize(): boolean { return this.width > 0 && this.height > 0; } - public onCharSizeChange: Event = new Emitter().event; + public onCharSizeChange: IEvent = new Emitter().event; constructor(public width: number, public height: number) {} public measure(): void {} } @@ -396,10 +396,10 @@ export class MockMouseService implements IMouseService { export class MockRenderService implements IRenderService { public serviceBrand: undefined; - public onDimensionsChange: Event = new Emitter().event; - public onRenderedViewportChange: Event<{ start: number, end: number }> = new Emitter<{ start: number, end: number }>().event; - public onRender: Event<{ start: number, end: number }> = new Emitter<{ start: number, end: number }>().event; - public onRefreshRequest: Event<{ start: number, end: number}> = new Emitter<{ start: number, end: number }>().event; + public onDimensionsChange: IEvent = new Emitter().event; + public onRenderedViewportChange: IEvent<{ start: number, end: number }> = new Emitter<{ start: number, end: number }>().event; + public onRender: IEvent<{ start: number, end: number }> = new Emitter<{ start: number, end: number }>().event; + public onRefreshRequest: IEvent<{ start: number, end: number}> = new Emitter<{ start: number, end: number }>().event; public dimensions: IRenderDimensions = createRenderDimensions(); public refreshRows(start: number, end: number): void { throw new Error('Method not implemented.'); diff --git a/src/browser/Types.ts b/src/browser/Types.ts index 5c840bff..f54e488c 100644 --- a/src/browser/Types.ts +++ b/src/browser/Types.ts @@ -7,7 +7,7 @@ import { CharData, IColor, ICoreTerminal, ITerminalOptions } from 'common/Types' import { IBuffer } from 'common/buffer/Types'; import { IDisposable, IRenderDimensions as IRenderDimensionsApi, Terminal as ITerminalApi } from '@xterm/xterm'; import { channels, css } from 'common/Color'; -import type { Event } from 'common/Event'; +import type { IEvent } from 'common/Event'; /** * A portion of the public API that are implemented identially internally and simply passed through. @@ -23,12 +23,12 @@ export interface ITerminal extends InternalPassthroughApis, ICoreTerminal { readonly dimensions: IRenderDimensionsApi | undefined; - onBlur: Event; - onFocus: Event; - onDimensionsChange: Event; - onA11yChar: Event; - onA11yTab: Event; - onWillOpen: Event; + onBlur: IEvent; + onFocus: IEvent; + onDimensionsChange: IEvent; + onA11yChar: IEvent; + onA11yTab: IEvent; + onWillOpen: IEvent; cancel(ev: MouseEvent | WheelEvent | KeyboardEvent | InputEvent, force?: boolean): boolean | void; } @@ -101,7 +101,7 @@ export interface IPartialColorSet { export interface IViewport extends IDisposable { scrollBarWidth: number; - readonly onRequestScrollLines: Event<{ amount: number, suppressScrollEvent: boolean }>; + readonly onRequestScrollLines: IEvent<{ amount: number, suppressScrollEvent: boolean }>; syncScrollArea(immediate?: boolean, force?: boolean): void; getLinesScrolled(ev: WheelEvent): number; getBufferElements(startLine: number, endLine?: number): { bufferElements: HTMLElement[], cursorElement?: HTMLElement }; @@ -131,8 +131,8 @@ export interface ILinkWithState { } export interface ILinkifier2 extends IDisposable { - onShowLinkUnderline: Event; - onHideLinkUnderline: Event; + onShowLinkUnderline: IEvent; + onHideLinkUnderline: IEvent; readonly currentLink: ILinkWithState | undefined; } diff --git a/src/browser/Viewport.ts b/src/browser/Viewport.ts index 33442976..2e1d8861 100644 --- a/src/browser/Viewport.ts +++ b/src/browser/Viewport.ts @@ -11,7 +11,7 @@ import { CoreMouseEventType } from 'common/Types'; import { addDisposableListener, scheduleAtNextAnimationFrame } from 'vs/base/browser/dom'; import { SmoothScrollableElement } from 'vs/base/browser/ui/scrollbar/scrollableElement'; import type { ScrollableElementChangeOptions } from 'vs/base/browser/ui/scrollbar/scrollableElementOptions'; -import { Emitter, Event } from 'common/Event'; +import { Emitter, EventUtils } from 'common/Event'; import { Scrollable, ScrollbarVisibility, type ScrollEvent } from 'vs/base/common/scrollable'; import { Gesture, EventType as GestureEventType, type GestureEvent } from 'vs/base/browser/touch'; @@ -71,7 +71,7 @@ export class Viewport extends Disposable { })); this._scrollableElement.setScrollDimensions({ height: 0, scrollHeight: 0 }); - this._register(Event.runAndSubscribe(themeService.onChangeColors, () => { + this._register(EventUtils.runAndSubscribe(themeService.onChangeColors, () => { element.style.backgroundColor = themeService.colors.background.css; this._scrollableElement.getDomNode().style.backgroundColor = themeService.colors.background.css; })); @@ -81,7 +81,7 @@ export class Viewport extends Disposable { this._styleElement = coreBrowserService.mainDocument.createElement('style'); screenElement.appendChild(this._styleElement); this._register(toDisposable(() => this._styleElement.remove())); - this._register(Event.runAndSubscribe(themeService.onChangeColors, () => { + this._register(EventUtils.runAndSubscribe(themeService.onChangeColors, () => { this._styleElement.textContent = [ `.xterm .xterm-scrollable-element > .scrollbar > .slider {`, ` background: ${themeService.colors.scrollbarSliderBackground.css};`, diff --git a/src/browser/public/Terminal.ts b/src/browser/public/Terminal.ts index 16006905..6b4cdee2 100644 --- a/src/browser/public/Terminal.ts +++ b/src/browser/public/Terminal.ts @@ -13,7 +13,7 @@ import { BufferNamespaceApi } from 'common/public/BufferNamespaceApi'; import { ParserApi } from 'common/public/ParserApi'; import { UnicodeApi } from 'common/public/UnicodeApi'; import { IBufferNamespace as IBufferNamespaceApi, IDecoration, IDecorationOptions, IDisposable, ILinkProvider, ILocalizableStrings, IMarker, IModes, IParser, IRenderDimensions, ITerminalAddon, Terminal as ITerminalApi, ITerminalInitOnlyOptions, IUnicodeHandling } from '@xterm/xterm'; -import type { Event } from 'common/Event'; +import type { IEvent } from 'common/Event'; /** * The set of options that only have an effect when set in the Terminal constructor. @@ -68,19 +68,19 @@ export class Terminal extends Disposable implements ITerminalApi { } } - public get onBell(): Event { return this._core.onBell; } - public get onBinary(): Event { return this._core.onBinary; } - public get onCursorMove(): Event { return this._core.onCursorMove; } - public get onData(): Event { return this._core.onData; } - public get onKey(): Event<{ key: string, domEvent: KeyboardEvent }> { return this._core.onKey; } - public get onLineFeed(): Event { return this._core.onLineFeed; } - public get onRender(): Event<{ start: number, end: number }> { return this._core.onRender; } - public get onResize(): Event<{ cols: number, rows: number }> { return this._core.onResize; } - public get onScroll(): Event { return this._core.onScroll; } - public get onSelectionChange(): Event { return this._core.onSelectionChange; } - public get onTitleChange(): Event { return this._core.onTitleChange; } - public get onWriteParsed(): Event { return this._core.onWriteParsed; } - public get onDimensionsChange(): Event { return this._core.onDimensionsChange; } + public get onBell(): IEvent { return this._core.onBell; } + public get onBinary(): IEvent { return this._core.onBinary; } + public get onCursorMove(): IEvent { return this._core.onCursorMove; } + public get onData(): IEvent { return this._core.onData; } + public get onKey(): IEvent<{ key: string, domEvent: KeyboardEvent }> { return this._core.onKey; } + public get onLineFeed(): IEvent { return this._core.onLineFeed; } + public get onRender(): IEvent<{ start: number, end: number }> { return this._core.onRender; } + public get onResize(): IEvent<{ cols: number, rows: number }> { return this._core.onResize; } + public get onScroll(): IEvent { return this._core.onScroll; } + public get onSelectionChange(): IEvent { return this._core.onSelectionChange; } + public get onTitleChange(): IEvent { return this._core.onTitleChange; } + public get onWriteParsed(): IEvent { return this._core.onWriteParsed; } + public get onDimensionsChange(): IEvent { return this._core.onDimensionsChange; } public get element(): HTMLElement | undefined { return this._core.element; } public get parser(): IParser { diff --git a/src/browser/renderer/shared/Types.ts b/src/browser/renderer/shared/Types.ts index 05f462a7..f86cd4fe 100644 --- a/src/browser/renderer/shared/Types.ts +++ b/src/browser/renderer/shared/Types.ts @@ -6,7 +6,7 @@ import { Terminal } from '@xterm/xterm'; import { ITerminal } from 'browser/Types'; import { IDisposable } from 'common/Types'; -import type { Event } from 'common/Event'; +import type { IEvent } from 'common/Event'; export interface IDimensions { width: number; @@ -57,7 +57,7 @@ export interface IRenderer extends IDisposable { * Fires when the renderer is requesting to be redrawn on the next animation * frame but is _not_ a result of content changing (eg. selection changes). */ - readonly onRequestRedraw: Event; + readonly onRequestRedraw: IEvent; dispose(): void; handleDevicePixelRatioChange(): void; diff --git a/src/browser/services/CoreBrowserService.ts b/src/browser/services/CoreBrowserService.ts index 562793f2..4e5d8b71 100644 --- a/src/browser/services/CoreBrowserService.ts +++ b/src/browser/services/CoreBrowserService.ts @@ -4,7 +4,7 @@ */ import { ICoreBrowserService } from './Services'; -import { Emitter, Event } from 'common/Event'; +import { Emitter, EventUtils } from 'common/Event'; import { addDisposableListener } from 'vs/base/browser/dom'; import { Disposable, MutableDisposable, toDisposable } from 'common/Lifecycle'; @@ -29,7 +29,7 @@ export class CoreBrowserService extends Disposable implements ICoreBrowserServic // Monitor device pixel ratio this._register(this.onWindowChange(w => this._screenDprMonitor.setWindow(w))); - this._register(Event.forward(this._screenDprMonitor.onDprChange, this._onDprChange)); + this._register(EventUtils.forward(this._screenDprMonitor.onDprChange, this._onDprChange)); this._register(addDisposableListener(this._textarea, 'focus', () => this._isFocused = true)); this._register(addDisposableListener(this._textarea, 'blur', () => this._isFocused = false)); diff --git a/src/browser/services/Services.ts b/src/browser/services/Services.ts index af9211df..1c82b28b 100644 --- a/src/browser/services/Services.ts +++ b/src/browser/services/Services.ts @@ -8,7 +8,7 @@ import { IColorSet, ILink, ReadonlyColorSet } from 'browser/Types'; import { ISelectionRedrawRequestEvent as ISelectionRequestRedrawEvent, ISelectionRequestScrollLinesEvent } from 'browser/selection/Types'; import { createDecorator } from 'common/services/ServiceRegistry'; import { AllColorIndex, IDisposable, IKeyboardResult } from 'common/Types'; -import type { Event } from 'common/Event'; +import type { IEvent } from 'common/Event'; export const ICharSizeService = createDecorator('CharSizeService'); export interface ICharSizeService { @@ -18,7 +18,7 @@ export interface ICharSizeService { readonly height: number; readonly hasValidSize: boolean; - readonly onCharSizeChange: Event; + readonly onCharSizeChange: IEvent; measure(): void; } @@ -29,8 +29,8 @@ export interface ICoreBrowserService { readonly isFocused: boolean; - readonly onDprChange: Event; - readonly onWindowChange: Event; + readonly onDprChange: IEvent; + readonly onWindowChange: IEvent; /** * Gets or sets the parent window that the terminal is rendered into. DOM and rendering APIs (e.g. @@ -61,17 +61,17 @@ export const IRenderService = createDecorator('RenderService'); export interface IRenderService extends IDisposable { serviceBrand: undefined; - onDimensionsChange: Event; + onDimensionsChange: IEvent; /** * Fires when buffer changes are rendered. This does not fire when only cursor * or selections are rendered. */ - onRenderedViewportChange: Event<{ start: number, end: number }>; + onRenderedViewportChange: IEvent<{ start: number, end: number }>; /** * Fires on render */ - onRender: Event<{ start: number, end: number }>; - onRefreshRequest: Event<{ start: number, end: number }>; + onRender: IEvent<{ start: number, end: number }>; + onRefreshRequest: IEvent<{ start: number, end: number }>; dimensions: IRenderDimensions; @@ -101,10 +101,10 @@ export interface ISelectionService { readonly selectionStart: [number, number] | undefined; readonly selectionEnd: [number, number] | undefined; - readonly onLinuxMouseSelection: Event; - readonly onRequestRedraw: Event; - readonly onRequestScrollLines: Event; - readonly onSelectionChange: Event; + readonly onLinuxMouseSelection: IEvent; + readonly onRequestRedraw: IEvent; + readonly onRequestScrollLines: IEvent; + readonly onSelectionChange: IEvent; disable(): void; enable(): void; @@ -136,7 +136,7 @@ export interface IThemeService { readonly colors: ReadonlyColorSet; - readonly onChangeColors: Event; + readonly onChangeColors: IEvent; restoreColor(slot?: AllColorIndex): void; /** diff --git a/src/common/CoreTerminal.ts b/src/common/CoreTerminal.ts index cff8558e..d630013c 100644 --- a/src/common/CoreTerminal.ts +++ b/src/common/CoreTerminal.ts @@ -37,7 +37,7 @@ import { IBufferSet } from 'common/buffer/Types'; import { InputHandler } from 'common/InputHandler'; import { WriteBuffer } from 'common/input/WriteBuffer'; import { OscLinkService } from 'common/services/OscLinkService'; -import { Emitter, Event } from 'common/Event'; +import { Emitter, EventUtils, type IEvent } from 'common/Event'; import { Disposable, MutableDisposable, toDisposable } from 'common/Lifecycle'; // Only trigger this warning a single time per session @@ -78,7 +78,7 @@ export abstract class CoreTerminal extends Disposable implements ICoreTerminal { */ protected _onScrollApi?: Emitter; protected _onScroll = this._register(new Emitter()); - public get onScroll(): Event { + public get onScroll(): IEvent { if (!this._onScrollApi) { this._onScrollApi = this._register(new Emitter()); this._onScroll.event(ev => { @@ -125,12 +125,12 @@ export abstract class CoreTerminal extends Disposable implements ICoreTerminal { // Register input handler and handle/forward events this._inputHandler = this._register(new InputHandler(this._bufferService, this._charsetService, this.coreService, this._logService, this.optionsService, this._oscLinkService, this.coreMouseService, this.unicodeService)); - this._register(Event.forward(this._inputHandler.onLineFeed, this._onLineFeed)); + this._register(EventUtils.forward(this._inputHandler.onLineFeed, this._onLineFeed)); // Setup listeners - this._register(Event.forward(this._bufferService.onResize, this._onResize)); - this._register(Event.forward(this.coreService.onData, this._onData)); - this._register(Event.forward(this.coreService.onBinary, this._onBinary)); + this._register(EventUtils.forward(this._bufferService.onResize, this._onResize)); + this._register(EventUtils.forward(this.coreService.onData, this._onData)); + this._register(EventUtils.forward(this.coreService.onBinary, this._onBinary)); this._register(this.coreService.onRequestScrollToBottom(() => this.scrollToBottom(true))); this._register(this.coreService.onUserInput(() => this._writeBuffer.handleUserInput())); this._register(this.optionsService.onMultipleOptionChange(['windowsPty'], () => this._handleWindowsPtyOptionChange())); @@ -140,7 +140,7 @@ export abstract class CoreTerminal extends Disposable implements ICoreTerminal { })); // Setup WriteBuffer this._writeBuffer = this._register(new WriteBuffer((data, promiseResult) => this._inputHandler.parse(data, promiseResult))); - this._register(Event.forward(this._writeBuffer.onWriteParsed, this._onWriteParsed)); + this._register(EventUtils.forward(this._writeBuffer.onWriteParsed, this._onWriteParsed)); } public write(data: string | Uint8Array, callback?: () => void): void { diff --git a/src/common/Event.ts b/src/common/Event.ts index 44146e76..9ea39b9c 100644 --- a/src/common/Event.ts +++ b/src/common/Event.ts @@ -68,7 +68,7 @@ export class Emitter { } } -export namespace Event { +export namespace EventUtils { export function forward(from: IEvent, to: Emitter): IDisposable { return from(e => to.fire(e)); } diff --git a/src/common/TestUtils.test.ts b/src/common/TestUtils.test.ts index cbe4fe58..137174e8 100644 --- a/src/common/TestUtils.test.ts +++ b/src/common/TestUtils.test.ts @@ -12,14 +12,14 @@ import { BufferSet } from 'common/buffer/BufferSet'; import { IDecPrivateModes, ICoreMouseEvent, CoreMouseEventType, ICharset, IModes, IAttributeData, IOscLinkData, IDisposable } from 'common/Types'; import { UnicodeV6 } from 'common/input/UnicodeV6'; import { IDecorationOptions, IDecoration } from '@xterm/xterm'; -import { Emitter, type Event } from 'common/Event'; +import { Emitter, type IEvent } from 'common/Event'; export class MockBufferService implements IBufferService { public serviceBrand: any; public get buffer(): IBuffer { return this.buffers.active; } public buffers: IBufferSet = {} as any; - public onResize: Event = new Emitter().event; - public onScroll: Event = new Emitter().event; + public onResize: IEvent = new Emitter().event; + public onScroll: IEvent = new Emitter().event; private readonly _onScroll = new Emitter(); public isUserScrolling: boolean = false; constructor( @@ -67,7 +67,7 @@ export class MockCoreMouseService implements ICoreMouseService { public addProtocol(name: string): void { } public reset(): void { } public triggerMouseEvent(event: ICoreMouseEvent): boolean { return false; } - public onProtocolChange: Event = new Emitter().event; + public onProtocolChange: IEvent = new Emitter().event; public explainEvents(events: CoreMouseEventType): { [event: string]: boolean } { throw new Error('Method not implemented.'); } @@ -122,10 +122,10 @@ export class MockCoreService implements ICoreService { mainStack: [] as number[], altStack: [] as number[] }; - public onData: Event = new Emitter().event; - public onUserInput: Event = new Emitter().event; - public onBinary: Event = new Emitter().event; - public onRequestScrollToBottom: Event = new Emitter().event; + public onData: IEvent = new Emitter().event; + public onUserInput: IEvent = new Emitter().event; + public onBinary: IEvent = new Emitter().event; + public onRequestScrollToBottom: IEvent = new Emitter().event; public reset(): void { } public triggerDataEvent(data: string, wasUserInput?: boolean): void { } public triggerBinaryEvent(data: string): void { } @@ -145,7 +145,7 @@ export class MockOptionsService implements IOptionsService { public serviceBrand: any; public readonly rawOptions: Required = clone(DEFAULT_OPTIONS); public options: Required = this.rawOptions; - public onOptionChange: Event = new Emitter().event; + public onOptionChange: IEvent = new Emitter().event; constructor(testOptions?: Partial) { if (testOptions) { for (const key of Object.keys(testOptions)) { @@ -197,7 +197,7 @@ export class MockUnicodeService implements IUnicodeService { } public versions: string[] = []; public activeVersion: string = ''; - public onChange: Event = new Emitter().event; + public onChange: IEvent = new Emitter().event; public wcwidth = (codepoint: number): UnicodeCharWidth => this._provider.wcwidth(codepoint); public charProperties(codepoint: number, preceding: UnicodeCharProperties): UnicodeCharProperties { let width = this.wcwidth(codepoint); diff --git a/src/common/Types.ts b/src/common/Types.ts index aeeee5b2..ec10ed55 100644 --- a/src/common/Types.ts +++ b/src/common/Types.ts @@ -9,7 +9,7 @@ import { IBufferSet } from 'common/buffer/Types'; import { IParams } from 'common/parser/Types'; import { ICoreMouseService, ICoreService, IOptionsService, IUnicodeService } from 'common/services/Services'; import { IFunctionIdentifier, ITerminalOptions as IPublicTerminalOptions } from '@xterm/xterm'; -import type { Emitter, Event } from 'common/Event'; +import type { Emitter, IEvent } from 'common/Event'; export interface ICoreTerminal { coreMouseService: ICoreMouseService; @@ -68,11 +68,11 @@ export interface ICircularList { isFull: boolean; onDeleteEmitter: Emitter; - onDelete: Event; + onDelete: IEvent; onInsertEmitter: Emitter; - onInsert: Event; + onInsert: IEvent; onTrimEmitter: Emitter; - onTrim: Event; + onTrim: IEvent; get(index: number): T | undefined; set(index: number, value: T): void; @@ -258,7 +258,7 @@ export interface IMarker extends IDisposable { readonly id: number; readonly isDisposed: boolean; readonly line: number; - onDispose: Event; + onDispose: IEvent; } export interface IModes { insertMode: boolean; @@ -467,7 +467,7 @@ export type IColorEvent = (IColorReportRequest | IColorSetRequest | IColorRestor * Calls the parser and handles actions generated by the parser. */ export interface IInputHandler { - onTitleChange: Event; + onTitleChange: IEvent; parse(data: string | Uint8Array, promiseResult?: boolean): void | Promise; print(data: Uint32Array, start: number, end: number): void; diff --git a/src/common/buffer/Types.ts b/src/common/buffer/Types.ts index b6e83586..85dd68ee 100644 --- a/src/common/buffer/Types.ts +++ b/src/common/buffer/Types.ts @@ -4,7 +4,7 @@ */ import { IAttributeData, ICircularList, IBufferLine, ICellData, IMarker, ICharset, IDisposable } from 'common/Types'; -import type { Event } from 'common/Event'; +import type { IEvent } from 'common/Event'; // BufferIndex denotes a position in the buffer: [rowIndex, colIndex] export type BufferIndex = [number, number]; @@ -46,7 +46,7 @@ export interface IBufferSet extends IDisposable { normal: IBuffer; active: IBuffer; - onBufferActivate: Event<{ activeBuffer: IBuffer, inactiveBuffer: IBuffer }>; + onBufferActivate: IEvent<{ activeBuffer: IBuffer, inactiveBuffer: IBuffer }>; activateNormalBuffer(): void; activateAltBuffer(fillAttr?: IAttributeData): void; diff --git a/src/common/services/Services.ts b/src/common/services/Services.ts index 737dcd0d..30ad6048 100644 --- a/src/common/services/Services.ts +++ b/src/common/services/Services.ts @@ -7,7 +7,7 @@ import { IDecoration, IDecorationOptions, ILinkHandler, ILogger, IWindowsPty, ty import { CoreMouseEncoding, CoreMouseEventType, CursorInactiveStyle, CursorStyle, IAttributeData, ICharset, IColor, ICoreMouseEvent, ICoreMouseProtocol, IDecPrivateModes, IDisposable, IKittyKeyboardState, IModes, IOscLinkData, IWindowOptions } from 'common/Types'; import { IBuffer, IBufferSet } from 'common/buffer/Types'; import { createDecorator } from 'common/services/ServiceRegistry'; -import type { Emitter, Event } from 'common/Event'; +import type { Emitter, IEvent } from 'common/Event'; export const IBufferService = createDecorator('BufferService'); export interface IBufferService { @@ -18,8 +18,8 @@ export interface IBufferService { readonly buffer: IBuffer; readonly buffers: IBufferSet; isUserScrolling: boolean; - onResize: Event; - onScroll: Event; + onResize: IEvent; + onScroll: IEvent; scroll(eraseAttr: IAttributeData, isWrapped?: boolean): void; scrollLines(disp: number, suppressScrollEvent?: boolean): void; resize(cols: number, rows: number): void; @@ -59,7 +59,7 @@ export interface ICoreMouseService { /** * Event to announce changes in mouse tracking. */ - onProtocolChange: Event; + onProtocolChange: IEvent; /** * Human readable version of mouse events. @@ -87,10 +87,10 @@ export interface ICoreService { readonly decPrivateModes: IDecPrivateModes; readonly kittyKeyboard: IKittyKeyboardState; - readonly onData: Event; - readonly onUserInput: Event; - readonly onBinary: Event; - readonly onRequestScrollToBottom: Event; + readonly onData: IEvent; + readonly onUserInput: IEvent; + readonly onBinary: IEvent; + readonly onRequestScrollToBottom: IEvent; reset(): void; @@ -201,7 +201,7 @@ export interface IOptionsService { /** * Adds an event listener for when any option changes. */ - readonly onOptionChange: Event; + readonly onOptionChange: IEvent; /** * Adds an event listener for when a specific option changes, this is a convenience method that is @@ -364,7 +364,7 @@ export interface IUnicodeService { /** Currently active version. */ activeVersion: string; /** Event triggered, when activate version changed. */ - readonly onChange: Event; + readonly onChange: IEvent; /** * Unicode version dependent @@ -389,8 +389,8 @@ export const IDecorationService = createDecorator('Decoratio export interface IDecorationService extends IDisposable { serviceBrand: undefined; readonly decorations: IterableIterator; - readonly onDecorationRegistered: Event; - readonly onDecorationRemoved: Event; + readonly onDecorationRegistered: IEvent; + readonly onDecorationRemoved: IEvent; registerDecoration(decorationOptions: IDecorationOptions): IDecoration | undefined; reset(): void; /** diff --git a/src/headless/Terminal.ts b/src/headless/Terminal.ts index 52618e86..cc8b152b 100644 --- a/src/headless/Terminal.ts +++ b/src/headless/Terminal.ts @@ -25,7 +25,7 @@ import { DEFAULT_ATTR_DATA } from 'common/buffer/BufferLine'; import { IBuffer } from 'common/buffer/Types'; import { CoreTerminal } from 'common/CoreTerminal'; import { IMarker, ITerminalOptions } from 'common/Types'; -import { Emitter, Event } from 'common/Event'; +import { Emitter, EventUtils } from 'common/Event'; export class Terminal extends CoreTerminal { private readonly _onBell = this._register(new Emitter()); @@ -49,11 +49,11 @@ export class Terminal extends CoreTerminal { // Setup InputHandler listeners this._register(this._inputHandler.onRequestBell(() => this.bell())); this._register(this._inputHandler.onRequestReset(() => this.reset())); - this._register(Event.forward(this._inputHandler.onCursorMove, this._onCursorMove)); - this._register(Event.forward(this._inputHandler.onTitleChange, this._onTitleChange)); - this._register(Event.forward(this._inputHandler.onA11yChar, this._onA11yCharEmitter)); - this._register(Event.forward(this._inputHandler.onA11yTab, this._onA11yTabEmitter)); - this._register(Event.forward(Event.map(this._inputHandler.onRequestRefreshRows, e => ({ start: e?.start ?? 0, end: e?.end ?? this.rows - 1 })), this._onRender)); + this._register(EventUtils.forward(this._inputHandler.onCursorMove, this._onCursorMove)); + this._register(EventUtils.forward(this._inputHandler.onTitleChange, this._onTitleChange)); + this._register(EventUtils.forward(this._inputHandler.onA11yChar, this._onA11yCharEmitter)); + this._register(EventUtils.forward(this._inputHandler.onA11yTab, this._onA11yTabEmitter)); + this._register(EventUtils.forward(EventUtils.map(this._inputHandler.onRequestRefreshRows, e => ({ start: e?.start ?? 0, end: e?.end ?? this.rows - 1 })), this._onRender)); } /** diff --git a/src/headless/public/Terminal.ts b/src/headless/public/Terminal.ts index 17b143fa..cdb94180 100644 --- a/src/headless/public/Terminal.ts +++ b/src/headless/public/Terminal.ts @@ -11,7 +11,7 @@ import { Terminal as TerminalCore } from 'headless/Terminal'; import { AddonManager } from 'common/public/AddonManager'; import { ITerminalOptions } from 'common/Types'; import { Disposable } from 'common/Lifecycle'; -import type { Event } from 'common/Event'; +import type { IEvent } from 'common/Event'; /** * The set of options that only have an effect when set in the Terminal constructor. */ @@ -72,16 +72,16 @@ export class Terminal extends Disposable implements ITerminalApi { } } - public get onBell(): Event { return this._core.onBell; } - public get onBinary(): Event { return this._core.onBinary; } - public get onCursorMove(): Event { return this._core.onCursorMove; } - public get onData(): Event { return this._core.onData; } - public get onLineFeed(): Event { return this._core.onLineFeed; } - public get onRender(): Event<{ start: number, end: number }> { return this._core.onRender; } - public get onResize(): Event<{ cols: number, rows: number }> { return this._core.onResize; } - public get onScroll(): Event { return this._core.onScroll; } - public get onTitleChange(): Event { return this._core.onTitleChange; } - public get onWriteParsed(): Event { return this._core.onWriteParsed; } + public get onBell(): IEvent { return this._core.onBell; } + public get onBinary(): IEvent { return this._core.onBinary; } + public get onCursorMove(): IEvent { return this._core.onCursorMove; } + public get onData(): IEvent { return this._core.onData; } + public get onLineFeed(): IEvent { return this._core.onLineFeed; } + public get onRender(): IEvent<{ start: number, end: number }> { return this._core.onRender; } + public get onResize(): IEvent<{ cols: number, rows: number }> { return this._core.onResize; } + public get onScroll(): IEvent { return this._core.onScroll; } + public get onTitleChange(): IEvent { return this._core.onTitleChange; } + public get onWriteParsed(): IEvent { return this._core.onWriteParsed; } public get parser(): IParser { if (!this._parser) {