Mihai Parparita
a39a468f19
Add support for the parent element (what is passed to Terminal.open) being in a different (same origin) window. Accesses to DOM APIs such as requestAnimationFrame and devicePixelRatio thus need to be scoped to the corrent window, instead of assuming that it's the same as the window/global scope where the code is running. This is done by inferring a parent window at the creation time, and then storing it in CoreBrowserService, which is already passed to most places that need it. To catch future regressions, an ESLint rule that checks for global accesses is added (it uses AST selectors via the no-restricted-syntax rule). This should also be applicable when the parent element is an iframe. Fixes #3758
84 lines
2.6 KiB
TypeScript
84 lines
2.6 KiB
TypeScript
/**
|
|
* Copyright (c) 2018 The xterm.js authors. All rights reserved.
|
|
* @license MIT
|
|
*/
|
|
|
|
import { IRenderDebouncerWithCallback } from 'browser/Types';
|
|
|
|
/**
|
|
* Debounces calls to render terminal rows using animation frames.
|
|
*/
|
|
export class RenderDebouncer implements IRenderDebouncerWithCallback {
|
|
private _rowStart: number | undefined;
|
|
private _rowEnd: number | undefined;
|
|
private _rowCount: number | undefined;
|
|
private _animationFrame: number | undefined;
|
|
private _refreshCallbacks: FrameRequestCallback[] = [];
|
|
|
|
constructor(
|
|
private _parentWindow: Window,
|
|
private _renderCallback: (start: number, end: number) => void
|
|
) {
|
|
}
|
|
|
|
public dispose(): void {
|
|
if (this._animationFrame) {
|
|
this._parentWindow.cancelAnimationFrame(this._animationFrame);
|
|
this._animationFrame = undefined;
|
|
}
|
|
}
|
|
|
|
public addRefreshCallback(callback: FrameRequestCallback): number {
|
|
this._refreshCallbacks.push(callback);
|
|
if (!this._animationFrame) {
|
|
this._animationFrame = this._parentWindow.requestAnimationFrame(() => this._innerRefresh());
|
|
}
|
|
return this._animationFrame;
|
|
}
|
|
|
|
public refresh(rowStart: number | undefined, rowEnd: number | undefined, rowCount: number): void {
|
|
this._rowCount = rowCount;
|
|
// Get the min/max row start/end for the arg values
|
|
rowStart = rowStart !== undefined ? rowStart : 0;
|
|
rowEnd = rowEnd !== undefined ? rowEnd : this._rowCount - 1;
|
|
// Set the properties to the updated values
|
|
this._rowStart = this._rowStart !== undefined ? Math.min(this._rowStart, rowStart) : rowStart;
|
|
this._rowEnd = this._rowEnd !== undefined ? Math.max(this._rowEnd, rowEnd) : rowEnd;
|
|
|
|
if (this._animationFrame) {
|
|
return;
|
|
}
|
|
|
|
this._animationFrame = this._parentWindow.requestAnimationFrame(() => this._innerRefresh());
|
|
}
|
|
|
|
private _innerRefresh(): void {
|
|
this._animationFrame = undefined;
|
|
|
|
// Make sure values are set
|
|
if (this._rowStart === undefined || this._rowEnd === undefined || this._rowCount === undefined) {
|
|
this._runRefreshCallbacks();
|
|
return;
|
|
}
|
|
|
|
// Clamp values
|
|
const start = Math.max(this._rowStart, 0);
|
|
const end = Math.min(this._rowEnd, this._rowCount - 1);
|
|
|
|
// Reset debouncer (this happens before render callback as the render could trigger it again)
|
|
this._rowStart = undefined;
|
|
this._rowEnd = undefined;
|
|
|
|
// Run render callback
|
|
this._renderCallback(start, end);
|
|
this._runRefreshCallbacks();
|
|
}
|
|
|
|
private _runRefreshCallbacks(): void {
|
|
for (const callback of this._refreshCallbacks) {
|
|
callback(0);
|
|
}
|
|
this._refreshCallbacks = [];
|
|
}
|
|
}
|