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
97 lines
2.8 KiB
TypeScript
97 lines
2.8 KiB
TypeScript
/**
|
|
* Copyright (c) 2017 The xterm.js authors. All rights reserved.
|
|
* @license MIT
|
|
*/
|
|
|
|
import { generateConfig, configEquals } from './CharAtlasUtils';
|
|
import { BaseCharAtlas } from './BaseCharAtlas';
|
|
import { DynamicCharAtlas } from './DynamicCharAtlas';
|
|
import { ICharAtlasConfig } from './Types';
|
|
import { IColorSet } from 'browser/Types';
|
|
import { ITerminalOptions } from 'xterm';
|
|
|
|
interface ICharAtlasCacheEntry {
|
|
atlas: BaseCharAtlas;
|
|
config: ICharAtlasConfig;
|
|
// N.B. This implementation potentially holds onto copies of the terminal forever, so
|
|
// this may cause memory leaks.
|
|
ownedBy: number[];
|
|
}
|
|
|
|
const charAtlasCache: ICharAtlasCacheEntry[] = [];
|
|
|
|
/**
|
|
* Acquires a char atlas, either generating a new one or returning an existing
|
|
* one that is in use by another terminal.
|
|
*/
|
|
export function acquireCharAtlas(
|
|
options: Required<ITerminalOptions>,
|
|
rendererId: number,
|
|
colors: IColorSet,
|
|
scaledCharWidth: number,
|
|
scaledCharHeight: number,
|
|
devicePixelRatio: number
|
|
): BaseCharAtlas {
|
|
const newConfig = generateConfig(scaledCharWidth, scaledCharHeight, options, colors, devicePixelRatio);
|
|
|
|
// Check to see if the renderer already owns this config
|
|
for (let i = 0; i < charAtlasCache.length; i++) {
|
|
const entry = charAtlasCache[i];
|
|
const ownedByIndex = entry.ownedBy.indexOf(rendererId);
|
|
if (ownedByIndex >= 0) {
|
|
if (configEquals(entry.config, newConfig)) {
|
|
return entry.atlas;
|
|
}
|
|
// The configs differ, release the renderer from the entry
|
|
if (entry.ownedBy.length === 1) {
|
|
entry.atlas.dispose();
|
|
charAtlasCache.splice(i, 1);
|
|
} else {
|
|
entry.ownedBy.splice(ownedByIndex, 1);
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
|
|
// Try match a char atlas from the cache
|
|
for (let i = 0; i < charAtlasCache.length; i++) {
|
|
const entry = charAtlasCache[i];
|
|
if (configEquals(entry.config, newConfig)) {
|
|
// Add the renderer to the cache entry and return
|
|
entry.ownedBy.push(rendererId);
|
|
return entry.atlas;
|
|
}
|
|
}
|
|
|
|
const newEntry: ICharAtlasCacheEntry = {
|
|
atlas: new DynamicCharAtlas(
|
|
document,
|
|
newConfig
|
|
),
|
|
config: newConfig,
|
|
ownedBy: [rendererId]
|
|
};
|
|
charAtlasCache.push(newEntry);
|
|
return newEntry.atlas;
|
|
}
|
|
|
|
/**
|
|
* Removes a terminal reference from the cache, allowing its memory to be freed.
|
|
*/
|
|
export function removeTerminalFromCache(rendererId: number): void {
|
|
for (let i = 0; i < charAtlasCache.length; i++) {
|
|
const index = charAtlasCache[i].ownedBy.indexOf(rendererId);
|
|
if (index !== -1) {
|
|
if (charAtlasCache[i].ownedBy.length === 1) {
|
|
// Remove the cache entry if it's the only renderer
|
|
charAtlasCache[i].atlas.dispose();
|
|
charAtlasCache.splice(i, 1);
|
|
} else {
|
|
// Remove the reference from the cache entry
|
|
charAtlasCache[i].ownedBy.splice(index, 1);
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
}
|