Compare commits

...
Author SHA1 Message Date
Cursor AgentandDaniel Imms 7c6f793aa2 Fix webpack aliases for target-* module paths and out/primitives+runtime
Co-authored-by: Daniel Imms <Tyriar@users.noreply.github.com>
2026-05-31 00:32:19 +00:00
Cursor AgentandDaniel Imms f22ef02831 Move primitives and runtime out of src/common/
Relocate src/common/primitives and src/common/runtime to src/primitives
and src/runtime. Add src/tsconfig.json as the primitives+runtime solution.
Update tsconfigs, esbuild, webpack aliases, publish path, and docs.

Co-authored-by: Daniel Imms <Tyriar@users.noreply.github.com>
2026-05-31 00:30:53 +00:00
Cursor AgentandDaniel Imms c569e5ab19 Full common split: composite tsconfigs and target-* modules
- Add composite TypeScript projects for common/primitives and common/runtime
- Decouple primitives from runtime (buffer service interfaces, UnicodeProperties, CellTypes, etc.)
- Move Types.ts to runtime; re-export primitive types from runtime/Types
- Rename src/browser -> src/target-browser, src/headless -> src/target-headless
- Update import paths (target-browser/*, target-headless/*) across repo
- Fix esbuild outbase so common/* and target-* resolve under out-esbuild/
- Point unicode addons at primitives for UnicodeTypes/UnicodeProperties
- Update ARCHITECTURE.md and AGENTS.md

Co-authored-by: Daniel Imms <Tyriar@users.noreply.github.com>
2026-05-31 00:19:43 +00:00
Cursor AgentandDaniel Imms 9a65429a30 Split common into primitives and runtime layers
Reorganize src/common per issue #5963: move building blocks under
primitives/ and services/integration under runtime/. Preserve existing
common/* import paths via TypeScript path mapping. Add src/ARCHITECTURE.md
documenting modules and goals.

Fix two relative imports broken by the directory depth change.

Co-authored-by: Daniel Imms <Tyriar@users.noreply.github.com>
2026-05-30 23:47:30 +00:00
Daniel Imms 43e8365f0e Merge pull request #5960 from xtermjs/cursor/move-fixtures-1191
Move fixtures to test/fixtures
2026-05-28 07:06:21 -07:00
Cursor AgentandDaniel Imms c7a94fc0bc Move fixtures to test/fixtures and update references
Co-authored-by: Daniel Imms <Tyriar@users.noreply.github.com>
2026-05-28 14:01:12 +00:00
Daniel Imms 4bb9c06b5f Merge pull request #5953 from xtermjs/cursor/alt-click-for-mouse-events-5b17
Add altClickForMouseEvents option
2026-05-28 06:35:56 -07:00
Daniel Imms 00e54532b3 Merge pull request #5959 from xtermjs/cursor/setup-dev-environment-dc0c
Add Cursor Cloud specific instructions to AGENTS.md
2026-05-27 22:13:27 -07:00
Cursor AgentandDaniel Imms e96133603b Add Cursor Cloud specific instructions to AGENTS.md
Add development environment guidance for cloud agents including:
- Demo server startup notes
- Build-before-test requirements
- Note about no external services needed
- tsgo compiler note
- Lint optimization tip

Co-authored-by: Daniel Imms <Tyriar@users.noreply.github.com>
2026-05-28 05:10:34 +00:00
Daniel Imms b2003861ec Merge pull request #5859 from xtermjs/iip_enhancements
IIP enhancements
2026-05-27 20:36:13 -07:00
Daniel Imms 38f77fd4ca Merge branch 'master' into iip_enhancements 2026-05-27 20:16:36 -07:00
Daniel Imms d3352cf1d5 Merge pull request #5873 from xtermjs/package_upgrades
package upgrades & linter fixes
2026-05-27 20:16:08 -07:00
Daniel Imms 0c4ec34df8 Remove unnecessary @types/lru-cache 2026-05-27 20:11:20 -07:00
Daniel Imms 743852b60c Remove unneeded comment 2026-05-27 19:58:52 -07:00
Daniel Imms 2069176528 Fix lint 2026-05-27 19:58:21 -07:00
Daniel Imms acd2472961 Merge remote-tracking branch 'upstream/master' into package_upgrades 2026-05-27 19:23:43 -07:00
Daniel ImmsandCursor 1b95efa8c8 Add explicit void return type to alt cursor event listener.
Fixes explicit-function-return-type lint in AltMouseCursorController.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-27 16:54:23 -07:00
Daniel ImmsandCursor ce1f5f9608 Add MouseEventCssClasses const enum for enable-mouse-events class.
Centralize the CSS class name in MouseService.ts and use it across mouse mode handling and tests.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-27 16:23:17 -07:00
Daniel ImmsandCursor bf8af4a871 Toggle enable-mouse-events cursor while alt is held for mouseEventsRequireAlt.
Extract AltMouseCursorController to bind DOM listeners only when the option and mouse protocol are active.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-27 16:20:45 -07:00
Daniel ImmsandCursor f8e9a81d0e Fix mouseEventsRequireAlt by stripping alt from PTY mouse reports.
Alt is only used locally to gate passthrough; applications like tmux ignore alt-modified SGR sequences.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-27 16:11:35 -07:00
Cursor AgentandDaniel Imms 7711d780c2 Handle mouseEventsRequireAlt option changes in mouse mode
Co-authored-by: Daniel Imms <Tyriar@users.noreply.github.com>
2026-05-27 21:59:23 +00:00
Cursor AgentandDaniel Imms f8cef535c7 Rename altClickForMouseEvents to mouseEventsRequireAlt
Co-authored-by: Daniel Imms <Tyriar@users.noreply.github.com>
2026-05-27 21:41:44 +00:00
Cursor AgentandDaniel Imms 5ad56446b8 Explicitly enable selection when altClickForMouseEvents is on at attach
Co-authored-by: Daniel Imms <Tyriar@users.noreply.github.com>
2026-05-27 21:20:17 +00:00
Cursor AgentandDaniel Imms fbb2a9710f Add altClickForMouseEvents option for issue #5952
When enabled during mouse events mode, click/drag/move events require the alt
key while wheel events are unaffected. Selection stays enabled by default
and takes precedence over macOptionClickForcesSelection.

Co-authored-by: Daniel Imms <Tyriar@users.noreply.github.com>
2026-05-27 20:13:31 +00:00
Jörg Breitbart 5a6427e867 Merge branch 'master' into package_upgrades 2026-05-21 13:45:03 +02:00
Jörg Breitbart 8519ac6d99 Merge branch 'master' into package_upgrades 2026-05-21 13:34:12 +02:00
jerch ae611694de Merge branch 'master' into iip_enhancements 2026-05-21 12:47:09 +02:00
jerch 772df0cb98 Merge branch 'master' into iip_enhancements 2026-05-11 17:03:53 +02:00
jerch aa93189cc5 Merge branch 'master' into package_upgrades 2026-05-11 16:57:49 +02:00
Jörg Breitbart f82a8029d2 fix README 2026-05-10 21:27:52 +02:00
Jörg Breitbart a2f321c887 add multipart demo 2026-05-10 21:08:22 +02:00
Jörg Breitbart eb58cefa8e add integration tests for filepart 2026-05-10 20:34:43 +02:00
Jörg Breitbart d92ca87cbe add qoi metrics test 2026-05-10 19:32:47 +02:00
jerch 224167bbbe Merge branch 'master' into iip_enhancements 2026-05-09 22:59:22 +02:00
Jörg Breitbart 740fa44ae4 make webfont loading tests more resilient 2026-05-09 18:13:16 +02:00
Jörg Breitbart 636baa8d79 make webfont loading tests more resilient 2026-05-09 18:06:59 +02:00
Jörg Breitbart 44a27dc958 make webfont loading tests more resilient 2026-05-09 17:59:33 +02:00
Jörg Breitbart dc1ae4514b package upgrades & linter fixes 2026-05-09 17:42:49 +02:00
Jörg Breitbart 494cf1f2e1 make linter happy 2026-04-30 16:54:54 +02:00
Jörg Breitbart 645865efec fix cursor placement in IIP 2026-04-30 16:46:22 +02:00
Jörg Breitbart 83e3657a82 fix _mouseCoordsService access in demo 2026-04-30 15:21:41 +02:00
Jörg Breitbart 53554a05f7 use _coreBrowserService.dpr 2026-04-30 10:44:38 +02:00
Jörg Breitbart 51c8d8abf8 implement ReportCellSize 2026-04-30 10:36:41 +02:00
Jörg Breitbart 05ea5ac324 implement ReportCellSize 2026-04-30 10:33:34 +02:00
Jörg Breitbart 9e27c7debb filepart handling in IIP 2026-04-29 21:36:45 +02:00
450 changed files with 4499 additions and 3226 deletions
+19 -4
View File
@@ -2,10 +2,13 @@
## Architecture Overview ## Architecture Overview
**Core Structure**: xterm.js is a multi-target terminal emulator with three main distributions: **Core Structure**: xterm.js is a multi-target terminal emulator with these main source areas:
- `src/browser/`: Full-featured browser terminal with DOM rendering - `src/primitives/`: Building blocks (buffer, parser, input, data, utilities); TypeScript project `src/primitives/tsconfig.json`
- `src/headless/`: Server-side terminal for Node.js (no DOM) - `src/runtime/`: Services, `CoreTerminal`, `InputHandler`, public API adapters; TypeScript project `src/runtime/tsconfig.json`
- `src/common/`: Shared core logic (parsing, buffer management, terminal state) - `src/target-browser/`: Browser terminal with DOM rendering
- `src/target-headless/`: Node terminal without DOM
See `src/ARCHITECTURE.md` for the dependency graph and import-path conventions (`common/*`, `target-browser/*`, `target-headless/*`).
**Key Classes**: **Key Classes**:
- `Terminal` (browser/headless): Public API wrapper - `Terminal` (browser/headless): Public API wrapper
@@ -98,3 +101,15 @@ const cell = line?.getCell(0);
## Writing unit tests ## Writing unit tests
- Unit tests live alongside the source code file of the thing it's testing with a .test.ts suffix. - Unit tests live alongside the source code file of the thing it's testing with a .test.ts suffix.
## Cursor Cloud specific instructions
**Demo server**: Start with `npm start` (port 3000). The demo server uses node-pty to spawn real shell sessions over WebSocket. Integration tests auto-start it via Playwright's `webServer` config, so you don't need to start it manually for `npm run test-integration`.
**Build before testing**: Always run `npm run build && npm run esbuild` before `npm run test-unit`. Integration tests also need `npm run esbuild-demo-client` and `npm run esbuild-demo-server`. The update script handles this automatically on session start.
**No external services**: This project has zero external dependencies (no databases, Docker, or APIs). Everything runs locally with Node.js.
**TypeScript compiler**: The project uses `tsgo` (native TypeScript compiler preview) rather than standard `tsc`. It's installed via the `@typescript/native-preview` package.
**Lint only changed files**: Prefer `npm run lint-changes` over `npm run lint` when iterating on code changes — it's significantly faster.
+6 -5
View File
@@ -11,10 +11,11 @@
"removeComments": true, "removeComments": true,
"paths": { "paths": {
"common/*": [ "common/*": [
"../../../src/common/*" "../../../src/primitives/*",
"../../../src/runtime/*",
], ],
"browser/*": [ "target-browser/*": [
"../../../src/browser/*" "../../../src/target-browser/*"
], ],
"*": [ "*": [
"./*" "./*"
@@ -31,10 +32,10 @@
], ],
"references": [ "references": [
{ {
"path": "../../../src/common" "path": "../../../src"
}, },
{ {
"path": "../../../src/browser" "path": "../../../src/target-browser"
}, },
{ {
"path": "../../../test/playwright" "path": "../../../test/playwright"
+3 -3
View File
@@ -15,8 +15,8 @@
"../../../node_modules/@types/mocha" "../../../node_modules/@types/mocha"
], ],
"paths": { "paths": {
"browser/*": [ "target-browser/*": [
"../../../src/browser/*" "../../../src/target-browser/*"
], ],
"@xterm/addon-clipboard": [ "@xterm/addon-clipboard": [
"../typings/addon-clipboard.d.ts" "../typings/addon-clipboard.d.ts"
@@ -29,7 +29,7 @@
], ],
"references": [ "references": [
{ {
"path": "../../../src/browser" "path": "../../../src/target-browser"
} }
] ]
} }
+6 -5
View File
@@ -11,10 +11,11 @@
"removeComments": true, "removeComments": true,
"paths": { "paths": {
"common/*": [ "common/*": [
"../../../src/common/*" "../../../src/primitives/*",
"../../../src/runtime/*",
], ],
"browser/*": [ "target-browser/*": [
"../../../src/browser/*" "../../../src/target-browser/*"
], ],
"*": [ "*": [
"./*" "./*"
@@ -31,10 +32,10 @@
], ],
"references": [ "references": [
{ {
"path": "../../../src/common" "path": "../../../src"
}, },
{ {
"path": "../../../src/browser" "path": "../../../src/target-browser"
}, },
{ {
"path": "../../../test/playwright" "path": "../../../test/playwright"
+1 -1
View File
@@ -5,7 +5,7 @@
import type { Terminal, ITerminalAddon, IRenderDimensions } from '@xterm/xterm'; import type { Terminal, ITerminalAddon, IRenderDimensions } from '@xterm/xterm';
import type { FitAddon as IFitApi } from '@xterm/addon-fit'; import type { FitAddon as IFitApi } from '@xterm/addon-fit';
import { ViewportConstants } from 'browser/shared/Constants'; import { ViewportConstants } from 'target-browser/shared/Constants';
interface ITerminalDimensions { interface ITerminalDimensions {
/** /**
+3 -3
View File
@@ -15,8 +15,8 @@
"../../../node_modules/@types/mocha" "../../../node_modules/@types/mocha"
], ],
"paths": { "paths": {
"browser/*": [ "target-browser/*": [
"../../../src/browser/*" "../../../src/target-browser/*"
], ],
"@xterm/addon-fit": [ "@xterm/addon-fit": [
"../typings/addon-fit.d.ts" "../typings/addon-fit.d.ts"
@@ -29,7 +29,7 @@
], ],
"references": [ "references": [
{ {
"path": "../../../src/browser" "path": "../../../src/target-browser"
} }
] ]
} }
+6 -5
View File
@@ -11,10 +11,11 @@
"removeComments": true, "removeComments": true,
"paths": { "paths": {
"common/*": [ "common/*": [
"../../../src/common/*" "../../../src/primitives/*",
"../../../src/runtime/*",
], ],
"browser/*": [ "target-browser/*": [
"../../../src/browser/*" "../../../src/target-browser/*"
], ],
"*": [ "*": [
"./*" "./*"
@@ -31,10 +32,10 @@
], ],
"references": [ "references": [
{ {
"path": "../../../src/common" "path": "../../../src"
}, },
{ {
"path": "../../../src/browser" "path": "../../../src/target-browser"
}, },
{ {
"path": "../../../test/playwright" "path": "../../../test/playwright"
+20 -31
View File
@@ -1,6 +1,7 @@
## @xterm/addon-image ## @xterm/addon-image
Inline image output in xterm.js. Supports SIXEL and iTerm's inline image protocol (IIP). Inline image output in xterm.js. Supports SIXEL, iTerm's inline image protocol (IIP)
and partially Kitty's terminal graphics prtocol (TGP).
![](fixture/example.png) ![](fixture/example.png)
@@ -43,9 +44,6 @@ terminal.loadAddon(imageAddon);
### General Notes ### General Notes
- *IMPORTANT:* The worker approach as done in previous releases got removed.
The addon contructor no longer expects a worker path as first argument.
- By default the addon will activate these `windowOptions` reports on the terminal: - By default the addon will activate these `windowOptions` reports on the terminal:
- getWinSizePixels (CSI 14 t) - getWinSizePixels (CSI 14 t)
- getCellSizePixels (CSI 16 t) - getCellSizePixels (CSI 16 t)
@@ -73,7 +71,7 @@ terminal.loadAddon(imageAddon);
- **Cursor Positioning** - **Cursor Positioning**
If scrolling is set, the cursor will be placed at the first image column of the last image row (VT340 mode). If scrolling is set, the cursor will be placed at the first image column of the last image row (VT340 mode).
Other cursor positioning modes as used by xterm or mintty are not supported. Other cursor positioning modes as used by xterm or mintty are not supported for sixel.
- **SIXEL Palette Handling** - **SIXEL Palette Handling**
By default the addon limits the palette size to 256 registers (as demanded by the DEC specification). By default the addon limits the palette size to 256 registers (as demanded by the DEC specification).
@@ -100,17 +98,24 @@ terminal.loadAddon(imageAddon);
Set by default, change it with `{iipSupport: true}`. Set by default, change it with `{iipSupport: true}`.
The IIP implementation has the following features / restrictions (sequence will silently fail for unmet conditions): The IIP implementation has the following features / restrictions (sequence will silently fail for unmet conditions):
- Supported formats: PNG, JPEG and GIF - Supported formats: PNG, JPEG, GIF and QOI
- No animation support. - No animation support.
- Image type hinting is not supported (always deducted from data header). - Image type hinting is not supported (always deducted from data header).
- File download is not supported. - File download is not supported.
- Filename gets parsed but not used. - Filename gets parsed but not used.
- Strict base64 handling as of RFC4648 §4 (standard alphabet, optional padding, no separator bytes allowed). - Strict base64 handling as of RFC4648 §4 (standard alphabet, optional padding, no separator bytes allowed).
- Payload size may not exceed CEIL(sizeParameter * 4 / 3).
- Image scaling beyond terminal viewport size is allowed (e.g. `width=200%`). - Image scaling beyond terminal viewport size is allowed (e.g. `width=200%`).
- Image pixel size is restricted by `pixelLimit` (pre- and post resizing). - Image pixel size is restricted by `pixelLimit` (pre- and post resizing).
- Size parameter is restricted by `iipSizeLimit`. - Playload size is restricted by `iipSizeLimit`.
- Cursor positioning behaves the same as for sixel (see above). - size parameter is not mandatory anymore.
- Cursor gets positioned at the next cell of the last image line.
- ReportCellSize sequence is supported.
- Hi-res display support is currently limited (image gets blurred).
- **Kitty Graphics Support (TGP)**
Set by default, change it with `{kittySupport: true}`.
Note that the kitty graphics support is still WIP.
### Storage and Drawing Settings ### Storage and Drawing Settings
@@ -127,6 +132,7 @@ The addon exposes two properties to interact with the storage limits at runtime:
By default the addon will show a placeholder pattern for evicted images that are still part By default the addon will show a placeholder pattern for evicted images that are still part
of the terminal (e.g. in the scrollback). The pattern can be deactivated by toggling `showPlaceholder`. of the terminal (e.g. in the scrollback). The pattern can be deactivated by toggling `showPlaceholder`.
### Image Data Retrieval ### Image Data Retrieval
The addon provides the following API endpoints to retrieve raw image data as canvas: The addon provides the following API endpoints to retrieve raw image data as canvas:
@@ -140,6 +146,7 @@ The addon provides the following API endpoints to retrieve raw image data as can
The buffer position is the 0-based absolute index (including scrollback at top). The buffer position is the 0-based absolute index (including scrollback at top).
Note that the canvas gets created and data copied over for every call, thus it is not suitable for performance critical actions. Note that the canvas gets created and data copied over for every call, thus it is not suitable for performance critical actions.
### Memory Usage ### Memory Usage
The addon does most image processing in Javascript and therefore can occupy a rather big amount of memory. To get an idea where the memory gets eaten, lets look at the data flow and processing steps: The addon does most image processing in Javascript and therefore can occupy a rather big amount of memory. To get an idea where the memory gets eaten, lets look at the data flow and processing steps:
@@ -180,8 +187,8 @@ _How can I adjust the memory usage?_
A constructor setting, thus you would have to anticipate, whether (multiple) terminals in your page gonna do lots of concurrent decoding. Since this is normally not the case and the memory usage is only temporarily peaking, a rather high value should work even with multiple terminals in one page. A constructor setting, thus you would have to anticipate, whether (multiple) terminals in your page gonna do lots of concurrent decoding. Since this is normally not the case and the memory usage is only temporarily peaking, a rather high value should work even with multiple terminals in one page.
- `storageLimit` - `storageLimit`
A constructor and a runtime setting. In conjunction with `storageUsage` you can do runtime checks and adjust the limit to your needs. If you have to lower the limit below the current usage, images will be removed in FIFO order and may turn into a placeholder in the terminal's scrollback (if `showPlaceholder` is set). When adjusting keep in mind to leave enough room for memory peaking for decoding. A constructor and a runtime setting. In conjunction with `storageUsage` you can do runtime checks and adjust the limit to your needs. If you have to lower the limit below the current usage, images will be removed in FIFO order and may turn into a placeholder in the terminal's scrollback (if `showPlaceholder` is set). When adjusting keep in mind to leave enough room for memory peaking for decoding.
- `sixelSizeLimit` - `sixelSizeLimit | iipSizeLimit | kittySizeLimit`
A constructor setting. This has only a small impact on peaking memory during decoding. It is meant to avoid processing of overly big or broken SIXEL sequences at an earlier phase, thus may stop the decoder from entering its memory intensive task for potentially invalid data. Constructor settings. This has only a small impact on peaking memory during decoding. It is meant to avoid processing of overly big or broken image sequences at an earlier phase, thus may stop the invoked decoders from entering memory intensive tasks for potentially invalid data.
### Terminal Interaction ### Terminal Interaction
@@ -211,23 +218,5 @@ _How can I adjust the memory usage?_
### Status ### Status
- Sixel support and image handling in xterm.js is considered beta quality. - Sixel and IIP support and image handling in xterm.js is considered beta quality.
- IIP support is in alpha stage. Please file a bug for any awkwardities. - Kitty support is in alpha stage. Please file a bug for any awkwardities or missing features.
### Changelog
- 0.5.0 integrate with xtermjs base repo (at v0.4.3)
- 0.4.3 defer canvas creation
- 0.4.2 fix image canvas resize
- 0.4.1 compat release for xterm.js 5.2.0
- 0.4.0 IIP support
- 0.3.1 compat release for xterm.js 5.1.0
- 0.3.0 important change: worker removed from addon
- 0.2.0 compat release for xterm.js 5.0.0
- 0.1.3 bugfix: avoid striping
- 0.1.2 bugfix: reset clear flag
- 0.1.1 bugfixes:
- clear sticky image tiles on render
- create folder from bootstrap.sh
- fix peer dependency in package.json
Binary file not shown.
+70 -16
View File
@@ -8,7 +8,7 @@ import { IIPImageStorage } from './IIPImageStorage';
import { CELL_SIZE_DEFAULT } from './ImageStorage'; import { CELL_SIZE_DEFAULT } from './ImageStorage';
import Base64Decoder from 'xterm-wasm-parts/lib/base64/Base64Decoder.wasm'; import Base64Decoder from 'xterm-wasm-parts/lib/base64/Base64Decoder.wasm';
import QoiDecoder from 'xterm-wasm-parts/lib/qoi/QoiDecoder.wasm'; import QoiDecoder from 'xterm-wasm-parts/lib/qoi/QoiDecoder.wasm';
import { HeaderParser, IHeaderFields, HeaderState } from './IIPHeaderParser'; import { HeaderParser, IHeaderFields, HeaderState, SequenceType } from './IIPHeaderParser';
import { imageType, UNSUPPORTED_TYPE } from './IIPMetrics'; import { imageType, UNSUPPORTED_TYPE } from './IIPMetrics';
// Local const enum mirror - esbuild can't inline const enums from external packages // Local const enum mirror - esbuild can't inline const enums from external packages
@@ -23,6 +23,7 @@ const enum DecoderConst {
// default IIP header values // default IIP header values
const DEFAULT_HEADER: IHeaderFields = { const DEFAULT_HEADER: IHeaderFields = {
type: SequenceType.INVALID,
name: 'Unnamed file', name: 'Unnamed file',
size: 0, size: 0,
width: 'auto', width: 'auto',
@@ -39,6 +40,8 @@ export class IIPHandler implements IOscHandler, IResetHandler {
private _dec: Base64Decoder; private _dec: Base64Decoder;
private _qoiDec: QoiDecoder; private _qoiDec: QoiDecoder;
private _metrics = UNSUPPORTED_TYPE; private _metrics = UNSUPPORTED_TYPE;
private _isMultipart = false;
private _abortMulti = false;
constructor( constructor(
private readonly _opts: IImageAddonOptions, private readonly _opts: IImageAddonOptions,
@@ -52,11 +55,14 @@ export class IIPHandler implements IOscHandler, IResetHandler {
this._qoiDec = new QoiDecoder(DecoderConst.KEEP_DATA); this._qoiDec = new QoiDecoder(DecoderConst.KEEP_DATA);
} }
public reset(): void {} public reset(): void {
this._hp.reset();
this._dec.release();
this._qoiDec.release();
}
public start(): void { public start(): void {
this._aborted = false; this._aborted = false;
this._header = DEFAULT_HEADER;
this._metrics = UNSUPPORTED_TYPE; this._metrics = UNSUPPORTED_TYPE;
this._hp.reset(); this._hp.reset();
} }
@@ -76,15 +82,27 @@ export class IIPHandler implements IOscHandler, IResetHandler {
return; return;
} }
if (dataPos > 0) { if (dataPos > 0) {
this._header = Object.assign({}, DEFAULT_HEADER, this._hp.fields); const seqType = this._hp.fields.type;
if (!this._header.inline || !this._header.size || this._header.size > this._opts.iipSizeLimit) { if (seqType === SequenceType.FILE) {
if (this._isMultipart) {
this._isMultipart = false;
this._abortMulti = false;
this._dec.release();
}
this._header = Object.assign({}, DEFAULT_HEADER, this._hp.fields);
if (!this._header.inline) {
this._aborted = true;
return;
}
this._dec.init();
} else if (this._abortMulti) {
this._aborted = true; this._aborted = true;
return; return;
} }
this._dec.init();
if ((this._dec.put(data.subarray(dataPos, end)) as number) !== DecoderConst.OK) { if ((this._dec.put(data.subarray(dataPos, end)) as number) !== DecoderConst.OK) {
this._dec.release(); this._dec.release();
this._aborted = true; this._aborted = true;
if (this._isMultipart) this._abortMulti = true;
} }
} }
} }
@@ -93,22 +111,58 @@ export class IIPHandler implements IOscHandler, IResetHandler {
public end(success: boolean): boolean | Promise<boolean> { public end(success: boolean): boolean | Promise<boolean> {
if (this._aborted) return true; if (this._aborted) return true;
if (this._hp.state !== HeaderState.END) {
if (this._hp.end()) return true;
}
const seqType = this._hp.fields.type;
if (seqType === SequenceType.FILEPART) return true;
if (seqType === SequenceType.REPORTCELLSIZE) {
// OSC 1337 ; ReportCellSize=[height];[width];[scale] ST
let width = CELL_SIZE_DEFAULT.width;
let height = CELL_SIZE_DEFAULT.height;
if (this._renderer.dimensions) {
width = this._renderer.dimensions.css.canvas.width / this._coreTerminal.cols;
height = this._renderer.dimensions.css.canvas.height / this._coreTerminal.rows;
}
const scale = this._coreTerminal._core._coreBrowserService?.dpr ?? 1;
const report = `\x1b]1337;ReportCellSize=${height.toFixed(3)};${width.toFixed(3)};${scale.toFixed(3)}\x1b\\`;
this._coreTerminal.input(report, false);
return true;
}
if (seqType === SequenceType.MULTIPARTFILE) {
this._header = Object.assign({}, DEFAULT_HEADER, this._hp.fields);
this._isMultipart = true;
this._abortMulti = false;
this._dec.release();
this._dec.init();
return true;
}
if (seqType === SequenceType.FILEEND) {
if (!this._isMultipart) return true;
this._isMultipart = false;
if (this._abortMulti || this._header.type !== SequenceType.MULTIPARTFILE) return true;
}
// fallthrough for SequenceType.FILE & SequenceType.FILEEND
let w = 0; let w = 0;
let h = 0; let h = 0;
// early exit condition chain // early exit condition chain
let cond: number | boolean = true; let cond: number | boolean;
if (cond = success) { if (cond = success) {
if (cond = !this._dec.end()) { if (cond = !this._dec.end()) {
if (cond = this._dec.data8.length === this._header.size) { this._metrics = imageType(this._dec.data8);
this._metrics = imageType(this._dec.data8); if (cond = this._metrics.mime !== 'unsupported') {
if (cond = this._metrics.mime !== 'unsupported') { w = this._metrics.width;
w = this._metrics.width; h = this._metrics.height;
h = this._metrics.height; if (cond = w && h && w * h < this._opts.pixelLimit) {
if (cond = w && h && w * h < this._opts.pixelLimit) { [w, h] = this._resize(w, h).map(Math.floor);
[w, h] = this._resize(w, h).map(Math.floor); cond = w && h && w * h < this._opts.pixelLimit;
cond = w && h && w * h < this._opts.pixelLimit;
}
} }
} }
} }
+129 -7
View File
@@ -4,19 +4,20 @@
*/ */
import { assert } from 'chai'; import { assert } from 'chai';
import { HeaderParser, HeaderState, IHeaderFields } from './IIPHeaderParser'; import { HeaderParser, HeaderState, IHeaderFields, SequenceType } from './IIPHeaderParser';
const CASES: [string, IHeaderFields][] = [ const CASES: [string, IHeaderFields][] = [
['File=size=123456;name=dGVzdA==:', {name: 'test', size: 123456}], ['File=size=123456;name=dGVzdA==:', {type: SequenceType.FILE, name: 'test', size: 123456}],
['File=size=123456;name=dGVzdA:', {name: 'test', size: 123456}], ['File=size=123456;name=dGVzdA:', {type: SequenceType.FILE, name: 'test', size: 123456}],
// utf-8 encoding in name // utf-8 encoding in name
['File=size=123456;name=w7xtbMOkdXTDnw==:', {name: 'ümläutß', size: 123456}], ['File=size=123456;name=w7xtbMOkdXTDnw==:', {type: SequenceType.FILE, name: 'ümläutß', size: 123456}],
['File=size=123456;name=w7xtbMOkdXTDnw:', {name: 'ümläutß', size: 123456}], ['File=size=123456;name=w7xtbMOkdXTDnw:', {type: SequenceType.FILE, name: 'ümläutß', size: 123456}],
// full header spec // full header spec
[ [
'File=inline=1;width=10px;height=20%;preserveAspectRatio=1;size=123456;name=w7xtbMOkdXTDnw:', 'File=inline=1;width=10px;height=20%;preserveAspectRatio=1;size=123456;name=w7xtbMOkdXTDnw:',
{ {
type: SequenceType.FILE,
inline: 1, inline: 1,
width: '10px', width: '10px',
height: '20%', height: '20%',
@@ -28,6 +29,7 @@ const CASES: [string, IHeaderFields][] = [
[ [
'File=inline=1;width=auto;height=20;preserveAspectRatio=1;size=123456;name=w7xtbMOkdXTDnw:', 'File=inline=1;width=auto;height=20;preserveAspectRatio=1;size=123456;name=w7xtbMOkdXTDnw:',
{ {
type: SequenceType.FILE,
inline: 1, inline: 1,
width: 'auto', width: 'auto',
height: '20', height: '20',
@@ -101,7 +103,7 @@ describe('IIPHeaderParser', () => {
let res = hp.parse(inp, 0, inp.length); let res = hp.parse(inp, 0, inp.length);
assert.strictEqual(res, inp.length); assert.strictEqual(res, inp.length);
assert.strictEqual(hp.state, HeaderState.END); assert.strictEqual(hp.state, HeaderState.END);
assert.deepEqual(hp.fields, {name: 'test', size: 0}); assert.deepEqual(hp.fields, {type: SequenceType.FILE, name: 'test', size: 0});
hp.reset(); hp.reset();
inp = fromBs(CASES[0][0]); inp = fromBs(CASES[0][0]);
res = hp.parse(inp, 0, inp.length); res = hp.parse(inp, 0, inp.length);
@@ -115,7 +117,7 @@ describe('IIPHeaderParser', () => {
let res = hp.parse(inp, 0, inp.length); let res = hp.parse(inp, 0, inp.length);
assert.strictEqual(res, inp.length); assert.strictEqual(res, inp.length);
assert.strictEqual(hp.state, HeaderState.END); assert.strictEqual(hp.state, HeaderState.END);
assert.deepEqual(hp.fields, {name: '', size: 123456}); assert.deepEqual(hp.fields, {type: SequenceType.FILE, name: '', size: 123456});
hp.reset(); hp.reset();
inp = fromBs(CASES[0][0]); inp = fromBs(CASES[0][0]);
res = hp.parse(inp, 0, inp.length); res = hp.parse(inp, 0, inp.length);
@@ -135,4 +137,124 @@ describe('IIPHeaderParser', () => {
assert.strictEqual(hp.state, HeaderState.END); assert.strictEqual(hp.state, HeaderState.END);
assert.deepEqual(hp.fields, CASES[0][1]); assert.deepEqual(hp.fields, CASES[0][1]);
}); });
it('FilePart sequence', () => {
const hp = new HeaderParser();
const inp = fromBs('FilePart=w7xtbMOkdXTDnw');
const res = hp.parse(inp, 0, inp.length);
assert.strictEqual(res, 9);
assert.strictEqual(hp.state, HeaderState.END);
assert.deepEqual(hp.fields.type, SequenceType.FILEPART);
});
it('FilePart sequence - bytewise', () => {
const hp = new HeaderParser();
const inp = fromBs('FilePart=w7xtbMOkdXTDnw');
let res = -2;
let pos = 0;
while (res === -2 && pos < inp.length) {
res = hp.parse(new Uint32Array([inp[pos++]]), 0, 1);
}
assert.strictEqual(res, 1);
assert.strictEqual(hp.state, HeaderState.END);
assert.deepEqual(hp.fields.type, SequenceType.FILEPART);
});
it('MultipartFile sequence', () => {
const hp = new HeaderParser();
const inp = fromBs('MultipartFile=inline=1;width=10px;height=20%;preserveAspectRatio=1;size=123456;name=w7xtbMOkdXTDnw');
let res = hp.parse(inp, 0, inp.length);
assert.strictEqual(res, -2);
assert.strictEqual(hp.state, HeaderState.VALUE);
res = hp.end();
assert.strictEqual(res, 0);
assert.strictEqual(hp.state, HeaderState.END);
assert.deepEqual(
hp.fields,
{
type: SequenceType.MULTIPARTFILE,
inline: 1,
width: '10px',
height: '20%',
preserveAspectRatio: 1,
size: 123456,
name: 'ümläutß'
}
);
});
it('MultipartFile sequence - bytewise', () => {
const hp = new HeaderParser();
const inp = fromBs('MultipartFile=inline=1;width=10px;height=20%;preserveAspectRatio=1;size=123456;name=w7xtbMOkdXTDnw');
let res = -2;
let pos = 0;
while (res === -2 && pos < inp.length) {
res = hp.parse(new Uint32Array([inp[pos++]]), 0, 1);
}
assert.strictEqual(res, -2);
assert.strictEqual(hp.state, HeaderState.VALUE);
res = hp.end();
assert.strictEqual(res, 0);
assert.strictEqual(hp.state, HeaderState.END);
assert.deepEqual(
hp.fields,
{
type: SequenceType.MULTIPARTFILE,
inline: 1,
width: '10px',
height: '20%',
preserveAspectRatio: 1,
size: 123456,
name: 'ümläutß'
}
);
});
it('FileEnd sequence', () => {
const hp = new HeaderParser();
const inp = fromBs('FileEnd');
let res = hp.parse(inp, 0, inp.length);
assert.strictEqual(res, -2);
assert.strictEqual(hp.state, HeaderState.START);
res = hp.end();
assert.strictEqual(res, 0);
assert.strictEqual(hp.state, HeaderState.END);
assert.deepEqual(hp.fields.type, SequenceType.FILEEND);
});
it('FileEnd sequence - bytewise', () => {
const hp = new HeaderParser();
const inp = fromBs('FileEnd');
let res = -2;
let pos = 0;
while (res === -2 && pos < inp.length) {
res = hp.parse(new Uint32Array([inp[pos++]]), 0, 1);
}
assert.strictEqual(res, -2);
assert.strictEqual(hp.state, HeaderState.START);
res = hp.end();
assert.strictEqual(res, 0);
assert.strictEqual(hp.state, HeaderState.END);
assert.deepEqual(hp.fields.type, SequenceType.FILEEND);
});
it('ReportCellSize sequence', () => {
const hp = new HeaderParser();
const inp = fromBs('ReportCellSize');
let res = hp.parse(inp, 0, inp.length);
assert.strictEqual(res, -2);
assert.strictEqual(hp.state, HeaderState.START);
res = hp.end();
assert.strictEqual(res, 0);
assert.strictEqual(hp.state, HeaderState.END);
assert.deepEqual(hp.fields, { type: SequenceType.REPORTCELLSIZE });
});
it('ReportCellSize sequence - bytewise', () => {
const hp = new HeaderParser();
const inp = fromBs('ReportCellSize');
let res = -2;
let pos = 0;
while (res === -2 && pos < inp.length) {
res = hp.parse(new Uint32Array([inp[pos++]]), 0, 1);
}
assert.strictEqual(res, -2);
assert.strictEqual(hp.state, HeaderState.START);
res = hp.end();
assert.strictEqual(res, 0);
assert.strictEqual(hp.state, HeaderState.END);
assert.deepEqual(hp.fields, { type: SequenceType.REPORTCELLSIZE });
});
}); });
+86 -11
View File
@@ -6,9 +6,27 @@
// eslint-disable-next-line // eslint-disable-next-line
declare const Buffer: any; declare const Buffer: any;
export const enum HeaderState {
START = 0,
ABORT = 1,
KEY = 2,
VALUE = 3,
END = 4
}
export const enum SequenceType {
INVALID = 0,
FILE = 1,
MULTIPARTFILE = 2,
FILEPART = 3,
FILEEND = 4,
REPORTCELLSIZE = 5
}
export interface IHeaderFields { export interface IHeaderFields {
[key: string]: number | string | Uint32Array | null | undefined; [key: string]: number | string | Uint32Array | null | undefined;
// sequence type
type: SequenceType;
// base-64 encoded filename. Defaults to "Unnamed file". // base-64 encoded filename. Defaults to "Unnamed file".
name: string; name: string;
// File size in bytes. The file transfer will be canceled if this size is exceeded. // File size in bytes. The file transfer will be canceled if this size is exceeded.
@@ -29,14 +47,6 @@ export interface IHeaderFields {
inline?: number; inline?: number;
} }
export const enum HeaderState {
START = 0,
ABORT = 1,
KEY = 2,
VALUE = 3,
END = 4
}
// field value decoders // field value decoders
// ASCII bytes to string // ASCII bytes to string
@@ -92,7 +102,19 @@ const DECODERS: {[key: string]: (v: Uint32Array) => number | string} = {
}; };
// sequence type markers
// File
const FILE_MARKER = [70, 105, 108, 101]; const FILE_MARKER = [70, 105, 108, 101];
// MultipartFile
const MULTIPARTFILE_MARKER = [77, 117, 108, 116, 105, 112, 97, 114, 116, 70, 105, 108, 101];
// FilePart
const FILEPART_MARKER = [70, 105, 108, 101, 80, 97, 114, 116];
// FileEnd
const FILEEND_MARKER = [70, 105, 108, 101, 69, 110, 100];
// ReportCellSize
const REPORTCELLSIZE_MARKER = [82, 101, 112, 111, 114, 116, 67, 101, 108, 108, 83, 105, 122, 101];
// max allowed chars for sequence header
const MAX_FIELDCHARS = 1024; const MAX_FIELDCHARS = 1024;
@@ -111,12 +133,43 @@ export class HeaderParser {
this._key = ''; this._key = '';
} }
public end(): number {
if (this.state === HeaderState.START) {
if (this._position === FILEEND_MARKER.length) {
for (let k = 0; k < FILEEND_MARKER.length; ++k) {
if (this._buffer[k] !== FILEEND_MARKER[k]) return this._a();
}
this.fields['type'] = SequenceType.FILEEND;
this.state = HeaderState.END;
return 0;
}
if (this._position === REPORTCELLSIZE_MARKER.length) {
for (let k = 0; k < REPORTCELLSIZE_MARKER.length; ++k) {
if (this._buffer[k] !== REPORTCELLSIZE_MARKER[k]) return this._a();
}
this.fields['type'] = SequenceType.REPORTCELLSIZE;
this.state = HeaderState.END;
return 0;
}
return this._a();
}
if (this.state === HeaderState.END) return 0;
if (this.state === HeaderState.VALUE
&& this.fields.type === SequenceType.MULTIPARTFILE
) {
if (!this._storeValue(this._position)) return this._a();
this.state = HeaderState.END;
return 0;
}
return this._a();
}
public parse(data: Uint32Array, start: number, end: number): number { public parse(data: Uint32Array, start: number, end: number): number {
let state = this.state; let state = this.state;
let pos = this._position; let pos = this._position;
const buffer = this._buffer; const buffer = this._buffer;
if (state === HeaderState.ABORT || state === HeaderState.END) return -1; if (state === HeaderState.ABORT || state === HeaderState.END) return -1;
if (state === HeaderState.START && pos > 6) return -1; if (state === HeaderState.START && pos > 14) return -1;
for (let i = start; i < end; ++i) { for (let i = start; i < end; ++i) {
const c = data[i]; const c = data[i];
switch (c) { switch (c) {
@@ -127,8 +180,29 @@ export class HeaderParser {
break; break;
case 61: // = case 61: // =
if (state === HeaderState.START) { if (state === HeaderState.START) {
for (let k = 0; k < FILE_MARKER.length; ++k) { if (buffer[0] === 70) {
if (buffer[k] !== FILE_MARKER[k]) return this._a(); // 'File' or 'FilePart'
let k = 0;
for (; k < FILE_MARKER.length; ++k) {
if (buffer[k] !== FILE_MARKER[k]) return this._a();
}
this.fields['type'] = SequenceType.FILE;
if (pos === FILEPART_MARKER.length) {
for (; k < FILEPART_MARKER.length; ++k) {
if (buffer[k] !== FILEPART_MARKER[k]) return this._a();
}
this.fields['type'] = SequenceType.FILEPART;
this.state = HeaderState.END;
return i + 1;
}
} else if (buffer[0] === 77) {
// 'MultipartFile'
for (let k = 0; k < MULTIPARTFILE_MARKER.length; ++k) {
if (buffer[k] !== MULTIPARTFILE_MARKER[k]) return this._a();
}
this.fields['type'] = SequenceType.MULTIPARTFILE;
} else {
return this._a();
} }
state = HeaderState.KEY; state = HeaderState.KEY;
pos = 0; pos = 0;
@@ -158,6 +232,7 @@ export class HeaderParser {
} }
private _a(): number { private _a(): number {
this.fields.type = SequenceType.INVALID;
this.state = HeaderState.ABORT; this.state = HeaderState.ABORT;
return -1; return -1;
} }
+3 -1
View File
@@ -3,6 +3,7 @@
* @license MIT * @license MIT
*/ */
import { IAddImageOpts } from 'Types';
import { ImageStorage } from './ImageStorage'; import { ImageStorage } from './ImageStorage';
/** /**
@@ -12,6 +13,7 @@ import { ImageStorage } from './ImageStorage';
* - Always uses scrolling mode (cursor advances with image) * - Always uses scrolling mode (cursor advances with image)
*/ */
export class IIPImageStorage { export class IIPImageStorage {
private _addImageOpts: IAddImageOpts = { scrolling: true, layer: 'top', zIndex: 0, cursorPos: 'iip' };
constructor( constructor(
private readonly _storage: ImageStorage private readonly _storage: ImageStorage
) {} ) {}
@@ -21,6 +23,6 @@ export class IIPImageStorage {
* Always uses scrolling mode — cursor advances past the image. * Always uses scrolling mode — cursor advances past the image.
*/ */
public addImage(img: HTMLCanvasElement | ImageBitmap): void { public addImage(img: HTMLCanvasElement | ImageBitmap): void {
this._storage.addImage(img, true); this._storage.addImage(img, this._addImageOpts);
} }
} }
+2 -1
View File
@@ -30,7 +30,8 @@ const TEST_IMAGES: [string, IMetrics][] = [
['iphone_hdr_YES.jpg', { mime: 'image/jpeg', width: 3264, height: 2448 }], ['iphone_hdr_YES.jpg', { mime: 'image/jpeg', width: 3264, height: 2448 }],
['nikon-e950.jpg', { mime: 'image/jpeg', width: 800, height: 600 }], ['nikon-e950.jpg', { mime: 'image/jpeg', width: 800, height: 600 }],
['agfa-makernotes.jpg', { mime: 'image/jpeg', width: 8, height: 8 }], ['agfa-makernotes.jpg', { mime: 'image/jpeg', width: 8, height: 8 }],
['sony-alpha-6000.jpg', { mime: 'image/jpeg', width: 6000, height: 4000 }] ['sony-alpha-6000.jpg', { mime: 'image/jpeg', width: 6000, height: 4000 }],
['dice.qoi', { mime: 'image/qoi', width: 800, height: 600 }],
]; ];
+1 -6
View File
@@ -137,11 +137,6 @@ export class ImageAddon implements ITerminalAddon, IImageApi {
// enable size reports // enable size reports
if (this._opts.enableSizeReports) { if (this._opts.enableSizeReports) {
// const windowOptions = terminal.getOption('windowOptions');
// windowOptions.getWinSizePixels = true;
// windowOptions.getCellSizePixels = true;
// windowOptions.getWinSizeChars = true;
// terminal.setOption('windowOptions', windowOptions);
const windowOps = terminal.options.windowOptions ?? {}; const windowOps = terminal.options.windowOptions ?? {};
windowOps.getWinSizePixels = true; windowOps.getWinSizePixels = true;
windowOps.getCellSizePixels = true; windowOps.getCellSizePixels = true;
@@ -260,7 +255,7 @@ export class ImageAddon implements ITerminalAddon, IImageApi {
} }
private _report(s: string): void { private _report(s: string): void {
this._terminal?._core.coreService.triggerDataEvent(s); this._terminal?._core.input(s, false);
} }
private _decset(params: (number | number[])[]): boolean { private _decset(params: (number | number[])[]): boolean {
+1 -1
View File
@@ -146,7 +146,7 @@ export class ImageRenderer extends Disposable implements IDisposable {
public clearLines(start: number, end: number, layer?: ImageLayer): void { public clearLines(start: number, end: number, layer?: ImageLayer): void {
const y = start * (this.dimensions?.css.cell.height || 0); const y = start * (this.dimensions?.css.cell.height || 0);
const w = this.dimensions?.css.canvas.width || 0; const w = this.dimensions?.css.canvas.width || 0;
const h = (++end - start) * (this.dimensions?.css.cell.height || 0); const h = (end + 1 - start) * (this.dimensions?.css.cell.height || 0);
if (!layer || layer === 'top') { if (!layer || layer === 'top') {
this._layers.get('top')?.clearRect(0, y, w, h); this._layers.get('top')?.clearRect(0, y, w, h);
} }
+22 -13
View File
@@ -5,7 +5,11 @@
import { IDisposable } from '@xterm/xterm'; import { IDisposable } from '@xterm/xterm';
import { ImageRenderer } from './ImageRenderer'; import { ImageRenderer } from './ImageRenderer';
import { ITerminalExt, IExtendedAttrsImage, IImageAddonOptions, IImageSpec, IBufferLineExt, BgFlags, Cell, Content, ICellSize, ExtFlags, Attributes, UnderlineStyle, ImageLayer } from './Types'; import {
ITerminalExt, IExtendedAttrsImage, IImageAddonOptions, IImageSpec,
IBufferLineExt, BgFlags, Cell, Content, ICellSize, ExtFlags, Attributes,
UnderlineStyle, IAddImageOpts
} from './Types';
// fallback default cell size // fallback default cell size
@@ -235,13 +239,15 @@ export class ImageStorage implements IDisposable {
/** /**
* Method to add an image to the storage. * Method to add an image to the storage.
* @param img - The image to add (canvas or bitmap). * @param img - The image to add (canvas or bitmap).
* @param scrolling - When true, cursor advances with the image (lineFeed per row). * @param opts - Options for addImage:
* When false, image is placed at (0,0) and cursor is restored (DECSET 80 / sixel origin mode). * - scrolling: When true, cursor advances with the image.
* @param layer - Which canvas layer to render on ('top' or 'bottom'). * When false, image is placed at ORIGIN and cursor does not move.
* @param zIndex - Z-index for image layering within the same layer. * - layer: Which canvas layer to render on ('top' or 'bottom').
* - zIndex: Z-index for image layering within the same layer.
* - cursorPos: 'vt340' for bottom-left, 'iip' for bottom.right.
* @returns The internal image ID assigned to the stored image. * @returns The internal image ID assigned to the stored image.
*/ */
public addImage(img: HTMLCanvasElement | ImageBitmap, scrolling: boolean, layer: ImageLayer = 'top', zIndex: number = 0): number { public addImage(img: HTMLCanvasElement | ImageBitmap, opts: IAddImageOpts): number {
// never allow storage to exceed memory limit // never allow storage to exceed memory limit
this._evictOldest(img.width * img.height); this._evictOldest(img.width * img.height);
@@ -263,7 +269,7 @@ export class ImageStorage implements IDisposable {
let offset = originX; let offset = originX;
let tileCount = 0; let tileCount = 0;
if (!scrolling) { if (!opts.scrolling) {
buffer.x = 0; buffer.x = 0;
buffer.y = 0; buffer.y = 0;
offset = 0; offset = 0;
@@ -277,7 +283,7 @@ export class ImageStorage implements IDisposable {
this._writeToCell(line as IBufferLineExt, offset + col, imageId, row * cols + col); this._writeToCell(line as IBufferLineExt, offset + col, imageId, row * cols + col);
tileCount++; tileCount++;
} }
if (scrolling) { if (opts.scrolling) {
if (row < rows - 1) this._terminal._core._inputHandler.lineFeed(); if (row < rows - 1) this._terminal._core._inputHandler.lineFeed();
} else { } else {
if (++buffer.y >= termRows) break; if (++buffer.y >= termRows) break;
@@ -287,8 +293,12 @@ export class ImageStorage implements IDisposable {
this._terminal._core._inputHandler._dirtyRowTracker.markDirty(buffer.y); this._terminal._core._inputHandler._dirtyRowTracker.markDirty(buffer.y);
// cursor positioning modes // cursor positioning modes
if (scrolling) { if (opts.scrolling) {
buffer.x = offset; if (opts.cursorPos === 'iip') {
buffer.x = Math.min(offset + cols, termCols);
} else {
buffer.x = offset;
}
} else { } else {
buffer.x = originX; buffer.x = originX;
buffer.y = originY; buffer.y = originY;
@@ -331,8 +341,8 @@ export class ImageStorage implements IDisposable {
marker: endMarker || undefined, marker: endMarker || undefined,
tileCount, tileCount,
bufferType: this._terminal.buffer.active.type, bufferType: this._terminal.buffer.active.type,
layer, layer: opts.layer,
zIndex zIndex: opts.zIndex
}; };
// finally add the image // finally add the image
@@ -455,7 +465,6 @@ export class ImageStorage implements IDisposable {
if (!nextE || nextE.imageId !== imageId || nextE.tileId !== startTile + count) { if (!nextE || nextE.imageId !== imageId || nextE.tileId !== startTile + count) {
break; break;
} }
e = nextE;
count++; count++;
} }
col--; col--;
+4 -2
View File
@@ -4,7 +4,7 @@
*/ */
import { ImageStorage, CELL_SIZE_DEFAULT } from './ImageStorage'; import { ImageStorage, CELL_SIZE_DEFAULT } from './ImageStorage';
import { IImageAddonOptions, ITerminalExt } from './Types'; import { IImageAddonOptions, ITerminalExt, IAddImageOpts } from './Types';
import { ImageRenderer } from './ImageRenderer'; import { ImageRenderer } from './ImageRenderer';
/** /**
@@ -15,6 +15,7 @@ import { ImageRenderer } from './ImageRenderer';
* - advanceCursor for empty sixels carrying only height * - advanceCursor for empty sixels carrying only height
*/ */
export class SixelImageStorage { export class SixelImageStorage {
private _addImageOpts: IAddImageOpts = { scrolling: true, layer: 'top', zIndex: 0, cursorPos: 'vt340' };
constructor( constructor(
private readonly _storage: ImageStorage, private readonly _storage: ImageStorage,
private readonly _opts: IImageAddonOptions, private readonly _opts: IImageAddonOptions,
@@ -27,7 +28,8 @@ export class SixelImageStorage {
* Cursor behavior depends on the sixelScrolling option (DECSET 80). * Cursor behavior depends on the sixelScrolling option (DECSET 80).
*/ */
public addImage(img: HTMLCanvasElement | ImageBitmap): void { public addImage(img: HTMLCanvasElement | ImageBitmap): void {
this._storage.addImage(img, this._opts.sixelScrolling); this._addImageOpts.scrolling = this._opts.sixelScrolling;
this._storage.addImage(img, this._addImageOpts);
} }
/** /**
+11 -3
View File
@@ -10,9 +10,9 @@ import { Attributes, BgFlags, Content, ExtFlags, UnderlineStyle } from 'common/b
import type { AttributeData } from 'common/buffer/AttributeData'; import type { AttributeData } from 'common/buffer/AttributeData';
import type { IParams, IDcsHandler, IOscHandler, IApcHandler, IEscapeSequenceParser } from 'common/parser/Types'; import type { IParams, IDcsHandler, IOscHandler, IApcHandler, IEscapeSequenceParser } from 'common/parser/Types';
import type { IBufferLine, IExtendedAttrs, IInputHandler } from 'common/Types'; import type { IBufferLine, IExtendedAttrs, IInputHandler } from 'common/Types';
import type { ITerminal, ReadonlyColorSet } from 'browser/Types'; import type { ITerminal, ReadonlyColorSet } from 'target-browser/Types';
import type { IRenderDimensions } from 'browser/renderer/shared/Types'; import type { IRenderDimensions } from 'target-browser/renderer/shared/Types';
import type { ICoreBrowserService, IRenderService, IThemeService } from 'browser/services/Services'; import type { ICoreBrowserService, IRenderService, IThemeService } from 'target-browser/services/Services';
export const enum Cell { export const enum Cell {
CONTENT = 0, // codepoint and wcwidth information (enum Content) CONTENT = 0, // codepoint and wcwidth information (enum Content)
@@ -100,6 +100,14 @@ export interface ICellSize {
} }
export type ImageLayer = 'top' | 'bottom'; export type ImageLayer = 'top' | 'bottom';
export type CursorPos = 'vt340' | 'iip';
export interface IAddImageOpts {
scrolling: boolean;
layer: ImageLayer;
zIndex: number;
cursorPos: CursorPos;
}
export interface IImageSpec { export interface IImageSpec {
orig: HTMLCanvasElement | ImageBitmap | undefined; orig: HTMLCanvasElement | ImageBitmap | undefined;
@@ -5,7 +5,7 @@
import { IDisposable } from '@xterm/xterm'; import { IDisposable } from '@xterm/xterm';
import { ImageStorage } from '../ImageStorage'; import { ImageStorage } from '../ImageStorage';
import { ImageLayer } from '../Types'; import { ImageLayer, IAddImageOpts } from '../Types';
import { IKittyImageData } from './KittyGraphicsTypes'; import { IKittyImageData } from './KittyGraphicsTypes';
// Kitty-specific image storage controller. // Kitty-specific image storage controller.
@@ -42,6 +42,7 @@ export class KittyImageStorage implements IDisposable {
this._images.delete(kittyId); this._images.delete(kittyId);
} }
}; };
private _addImageOpts: IAddImageOpts = { scrolling: true, layer: 'top', zIndex: 0, cursorPos: 'iip' };
constructor( constructor(
private readonly _storage: ImageStorage private readonly _storage: ImageStorage
@@ -98,7 +99,10 @@ export class KittyImageStorage implements IDisposable {
if (oldStorageId !== undefined) { if (oldStorageId !== undefined) {
this._storageIdToKittyId.delete(oldStorageId); this._storageIdToKittyId.delete(oldStorageId);
} }
const storageId = this._storage.addImage(image, scrolling, layer, zIndex); this._addImageOpts.scrolling = scrolling;
this._addImageOpts.layer = layer;
this._addImageOpts.zIndex = zIndex;
const storageId = this._storage.addImage(image, this._addImageOpts);
this._kittyIdToStorageId.set(kittyId, storageId); this._kittyIdToStorageId.set(kittyId, storageId);
this._storageIdToKittyId.set(storageId, kittyId); this._storageIdToKittyId.set(storageId, kittyId);
} }
+7 -4
View File
@@ -12,8 +12,11 @@
"../../../node_modules/@types/mocha" "../../../node_modules/@types/mocha"
], ],
"paths": { "paths": {
"browser/*": [ "../../../src/browser/*" ], "target-browser/*": [ "../../../src/target-browser/*" ],
"common/*": [ "../../../src/common/*" ], "common/*": [
"../../../src/primitives/*",
"../../../src/runtime/*",
],
"@xterm/addon-image": [ "../typings/addon-image.d.ts" ], "@xterm/addon-image": [ "../typings/addon-image.d.ts" ],
"*": [ "./*" ] "*": [ "./*" ]
} }
@@ -23,7 +26,7 @@
"../../../typings/xterm.d.ts" "../../../typings/xterm.d.ts"
], ],
"references": [ "references": [
{ "path": "../../../src/browser" }, { "path": "../../../src/target-browser" },
{ "path": "../../../src/common" } { "path": "../../../src" }
] ]
} }
@@ -290,6 +290,67 @@ test.describe('ImageAddon', () => {
}); });
}); });
test.describe('IIP support', () => {
test('size params is optional/informative', async () => {
// too small size param
await ctx.proxy.write(`\x1b]1337;File=inline=1;size=5:${PALETTE_PNG_BASE64}\x07`);
deepStrictEqual(await getOrigSize(1), [640, 80]);
// no size aparm at all
await ctx.proxy.write(`\x1b[10H\x1b]1337;File=inline=1:${PALETTE_QOI_BASE64}\x07`);
deepStrictEqual(await getOrigSize(2), [640, 80]);
});
test.skip('FilePart support - bytewise', async () => {
// opener
await ctx.proxy.write(`\x1b]1337;MultipartFile=inline=1\x07`);
// byte-wise
for (let i = 0; i < PALETTE_PNG_BASE64.length; ++i) {
await ctx.proxy.write(`\x1b]1337;FilePart=${PALETTE_PNG_BASE64[i]}\x07`);
}
// finalizer
await ctx.proxy.write(`\x1b]1337;FileEnd\x07`);
deepStrictEqual(await getOrigSize(1), [640, 80]);
});
test('FilePart support - chunks', async () => {
// opener
await ctx.proxy.write(`\x1b]1337;MultipartFile=inline=1\x07`);
// chunks
for (let i = 0; i < PALETTE_PNG_BASE64.length; i += 256) {
await ctx.proxy.write(`\x1b]1337;FilePart=${PALETTE_PNG_BASE64.slice(i, i + 256)}\x07`);
}
// finalizer
await ctx.proxy.write(`\x1b]1337;FileEnd\x07`);
deepStrictEqual(await getOrigSize(1), [640, 80]);
});
test('FilePart support - edgecases', async () => {
// multiple opener do not harm
for (let i = 0; i < 10; ++i) {
await ctx.proxy.write(`\x1b]1337;MultipartFile=inline=1\x07`);
}
// multiple finalizer do not harm
for (let i = 0; i < 5; ++i) {
await ctx.proxy.write(`\x1b]1337;FileEnd\x07`);
}
// chunks w'o opener are ignored
for (let i = 0; i < PALETTE_PNG_BASE64.length; i += 256) {
await ctx.proxy.write(`\x1b]1337;FilePart=${PALETTE_PNG_BASE64.slice(i, i + 256)}\x07`);
}
await ctx.proxy.write(`\x1b]1337;FileEnd\x07`);
pollFor(ctx.page, 'window.imageAddon._storage._images.size', 0);
});
test('FilePart support - other IIP sequence cancels chunked image', async () => {
// opener
await ctx.proxy.write(`\x1b]1337;MultipartFile=inline=1\x07`);
// chunks
for (let i = 0; i < PALETTE_PNG_BASE64.length; i += 256) {
await ctx.proxy.write(`\x1b]1337;FilePart=${PALETTE_PNG_BASE64.slice(i, i + 256)}\x07`);
}
// finalizer skipped
// write spinfox.png
await ctx.proxy.write(TESTDATA_IIP[1][0]);
deepStrictEqual(await getOrigSize(1), TESTDATA_IIP[1][1]);
});
});
test.describe('IIP support - testimages', () => { test.describe('IIP support - testimages', () => {
test('palette.png', async () => { test('palette.png', async () => {
await ctx.proxy.write(TESTDATA_IIP[0][0]); await ctx.proxy.write(TESTDATA_IIP[0][0]);
+6 -12
View File
@@ -539,7 +539,6 @@ test.describe('Kitty Graphics Protocol', () => {
test.describe('Query support (a=q)', () => { test.describe('Query support (a=q)', () => {
test('responds with OK for capability query without payload', async () => { test('responds with OK for capability query without payload', async () => {
let response = '';
await ctx.page.evaluate(() => { await ctx.page.evaluate(() => {
(window as any).kittyResponse = ''; (window as any).kittyResponse = '';
(window as any).term.onData((data: string) => { (window as any).kittyResponse = data; }); (window as any).term.onData((data: string) => { (window as any).kittyResponse = data; });
@@ -548,12 +547,11 @@ test.describe('Kitty Graphics Protocol', () => {
await ctx.proxy.write('\x1b_Gi=31,a=q;\x1b\\'); await ctx.proxy.write('\x1b_Gi=31,a=q;\x1b\\');
await timeout(100); await timeout(100);
response = await ctx.page.evaluate('window.kittyResponse'); const response = await ctx.page.evaluate('window.kittyResponse');
strictEqual(response, '\x1b_Gi=31;OK\x1b\\'); strictEqual(response, '\x1b_Gi=31;OK\x1b\\');
}); });
test('responds with OK for valid PNG query', async () => { test('responds with OK for valid PNG query', async () => {
let response = '';
await ctx.page.evaluate(() => { await ctx.page.evaluate(() => {
(window as any).kittyResponse = ''; (window as any).kittyResponse = '';
(window as any).term.onData((data: string) => { (window as any).kittyResponse = data; }); (window as any).term.onData((data: string) => { (window as any).kittyResponse = data; });
@@ -562,7 +560,7 @@ test.describe('Kitty Graphics Protocol', () => {
await ctx.proxy.write(`\x1b_Gi=42,a=q,f=100;${KITTY_BLACK_1X1_BASE64}\x1b\\`); await ctx.proxy.write(`\x1b_Gi=42,a=q,f=100;${KITTY_BLACK_1X1_BASE64}\x1b\\`);
await timeout(100); await timeout(100);
response = await ctx.page.evaluate('window.kittyResponse'); const response = await ctx.page.evaluate('window.kittyResponse');
strictEqual(response, '\x1b_Gi=42;OK\x1b\\'); strictEqual(response, '\x1b_Gi=42;OK\x1b\\');
}); });
@@ -578,7 +576,6 @@ test.describe('Kitty Graphics Protocol', () => {
}); });
test('responds with error for invalid base64', async () => { test('responds with error for invalid base64', async () => {
let response = '';
await ctx.page.evaluate(() => { await ctx.page.evaluate(() => {
(window as any).kittyResponse = ''; (window as any).kittyResponse = '';
(window as any).term.onData((data: string) => { (window as any).kittyResponse = data; }); (window as any).term.onData((data: string) => { (window as any).kittyResponse = data; });
@@ -587,12 +584,11 @@ test.describe('Kitty Graphics Protocol', () => {
await ctx.proxy.write('\x1b_Gi=60,a=q,f=100;!!!invalid!!!\x1b\\'); await ctx.proxy.write('\x1b_Gi=60,a=q,f=100;!!!invalid!!!\x1b\\');
await timeout(100); await timeout(100);
response = await ctx.page.evaluate('window.kittyResponse'); const response: string = await ctx.page.evaluate('window.kittyResponse');
strictEqual(response.startsWith('\x1b_Gi=60;EINVAL:'), true); strictEqual(response.startsWith('\x1b_Gi=60;EINVAL:'), true);
}); });
test('responds with error for RGB data without dimensions', async () => { test('responds with error for RGB data without dimensions', async () => {
let response = '';
await ctx.page.evaluate(() => { await ctx.page.evaluate(() => {
(window as any).kittyResponse = ''; (window as any).kittyResponse = '';
(window as any).term.onData((data: string) => { (window as any).kittyResponse = data; }); (window as any).term.onData((data: string) => { (window as any).kittyResponse = data; });
@@ -601,7 +597,7 @@ test.describe('Kitty Graphics Protocol', () => {
await ctx.proxy.write('\x1b_Gi=70,a=q,f=24;AAAA\x1b\\'); await ctx.proxy.write('\x1b_Gi=70,a=q,f=24;AAAA\x1b\\');
await timeout(100); await timeout(100);
response = await ctx.page.evaluate('window.kittyResponse'); const response = await ctx.page.evaluate('window.kittyResponse');
strictEqual(response, '\x1b_Gi=70;EINVAL:width and height required for raw pixel data\x1b\\'); strictEqual(response, '\x1b_Gi=70;EINVAL:width and height required for raw pixel data\x1b\\');
}); });
@@ -642,7 +638,6 @@ test.describe('Kitty Graphics Protocol', () => {
}); });
test('responds with EINVAL when both i and I keys are specified', async () => { test('responds with EINVAL when both i and I keys are specified', async () => {
let response = '';
await ctx.page.evaluate(() => { await ctx.page.evaluate(() => {
(window as any).kittyResponse = ''; (window as any).kittyResponse = '';
(window as any).term.onData((data: string) => { (window as any).kittyResponse = data; }); (window as any).term.onData((data: string) => { (window as any).kittyResponse = data; });
@@ -652,12 +647,11 @@ test.describe('Kitty Graphics Protocol', () => {
await ctx.proxy.write(`\x1b_Gi=100,I=200,a=q,f=100;${KITTY_BLACK_1X1_BASE64}\x1b\\`); await ctx.proxy.write(`\x1b_Gi=100,I=200,a=q,f=100;${KITTY_BLACK_1X1_BASE64}\x1b\\`);
await timeout(100); await timeout(100);
response = await ctx.page.evaluate('window.kittyResponse'); const response = await ctx.page.evaluate('window.kittyResponse');
strictEqual(response, '\x1b_Gi=100;EINVAL:cannot specify both i and I keys\x1b\\'); strictEqual(response, '\x1b_Gi=100;EINVAL:cannot specify both i and I keys\x1b\\');
}); });
test('responds with EINVAL for i+I conflict even without payload', async () => { test('responds with EINVAL for i+I conflict even without payload', async () => {
let response = '';
await ctx.page.evaluate(() => { await ctx.page.evaluate(() => {
(window as any).kittyResponse = ''; (window as any).kittyResponse = '';
(window as any).term.onData((data: string) => { (window as any).kittyResponse = data; }); (window as any).term.onData((data: string) => { (window as any).kittyResponse = data; });
@@ -667,7 +661,7 @@ test.describe('Kitty Graphics Protocol', () => {
await ctx.proxy.write('\x1b_Gi=101,I=201,a=d\x1b\\'); await ctx.proxy.write('\x1b_Gi=101,I=201,a=d\x1b\\');
await timeout(100); await timeout(100);
response = await ctx.page.evaluate('window.kittyResponse'); const response = await ctx.page.evaluate('window.kittyResponse');
strictEqual(response, '\x1b_Gi=101;EINVAL:cannot specify both i and I keys\x1b\\'); strictEqual(response, '\x1b_Gi=101;EINVAL:cannot specify both i and I keys\x1b\\');
}); });
}); });
+6 -5
View File
@@ -11,10 +11,11 @@
"removeComments": true, "removeComments": true,
"paths": { "paths": {
"common/*": [ "common/*": [
"../../../src/common/*" "../../../src/primitives/*",
"../../../src/runtime/*",
], ],
"browser/*": [ "target-browser/*": [
"../../../src/browser/*" "../../../src/target-browser/*"
], ],
"*": [ "*": [
"./*" "./*"
@@ -31,10 +32,10 @@
], ],
"references": [ "references": [
{ {
"path": "../../../src/common" "path": "../../../src"
}, },
{ {
"path": "../../../src/browser" "path": "../../../src/target-browser"
}, },
{ {
"path": "../../../test/playwright" "path": "../../../test/playwright"
+5 -2
View File
@@ -25,8 +25,11 @@ const addon = {
modules: ['./node_modules'], modules: ['./node_modules'],
extensions: [ '.js' ], extensions: [ '.js' ],
alias: { alias: {
common: path.resolve('../../out/common'), common: [
browser: path.resolve('../../out/browser'), path.resolve('../../out/runtime'),
path.resolve('../../out/primitives'),
],
browser: path.resolve('../../out/target-browser'),
vs: path.resolve('../../out/vs') vs: path.resolve('../../out/vs')
} }
}, },
+4 -8
View File
@@ -31,15 +31,11 @@
], ],
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"lru-cache": "^6.0.0", "lru-cache": "^11.3.6",
"opentype.js": "^0.8.0" "opentype.js": "^2.0.0"
}, },
"devDependencies": { "devDependencies": {
"@types/lru-cache": "^5.1.0", "@types/opentype.js": "^1.3.9",
"@types/opentype.js": "^0.7.0", "font-finder": "^1.1.0"
"axios": "^1.15.2",
"font-finder": "^1.1.0",
"mkdirp": "0.5.5",
"yauzl": "^3.2.1"
} }
} }
@@ -1,5 +1,5 @@
import * as opentype from 'opentype.js'; import * as opentype from 'opentype.js';
import LRUCache = require('lru-cache'); import { LRUCache } from 'lru-cache';
import { IFont, ILigatureData, IFlattenedLookupTree, ILookupTree, IOptions } from './types'; import { IFont, ILigatureData, IFlattenedLookupTree, ILookupTree, IOptions } from './types';
import mergeTrees from './merge'; import mergeTrees from './merge';
@@ -23,8 +23,8 @@ class FontImpl implements IFont {
if (options.cacheSize > 0) { if (options.cacheSize > 0) {
this._cache = new LRUCache({ this._cache = new LRUCache({
max: options.cacheSize, maxSize: options.cacheSize,
length: ((val: ILigatureData | [number, number][], key: string) => key.length) as any sizeCalculation: ((val: ILigatureData | [number, number][], key: string) => key.length) as any
}); });
} }
@@ -44,7 +44,6 @@ export default function mergeRange(ranges: [number, number][], newRangeStart: nu
// current range // current range
ranges[i - 1][1] = Math.max(newRangeEnd, range[1]); ranges[i - 1][1] = Math.max(newRangeEnd, range[1]);
ranges.splice(i, 1); ranges.splice(i, 1);
inRange = false;
return ranges; return ranges;
} }
// Case 7: New range extends from previous range past the // Case 7: New range extends from previous range past the
+6 -5
View File
@@ -16,10 +16,11 @@
], ],
"paths": { "paths": {
"common/*": [ "common/*": [
"../../../src/common/*" "../../../src/primitives/*",
"../../../src/runtime/*",
], ],
"browser/*": [ "target-browser/*": [
"../../../src/browser/*" "../../../src/target-browser/*"
], ],
"@xterm/addon-progress": [ "@xterm/addon-progress": [
"../typings/addon-progress.d.ts" "../typings/addon-progress.d.ts"
@@ -32,10 +33,10 @@
], ],
"references": [ "references": [
{ {
"path": "../../../src/browser" "path": "../../../src/target-browser"
}, },
{ {
"path": "../../../src/common" "path": "../../../src"
} }
] ]
} }
+6 -5
View File
@@ -11,10 +11,11 @@
"removeComments": true, "removeComments": true,
"paths": { "paths": {
"common/*": [ "common/*": [
"../../../src/common/*" "../../../src/primitives/*",
"../../../src/runtime/*",
], ],
"browser/*": [ "target-browser/*": [
"../../../src/browser/*" "../../../src/target-browser/*"
], ],
"*": [ "*": [
"./*" "./*"
@@ -31,10 +32,10 @@
], ],
"references": [ "references": [
{ {
"path": "../../../src/common" "path": "../../../src"
}, },
{ {
"path": "../../../src/browser" "path": "../../../src/target-browser"
}, },
{ {
"path": "../../../test/playwright" "path": "../../../test/playwright"
+5 -2
View File
@@ -25,8 +25,11 @@ module.exports = {
modules: ['./node_modules'], modules: ['./node_modules'],
extensions: [ '.js' ], extensions: [ '.js' ],
alias: { alias: {
common: path.resolve('../../out/common'), common: [
browser: path.resolve('../../out/browser'), path.resolve('../../out/runtime'),
path.resolve('../../out/primitives'),
],
browser: path.resolve('../../out/target-browser'),
vs: path.resolve('../../out/vs') vs: path.resolve('../../out/vs')
} }
}, },
+1 -1
View File
@@ -5,7 +5,7 @@
import { assert } from 'chai'; import { assert } from 'chai';
import { SearchEngine } from './SearchEngine'; import { SearchEngine } from './SearchEngine';
import { SearchLineCache } from './SearchLineCache'; import { SearchLineCache } from './SearchLineCache';
import { Terminal } from 'browser/public/Terminal'; import { Terminal } from 'target-browser/public/Terminal';
import type { ISearchOptions } from '@xterm/addon-search'; import type { ISearchOptions } from '@xterm/addon-search';
import { DisposableStore } from 'common/Lifecycle'; import { DisposableStore } from 'common/Lifecycle';
+3 -3
View File
@@ -174,7 +174,7 @@ export class SearchEngine {
this._terminal.clearSelection(); this._terminal.clearSelection();
let startRow = this._terminal.buffer.active.baseY + this._terminal.rows - 1; let startRow = this._terminal.buffer.active.baseY + this._terminal.rows - 1;
let startCol = this._terminal.cols; const startCol = this._terminal.cols;
const isReverseSearch = true; const isReverseSearch = true;
this._lineCache.initLinesCache(); this._lineCache.initLinesCache();
@@ -186,14 +186,14 @@ export class SearchEngine {
let result: ISearchResult | undefined; let result: ISearchResult | undefined;
if (prevSelectedPos) { if (prevSelectedPos) {
searchPosition.startRow = startRow = prevSelectedPos.start.y; searchPosition.startRow = startRow = prevSelectedPos.start.y;
searchPosition.startCol = startCol = prevSelectedPos.start.x; searchPosition.startCol = prevSelectedPos.start.x;
if (cachedSearchTerm !== term) { if (cachedSearchTerm !== term) {
// Try to expand selection to right first. // Try to expand selection to right first.
result = this._findInLine(term, searchPosition, searchOptions, false); result = this._findInLine(term, searchPosition, searchOptions, false);
if (!result) { if (!result) {
// If selection was not able to be expanded to the right, then try reverse search // If selection was not able to be expanded to the right, then try reverse search
searchPosition.startRow = startRow = prevSelectedPos.end.y; searchPosition.startRow = startRow = prevSelectedPos.end.y;
searchPosition.startCol = startCol = prevSelectedPos.end.x; searchPosition.startCol = prevSelectedPos.end.x;
} }
} }
} }
@@ -4,7 +4,7 @@
*/ */
import { assert } from 'chai'; import { assert } from 'chai';
import { SearchLineCache, LineCacheEntry } from './SearchLineCache'; import { SearchLineCache, LineCacheEntry } from './SearchLineCache';
import { Terminal } from 'browser/public/Terminal'; import { Terminal } from 'target-browser/public/Terminal';
import { timeout } from 'common/Async'; import { timeout } from 'common/Async';
function writeP(terminal: Terminal, data: string): Promise<void> { function writeP(terminal: Terminal, data: string): Promise<void> {
+6 -5
View File
@@ -16,10 +16,11 @@
], ],
"paths": { "paths": {
"common/*": [ "common/*": [
"../../../src/common/*" "../../../src/primitives/*",
"../../../src/runtime/*",
], ],
"browser/*": [ "target-browser/*": [
"../../../src/browser/*" "../../../src/target-browser/*"
], ],
"@xterm/addon-search" : [ "@xterm/addon-search" : [
"../typings/addon-search.d.ts" "../typings/addon-search.d.ts"
@@ -32,10 +33,10 @@
], ],
"references": [ "references": [
{ {
"path": "../../../src/common" "path": "../../../src"
}, },
{ {
"path": "../../../src/browser" "path": "../../../src/target-browser"
} }
] ]
} }
+6 -5
View File
@@ -11,10 +11,11 @@
"removeComments": true, "removeComments": true,
"paths": { "paths": {
"common/*": [ "common/*": [
"../../../src/common/*" "../../../src/primitives/*",
"../../../src/runtime/*",
], ],
"browser/*": [ "target-browser/*": [
"../../../src/browser/*" "../../../src/target-browser/*"
], ],
"*": [ "*": [
"./*" "./*"
@@ -31,10 +32,10 @@
], ],
"references": [ "references": [
{ {
"path": "../../../src/common" "path": "../../../src"
}, },
{ {
"path": "../../../src/browser" "path": "../../../src/target-browser"
}, },
{ {
"path": "../../../test/playwright" "path": "../../../test/playwright"
+4 -1
View File
@@ -25,7 +25,10 @@ module.exports = {
modules: ['./node_modules'], modules: ['./node_modules'],
extensions: [ '.js' ], extensions: [ '.js' ],
alias: { alias: {
common: path.resolve('../../out/common'), common: [
path.resolve('../../out/runtime'),
path.resolve('../../out/primitives'),
],
vs: path.resolve('../../out/vs') vs: path.resolve('../../out/vs')
} }
}, },
@@ -7,7 +7,7 @@ import { perfContext, before, ThroughputRuntimeCase } from 'xterm-benchmark';
import { spawn } from 'node-pty'; import { spawn } from 'node-pty';
import { Utf8ToUtf32, stringFromCodePoint } from 'common/input/TextDecoder'; import { Utf8ToUtf32, stringFromCodePoint } from 'common/input/TextDecoder';
import { Terminal } from 'browser/public/Terminal'; import { Terminal } from 'target-browser/public/Terminal';
import { SerializeAddon } from 'SerializeAddon'; import { SerializeAddon } from 'SerializeAddon';
class TestTerminal extends Terminal { class TestTerminal extends Terminal {
@@ -7,13 +7,16 @@
"rootDir": "..", "rootDir": "..",
"outDir": "../out-benchmark", "outDir": "../out-benchmark",
"types": ["../../../node_modules/@types/node"], "types": ["../../../node_modules/@types/node"],
"moduleResolution": "node", "moduleResolution": "nodenext",
"strict": false, "strict": false,
"target": "es2021", "target": "es2021",
"module": "commonjs", "module": "nodenext",
"paths": { "paths": {
"common/*": ["../../../src/common/*"], "common/*": [
"browser/*": ["../../../src/browser/*"], "../../../src/primitives/*",
"../../../src/runtime/*",
],
"target-browser/*": ["../../../src/target-browser/*"],
"SerializeAddon": ["../src/SerializeAddon"], "SerializeAddon": ["../src/SerializeAddon"],
"@xterm/addon-serialize": [ "@xterm/addon-serialize": [
"../typings/addon-serialize.d.ts" "../typings/addon-serialize.d.ts"
@@ -23,7 +26,7 @@
"include": ["../**/*", "../../../typings/xterm.d.ts"], "include": ["../**/*", "../../../typings/xterm.d.ts"],
"exclude": ["../../../**/*test.ts", "../../**/*api.ts"], "exclude": ["../../../**/*test.ts", "../../**/*api.ts"],
"references": [ "references": [
{ "path": "../../../src/common" }, { "path": "../../../src" },
{ "path": "../../../src/browser" } { "path": "../../../src/target-browser" }
] ]
} }
@@ -6,10 +6,10 @@
import jsdom = require('jsdom'); import jsdom = require('jsdom');
import { assert } from 'chai'; import { assert } from 'chai';
import { SerializeAddon } from './SerializeAddon'; import { SerializeAddon } from './SerializeAddon';
import { Terminal } from 'browser/public/Terminal'; import { Terminal } from 'target-browser/public/Terminal';
import { SelectionModel } from 'browser/selection/SelectionModel'; import { SelectionModel } from 'target-browser/selection/SelectionModel';
import { IBufferService } from 'common/services/Services'; import { IBufferService } from 'common/services/Services';
import { ThemeService } from 'browser/services/ThemeService'; import { ThemeService } from 'target-browser/services/ThemeService';
function sgr(...seq: string[]): string { function sgr(...seq: string[]): string {
return `\x1b[${seq.join(';')}m`; return `\x1b[${seq.join(';')}m`;
+1 -1
View File
@@ -8,7 +8,7 @@
import type { IBuffer, IBufferCell, IBufferRange, ITerminalAddon, Terminal } from '@xterm/xterm'; import type { IBuffer, IBufferCell, IBufferRange, ITerminalAddon, Terminal } from '@xterm/xterm';
import type { IHTMLSerializeOptions, SerializeAddon as ISerializeApi, ISerializeOptions, ISerializeRange } from '@xterm/addon-serialize'; import type { IHTMLSerializeOptions, SerializeAddon as ISerializeApi, ISerializeOptions, ISerializeRange } from '@xterm/addon-serialize';
import { IAttributeData, IColor } from 'common/Types'; import { IAttributeData, IColor } from 'common/Types';
import { DEFAULT_ANSI_COLORS } from 'browser/Types'; import { DEFAULT_ANSI_COLORS } from 'target-browser/Types';
import { UnderlineStyle } from 'common/buffer/Constants'; import { UnderlineStyle } from 'common/buffer/Constants';
function constrain(value: number, low: number, high: number): number { function constrain(value: number, low: number, high: number): number {
+6 -5
View File
@@ -12,10 +12,11 @@
"removeComments": true, "removeComments": true,
"paths": { "paths": {
"common/*": [ "common/*": [
"../../../src/common/*" "../../../src/primitives/*",
"../../../src/runtime/*",
], ],
"browser/*": [ "target-browser/*": [
"../../../src/browser/*" "../../../src/target-browser/*"
], ],
"@xterm/addon-serialize": [ "@xterm/addon-serialize": [
"../typings/addon-serialize.d.ts" "../typings/addon-serialize.d.ts"
@@ -33,10 +34,10 @@
], ],
"references": [ "references": [
{ {
"path": "../../../src/common" "path": "../../../src"
}, },
{ {
"path": "../../../src/browser" "path": "../../../src/target-browser"
} }
] ]
} }
+6 -5
View File
@@ -11,10 +11,11 @@
"removeComments": true, "removeComments": true,
"paths": { "paths": {
"common/*": [ "common/*": [
"../../../src/common/*" "../../../src/primitives/*",
"../../../src/runtime/*",
], ],
"browser/*": [ "target-browser/*": [
"../../../src/browser/*" "../../../src/target-browser/*"
] ]
}, },
"strict": true, "strict": true,
@@ -28,10 +29,10 @@
], ],
"references": [ "references": [
{ {
"path": "../../../src/common" "path": "../../../src"
}, },
{ {
"path": "../../../src/browser" "path": "../../../src/target-browser"
}, },
{ {
"path": "../../../test/playwright" "path": "../../../test/playwright"
+5 -2
View File
@@ -25,8 +25,11 @@ module.exports = {
modules: ['./node_modules'], modules: ['./node_modules'],
extensions: [ '.js' ], extensions: [ '.js' ],
alias: { alias: {
common: path.resolve('../../out/common'), common: [
browser: path.resolve('../../out/browser') path.resolve('../../out/runtime'),
path.resolve('../../out/primitives'),
],
browser: path.resolve('../../out/target-browser')
} }
}, },
output: { output: {
@@ -7,7 +7,7 @@ import { perfContext, before, ThroughputRuntimeCase } from 'xterm-benchmark';
import { spawn } from 'node-pty'; import { spawn } from 'node-pty';
import { Utf8ToUtf32, stringFromCodePoint } from 'common/input/TextDecoder'; import { Utf8ToUtf32, stringFromCodePoint } from 'common/input/TextDecoder';
import { CoreBrowserTerminal } from 'browser/CoreBrowserTerminal'; import { CoreBrowserTerminal } from 'target-browser/CoreBrowserTerminal';
import { UnicodeGraphemeProvider } from 'UnicodeGraphemeProvider'; import { UnicodeGraphemeProvider } from 'UnicodeGraphemeProvider';
@@ -4,13 +4,16 @@
"rootDir": "..", "rootDir": "..",
"outDir": "../out-benchmark", "outDir": "../out-benchmark",
"types": ["../../../node_modules/@types/node"], "types": ["../../../node_modules/@types/node"],
"moduleResolution": "node", "moduleResolution": "nodenext",
"strict": false, "strict": false,
"target": "es2015", "target": "es2015",
"module": "commonjs", "module": "nodenext",
"paths": { "paths": {
"common/*": ["../../../src/common/*"], "common/*": [
"browser/*": ["../../../src/browser/*"], "../../../src/primitives/*",
"../../../src/runtime/*",
],
"target-browser/*": ["../../../src/target-browser/*"],
"UnicodeGraphemeProvider": ["../src/UnicodeGraphemeProvider"], "UnicodeGraphemeProvider": ["../src/UnicodeGraphemeProvider"],
"@xterm/addon-unicode-graphemes": [ "@xterm/addon-unicode-graphemes": [
"../typings/addon-unicode-graphemes.d.ts" "../typings/addon-unicode-graphemes.d.ts"
@@ -20,7 +23,7 @@
"include": ["../**/*", "../../../typings/xterm.d.ts"], "include": ["../**/*", "../../../typings/xterm.d.ts"],
"exclude": ["../../../**/*test.ts", "../../**/*api.ts"], "exclude": ["../../../**/*test.ts", "../../**/*api.ts"],
"references": [ "references": [
{ "path": "../../../src/common" }, { "path": "../../../src" },
{ "path": "../../../src/browser" } { "path": "../../../src/target-browser" }
] ]
} }
@@ -4,8 +4,8 @@
*/ */
import { IUnicodeVersionProvider } from '@xterm/xterm'; import { IUnicodeVersionProvider } from '@xterm/xterm';
import { UnicodeCharProperties, UnicodeCharWidth } from 'common/services/Services'; import { createPropertyValue, extractCharKind, extractWidth } from 'common/input/UnicodeProperties';
import { UnicodeService } from 'common/services/UnicodeService'; import { UnicodeCharProperties, UnicodeCharWidth } from 'common/input/UnicodeTypes';
import * as UC from './third-party/UnicodeProperties'; import * as UC from './third-party/UnicodeProperties';
export class UnicodeGraphemeProvider implements IUnicodeVersionProvider { export class UnicodeGraphemeProvider implements IUnicodeVersionProvider {
@@ -19,7 +19,7 @@ export class UnicodeGraphemeProvider implements IUnicodeVersionProvider {
} }
private static readonly _plainNarrowProperties: UnicodeCharProperties private static readonly _plainNarrowProperties: UnicodeCharProperties
= UnicodeService.createPropertyValue(UC.GRAPHEME_BREAK_Other, 1, false); = createPropertyValue(UC.GRAPHEME_BREAK_Other, 1, false);
public charProperties(codepoint: number, preceding: UnicodeCharProperties): UnicodeCharProperties { public charProperties(codepoint: number, preceding: UnicodeCharProperties): UnicodeCharProperties {
// Optimize the simple ASCII case, under the condition that // Optimize the simple ASCII case, under the condition that
@@ -39,9 +39,9 @@ export class UnicodeGraphemeProvider implements IUnicodeVersionProvider {
w = 1; w = 1;
} }
if (preceding !== 0) { if (preceding !== 0) {
const oldWidth = UnicodeService.extractWidth(preceding); const oldWidth = extractWidth(preceding);
if (this.handleGraphemes) { if (this.handleGraphemes) {
charInfo = UC.shouldJoin(UnicodeService.extractCharKind(preceding), charInfo); charInfo = UC.shouldJoin(extractCharKind(preceding), charInfo);
} else { } else {
charInfo = w === 0 ? 1 : 0; charInfo = w === 0 ? 1 : 0;
} }
@@ -54,7 +54,7 @@ export class UnicodeGraphemeProvider implements IUnicodeVersionProvider {
} }
} }
} }
return UnicodeService.createPropertyValue(charInfo, w, shouldJoin); return createPropertyValue(charInfo, w, shouldJoin);
} }
public wcwidth(codepoint: number): UnicodeCharWidth { public wcwidth(codepoint: number): UnicodeCharWidth {
@@ -13,7 +13,8 @@
"strict": true, "strict": true,
"paths": { "paths": {
"common/*": [ "common/*": [
"../../../src/common/*" "../../../src/primitives/*",
"../../../src/runtime/*",
], ],
"@xterm/addon-unicode-graphemes": [ "@xterm/addon-unicode-graphemes": [
"../typings/addon-unicode-graphemes.d.ts" "../typings/addon-unicode-graphemes.d.ts"
@@ -29,7 +30,7 @@
], ],
"references": [ "references": [
{ {
"path": "../../../src/common" "path": "../../../src"
} }
] ]
} }
@@ -11,10 +11,11 @@
"removeComments": true, "removeComments": true,
"paths": { "paths": {
"common/*": [ "common/*": [
"../../../src/common/*" "../../../src/primitives/*",
"../../../src/runtime/*",
], ],
"browser/*": [ "target-browser/*": [
"../../../src/browser/*" "../../../src/target-browser/*"
] ]
}, },
"strict": true, "strict": true,
@@ -28,10 +29,10 @@
], ],
"references": [ "references": [
{ {
"path": "../../../src/common" "path": "../../../src"
}, },
{ {
"path": "../../../src/browser" "path": "../../../src/target-browser"
}, },
{ {
"path": "../../../test/playwright" "path": "../../../test/playwright"
@@ -25,7 +25,10 @@ module.exports = {
modules: ['./node_modules'], modules: ['./node_modules'],
extensions: [ '.js' ], extensions: [ '.js' ],
alias: { alias: {
common: path.resolve('../../out/common'), common: [
path.resolve('../../out/runtime'),
path.resolve('../../out/primitives'),
],
vs: path.resolve('../../out/vs') vs: path.resolve('../../out/vs')
} }
}, },
+4 -4
View File
@@ -4,8 +4,8 @@
*/ */
import { IUnicodeVersionProvider } from '@xterm/xterm'; import { IUnicodeVersionProvider } from '@xterm/xterm';
import { UnicodeCharProperties, UnicodeCharWidth } from 'common/services/Services'; import { createPropertyValue, extractWidth } from 'common/input/UnicodeProperties';
import { UnicodeService } from 'common/services/UnicodeService'; import { UnicodeCharProperties, UnicodeCharWidth } from 'common/input/UnicodeTypes';
const BMP_COMBINING = [ const BMP_COMBINING = [
[0x0300, 0x036F], [0x0483, 0x0489], [0x0591, 0x05BD], [0x0300, 0x036F], [0x0483, 0x0489], [0x0591, 0x05BD],
@@ -223,13 +223,13 @@ export class UnicodeV11 implements IUnicodeVersionProvider {
let width = this.wcwidth(codepoint); let width = this.wcwidth(codepoint);
let shouldJoin = width === 0 && preceding !== 0; let shouldJoin = width === 0 && preceding !== 0;
if (shouldJoin) { if (shouldJoin) {
const oldWidth = UnicodeService.extractWidth(preceding); const oldWidth = extractWidth(preceding);
if (oldWidth === 0) { if (oldWidth === 0) {
shouldJoin = false; shouldJoin = false;
} else if (oldWidth > width) { } else if (oldWidth > width) {
width = oldWidth; width = oldWidth;
} }
} }
return UnicodeService.createPropertyValue(0, width, shouldJoin); return createPropertyValue(0, width, shouldJoin);
} }
} }
+3 -2
View File
@@ -13,7 +13,8 @@
"strict": true, "strict": true,
"paths": { "paths": {
"common/*": [ "common/*": [
"../../../src/common/*" "../../../src/primitives/*",
"../../../src/runtime/*",
], ],
"@xterm/addon-unicode11": [ "@xterm/addon-unicode11": [
"../typings/addon-unicode11.d.ts" "../typings/addon-unicode11.d.ts"
@@ -32,7 +33,7 @@
], ],
"references": [ "references": [
{ {
"path": "../../../src/common" "path": "../../../src"
} }
] ]
} }
+6 -5
View File
@@ -11,10 +11,11 @@
"removeComments": true, "removeComments": true,
"paths": { "paths": {
"common/*": [ "common/*": [
"../../../src/common/*" "../../../src/primitives/*",
"../../../src/runtime/*",
], ],
"browser/*": [ "target-browser/*": [
"../../../src/browser/*" "../../../src/target-browser/*"
], ],
"*": [ "*": [
"./*" "./*"
@@ -31,10 +32,10 @@
], ],
"references": [ "references": [
{ {
"path": "../../../src/common" "path": "../../../src"
}, },
{ {
"path": "../../../src/browser" "path": "../../../src/target-browser"
}, },
{ {
"path": "../../../test/playwright" "path": "../../../test/playwright"
+4 -1
View File
@@ -25,7 +25,10 @@ module.exports = {
modules: ['./node_modules'], modules: ['./node_modules'],
extensions: [ '.js' ], extensions: [ '.js' ],
alias: { alias: {
common: path.resolve('../../out/common'), common: [
path.resolve('../../out/runtime'),
path.resolve('../../out/primitives'),
],
vs: path.resolve('../../out/vs') vs: path.resolve('../../out/vs')
} }
}, },
@@ -78,7 +78,22 @@ test.describe('WebFontsAddon', () => {
const data = await ctx.page.evaluate(` const data = await ctx.page.evaluate(`
document.styleSheets[0].insertRule("@font-face {font-family: Kongtext; src: url(/fonts/kongtext.regular.ttf) format('truetype'); unicode-range: U+00A0-00FF}", 0); document.styleSheets[0].insertRule("@font-face {font-family: Kongtext; src: url(/fonts/kongtext.regular.ttf) format('truetype'); unicode-range: U+00A0-00FF}", 0);
`); `);
deepStrictEqual(await getDocumentFonts(), [{ family: 'Kongtext', status: 'unloaded' }]); let fonts = await getDocumentFonts();
// safari may have loaded the font, firefox & chrome never load it
if (browser.browserType().name() === 'webkit') {
try {
deepStrictEqual(fonts, [{ family: 'Kongtext', status: 'loading' }]);
} catch (e) {
try {
deepStrictEqual(fonts, [{ family: 'Kongtext', status: 'loaded' }]);
} catch (e) {
deepStrictEqual(fonts, [{ family: 'Kongtext', status: 'unloaded' }]);
}
}
} else {
deepStrictEqual(fonts, [{ family: 'Kongtext', status: 'unloaded' }]);
}
// broken case: webfont in ctor without addon usage // broken case: webfont in ctor without addon usage
await ctx.page.evaluate(` await ctx.page.evaluate(`
@@ -86,15 +101,20 @@ test.describe('WebFontsAddon', () => {
window.helperTerm.open(term.element); window.helperTerm.open(term.element);
`); `);
// safari loads the font, firefox & chrome dont fonts = await getDocumentFonts();
// safari might load the font, firefox & chrome dont
if (browser.browserType().name() === 'webkit') { if (browser.browserType().name() === 'webkit') {
try { try {
deepStrictEqual(await getDocumentFonts(), [{ family: 'Kongtext', status: 'loading' }]); deepStrictEqual(fonts, [{ family: 'Kongtext', status: 'loading' }]);
} catch (e) { } catch (e) {
deepStrictEqual(await getDocumentFonts(), [{ family: 'Kongtext', status: 'loaded' }]); try {
deepStrictEqual(fonts, [{ family: 'Kongtext', status: 'loaded' }]);
} catch (e) {
deepStrictEqual(fonts, [{ family: 'Kongtext', status: 'unloaded' }]);
}
} }
} else { } else {
deepStrictEqual(await getDocumentFonts(), [{ family: 'Kongtext', status: 'unloaded' }]); deepStrictEqual(fonts, [{ family: 'Kongtext', status: 'unloaded' }]);
} }
// good case: addon fixes layout for webfont in ctor // good case: addon fixes layout for webfont in ctor
+6 -6
View File
@@ -5,17 +5,17 @@
"lib": [ "lib": [
"es2021", "es2021",
], ],
// "downlevelIteration": true,
"rootDir": ".", "rootDir": ".",
"outDir": "../out-test", "outDir": "../out-test",
"sourceMap": true, "sourceMap": true,
"removeComments": true, "removeComments": true,
"paths": { "paths": {
"common/*": [ "common/*": [
"../../../src/common/*" "../../../src/primitives/*",
"../../../src/runtime/*",
], ],
"browser/*": [ "target-browser/*": [
"../../../src/browser/*" "../../../src/target-browser/*"
], ],
"*": [ "*": [
"./*" "./*"
@@ -32,10 +32,10 @@
], ],
"references": [ "references": [
{ {
"path": "../../../src/common" "path": "../../../src"
}, },
{ {
"path": "../../../src/browser" "path": "../../../src/target-browser"
}, },
{ {
"path": "../../../test/playwright" "path": "../../../test/playwright"
@@ -113,8 +113,8 @@ export class LinkComputer {
let line: IBufferLine | undefined; let line: IBufferLine | undefined;
let topIdx = lineIndex; let topIdx = lineIndex;
let bottomIdx = lineIndex; let bottomIdx = lineIndex;
let length = 0; let length;
let content = ''; let content;
const lines: string[] = []; const lines: string[] = [];
if ((line = terminal.buffer.active.getLine(lineIndex))) { if ((line = terminal.buffer.active.getLine(lineIndex))) {
+6 -6
View File
@@ -5,17 +5,17 @@
"lib": [ "lib": [
"es2021", "es2021",
], ],
// "downlevelIteration": true,
"rootDir": ".", "rootDir": ".",
"outDir": "../out-test", "outDir": "../out-test",
"sourceMap": true, "sourceMap": true,
"removeComments": true, "removeComments": true,
"paths": { "paths": {
"common/*": [ "common/*": [
"../../../src/common/*" "../../../src/primitives/*",
"../../../src/runtime/*",
], ],
"browser/*": [ "target-browser/*": [
"../../../src/browser/*" "../../../src/target-browser/*"
], ],
"*": [ "*": [
"./*" "./*"
@@ -32,10 +32,10 @@
], ],
"references": [ "references": [
{ {
"path": "../../../src/common" "path": "../../../src"
}, },
{ {
"path": "../../../src/browser" "path": "../../../src/target-browser"
}, },
{ {
"path": "../../../test/playwright" "path": "../../../test/playwright"
+4 -4
View File
@@ -1,12 +1,12 @@
import { ISelectionRenderModel } from 'browser/renderer/shared/Types'; import { ISelectionRenderModel } from 'target-browser/renderer/shared/Types';
import { ICoreBrowserService, IThemeService } from 'browser/services/Services'; import { ICoreBrowserService, IThemeService } from 'target-browser/services/Services';
import { ReadonlyColorSet } from 'browser/Types'; import { ReadonlyColorSet } from 'target-browser/Types';
import { Attributes, BgFlags, ExtFlags, FgFlags, NULL_CELL_CODE, UnderlineStyle } from 'common/buffer/Constants'; import { Attributes, BgFlags, ExtFlags, FgFlags, NULL_CELL_CODE, UnderlineStyle } from 'common/buffer/Constants';
import { IDecorationService, IOptionsService } from 'common/services/Services'; import { IDecorationService, IOptionsService } from 'common/services/Services';
import { ICellData } from 'common/Types'; import { ICellData } from 'common/Types';
import { Terminal } from '@xterm/xterm'; import { Terminal } from '@xterm/xterm';
import { rgba } from 'common/Color'; import { rgba } from 'common/Color';
import { treatGlyphAsBackgroundColor } from 'browser/renderer/shared/RendererUtils'; import { treatGlyphAsBackgroundColor } from 'target-browser/renderer/shared/RendererUtils';
import { blockPatternCodepoints } from './customGlyphs/CustomGlyphDefinitions'; import { blockPatternCodepoints } from './customGlyphs/CustomGlyphDefinitions';
// Work variables to avoid garbage collection // Work variables to avoid garbage collection
+1 -1
View File
@@ -5,7 +5,7 @@
import { TextureAtlas } from './TextureAtlas'; import { TextureAtlas } from './TextureAtlas';
import { ITerminalOptions, Terminal } from '@xterm/xterm'; import { ITerminalOptions, Terminal } from '@xterm/xterm';
import { ITerminal, ReadonlyColorSet } from 'browser/Types'; import { ITerminal, ReadonlyColorSet } from 'target-browser/Types';
import { ICharAtlasConfig, ITextureAtlas } from './Types'; import { ICharAtlasConfig, ITextureAtlas } from './Types';
import { generateConfig, configEquals } from './CharAtlasUtils'; import { generateConfig, configEquals } from './CharAtlasUtils';
import type { ILogService } from 'common/services/Services'; import type { ILogService } from 'common/services/Services';
+1 -1
View File
@@ -6,7 +6,7 @@
import { ICharAtlasConfig } from './Types'; import { ICharAtlasConfig } from './Types';
import { Attributes } from 'common/buffer/Constants'; import { Attributes } from 'common/buffer/Constants';
import { ITerminalOptions } from '@xterm/xterm'; import { ITerminalOptions } from '@xterm/xterm';
import { IColorSet, ReadonlyColorSet } from 'browser/Types'; import { IColorSet, ReadonlyColorSet } from 'target-browser/Types';
import { NULL_COLOR } from 'common/Color'; import { NULL_COLOR } from 'common/Color';
export function generateConfig(deviceCellWidth: number, deviceCellHeight: number, deviceCharWidth: number, deviceCharHeight: number, options: Required<ITerminalOptions>, colors: ReadonlyColorSet, devicePixelRatio: number, deviceMaxTextureSize: number, customGlyphs: boolean = true): ICharAtlasConfig { export function generateConfig(deviceCellWidth: number, deviceCellHeight: number, deviceCharWidth: number, deviceCharHeight: number, options: Required<ITerminalOptions>, colors: ReadonlyColorSet, devicePixelRatio: number, deviceMaxTextureSize: number, customGlyphs: boolean = true): ICharAtlasConfig {
@@ -3,8 +3,8 @@
* @license MIT * @license MIT
*/ */
import { RendererConstants } from 'browser/renderer/shared/Constants'; import { RendererConstants } from 'target-browser/renderer/shared/Constants';
import { ICoreBrowserService } from 'browser/services/Services'; import { ICoreBrowserService } from 'target-browser/services/Services';
const enum Constants { const enum Constants {
/** /**
+2 -2
View File
@@ -3,14 +3,14 @@
* @license MIT * @license MIT
*/ */
import { TextureAtlas } from './TextureAtlas'; import { TextureAtlas } from './TextureAtlas';
import { IRenderDimensions } from 'browser/renderer/shared/Types'; import { IRenderDimensions } from 'target-browser/renderer/shared/Types';
import { NULL_CELL_CODE } from 'common/buffer/Constants'; import { NULL_CELL_CODE } from 'common/buffer/Constants';
import { Disposable, toDisposable } from 'common/Lifecycle'; import { Disposable, toDisposable } from 'common/Lifecycle';
import { Terminal } from '@xterm/xterm'; import { Terminal } from '@xterm/xterm';
import { IRenderModel, IWebGL2RenderingContext, IWebGLVertexArrayObject, type IRasterizedGlyph, type ITextureAtlas } from './Types'; import { IRenderModel, IWebGL2RenderingContext, IWebGLVertexArrayObject, type IRasterizedGlyph, type ITextureAtlas } from './Types';
import { createProgram, GLTexture, PROJECTION_MATRIX } from './WebglUtils'; import { createProgram, GLTexture, PROJECTION_MATRIX } from './WebglUtils';
import type { ILogService, IOptionsService } from 'common/services/Services'; import type { ILogService, IOptionsService } from 'common/services/Services';
import { allowRescaling, throwIfFalsy } from 'browser/renderer/shared/RendererUtils'; import { allowRescaling, throwIfFalsy } from 'target-browser/renderer/shared/RendererUtils';
interface IVertices { interface IVertices {
attributes: Float32Array; attributes: Float32Array;
+4 -4
View File
@@ -3,9 +3,9 @@
* @license MIT * @license MIT
*/ */
import { IRenderDimensions } from 'browser/renderer/shared/Types'; import { IRenderDimensions } from 'target-browser/renderer/shared/Types';
import { IThemeService } from 'browser/services/Services'; import { IThemeService } from 'target-browser/services/Services';
import { ReadonlyColorSet } from 'browser/Types'; import { ReadonlyColorSet } from 'target-browser/Types';
import { Attributes, FgFlags } from 'common/buffer/Constants'; import { Attributes, FgFlags } from 'common/buffer/Constants';
import { Disposable, toDisposable } from 'common/Lifecycle'; import { Disposable, toDisposable } from 'common/Lifecycle';
import { IColor } from 'common/Types'; import { IColor } from 'common/Types';
@@ -13,7 +13,7 @@ import { Terminal } from '@xterm/xterm';
import { RenderModelConstants } from './RenderModel'; import { RenderModelConstants } from './RenderModel';
import { IRenderModel, IWebGL2RenderingContext, IWebGLVertexArrayObject } from './Types'; import { IRenderModel, IWebGL2RenderingContext, IWebGLVertexArrayObject } from './Types';
import { createProgram, expandFloat32Array, PROJECTION_MATRIX } from './WebglUtils'; import { createProgram, expandFloat32Array, PROJECTION_MATRIX } from './WebglUtils';
import { throwIfFalsy } from 'browser/renderer/shared/RendererUtils'; import { throwIfFalsy } from 'target-browser/renderer/shared/RendererUtils';
import type { ILogService } from 'common/services/Services'; import type { ILogService } from 'common/services/Services';
const enum VertexAttribLocations { const enum VertexAttribLocations {
+2 -2
View File
@@ -4,8 +4,8 @@
*/ */
import { ICursorRenderModel, IRenderModel } from './Types'; import { ICursorRenderModel, IRenderModel } from './Types';
import { ISelectionRenderModel } from 'browser/renderer/shared/Types'; import { ISelectionRenderModel } from 'target-browser/renderer/shared/Types';
import { createSelectionRenderModel } from 'browser/renderer/shared/SelectionRenderModel'; import { createSelectionRenderModel } from 'target-browser/renderer/shared/SelectionRenderModel';
export const enum RenderModelConstants { export const enum RenderModelConstants {
INDICIES_PER_CELL = 4, INDICIES_PER_CELL = 4,
+2 -2
View File
@@ -3,10 +3,10 @@
* @license MIT * @license MIT
*/ */
import { IColorContrastCache } from 'browser/Types'; import { IColorContrastCache } from 'target-browser/Types';
import { DIM_OPACITY, TEXT_BASELINE } from './Constants'; import { DIM_OPACITY, TEXT_BASELINE } from './Constants';
import { tryDrawCustomGlyph } from './customGlyphs/CustomGlyphRasterizer'; import { tryDrawCustomGlyph } from './customGlyphs/CustomGlyphRasterizer';
import { computeNextVariantOffset, treatGlyphAsBackgroundColor, isPowerlineGlyph, isRestrictedPowerlineGlyph, throwIfFalsy } from 'browser/renderer/shared/RendererUtils'; import { computeNextVariantOffset, treatGlyphAsBackgroundColor, isPowerlineGlyph, isRestrictedPowerlineGlyph, throwIfFalsy } from 'target-browser/renderer/shared/RendererUtils';
import { IBoundingBox, ICharAtlasConfig, IRasterizedGlyph, ITextureAtlas } from './Types'; import { IBoundingBox, ICharAtlasConfig, IRasterizedGlyph, ITextureAtlas } from './Types';
import { NULL_COLOR, channels, color, rgba } from 'common/Color'; import { NULL_COLOR, channels, color, rgba } from 'common/Color';
import { FourKeyMap } from 'common/MultiKeyMap'; import { FourKeyMap } from 'common/MultiKeyMap';
+2 -2
View File
@@ -4,8 +4,8 @@
*/ */
import { FontWeight } from '@xterm/xterm'; import { FontWeight } from '@xterm/xterm';
import { IColorSet } from 'browser/Types'; import { IColorSet } from 'target-browser/Types';
import { ISelectionRenderModel } from 'browser/renderer/shared/Types'; import { ISelectionRenderModel } from 'target-browser/renderer/shared/Types';
import { CursorInactiveStyle, CursorStyle, type IDisposable } from 'common/Types'; import { CursorInactiveStyle, CursorStyle, type IDisposable } from 'common/Types';
import type { IEvent } from 'common/Event'; import type { IEvent } from 'common/Event';
+2 -2
View File
@@ -5,8 +5,8 @@
import type { ITerminalAddon, Terminal } from '@xterm/xterm'; import type { ITerminalAddon, Terminal } from '@xterm/xterm';
import type { IWebglAddonOptions, WebglAddon as IWebglApi } from '@xterm/addon-webgl'; import type { IWebglAddonOptions, WebglAddon as IWebglApi } from '@xterm/addon-webgl';
import { ICharacterJoinerService, ICharSizeService, ICoreBrowserService, IRenderService, IThemeService } from 'browser/services/Services'; import { ICharacterJoinerService, ICharSizeService, ICoreBrowserService, IRenderService, IThemeService } from 'target-browser/services/Services';
import { ITerminal } from 'browser/Types'; import { ITerminal } from 'target-browser/Types';
import { Disposable, toDisposable } from 'common/Lifecycle'; import { Disposable, toDisposable } from 'common/Lifecycle';
import { getSafariVersion, isSafari } from 'common/Platform'; import { getSafariVersion, isSafari } from 'common/Platform';
import { ICoreService, IDecorationService, ILogService, IOptionsService } from 'common/services/Services'; import { ICoreService, IDecorationService, ILogService, IOptionsService } from 'common/services/Services';
+8 -8
View File
@@ -3,18 +3,18 @@
* @license MIT * @license MIT
*/ */
import { ITerminal } from 'browser/Types'; import { ITerminal } from 'target-browser/Types';
import { CellColorResolver } from './CellColorResolver'; import { CellColorResolver } from './CellColorResolver';
import { acquireTextureAtlas, removeTerminalFromCache } from './CharAtlasCache'; import { acquireTextureAtlas, removeTerminalFromCache } from './CharAtlasCache';
import { CursorBlinkStateManager } from './CursorBlinkStateManager'; import { CursorBlinkStateManager } from './CursorBlinkStateManager';
import { observeDevicePixelDimensions } from './DevicePixelObserver'; import { observeDevicePixelDimensions } from './DevicePixelObserver';
import { IRenderDimensions, IRenderer, IRequestRedrawEvent } from 'browser/renderer/shared/Types'; import { IRenderDimensions, IRenderer, IRequestRedrawEvent } from 'target-browser/renderer/shared/Types';
import { ICharSizeService, ICharacterJoinerService, ICoreBrowserService, IThemeService } from 'browser/services/Services'; import { ICharSizeService, ICharacterJoinerService, ICoreBrowserService, IThemeService } from 'target-browser/services/Services';
import { CharData, IBufferLine, ICellData } from 'common/Types'; import { CharData, IBufferLine, ICellData } from 'common/Types';
import { AttributeData } from 'common/buffer/AttributeData'; import { AttributeData } from 'common/buffer/AttributeData';
import { CellData } from 'common/buffer/CellData'; import { CellData } from 'common/buffer/CellData';
import { Attributes, Content, FgFlags, NULL_CELL_CHAR, NULL_CELL_CODE } from 'common/buffer/Constants'; import { Attributes, Content, FgFlags, NULL_CELL_CHAR, NULL_CELL_CODE } from 'common/buffer/Constants';
import { TextBlinkStateManager } from 'browser/renderer/shared/TextBlinkStateManager'; import { TextBlinkStateManager } from 'target-browser/renderer/shared/TextBlinkStateManager';
import { ICoreService, IDecorationService, ILogService, IOptionsService } from 'common/services/Services'; import { ICoreService, IDecorationService, ILogService, IOptionsService } from 'common/services/Services';
import { Terminal } from '@xterm/xterm'; import { Terminal } from '@xterm/xterm';
import { GlyphRenderer } from './GlyphRenderer'; import { GlyphRenderer } from './GlyphRenderer';
@@ -24,9 +24,9 @@ import { IWebGL2RenderingContext, type ITextureAtlas } from './Types';
import { LinkRenderLayer } from './renderLayer/LinkRenderLayer'; import { LinkRenderLayer } from './renderLayer/LinkRenderLayer';
import { IRenderLayer } from './renderLayer/Types'; import { IRenderLayer } from './renderLayer/Types';
import { Emitter, EventUtils } from 'common/Event'; import { Emitter, EventUtils } from 'common/Event';
import { addDisposableListener } from 'browser/Dom'; import { addDisposableListener } from 'target-browser/Dom';
import { combinedDisposable, Disposable, MutableDisposable, toDisposable } from 'common/Lifecycle'; import { combinedDisposable, Disposable, MutableDisposable, toDisposable } from 'common/Lifecycle';
import { createRenderDimensions } from 'browser/renderer/shared/RendererUtils'; import { createRenderDimensions } from 'target-browser/renderer/shared/RendererUtils';
const enum Constants { const enum Constants {
MERGE_RETRY_LIMIT = 32 MERGE_RETRY_LIMIT = 32
@@ -427,8 +427,8 @@ export class WebglRenderer extends Disposable implements IRenderer {
let line: IBufferLine; let line: IBufferLine;
let joinedRanges: [number, number][]; let joinedRanges: [number, number][];
let isJoined: boolean; let isJoined: boolean;
let skipJoinedCheckUntilX: number = 0; let skipJoinedCheckUntilX: number;
let isValidJoinRange: boolean = true; let isValidJoinRange: boolean;
let lastCharX: number; let lastCharX: number;
let range: [number, number]; let range: [number, number];
let isCursorRow: boolean; let isCursorRow: boolean;
+1 -1
View File
@@ -3,7 +3,7 @@
* @license MIT * @license MIT
*/ */
import { throwIfFalsy } from 'browser/renderer/shared/RendererUtils'; import { throwIfFalsy } from 'target-browser/renderer/shared/RendererUtils';
import type { ILogService } from 'common/services/Services'; import type { ILogService } from 'common/services/Services';
/** /**
@@ -3,7 +3,7 @@
* @license MIT * @license MIT
*/ */
import { throwIfFalsy } from 'browser/renderer/shared/RendererUtils'; import { throwIfFalsy } from 'target-browser/renderer/shared/RendererUtils';
import type { ILogService } from 'common/services/Services'; import type { ILogService } from 'common/services/Services';
import { customGlyphDefinitions } from './CustomGlyphDefinitions'; import { customGlyphDefinitions } from './CustomGlyphDefinitions';
import { CustomGlyphDefinitionType, CustomGlyphScaleType, CustomGlyphVectorType, type CustomGlyphDefinitionPart, type CustomGlyphPathDrawFunctionDefinition, type CustomGlyphPatternDefinition, type ICustomGlyphSolidOctantBlockVector, type ICustomGlyphVectorShape } from './Types'; import { CustomGlyphDefinitionType, CustomGlyphScaleType, CustomGlyphVectorType, type CustomGlyphDefinitionPart, type CustomGlyphPathDrawFunctionDefinition, type CustomGlyphPatternDefinition, type ICustomGlyphSolidOctantBlockVector, type ICustomGlyphVectorShape } from './Types';
@@ -3,16 +3,16 @@
* @license MIT * @license MIT
*/ */
import { ReadonlyColorSet } from 'browser/Types'; import { ReadonlyColorSet } from 'target-browser/Types';
import { acquireTextureAtlas } from '../CharAtlasCache'; import { acquireTextureAtlas } from '../CharAtlasCache';
import { IRenderDimensions } from 'browser/renderer/shared/Types'; import { IRenderDimensions } from 'target-browser/renderer/shared/Types';
import { ICoreBrowserService, IThemeService } from 'browser/services/Services'; import { ICoreBrowserService, IThemeService } from 'target-browser/services/Services';
import { Disposable, toDisposable } from 'common/Lifecycle'; import { Disposable, toDisposable } from 'common/Lifecycle';
import { CellData } from 'common/buffer/CellData'; import { CellData } from 'common/buffer/CellData';
import { IOptionsService } from 'common/services/Services'; import { IOptionsService } from 'common/services/Services';
import { Terminal } from '@xterm/xterm'; import { Terminal } from '@xterm/xterm';
import { IRenderLayer } from './Types'; import { IRenderLayer } from './Types';
import { throwIfFalsy } from 'browser/renderer/shared/RendererUtils'; import { throwIfFalsy } from 'target-browser/renderer/shared/RendererUtils';
import { TEXT_BASELINE } from '../Constants'; import { TEXT_BASELINE } from '../Constants';
import type { ITextureAtlas } from '../Types'; import type { ITextureAtlas } from '../Types';
@@ -4,10 +4,10 @@
*/ */
import { is256Color } from '../CharAtlasUtils'; import { is256Color } from '../CharAtlasUtils';
import { INVERTED_DEFAULT_COLOR } from 'browser/renderer/shared/Constants'; import { INVERTED_DEFAULT_COLOR } from 'target-browser/renderer/shared/Constants';
import { IRenderDimensions } from 'browser/renderer/shared/Types'; import { IRenderDimensions } from 'target-browser/renderer/shared/Types';
import { ICoreBrowserService, IThemeService } from 'browser/services/Services'; import { ICoreBrowserService, IThemeService } from 'target-browser/services/Services';
import { ILinkifier2, ILinkifierEvent } from 'browser/Types'; import { ILinkifier2, ILinkifierEvent } from 'target-browser/Types';
import { IOptionsService } from 'common/services/Services'; import { IOptionsService } from 'common/services/Services';
import { Terminal } from '@xterm/xterm'; import { Terminal } from '@xterm/xterm';
import { BaseRenderLayer } from './BaseRenderLayer'; import { BaseRenderLayer } from './BaseRenderLayer';
+1 -1
View File
@@ -4,7 +4,7 @@
*/ */
import { IDisposable, Terminal } from '@xterm/xterm'; import { IDisposable, Terminal } from '@xterm/xterm';
import { IRenderDimensions } from 'browser/renderer/shared/Types'; import { IRenderDimensions } from 'target-browser/renderer/shared/Types';
export interface IRenderLayer extends IDisposable { export interface IRenderLayer extends IDisposable {
/** /**
+6 -6
View File
@@ -12,10 +12,11 @@
"removeComments": true, "removeComments": true,
"paths": { "paths": {
"common/*": [ "common/*": [
"../../../src/common/*" "../../../src/primitives/*",
"../../../src/runtime/*",
], ],
"browser/*": [ "target-browser/*": [
"../../../src/browser/*" "../../../src/target-browser/*"
], ],
"@xterm/addon-webgl": [ "@xterm/addon-webgl": [
"../typings/addon-webgl.d.ts" "../typings/addon-webgl.d.ts"
@@ -25,7 +26,6 @@
] ]
}, },
"strict": true, "strict": true,
"downlevelIteration": true,
"experimentalDecorators": true, "experimentalDecorators": true,
"types": [ "types": [
"../../../node_modules/@types/mocha" "../../../node_modules/@types/mocha"
@@ -37,10 +37,10 @@
], ],
"references": [ "references": [
{ {
"path": "../../../src/common" "path": "../../../src"
}, },
{ {
"path": "../../../src/browser" "path": "../../../src/target-browser"
} }
] ]
} }
+6 -5
View File
@@ -11,10 +11,11 @@
"removeComments": true, "removeComments": true,
"paths": { "paths": {
"common/*": [ "common/*": [
"../../../src/common/*" "../../../src/primitives/*",
"../../../src/runtime/*",
], ],
"browser/*": [ "target-browser/*": [
"../../../src/browser/*" "../../../src/target-browser/*"
], ],
"*": [ "*": [
"./*" "./*"
@@ -32,10 +33,10 @@
], ],
"references": [ "references": [
{ {
"path": "../../../src/common" "path": "../../../src"
}, },
{ {
"path": "../../../src/browser" "path": "../../../src/target-browser"
}, },
{ {
"path": "../../../test/playwright" "path": "../../../test/playwright"
+5 -2
View File
@@ -25,8 +25,11 @@ module.exports = {
modules: ['./node_modules'], modules: ['./node_modules'],
extensions: [ '.js' ], extensions: [ '.js' ],
alias: { alias: {
common: path.resolve('../../out/common'), common: [
browser: path.resolve('../../out/browser'), path.resolve('../../out/runtime'),
path.resolve('../../out/primitives'),
],
browser: path.resolve('../../out/target-browser'),
vs: path.resolve('../../out/vs') vs: path.resolve('../../out/vs')
} }
}, },
+37 -13
View File
@@ -92,6 +92,9 @@ let outConfig = {
} }
let skipOut = false; let skipOut = false;
/** @type {esbuild.BuildOptions[] | undefined} */
let outBuilds;
/** @type {esbuild.BuildOptions} */ /** @type {esbuild.BuildOptions} */
let outTestConfig = { let outTestConfig = {
format: 'cjs', format: 'cjs',
@@ -171,7 +174,7 @@ if (config.addon) {
} else if (config.isHeadless) { } else if (config.isHeadless) {
bundleConfig = { bundleConfig = {
...bundleConfig, ...bundleConfig,
entryPoints: [`src/headless/public/Terminal.ts`], entryPoints: [`src/target-headless/public/Terminal.ts`],
outfile: `headless/lib-headless/xterm-headless.mjs` outfile: `headless/lib-headless/xterm-headless.mjs`
}; };
outConfig = { outConfig = {
@@ -183,18 +186,35 @@ if (config.addon) {
} else { } else {
bundleConfig = { bundleConfig = {
...bundleConfig, ...bundleConfig,
entryPoints: [`src/browser/public/Terminal.ts`], entryPoints: [`src/target-browser/public/Terminal.ts`],
outfile: `lib/xterm.mjs` outfile: `lib/xterm.mjs`
}; };
outConfig = { outBuilds = [
...outConfig, {
entryPoints: [ ...outConfig,
'src/browser/**/*.ts', entryPoints: ['src/primitives/**/*.ts'],
'src/common/**/*.ts', outbase: 'src/primitives',
'src/headless/**/*.ts' outdir: 'out-esbuild/common',
], },
outdir: 'out-esbuild/' {
}; ...outConfig,
entryPoints: ['src/runtime/**/*.ts'],
outbase: 'src/runtime',
outdir: 'out-esbuild/common',
},
{
...outConfig,
entryPoints: ['src/target-browser/**/*.ts'],
outbase: 'src',
outdir: 'out-esbuild',
},
{
...outConfig,
entryPoints: ['src/target-headless/**/*.ts'],
outbase: 'src',
outdir: 'out-esbuild',
},
];
outTestConfig = { outTestConfig = {
...outConfig, ...outConfig,
entryPoints: ['test/**/*.ts'], entryPoints: ['test/**/*.ts'],
@@ -205,7 +225,9 @@ if (config.addon) {
if (config.isWatch) { if (config.isWatch) {
context(bundleConfig).then(e => e.watch()); context(bundleConfig).then(e => e.watch());
if (!skipOut) { if (!skipOut) {
context(outConfig).then(e => e.watch()); for (const buildConfig of outBuilds ?? [outConfig]) {
context(buildConfig).then(e => e.watch());
}
} }
if (!skipOutTest) { if (!skipOutTest) {
context(outTestConfig).then(e => e.watch()); context(outTestConfig).then(e => e.watch());
@@ -213,7 +235,9 @@ if (config.isWatch) {
} else { } else {
await build(bundleConfig); await build(bundleConfig);
if (!skipOut) { if (!skipOut) {
await build(outConfig); for (const buildConfig of outBuilds ?? [outConfig]) {
await build(buildConfig);
}
} }
if (!skipOutTest) { if (!skipOutTest) {
await build(outTestConfig); await build(outTestConfig);
+1 -1
View File
@@ -81,7 +81,7 @@ function checkAndPublishPackage(packageDir, repoCommit, peerDependencies, update
// Update Version.ts with the new version // Update Version.ts with the new version
if (updateVersionTs) { if (updateVersionTs) {
const versionTsPath = path.join(packageDir, 'src/common/Version.ts'); const versionTsPath = path.join(packageDir, 'src/primitives/Version.ts');
const versionTsContent = fs.readFileSync(versionTsPath, 'utf8'); const versionTsContent = fs.readFileSync(versionTsPath, 'utf8');
const updatedVersionTs = versionTsContent.replace( const updatedVersionTs = versionTsContent.replace(
/export const XTERM_VERSION = '[^']+';/, /export const XTERM_VERSION = '[^']+';/,
+1 -1
View File
@@ -38,4 +38,4 @@ function findUnusedSymbols(
} }
// Example usage // Example usage
findUnusedSymbols("./src/browser/tsconfig.json"); findUnusedSymbols("./src/target-browser/tsconfig.json");
@@ -65,7 +65,8 @@ export class AddonImageWindow extends BaseWindow implements IControlWindow {
const dtIip = document.createElement('dt'); const dtIip = document.createElement('dt');
dtIip.textContent = 'IIP (iTerm)'; dtIip.textContent = 'IIP (iTerm)';
dlIip.appendChild(dtIip); dlIip.appendChild(dtIip);
this._addDdWithButton(dlIip, 'image-demo3', 'palette'); this._addDdWithButton(dlIip, 'image-demo3', 'palette (png File)');
this._addDdWithButton(dlIip, 'image-demo4', 'dice (qoi MultipartFile)');
container.appendChild(dlIip); container.appendChild(dlIip);
// Kitty demos // Kitty demos
@@ -141,6 +142,21 @@ export class AddonImageWindow extends BaseWindow implements IControlWindow {
this._terminal.write(`\x1b]1337;File=inline=1;size=${data.length}:${btoa(sdata)}\x1b\\`); this._terminal.write(`\x1b]1337;File=inline=1;size=${data.length}:${btoa(sdata)}\x1b\\`);
}); });
const iipDemoMulti = (url: string) => () => fetch(url)
.then(resp => resp.arrayBuffer())
.then(buffer => {
const data = new Uint8Array(buffer);
let sdata = '';
for (let i = 0; i < data.length; ++i) sdata += String.fromCharCode(data[i]);
const encoded = btoa(sdata);
this._terminal.write('\r\n');
this._terminal.write(`\x1b]1337;MultipartFile=inline=1\x1b\\`);
for (let i = 0; i < encoded.length; i += 100) {
this._terminal.write(`\x1b]1337;FilePart=${encoded.slice(i, i + 100)}\x1b\\`);
}
this._terminal.write(`\x1b]1337;FileEnd\x1b\\`);
});
const kittyDemo = (url: string) => () => fetch(url) const kittyDemo = (url: string) => () => fetch(url)
.then(resp => resp.arrayBuffer()) .then(resp => resp.arrayBuffer())
.then(buffer => { .then(buffer => {
@@ -158,6 +174,8 @@ export class AddonImageWindow extends BaseWindow implements IControlWindow {
sixelDemo('https://raw.githubusercontent.com/jerch/node-sixel/master/testfiles/test2.sixel')); sixelDemo('https://raw.githubusercontent.com/jerch/node-sixel/master/testfiles/test2.sixel'));
document.getElementById('image-demo3')!.addEventListener('click', document.getElementById('image-demo3')!.addEventListener('click',
iipDemo('https://raw.githubusercontent.com/jerch/node-sixel/master/palette.png')); iipDemo('https://raw.githubusercontent.com/jerch/node-sixel/master/palette.png'));
document.getElementById('image-demo4')!.addEventListener('click',
iipDemoMulti('https://raw.githubusercontent.com/jerch/xterm-wasm-parts/master/fixtures/qoi/dice.qoi'));
document.getElementById('image-demo-kitty1')!.addEventListener('click', document.getElementById('image-demo-kitty1')!.addEventListener('click',
kittyDemo('https://raw.githubusercontent.com/jerch/node-sixel/master/palette.png')); kittyDemo('https://raw.githubusercontent.com/jerch/node-sixel/master/palette.png'));
@@ -176,7 +194,7 @@ export class AddonImageWindow extends BaseWindow implements IControlWindow {
// } // }
// } // }
const pos = (this._terminal as any)._core._mouseService!.getCoords(ev, (this._terminal as any)._core.screenElement!, this._terminal.cols, this._terminal.rows); const pos = (this._terminal as any)._core._mouseCoordsService!.getCoords(ev, (this._terminal as any)._core.screenElement!, this._terminal.cols, this._terminal.rows);
const x = pos[0] - 1; const x = pos[0] - 1;
const y = pos[1] - 1; const y = pos[1] - 1;
const canvas = ev.shiftKey const canvas = ev.shiftKey
+1
View File
@@ -2,6 +2,7 @@
"compilerOptions": { "compilerOptions": {
"module": "commonjs", "module": "commonjs",
"target": "es2021", "target": "es2021",
"types": ["node"],
"outDir": "../out-demo/client", "outDir": "../out-demo/client",
"rootDir": ".", "rootDir": ".",
"sourceMap": true, "sourceMap": true,
+1 -1
View File
@@ -118,7 +118,7 @@ function startServer(): void {
}); });
appWs.ws('/terminals/:pid', function (ws, req) { appWs.ws('/terminals/:pid', function (ws, req) {
const term = terminals[parseInt(req.params.pid)]; const term = terminals[parseInt(Array.isArray(req.params.pid) ? req.params.pid[0] : req.params.pid)];
console.log('Connected to terminal ' + term.pid); console.log('Connected to terminal ' + term.pid);
temporaryDisposable[term.pid].dispose(); temporaryDisposable[term.pid].dispose();
delete temporaryDisposable[term.pid]; delete temporaryDisposable[term.pid];
+1 -1
View File
@@ -37,7 +37,7 @@ export default tseslint.config(
'@stylistic/comma-spacing': ['warn', { before: false, after: true }], '@stylistic/comma-spacing': ['warn', { before: false, after: true }],
'@stylistic/indent': ['warn', 2], '@stylistic/indent': ['warn', 2],
'@stylistic/semi': ['warn', 'always'], '@stylistic/semi': ['warn', 'always'],
'@stylistic/quotes': ['warn', 'single', { allowTemplateLiterals: true }], '@stylistic/quotes': ['warn', 'single', { allowTemplateLiterals: 'always' }],
'@stylistic/member-delimiter-style': ['warn', { '@stylistic/member-delimiter-style': ['warn', {
multiline: { delimiter: 'semi', requireLast: true }, multiline: { delimiter: 'semi', requireLast: true },
singleline: { delimiter: 'comma', requireLast: false } singleline: { delimiter: 'comma', requireLast: false }
+1 -1
View File
@@ -17,7 +17,7 @@ export default tseslint.config(
rules: { rules: {
'@stylistic/indent': ['warn', 2], '@stylistic/indent': ['warn', 2],
'@stylistic/semi': ['warn', 'always'], '@stylistic/semi': ['warn', 'always'],
'@stylistic/quotes': ['warn', 'single', { allowTemplateLiterals: true }], '@stylistic/quotes': ['warn', 'single', { allowTemplateLiterals: 'always' }],
'@stylistic/member-delimiter-style': ['warn', { '@stylistic/member-delimiter-style': ['warn', {
multiline: { delimiter: 'semi', requireLast: true }, multiline: { delimiter: 'semi', requireLast: true },
singleline: { delimiter: 'comma', requireLast: false } singleline: { delimiter: 'comma', requireLast: false }
+2602 -2288
View File
File diff suppressed because it is too large Load Diff
+25 -24
View File
@@ -75,40 +75,41 @@
"prepublishOnly": "npm run package" "prepublishOnly": "npm run package"
}, },
"devDependencies": { "devDependencies": {
"@eslint/js": "^10.0.1",
"@lunapaint/png-codec": "^0.2.0", "@lunapaint/png-codec": "^0.2.0",
"@playwright/test": "^1.57.0", "@playwright/test": "^1.59.1",
"@stylistic/eslint-plugin": "^4.4.1", "@stylistic/eslint-plugin": "^5.10.0",
"@types/chai": "^4.2.22", "@types/chai": "^5.2.3",
"@types/express": "4", "@types/express": "^5.0.6",
"@types/express-ws": "^3.0.1", "@types/express-ws": "^3.0.1",
"@types/jsdom": "^27.0.0", "@types/jsdom": "^28.0.1",
"@types/mocha": "^9.0.0", "@types/mocha": "^10.0.10",
"@types/node": "^22.19.3", "@types/node": "^22.19.3",
"@types/webpack": "^5.28.0", "@types/webpack": "^5.28.0",
"@types/ws": "^8.2.0", "@types/ws": "^8.2.0",
"@typescript-eslint/eslint-plugin": "^8.50.1", "@typescript-eslint/eslint-plugin": "^8.59.2",
"@typescript-eslint/parser": "^8.50.1", "@typescript-eslint/parser": "^8.59.2",
"@typescript/native-preview": "^7.0.0-dev.20260213.1", "@typescript/native-preview": "^7.0.0-dev.20260509.2",
"chai": "^4.3.4", "chai": "^6.2.2",
"concurrently": "^9.1.2", "concurrently": "^9.1.2",
"esbuild": "~0.25.2", "esbuild": "^0.28.0",
"eslint": "^9.39.2", "eslint": "^10.3.0",
"eslint-plugin-jsdoc": "^50.8.0", "eslint-plugin-jsdoc": "^62.9.0",
"express": "^4.19.2", "express": "^5.2.1",
"express-ws": "^5.0.2", "express-ws": "^5.0.2",
"jsdom": "^27.3.0", "jsdom": "^29.1.1",
"mocha": "^10.1.0", "mocha": "^11.7.5",
"mustache": "^4.2.0", "mustache": "^4.2.0",
"node-pty": "^1.2.0-beta.9", "node-pty": "^1.2.0-beta.9",
"nyc": "^17.1.0", "nyc": "^18.0.0",
"source-map-loader": "^3.0.0", "source-map-loader": "^5.0.0",
"source-map-support": "^0.5.20", "source-map-support": "^0.5.20",
"ts-loader": "^9.3.1", "ts-loader": "^9.5.7",
"typescript": "^5.9.3", "typescript": "^5.9.3",
"typescript-eslint": "^8.50.1", "typescript-eslint": "^8.59.2",
"webpack": "^5.61.0", "webpack": "^5.106.2",
"webpack-cli": "^4.9.1", "webpack-cli": "^7.0.2",
"ws": "^8.2.3", "ws": "^8.20.0",
"xterm-benchmark": "^0.3.1" "xterm-benchmark": "^0.3.2"
} }
} }
+70
View File
@@ -0,0 +1,70 @@
# xterm.js source architecture
This document describes how `src/` is organized. The layout follows [issue #5963](https://github.com/xtermjs/xterm.js/issues/5963): **primitives** and **runtime** as separate TypeScript composite projects, with **target-browser** and **target-headless** as platform entry points.
## Dependency graph
```mermaid
flowchart BT
primitives["primitives<br/>building blocks"]
runtime["runtime<br/>services, integration"]
targetBrowser["target-browser<br/>DOM terminal"]
targetHeadless["target-headless<br/>Node terminal"]
runtime --> primitives
targetBrowser --> runtime
targetHeadless --> runtime
```
## TypeScript projects
| Project | `tsconfig` | Output | Role |
| --- | --- | --- | --- |
| Primitives | `src/primitives/tsconfig.json` | `out/primitives/` | Buffer, parser, input helpers, static data, shared utilities. Must not import from `runtime/`. |
| Runtime | `src/runtime/tsconfig.json` | `out/runtime/` | Services (DI), `CoreTerminal`, `InputHandler`, public API adapters, `Types.ts`. References primitives. |
| Source (solution) | `src/tsconfig.json` | — | Solution root; references primitives + runtime only. |
| Target browser | `src/target-browser/tsconfig.json` | `out/target-browser/` | Browser rendering, input, public `Terminal`. References `src/`. |
| Target headless | `src/target-headless/tsconfig.json` | `out/target-headless/` | Headless terminal. References `src/`. |
Unit test files (`**/*.test.ts`) are excluded from composite library builds; they are compiled via esbuild for `npm run test-unit`.
## `primitives/`
| Area | Contents |
| --- | --- |
| Root utilities | `Async`, `CircularList`, `Color`, `ColorTypes`, `Event`, `KeyboardTypes`, `Lifecycle`, `MultiKeyMap`, `Platform`, `SortedList`, `StringBuilder`, `TaskQueue`, `TerminalOptions`, `Version` |
| `buffer/` | Screen buffer, `CellTypes`, `BufferService` / `BufferOptions` / `BufferLog` interfaces (buffer-layer contracts) |
| `data/` | `Charsets`, `EscapeSequences` |
| `input/` | UTF decoding, keyboard helpers, `UnicodeTypes`, `UnicodeProperties` |
| `parser/` | Escape-sequence parser |
Primitives depend only on other primitives (and `@xterm/xterm` typings where needed). Buffer code uses `IBufferService` from `common/buffer/BufferService`, not `common/services/Services`.
## `runtime/`
| Area | Contents |
| --- | --- |
| `services/` | DI implementations (`BufferService`, `OptionsService`, …) |
| `public/` | Public API adapters (`AddonManager`, buffer/parser views) |
| Root | `CoreTerminal`, `InputHandler`, `WindowsMode`, `Types.ts`, `TestUtils.test.ts` |
`Types.ts` re-exports primitive types and adds integration types (`IInputHandler`, `ICoreTerminal`, mouse/color helpers, etc.).
## Import paths
Source keeps the `common/...` prefix (logical module name, not a physical `common/` folder). Each project's `paths` in `tsconfig.json` map that prefix to `primitives/` and/or `runtime/`.
Platform code uses:
- `target-browser/...` — browser terminal
- `target-headless/...` — Node terminal
## Published packages vs source folders
The npm package directory `headless/` (e.g. `headless/lib-headless/`) is unchanged; only the **source** tree uses `src/target-headless/`.
## Related issues
- [#5963](https://github.com/xtermjs/xterm.js/issues/5963) — module split
- [#5896](https://github.com/xtermjs/xterm.js/issues/5896) — relative imports
- [#5897](https://github.com/xtermjs/xterm.js/issues/5897) — `import/no-cycle` lint
-25
View File
@@ -1,25 +0,0 @@
{
"extends": "../tsconfig-library-base",
"compilerOptions": {
"lib": [
"dom",
"es2021"
],
"outDir": "../../out",
"types": [
"../../node_modules/@types/mocha"
],
"skipLibCheck": true,
"paths": {
"common/*": [ "./../common/*" ],
"*": [ "./../*" ]
}
},
"include": [
"./**/*",
"../../typings/xterm.d.ts"
],
"references": [
{ "path": "../common" }
]
}
-23
View File
@@ -1,23 +0,0 @@
{
"extends": "../tsconfig-library-base",
"compilerOptions": {
"lib": [
"es2015",
"es2016.Array.Include",
"es2019.string",
"es2021.weakref"
],
"outDir": "../../out",
"types": [
"../../node_modules/@types/mocha"
],
"paths": {
"common/*": [ "./../common/*" ],
"*": [ "./../*" ]
}
},
"include": [
"./**/*",
"../../typings/xterm.d.ts"
]
}
@@ -3,9 +3,30 @@
* @license MIT * @license MIT
*/ */
import { ICircularList } from 'common/Types';
import { Disposable } from 'common/Lifecycle'; import { Disposable } from 'common/Lifecycle';
import { Emitter } from 'common/Event'; import { Emitter, type IEvent } from 'common/Event';
export interface ICircularList<T> {
length: number;
maxLength: number;
isFull: boolean;
onDeleteEmitter: Emitter<IDeleteEvent>;
onDelete: IEvent<IDeleteEvent>;
onInsertEmitter: Emitter<IInsertEvent>;
onInsert: IEvent<IInsertEvent>;
onTrimEmitter: Emitter<number>;
onTrim: IEvent<number>;
get(index: number): T | undefined;
set(index: number, value: T): void;
push(value: T): void;
recycle(): T;
pop(): T | undefined;
splice(start: number, deleteCount: number, ...items: T[]): void;
trimStart(count: number): void;
shiftElements(start: number, count: number, offset: number): void;
}
export interface IInsertEvent { export interface IInsertEvent {
index: number; index: number;
@@ -3,7 +3,7 @@
* @license MIT * @license MIT
*/ */
import { IColor, IColorRGB } from 'common/Types'; import { IColor, IColorRGB } from 'common/ColorTypes';
let $r = 0; let $r = 0;
let $g = 0; let $g = 0;
+11
View File
@@ -0,0 +1,11 @@
/**
* Copyright (c) 2018 The xterm.js authors. All rights reserved.
* @license MIT
*/
export interface IColor {
readonly css: string;
readonly rgba: number; // 32-bit int with rgba in each byte
}
export type IColorRGB = [red: number, green: number, blue: number];
+29
View File
@@ -0,0 +1,29 @@
/**
* Copyright (c) 2018 The xterm.js authors. All rights reserved.
* @license MIT
*/
export interface IKeyboardEvent {
altKey: boolean;
ctrlKey: boolean;
shiftKey: boolean;
metaKey: boolean;
/** @deprecated See KeyboardEvent.keyCode */
keyCode: number;
key: string;
type: string;
code: string;
}
export const enum KeyboardResultType {
SEND_KEY,
SELECT_ALL,
PAGE_UP,
PAGE_DOWN
}
export interface IKeyboardResult {
type: KeyboardResultType;
cancel: boolean;
key: string | undefined;
}

Some files were not shown because too many files have changed in this diff Show More