@@ -15,19 +15,22 @@ export interface ITerminalAddon {
|
|||||||
|
|
||||||
export class LigaturesAddon implements ITerminalAddon , ILigaturesApi {
|
export class LigaturesAddon implements ITerminalAddon , ILigaturesApi {
|
||||||
private readonly _fallbackLigatures: string[];
|
private readonly _fallbackLigatures: string[];
|
||||||
|
private readonly _fontFeatureSettings?: string;
|
||||||
|
|
||||||
private _terminal: Terminal | undefined;
|
private _terminal: Terminal | undefined;
|
||||||
private _characterJoinerId: number | undefined;
|
private _characterJoinerId: number | undefined;
|
||||||
|
|
||||||
constructor(options?: Partial<ILigatureOptions>) {
|
constructor(options?: Partial<ILigatureOptions>) {
|
||||||
|
// Source: calt set from https://github.com/be5invis/Iosevka?tab=readme-ov-file#ligations
|
||||||
this._fallbackLigatures = (options?.fallbackLigatures || [
|
this._fallbackLigatures = (options?.fallbackLigatures || [
|
||||||
'<--', '<---', '<<-', '<-', '->', '->>', '-->', '--->',
|
'<--', '<---', '<<-', '<-', '->', '->>', '-->', '--->',
|
||||||
'<==', '<===', '<<=', '<=', '=>', '=>>', '==>', '===>', '>=', '>>=',
|
'<==', '<===', '<<=', '<=', '=>', '=>>', '==>', '===>', '>=', '>>=',
|
||||||
'<->', '<-->', '<--->', '<---->', '<=>', '<==>', '<===>', '<====>', '-------->',
|
'<->', '<-->', '<--->', '<---->', '<=>', '<==>', '<===>', '<====>', '::', ':::',
|
||||||
'<~~', '<~', '~>', '~~>', '::', ':::', '==', '!=', '===', '!==',
|
'<~~', '</', '</>', '/>', '~~>', '==', '!=', '/=', '~=', '<>', '===', '!==', '!===',
|
||||||
':=', ':-', ':+', '<*', '<*>', '*>', '<|', '<|>', '|>', '+:', '-:', '=:', ':>',
|
'<:', ':=', '*=', '*+', '<*', '<*>', '*>', '<|', '<|>', '|>', '+*', '=*', '=:', ':>',
|
||||||
'++', '+++', '<!--', '<!---', '<***>'
|
'/*', '*/', '+++', '<!--', '<!---'
|
||||||
]).sort((a, b) => b.length - a.length);
|
]).sort((a, b) => b.length - a.length);
|
||||||
|
this._fontFeatureSettings = options?.fontFeatureSettings;
|
||||||
}
|
}
|
||||||
|
|
||||||
public activate(terminal: Terminal): void {
|
public activate(terminal: Terminal): void {
|
||||||
@@ -36,7 +39,7 @@ export class LigaturesAddon implements ITerminalAddon , ILigaturesApi {
|
|||||||
}
|
}
|
||||||
this._terminal = terminal;
|
this._terminal = terminal;
|
||||||
this._characterJoinerId = enableLigatures(terminal, this._fallbackLigatures);
|
this._characterJoinerId = enableLigatures(terminal, this._fallbackLigatures);
|
||||||
terminal.element.style.fontFeatureSettings = '"liga" on, "calt" on';
|
terminal.element.style.fontFeatureSettings = this._fontFeatureSettings ?? '"calt" on';
|
||||||
}
|
}
|
||||||
|
|
||||||
public dispose(): void {
|
public dispose(): void {
|
||||||
|
|||||||
@@ -5,4 +5,5 @@
|
|||||||
|
|
||||||
export interface ILigatureOptions {
|
export interface ILigatureOptions {
|
||||||
fallbackLigatures: string[];
|
fallbackLigatures: string[];
|
||||||
|
fontFeatureSettings: string;
|
||||||
}
|
}
|
||||||
|
|||||||
+21
-9
@@ -23,7 +23,10 @@ declare module '@xterm/addon-ligatures' {
|
|||||||
constructor(options?: Partial<ILigatureOptions>);
|
constructor(options?: Partial<ILigatureOptions>);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Activates the addon
|
* Activates the addon. Note that if webgl is also being used, that addon
|
||||||
|
* should be reactivated after ligatures is activated in order to apply
|
||||||
|
* {@link ILigatureOptions.fontFeatureSettings} to the texture atlas.
|
||||||
|
*
|
||||||
*
|
*
|
||||||
* @param terminal The terminal the addon is being loaded in.
|
* @param terminal The terminal the addon is being loaded in.
|
||||||
*/
|
*/
|
||||||
@@ -40,19 +43,28 @@ declare module '@xterm/addon-ligatures' {
|
|||||||
*/
|
*/
|
||||||
export interface ILigatureOptions {
|
export interface ILigatureOptions {
|
||||||
/**
|
/**
|
||||||
* Fallback ligatures to use when the font access API is either not supported by the browser or
|
* Fallback ligatures to use when the font access API is either not
|
||||||
* access is denied. The default set of ligatures is taken from Iosevka's default "calt"
|
* supported by the browser or access is denied. The default set of
|
||||||
* ligation set: https://typeof.net/Iosevka/
|
* ligatures is taken from Iosevka's default "calt" ligation set:
|
||||||
|
* https://typeof.net/Iosevka/
|
||||||
*
|
*
|
||||||
* ```
|
* ```
|
||||||
* <-- <--- <<- <- -> ->> --> --->
|
* <-- <--- <<- <- -> ->> --> --->
|
||||||
* <== <=== <<= <= => =>> ==> ===> >= >>=
|
* <== <=== <<= <= => =>> ==> ===> >= >>=
|
||||||
* <-> <--> <---> <----> <=> <==> <===> <====> -------->
|
* <-> <--> <---> <----> <=> <==> <===> <====> :: :::
|
||||||
* <~~ <~ ~> ~~> :: ::: == != === !==
|
* <~~ </ </> /> ~~> == != /= ~= <> === !== !===
|
||||||
* := :- :+ <* <*> *> <| <|> |> +: -: =: :>
|
* <: := *= *+ <* <*> *> <| <|> |> +* =* =: :>
|
||||||
* ++ +++ <!-- <!--- <***>
|
* /* <close block comment> +++ <!-- <!---
|
||||||
* ```
|
|
||||||
*/
|
*/
|
||||||
fallbackLigatures: string[]
|
fallbackLigatures: string[]
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The CSS `font-feature-settings` value to use for enabling ligatures. This
|
||||||
|
* also supports font variants for example with a value like
|
||||||
|
* `"calt" on, "ss03"`.
|
||||||
|
*
|
||||||
|
* The default value is `"calt" on`.
|
||||||
|
*/
|
||||||
|
fontFeatureSettings: string;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -238,9 +238,9 @@ export class GlyphRenderer extends Disposable {
|
|||||||
|
|
||||||
// Get the glyph
|
// Get the glyph
|
||||||
if (chars && chars.length > 1) {
|
if (chars && chars.length > 1) {
|
||||||
$glyph = this._atlas.getRasterizedGlyphCombinedChar(chars, bg, fg, ext, false);
|
$glyph = this._atlas.getRasterizedGlyphCombinedChar(chars, bg, fg, ext, false, this._terminal.element);
|
||||||
} else {
|
} else {
|
||||||
$glyph = this._atlas.getRasterizedGlyph(code, bg, fg, ext, false);
|
$glyph = this._atlas.getRasterizedGlyph(code, bg, fg, ext, false, this._terminal.element);
|
||||||
}
|
}
|
||||||
|
|
||||||
$leftCellPadding = Math.floor((this._dimensions.device.cell.width - this._dimensions.device.char.width) / 2);
|
$leftCellPadding = Math.floor((this._dimensions.device.cell.width - this._dimensions.device.char.width) / 2);
|
||||||
|
|||||||
+25
-6
@@ -637,17 +637,25 @@ function initAddons(term: Terminal): void {
|
|||||||
}
|
}
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
function postInitWebgl(): void {
|
||||||
|
setTimeout(() => {
|
||||||
|
setTextureAtlas(addons.webgl.instance.textureAtlas);
|
||||||
|
addons.webgl.instance.onChangeTextureAtlas(e => setTextureAtlas(e));
|
||||||
|
addons.webgl.instance.onAddTextureAtlasCanvas(e => appendTextureAtlas(e));
|
||||||
|
}, 500);
|
||||||
|
}
|
||||||
|
function preDisposeWebgl(): void {
|
||||||
|
if (addons.webgl.instance.textureAtlas) {
|
||||||
|
addons.webgl.instance.textureAtlas.remove();
|
||||||
|
}
|
||||||
|
}
|
||||||
if (checkbox.checked) {
|
if (checkbox.checked) {
|
||||||
// HACK: Manually remove addons that cannot be changes
|
// HACK: Manually remove addons that cannot be changes
|
||||||
addon.instance = new (addon as IDemoAddon<Exclude<AddonType, 'attach'>>).ctor();
|
addon.instance = new (addon as IDemoAddon<Exclude<AddonType, 'attach'>>).ctor();
|
||||||
try {
|
try {
|
||||||
term.loadAddon(addon.instance);
|
term.loadAddon(addon.instance);
|
||||||
if (name === 'webgl') {
|
if (name === 'webgl') {
|
||||||
setTimeout(() => {
|
postInitWebgl();
|
||||||
setTextureAtlas(addons.webgl.instance.textureAtlas);
|
|
||||||
addons.webgl.instance.onChangeTextureAtlas(e => setTextureAtlas(e));
|
|
||||||
addons.webgl.instance.onAddTextureAtlasCanvas(e => appendTextureAtlas(e));
|
|
||||||
}, 0);
|
|
||||||
} else if (name === 'unicode11') {
|
} else if (name === 'unicode11') {
|
||||||
term.unicode.activeVersion = '11';
|
term.unicode.activeVersion = '11';
|
||||||
} else if (name === 'unicodeGraphemes') {
|
} else if (name === 'unicodeGraphemes') {
|
||||||
@@ -663,13 +671,24 @@ function initAddons(term: Terminal): void {
|
|||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
if (name === 'webgl') {
|
if (name === 'webgl') {
|
||||||
addons.webgl.instance.textureAtlas.remove();
|
preDisposeWebgl();
|
||||||
} else if (name === 'unicode11' || name === 'unicodeGraphemes') {
|
} else if (name === 'unicode11' || name === 'unicodeGraphemes') {
|
||||||
term.unicode.activeVersion = '6';
|
term.unicode.activeVersion = '6';
|
||||||
}
|
}
|
||||||
addon.instance!.dispose();
|
addon.instance!.dispose();
|
||||||
addon.instance = undefined;
|
addon.instance = undefined;
|
||||||
}
|
}
|
||||||
|
if (name === 'ligatures') {
|
||||||
|
// Recreate webgl when ligatures are toggled so texture atlas picks up any font feature
|
||||||
|
// settings changes
|
||||||
|
if (addons.webgl.instance) {
|
||||||
|
preDisposeWebgl();
|
||||||
|
addons.webgl.instance.dispose();
|
||||||
|
addons.webgl.instance = new addons.webgl.ctor();
|
||||||
|
term.loadAddon(addons.webgl.instance);
|
||||||
|
postInitWebgl();
|
||||||
|
}
|
||||||
|
}
|
||||||
});
|
});
|
||||||
const label = document.createElement('label');
|
const label = document.createElement('label');
|
||||||
label.classList.add('addon');
|
label.classList.add('addon');
|
||||||
|
|||||||
@@ -103,6 +103,7 @@ export class TextureAtlas implements ITextureAtlas {
|
|||||||
}
|
}
|
||||||
|
|
||||||
public dispose(): void {
|
public dispose(): void {
|
||||||
|
this._tmpCanvas.remove();
|
||||||
for (const page of this.pages) {
|
for (const page of this.pages) {
|
||||||
page.canvas.remove();
|
page.canvas.remove();
|
||||||
}
|
}
|
||||||
@@ -122,7 +123,7 @@ export class TextureAtlas implements ITextureAtlas {
|
|||||||
for (let i = 33; i < 126; i++) {
|
for (let i = 33; i < 126; i++) {
|
||||||
queue.enqueue(() => {
|
queue.enqueue(() => {
|
||||||
if (!this._cacheMap.get(i, DEFAULT_COLOR, DEFAULT_COLOR, DEFAULT_EXT)) {
|
if (!this._cacheMap.get(i, DEFAULT_COLOR, DEFAULT_COLOR, DEFAULT_EXT)) {
|
||||||
const rasterizedGlyph = this._drawToCache(i, DEFAULT_COLOR, DEFAULT_COLOR, DEFAULT_EXT);
|
const rasterizedGlyph = this._drawToCache(i, DEFAULT_COLOR, DEFAULT_COLOR, DEFAULT_EXT, false, undefined);
|
||||||
this._cacheMap.set(i, DEFAULT_COLOR, DEFAULT_COLOR, DEFAULT_EXT, rasterizedGlyph);
|
this._cacheMap.set(i, DEFAULT_COLOR, DEFAULT_COLOR, DEFAULT_EXT, rasterizedGlyph);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -242,12 +243,12 @@ export class TextureAtlas implements ITextureAtlas {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public getRasterizedGlyphCombinedChar(chars: string, bg: number, fg: number, ext: number, restrictToCellHeight: boolean): IRasterizedGlyph {
|
public getRasterizedGlyphCombinedChar(chars: string, bg: number, fg: number, ext: number, restrictToCellHeight: boolean, domContainer: HTMLElement | undefined): IRasterizedGlyph {
|
||||||
return this._getFromCacheMap(this._cacheMapCombined, chars, bg, fg, ext, restrictToCellHeight);
|
return this._getFromCacheMap(this._cacheMapCombined, chars, bg, fg, ext, restrictToCellHeight, domContainer);
|
||||||
}
|
}
|
||||||
|
|
||||||
public getRasterizedGlyph(code: number, bg: number, fg: number, ext: number, restrictToCellHeight: boolean): IRasterizedGlyph {
|
public getRasterizedGlyph(code: number, bg: number, fg: number, ext: number, restrictToCellHeight: boolean, domContainer: HTMLElement | undefined): IRasterizedGlyph {
|
||||||
return this._getFromCacheMap(this._cacheMap, code, bg, fg, ext, restrictToCellHeight);
|
return this._getFromCacheMap(this._cacheMap, code, bg, fg, ext, restrictToCellHeight, domContainer);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -259,11 +260,12 @@ export class TextureAtlas implements ITextureAtlas {
|
|||||||
bg: number,
|
bg: number,
|
||||||
fg: number,
|
fg: number,
|
||||||
ext: number,
|
ext: number,
|
||||||
restrictToCellHeight: boolean = false
|
restrictToCellHeight: boolean,
|
||||||
|
domContainer: HTMLElement | undefined
|
||||||
): IRasterizedGlyph {
|
): IRasterizedGlyph {
|
||||||
$glyph = cacheMap.get(key, bg, fg, ext);
|
$glyph = cacheMap.get(key, bg, fg, ext);
|
||||||
if (!$glyph) {
|
if (!$glyph) {
|
||||||
$glyph = this._drawToCache(key, bg, fg, ext, restrictToCellHeight);
|
$glyph = this._drawToCache(key, bg, fg, ext, restrictToCellHeight, domContainer);
|
||||||
cacheMap.set(key, bg, fg, ext, $glyph);
|
cacheMap.set(key, bg, fg, ext, $glyph);
|
||||||
}
|
}
|
||||||
return $glyph;
|
return $glyph;
|
||||||
@@ -423,12 +425,20 @@ export class TextureAtlas implements ITextureAtlas {
|
|||||||
return this._config.colors.contrastCache;
|
return this._config.colors.contrastCache;
|
||||||
}
|
}
|
||||||
|
|
||||||
private _drawToCache(codeOrChars: number | string, bg: number, fg: number, ext: number, restrictToCellHeight: boolean = false): IRasterizedGlyph {
|
private _drawToCache(codeOrChars: number | string, bg: number, fg: number, ext: number, restrictToCellHeight: boolean, domContainer: HTMLElement | undefined): IRasterizedGlyph {
|
||||||
const chars = typeof codeOrChars === 'number' ? String.fromCharCode(codeOrChars) : codeOrChars;
|
const chars = typeof codeOrChars === 'number' ? String.fromCharCode(codeOrChars) : codeOrChars;
|
||||||
|
|
||||||
// Uncomment for debugging
|
// Uncomment for debugging
|
||||||
// console.log(`draw to cache "${chars}"`, bg, fg, ext);
|
// console.log(`draw to cache "${chars}"`, bg, fg, ext);
|
||||||
|
|
||||||
|
// Attach the canvas to the DOM in order to inherit font-feature-settings
|
||||||
|
// from the parent elements. This is necessary for ligatures and variants to
|
||||||
|
// work.
|
||||||
|
if (domContainer && this._tmpCanvas.parentElement !== domContainer) {
|
||||||
|
this._tmpCanvas.style.display = 'none';
|
||||||
|
domContainer.append(this._tmpCanvas);
|
||||||
|
}
|
||||||
|
|
||||||
// Allow 1 cell width per character, with a minimum of 2 (CJK), plus some padding. This is used
|
// Allow 1 cell width per character, with a minimum of 2 (CJK), plus some padding. This is used
|
||||||
// to draw the glyph to the canvas as well as to restrict the bounding box search to ensure
|
// to draw the glyph to the canvas as well as to restrict the bounding box search to ensure
|
||||||
// giant ligatures (eg. =====>) don't impact overall performance.
|
// giant ligatures (eg. =====>) don't impact overall performance.
|
||||||
|
|||||||
@@ -108,8 +108,8 @@ export interface ITextureAtlas extends IDisposable {
|
|||||||
* Clear all glyphs from the texture atlas.
|
* Clear all glyphs from the texture atlas.
|
||||||
*/
|
*/
|
||||||
clearTexture(): void;
|
clearTexture(): void;
|
||||||
getRasterizedGlyph(code: number, bg: number, fg: number, ext: number, restrictToCellHeight: boolean): IRasterizedGlyph;
|
getRasterizedGlyph(code: number, bg: number, fg: number, ext: number, restrictToCellHeight: boolean, domContainer: HTMLElement | undefined): IRasterizedGlyph;
|
||||||
getRasterizedGlyphCombinedChar(chars: string, bg: number, fg: number, ext: number, restrictToCellHeight: boolean): IRasterizedGlyph;
|
getRasterizedGlyphCombinedChar(chars: string, bg: number, fg: number, ext: number, restrictToCellHeight: boolean, domContainer: HTMLElement | undefined): IRasterizedGlyph;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|||||||
Reference in New Issue
Block a user