waveterm/xterm.js
0
0
Fork 0
mirror of https://github.com/wavetermdev/xterm.js.git synced 2026-08-05 13:43:48 -07:00
Code Issues Packages Projects Releases Wiki Activity

More adoption of MutableDisposable

Browse Source
This commit is contained in:
Daniel Imms
2023-08-27 06:55:16 -07:00
parent ec02bab97c
commit 57db72d287
4 changed files with 34 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files
addons/xterm-addon-search/src/SearchAddon.ts
+7 -12
View File
@@ -5,7 +5,7 @@
import { Terminal, IDisposable, ITerminalAddon, IDecoration } from 'xterm'; import { Terminal, IDisposable, ITerminalAddon, IDecoration } from 'xterm';
import { EventEmitter } from 'common/EventEmitter'; import { EventEmitter } from 'common/EventEmitter';
import { Disposable, toDisposable, disposeArray } from 'common/Lifecycle'; import { Disposable, toDisposable, disposeArray, MutableDisposable } from 'common/Lifecycle';
export interface ISearchOptions { export interface ISearchOptions {
regex?: boolean; regex?: boolean;
@@ -66,7 +66,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon {
private _cachedSearchTerm: string | undefined; private _cachedSearchTerm: string | undefined;
private _highlightedLines: Set<number> = new Set(); private _highlightedLines: Set<number> = new Set();
private _highlightDecorations: IHighlight[] = []; private _highlightDecorations: IHighlight[] = [];
private _selectedDecoration: IHighlight | undefined; private _selectedDecoration: MutableDisposable<IHighlight> = this.register(new MutableDisposable());
private _highlightLimit: number; private _highlightLimit: number;
private _lastSearchOptions: ISearchOptions | undefined; private _lastSearchOptions: ISearchOptions | undefined;
private _highlightTimeout: number | undefined; private _highlightTimeout: number | undefined;
@@ -110,7 +110,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon {
} }
public clearDecorations(retainCachedSearchTerm?: boolean): void { public clearDecorations(retainCachedSearchTerm?: boolean): void {
this.clearActiveDecoration(); this._selectedDecoration.clear();
disposeArray(this._highlightDecorations); disposeArray(this._highlightDecorations);
this._highlightDecorations = []; this._highlightDecorations = [];
this._highlightedLines.clear(); this._highlightedLines.clear();
@@ -119,11 +119,6 @@ export class SearchAddon extends Disposable implements ITerminalAddon {
} }
} }
public clearActiveDecoration(): void {
this._selectedDecoration?.dispose();
this._selectedDecoration = undefined;
}
/** /**
* Find the next instance of the term, then scroll to and select it. If it * Find the next instance of the term, then scroll to and select it. If it
* doesn't exist, do nothing. * doesn't exist, do nothing.
@@ -320,8 +315,8 @@ export class SearchAddon extends Disposable implements ITerminalAddon {
private _fireResults(searchOptions?: ISearchOptions): void { private _fireResults(searchOptions?: ISearchOptions): void {
if (searchOptions?.decorations) { if (searchOptions?.decorations) {
let resultIndex = -1; let resultIndex = -1;
if (this._selectedDecoration) { if (this._selectedDecoration.value) {
const selectedMatch = this._selectedDecoration.match; const selectedMatch = this._selectedDecoration.value.match;
for (let i = 0; i < this._highlightDecorations.length; i++) { for (let i = 0; i < this._highlightDecorations.length; i++) {
const match = this._highlightDecorations[i].match; const match = this._highlightDecorations[i].match;
if (match.row === selectedMatch.row && match.col === selectedMatch.col && match.size === selectedMatch.size) { if (match.row === selectedMatch.row && match.col === selectedMatch.col && match.size === selectedMatch.size) {
@@ -642,7 +637,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon {
*/ */
private _selectResult(result: ISearchResult | undefined, options?: ISearchDecorationOptions, noScroll?: boolean): boolean { private _selectResult(result: ISearchResult | undefined, options?: ISearchDecorationOptions, noScroll?: boolean): boolean {
const terminal = this._terminal!; const terminal = this._terminal!;
this.clearActiveDecoration(); this._selectedDecoration.clear();
if (!result) { if (!result) {
terminal.clearSelection(); terminal.clearSelection();
return false; return false;
@@ -666,7 +661,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon {
disposables.push(marker); disposables.push(marker);
disposables.push(decoration.onRender((e) => this._applyStyles(e, options.activeMatchBorder, true))); disposables.push(decoration.onRender((e) => this._applyStyles(e, options.activeMatchBorder, true)));
disposables.push(decoration.onDispose(() => disposeArray(disposables))); disposables.push(decoration.onDispose(() => disposeArray(disposables)));
this._selectedDecoration = { decoration, match: result, dispose() { decoration.dispose(); } }; this._selectedDecoration.value = { decoration, match: result, dispose() { decoration.dispose(); } };
} }
} }
} }
addons/xterm-addon-webgl/src/WebglRenderer.ts
+21 -24
View File
@@ -41,8 +41,8 @@ export class WebglRenderer extends Disposable implements IRenderer {
private _canvas: HTMLCanvasElement; private _canvas: HTMLCanvasElement;
private _gl: IWebGL2RenderingContext; private _gl: IWebGL2RenderingContext;
private _rectangleRenderer?: RectangleRenderer; private _rectangleRenderer: MutableDisposable<RectangleRenderer> = this.register(new MutableDisposable());
private _glyphRenderer?: GlyphRenderer; private _glyphRenderer: MutableDisposable<GlyphRenderer> = this.register(new MutableDisposable());
public readonly dimensions: IRenderDimensions; public readonly dimensions: IRenderDimensions;
@@ -128,7 +128,7 @@ export class WebglRenderer extends Disposable implements IRenderer {
this._core.screenElement!.appendChild(this._canvas); this._core.screenElement!.appendChild(this._canvas);
[this._rectangleRenderer, this._glyphRenderer] = this._initializeWebGLState(); [this._rectangleRenderer.value, this._glyphRenderer.value] = this._initializeWebGLState();
this._isAttached = this._coreBrowserService.window.document.body.contains(this._core.screenElement!); this._isAttached = this._coreBrowserService.window.document.body.contains(this._core.screenElement!);
@@ -182,10 +182,10 @@ export class WebglRenderer extends Disposable implements IRenderer {
this._core.screenElement!.style.width = `${this.dimensions.css.canvas.width}px`; this._core.screenElement!.style.width = `${this.dimensions.css.canvas.width}px`;
this._core.screenElement!.style.height = `${this.dimensions.css.canvas.height}px`; this._core.screenElement!.style.height = `${this.dimensions.css.canvas.height}px`;
this._rectangleRenderer?.setDimensions(this.dimensions); this._rectangleRenderer.value?.setDimensions(this.dimensions);
this._rectangleRenderer?.handleResize(); this._rectangleRenderer.value?.handleResize();
this._glyphRenderer?.setDimensions(this.dimensions); this._glyphRenderer.value?.setDimensions(this.dimensions);
this._glyphRenderer?.handleResize(); this._glyphRenderer.value?.handleResize();
this._refreshCharAtlas(); this._refreshCharAtlas();
@@ -241,17 +241,14 @@ export class WebglRenderer extends Disposable implements IRenderer {
* Initializes members dependent on WebGL context state. * Initializes members dependent on WebGL context state.
*/ */
private _initializeWebGLState(): [RectangleRenderer, GlyphRenderer] { private _initializeWebGLState(): [RectangleRenderer, GlyphRenderer] {
// Dispose any previous rectangle and glyph renderers before creating new ones. this._rectangleRenderer.value = new RectangleRenderer(this._terminal, this._gl, this.dimensions, this._themeService);
this._rectangleRenderer?.dispose(); this._glyphRenderer.value = new GlyphRenderer(this._terminal, this._gl, this.dimensions);
this._glyphRenderer?.dispose();
this._rectangleRenderer = this.register(new RectangleRenderer(this._terminal, this._gl, this.dimensions, this._themeService));
this._glyphRenderer = this.register(new GlyphRenderer(this._terminal, this._gl, this.dimensions));
// Update dimensions and acquire char atlas // Update dimensions and acquire char atlas
this.handleCharSizeChanged(); this.handleCharSizeChanged();
return [this._rectangleRenderer, this._glyphRenderer]; return [this._rectangleRenderer.value, this._glyphRenderer.value
];
} }
/** /**
@@ -284,7 +281,7 @@ export class WebglRenderer extends Disposable implements IRenderer {
} }
this._charAtlas = atlas; this._charAtlas = atlas;
this._charAtlas.warmUp(); this._charAtlas.warmUp();
this._glyphRenderer?.setAtlas(this._charAtlas); this._glyphRenderer.value?.setAtlas(this._charAtlas);
} }
/** /**
@@ -340,14 +337,14 @@ export class WebglRenderer extends Disposable implements IRenderer {
l.handleGridChanged(this._terminal, start, end); l.handleGridChanged(this._terminal, start, end);
} }
if (!this._glyphRenderer || !this._rectangleRenderer) { if (!this._glyphRenderer.value || !this._rectangleRenderer.value) {
return; return;
} }
// Tell renderer the frame is beginning // Tell renderer the frame is beginning
// upon a model clear also refresh the full viewport model // upon a model clear also refresh the full viewport model
// (also triggered by an atlas page merge, part of #4480) // (also triggered by an atlas page merge, part of #4480)
if (this._glyphRenderer.beginFrame()) { if (this._glyphRenderer.value.beginFrame()) {
this._clearModel(true); this._clearModel(true);
this._updateModel(0, this._terminal.rows - 1); this._updateModel(0, this._terminal.rows - 1);
} else { } else {
@@ -356,10 +353,10 @@ export class WebglRenderer extends Disposable implements IRenderer {
} }
// Render // Render
this._rectangleRenderer?.renderBackgrounds(); this._rectangleRenderer.value.renderBackgrounds();
this._glyphRenderer?.render(this._model); this._glyphRenderer.value.render(this._model);
if (!this._cursorBlinkStateManager.value || this._cursorBlinkStateManager.value.isCursorVisible) { if (!this._cursorBlinkStateManager.value || this._cursorBlinkStateManager.value.isCursorVisible) {
this._rectangleRenderer?.renderCursor(); this._rectangleRenderer.value.renderCursor();
} }
} }
@@ -502,7 +499,7 @@ export class WebglRenderer extends Disposable implements IRenderer {
this._model.cells[i + RENDER_MODEL_FG_OFFSET] = this._cellColorResolver.result.fg; this._model.cells[i + RENDER_MODEL_FG_OFFSET] = this._cellColorResolver.result.fg;
this._model.cells[i + RENDER_MODEL_EXT_OFFSET] = this._cellColorResolver.result.ext; this._model.cells[i + RENDER_MODEL_EXT_OFFSET] = this._cellColorResolver.result.ext;
this._glyphRenderer!.updateCell(x, y, code, this._cellColorResolver.result.bg, this._cellColorResolver.result.fg, this._cellColorResolver.result.ext, chars, lastBg); this._glyphRenderer.value!.updateCell(x, y, code, this._cellColorResolver.result.bg, this._cellColorResolver.result.fg, this._cellColorResolver.result.ext, chars, lastBg);
if (isJoined) { if (isJoined) {
// Restore work cell // Restore work cell
@@ -511,7 +508,7 @@ export class WebglRenderer extends Disposable implements IRenderer {
// Null out non-first cells // Null out non-first cells
for (x++; x < lastCharX; x++) { for (x++; x < lastCharX; x++) {
j = ((y * terminal.cols) + x) * RENDER_MODEL_INDICIES_PER_CELL; j = ((y * terminal.cols) + x) * RENDER_MODEL_INDICIES_PER_CELL;
this._glyphRenderer!.updateCell(x, y, NULL_CELL_CODE, 0, 0, 0, NULL_CELL_CHAR, 0); this._glyphRenderer.value!.updateCell(x, y, NULL_CELL_CODE, 0, 0, 0, NULL_CELL_CHAR, 0);
this._model.cells[j] = NULL_CELL_CODE; this._model.cells[j] = NULL_CELL_CODE;
this._model.cells[j + RENDER_MODEL_BG_OFFSET] = this._cellColorResolver.result.bg; this._model.cells[j + RENDER_MODEL_BG_OFFSET] = this._cellColorResolver.result.bg;
this._model.cells[j + RENDER_MODEL_FG_OFFSET] = this._cellColorResolver.result.fg; this._model.cells[j + RENDER_MODEL_FG_OFFSET] = this._cellColorResolver.result.fg;
@@ -521,9 +518,9 @@ export class WebglRenderer extends Disposable implements IRenderer {
} }
} }
if (modelUpdated) { if (modelUpdated) {
this._rectangleRenderer!.updateBackgrounds(this._model); this._rectangleRenderer.value!.updateBackgrounds(this._model);
} }
this._rectangleRenderer!.updateCursor(this._model); this._rectangleRenderer.value!.updateCursor(this._model);
} }
/** /**
addons/xterm-addon-webgl/src/renderLayer/BaseRenderLayer.ts
-1
View File
@@ -49,7 +49,6 @@ export abstract class BaseRenderLayer extends Disposable implements IRenderLayer
})); }));
this.register(toDisposable(() => { this.register(toDisposable(() => {
this._canvas.remove(); this._canvas.remove();
this._charAtlas?.dispose();
})); }));
} }
src/browser/Terminal.ts
+6 -7
View File
@@ -44,7 +44,7 @@ import { ThemeService } from 'browser/services/ThemeService';
import { color, rgba } from 'common/Color'; import { color, rgba } from 'common/Color';
import { CoreTerminal } from 'common/CoreTerminal'; import { CoreTerminal } from 'common/CoreTerminal';
import { EventEmitter, IEvent, forwardEvent } from 'common/EventEmitter'; import { EventEmitter, IEvent, forwardEvent } from 'common/EventEmitter';
import { toDisposable } from 'common/Lifecycle'; import { MutableDisposable, toDisposable } from 'common/Lifecycle';
import * as Browser from 'common/Platform'; import * as Browser from 'common/Platform';
import { ColorRequestType, CoreMouseAction, CoreMouseButton, CoreMouseEventType, IColorEvent, ITerminalOptions, KeyboardResultType, ScrollSource, SpecialColorIndex } from 'common/Types'; import { ColorRequestType, CoreMouseAction, CoreMouseButton, CoreMouseEventType, IColorEvent, ITerminalOptions, KeyboardResultType, ScrollSource, SpecialColorIndex } from 'common/Types';
import { DEFAULT_ATTR_DATA } from 'common/buffer/BufferLine'; import { DEFAULT_ATTR_DATA } from 'common/buffer/BufferLine';
@@ -118,7 +118,7 @@ export class Terminal extends CoreTerminal implements ITerminal {
public linkifier2: ILinkifier2; public linkifier2: ILinkifier2;
public viewport: IViewport | undefined; public viewport: IViewport | undefined;
private _compositionHelper: ICompositionHelper | undefined; private _compositionHelper: ICompositionHelper | undefined;
private _accessibilityManager: AccessibilityManager | undefined; private _accessibilityManager: MutableDisposable<AccessibilityManager> = this.register(new MutableDisposable());
private readonly _onCursorMove = this.register(new EventEmitter<void>()); private readonly _onCursorMove = this.register(new EventEmitter<void>());
public readonly onCursorMove = this._onCursorMove.event; public readonly onCursorMove = this._onCursorMove.event;
@@ -252,12 +252,11 @@ export class Terminal extends CoreTerminal implements ITerminal {
private _handleScreenReaderModeOptionChange(value: boolean): void { private _handleScreenReaderModeOptionChange(value: boolean): void {
if (value) { if (value) {
if (!this._accessibilityManager && this._renderService) { if (!this._accessibilityManager.value && this._renderService) {
this._accessibilityManager = this._instantiationService.createInstance(AccessibilityManager, this); this._accessibilityManager.value = this._instantiationService.createInstance(AccessibilityManager, this);
} }
} else { } else {
this._accessibilityManager?.dispose(); this._accessibilityManager.clear();
this._accessibilityManager = undefined;
} }
} }
@@ -535,7 +534,7 @@ export class Terminal extends CoreTerminal implements ITerminal {
if (this.options.screenReaderMode) { if (this.options.screenReaderMode) {
// Note that this must be done *after* the renderer is created in order to // Note that this must be done *after* the renderer is created in order to
// ensure the correct order of the dprchange event // ensure the correct order of the dprchange event
this._accessibilityManager = this._instantiationService.createInstance(AccessibilityManager, this); this._accessibilityManager.value = this._instantiationService.createInstance(AccessibilityManager, this);
} }
this.register(this.optionsService.onSpecificOptionChange('screenReaderMode', e => this._handleScreenReaderModeOptionChange(e))); this.register(this.optionsService.onSpecificOptionChange('screenReaderMode', e => this._handleScreenReaderModeOptionChange(e)));