Add error handling for dynamic imports

Co-authored-by: Tyriar <2193314+Tyriar@users.noreply.github.com>

.devcontainer/devcontainer.json

@@ -1,13 +1,15 @@
 {
   "name": "xterm.js",
-  "image": "mcr.microsoft.com/devcontainers/typescript-node:0-18-buster",
+  "image": "mcr.microsoft.com/devcontainers/typescript-node:22-bookworm",
   "features": {
-    "ghcr.io/devcontainers/features/node:1": {} // yarn
+    "ghcr.io/devcontainers/features/node:1": {
+      "version": 22
+    } // yarn
   },
   "forwardPorts": [
     3000
   ],
-  "postCreateCommand": "yarn install",
+  "postCreateCommand": "npm install && npm run setup",
   "customizations": {
     "vscode": {
       "extensions": [

.editorconfig

@@ -5,7 +5,6 @@ indent_style = space
 indent_size = 2
 insert_final_newline = true
 trim_trailing_whitespace = true
-end_of_line = lf
 
 [*.{j,t}s]
 max_line_length = 100

.eslintrc.json

@@ -1,264 +0,0 @@
-{
-  "env": {
-    "browser": true,
-    "es2021": true,
-    "node": true
-  },
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "project": [
-      "demo/tsconfig.json",
-      "src/browser/tsconfig.json",
-      "src/common/tsconfig.json",
-      "src/headless/tsconfig.json",
-      "test/api/tsconfig.json",
-      "test/benchmark/tsconfig.json",
-      "test/playwright/tsconfig.json",
-      "addons/addon-attach/src/tsconfig.json",
-      "addons/addon-attach/test/tsconfig.json",
-      "addons/addon-canvas/src/tsconfig.json",
-      "addons/addon-canvas/test/tsconfig.json",
-      "addons/addon-fit/src/tsconfig.json",
-      "addons/addon-fit/test/tsconfig.json",
-      "addons/addon-image/src/tsconfig.json",
-      "addons/addon-image/test/tsconfig.json",
-      "addons/addon-ligatures/src/tsconfig.json",
-      "addons/addon-search/src/tsconfig.json",
-      "addons/addon-search/test/tsconfig.json",
-      "addons/addon-serialize/src/tsconfig.json",
-      "addons/addon-serialize/test/tsconfig.json",
-      "addons/addon-serialize/benchmark/tsconfig.json",
-      "addons/addon-unicode11/src/tsconfig.json",
-      "addons/addon-unicode11/test/tsconfig.json",
-      "addons/addon-unicode-graphemes/src/tsconfig.json",
-      "addons/addon-unicode-graphemes/test/tsconfig.json",
-      "addons/addon-unicode-graphemes/benchmark/tsconfig.json",
-      "addons/addon-web-links/src/tsconfig.json",
-      "addons/addon-web-links/test/tsconfig.json",
-      "addons/addon-webgl/src/tsconfig.json",
-      "addons/addon-webgl/test/tsconfig.json"
-    ],
-    "sourceType": "module"
-  },
-  "ignorePatterns": [
-    "addons/*/src/third-party/*.ts",
-    "out/*",
-    "out-test/*",
-    "**/inwasm-sdks/*",
-    "**/typings/*.d.ts",
-    "**/node_modules",
-    "**/*.js"
-  ],
-  "plugins": [
-    "@typescript-eslint",
-    "jsdoc"
-  ],
-  "rules": {
-    "no-extra-semi": "error",
-    "@typescript-eslint/array-type": [
-      "warn",
-      {
-        "default": "array",
-        "readonly": "generic"
-      }
-    ],
-    "@typescript-eslint/consistent-type-assertions": "warn",
-    "@typescript-eslint/consistent-type-definitions": "warn",
-    "@typescript-eslint/explicit-function-return-type": [
-      "warn",
-      {
-        "allowExpressions": true
-      }
-    ],
-    "@typescript-eslint/explicit-member-accessibility": [
-      "warn",
-      {
-        "accessibility": "explicit",
-        "overrides": {
-          "constructors": "off"
-        }
-      }
-    ],
-    "@typescript-eslint/indent": [
-      "warn",
-      2
-    ],
-    "@typescript-eslint/member-delimiter-style": [
-      "warn",
-      {
-        "multiline": {
-          "delimiter": "semi",
-          "requireLast": true
-        },
-        "singleline": {
-          "delimiter": "comma",
-          "requireLast": false
-        }
-      }
-    ],
-    "@typescript-eslint/naming-convention": [
-      "warn",
-      { "selector": "default", "format": ["camelCase"],
-        "filter": {
-          "regex": "^[a-z]",
-          "match": true
-        }
-      },
-      // variableLike
-      { "selector": "variable", "format": ["camelCase", "UPPER_CASE"] },
-      { "selector": "variable", "filter": "^I.+Service$", "format": ["PascalCase"], "prefix": ["I"] },
-      // memberLike
-      { "selector": "memberLike", "modifiers": ["private"], "format": ["camelCase"], "leadingUnderscore": "require" },
-      { "selector": "memberLike", "modifiers": ["protected"], "format": ["camelCase"], "leadingUnderscore": "require" },
-      { "selector": "enumMember", "format": ["UPPER_CASE"] },
-      // memberLike - Allow enum-like objects to use UPPER_CASE
-      { "selector": "property", "modifiers": ["public"], "format": ["camelCase", "UPPER_CASE"],
-        "filter": {
-          "regex": "^[a-z]",
-          "match": true
-        }
-      },
-      // restrict on* naming for events only
-      { "selector": "method", "modifiers": ["public"], "format": ["camelCase", "UPPER_CASE"], "custom": {
-        "regex": "^on[A-Z].+",
-        "match": false
-      } },
-      { "selector": "method", "modifiers": ["private"], "format": ["camelCase"], "leadingUnderscore": "require", "custom": {
-        "regex": "^on[A-Z].+",
-        "match": false
-      } },
-      { "selector": "method", "modifiers": ["protected"], "format": ["camelCase"], "leadingUnderscore": "require", "custom": {
-        "regex": "^on[A-Z].+",
-        "match": false
-      } },
-      // typeLike
-      { "selector": "typeLike", "format": ["PascalCase"] },
-      { "selector": "interface", "format": ["PascalCase"], "prefix": ["I"] }
-    ],
-    "@typescript-eslint/no-confusing-void-expression": [
-      "warn",
-      { "ignoreArrowShorthand": true }
-    ],
-    "@typescript-eslint/no-useless-constructor": "warn",
-    "@typescript-eslint/prefer-namespace-keyword": "warn",
-    "@typescript-eslint/type-annotation-spacing": "warn",
-    "@typescript-eslint/quotes": [
-      "warn",
-      "single",
-      { "allowTemplateLiterals": true }
-    ],
-    "@typescript-eslint/semi": [
-      "warn",
-      "always"
-    ],
-    "comma-dangle": [
-      "warn",
-      {
-        "objects": "never",
-        "arrays": "never",
-        "functions": "never"
-      }
-    ],
-    "curly": [
-      "warn",
-      "multi-line"
-    ],
-    "eol-last": "warn",
-    "eqeqeq": [
-      "warn",
-      "always"
-    ],
-    "jsdoc/check-alignment": 1,
-    "jsdoc/check-param-names": 1,
-    "jsdoc/no-multi-asterisks": 1,
-    "keyword-spacing": "warn",
-    "max-len": [
-      "warn",
-      {
-        "code": 1000, // Don't enforce for code
-        "comments": 100,
-        "ignoreTrailingComments": true,
-        "ignoreUrls": true,
-        "ignorePattern": "^ *((?<vt_comment>(//|\\*) @vt)|(?<table_comment>\\* \\| )|(?<commented_code>//  ))"
-      }
-    ],
-    "new-parens": "warn",
-    "no-duplicate-imports": "warn",
-    "no-else-return": [
-      "warn",
-      {
-        "allowElseIf": false
-      }
-    ],
-    "no-eval": "warn",
-    "no-irregular-whitespace": "warn",
-    "no-restricted-imports": [
-      "warn",
-      {
-        "patterns": [
-          ".*\\/out\\/.*"
-        ]
-      }
-    ],
-    "no-restricted-syntax": [
-      "warn",
-      {
-        "selector": "CallExpression[callee.name='requestAnimationFrame']",
-        "message": "The global requestAnimationFrame() should be avoided, call it on the parent window from ICoreBrowserService."
-      },
-      {
-        "selector": "CallExpression[callee.name='cancelAnimationFrame']",
-        "message": "The global cancelAnimationFrame() should be avoided, call it on the parent window from ICoreBrowserService."
-      },
-      {
-        "selector": "CallExpression > MemberExpression[object.name='window'][property.name='requestAnimationFrame']",
-        "message": "window.requestAnimationFrame() should be avoided, call it on the parent window from ICoreBrowserService."
-      },
-      {
-        "selector": "CallExpression > MemberExpression[object.name='window'][property.name='cancelAnimationFrame']",
-        "message": "window.cancelAnimationFrame() should be avoided, call it on the parent window from ICoreBrowserService."
-      },
-      {
-        "selector": "MemberExpression[object.name='window'][property.name='devicePixelRatio']",
-        "message": "window.devicePixelRatio should be avoided, get it from ICoreBrowserService."
-      }
-    ],
-    "no-trailing-spaces": "warn",
-    "no-unsafe-finally": "warn",
-    "no-unused-vars": ["warn", {
-      "vars": "all",
-      "args": "none"
-    }],
-    "no-var": "warn",
-    "one-var": [
-      "warn",
-      "never"
-    ],
-    "object-curly-spacing": [
-      "warn",
-      "always"
-    ],
-    "prefer-const": "warn",
-    "spaced-comment": [
-      "warn",
-      "always",
-      {
-        "markers": ["/"],
-        "exceptions": ["-"]
-      }
-    ]
-  },
-  "overrides": [
-    {
-      "files": [
-        "**/*.api.ts",
-        "**/*.test.ts"
-      ],
-      "rules": {
-        "object-curly-spacing": "off",
-        "max-len": "off",
-        "no-unused-vars": "off"
-      }
-    }
-  ]
-}

.eslintrc.json.typings

@@ -1,104 +0,0 @@
-{
-  "env": {
-    "browser": true,
-    "es2021": true,
-    "node": true
-  },
-  "parser": "@typescript-eslint/parser",
-  "plugins": [
-    "@typescript-eslint",
-    "jsdoc"
-  ],
-  "rules": {
-    "no-extra-semi": "error",
-    "@typescript-eslint/array-type": [
-      "warn",
-      {
-        "default": "array",
-        "readonly": "generic"
-      }
-    ],
-    "@typescript-eslint/explicit-function-return-type": [
-      "warn",
-      {
-        "allowExpressions": true
-      }
-    ],
-    "@typescript-eslint/indent": [
-      "warn",
-      2
-    ],
-    "@typescript-eslint/member-delimiter-style": [
-      "warn",
-      {
-        "multiline": {
-          "delimiter": "semi",
-          "requireLast": true
-        },
-        "singleline": {
-          "delimiter": "comma",
-          "requireLast": false
-        }
-      }
-    ],
-    "@typescript-eslint/naming-convention": [
-      "warn",
-      { "selector": "typeLike", "format": ["PascalCase"] },
-      { "selector": "interface", "format": ["PascalCase"], "prefix": ["I"] }
-    ],
-    "@typescript-eslint/prefer-namespace-keyword": "warn",
-    "@typescript-eslint/type-annotation-spacing": "warn",
-    "@typescript-eslint/quotes": [
-      "warn",
-      "single",
-      { "allowTemplateLiterals": true }
-    ],
-    "@typescript-eslint/semi": [
-      "warn",
-      "always"
-    ],
-    "comma-dangle": [
-      "warn",
-      {
-        "objects": "never",
-        "arrays": "never",
-        "functions": "never"
-      }
-    ],
-    "curly": [
-      "warn",
-      "multi-line"
-    ],
-    "eol-last": "warn",
-    "eqeqeq": [
-      "warn",
-      "always"
-    ],
-    "jsdoc/check-alignment": 1,
-    "jsdoc/check-param-names": 1,
-    "keyword-spacing": "warn",
-    "max-len": [
-      "warn",
-      {
-        "code": 1000, // Don't enforce for code
-        "comments": 80,
-        "ignoreUrls": true,
-        "ignorePattern": "^ *(?<ps_description>\\* Ps=)"
-      }
-    ],
-    "no-irregular-whitespace": "warn",
-    "no-trailing-spaces": "warn",
-    "object-curly-spacing": [
-      "warn",
-      "always"
-    ],
-    "spaced-comment": [
-      "warn",
-      "always",
-      {
-        "markers": ["/"],
-        "exceptions": ["-"]
-      }
-    ]
-  }
-}

.github/copilot-instructions.md

@@ -0,0 +1,93 @@
+# xterm.js Copilot Instructions
+
+## Architecture Overview
+
+**Core Structure**: xterm.js is a multi-target terminal emulator with three main distributions:
+- `src/browser/`: Full-featured browser terminal with DOM rendering
+- `src/headless/`: Server-side terminal for Node.js (no DOM)
+- `src/common/`: Shared core logic (parsing, buffer management, terminal state)
+
+**Key Classes**:
+- `Terminal` (browser/headless): Public API wrapper
+- `CoreTerminal` (common): Core terminal logic and state
+- `CoreBrowserTerminal` (browser): Browser-specific terminal implementation
+
+## Development Workflow
+
+**Build System**:
+```bash
+npm run build && npm run esbuild # Build all TypeScript and bundle
+```
+
+**Testing**:
+- Unit tests: `npm run test-unit` (Mocha)
+- Unit tests filtering to file: `npm run test-unit -- **/fileName.ts
+- Per-addon unit tests: `npm run test-unit addons/addon-image/out-esbuild/*.test.js`
+- Integration tests: `npm run test-integration` (Playwright across Chrome/Firefox/WebKit)
+- Integration tests by file: `npm run test-integration -- test/playwright/InputHandler.test.ts`. Never use grep to filter tests, it doesn't work
+- Integration tests by addon: `npm run test-integration --suite=addon-search`. Suites always follow the format `addon-<something>`
+- Lint changes: `npm run lint-changes` to lint only changed files, `npm run lint-changes-fix` to fix them
+
+## Addon Development Pattern
+
+All addons follow this structure:
+```typescript
+export class MyAddon implements ITerminalAddon {
+  activate(terminal: Terminal): void {
+    // Called when loaded via terminal.loadAddon()
+    // Register handlers, access terminal APIs
+  }
+  dispose(): void {
+    // Cleanup when addon is disposed
+  }
+}
+```
+
+**Key Examples**:
+- `addons/addon-fit/`: Terminal sizing
+- `addons/addon-webgl/`: GPU-accelerated rendering
+- `addons/addon-search/`: Text search functionality
+
+## Project-Specific Conventions
+
+**TypeScript Project Structure**: Uses TypeScript project references (`tsconfig.all.json`) for incremental builds across browser/headless/addons.
+
+**API Design**: 
+- Browser and headless terminals share the same public API
+- Proposed APIs require `allowProposedApi: true` option
+- Constructor-only options (cols, rows) cannot be changed after instantiation
+
+**Testing Utilities**: Use `TestUtils.ts` helpers:
+- `openTerminal(ctx, options)` for setup
+- `pollFor(page, fn, expectedValue)` for async assertions
+- `writeSync(page, data)` for terminal input
+
+## Common Patterns
+
+**Parser Integration**: Register custom escape sequence handlers:
+```typescript
+terminal.parser.registerCsiHandler('m', params => {
+  // Handle SGR sequences
+  return true; // Handled
+});
+```
+
+**Buffer Access**: Read terminal content via buffer API:
+```typescript
+const line = terminal.buffer.active.getLine(0);
+const cell = line?.getCell(0);
+```
+
+**Events**: All terminals emit standard events (onData, onResize, onRender) plus platform-specific ones.
+
+## Critical Implementation Details
+
+- Terminal rendering uses either DOM or WebGL renderers
+- Buffer lines are immutable; create new instances for modifications
+- Character width handling supports Unicode 11+ and grapheme clustering
+- Mouse events translate web events to terminal protocols (X10, VT200, etc.)
+- Color theming supports both palette and true color modes
+
+## Writing unit tests
+
+- Unit tests live alongside the source code file of the thing it's testing with a .test.ts suffix.

.github/instructions/unit-test-instructions.instructions.md

@@ -0,0 +1,8 @@
+---
+applyTo: '**/*.test.ts'
+---
+When writing unit tests follow these rules:
+
+- When writing unit tests for addons, always create a real xterm.js instance instead of mocking it.
+- Prefer `assert.ok` over `assert.notStrictEqual` when checking something is undefined or not.
+- Avoid comments as most tests should be self-documenting.

.github/workflows/ci.yml

@@ -12,44 +12,64 @@ jobs:
     timeout-minutes: 10
     steps:
     - uses: actions/checkout@v3
-    - name: Use Node.js 18.x
+    - name: Use Node.js 22.x
       uses: actions/setup-node@v3
       with:
-        node-version: 18.x
-        cache: 'yarn'
+        node-version: 22.x
+        cache: 'npm'
     - name: Install dependencies
-      run: yarn --frozen-lockfile
-    - name: Build
-      run: yarn setup
+      run: npm ci
+    - name: Setup and run tsc
+      run: npm run setup
+    - name: Esbuild
+      run: npm run esbuild
     - name: Zip artifacts
       run: |
         zip -r compressed-build \
+          ./lib/* \
           ./out/* \
-          ./out-test/* \
+          ./out-*/* \
+          ./addons/addon-attach/lib/* \
           ./addons/addon-attach/out/* \
-          ./addons/addon-attach/out-test/* \
-          ./addons/addon-canvas/out/* \
-          ./addons/addon-canvas/out-test/* \
+          ./addons/addon-attach/out-*/* \
+          ./addons/addon-clipboard/lib/* \
+          ./addons/addon-clipboard/out/* \
+          ./addons/addon-clipboard/out-*/* \
+          ./addons/addon-fit/lib/* \
           ./addons/addon-fit/out/* \
-          ./addons/addon-fit/out-test/* \
+          ./addons/addon-fit/out-*/* \
+          ./addons/addon-image/lib/* \
           ./addons/addon-image/out/* \
-          ./addons/addon-image/out-test/* \
+          ./addons/addon-image/out-*/* \
+          ./addons/addon-ligatures/lib/* \
           ./addons/addon-ligatures/out/* \
-          ./addons/addon-ligatures/out-test/* \
+          ./addons/addon-ligatures/out-*/* \
+          ./addons/addon-progress/lib/* \
+          ./addons/addon-progress/out/* \
+          ./addons/addon-progress/out-*/* \
+          ./addons/addon-search/lib/* \
           ./addons/addon-search/out/* \
-          ./addons/addon-search/out-test/* \
+          ./addons/addon-search/out-*/* \
+          ./addons/addon-serialize/lib/* \
           ./addons/addon-serialize/out/* \
-          ./addons/addon-serialize/out-test/* \
+          ./addons/addon-serialize/out-*/* \
+          ./addons/addon-unicode11/lib/* \
           ./addons/addon-unicode11/out/* \
-          ./addons/addon-unicode11/out-test/* \
+          ./addons/addon-unicode11/out-*/* \
+          ./addons/addon-unicode-graphemes/lib/* \
           ./addons/addon-unicode-graphemes/out/* \
-          ./addons/addon-unicode-graphemes/out-test/* \
+          ./addons/addon-unicode-graphemes/out-*/* \
+          ./addons/addon-web-links/lib/* \
           ./addons/addon-web-links/out/* \
-          ./addons/addon-web-links/out-test/* \
+          ./addons/addon-web-links/out-*/* \
+          ./addons/addon-web-fonts/lib/* \
+          ./addons/addon-web-fonts/out/* \
+          ./addons/addon-web-fonts/out-*/* \
+          ./addons/addon-webgl/lib/* \
           ./addons/addon-webgl/out/* \
-          ./addons/addon-webgl/out-test/*
+          ./addons/addon-webgl/out-*st/*
     - name: Upload artifacts
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: build-artifacts
         path: compressed-build.zip
@@ -60,21 +80,20 @@ jobs:
     timeout-minutes: 10
     steps:
     - uses: actions/checkout@v3
-    - name: Use Node.js 18.x
+    - name: Use Node.js 22.x
       uses: actions/setup-node@v3
       with:
-        node-version: 18.x
-        cache: 'yarn'
+        node-version: 22.x
+        cache: 'npm'
     - name: Install dependencies
       run: |
-        yarn --frozen-lockfile
-        yarn install-addons
+        npm ci
     - name: Lint code
       env:
         NODE_OPTIONS: --max_old_space_size=4096
-      run: yarn lint
+      run: npm run lint
     - name: Lint API
-      run: yarn lint-api
+      run: npm run lint-api
 
   test-unit-coverage:
     needs: build
@@ -82,16 +101,15 @@ jobs:
     timeout-minutes: 10
     steps:
     - uses: actions/checkout@v3
-    - name: Use Node.js 18.x
+    - name: Use Node.js 22.x
       uses: actions/setup-node@v3
       with:
-        node-version: 18.x
-        cache: 'yarn'
+        node-version: 22.x
+        cache: 'npm'
     - name: Install dependencies
       run: |
-        yarn --frozen-lockfile
-        yarn install-addons
-    - uses: actions/download-artifact@v3
+        npm ci
+    - uses: actions/download-artifact@v4
       with:
         name: build-artifacts
     - name: Unzip artifacts
@@ -105,16 +123,16 @@ jobs:
         ls -R
     - name: Unit test coverage
       run: |
-        yarn test-unit-coverage --forbid-only
+        npm run test-unit-coverage --forbid-only
         EXIT_CODE=$?
         ./node_modules/.bin/nyc report --reporter=cobertura
         exit $EXIT_CODE
 
-  test-unit-parallel:
+  test-unit:
     timeout-minutes: 20
     strategy:
       matrix:
-        node-version: [18]
+        node-version: [22]
         runs-on: [ubuntu, macos, windows]
     runs-on: ${{ matrix.runs-on }}-latest
     steps:
@@ -123,17 +141,16 @@ jobs:
       uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}.x
-        cache: 'yarn'
+        cache: 'npm'
     - name: Install dependencies
       run: |
-        yarn --frozen-lockfile
-        yarn install-addons
+        npm ci
     - name: Wait for build job
       uses: NathanFirmo/wait-for-other-job@v1.1.1
       with:
         token: ${{ secrets.GITHUB_TOKEN }}
         job: build
-    - uses: actions/download-artifact@v3
+    - uses: actions/download-artifact@v4
       with:
         name: build-artifacts
     - name: Unzip artifacts
@@ -146,68 +163,26 @@ jobs:
         fi
         ls -R
     - name: Unit tests
-      run: yarn test-unit --forbid-only
+      run: npm run test-unit --forbid-only
 
-  test-api-parallel:
+  test-integration:
     timeout-minutes: 20
     strategy:
       matrix:
-        node-version: [18] # just one as integration tests are about testing in browser
-        runs-on: [ubuntu] # macos is flaky
-        browser: [chromium, firefox]
-    runs-on: ${{ matrix.runs-on }}-latest
-    steps:
-    - uses: actions/checkout@v3
-    - name: Use Node.js ${{ matrix.node-version }}.x
-      uses: actions/setup-node@v3
-      with:
-        node-version: ${{ matrix.node-version }}.x
-        cache: 'yarn'
-    - name: Install dependencies
-      run: |
-        yarn --frozen-lockfile
-        yarn install-addons
-    - name: Install playwright
-      run: npx playwright install
-    - name: Wait for build job
-      uses: NathanFirmo/wait-for-other-job@v1.1.1
-      with:
-        token: ${{ secrets.GITHUB_TOKEN }}
-        job: build
-    - uses: actions/download-artifact@v3
-      with:
-        name: build-artifacts
-    - name: Unzip artifacts
-      shell: bash
-      run: |
-        if [ "$RUNNER_OS" == "Windows" ]; then
-          pwsh -Command "7z x compressed-build.zip -aoa -o${{ github.workspace }}"
-        else
-          unzip -o compressed-build.zip
-        fi
-        ls -R
-    - name: Integration tests (${{ matrix.browser }})
-      run: yarn test-api-${{ matrix.browser }} --headless --forbid-only
-
-  test-playwright-parallel:
-    timeout-minutes: 20
-    strategy:
-      matrix:
-        node-version: [18] # just one as integration tests are about testing in browser
-        runs-on: [ubuntu] # macos is flaky
+        node-version: [22] # just one as integration tests are about testing in browser
+        runs-on: [ubuntu-22.04] # macos is flaky
         browser: [chromium, firefox, webkit]
-    runs-on: ${{ matrix.runs-on }}-latest
+    runs-on: ${{ matrix.runs-on }}
     steps:
     - uses: actions/checkout@v3
     - name: Use Node.js ${{ matrix.node-version }}.x
       uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}.x
-        cache: 'yarn'
+        cache: 'npm'
     - name: Install dependencies
       run: |
-        yarn --frozen-lockfile
-        yarn install-addons
+        npm ci
     - name: Install playwright
       run: npx playwright install --with-deps ${{ matrix.browser }}
     - name: Wait for build job
@@ -215,7 +190,7 @@ jobs:
       with:
         token: ${{ secrets.GITHUB_TOKEN }}
         job: build
-    - uses: actions/download-artifact@v3
+    - uses: actions/download-artifact@v4
       with:
         name: build-artifacts
     - name: Unzip artifacts
@@ -227,72 +202,56 @@ jobs:
           unzip -o compressed-build.zip
         fi
         ls -R
-    - name: Build demo
-      run: yarn build-demo
+    - name: Build demo client
+      run: npm run esbuild-demo-client
+    - name: Build demo server
+      run: npm run esbuild-demo-server
     - name: Integration tests (core) # Tests use 50% workers to reduce flakiness
-      run: yarn test-playwright-${{ matrix.browser }} --workers=50% --forbid-only --suite=core
-    - name: Integration tests (addon-canvas)
-      run: yarn test-playwright-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-canvas
+      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=core
+    - name: Integration tests (addon-attach)
+      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-attach
+    - name: Integration tests (addon-clipboard)
+      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-clipboard
+    - name: Integration tests (addon-fit)
+      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-fit
+    - name: Integration tests (addon-image)
+      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-image
+    - name: Integration tests (addon-progress)
+      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-progress
+    - name: Integration tests (addon-search)
+      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-search
+    - name: Integration tests (addon-serialize)
+      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-serialize
+    - name: Integration tests (addon-unicode-graphemes)
+      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-unicode-graphemes
+    - name: Integration tests (addon-unicode11)
+      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-unicode11
+    - name: Integration tests (addon-web-fonts)
+      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-web-fonts
+    - name: Integration tests (addon-web-links)
+      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-web-links
     - name: Integration tests (addon-webgl)
-      run: yarn test-playwright-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-webgl
-
-  test-api:
-    needs: build
-    timeout-minutes: 20
-    strategy:
-      matrix:
-        node-version: [18] # just one as integration tests are about testing in browser
-        runs-on: [windows] # macos is flaky
-        browser: [chromium, firefox]
-    runs-on: ${{ matrix.runs-on }}-latest
-    steps:
-    - uses: actions/checkout@v3
-    - name: Use Node.js ${{ matrix.node-version }}.x
-      uses: actions/setup-node@v3
-      with:
-        node-version: ${{ matrix.node-version }}.x
-        cache: 'yarn'
-    - name: Install dependencies
-      run: |
-        yarn --frozen-lockfile
-        yarn install-addons
-    - name: Install playwright
-      run: npx playwright install
-    - uses: actions/download-artifact@v3
-      with:
-        name: build-artifacts
-    - name: Unzip artifacts
-      shell: bash
-      run: |
-        if [ "$RUNNER_OS" == "Windows" ]; then
-          pwsh -Command "7z x compressed-build.zip -aoa -o${{ github.workspace }}"
-        else
-          unzip -o compressed-build.zip
-        fi
-        ls -R
-    - name: Integration tests (${{ matrix.browser }})
-      run: yarn test-api-${{ matrix.browser }} --headless --forbid-only
+      run: npm run test-integration-${{ matrix.browser }} --workers=50% --forbid-only --suite=addon-webgl
 
   release-dry-run:
     needs: build
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [18]
+        node-version: [22]
     steps:
     - uses: actions/checkout@v3
     - name: Use Node.js ${{ matrix.node-version }}.x
       uses: actions/setup-node@v3
       with:
         node-version: ${{ matrix.node-version }}.x
-        cache: 'yarn'
+        cache: 'npm'
     - name: Install dependencies
       run: |
-        yarn --frozen-lockfile
-        yarn install-addons
+        npm ci
     - name: Install playwright
       run: npx playwright install
-    - uses: actions/download-artifact@v3
+    - uses: actions/download-artifact@v4
       with:
         name: build-artifacts
     - name: Unzip artifacts
@@ -306,7 +265,7 @@ jobs:
         ls -R
     - name: Package headless
       run: |
-        yarn package-headless
+        npm run package-headless
         node ./bin/package_headless.js
     - name: Publish to npm (dry run)
       run: node ./bin/publish.js --dry

.github/workflows/copilot-setup-steps.yml

@@ -0,0 +1,32 @@
+name: "Copilot Setup Steps"
+
+on:
+  workflow_dispatch:
+  push:
+    paths:
+      - .github/workflows/copilot-setup-steps.yml
+  pull_request:
+    paths:
+      - .github/workflows/copilot-setup-steps.yml
+
+jobs:
+  copilot-setup-steps:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Use Node.js 22.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 22.x
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm ci
+      - name: Setup and run tsc
+        run: npm run setup
+      - name: Esbuild
+        run: npm run esbuild

.github/workflows/release.yml

@@ -11,18 +11,18 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-    - name: Use Node.js 18.x
+    - name: Use Node.js 22.x
       uses: actions/setup-node@v3
       with:
-        node-version: 18.x
-        cache: 'yarn'
+        node-version: 22.x
+        cache: 'npm'
     - name: Install dependencies
-      run: yarn --frozen-lockfile
+      run: npm ci
     - name: Build
-      run: yarn setup
+      run: npm run setup
     - name: Package headless
       run: |
-        yarn package-headless
+        npm run package-headless
         node ./bin/package_headless.js
     - name: Publish to npm
       env:

.gitignore

@@ -3,7 +3,10 @@ node_modules/
 .lock-wscript
 lib/
 out/
+out-demo/
 out-test/
+out-esbuild/
+out-esbuild-test/
 .nyc_output/
 Makefile.gyp
 *.Makefile
@@ -16,7 +19,8 @@ npm-debug.log
 .env
 build/
 .DS_Store
-package-lock.json
+yarn.lock
+test-results/
 
 # Keep bundled code out of Git
 dist/

.mailmap

@@ -1,7 +0,0 @@
-Antonis Kalipetis <akalipetis@sourcelair.com>
-Antonis Kalipetis <akalipetis@sourcelair.com> <akalipetis@gmail.com>
-Daniel Imms <daimms@microsoft.com> <tyriar@tyriar.com>
-Paris Kasidiaris <paris@sourcelair.com>
-Paris Kasidiaris <pariskasidiaris@gmail.com>
-Thanasis Daglis <thanasis@sourcelair.com>
-Thanasis Daglis <thanasis@sourcelair.com> <ath.daglis@gmail.com>

.mocha.env

@@ -1 +0,0 @@
-NODE_PATH=./out

.mocharc.yml

@@ -1,5 +0,0 @@
-require:
-  - source-map-support/register
-reporter: spec
-color: true
-check-leaks: true

.npmignore

@@ -17,6 +17,9 @@
 !lib/**/*.js
 !lib/**/*.js.map
 
+!lib/**/*.mjs
+!lib/**/*.mjs.map
+
 !lib/**/*.css
 
 # Whitelist - src/

.npmrc

@@ -1 +0,0 @@
-package-lock=false

.nvmrc

@@ -1 +1 @@
-16
+22

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "dbaeumer.vscode-eslint"
+    ]
+}

.vscode/launch.json

@@ -61,7 +61,7 @@
       "runtimeExecutable": "npm",
       "runtimeArgs": ["start"],
       "stopOnEntry": true,
-      "runtimeVersion": "16",
+      "runtimeVersion": "22",
       "serverReadyAction": {
         "action": "openExternally",
         "pattern": "App listening to (http://.*?:[0-9]+)"

.vscode/settings.json

@@ -1,16 +1,4 @@
 {
-  "files.associations": {
-    ".eslintrc.json.typings": "jsonc"
-  },
   "typescript.preferences.importModuleSpecifier": "non-relative",
-  "typescript.preferences.quoteStyle": "single",
-  "mochaExplorer.envPath": ".mocha.env",
-  "mochaExplorer.files": [
-    "out/**/*.test.js",
-    "addons/**/out/*.test.js"
-  ],
-  "mochaExplorer.watch": [
-    "out/**/*.js",
-    "addons/**/out/*.js"
-  ]
+  "typescript.preferences.quoteStyle": "single"
 }

.vscode/tasks.json

@@ -8,6 +8,87 @@
     "showReuseMessage": true
   },
   "tasks": [
+    // Compound tasks
+    {
+      "label": "dev",
+      "detail": "Runs all tasks required to run the demo in a single terminal using concurrently. This does not support problem matching.",
+      "type": "npm",
+      "script": "dev",
+      "isBackground": true,
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      }
+    },
+    {
+      "label": "dev (separate terminals)",
+      "detail": "Runs all tasks required to run the demo in separate terminals. This does support problem matching.",
+      "dependsOn": ["demo-server", "tsc", "esbuild", "esbuild-demo-client", "esbuild-demo-server"],
+      "group": "build"
+    },
+
+    // Demo
+    {
+      "label": "demo-server",
+      "type": "npm",
+      "script": "start",
+      "group": "build",
+      "isBackground": true,
+      "problemMatcher": [],
+      "presentation": {
+        "group": "xterm-demo"
+      }
+    },
+
+    // Build
+    {
+      "label": "tsc",
+      "type": "npm",
+      "script": "tsc-watch",
+      "group": "build",
+      "isBackground": true,
+      "problemMatcher": "$tsc-watch",
+      "presentation": {
+        "group": "xterm-build"
+      }
+    },
+    {
+      "label": "esbuild",
+      "type": "npm",
+      "script": "esbuild-watch",
+      "group": "build",
+      "isBackground": true,
+      "problemMatcher": "$esbuild-watch",
+      "presentation": {
+        "group": "xterm-build"
+      }
+    },
+    {
+      "label": "esbuild-demo-client",
+      "type": "npm",
+      "script": "esbuild-demo-client-watch",
+      "dependsOn": ["esbuild", "tsc"],
+      "group": "build",
+      "isBackground": true,
+      "problemMatcher": "$esbuild-watch",
+      "presentation": {
+        "group": "xterm-demo"
+      }
+    },
+    {
+      "label": "esbuild-demo-server",
+      "type": "npm",
+      "script": "esbuild-demo-server-watch",
+      "dependsOn": ["esbuild", "tsc"],
+      "group": "build",
+      "isBackground": true,
+      "problemMatcher": "$esbuild-watch",
+      "presentation": {
+        "group": "xterm-demo"
+      }
+    },
+
+    // Test
     {
       "type": "npm",
       "script": "test",
@@ -16,59 +97,6 @@
         "isDefault": true
       },
       "problemMatcher": []
-    },
-    {
-      "label": "watch",
-      "type": "npm",
-      "script": "watch",
-      "group": "build",
-      "isBackground": true,
-      "problemMatcher": "$tsc-watch",
-      "presentation": {
-        "group": "vscode"
-      }
-    },
-    {
-      "label": "start",
-      "type": "npm",
-      "script": "start",
-      "group": "build",
-      "isBackground": true,
-      "problemMatcher": [],
-      "presentation": {
-        "group": "vscode"
-      }
-    },
-    {
-      "label": "Start demo",
-      "dependsOn": ["start", "watch"],
-      "group": {
-        "kind": "build",
-        "isDefault": true
-      },
-      "isBackground": true,
-      "problemMatcher": {
-        "owner": "typescript",
-        "fileLocation": [
-          "relative",
-          "${workspaceFolder}"
-        ],
-        "pattern": [
-          {
-            "regexp": "^([^\\\\s].*)\\\\((\\\\d+,\\\\d+)\\\\):\\\\s*(.*)$",
-            "file": 1,
-            "location": 2,
-            "message": 3
-          }
-        ],
-        "background": {
-          "beginsPattern": "assets by",
-          "endsPattern": "webpack \\d+\\.\\d+\\.\\d+ compiled successfully"
-        }
-      },
-      "presentation": {
-        "group": "vscode"
-      }
     }
   ]
 }

CONTRIBUTING.md

@@ -1,62 +1,50 @@
 # How to contribute to xterm.js
 
-- [Opening issues for bug reports or feature requests](#opening-issues)
 - [Contributing code](#contributing-code)
+- [Opening issues](#opening-issues)
+- [Answering discussion questions](#answering-discussion-questions)
+
+## Contributing code
+
+You can find issues to work on by looking at issues labeled with [help wanted](https://github.com/xtermjs/xterm.js/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) or [good first issue](https://github.com/xtermjs/xterm.js/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). It's a good idea to comment on the issue saying that you're looking into it, just in case someone else comes along and you duplicate work. Once you have your issue, here are the steps to contribute:
+
+- Fork [xterm.js](https://github.com/xtermjs/xterm.js/) ([how to fork a repo](https://help.github.com/articles/fork-a-repo)).
+- Get the [xterm.js demo](https://github.com/xtermjs/xterm.js/wiki/Contributing#running-the-demo) running.
+- Make the fix and verify it works in the demo. Be sure to follow thew general code style of the rest of the project.
+- If your changes are easy to test or likely to regress in the future, add tests. These could be unit or integration (playwright) tests.
+- Submit a pull request ([how to create a pull request](https://help.github.com/articles/fork-a-repo)).
+
+> ![TIP]
+> Don't put more than one feature or fix in a single pull request. The smaller pull requests are the easier they are to review and merge.
+
+By contributing code to xterm.js you:
+
+ - Agree to license the contributed code under xterm.js' [MIT license](LICENSE).
+ - Confirm that you have the right to contribute and license the code in question. This means that either you hold all rights on the code, or the rights holder has explicitly granted the right to use it like this, through a compatible open source license or through a direct agreement with you.
 
 ## Opening issues
 
 The preferred way to report bugs or request features is to use
-[GitHub issues](http://github.com/sourcelair/xterm.js/issues). Before
-opening an issue, read these pointers.
+[GitHub issues](http://github.com/xtermjs/xterm.js/issues).
 
-### Opening issues effectively
+### Creating great issues
 
-- Include information about **the browser in which the problem occurred**. Even
-  if you tested several browsers, and the problem occurred in all of them,
-  mention this fact in the bug report. Also include browser version numbers and
-  the operating system that you're on.
+- Include information about **the browser in which the problem occurred** or the terminal being used. If you tested several browsers and the problem occurred in all of them, mention this fact in the bug report. Also include browser version numbers and the operating system that you're on.
+- Include the version of xterm.js being used, preferably either with the latest `beta` tagged release on npm or reproducing in the demo on the `master` branch.
+- Mention precisely what went wrong. What did you expect to happen? What happened instead? Describe the exact steps a maintainer has to take to make the problem occur.
+- If the problem can not be reproduced in the [demo of xterm.js](https://github.com/xtermjs/xterm.js/wiki/Contributing#running-the-demo), provide an HTML document that demonstrates the problem.
+- Be polite and follow [the code of conduct](https://github.com/xtermjs/xterm.js?tab=coc-ov-file#readme).
 
-- Mention which release of xterm.js you're using. Preferably, try also with
-  the current HEAD of the master branch, to ensure the problem has not already been
-  fixed.
+### Issue triaging philosophy
 
-- Mention precisely what went wrong. What did you expect to happen? What happened instead? Describe the
-  exact steps a maintainer has to take to make the problem occur.
+It's pretty common for maintainers of large open source projects to suffer from burnout, especially when needing to triage a large number of incoming issues instead of actually building things. Here are some of the steps we take to try mitigate this:
 
-- If the problem can not be reproduced in the [demo of xterm.js](https://github.com/xtermjs/xterm.js/wiki/Contributing#running-the-demo), please provide an HTML document that demonstrates the problem.
-
-- Be polite. Issues with an indignant or belligerent tone tend to be moved to the
-  bottom of the pile.
+- Support questions live in [GH discussions](https://github.com/xtermjs/xterm.js/discussions), issues may be transfered there without further comment and core maintainers may or may not participate in discussions.
+- Issues are strictly for well defined features or bugs that are _actionable_.
+- Sometimes features are out of scope. A common example of this is a niche feature that the pricipal implementation ([VS Code](https://code.visualstudio.com/)) won't leverage and therefore would be difficult to maintain and likely suffer from bitrot. The reporter may not agree with this, but you could always create an addon if that works or maintain your own fork if it comes to that.
+- If a feature does not have a clear way forward or needs more discussion it may be closed ro moved to a discussion.
+- If a bug is not easily reproducible it may be closed or moved to a discussion. Generally issues that are labeled are something we want to do or has actionable steps to look into further.
 
 ## Answering discussion questions
 
-Issues are only meant to track (likely) feature requests and bugs. We use [GitHub Discussions](https://github.com/xtermjs/xterm.js/discussions) for general Q&A as well as discussing possible features. If you want to help out, many questions get asked over at the [discussions page](https://github.com/xtermjs/xterm.js/discussions) which could use an expert as the core team is often stretched thin.
-
-## Contributing code
-
-You can find issues to work on by looking at the [help wanted](https://github.com/xtermjs/xterm.js/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) or [good first issue](https://github.com/xtermjs/xterm.js/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) issues. It's a good idea to comment on the issue saying that you're taking it, just in case someone else comes along and you duplicate work. Once you have your issue, here are the steps to contribute:
-
-- Fork [xterm.js](https://github.com/sourcelair/xterm.js/)
-  ([how to fork a repo](https://help.github.com/articles/fork-a-repo)).
-- Get the [xterm.js demo](https://github.com/xtermjs/xterm.js/wiki/Contributing#running-the-demo) running.
-- Make your changes.
-- If your changes are easy to test or likely to regress, add tests. Tests go into `test`, directory.
-- Follow the general code style of the rest of the project (see below).
-- Submit a pull request
-([how to create a pull request](https://help.github.com/articles/fork-a-repo)).
-  Don't put more than one feature/fix in a single pull request.
-
-By contributing code to xterm.js you:
-
- - Agree to license the contributed code under xterm.js' [MIT
-   license](LICENSE).
-
- - Confirm that you have the right to contribute and license the code
-   in question. (Either you hold all rights on the code, or the rights
-   holder has explicitly granted the right to use it like this,
-   through a compatible open source license or through a direct
-   agreement with you.)
-
-### Test coverage
-
-One area that always needs attention is improving out unit test coverage, you can view the code coverage report on [Azure Pipelines](https://dev.azure.com/xtermjs/xterm.js/_build/latest?definitionId=3) by clicking the Code Coverage tab.
+Issues are only meant to track (likely) feature requests and bugs. We use [GitHub Discussions](https://github.com/xtermjs/xterm.js/discussions) for general Q&A as well as discussing possible features. If you want to help out, many questions get asked over at the [discussions page](https://github.com/xtermjs/xterm.js/discussions) which could use an expert as the core team is often stretched thin.

Procfile

@@ -1,2 +0,0 @@
-web: npm start
-webpack: npm run watch

README.md

@@ -1,27 +1,27 @@
-# [![xterm.js logo](logo-full.png)](https://xtermjs.org)
+# [![xterm.js](images/logo-full.png)](https://xtermjs.org)
 
-Xterm.js is a front-end component written in TypeScript that lets applications bring fully-featured terminals to their users in the browser. It's used by popular projects such as VS Code, Hyper and Theia.
+Xterm.js is a frontend component that enables applications to bring fully-featured terminals to their users in the browser. It's used by popular projects such as [VS Code](https://code.visualstudio.com/) (and its forks), [Tabby](https://tabby.sh/) and [Hyper](https://hyper.is/).
 
 ## Features
 
 - **Terminal apps just work**: Xterm.js works with most terminal apps such as `bash`, `vim`, and `tmux`, including support for curses-based apps and mouse events.
-- **Performant**: Xterm.js is *really* fast, it even includes a GPU-accelerated renderer.
+- **Performant**: Xterm.js is *really* fast and includes an optional GPU-accelerated renderer.
 - **Rich Unicode support**: Supports CJK, emojis, and IMEs.
-- **Self-contained**: Requires zero dependencies to work.
-- **Accessible**: Screen reader and minimum contrast ratio support can be turned on.
-- **And much more**: Links, theming, addons, well documented API, etc.
+- **Self-contained**: The core library has zero dependencies.
+- **Accessible**: Screen reader mode and minimum contrast ratio support can be turned on.
+- **And much more**: Links, theming, custom glyphs, addons, well documented API, etc.
 
 ## What xterm.js is not
 
 - Xterm.js is not a terminal application that you can download and use on your computer.
-- Xterm.js is not `bash`. Xterm.js can be connected to processes like `bash` and let you interact with them (provide input, receive output).
+- Xterm.js is not `bash`. Xterm.js can be connected to processes like `bash` and let you interact with them (provide input, receive output) through a library like [node-pty](https://github.com/microsoft/node-pty).
 
 ## Getting Started
 
-First, you need to install the module, we ship exclusively through [npm](https://www.npmjs.com/), so you need that installed and then add xterm.js as a dependency by running:
+First, you need to install the module. We ship exclusively through [npm](https://www.npmjs.com), so you need that installed and then add [@xterm/xterm](https://www.npmjs.com/package/@xterm/xterm) as a dependency by running:
 
 ```bash
-npm install @xterm/xterm
+npm install --save @xterm/xterm
 ```
 
 To start using xterm.js on your browser, add the `xterm.js` and `xterm.css` to the head of your HTML page. Then create a `<div id="terminal"></div>` onto which xterm can attach itself. Finally, instantiate the `Terminal` object and then call the `open` function with the DOM object of the `div`.
@@ -54,12 +54,10 @@ import { Terminal } from '@xterm/xterm';
 
 ### Addons
 
-⚠️ *This section describes the new addon format introduced in v3.14.0, see [here](https://github.com/xtermjs/xterm.js/blob/3.14.2/README.md#addons) for the instructions on the old format*
-
 Addons are separate modules that extend the `Terminal` by building on the [xterm.js API](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts). To use an addon, you first need to install it in your project:
 
 ```bash
-npm i -S @xterm/addon-web-links
+npm install --save @xterm/addon-web-links
 ```
 
 Then import the addon, instantiate it and call `Terminal.loadAddon`:
@@ -77,58 +75,58 @@ terminal.loadAddon(new WebLinksAddon());
 The xterm.js team maintains the following addons, but anyone can build them:
 
 - [`@xterm/addon-attach`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-attach): Attaches to a server running a process via a websocket
-- [`@xterm/addon-canvas`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-canvas): Renders xterm.js using a `canvas` element's 2d context
+- [`@xterm/addon-clipboard`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-clipboard): Access the browser's clipboard
 - [`@xterm/addon-fit`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-fit): Fits the terminal to the containing element
 - [`@xterm/addon-image`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-image): Adds image support
+- [`@xterm/addon-ligatures`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-ligatures): Enables rendering of ligatures
+- [`@xterm/addon-progress`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-progress): Adds support for the progress API (`OSC 9;4`)
 - [`@xterm/addon-search`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-search): Adds search functionality
-- [`@xterm/addon-serialize`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-serialize): Serializes the terminal's buffer to a VT sequences or HTML
+- [`@xterm/addon-serialize`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-serialize): Serializes the terminal's buffer to VT sequences or HTML
+- [`@xterm/addon-unicode-graphemes`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-unicode-graphemes): Enhanced unicode support including grapheme clustering (experimental)
 - [`@xterm/addon-unicode11`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-unicode11): Updates character widths to their unicode11 values
+- [`@xterm/addon-web-fonts`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-web-fonts): Easily integrate web fonts
 - [`@xterm/addon-web-links`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-web-links): Adds web link detection and interaction
 - [`@xterm/addon-webgl`](https://github.com/xtermjs/xterm.js/tree/master/addons/addon-webgl): Renders xterm.js using a `canvas` element's webgl2 context
 
 ## Browser Support
 
-Since xterm.js is typically implemented as a developer tool, only modern browsers are supported officially. Specifically the latest versions of *Chrome*, *Edge*, *Firefox*, and *Safari*.
-
-Xterm.js works seamlessly in [Electron](https://electronjs.org/) apps and may even work on earlier versions of the browsers. These are the versions we strive to keep working.
+Since xterm.js is typically implemented as a developer tool, generally only modern evergreen browsers are supported officially. Specifically the latest versions of *Chrome*, *Edge*, *Firefox*, and *Safari*. Xterm.js also works seamlessly in [Electron](https://electronjs.org/) apps and may even work on earlier versions of the browsers. These are the versions we strive to keep working.
 
 ### Node.js Support
 
-We also publish [`xterm-headless`](https://www.npmjs.com/package/xterm-headless) which is a stripped down version of xterm.js that runs in Node.js. An example use case for this is to keep track of a terminal's state where the process is running and using the serialize addon so it can get all state restored upon reconnection.
+We also publish [`xterm-headless`](https://www.npmjs.com/package/xterm-headless) which is a stripped down version of xterm.js that runs headless in Node.js. An example use case for this is to keep track of a terminal's state where the process is running and using the [serialize addon](https://www.npmjs.com/package/@xterm/addon-serialize) so it can get all state restored upon reconnection.
 
 ## API
 
 The full API for xterm.js is contained within the [TypeScript declaration file](https://github.com/xtermjs/xterm.js/blob/master/typings/xterm.d.ts), use the branch/tag picker in GitHub (`w`) to navigate to the correct version of the API.
 
-Note that some APIs are marked *experimental*, these are added to enable experimentation with new ideas without committing to support it like a normal [semver](https://semver.org/) API. Note that these APIs can change radically between versions, so be sure to read release notes if you plan on using experimental APIs.
+Some APIs may be marked with *experimental*, these are added to enable experimentation with new ideas without committing to support it like a normal [semver](https://semver.org/) API. Note that these APIs can change radically between versions, so be sure to read release notes if you plan on using experimental APIs.
 
 ## Releases
 
-Xterm.js follows a monthly release cycle roughly.
-
-All current and past releases are available on this repo's [Releases page](https://github.com/sourcelair/xterm.js/releases), you can view the [high-level roadmap on the wiki](https://github.com/xtermjs/xterm.js/wiki/Roadmap) and see what we're working on now by looking through [Milestones](https://github.com/sourcelair/xterm.js/milestones).
+Stable releases are done on an as needed basis. All current and past releases are available on this repo's [releases page](https://github.com/sourcelair/xterm.js/releases), you can see what's planned for upcoming releases looking through the repository [milestones](https://github.com/sourcelair/xterm.js/milestones).
 
 ### Beta builds
 
-Our CI releases beta builds to npm for every change that goes into master. Install the latest beta build with:
+Beta releases are continuously published off the `master` branch. Install the latest beta build with:
 
 ```bash
-npm install -S @xterm/xterm@beta
+npm install --save @xterm/xterm@beta
 ```
 
-These should generally be stable, but some bugs may slip in. We recommend using the beta build primarily to test out new features and to verify bug fixes.
+The principal implementation (VS Code) typically uses the latest or near the latest beta build. Generally they are quite stable but can potentially contain bugs or breaking changes. If stability is very important we recommend using the beta build primarily to test out new features and to verify bug fixes, unless you're tracking what's landing and are comfortable taking that risk.
 
 ## Contributing
 
-You can read the [guide on the wiki](https://github.com/xtermjs/xterm.js/wiki/Contributing) to learn how to contribute and set up xterm.js for development.
+Read [CONTRIBUTING.md](https://github.com/xtermjs/xterm.js/blob/master/CONTRIBUTING.md) to learn how to contribute to the project.
 
 ## Real-world uses
-Xterm.js is used in several world-class applications to provide great terminal experiences.
+
+Xterm.js is used in many world-class applications to provide great terminal experiences.
 
 - [**SourceLair**](https://www.sourcelair.com/): In-browser IDE that provides its users with fully-featured Linux terminals based on xterm.js.
 - [**Microsoft Visual Studio Code**](http://code.visualstudio.com/): Modern, versatile, and powerful open source code editor that provides an integrated terminal based on xterm.js.
 - [**ttyd**](https://github.com/tsl0922/ttyd): A command-line tool for sharing terminal over the web, with fully-featured terminal emulation based on xterm.js.
-- [**Katacoda**](https://www.katacoda.com/): Katacoda is an Interactive Learning Platform for software developers, covering the latest Cloud Native technologies.
 - [**Eclipse Che**](http://www.eclipse.org/che): Developer workspace server, cloud IDE, and Eclipse next-generation IDE.
 - [**Codenvy**](http://www.codenvy.com): Cloud workspaces for development teams.
 - [**CoderPad**](https://coderpad.io): Online interviewing platform for programmers. Run code in many programming languages, with results displayed by xterm.js.
@@ -222,14 +220,23 @@ Xterm.js is used in several world-class applications to provide great terminal e
 - [**Cloudtutor.io**](https://cloudtutor.io): innovative online learning platform that offers users access to an interactive lab.
 - [**Helix Editor Playground**](https://github.com/tomgroenwoldt/helix-editor-playground): Online playground for the terminal based helix editor.
 - [**Coder**](https://github.com/coder/coder): Self-Hosted Remote Development Environments
+- [**Wave Terminal**](https://waveterm.dev): An open-source, ai-native, terminal built for seamless workflows.
+- [**eva**](https://github.com/info24/eva): Eva is a web application for SSH remote login, developed in Go.
+- [**OpenSFTP**](https://opensftp.com): Super beautiful SSH and SFTP integrated workspace client.
+- [**balena**](https://www.balena.io/): Balena is a full-stack solution for developing, deploying, updating, and troubleshooting IoT Edge devices. We use xterm.js to manage & debug devices on [balenaCloud](https://www.balena.io/cloud).
+- [**Filet Cloud**](https://github.com/fuglaro/filet-cloud): The lean and powerful personal cloud ⛅.
+- [**pyTermTk**](https://github.com/ceccopierangiolieugenio/pyTermTk): Python Terminal Toolkit - a Spiced Up Cross Compatible TUI Library 🌶️, use xterm.js for the [HTML5 exporter](https://ceccopierangiolieugenio.github.io/pyTermTk/sandbox/sandbox.html).
+- [**ecmaOS**](https://ecmaos.sh): A kernel and suite of applications tying modern web technologies into a browser-based operating system.
+- [**LabEx**](https://labex.io): Interactive learning platform with hands-on labs and xterm.js-based online terminals, focused on learn-by-doing approach.
+- [**EmuDevz**](https://afska.github.io/emudevz): A free coding game where players learn how to build an emulator from scratch.
 - [And much more...](https://github.com/xtermjs/xterm.js/network/dependents?package_id=UGFja2FnZS0xNjYzMjc4OQ%3D%3D)
 
-Do you use xterm.js in your application as well? Please [open a Pull Request](https://github.com/sourcelair/xterm.js/pulls) to include it here. We would love to have it on our list. Note: Please add any new contributions to the end of the list only.
+Do you use xterm.js in your application as well? Please [open a Pull Request](https://github.com/sourcelair/xterm.js/pulls) to include it here. We would love to have it on our list. Please add any new contributions to the end of the list.
 
 ## License Agreement
 
 If you contribute code to this project, you implicitly allow your code to be distributed under the MIT license. You are also implicitly verifying that all code is your original work.
 
-Copyright (c) 2017-2022, [The xterm.js authors](https://github.com/xtermjs/xterm.js/graphs/contributors) (MIT License)<br>
+Copyright (c) 2017-2026, [The xterm.js authors](https://github.com/xtermjs/xterm.js/graphs/contributors) (MIT License)<br>
 Copyright (c) 2014-2017, SourceLair, Private Company ([www.sourcelair.com](https://www.sourcelair.com/home)) (MIT License)<br>
 Copyright (c) 2012-2013, Christopher Jeffrey (MIT License)

addons/addon-attach/.npmignore

@@ -8,6 +8,9 @@
 !lib/**/*.js
 !lib/**/*.js.map
 
+!lib/**/*.mjs
+!lib/**/*.mjs.map
+
 !lib/**/*.css
 
 # Whitelist - src/

addons/addon-attach/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@xterm/addon-attach",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "author": {
     "name": "The xterm.js authors",
     "url": "https://xtermjs.org/"
   },
   "main": "lib/addon-attach.js",
+  "module": "lib/addon-attach.mjs",
   "types": "typings/addon-attach.d.ts",
   "repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/addon-attach",
   "license": "MIT",
@@ -18,9 +19,7 @@
     "build": "../../node_modules/.bin/tsc -p .",
     "prepackage": "npm run build",
     "package": "../../node_modules/.bin/webpack",
-    "prepublishOnly": "npm run package"
-  },
-  "peerDependencies": {
-    "@xterm/xterm": "^5.0.0"
+    "prepublishOnly": "npm run package",
+    "start": "node ../../demo/start"
   }
 }

addons/addon-attach/test/AttachAddon.api.ts

@@ -1,50 +0,0 @@
-/**
- * Copyright (c) 2019 The xterm.js authors. All rights reserved.
- * @license MIT
- */
-
-import WebSocket = require('ws');
-import { openTerminal, pollFor, launchBrowser } from '../../../out-test/api/TestUtils';
-import { Browser, Page } from '@playwright/test';
-
-const APP = 'http://127.0.0.1:3001/test';
-
-let browser: Browser;
-let page: Page;
-const width = 800;
-const height = 600;
-
-describe('AttachAddon', () => {
-  before(async function(): Promise<any> {
-    browser = await launchBrowser();
-    page = await (await browser.newContext()).newPage();
-    await page.setViewportSize({ width, height });
-  });
-
-  after(async () => {
-    await browser.close();
-  });
-
-  beforeEach(async () => await page.goto(APP));
-
-  it('string', async function(): Promise<any> {
-    await openTerminal(page);
-    const port = 8080;
-    const server = new WebSocket.Server({ port });
-    server.on('connection', socket => socket.send('foo'));
-    await page.evaluate(`window.term.loadAddon(new window.AttachAddon(new WebSocket('ws://localhost:${port}')))`);
-    await pollFor(page, `window.term.buffer.active.getLine(0).translateToString(true)`, 'foo');
-    server.close();
-  });
-
-  it('utf8', async function(): Promise<any> {
-    await openTerminal(page);
-    const port = 8080;
-    const server = new WebSocket.Server({ port });
-    const data = new Uint8Array([102, 111, 111]);
-    server.on('connection', socket => socket.send(data));
-    await page.evaluate(`window.term.loadAddon(new window.AttachAddon(new WebSocket('ws://localhost:${port}')))`);
-    await pollFor(page, `window.term.buffer.active.getLine(0).translateToString(true)`, 'foo');
-    server.close();
-  });
-});

addons/addon-attach/test/AttachAddon.test.ts

@@ -0,0 +1,42 @@
+/**
+ * Copyright (c) 2019 The xterm.js authors. All rights reserved.
+ * @license MIT
+ */
+
+import WebSocket = require('ws');
+
+import test from '@playwright/test';
+import { ITestContext, createTestContext, openTerminal, pollFor, timeout } from '../../../test/playwright/TestUtils';
+
+let ctx: ITestContext;
+test.beforeAll(async ({ browser }) => {
+  ctx = await createTestContext(browser);
+  await openTerminal(ctx);
+});
+test.afterAll(async () => await ctx.page.close());
+
+test.describe('Search Tests', () => {
+
+  test.beforeEach(async () => {
+    await ctx.proxy.reset();
+  });
+
+  test('string', async function(): Promise<any> {
+    const port = 8080;
+    const server = new WebSocket.Server({ port });
+    server.on('connection', socket => socket.send('foo'));
+    await ctx.page.evaluate(`window.term.loadAddon(new window.AttachAddon(new WebSocket('ws://localhost:${port}')))`);
+    await pollFor(ctx.page, `window.term.buffer.active.getLine(0).translateToString(true)`, 'foo');
+    server.close();
+  });
+
+  test('utf8', async function(): Promise<any> {
+    const port = 8080;
+    const server = new WebSocket.Server({ port });
+    const data = new Uint8Array([102, 111, 111]);
+    server.on('connection', socket => socket.send(data));
+    await ctx.page.evaluate(`window.term.loadAddon(new window.AttachAddon(new WebSocket('ws://localhost:${port}')))`);
+    await pollFor(ctx.page, `window.term.buffer.active.getLine(0).translateToString(true)`, 'foo');
+    server.close();
+  });
+});

addons/addon-attach/test/playwright.config.ts

@@ -5,14 +5,14 @@ const config: PlaywrightTestConfig = {
   timeout: 10000,
   projects: [
     {
-      name: 'Chrome Stable',
+      name: 'ChromeStable',
       use: {
         browserName: 'chromium',
         channel: 'chrome'
       }
     },
     {
-      name: 'Firefox Stable',
+      name: 'FirefoxStable',
       use: {
         browserName: 'firefox'
       }
@@ -26,7 +26,7 @@ const config: PlaywrightTestConfig = {
   ],
   reporter: 'list',
   webServer: {
-    command: 'npm run start-server-only',
+    command: 'npm run start',
     port: 3000,
     timeout: 120000,
     reuseExistingServer: !process.env.CI

addons/addon-attach/test/tsconfig.json

@@ -1,23 +1,41 @@
 {
   "compilerOptions": {
     "module": "commonjs",
-    "target": "es2021",
+    "target": "ESNext",
     "lib": [
-      "es2015"
+      "es2021",
     ],
     "rootDir": ".",
     "outDir": "../out-test",
     "sourceMap": true,
     "removeComments": true,
+    "baseUrl": ".",
+    "paths": {
+      "common/*": [
+        "../../../src/common/*"
+      ],
+      "browser/*": [
+        "../../../src/browser/*"
+      ]
+    },
     "strict": true,
     "types": [
-      "../../../node_modules/@types/mocha",
-      "../../../node_modules/@types/node",
-      "../../../out-test/api/TestUtils"
+      "../../../node_modules/@types/node"
     ]
   },
   "include": [
     "./**/*",
     "../../../typings/xterm.d.ts"
+  ],
+  "references": [
+    {
+      "path": "../../../src/common"
+    },
+    {
+      "path": "../../../src/browser"
+    },
+    {
+      "path": "../../../test/playwright"
+    }
   ]
 }

addons/addon-attach/webpack.config.js

@@ -25,7 +25,9 @@ module.exports = {
     filename: mainFile,
     path: path.resolve('./lib'),
     library: addonName,
-    libraryTarget: 'umd'
+    libraryTarget: 'umd',
+    // Force usage of globalThis instead of global / self. (This is cross-env compatible)
+    globalObject: 'globalThis',
   },
   mode: 'production'
 };

addons/addon-canvas/.gitignore

@@ -1,2 +0,0 @@
-lib
-node_modules

addons/addon-canvas/README.md

@@ -1,28 +0,0 @@
-## @xterm/addon-canvas
-
-An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables a canvas-based renderer using a 2d context to draw. This addon requires xterm.js v5+.
-
-The purpose of this addon is to be used as a fallback for the [webgl addon](https://www.npmjs.com/package/@xterm/addon-webgl) when better performance is desired over the default DOM renderer, but WebGL2 isn't supported or performant for some reason.
-
-### Install
-
-```bash
-npm install --save @xterm/addon-canvas
-```
-
-### Usage
-
-```ts
-import { Terminal } from '@xterm/xterm';
-import { CanvasAddon } from '@xterm/addon-canvas';
-
-const terminal = new Terminal();
-terminal.open(element);
-terminal.loadAddon(new CanvasAddon());
-```
-
-See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/addon-canvas/typings/addon-canvas.d.ts) for more advanced usage.
-
-### See also
-
-- [@xterm/addon-webgl](https://www.npmjs.com/package/@xterm/addon-webgl) A renderer for xterm.js that uses WebGL

addons/addon-canvas/src/BaseRenderLayer.ts

@@ -1,511 +0,0 @@
-/**
- * Copyright (c) 2017 The xterm.js authors. All rights reserved.
- * @license MIT
- */
-
-import { ReadonlyColorSet } from 'browser/Types';
-import { CellColorResolver } from 'browser/renderer/shared/CellColorResolver';
-import { acquireTextureAtlas } from 'browser/renderer/shared/CharAtlasCache';
-import { TEXT_BASELINE } from 'browser/renderer/shared/Constants';
-import { tryDrawCustomChar } from 'browser/renderer/shared/CustomGlyphs';
-import { allowRescaling, throwIfFalsy } from 'browser/renderer/shared/RendererUtils';
-import { createSelectionRenderModel } from 'browser/renderer/shared/SelectionRenderModel';
-import { IRasterizedGlyph, IRenderDimensions, ISelectionRenderModel, ITextureAtlas } from 'browser/renderer/shared/Types';
-import { ICoreBrowserService, IThemeService } from 'browser/services/Services';
-import { EventEmitter, forwardEvent } from 'common/EventEmitter';
-import { Disposable, MutableDisposable, toDisposable } from 'common/Lifecycle';
-import { isSafari } from 'common/Platform';
-import { ICellData } from 'common/Types';
-import { CellData } from 'common/buffer/CellData';
-import { WHITESPACE_CELL_CODE } from 'common/buffer/Constants';
-import { IBufferService, IDecorationService, IOptionsService } from 'common/services/Services';
-import { Terminal } from '@xterm/xterm';
-import { IRenderLayer } from './Types';
-
-export abstract class BaseRenderLayer extends Disposable implements IRenderLayer {
-  private _canvas: HTMLCanvasElement;
-  protected _ctx!: CanvasRenderingContext2D;
-  private _deviceCharWidth: number = 0;
-  private _deviceCharHeight: number = 0;
-  private _deviceCellWidth: number = 0;
-  private _deviceCellHeight: number = 0;
-  private _deviceCharLeft: number = 0;
-  private _deviceCharTop: number = 0;
-
-  protected _selectionModel: ISelectionRenderModel = createSelectionRenderModel();
-  private _cellColorResolver: CellColorResolver;
-  private _bitmapGenerator: (BitmapGenerator | undefined)[] = [];
-
-  protected _charAtlas!: ITextureAtlas;
-  protected _charAtlasDisposable = this.register(new MutableDisposable());
-
-  public get canvas(): HTMLCanvasElement { return this._canvas; }
-  public get cacheCanvas(): HTMLCanvasElement { return this._charAtlas?.pages[0].canvas!; }
-
-  private readonly _onAddTextureAtlasCanvas = this.register(new EventEmitter<HTMLCanvasElement>());
-  public readonly onAddTextureAtlasCanvas = this._onAddTextureAtlasCanvas.event;
-
-  constructor(
-    private readonly _terminal: Terminal,
-    private _container: HTMLElement,
-    id: string,
-    zIndex: number,
-    private _alpha: boolean,
-    protected readonly _themeService: IThemeService,
-    protected readonly _bufferService: IBufferService,
-    protected readonly _optionsService: IOptionsService,
-    protected readonly _decorationService: IDecorationService,
-    protected readonly _coreBrowserService: ICoreBrowserService
-  ) {
-    super();
-    this._cellColorResolver = new CellColorResolver(this._terminal, this._optionsService, this._selectionModel, this._decorationService, this._coreBrowserService, this._themeService);
-    this._canvas = this._coreBrowserService.mainDocument.createElement('canvas');
-    this._canvas.classList.add(`xterm-${id}-layer`);
-    this._canvas.style.zIndex = zIndex.toString();
-    this._initCanvas();
-    this._container.appendChild(this._canvas);
-    this._refreshCharAtlas(this._themeService.colors);
-    this.register(this._themeService.onChangeColors(e => {
-      this._refreshCharAtlas(e);
-      this.reset();
-      // Trigger selection changed as it's handled separately to regular rendering
-      this.handleSelectionChanged(this._selectionModel.selectionStart, this._selectionModel.selectionEnd, this._selectionModel.columnSelectMode);
-    }));
-
-    this.register(toDisposable(() => {
-      this._canvas.remove();
-    }));
-  }
-
-  private _initCanvas(): void {
-    this._ctx = throwIfFalsy(this._canvas.getContext('2d', { alpha: this._alpha }));
-    // Draw the background if this is an opaque layer
-    if (!this._alpha) {
-      this._clearAll();
-    }
-  }
-
-  public handleBlur(): void {}
-  public handleFocus(): void {}
-  public handleCursorMove(): void {}
-  public handleGridChanged(startRow: number, endRow: number): void {}
-
-  public handleSelectionChanged(start: [number, number] | undefined, end: [number, number] | undefined, columnSelectMode: boolean = false): void {
-    this._selectionModel.update((this._terminal as any)._core, start, end, columnSelectMode);
-  }
-
-  protected _setTransparency(alpha: boolean): void {
-    // Do nothing when alpha doesn't change
-    if (alpha === this._alpha) {
-      return;
-    }
-
-    // Create new canvas and replace old one
-    const oldCanvas = this._canvas;
-    this._alpha = alpha;
-    // Cloning preserves properties
-    this._canvas = this._canvas.cloneNode() as HTMLCanvasElement;
-    this._initCanvas();
-    this._container.replaceChild(this._canvas, oldCanvas);
-
-    // Regenerate char atlas and force a full redraw
-    this._refreshCharAtlas(this._themeService.colors);
-    this.handleGridChanged(0, this._bufferService.rows - 1);
-  }
-
-  /**
-   * Refreshes the char atlas, aquiring a new one if necessary.
-   * @param colorSet The color set to use for the char atlas.
-   */
-  private _refreshCharAtlas(colorSet: ReadonlyColorSet): void {
-    if (this._deviceCharWidth <= 0 && this._deviceCharHeight <= 0) {
-      return;
-    }
-    this._charAtlas = acquireTextureAtlas(this._terminal, this._optionsService.rawOptions, colorSet, this._deviceCellWidth, this._deviceCellHeight, this._deviceCharWidth, this._deviceCharHeight, this._coreBrowserService.dpr);
-    this._charAtlasDisposable.value = forwardEvent(this._charAtlas.onAddTextureAtlasCanvas, this._onAddTextureAtlasCanvas);
-    this._charAtlas.warmUp();
-    for (let i = 0; i < this._charAtlas.pages.length; i++) {
-      this._bitmapGenerator[i] = new BitmapGenerator(this._charAtlas.pages[i].canvas);
-    }
-  }
-
-  public resize(dim: IRenderDimensions): void {
-    this._deviceCellWidth = dim.device.cell.width;
-    this._deviceCellHeight = dim.device.cell.height;
-    this._deviceCharWidth = dim.device.char.width;
-    this._deviceCharHeight = dim.device.char.height;
-    this._deviceCharLeft = dim.device.char.left;
-    this._deviceCharTop = dim.device.char.top;
-    this._canvas.width = dim.device.canvas.width;
-    this._canvas.height = dim.device.canvas.height;
-    this._canvas.style.width = `${dim.css.canvas.width}px`;
-    this._canvas.style.height = `${dim.css.canvas.height}px`;
-
-    // Draw the background if this is an opaque layer
-    if (!this._alpha) {
-      this._clearAll();
-    }
-
-    this._refreshCharAtlas(this._themeService.colors);
-  }
-
-  public abstract reset(): void;
-
-  public clearTextureAtlas(): void {
-    this._charAtlas?.clearTexture();
-  }
-
-  /**
-   * Fills 1+ cells completely. This uses the existing fillStyle on the context.
-   * @param x The column to start at.
-   * @param y The row to start at
-   * @param width The number of columns to fill.
-   * @param height The number of rows to fill.
-   */
-  protected _fillCells(x: number, y: number, width: number, height: number): void {
-    this._ctx.fillRect(
-      x * this._deviceCellWidth,
-      y * this._deviceCellHeight,
-      width * this._deviceCellWidth,
-      height * this._deviceCellHeight);
-  }
-
-  /**
-   * Fills a 1px line (2px on HDPI) at the middle of the cell. This uses the
-   * existing fillStyle on the context.
-   * @param x The column to fill.
-   * @param y The row to fill.
-   */
-  protected _fillMiddleLineAtCells(x: number, y: number, width: number = 1): void {
-    const cellOffset = Math.ceil(this._deviceCellHeight * 0.5);
-    this._ctx.fillRect(
-      x * this._deviceCellWidth,
-      (y + 1) * this._deviceCellHeight - cellOffset - this._coreBrowserService.dpr,
-      width * this._deviceCellWidth,
-      this._coreBrowserService.dpr);
-  }
-
-  /**
-   * Fills a 1px line (2px on HDPI) at the bottom of the cell. This uses the
-   * existing fillStyle on the context.
-   * @param x The column to fill.
-   * @param y The row to fill.
-   */
-  protected _fillBottomLineAtCells(x: number, y: number, width: number = 1, pixelOffset: number = 0): void {
-    this._ctx.fillRect(
-      x * this._deviceCellWidth,
-      (y + 1) * this._deviceCellHeight + pixelOffset - this._coreBrowserService.dpr - 1 /* Ensure it's drawn within the cell */,
-      width * this._deviceCellWidth,
-      this._coreBrowserService.dpr);
-  }
-
-  protected _curlyUnderlineAtCell(x: number, y: number, width: number = 1): void {
-    this._ctx.save();
-    this._ctx.beginPath();
-    this._ctx.strokeStyle = this._ctx.fillStyle;
-    const lineWidth = this._coreBrowserService.dpr;
-    this._ctx.lineWidth = lineWidth;
-    for (let xOffset = 0; xOffset < width; xOffset++) {
-      const xLeft = (x + xOffset) * this._deviceCellWidth;
-      const xMid = (x + xOffset + 0.5) * this._deviceCellWidth;
-      const xRight = (x + xOffset + 1) * this._deviceCellWidth;
-      const yMid = (y + 1) * this._deviceCellHeight - lineWidth - 1;
-      const yMidBot = yMid - lineWidth;
-      const yMidTop = yMid + lineWidth;
-      this._ctx.moveTo(xLeft, yMid);
-      this._ctx.bezierCurveTo(
-        xLeft, yMidBot,
-        xMid, yMidBot,
-        xMid, yMid
-      );
-      this._ctx.bezierCurveTo(
-        xMid, yMidTop,
-        xRight, yMidTop,
-        xRight, yMid
-      );
-    }
-    this._ctx.stroke();
-    this._ctx.restore();
-  }
-
-  protected _dottedUnderlineAtCell(x: number, y: number, width: number = 1): void {
-    this._ctx.save();
-    this._ctx.beginPath();
-    this._ctx.strokeStyle = this._ctx.fillStyle;
-    const lineWidth = this._coreBrowserService.dpr;
-    this._ctx.lineWidth = lineWidth;
-    this._ctx.setLineDash([lineWidth * 2, lineWidth]);
-    const xLeft = x * this._deviceCellWidth;
-    const yMid = (y + 1) * this._deviceCellHeight - lineWidth - 1;
-    this._ctx.moveTo(xLeft, yMid);
-    for (let xOffset = 0; xOffset < width; xOffset++) {
-      // const xLeft = x * this._deviceCellWidth;
-      const xRight = (x + width + xOffset) * this._deviceCellWidth;
-      this._ctx.lineTo(xRight, yMid);
-    }
-    this._ctx.stroke();
-    this._ctx.closePath();
-    this._ctx.restore();
-  }
-
-  protected _dashedUnderlineAtCell(x: number, y: number, width: number = 1): void {
-    this._ctx.save();
-    this._ctx.beginPath();
-    this._ctx.strokeStyle = this._ctx.fillStyle;
-    const lineWidth = this._coreBrowserService.dpr;
-    this._ctx.lineWidth = lineWidth;
-    this._ctx.setLineDash([lineWidth * 4, lineWidth * 3]);
-    const xLeft = x * this._deviceCellWidth;
-    const xRight = (x + width) * this._deviceCellWidth;
-    const yMid = (y + 1) * this._deviceCellHeight - lineWidth - 1;
-    this._ctx.moveTo(xLeft, yMid);
-    this._ctx.lineTo(xRight, yMid);
-    this._ctx.stroke();
-    this._ctx.closePath();
-    this._ctx.restore();
-  }
-
-  /**
-   * Fills a 1px line (2px on HDPI) at the left of the cell. This uses the
-   * existing fillStyle on the context.
-   * @param x The column to fill.
-   * @param y The row to fill.
-   */
-  protected _fillLeftLineAtCell(x: number, y: number, width: number): void {
-    this._ctx.fillRect(
-      x * this._deviceCellWidth,
-      y * this._deviceCellHeight,
-      this._coreBrowserService.dpr * width,
-      this._deviceCellHeight);
-  }
-
-  /**
-   * Strokes a 1px rectangle (2px on HDPI) around a cell. This uses the existing
-   * strokeStyle on the context.
-   * @param x The column to fill.
-   * @param y The row to fill.
-   */
-  protected _strokeRectAtCell(x: number, y: number, width: number, height: number): void {
-    const lineWidth = this._coreBrowserService.dpr;
-    this._ctx.lineWidth = lineWidth;
-    this._ctx.strokeRect(
-      x * this._deviceCellWidth + lineWidth / 2,
-      y * this._deviceCellHeight + (lineWidth / 2),
-      width * this._deviceCellWidth - lineWidth,
-      (height * this._deviceCellHeight) - lineWidth);
-  }
-
-  /**
-   * Clears the entire canvas.
-   */
-  protected _clearAll(): void {
-    if (this._alpha) {
-      this._ctx.clearRect(0, 0, this._canvas.width, this._canvas.height);
-    } else {
-      this._ctx.fillStyle = this._themeService.colors.background.css;
-      this._ctx.fillRect(0, 0, this._canvas.width, this._canvas.height);
-    }
-  }
-
-  /**
-   * Clears 1+ cells completely.
-   * @param x The column to start at.
-   * @param y The row to start at.
-   * @param width The number of columns to clear.
-   * @param height The number of rows to clear.
-   */
-  protected _clearCells(x: number, y: number, width: number, height: number): void {
-    if (this._alpha) {
-      this._ctx.clearRect(
-        x * this._deviceCellWidth,
-        y * this._deviceCellHeight,
-        width * this._deviceCellWidth,
-        height * this._deviceCellHeight);
-    } else {
-      this._ctx.fillStyle = this._themeService.colors.background.css;
-      this._ctx.fillRect(
-        x * this._deviceCellWidth,
-        y * this._deviceCellHeight,
-        width * this._deviceCellWidth,
-        height * this._deviceCellHeight);
-    }
-  }
-
-  /**
-   * Draws a truecolor character at the cell. The character will be clipped to
-   * ensure that it fits with the cell, including the cell to the right if it's
-   * a wide character. This uses the existing fillStyle on the context.
-   * @param cell The cell data for the character to draw.
-   * @param x The column to draw at.
-   * @param y The row to draw at.
-   */
-  protected _fillCharTrueColor(cell: CellData, x: number, y: number): void {
-    this._ctx.font = this._getFont(false, false);
-    this._ctx.textBaseline = TEXT_BASELINE;
-    this._clipRow(y);
-
-    // Draw custom characters if applicable
-    let drawSuccess = false;
-    if (this._optionsService.rawOptions.customGlyphs !== false) {
-      drawSuccess = tryDrawCustomChar(this._ctx, cell.getChars(), x * this._deviceCellWidth, y * this._deviceCellHeight, this._deviceCellWidth, this._deviceCellHeight, this._optionsService.rawOptions.fontSize, this._coreBrowserService.dpr);
-    }
-
-    // Draw the character
-    if (!drawSuccess) {
-      this._ctx.fillText(
-        cell.getChars(),
-        x * this._deviceCellWidth + this._deviceCharLeft,
-        y * this._deviceCellHeight + this._deviceCharTop + this._deviceCharHeight);
-    }
-  }
-
-  /**
-   * Draws one or more characters at a cell. If possible this will draw using
-   * the character atlas to reduce draw time.
-   */
-  protected _drawChars(cell: ICellData, x: number, y: number): void {
-    const chars = cell.getChars();
-    const code = cell.getCode();
-    const width = cell.getWidth();
-    this._cellColorResolver.resolve(cell, x, this._bufferService.buffer.ydisp + y, this._deviceCellWidth);
-
-    if (!this._charAtlas) {
-      return;
-    }
-
-    let glyph: IRasterizedGlyph;
-    if (chars && chars.length > 1) {
-      glyph = this._charAtlas.getRasterizedGlyphCombinedChar(chars, this._cellColorResolver.result.bg, this._cellColorResolver.result.fg, this._cellColorResolver.result.ext, true);
-    } else {
-      glyph = this._charAtlas.getRasterizedGlyph(cell.getCode() || WHITESPACE_CELL_CODE, this._cellColorResolver.result.bg, this._cellColorResolver.result.fg, this._cellColorResolver.result.ext, true);
-    }
-    if (!glyph.size.x || !glyph.size.y) {
-      return;
-    }
-    this._ctx.save();
-    this._clipRow(y);
-
-    // Draw the image, use the bitmap if it's available
-
-    // HACK: If the canvas doesn't match, delete the generator. It's not clear how this happens but
-    // something is wrong with either the lifecycle of _bitmapGenerator or the page canvases are
-    // swapped out unexpectedly
-    if (this._bitmapGenerator[glyph.texturePage] && this._charAtlas.pages[glyph.texturePage].canvas !== this._bitmapGenerator[glyph.texturePage]!.canvas) {
-      this._bitmapGenerator[glyph.texturePage]?.bitmap?.close();
-      delete this._bitmapGenerator[glyph.texturePage];
-    }
-
-    if (this._charAtlas.pages[glyph.texturePage].version !== this._bitmapGenerator[glyph.texturePage]?.version) {
-      if (!this._bitmapGenerator[glyph.texturePage]) {
-        this._bitmapGenerator[glyph.texturePage] = new BitmapGenerator(this._charAtlas.pages[glyph.texturePage].canvas);
-      }
-      this._bitmapGenerator[glyph.texturePage]!.refresh();
-      this._bitmapGenerator[glyph.texturePage]!.version = this._charAtlas.pages[glyph.texturePage].version;
-    }
-
-    // Reduce scale horizontally for wide glyphs printed in cells that would overlap with the
-    // following cell (ie. the width is not 2).
-    let renderWidth = glyph.size.x;
-    if (this._optionsService.rawOptions.rescaleOverlappingGlyphs) {
-      if (allowRescaling(code, width, glyph.size.x, this._deviceCellWidth)) {
-        renderWidth = this._deviceCellWidth - 1; // - 1 to improve readability
-      }
-    }
-
-    this._ctx.drawImage(
-      this._bitmapGenerator[glyph.texturePage]?.bitmap || this._charAtlas!.pages[glyph.texturePage].canvas,
-      glyph.texturePosition.x,
-      glyph.texturePosition.y,
-      glyph.size.x,
-      glyph.size.y,
-      x * this._deviceCellWidth + this._deviceCharLeft - glyph.offset.x,
-      y * this._deviceCellHeight + this._deviceCharTop - glyph.offset.y,
-      renderWidth,
-      glyph.size.y
-    );
-    this._ctx.restore();
-  }
-
-  /**
-   * Clips a row to ensure no pixels will be drawn outside the cells in the row.
-   * @param y The row to clip.
-   */
-  private _clipRow(y: number): void {
-    this._ctx.beginPath();
-    this._ctx.rect(
-      0,
-      y * this._deviceCellHeight,
-      this._bufferService.cols * this._deviceCellWidth,
-      this._deviceCellHeight);
-    this._ctx.clip();
-  }
-
-  /**
-   * Gets the current font.
-   * @param isBold If we should use the bold fontWeight.
-   */
-  protected _getFont(isBold: boolean, isItalic: boolean): string {
-    const fontWeight = isBold ? this._optionsService.rawOptions.fontWeightBold : this._optionsService.rawOptions.fontWeight;
-    const fontStyle = isItalic ? 'italic' : '';
-
-    return `${fontStyle} ${fontWeight} ${this._optionsService.rawOptions.fontSize * this._coreBrowserService.dpr}px ${this._optionsService.rawOptions.fontFamily}`;
-  }
-}
-
-/**
- * The number of milliseconds to wait before generating the ImageBitmap, this is to debounce/batch
- * the operation as window.createImageBitmap is asynchronous.
- */
-const GLYPH_BITMAP_COMMIT_DELAY = 100;
-
-const enum BitmapGeneratorState {
-  IDLE = 0,
-  GENERATING = 1,
-  GENERATING_INVALID = 2
-}
-
-class BitmapGenerator {
-  private _state: BitmapGeneratorState = BitmapGeneratorState.IDLE;
-  private _commitTimeout: number | undefined = undefined;
-  private _bitmap: ImageBitmap | undefined = undefined;
-  public get bitmap(): ImageBitmap | undefined { return this._bitmap; }
-  public version: number = -1;
-
-  constructor(public readonly canvas: HTMLCanvasElement) {
-  }
-
-  public refresh(): void {
-    // Clear the bitmap immediately as it's stale
-    this._bitmap?.close();
-    this._bitmap = undefined;
-    // Disable ImageBitmaps on Safari because of https://bugs.webkit.org/show_bug.cgi?id=149990
-    if (isSafari) {
-      return;
-    }
-    if (this._commitTimeout === undefined) {
-      this._commitTimeout = window.setTimeout(() => this._generate(), GLYPH_BITMAP_COMMIT_DELAY);
-    }
-    if (this._state === BitmapGeneratorState.GENERATING) {
-      this._state = BitmapGeneratorState.GENERATING_INVALID;
-    }
-  }
-
-  private _generate(): void {
-    if (this._state === BitmapGeneratorState.IDLE) {
-      this._bitmap?.close();
-      this._bitmap = undefined;
-      this._state = BitmapGeneratorState.GENERATING;
-      window.createImageBitmap(this.canvas).then(bitmap => {
-        if (this._state === BitmapGeneratorState.GENERATING_INVALID) {
-          this.refresh();
-        } else {
-          this._bitmap = bitmap;
-        }
-        this._state = BitmapGeneratorState.IDLE;
-      });
-      if (this._commitTimeout) {
-        this._commitTimeout = undefined;
-      }
-    }
-  }
-}

addons/addon-canvas/src/CanvasAddon.ts

@@ -1,73 +0,0 @@
-/**
- * Copyright (c) 2022 The xterm.js authors. All rights reserved.
- * @license MIT
- */
-
-import type { ITerminalAddon, Terminal } from '@xterm/xterm';
-import type { CanvasAddon as ICanvasApi } from '@xterm/addon-canvas';
-import { ICharacterJoinerService, ICharSizeService, ICoreBrowserService, IRenderService, IThemeService } from 'browser/services/Services';
-import { ITerminal } from 'browser/Types';
-import { EventEmitter, forwardEvent } from 'common/EventEmitter';
-import { Disposable, toDisposable } from 'common/Lifecycle';
-import { setTraceLogger } from 'common/services/LogService';
-import { IBufferService, IDecorationService, ILogService } from 'common/services/Services';
-import { CanvasRenderer } from './CanvasRenderer';
-
-export class CanvasAddon extends Disposable implements ITerminalAddon , ICanvasApi {
-  private _terminal?: Terminal;
-  private _renderer?: CanvasRenderer;
-
-  private readonly _onChangeTextureAtlas = this.register(new EventEmitter<HTMLCanvasElement>());
-  public readonly onChangeTextureAtlas = this._onChangeTextureAtlas.event;
-  private readonly _onAddTextureAtlasCanvas = this.register(new EventEmitter<HTMLCanvasElement>());
-  public readonly onAddTextureAtlasCanvas = this._onAddTextureAtlasCanvas.event;
-
-  public get textureAtlas(): HTMLCanvasElement | undefined {
-    return this._renderer?.textureAtlas;
-  }
-
-  public activate(terminal: Terminal): void {
-    const core = (terminal as any)._core as ITerminal;
-    if (!terminal.element) {
-      this.register(core.onWillOpen(() => this.activate(terminal)));
-      return;
-    }
-
-    this._terminal = terminal;
-    const coreService = core.coreService;
-    const optionsService = core.optionsService;
-    const screenElement = core.screenElement!;
-    const linkifier = core.linkifier!;
-
-    const unsafeCore = core as any;
-    const bufferService: IBufferService = unsafeCore._bufferService;
-    const renderService: IRenderService = unsafeCore._renderService;
-    const characterJoinerService: ICharacterJoinerService = unsafeCore._characterJoinerService;
-    const charSizeService: ICharSizeService = unsafeCore._charSizeService;
-    const coreBrowserService: ICoreBrowserService = unsafeCore._coreBrowserService;
-    const decorationService: IDecorationService = unsafeCore._decorationService;
-    const logService: ILogService = unsafeCore._logService;
-    const themeService: IThemeService = unsafeCore._themeService;
-
-    // Set trace logger just in case it hasn't been yet which could happen when the addon is
-    // bundled separately to the core module
-    setTraceLogger(logService);
-
-    this._renderer = new CanvasRenderer(terminal, screenElement, linkifier, bufferService, charSizeService, optionsService, characterJoinerService, coreService, coreBrowserService, decorationService, themeService);
-    this.register(forwardEvent(this._renderer.onChangeTextureAtlas, this._onChangeTextureAtlas));
-    this.register(forwardEvent(this._renderer.onAddTextureAtlasCanvas, this._onAddTextureAtlasCanvas));
-    renderService.setRenderer(this._renderer);
-    renderService.handleResize(bufferService.cols, bufferService.rows);
-
-    this.register(toDisposable(() => {
-      renderService.setRenderer((this._terminal as any)._core._createRenderer());
-      renderService.handleResize(terminal.cols, terminal.rows);
-      this._renderer?.dispose();
-      this._renderer = undefined;
-    }));
-  }
-
-  public clearTextureAtlas(): void {
-    this._renderer?.clearTextureAtlas();
-  }
-}

addons/addon-canvas/src/CanvasRenderer.ts

@@ -1,191 +0,0 @@
-/**
- * Copyright (c) 2017 The xterm.js authors. All rights reserved.
- * @license MIT
- */
-
-import { ILinkifier2 } from 'browser/Types';
-import { removeTerminalFromCache } from 'browser/renderer/shared/CharAtlasCache';
-import { observeDevicePixelDimensions } from 'browser/renderer/shared/DevicePixelObserver';
-import { createRenderDimensions } from 'browser/renderer/shared/RendererUtils';
-import { IRenderDimensions, IRenderer, IRequestRedrawEvent } from 'browser/renderer/shared/Types';
-import { ICharSizeService, ICharacterJoinerService, ICoreBrowserService, IThemeService } from 'browser/services/Services';
-import { EventEmitter, forwardEvent } from 'common/EventEmitter';
-import { Disposable, MutableDisposable, toDisposable } from 'common/Lifecycle';
-import { IBufferService, ICoreService, IDecorationService, IOptionsService } from 'common/services/Services';
-import { Terminal } from '@xterm/xterm';
-import { CursorRenderLayer } from './CursorRenderLayer';
-import { LinkRenderLayer } from './LinkRenderLayer';
-import { SelectionRenderLayer } from './SelectionRenderLayer';
-import { TextRenderLayer } from './TextRenderLayer';
-import { IRenderLayer } from './Types';
-
-export class CanvasRenderer extends Disposable implements IRenderer {
-  private _renderLayers: IRenderLayer[];
-  private _devicePixelRatio: number;
-  private _observerDisposable = this.register(new MutableDisposable());
-
-  public dimensions: IRenderDimensions;
-
-  private readonly _onRequestRedraw = this.register(new EventEmitter<IRequestRedrawEvent>());
-  public readonly onRequestRedraw = this._onRequestRedraw.event;
-  private readonly _onChangeTextureAtlas = this.register(new EventEmitter<HTMLCanvasElement>());
-  public readonly onChangeTextureAtlas = this._onChangeTextureAtlas.event;
-  private readonly _onAddTextureAtlasCanvas = this.register(new EventEmitter<HTMLCanvasElement>());
-  public readonly onAddTextureAtlasCanvas = this._onAddTextureAtlasCanvas.event;
-
-  constructor(
-    private readonly _terminal: Terminal,
-    private readonly _screenElement: HTMLElement,
-    linkifier2: ILinkifier2,
-    private readonly _bufferService: IBufferService,
-    private readonly _charSizeService: ICharSizeService,
-    private readonly _optionsService: IOptionsService,
-    characterJoinerService: ICharacterJoinerService,
-    coreService: ICoreService,
-    private readonly _coreBrowserService: ICoreBrowserService,
-    decorationService: IDecorationService,
-    private readonly _themeService: IThemeService
-  ) {
-    super();
-    const allowTransparency = this._optionsService.rawOptions.allowTransparency;
-    this._renderLayers = [
-      new TextRenderLayer(this._terminal, this._screenElement, 0, allowTransparency, this._bufferService, this._optionsService, characterJoinerService, decorationService, this._coreBrowserService, _themeService),
-      new SelectionRenderLayer(this._terminal, this._screenElement, 1, this._bufferService, this._coreBrowserService, decorationService, this._optionsService, _themeService),
-      new LinkRenderLayer(this._terminal, this._screenElement, 2, linkifier2, this._bufferService, this._optionsService, decorationService, this._coreBrowserService, _themeService),
-      new CursorRenderLayer(this._terminal, this._screenElement, 3, this._onRequestRedraw, this._bufferService, this._optionsService, coreService, this._coreBrowserService, decorationService, _themeService)
-    ];
-    for (const layer of this._renderLayers) {
-      forwardEvent(layer.onAddTextureAtlasCanvas, this._onAddTextureAtlasCanvas);
-    }
-    this.dimensions = createRenderDimensions();
-    this._devicePixelRatio = this._coreBrowserService.dpr;
-    this._updateDimensions();
-
-    this._observerDisposable.value = observeDevicePixelDimensions(this._renderLayers[0].canvas, this._coreBrowserService.window, (w, h) => this._setCanvasDevicePixelDimensions(w, h));
-    this.register(this._coreBrowserService.onWindowChange(w => {
-      this._observerDisposable.value = observeDevicePixelDimensions(this._renderLayers[0].canvas, w, (w, h) => this._setCanvasDevicePixelDimensions(w, h));
-    }));
-
-    this.register(toDisposable(() => {
-      for (const l of this._renderLayers) {
-        l.dispose();
-      }
-      removeTerminalFromCache(this._terminal);
-    }));
-  }
-
-  public get textureAtlas(): HTMLCanvasElement | undefined {
-    return this._renderLayers[0].cacheCanvas;
-  }
-
-  public handleDevicePixelRatioChange(): void {
-    // If the device pixel ratio changed, the char atlas needs to be regenerated
-    // and the terminal needs to refreshed
-    if (this._devicePixelRatio !== this._coreBrowserService.dpr) {
-      this._devicePixelRatio = this._coreBrowserService.dpr;
-      this.handleResize(this._bufferService.cols, this._bufferService.rows);
-    }
-  }
-
-  public handleResize(cols: number, rows: number): void {
-    // Update character and canvas dimensions
-    this._updateDimensions();
-
-    // Resize all render layers
-    for (const l of this._renderLayers) {
-      l.resize(this.dimensions);
-    }
-
-    // Resize the screen
-    this._screenElement.style.width = `${this.dimensions.css.canvas.width}px`;
-    this._screenElement.style.height = `${this.dimensions.css.canvas.height}px`;
-  }
-
-  public handleCharSizeChanged(): void {
-    this.handleResize(this._bufferService.cols, this._bufferService.rows);
-  }
-
-  public handleBlur(): void {
-    this._runOperation(l => l.handleBlur());
-  }
-
-  public handleFocus(): void {
-    this._runOperation(l => l.handleFocus());
-  }
-
-  public handleSelectionChanged(start: [number, number] | undefined, end: [number, number] | undefined, columnSelectMode: boolean = false): void {
-    this._runOperation(l => l.handleSelectionChanged(start, end, columnSelectMode));
-    // Selection foreground requires a full re-render
-    if (this._themeService.colors.selectionForeground) {
-      this._onRequestRedraw.fire({ start: 0, end: this._bufferService.rows - 1 });
-    }
-  }
-
-  public handleCursorMove(): void {
-    this._runOperation(l => l.handleCursorMove());
-  }
-
-  public clear(): void {
-    this._runOperation(l => l.reset());
-  }
-
-  private _runOperation(operation: (layer: IRenderLayer) => void): void {
-    for (const l of this._renderLayers) {
-      operation(l);
-    }
-  }
-
-  /**
-   * Performs the refresh loop callback, calling refresh only if a refresh is
-   * necessary before queueing up the next one.
-   */
-  public renderRows(start: number, end: number): void {
-    for (const l of this._renderLayers) {
-      l.handleGridChanged(start, end);
-    }
-  }
-
-  public clearTextureAtlas(): void {
-    for (const layer of this._renderLayers) {
-      layer.clearTextureAtlas();
-    }
-  }
-
-  /**
-   * Recalculates the character and canvas dimensions.
-   */
-  private _updateDimensions(): void {
-    if (!this._charSizeService.hasValidSize) {
-      return;
-    }
-
-    // See the WebGL renderer for an explanation of this section.
-    const dpr = this._coreBrowserService.dpr;
-    this.dimensions.device.char.width = Math.floor(this._charSizeService.width * dpr);
-    this.dimensions.device.char.height = Math.ceil(this._charSizeService.height * dpr);
-    this.dimensions.device.cell.height = Math.floor(this.dimensions.device.char.height * this._optionsService.rawOptions.lineHeight);
-    this.dimensions.device.char.top = this._optionsService.rawOptions.lineHeight === 1 ? 0 : Math.round((this.dimensions.device.cell.height - this.dimensions.device.char.height) / 2);
-    this.dimensions.device.cell.width = this.dimensions.device.char.width + Math.round(this._optionsService.rawOptions.letterSpacing);
-    this.dimensions.device.char.left = Math.floor(this._optionsService.rawOptions.letterSpacing / 2);
-    this.dimensions.device.canvas.height = this._bufferService.rows * this.dimensions.device.cell.height;
-    this.dimensions.device.canvas.width = this._bufferService.cols * this.dimensions.device.cell.width;
-    this.dimensions.css.canvas.height = Math.round(this.dimensions.device.canvas.height / dpr);
-    this.dimensions.css.canvas.width = Math.round(this.dimensions.device.canvas.width / dpr);
-    this.dimensions.css.cell.height = this.dimensions.css.canvas.height / this._bufferService.rows;
-    this.dimensions.css.cell.width = this.dimensions.css.canvas.width / this._bufferService.cols;
-  }
-
-  private _setCanvasDevicePixelDimensions(width: number, height: number): void {
-    this.dimensions.device.canvas.height = height;
-    this.dimensions.device.canvas.width = width;
-    // Resize all render layers
-    for (const l of this._renderLayers) {
-      l.resize(this.dimensions);
-    }
-    this._requestRedrawViewport();
-  }
-
-  private _requestRedrawViewport(): void {
-    this._onRequestRedraw.fire({ start: 0, end: this._bufferService.rows - 1 });
-  }
-}

addons/addon-canvas/src/CursorRenderLayer.ts

@@ -1,233 +0,0 @@
-/**
- * Copyright (c) 2017 The xterm.js authors. All rights reserved.
- * @license MIT
- */
-
-import { CursorBlinkStateManager } from 'browser/renderer/shared/CursorBlinkStateManager';
-import { IRenderDimensions, IRequestRedrawEvent } from 'browser/renderer/shared/Types';
-import { ICoreBrowserService, IThemeService } from 'browser/services/Services';
-import { IEventEmitter } from 'common/EventEmitter';
-import { MutableDisposable } from 'common/Lifecycle';
-import { isFirefox } from 'common/Platform';
-import { ICellData } from 'common/Types';
-import { CellData } from 'common/buffer/CellData';
-import { IBufferService, ICoreService, IDecorationService, IOptionsService } from 'common/services/Services';
-import { Terminal } from '@xterm/xterm';
-import { BaseRenderLayer } from './BaseRenderLayer';
-
-interface ICursorState {
-  x: number;
-  y: number;
-  isFocused: boolean;
-  style: string;
-  width: number;
-}
-
-export class CursorRenderLayer extends BaseRenderLayer {
-  private _state: ICursorState;
-  private _cursorRenderers: {[key: string]: (x: number, y: number, cell: ICellData) => void};
-  private _cursorBlinkStateManager: MutableDisposable<CursorBlinkStateManager> = this.register(new MutableDisposable());
-  private _cell: ICellData = new CellData();
-
-  constructor(
-    terminal: Terminal,
-    container: HTMLElement,
-    zIndex: number,
-    private readonly _onRequestRedraw: IEventEmitter<IRequestRedrawEvent>,
-    bufferService: IBufferService,
-    optionsService: IOptionsService,
-    private readonly _coreService: ICoreService,
-    coreBrowserService: ICoreBrowserService,
-    decorationService: IDecorationService,
-    themeService: IThemeService
-  ) {
-    super(terminal, container, 'cursor', zIndex, true, themeService, bufferService, optionsService, decorationService, coreBrowserService);
-    this._state = {
-      x: 0,
-      y: 0,
-      isFocused: false,
-      style: '',
-      width: 0
-    };
-    this._cursorRenderers = {
-      'bar': this._renderBarCursor.bind(this),
-      'block': this._renderBlockCursor.bind(this),
-      'underline': this._renderUnderlineCursor.bind(this),
-      'outline': this._renderOutlineCursor.bind(this)
-    };
-    this.register(optionsService.onOptionChange(() => this._handleOptionsChanged()));
-    this._handleOptionsChanged();
-  }
-
-  public resize(dim: IRenderDimensions): void {
-    super.resize(dim);
-    // Resizing the canvas discards the contents of the canvas so clear state
-    this._state = {
-      x: 0,
-      y: 0,
-      isFocused: false,
-      style: '',
-      width: 0
-    };
-  }
-
-  public reset(): void {
-    this._clearCursor();
-    this._cursorBlinkStateManager.value?.restartBlinkAnimation();
-    this._handleOptionsChanged();
-  }
-
-  public handleBlur(): void {
-    this._cursorBlinkStateManager.value?.pause();
-    this._onRequestRedraw.fire({ start: this._bufferService.buffer.y, end: this._bufferService.buffer.y });
-  }
-
-  public handleFocus(): void {
-    this._cursorBlinkStateManager.value?.resume();
-    this._onRequestRedraw.fire({ start: this._bufferService.buffer.y, end: this._bufferService.buffer.y });
-  }
-
-  private _handleOptionsChanged(): void {
-    if (this._optionsService.rawOptions.cursorBlink) {
-      if (!this._cursorBlinkStateManager.value) {
-        this._cursorBlinkStateManager.value = new CursorBlinkStateManager(() => this._render(true), this._coreBrowserService);
-      }
-    } else {
-      this._cursorBlinkStateManager.clear();
-    }
-    // Request a refresh from the terminal as management of rendering is being
-    // moved back to the terminal
-    this._onRequestRedraw.fire({ start: this._bufferService.buffer.y, end: this._bufferService.buffer.y });
-  }
-
-  public handleCursorMove(): void {
-    this._cursorBlinkStateManager.value?.restartBlinkAnimation();
-  }
-
-  public handleGridChanged(startRow: number, endRow: number): void {
-    if (!this._cursorBlinkStateManager.value || this._cursorBlinkStateManager.value.isPaused) {
-      this._render(false);
-    } else {
-      this._cursorBlinkStateManager.value.restartBlinkAnimation();
-    }
-  }
-
-  private _render(triggeredByAnimationFrame: boolean): void {
-    // Don't draw the cursor if it's hidden
-    if (!this._coreService.isCursorInitialized || this._coreService.isCursorHidden) {
-      this._clearCursor();
-      return;
-    }
-
-    const cursorY = this._bufferService.buffer.ybase + this._bufferService.buffer.y;
-    const viewportRelativeCursorY = cursorY - this._bufferService.buffer.ydisp;
-
-    // Don't draw the cursor if it's off-screen
-    if (viewportRelativeCursorY < 0 || viewportRelativeCursorY >= this._bufferService.rows) {
-      this._clearCursor();
-      return;
-    }
-
-    // in case cursor.x == cols adjust visual cursor to cols - 1
-    const cursorX = Math.min(this._bufferService.buffer.x, this._bufferService.cols - 1);
-    this._bufferService.buffer.lines.get(cursorY)!.loadCell(cursorX, this._cell);
-    if (this._cell.content === undefined) {
-      return;
-    }
-
-    if (!this._coreBrowserService.isFocused) {
-      this._clearCursor();
-      this._ctx.save();
-      this._ctx.fillStyle = this._themeService.colors.cursor.css;
-      const cursorStyle = this._optionsService.rawOptions.cursorStyle;
-      const cursorInactiveStyle = this._optionsService.rawOptions.cursorInactiveStyle;
-      if (cursorInactiveStyle && cursorInactiveStyle !== 'none') {
-        this._cursorRenderers[cursorInactiveStyle](cursorX, viewportRelativeCursorY, this._cell);
-      }
-      this._ctx.restore();
-      this._state.x = cursorX;
-      this._state.y = viewportRelativeCursorY;
-      this._state.isFocused = false;
-      this._state.style = cursorStyle;
-      this._state.width = this._cell.getWidth();
-      return;
-    }
-
-    // Don't draw the cursor if it's blinking
-    if (this._cursorBlinkStateManager.value && !this._cursorBlinkStateManager.value.isCursorVisible) {
-      this._clearCursor();
-      return;
-    }
-
-    if (this._state) {
-      // The cursor is already in the correct spot, don't redraw
-      if (this._state.x === cursorX &&
-          this._state.y === viewportRelativeCursorY &&
-          this._state.isFocused === this._coreBrowserService.isFocused &&
-          this._state.style === this._optionsService.rawOptions.cursorStyle &&
-          this._state.width === this._cell.getWidth()) {
-        return;
-      }
-      this._clearCursor();
-    }
-
-    this._ctx.save();
-    this._cursorRenderers[this._optionsService.rawOptions.cursorStyle || 'block'](cursorX, viewportRelativeCursorY, this._cell);
-    this._ctx.restore();
-
-    this._state.x = cursorX;
-    this._state.y = viewportRelativeCursorY;
-    this._state.isFocused = false;
-    this._state.style = this._optionsService.rawOptions.cursorStyle;
-    this._state.width = this._cell.getWidth();
-  }
-
-  private _clearCursor(): void {
-    if (this._state) {
-      // Avoid potential rounding errors when browser is Firefox (#4487) or device pixel ratio is
-      // less than 1
-      if (isFirefox || this._coreBrowserService.dpr < 1) {
-        this._clearAll();
-      } else {
-        this._clearCells(this._state.x, this._state.y, this._state.width, 1);
-      }
-      this._state = {
-        x: 0,
-        y: 0,
-        isFocused: false,
-        style: '',
-        width: 0
-      };
-    }
-  }
-
-  private _renderBarCursor(x: number, y: number, cell: ICellData): void {
-    this._ctx.save();
-    this._ctx.fillStyle = this._themeService.colors.cursor.css;
-    this._fillLeftLineAtCell(x, y, this._optionsService.rawOptions.cursorWidth);
-    this._ctx.restore();
-  }
-
-  private _renderBlockCursor(x: number, y: number, cell: ICellData): void {
-    this._ctx.save();
-    this._ctx.fillStyle = this._themeService.colors.cursor.css;
-    this._fillCells(x, y, cell.getWidth(), 1);
-    this._ctx.fillStyle = this._themeService.colors.cursorAccent.css;
-    this._fillCharTrueColor(cell, x, y);
-    this._ctx.restore();
-  }
-
-  private _renderUnderlineCursor(x: number, y: number, cell: ICellData): void {
-    this._ctx.save();
-    this._ctx.fillStyle = this._themeService.colors.cursor.css;
-    this._fillBottomLineAtCells(x, y);
-    this._ctx.restore();
-  }
-
-  private _renderOutlineCursor(x: number, y: number, cell: ICellData): void {
-    this._ctx.save();
-    this._ctx.strokeStyle = this._themeService.colors.cursor.css;
-    this._strokeRectAtCell(x, y, cell.getWidth(), 1);
-    this._ctx.restore();
-  }
-}

addons/addon-canvas/src/GridCache.test.ts

@@ -1,62 +0,0 @@
-/**
- * Copyright (c) 2017 The xterm.js authors. All rights reserved.
- * @license MIT
- */
-
-import { assert } from 'chai';
-import { GridCache } from './GridCache';
-
-describe('GridCache', () => {
-  let grid: GridCache<number>;
-
-  beforeEach(() => {
-    grid = new GridCache<number>();
-  });
-
-  describe('constructor', () => {
-    it('should create an empty cache', () => {
-      assert.equal(grid.cache.length, 0);
-    });
-  });
-
-  describe('resize', () => {
-    it('should fill all new elements with null', () => {
-      grid.resize(2, 2);
-      assert.equal(grid.cache.length, 2);
-      assert.equal(grid.cache[0].length, 2);
-      assert.equal(grid.cache[0][0], null);
-      assert.equal(grid.cache[0][1], null);
-      assert.equal(grid.cache[1].length, 2);
-      assert.equal(grid.cache[1][0], null);
-      assert.equal(grid.cache[1][1], null);
-      grid.resize(3, 2);
-      assert.equal(grid.cache.length, 3);
-      assert.equal(grid.cache[2][0], null);
-      assert.equal(grid.cache[2][1], null);
-    });
-
-    it('should remove rows/cols from the cache when reduced', () => {
-      grid.resize(2, 2);
-      grid.resize(1, 1);
-      assert.equal(grid.cache.length, 1);
-      assert.equal(grid.cache[0].length, 1);
-    });
-
-    it('should not touch existing cache entries if they fit in the new cache', () => {
-      grid.resize(1, 1);
-      assert.equal(grid.cache[0][0], null);
-      grid.cache[0][0] = 1;
-      grid.resize(2, 1);
-      assert.equal(grid.cache[0][0], 1);
-    });
-  });
-
-  describe('clear', () => {
-    it('should make all entries null', () => {
-      grid.resize(1, 1);
-      grid.cache[0][0] = 1;
-      grid.clear();
-      assert.equal(grid.cache[0][0], null);
-    });
-  });
-});

addons/addon-canvas/src/GridCache.ts

@@ -1,33 +0,0 @@
-/**
- * Copyright (c) 2017 The xterm.js authors. All rights reserved.
- * @license MIT
- */
-
-export class GridCache<T> {
-  public cache: (T | undefined)[][];
-
-  public constructor() {
-    this.cache = [];
-  }
-
-  public resize(width: number, height: number): void {
-    for (let x = 0; x < width; x++) {
-      if (this.cache.length <= x) {
-        this.cache.push([]);
-      }
-      for (let y = this.cache[x].length; y < height; y++) {
-        this.cache[x].push(undefined);
-      }
-      this.cache[x].length = height;
-    }
-    this.cache.length = width;
-  }
-
-  public clear(): void {
-    for (let x = 0; x < this.cache.length; x++) {
-      for (let y = 0; y < this.cache[x].length; y++) {
-        this.cache[x][y] = undefined;
-      }
-    }
-  }
-}

addons/addon-canvas/src/LinkRenderLayer.ts

@@ -1,84 +0,0 @@
-/**
- * Copyright (c) 2017 The xterm.js authors. All rights reserved.
- * @license MIT
- */
-
-import { ILinkifier2, ILinkifierEvent } from 'browser/Types';
-import { is256Color } from 'browser/renderer/shared/CharAtlasUtils';
-import { INVERTED_DEFAULT_COLOR } from 'browser/renderer/shared/Constants';
-import { IRenderDimensions } from 'browser/renderer/shared/Types';
-import { ICoreBrowserService, IThemeService } from 'browser/services/Services';
-import { IBufferService, IDecorationService, IOptionsService } from 'common/services/Services';
-import { Terminal } from '@xterm/xterm';
-import { BaseRenderLayer } from './BaseRenderLayer';
-
-export class LinkRenderLayer extends BaseRenderLayer {
-  private _state: ILinkifierEvent | undefined;
-
-  constructor(
-    terminal: Terminal,
-    container: HTMLElement,
-    zIndex: number,
-    linkifier2: ILinkifier2,
-    bufferService: IBufferService,
-    optionsService: IOptionsService,
-    decorationService: IDecorationService,
-    coreBrowserService: ICoreBrowserService,
-    themeService: IThemeService
-  ) {
-    super(terminal, container, 'link', zIndex, true, themeService, bufferService, optionsService, decorationService, coreBrowserService);
-
-    this.register(linkifier2.onShowLinkUnderline(e => this._handleShowLinkUnderline(e)));
-    this.register(linkifier2.onHideLinkUnderline(e => this._handleHideLinkUnderline(e)));
-  }
-
-  public resize(dim: IRenderDimensions): void {
-    super.resize(dim);
-    // Resizing the canvas discards the contents of the canvas so clear state
-    this._state = undefined;
-  }
-
-  public reset(): void {
-    this._clearCurrentLink();
-  }
-
-  private _clearCurrentLink(): void {
-    if (this._state) {
-      this._clearCells(this._state.x1, this._state.y1, this._state.cols - this._state.x1, 1);
-      const middleRowCount = this._state.y2 - this._state.y1 - 1;
-      if (middleRowCount > 0) {
-        this._clearCells(0, this._state.y1 + 1, this._state.cols, middleRowCount);
-      }
-      this._clearCells(0, this._state.y2, this._state.x2, 1);
-      this._state = undefined;
-    }
-  }
-
-  private _handleShowLinkUnderline(e: ILinkifierEvent): void {
-    if (e.fg === INVERTED_DEFAULT_COLOR) {
-      this._ctx.fillStyle = this._themeService.colors.background.css;
-    } else if (e.fg && is256Color(e.fg)) {
-      // 256 color support
-      this._ctx.fillStyle = this._themeService.colors.ansi[e.fg].css;
-    } else {
-      this._ctx.fillStyle = this._themeService.colors.foreground.css;
-    }
-
-    if (e.y1 === e.y2) {
-      // Single line link
-      this._fillBottomLineAtCells(e.x1, e.y1, e.x2 - e.x1);
-    } else {
-      // Multi-line link
-      this._fillBottomLineAtCells(e.x1, e.y1, e.cols - e.x1);
-      for (let y = e.y1 + 1; y < e.y2; y++) {
-        this._fillBottomLineAtCells(0, y, e.cols);
-      }
-      this._fillBottomLineAtCells(0, e.y2, e.x2);
-    }
-    this._state = e;
-  }
-
-  private _handleHideLinkUnderline(e: ILinkifierEvent): void {
-    this._clearCurrentLink();
-  }
-}

addons/addon-canvas/src/SelectionRenderLayer.ts

@@ -1,152 +0,0 @@
-/**
- * Copyright (c) 2017 The xterm.js authors. All rights reserved.
- * @license MIT
- */
-
-import { IRenderDimensions } from 'browser/renderer/shared/Types';
-import { BaseRenderLayer } from './BaseRenderLayer';
-import { IBufferService, IDecorationService, IOptionsService } from 'common/services/Services';
-import { ICoreBrowserService, IThemeService } from 'browser/services/Services';
-import { Terminal } from '@xterm/xterm';
-
-interface ISelectionState {
-  start?: [number, number];
-  end?: [number, number];
-  columnSelectMode?: boolean;
-  ydisp?: number;
-}
-
-export class SelectionRenderLayer extends BaseRenderLayer {
-  private _state!: ISelectionState;
-
-  constructor(
-    terminal: Terminal,
-    container: HTMLElement,
-    zIndex: number,
-    bufferService: IBufferService,
-    coreBrowserService: ICoreBrowserService,
-    decorationService: IDecorationService,
-    optionsService: IOptionsService,
-    themeService: IThemeService
-  ) {
-    super(terminal, container, 'selection', zIndex, true, themeService, bufferService, optionsService, decorationService, coreBrowserService);
-    this._clearState();
-  }
-
-  private _clearState(): void {
-    this._state = {
-      start: undefined,
-      end: undefined,
-      columnSelectMode: undefined,
-      ydisp: undefined
-    };
-  }
-
-  public resize(dim: IRenderDimensions): void {
-    super.resize(dim);
-    // On resize use the base render layer's cached selection values since resize clears _state
-    // inside reset.
-    if (this._selectionModel.selectionStart && this._selectionModel.selectionEnd) {
-      this._clearState();
-      this._redrawSelection(this._selectionModel.selectionStart, this._selectionModel.selectionEnd, this._selectionModel.columnSelectMode);
-    }
-  }
-
-  public reset(): void {
-    if (this._state.start && this._state.end) {
-      this._clearState();
-      this._clearAll();
-    }
-  }
-
-  public handleBlur(): void {
-    this.reset();
-    this._redrawSelection(this._selectionModel.selectionStart, this._selectionModel.selectionEnd, this._selectionModel.columnSelectMode);
-  }
-
-  public handleFocus(): void {
-    this.reset();
-    this._redrawSelection(this._selectionModel.selectionStart, this._selectionModel.selectionEnd, this._selectionModel.columnSelectMode);
-  }
-
-  public handleSelectionChanged(start: [number, number] | undefined, end: [number, number] | undefined, columnSelectMode: boolean): void {
-    super.handleSelectionChanged(start, end, columnSelectMode);
-    this._redrawSelection(start, end, columnSelectMode);
-  }
-
-  private _redrawSelection(start: [number, number] | undefined, end: [number, number] | undefined, columnSelectMode: boolean): void {
-    // Selection has not changed
-    if (!this._didStateChange(start, end, columnSelectMode, this._bufferService.buffer.ydisp)) {
-      return;
-    }
-
-    // Remove all selections
-    this._clearAll();
-
-    // Selection does not exist
-    if (!start || !end) {
-      this._clearState();
-      return;
-    }
-
-    // Translate from buffer position to viewport position
-    const viewportStartRow = start[1] - this._bufferService.buffer.ydisp;
-    const viewportEndRow = end[1] - this._bufferService.buffer.ydisp;
-    const viewportCappedStartRow = Math.max(viewportStartRow, 0);
-    const viewportCappedEndRow = Math.min(viewportEndRow, this._bufferService.rows - 1);
-
-    // No need to draw the selection
-    if (viewportCappedStartRow >= this._bufferService.rows || viewportCappedEndRow < 0) {
-      this._state.ydisp = this._bufferService.buffer.ydisp;
-      return;
-    }
-
-    this._ctx.fillStyle = (this._coreBrowserService.isFocused
-      ? this._themeService.colors.selectionBackgroundTransparent
-      : this._themeService.colors.selectionInactiveBackgroundTransparent).css;
-
-    if (columnSelectMode) {
-      const startCol = start[0];
-      const width = end[0] - startCol;
-      const height = viewportCappedEndRow - viewportCappedStartRow + 1;
-      this._fillCells(startCol, viewportCappedStartRow, width, height);
-    } else {
-      // Draw first row
-      const startCol = viewportStartRow === viewportCappedStartRow ? start[0] : 0;
-      const startRowEndCol = viewportCappedStartRow === viewportEndRow ? end[0] : this._bufferService.cols;
-      this._fillCells(startCol, viewportCappedStartRow, startRowEndCol - startCol, 1);
-
-      // Draw middle rows
-      const middleRowsCount = Math.max(viewportCappedEndRow - viewportCappedStartRow - 1, 0);
-      this._fillCells(0, viewportCappedStartRow + 1, this._bufferService.cols, middleRowsCount);
-
-      // Draw final row
-      if (viewportCappedStartRow !== viewportCappedEndRow) {
-        // Only draw viewportEndRow if it's not the same as viewportStartRow
-        const endCol = viewportEndRow === viewportCappedEndRow ? end[0] : this._bufferService.cols;
-        this._fillCells(0, viewportCappedEndRow, endCol, 1);
-      }
-    }
-
-    // Save state for next render
-    this._state.start = [start[0], start[1]];
-    this._state.end = [end[0], end[1]];
-    this._state.columnSelectMode = columnSelectMode;
-    this._state.ydisp = this._bufferService.buffer.ydisp;
-  }
-
-  private _didStateChange(start: [number, number] | undefined, end: [number, number] | undefined, columnSelectMode: boolean, ydisp: number): boolean {
-    return !this._areCoordinatesEqual(start, this._state.start) ||
-      !this._areCoordinatesEqual(end, this._state.end) ||
-      columnSelectMode !== this._state.columnSelectMode ||
-      ydisp !== this._state.ydisp;
-  }
-
-  private _areCoordinatesEqual(coord1: [number, number] | undefined, coord2: [number, number] | undefined): boolean {
-    if (!coord1 || !coord2) {
-      return false;
-    }
-
-    return coord1[0] === coord2[0] && coord1[1] === coord2[1];
-  }
-}

addons/addon-canvas/src/TextRenderLayer.ts

@@ -1,292 +0,0 @@
-/**
- * Copyright (c) 2017 The xterm.js authors. All rights reserved.
- * @license MIT
- */
-
-import { IRenderDimensions } from 'browser/renderer/shared/Types';
-import { JoinedCellData } from 'browser/services/CharacterJoinerService';
-import { ICharacterJoinerService, ICoreBrowserService, IThemeService } from 'browser/services/Services';
-import { CharData, ICellData } from 'common/Types';
-import { AttributeData } from 'common/buffer/AttributeData';
-import { CellData } from 'common/buffer/CellData';
-import { Content, NULL_CELL_CODE } from 'common/buffer/Constants';
-import { IBufferService, IDecorationService, IOptionsService } from 'common/services/Services';
-import { Terminal } from '@xterm/xterm';
-import { BaseRenderLayer } from './BaseRenderLayer';
-import { GridCache } from './GridCache';
-
-/**
- * This CharData looks like a null character, which will forc a clear and render
- * when the character changes (a regular space ' ' character may not as it's
- * drawn state is a cleared cell).
- */
-// const OVERLAP_OWNED_CHAR_DATA: CharData = [null, '', 0, -1];
-
-export class TextRenderLayer extends BaseRenderLayer {
-  private _state: GridCache<CharData>;
-  private _characterWidth: number = 0;
-  private _characterFont: string = '';
-  private _characterOverlapCache: { [key: string]: boolean } = {};
-  private _workCell = new CellData();
-
-  constructor(
-    terminal: Terminal,
-    container: HTMLElement,
-    zIndex: number,
-    alpha: boolean,
-    bufferService: IBufferService,
-    optionsService: IOptionsService,
-    private readonly _characterJoinerService: ICharacterJoinerService,
-    decorationService: IDecorationService,
-    coreBrowserService: ICoreBrowserService,
-    themeService: IThemeService
-  ) {
-    super(terminal, container, 'text', zIndex, alpha, themeService, bufferService, optionsService, decorationService, coreBrowserService);
-    this._state = new GridCache<CharData>();
-    this.register(optionsService.onSpecificOptionChange('allowTransparency', value => this._setTransparency(value)));
-  }
-
-  public resize(dim: IRenderDimensions): void {
-    super.resize(dim);
-
-    // Clear the character width cache if the font or width has changed
-    const terminalFont = this._getFont(false, false);
-    if (this._characterWidth !== dim.device.char.width || this._characterFont !== terminalFont) {
-      this._characterWidth = dim.device.char.width;
-      this._characterFont = terminalFont;
-      this._characterOverlapCache = {};
-    }
-    // Resizing the canvas discards the contents of the canvas so clear state
-    this._state.clear();
-    this._state.resize(this._bufferService.cols, this._bufferService.rows);
-  }
-
-  public reset(): void {
-    this._state.clear();
-    this._clearAll();
-  }
-
-  private _forEachCell(
-    firstRow: number,
-    lastRow: number,
-    callback: (
-      cell: ICellData,
-      x: number,
-      y: number
-    ) => void
-  ): void {
-    for (let y = firstRow; y <= lastRow; y++) {
-      const row = y + this._bufferService.buffer.ydisp;
-      const line = this._bufferService.buffer.lines.get(row);
-      const joinedRanges = this._characterJoinerService.getJoinedCharacters(row);
-      for (let x = 0; x < this._bufferService.cols; x++) {
-        line!.loadCell(x, this._workCell);
-        let cell = this._workCell;
-
-        // If true, indicates that the current character(s) to draw were joined.
-        let isJoined = false;
-        let lastCharX = x;
-
-        // The character to the left is a wide character, drawing is owned by
-        // the char at x-1
-        if (cell.getWidth() === 0) {
-          continue;
-        }
-
-        // exit early for NULL and SP
-        // NOTE: commented out due to #4120 (needs a more clever patch to keep things performant)
-        // const code = cell.getCode();
-        // if (code === 0 || code === 32) {
-        //  continue;
-        // }
-
-        // Process any joined character ranges as needed. Because of how the
-        // ranges are produced, we know that they are valid for the characters
-        // and attributes of our input.
-        if (joinedRanges.length > 0 && x === joinedRanges[0][0]) {
-          isJoined = true;
-          const range = joinedRanges.shift()!;
-
-          // We already know the exact start and end column of the joined range,
-          // so we get the string and width representing it directly
-          cell = new JoinedCellData(
-            this._workCell,
-            line!.translateToString(true, range[0], range[1]),
-            range[1] - range[0]
-          );
-
-          // Skip over the cells occupied by this range in the loop
-          lastCharX = range[1] - 1;
-        }
-
-        // If the character is an overlapping char and the character to the
-        // right is a space, take ownership of the cell to the right. We skip
-        // this check for joined characters because their rendering likely won't
-        // yield the same result as rendering the last character individually.
-        if (!isJoined && this._isOverlapping(cell)) {
-          // If the character is overlapping, we want to force a re-render on every
-          // frame. This is specifically to work around the case where two
-          // overlaping chars `a` and `b` are adjacent, the cursor is moved to b and a
-          // space is added. Without this, the first half of `b` would never
-          // get removed, and `a` would not re-render because it thinks it's
-          // already in the correct state.
-          // this._state.cache[x][y] = OVERLAP_OWNED_CHAR_DATA;
-          if (lastCharX < line!.length - 1 && line!.getCodePoint(lastCharX + 1) === NULL_CELL_CODE) {
-            // patch width to 2
-            cell.content &= ~Content.WIDTH_MASK;
-            cell.content |= 2 << Content.WIDTH_SHIFT;
-            // this._clearChar(x + 1, y);
-            // The overlapping char's char data will force a clear and render when the
-            // overlapping char is no longer to the left of the character and also when
-            // the space changes to another character.
-            // this._state.cache[x + 1][y] = OVERLAP_OWNED_CHAR_DATA;
-          }
-        }
-
-        callback(
-          cell,
-          x,
-          y
-        );
-
-        x = lastCharX;
-      }
-    }
-  }
-
-  /**
-   * Draws the background for a specified range of columns. Tries to batch adjacent cells of the
-   * same color together to reduce draw calls.
-   */
-  private _drawBackground(firstRow: number, lastRow: number): void {
-    const ctx = this._ctx;
-    const cols = this._bufferService.cols;
-    let startX: number = 0;
-    let startY: number = 0;
-    let prevFillStyle: string | null = null;
-
-    ctx.save();
-
-    this._forEachCell(firstRow, lastRow, (cell, x, y) => {
-      // libvte and xterm both draw the background (but not foreground) of invisible characters,
-      // so we should too.
-      let nextFillStyle = null; // null represents default background color
-
-      if (cell.isInverse()) {
-        if (cell.isFgDefault()) {
-          nextFillStyle = this._themeService.colors.foreground.css;
-        } else if (cell.isFgRGB()) {
-          nextFillStyle = `rgb(${AttributeData.toColorRGB(cell.getFgColor()).join(',')})`;
-        } else {
-          nextFillStyle = this._themeService.colors.ansi[cell.getFgColor()].css;
-        }
-      } else if (cell.isBgRGB()) {
-        nextFillStyle = `rgb(${AttributeData.toColorRGB(cell.getBgColor()).join(',')})`;
-      } else if (cell.isBgPalette()) {
-        nextFillStyle = this._themeService.colors.ansi[cell.getBgColor()].css;
-      }
-
-      // Get any decoration foreground/background overrides, this must be fetched before the early
-      // exist but applied after inverse
-      let isTop = false;
-      this._decorationService.forEachDecorationAtCell(x, this._bufferService.buffer.ydisp + y, undefined, d => {
-        if (d.options.layer !== 'top' && isTop) {
-          return;
-        }
-        if (d.backgroundColorRGB) {
-          nextFillStyle = d.backgroundColorRGB.css;
-        }
-        isTop = d.options.layer === 'top';
-      });
-
-      if (prevFillStyle === null) {
-        // This is either the first iteration, or the default background was set. Either way, we
-        // don't need to draw anything.
-        startX = x;
-        startY = y;
-      }
-
-      if (y !== startY) {
-        // our row changed, draw the previous row
-        ctx.fillStyle = prevFillStyle || '';
-        this._fillCells(startX, startY, cols - startX, 1);
-        startX = x;
-        startY = y;
-      } else if (prevFillStyle !== nextFillStyle) {
-        // our color changed, draw the previous characters in this row
-        ctx.fillStyle = prevFillStyle || '';
-        this._fillCells(startX, startY, x - startX, 1);
-        startX = x;
-        startY = y;
-      }
-
-      prevFillStyle = nextFillStyle;
-    });
-
-    // flush the last color we encountered
-    if (prevFillStyle !== null) {
-      ctx.fillStyle = prevFillStyle;
-      this._fillCells(startX, startY, cols - startX, 1);
-    }
-
-    ctx.restore();
-  }
-
-  private _drawForeground(firstRow: number, lastRow: number): void {
-    this._forEachCell(firstRow, lastRow, (cell, x, y) => this._drawChars(cell, x, y));
-  }
-
-  public handleGridChanged(firstRow: number, lastRow: number): void {
-    // Resize has not been called yet
-    if (this._state.cache.length === 0) {
-      return;
-    }
-
-    if (this._charAtlas) {
-      this._charAtlas.beginFrame();
-    }
-
-    this._clearCells(0, firstRow, this._bufferService.cols, lastRow - firstRow + 1);
-    this._drawBackground(firstRow, lastRow);
-    this._drawForeground(firstRow, lastRow);
-  }
-
-  /**
-   * Whether a character is overlapping to the next cell.
-   */
-  private _isOverlapping(cell: ICellData): boolean {
-    // Only single cell characters can be overlapping, rendering issues can
-    // occur without this check
-    if (cell.getWidth() !== 1) {
-      return false;
-    }
-
-    // We assume that any ascii character will not overlap
-    if (cell.getCode() < 256) {
-      return false;
-    }
-
-    const chars = cell.getChars();
-
-    // Deliver from cache if available
-    if (this._characterOverlapCache.hasOwnProperty(chars)) {
-      return this._characterOverlapCache[chars];
-    }
-
-    // Setup the font
-    this._ctx.save();
-    this._ctx.font = this._characterFont;
-
-    // Measure the width of the character, but Math.floor it
-    // because that is what the renderer does when it calculates
-    // the character dimensions we are comparing against
-    const overlaps = Math.floor(this._ctx.measureText(chars).width) > this._characterWidth;
-
-    // Restore the original context
-    this._ctx.restore();
-
-    // Cache and return
-    this._characterOverlapCache[chars] = overlaps;
-    return overlaps;
-  }
-}

addons/addon-canvas/src/Types.d.ts

@@ -1,86 +0,0 @@
-/**
- * Copyright (c) 2019 The xterm.js authors. All rights reserved.
- * @license MIT
- */
-
-import { IDisposable } from 'common/Types';
-import { IEvent } from 'common/EventEmitter';
-import { IRenderDimensions } from 'browser/renderer/shared/Types';
-
-export interface IRequestRedrawEvent {
-  start: number;
-  end: number;
-}
-
-/**
- * Note that IRenderer implementations should emit the refresh event after
- * rendering rows to the screen.
- */
-export interface IRenderer extends IDisposable {
-  readonly dimensions: IRenderDimensions;
-
-  /**
-   * Fires when the renderer is requesting to be redrawn on the next animation
-   * frame but is _not_ a result of content changing (eg. selection changes).
-   */
-  readonly onRequestRedraw: IEvent<IRequestRedrawEvent>;
-
-  handleDevicePixelRatioChange(): void;
-  handleResize(cols: number, rows: number): void;
-  handleCharSizeChanged(): void;
-  handleBlur(): void;
-  handleFocus(): void;
-  handleSelectionChanged(start: [number, number] | undefined, end: [number, number] | undefined, columnSelectMode: boolean): void;
-  handleCursorMove(): void;
-  handleOptionsChanged(): void;
-  clear(): void;
-  renderRows(start: number, end: number): void;
-  clearTextureAtlas?(): void;
-}
-
-export interface IRenderLayer extends IDisposable {
-  readonly canvas: HTMLCanvasElement;
-  readonly cacheCanvas: HTMLCanvasElement;
-
-  readonly onAddTextureAtlasCanvas: IEvent<HTMLCanvasElement>;
-  /**
-   * Called when the terminal loses focus.
-   */
-  handleBlur(): void;
-
-  /**
-   * Called when the terminal gets focus.
-   */
-  handleFocus(): void;
-
-  /**
-   * Called when the cursor is moved.
-   */
-  handleCursorMove(): void;
-
-  /**
-   * Called when the data in the grid has changed (or needs to be rendered
-   * again).
-   */
-  handleGridChanged(startRow: number, endRow: number): void;
-
-  /**
-   * Calls when the selection changes.
-   */
-  handleSelectionChanged(start: [number, number] | undefined, end: [number, number] | undefined, columnSelectMode: boolean): void;
-
-  /**
-   * Resize the render layer.
-   */
-  resize(dim: IRenderDimensions): void;
-
-  /**
-   * Clear the state of the render layer.
-   */
-  reset(): void;
-
-  /**
-   * Clears the texture atlas.
-   */
-  clearTextureAtlas(): void;
-}

addons/addon-canvas/test/CanvasRenderer.test.ts

@@ -1,37 +0,0 @@
-/**
- * Copyright (c) 2019 The xterm.js authors. All rights reserved.
- * @license MIT
- */
-
-import test from '@playwright/test';
-import { ISharedRendererTestContext, injectSharedRendererTests, injectSharedRendererTestsStandalone } from '../../../out-test/playwright/SharedRendererTests';
-import { ITestContext, createTestContext, openTerminal } from '../../../out-test/playwright/TestUtils';
-
-let ctx: ITestContext;
-const ctxWrapper: ISharedRendererTestContext = {
-  value: undefined,
-  skipCanvasExceptions: true
-} as any;
-test.beforeAll(async ({ browser }) => {
-  ctx = await createTestContext(browser);
-  await openTerminal(ctx);
-  ctxWrapper.value = ctx;
-  await ctx.page.evaluate(`
-    window.addon = new window.CanvasAddon(true);
-    window.term.loadAddon(window.addon);
-  `);
-});
-test.afterAll(async () => await ctx.page.close());
-
-test.describe('Canvas Renderer Integration Tests', () => {
-  // HACK: The tests fail for an unknown reason
-  test.skip(({ browserName }) => browserName === 'webkit');
-
-  injectSharedRendererTests(ctxWrapper);
-  injectSharedRendererTestsStandalone(ctxWrapper, async () => {
-    await ctx.page.evaluate(`
-      window.addon = new window.CanvasAddon(true);
-      window.term.loadAddon(window.addon);
-    `);
-  });
-});

addons/addon-canvas/typings/addon-canvas.d.ts

@@ -1,43 +0,0 @@
-/**
- * Copyright (c) 2017 The xterm.js authors. All rights reserved.
- * @license MIT
- */
-
-import { Terminal, ITerminalAddon, IEvent } from '@xterm/xterm';
-
-declare module '@xterm/addon-canvas' {
-  /**
-   * An xterm.js addon that provides search functionality.
-   */
-  export class CanvasAddon implements ITerminalAddon {
-    public textureAtlas?: HTMLCanvasElement;
-
-    /**
-     * An event that is fired when the texture atlas of the renderer changes.
-     */
-    public readonly onChangeTextureAtlas: IEvent<HTMLCanvasElement>;
-
-    /**
-     * An event that is fired when the a new page is added to the texture atlas.
-     */
-    public readonly onAddTextureAtlasCanvas: IEvent<HTMLCanvasElement>;
-
-    constructor();
-
-    /**
-     * Activates the addon.
-     * @param terminal The terminal the addon is being loaded in.
-     */
-    public activate(terminal: Terminal): void;
-
-    /**
-     * Disposes the addon.
-     */
-    public dispose(): void;
-
-    /**
-     * Clears the terminal's texture atlas and triggers a redraw.
-     */
-    public clearTextureAtlas(): void;
-  }
-}

addons/addon-clipboard/.gitignore

@@ -0,0 +1,2 @@
+lib
+node_modules

addons/addon-clipboard/.npmignore

@@ -8,6 +8,9 @@
 !lib/**/*.js
 !lib/**/*.js.map
 
+!lib/**/*.mjs
+!lib/**/*.mjs.map
+
 !lib/**/*.css
 
 # Whitelist - src/

addons/addon-clipboard/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2017, The xterm.js authors (https://github.com/xtermjs/xterm.js)
+Copyright (c) 2023, The xterm.js authors (https://github.com/xtermjs/xterm.js)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

addons/addon-clipboard/README.md

@@ -0,0 +1,53 @@
+## @xterm/addon-clipboard
+
+An addon for [xterm.js](https://github.com/xtermjs/xterm.js) that enables
+accessing the system clipboard. This addon requires xterm.js v4+.
+
+### Install
+
+```bash
+npm install --save @xterm/addon-clipboard
+```
+
+### Usage
+
+```ts
+import { Terminal } from 'xterm';
+import { ClipboardAddon } from '@xterm/addon-clipboard';
+
+const terminal = new Terminal();
+const clipboardAddon = new ClipboardAddon();
+terminal.loadAddon(clipboardAddon);
+```
+
+To use a custom clipboard provider
+
+```ts
+import { Terminal } from '@xterm/xterm';
+import { ClipboardAddon, IClipboardProvider, ClipboardSelectionType } from '@xterm/addon-clipboard';
+
+function b64Encode(data: string): string {
+  // Base64 encode impl
+}
+
+function b64Decode(data: string): string {
+  // Base64 decode impl
+}
+
+class MyCustomClipboardProvider implements IClipboardProvider {
+  private _data: string
+  public readText(selection: ClipboardSelectionType): Promise<string> {
+    return Promise.resolve(b64Encode(this._data));
+  }
+  public writeText(selection: ClipboardSelectionType, data: string): Promise<void> {
+    this._data = b64Decode(data);
+    return Promise.resolve();
+  }
+}
+
+const terminal = new Terminal();
+const clipboardAddon = new ClipboardAddon(new MyCustomClipboardProvider());
+terminal.loadAddon(clipboardAddon);
+```
+
+See the full [API](https://github.com/xtermjs/xterm.js/blob/master/addons/addon-clipboard/typings/addon-clipboard.d.ts) for more advanced usage.

addons/addon-clipboard/package.json

@@ -1,17 +1,17 @@
 {
-  "name": "@xterm/addon-canvas",
-  "version": "0.7.0",
+  "name": "@xterm/addon-clipboard",
+  "version": "0.2.0",
   "author": {
     "name": "The xterm.js authors",
     "url": "https://xtermjs.org/"
   },
-  "main": "lib/addon-canvas.js",
-  "types": "typings/addon-canvas.d.ts",
-  "repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/addon-canvas",
+  "main": "lib/addon-clipboard.js",
+  "module": "lib/addon-clipboard.mjs",
+  "types": "typings/addon-clipboard.d.ts",
+  "repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/addon-clipboard",
   "license": "MIT",
   "keywords": [
     "terminal",
-    "canvas",
     "xterm",
     "xterm.js"
   ],
@@ -20,9 +20,9 @@
     "prepackage": "npm run build",
     "package": "../../node_modules/.bin/webpack",
     "prepublishOnly": "npm run package",
-    "start-server-only": "node ../../demo/start-server-only"
+    "start": "node ../../demo/start"
   },
-  "peerDependencies": {
-    "@xterm/xterm": "^5.0.0"
+  "dependencies": {
+    "js-base64": "^3.7.5"
   }
 }

addons/addon-clipboard/src/ClipboardAddon.ts

@@ -0,0 +1,99 @@
+/**
+ * Copyright (c) 2023 The xterm.js authors. All rights reserved.
+ * @license MIT
+ */
+
+import type { IDisposable, ITerminalAddon, Terminal } from '@xterm/xterm';
+import { type IClipboardProvider, ClipboardSelectionType, type IBase64 } from '@xterm/addon-clipboard';
+import { Base64 as JSBase64 } from 'js-base64';
+
+export class ClipboardAddon implements ITerminalAddon {
+  private _terminal?: Terminal;
+  private _disposable?: IDisposable;
+
+  constructor(
+    private _base64: IBase64 = new Base64(),
+    private _provider: IClipboardProvider = new BrowserClipboardProvider()
+  ) {}
+
+  public activate(terminal: Terminal): void {
+    this._terminal = terminal;
+    this._disposable = terminal.parser.registerOscHandler(52, data => this._setOrReportClipboard(data));
+  }
+
+  public dispose(): void {
+    return this._disposable?.dispose();
+  }
+
+  private _readText(sel: ClipboardSelectionType, data: string): void {
+    const b64 = this._base64.encodeText(data);
+    this._terminal?.input(`\x1b]52;${sel};${b64}\x07`, false);
+  }
+
+  private _setOrReportClipboard(data: string): boolean | Promise<boolean> {
+    const args = data.split(';');
+    if (args.length < 2) {
+      return true;
+    }
+
+    const pc = args[0] as ClipboardSelectionType;
+    const pd = args[1];
+    if (pd === '?') {
+      const text = this._provider.readText(pc);
+
+      // Report clipboard
+      if (text instanceof Promise) {
+        return text.then((data) => {
+          this._readText(pc, data);
+          return true;
+        });
+      }
+
+      this._readText(pc, text);
+      return true;
+    }
+
+    // Clear clipboard if text is not a base64 encoded string.
+    let text = '';
+    try {
+      text = this._base64.decodeText(pd);
+    } catch {}
+
+
+    const result = this._provider.writeText(pc, text);
+    if (result instanceof Promise) {
+      return result.then(() => true);
+    }
+
+    return true;
+  }
+}
+
+export class BrowserClipboardProvider implements IClipboardProvider {
+  public async readText(selection: ClipboardSelectionType): Promise<string> {
+    if (selection !== 'c') {
+      return Promise.resolve('');
+    }
+    return navigator.clipboard.readText();
+  }
+
+  public async writeText(selection: ClipboardSelectionType, text: string): Promise<void> {
+    if (selection !== 'c') {
+      return Promise.resolve();
+    }
+    return navigator.clipboard.writeText(text);
+  }
+}
+
+export class Base64 implements IBase64 {
+  public encodeText(data: string): string {
+    return JSBase64.encode(data);
+  }
+  public decodeText(data: string): string {
+    const text = JSBase64.decode(data);
+    if (!JSBase64.isValid(data) || JSBase64.encode(text) !== data) {
+      return '';
+    }
+    return text;
+  }
+}

addons/addon-clipboard/src/tsconfig.json

@@ -0,0 +1,35 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es2021",
+    "lib": [
+      "dom",
+      "es2015"
+    ],
+    "rootDir": ".",
+    "outDir": "../out",
+    "sourceMap": true,
+    "removeComments": true,
+    "strict": true,
+    "types": [
+      "../../../node_modules/@types/mocha"
+    ],
+    "paths": {
+      "browser/*": [
+        "../../../src/browser/*"
+      ],
+      "@xterm/addon-clipboard": [
+        "../typings/addon-clipboard.d.ts"
+      ]
+    }
+  },
+  "include": [
+    "./**/*",
+    "../../../typings/xterm.d.ts"
+  ],
+  "references": [
+    {
+      "path": "../../../src/browser"
+    }
+  ]
+}

addons/addon-clipboard/test/ClipboardAddon.test.ts

@@ -0,0 +1,78 @@
+/**
+ * Copyright (c) 2023 The xterm.js authors. All rights reserved.
+ * @license MIT
+ */
+
+import test from '@playwright/test';
+import { deepEqual, ok, strictEqual } from 'assert';
+import { ITestContext, createTestContext, launchBrowser, openTerminal, timeout } from '../../../test/playwright/TestUtils';
+
+let ctx: ITestContext;
+test.beforeAll(async ({ browser }, testInfo) => {
+  ctx = await createTestContext(browser);
+  await openTerminal(ctx);
+});
+test.afterAll(async () => {
+  await ctx.page.close();
+});
+
+test.describe('ClipboardAddon', () => {
+
+  test.beforeEach(async ({}, testInfo) => {
+    // DEBT: This test doesn't work since the migration to @playwright/test
+    if (ctx.browser.browserType().name() !== 'chromium') {
+      testInfo.skip();
+      return;
+    }
+    if (ctx.browser.browserType().name() === 'chromium') {
+      // Enable clipboard access in chromium without user gesture
+      await ctx.page.context().grantPermissions(['clipboard-read', 'clipboard-write']);
+    }
+    await ctx.page.evaluate(`
+      window.term.reset()
+      window.clipboard?.dispose();
+      window.clipboard = new ClipboardAddon();
+      window.term.loadAddon(window.clipboard);
+    `);
+  });
+
+  test.beforeEach(async () => {
+    await ctx.proxy.reset();
+  });
+
+  const testDataEncoded = 'aGVsbG8gd29ybGQ=';
+  const testDataDecoded = 'hello world';
+
+  test.describe('write data', async function (): Promise<any> {
+    test('simple string', async () => {
+      await ctx.proxy.write(`\x1b]52;c;${testDataEncoded}\x07`);
+      deepEqual(await ctx.page.evaluate(() => window.navigator.clipboard.readText()), testDataDecoded);
+    });
+    test('invalid base64 string', async () => {
+      await ctx.proxy.write(`\x1b]52;c;${testDataEncoded}invalid\x07`);
+      deepEqual(await ctx.page.evaluate(() => window.navigator.clipboard.readText()), '');
+    });
+    test('empty string', async () => {
+      await ctx.proxy.write(`\x1b]52;c;${testDataEncoded}\x07`);
+      await ctx.proxy.write(`\x1b]52;c;\x07`);
+      deepEqual(await ctx.page.evaluate(() => window.navigator.clipboard.readText()), '');
+    });
+  });
+
+  test.describe('read data', async function (): Promise<any> {
+    test('simple string', async () => {
+      await ctx.page.evaluate(`
+        window.data = [];
+        window.term.onData(e => data.push(e));
+      `);
+      await ctx.page.evaluate(() => window.navigator.clipboard.writeText('hello world'));
+      await ctx.proxy.write(`\x1b]52;c;?\x07`);
+      deepEqual(await ctx.page.evaluate('window.data'), [`\x1b]52;c;${testDataEncoded}\x07`]);
+    });
+    test('clear clipboard', async () => {
+      await ctx.proxy.write(`\x1b]52;c;!\x07`);
+      await ctx.proxy.write(`\x1b]52;c;?\x07`);
+      deepEqual(await ctx.page.evaluate(() => window.navigator.clipboard.readText()), '');
+    });
+  });
+});

addons/addon-clipboard/test/playwright.config.ts

@@ -0,0 +1,35 @@
+import { PlaywrightTestConfig } from '@playwright/test';
+
+const config: PlaywrightTestConfig = {
+  testDir: '.',
+  timeout: 10000,
+  projects: [
+    {
+      name: 'ChromeStable',
+      use: {
+        browserName: 'chromium',
+        channel: 'chrome'
+      }
+    },
+    {
+      name: 'FirefoxStable',
+      use: {
+        browserName: 'firefox'
+      }
+    },
+    {
+      name: 'WebKit',
+      use: {
+        browserName: 'webkit'
+      }
+    }
+  ],
+  reporter: 'list',
+  webServer: {
+    command: 'npm run start',
+    port: 3000,
+    timeout: 120000,
+    reuseExistingServer: !process.env.CI
+  }
+};
+export default config;

addons/addon-clipboard/test/tsconfig.json

@@ -1,9 +1,9 @@
 {
   "compilerOptions": {
     "module": "commonjs",
-    "target": "es2015",
+    "target": "ESNext",
     "lib": [
-      "es6",
+      "es2021",
     ],
     "rootDir": ".",
     "outDir": "../out-test",
@@ -20,10 +20,7 @@
     },
     "strict": true,
     "types": [
-      "../../../node_modules/@types/node",
-      "../../../node_modules/@lunapaint/png-codec",
-      "../../../out-test/playwright/TestUtils",
-      "../../../out-test/playwright/SharedRendererTests"
+      "../../../node_modules/@types/node"
     ]
   },
   "include": [
@@ -36,6 +33,9 @@
     },
     {
       "path": "../../../src/browser"
+    },
+    {
+      "path": "../../../test/playwright"
     }
   ]
 }

addons/addon-clipboard/typings/addon-clipboard.d.ts

@@ -0,0 +1,113 @@
+/**
+ * Copyright (c) 2023 The xterm.js authors. All rights reserved.
+ * @license MIT
+ */
+
+import { Terminal, ITerminalAddon } from '@xterm/xterm';
+
+declare module '@xterm/addon-clipboard' {
+  /**
+   * An xterm.js addon that enables accessing the system clipboard from
+   * xterm.js.
+   */
+  export class ClipboardAddon implements ITerminalAddon {
+    /**
+     * Creates a new clipboard addon.
+     * @param base64 An optional base64 encoder/decoder.
+     * @param provider An optional clipboard provider.
+     */
+    constructor(base64?: IBase64, provider?: IClipboardProvider);
+
+    /**
+     * Activates the addon
+     * @param terminal The terminal the addon is being loaded in.
+     */
+    public activate(terminal: Terminal): void;
+
+    /**
+     * Disposes the addon.
+     */
+    public dispose(): void
+  }
+
+  /**
+   * Clipboard selection type. This is used to specify which selection buffer to
+   * read or write to.
+   * - SYSTEM `c`: The system clipboard.
+   * - PRIMARY `p`: The primary clipboard. This is provided for compatibility
+   *  with Linux X11.
+   */
+  export const enum ClipboardSelectionType {
+    SYSTEM = 'c',
+    PRIMARY = 'p',
+  }
+
+  export interface IBase64 {
+    /**
+    * Converts a utf-8 string to a base64 string.
+    * @param data The utf-8 string to convert to base64 string.
+    */
+    encodeText(data: string): string;
+
+    /**
+    * Converts a base64 string to a utf-8 string.
+    * @param data The base64 string to convert to utf-8 string.
+    * @throws An error if the input is not valid base64.
+    */
+    decodeText(data: string): string;
+  }
+
+  /**
+   * A default Base64 encoding and decoding type.
+   **/
+  export class Base64 implements IBase64 {
+    /**
+     * Converts a utf-8 string to a base64 string.
+     * @param data The utf-8 string to convert to base64 string.
+     */
+    public encodeText(data: string): string;
+
+    /**
+     * Converts a base64 string to a utf-8 string.
+     * @param data The base64 string to convert to utf-8 string.
+     * @throws An error if the input is not valid base64.
+     */
+    public decodeText(data: string): string;
+  }
+
+  export interface IClipboardProvider {
+    /**
+     * Gets the clipboard content.
+     * @param selection The clipboard selection to read.
+     * @returns A promise that resolves with clipboard selection data.
+     */
+    readText(selection: ClipboardSelectionType): string | Promise<string>;
+
+    /**
+     * Sets the clipboard content.
+     * @param selection The clipboard selection to set.
+     * @param data The clipboard text to write.
+     */
+    writeText(selection: ClipboardSelectionType, text: string): void | Promise<void>;
+  }
+
+  /**
+   * The clipboard provider interface that enables xterm.js to access the system clipboard.
+   */
+  export class BrowserClipboardProvider implements IClipboardProvider{
+    /**
+     * Reads text from the clipboard.
+     * @param selection The selection type to read from.
+     * @returns A promise that resolves with the text from the clipboard.
+     */
+    public readText(selection: ClipboardSelectionType): Promise<string>;
+
+    /**
+     * Writes text to the clipboard.
+     * @param selection The selection type to write to.
+     * @param data The text to write to the clipboard.
+     * @returns A promise that resolves when the text has been written to the clipboard.
+     */
+    public writeText(selection: ClipboardSelectionType, data: string): Promise<void>;
+  }
+}

addons/addon-clipboard/webpack.config.js

@@ -0,0 +1,31 @@
+/**
+ * Copyright (c) 2023 The xterm.js authors. All rights reserved.
+ * @license MIT
+ */
+
+const path = require('path');
+
+const addonName = 'ClipboardAddon';
+const mainFile = 'addon-clipboard.js';
+
+module.exports = {
+  entry: `./out/${addonName}.js`,
+  devtool: 'source-map',
+  module: {
+    rules: [
+      {
+        test: /\.js$/,
+        use: ["source-map-loader"],
+        enforce: "pre",
+        exclude: /node_modules/
+      }
+    ]
+  },
+  output: {
+    filename: mainFile,
+    path: path.resolve('./lib'),
+    library: addonName,
+    libraryTarget: 'umd'
+  },
+  mode: 'production'
+};

addons/addon-fit/.npmignore

@@ -8,6 +8,9 @@
 !lib/**/*.js
 !lib/**/*.js.map
 
+!lib/**/*.mjs
+!lib/**/*.mjs.map
+
 !lib/**/*.css
 
 # Whitelist - src/

addons/addon-fit/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@xterm/addon-fit",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "author": {
     "name": "The xterm.js authors",
     "url": "https://xtermjs.org/"
   },
   "main": "lib/addon-fit.js",
+  "module": "lib/addon-fit.mjs",
   "types": "typings/addon-fit.d.ts",
   "repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/addon-fit",
   "license": "MIT",
@@ -18,9 +19,7 @@
     "build": "../../node_modules/.bin/tsc -p .",
     "prepackage": "npm run build",
     "package": "../../node_modules/.bin/webpack",
-    "prepublishOnly": "npm run package"
-  },
-  "peerDependencies": {
-    "@xterm/xterm": "^5.0.0"
+    "prepublishOnly": "npm run package",
+    "start": "node ../../demo/start"
   }
 }

addons/addon-fit/src/FitAddon.ts

@@ -3,9 +3,9 @@
  * @license MIT
  */
 
-import type { Terminal, ITerminalAddon } from '@xterm/xterm';
+import type { Terminal, ITerminalAddon, IRenderDimensions } from '@xterm/xterm';
 import type { FitAddon as IFitApi } from '@xterm/addon-fit';
-import { IRenderDimensions } from 'browser/renderer/shared/Types';
+import { ViewportConstants } from 'browser/shared/Constants';
 
 interface ITerminalDimensions {
   /**
@@ -22,6 +22,17 @@ interface ITerminalDimensions {
 const MINIMUM_COLS = 2;
 const MINIMUM_ROWS = 1;
 
+function getWindow(e: Node): Window {
+  if (e?.ownerDocument?.defaultView) {
+    return e.ownerDocument.defaultView;
+  }
+
+  return window;
+}
+function _getComputedStyle(el: HTMLElement): CSSStyleDeclaration {
+  return getWindow(el).getComputedStyle(el, null);
+}
+
 export class FitAddon implements ITerminalAddon , IFitApi {
   private _terminal: Terminal | undefined;
 
@@ -37,12 +48,8 @@ export class FitAddon implements ITerminalAddon , IFitApi {
       return;
     }
 
-    // TODO: Remove reliance on private API
-    const core = (this._terminal as any)._core;
-
     // Force a full render
     if (this._terminal.rows !== dims.rows || this._terminal.cols !== dims.cols) {
-      core._renderService.clear();
       this._terminal.resize(dims.cols, dims.rows);
     }
   }
@@ -56,21 +63,20 @@ export class FitAddon implements ITerminalAddon , IFitApi {
       return undefined;
     }
 
-    // TODO: Remove reliance on private API
-    const core = (this._terminal as any)._core;
-    const dims: IRenderDimensions = core._renderService.dimensions;
+    const dims: IRenderDimensions | undefined = this._terminal.dimensions;
 
-    if (dims.css.cell.width === 0 || dims.css.cell.height === 0) {
+    if (!dims || dims.css.cell.width === 0 || dims.css.cell.height === 0) {
       return undefined;
     }
 
-    const scrollbarWidth = this._terminal.options.scrollback === 0 ?
-      0 : core.viewport.scrollBarWidth;
+    const scrollbarWidth = (this._terminal.options.scrollback === 0
+      ? 0
+      : (this._terminal.options.overviewRuler?.width || ViewportConstants.DEFAULT_SCROLL_BAR_WIDTH));
 
-    const parentElementStyle = window.getComputedStyle(this._terminal.element.parentElement);
+    const parentElementStyle = _getComputedStyle(this._terminal.element.parentElement);
     const parentElementHeight = parseInt(parentElementStyle.getPropertyValue('height'));
     const parentElementWidth = Math.max(0, parseInt(parentElementStyle.getPropertyValue('width')));
-    const elementStyle = window.getComputedStyle(this._terminal.element);
+    const elementStyle = _getComputedStyle(this._terminal.element);
     const elementPadding = {
       top: parseInt(elementStyle.getPropertyValue('padding-top')),
       bottom: parseInt(elementStyle.getPropertyValue('padding-bottom')),

addons/addon-fit/test/FitAddon.api.ts

@@ -1,135 +0,0 @@
-/**
- * Copyright (c) 2019 The xterm.js authors. All rights reserved.
- * @license MIT
- */
-
-import { assert } from 'chai';
-import { openTerminal, launchBrowser, timeout } from '../../../out-test/api/TestUtils';
-import { Browser, Page } from '@playwright/test';
-
-const APP = 'http://127.0.0.1:3001/test';
-
-let browser: Browser;
-let page: Page;
-const width = 1024;
-const height = 768;
-
-describe('FitAddon', () => {
-  before(async function(): Promise<any> {
-    browser = await launchBrowser();
-    page = await (await browser.newContext()).newPage();
-    await page.setViewportSize({ width, height });
-    await page.goto(APP);
-  });
-
-  beforeEach(async function(): Promise<any> {
-    await page.evaluate(`document.querySelector('#terminal-container').style.display=''`);
-    await openTerminal(page);
-  });
-
-  after(async () => {
-    await browser.close();
-  });
-
-  afterEach(async function(): Promise<any> {
-    await page.evaluate(`window.term.dispose()`);
-  });
-
-  it('no terminal', async function(): Promise<any> {
-    await page.evaluate(`window.fit = new FitAddon();`);
-    assert.equal(await page.evaluate(`window.fit.proposeDimensions()`), undefined);
-  });
-
-  describe('proposeDimensions', () => {
-    afterEach(() => unloadFit());
-
-    it('default', async function(): Promise<any> {
-      await loadFit();
-      const dimensions: {cols: number, rows: number} = await page.evaluate(`window.fit.proposeDimensions()`);
-      assert.isAbove(dimensions.cols, 85);
-      assert.isBelow(dimensions.cols, 88);
-      assert.isAbove(dimensions.rows, 24);
-      assert.isBelow(dimensions.rows, 29);
-    });
-
-    it('width', async function(): Promise<any> {
-      await loadFit(1008);
-      const dimensions: {cols: number, rows: number} = await page.evaluate(`window.fit.proposeDimensions()`);
-      assert.isAbove(dimensions.cols, 108);
-      assert.isBelow(dimensions.cols, 111);
-      assert.isAbove(dimensions.rows, 24);
-      assert.isBelow(dimensions.rows, 29);
-    });
-
-    it('small', async function(): Promise<any> {
-      await loadFit(1, 1);
-      assert.deepEqual(await page.evaluate(`window.fit.proposeDimensions()`), {
-        cols: 2,
-        rows: 1
-      });
-    });
-
-    it('hidden', async function(): Promise<any> {
-      await page.evaluate(`window.term.dispose()`);
-      await page.evaluate(`document.querySelector('#terminal-container').style.display='none'`);
-      await page.evaluate(`window.term = new Terminal()`);
-      await page.evaluate(`window.term.open(document.querySelector('#terminal-container'))`);
-      await loadFit();
-      const dimensions: { cols: number, rows: number } | undefined = await page.evaluate(`window.fit.proposeDimensions()`);
-      // The value of dims will be undefined if the char measure strategy falls back to the DOM
-      // method, so only assert if it's not undefined.
-      if (dimensions) {
-        assert.isAbove(dimensions.cols, 85);
-        assert.isBelow(dimensions.cols, 88);
-        assert.isAbove(dimensions.rows, 24);
-        assert.isBelow(dimensions.rows, 29);
-      }
-    });
-  });
-
-  describe('fit', () => {
-    afterEach(() => unloadFit());
-
-    it('default', async function(): Promise<any> {
-      await loadFit();
-      await page.evaluate(`window.fit.fit()`);
-      const cols: number = await page.evaluate(`window.term.cols`);
-      const rows: number = await page.evaluate(`window.term.rows`);
-      assert.isAbove(cols, 85);
-      assert.isBelow(cols, 88);
-      assert.isAbove(rows, 24);
-      assert.isBelow(rows, 29);
-    });
-
-    it('width', async function(): Promise<any> {
-      await loadFit(1008);
-      await page.evaluate(`window.fit.fit()`);
-      const cols: number = await page.evaluate(`window.term.cols`);
-      const rows: number = await page.evaluate(`window.term.rows`);
-      assert.isAbove(cols, 108);
-      assert.isBelow(cols, 111);
-      assert.isAbove(rows, 24);
-      assert.isBelow(rows, 29);
-    });
-
-    it('small', async function(): Promise<any> {
-      await loadFit(1, 1);
-      await page.evaluate(`window.fit.fit()`);
-      assert.equal(await page.evaluate(`window.term.cols`), 2);
-      assert.equal(await page.evaluate(`window.term.rows`), 1);
-    });
-  });
-});
-
-async function loadFit(width: number = 800, height: number = 450): Promise<void> {
-  await page.evaluate(`
-    window.fit = new FitAddon();
-    window.term.loadAddon(window.fit);
-    document.querySelector('#terminal-container').style.width='${width}px';
-    document.querySelector('#terminal-container').style.height='${height}px';
-  `);
-}
-
-async function unloadFit(): Promise<void> {
-  await page.evaluate(`window.fit.dispose();`);
-}

addons/addon-fit/test/FitAddon.test.ts

@@ -0,0 +1,133 @@
+/**
+ * Copyright (c) 2019 The xterm.js authors. All rights reserved.
+ * @license MIT
+ */
+
+import test from '@playwright/test';
+import { deepEqual, ok, strictEqual } from 'assert';
+import { ITestContext, createTestContext, openTerminal, timeout } from '../../../test/playwright/TestUtils';
+
+let ctx: ITestContext;
+test.beforeAll(async ({ browser }) => {
+  ctx = await createTestContext(browser);
+  ctx.page.setViewportSize({ width: 1024, height: 768 });
+  await openTerminal(ctx);
+});
+test.afterAll(async () => await ctx.page.close());
+
+test.describe('FitAddon', () => {
+  test.beforeEach(async function(): Promise<any> {
+    await ctx.page.evaluate(`document.querySelector('#terminal-container').style.display=''`);
+    await ctx.page.evaluate(`
+      window.term.reset()
+      window.fit?.dispose();
+      window.fit = new FitAddon();
+      window.term.loadAddon(window.fit);
+    `);
+  });
+
+  // test.beforeEach(async function(): Promise<any> {
+  //   await ctx.page.evaluate(`document.querySelector('#terminal-container').style.display=''`);
+  //   await openTerminal(page);
+  // });
+
+  // after(async () => {
+  //   await browser.close();
+  // });
+
+  // afterEach(async function(): Promise<any> {
+  //   await ctx.proxy.dispose();
+  // });
+
+  test('no terminal', async function(): Promise<any> {
+    await ctx.page.evaluate(`window.fit2 = new FitAddon();`);
+    strictEqual(await ctx.page.evaluate(`window.fit2.proposeDimensions()`), undefined);
+    await ctx.page.evaluate(`window.fit2.dispose();`);
+  });
+
+  test.describe('proposeDimensions', () => {
+    test('default', async function(): Promise<any> {
+      await setDimensions();
+      const dimensions: {cols: number, rows: number} = await ctx.page.evaluate(`window.fit.proposeDimensions()`);
+      ok(dimensions.cols > 85);
+      ok(dimensions.cols < 88);
+      ok(dimensions.rows > 24);
+      ok(dimensions.rows < 29);
+    });
+
+    test('width', async function(): Promise<any> {
+      await setDimensions(1008);
+      const dimensions: {cols: number, rows: number} = await ctx.page.evaluate(`window.fit.proposeDimensions()`);
+      ok(dimensions.cols > 108);
+      ok(dimensions.cols < 111);
+      ok(dimensions.rows > 24);
+      ok(dimensions.rows < 29);
+    });
+
+    test('small', async function(): Promise<any> {
+      await setDimensions(1, 1);
+      deepEqual(await ctx.page.evaluate(`window.fit.proposeDimensions()`), {
+        cols: 2,
+        rows: 1
+      });
+    });
+
+    test('hidden', async function(): Promise<any> {
+      await ctx.proxy.dispose();
+      await ctx.page.evaluate(`document.querySelector('#terminal-container').style.display='none'`);
+      await ctx.page.evaluate(`window.term = new Terminal()`);
+      await ctx.page.evaluate(`window.term.open(document.querySelector('#terminal-container'))`);
+      await setDimensions();
+      const dimensions: { cols: number, rows: number } | undefined = await ctx.page.evaluate(`window.fit.proposeDimensions()`);
+      // The value of dims will be undefined if the char measure strategy falls back to the DOM
+      // method, so only assert if it's not undefined.
+      if (dimensions) {
+        ok(dimensions.cols > 85);
+        ok(dimensions.cols < 88);
+        ok(dimensions.rows > 24);
+        ok(dimensions.rows < 29);
+      }
+    });
+  });
+
+  test.describe('fit', () => {
+    test('default', async function(): Promise<any> {
+      await setDimensions();
+      await ctx.page.evaluate(`window.fit.fit()`);
+      const cols: number = await ctx.proxy.cols;
+      const rows: number = await ctx.proxy.rows;
+      ok(cols > 85);
+      ok(cols < 88);
+      ok(rows > 24);
+      ok(rows < 29);
+    });
+
+    test('width', async function(): Promise<any> {
+      await setDimensions(1008);
+      await ctx.page.evaluate(`window.fit.fit()`);
+      const cols: number = await ctx.proxy.cols;
+      const rows: number = await ctx.proxy.rows;
+      ok(cols > 108);
+      ok(cols < 111);
+      ok(rows > 24);
+      ok(rows < 29);
+    });
+
+    test('small', async function(): Promise<any> {
+      await setDimensions(1, 1);
+      await ctx.page.evaluate(`window.fit.fit()`);
+      strictEqual(await ctx.proxy.cols, 2);
+      strictEqual(await ctx.proxy.rows, 1);
+    });
+  });
+});
+
+async function setDimensions(width: number = 800, height: number = 450): Promise<void> {
+  await ctx.page.evaluate(`
+    document.querySelector('#terminal-container').style.width='${width}px';
+    document.querySelector('#terminal-container').style.height='${height}px';
+    document.querySelector('#terminal-container').style.display='';
+  `);
+  // HACK: Await a short period as hiding #terminal-container can mess with other tests
+  await timeout(500);
+}

addons/addon-fit/test/playwright.config.ts

@@ -0,0 +1,35 @@
+import { PlaywrightTestConfig } from '@playwright/test';
+
+const config: PlaywrightTestConfig = {
+  testDir: '.',
+  timeout: 10000,
+  projects: [
+    {
+      name: 'ChromeStable',
+      use: {
+        browserName: 'chromium',
+        channel: 'chrome'
+      }
+    },
+    {
+      name: 'FirefoxStable',
+      use: {
+        browserName: 'firefox'
+      }
+    },
+    {
+      name: 'WebKit',
+      use: {
+        browserName: 'webkit'
+      }
+    }
+  ],
+  reporter: 'list',
+  webServer: {
+    command: 'npm run start',
+    port: 3000,
+    timeout: 120000,
+    reuseExistingServer: !process.env.CI
+  }
+};
+export default config;

addons/addon-fit/test/tsconfig.json

@@ -1,23 +1,41 @@
 {
   "compilerOptions": {
     "module": "commonjs",
-    "target": "es2021",
+    "target": "ESNext",
     "lib": [
-      "es2015"
+      "es2021",
     ],
     "rootDir": ".",
     "outDir": "../out-test",
     "sourceMap": true,
     "removeComments": true,
+    "baseUrl": ".",
+    "paths": {
+      "common/*": [
+        "../../../src/common/*"
+      ],
+      "browser/*": [
+        "../../../src/browser/*"
+      ]
+    },
     "strict": true,
     "types": [
-      "../../../node_modules/@types/mocha",
-      "../../../node_modules/@types/node",
-      "../../../out-test/api/TestUtils"
+      "../../../node_modules/@types/node"
     ]
   },
   "include": [
     "./**/*",
     "../../../typings/xterm.d.ts"
+  ],
+  "references": [
+    {
+      "path": "../../../src/common"
+    },
+    {
+      "path": "../../../src/browser"
+    },
+    {
+      "path": "../../../test/playwright"
+    }
   ]
 }

addons/addon-fit/typings/addon-fit.d.ts

@@ -39,7 +39,7 @@ declare module '@xterm/addon-fit' {
   }
 
   /**
-   * Reprepresents the dimensions of a terminal.
+   * Represents the dimensions of a terminal.
    */
   export interface ITerminalDimensions {
     /**

addons/addon-fit/webpack.config.js

@@ -25,7 +25,9 @@ module.exports = {
     filename: mainFile,
     path: path.resolve('./lib'),
     library: addonName,
-    libraryTarget: 'umd'
+    libraryTarget: 'umd',
+    // Force usage of globalThis instead of global / self. (This is cross-env compatible)
+    globalObject: 'globalThis',
   },
   mode: 'production'
 };

addons/addon-image/.gitignore

@@ -17,7 +17,6 @@ npm-debug.log
 .env
 build/
 .DS_Store
-package-lock.json
 yarn.lock
 
 # Keep bundled code out of Git

addons/addon-image/.npmignore

@@ -6,5 +6,7 @@ tsconfig.json
 webpack.config.js
 test
 out-test
+out-esbuild
+out-esbuild-test
 inwasm-sdks
 inwasm-builds

addons/addon-image/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@xterm/addon-image",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "author": {
     "name": "The xterm.js authors",
     "url": "https://xtermjs.org/"
   },
   "main": "lib/addon-image.js",
+  "module": "lib/addon-image.mjs",
   "types": "typings/addon-image.d.ts",
   "repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/addon-image",
   "license": "MIT",
@@ -19,10 +20,8 @@
   "scripts": {
     "prepackage": "../../node_modules/.bin/tsc -p .",
     "package": "../../node_modules/.bin/webpack",
-    "prepublishOnly": "npm run package"
-  },
-  "peerDependencies": {
-    "@xterm/xterm": "^5.2.0"
+    "prepublishOnly": "npm run package",
+    "start": "node ../../demo/start"
   },
   "devDependencies": {
     "sixel": "^0.16.0",

addons/addon-image/src/IIPHandler.ts

@@ -105,7 +105,7 @@ export class IIPHandler implements IOscHandler, IResetHandler {
       return true;
     }
 
-    const blob = new Blob([this._dec.data8], { type: this._metrics.mime });
+    const blob = new Blob([new Uint8Array(this._dec.data8)], { type: this._metrics.mime });
     this._dec.release();
 
     if (!window.createImageBitmap) {

addons/addon-image/src/IIPHeaderParser.ts

@@ -176,7 +176,7 @@ export class HeaderParser {
       try {
         const v = this._buffer.slice(0, pos);
         this.fields[this._key] = DECODERS[this._key] ? DECODERS[this._key](v) : v;
-      } catch (e) {
+      } catch {
         return false;
       }
       return true;

addons/addon-image/src/IIPMetrics.test.ts

@@ -25,6 +25,7 @@ const TEST_IMAGES: [string, IMetrics][] = [
   ['w3c_home_gray.png', { mime: 'image/png', width: 72, height: 48 }],
   ['w3c_home.jpg', { mime: 'image/jpeg', width: 72, height: 48 }],
   ['w3c_home.png', { mime: 'image/png', width: 72, height: 48 }],
+  ['w3c_home_noexif.jpg', { mime: 'image/jpeg', width: 72, height: 48 }],
   ['spinfox.png', { mime: 'image/png', width: 148, height: 148 }],
   ['iphone_hdr_YES.jpg', { mime: 'image/jpeg', width: 3264, height: 2448 }],
   ['nikon-e950.jpg', { mime: 'image/jpeg', width: 800, height: 600 }],

addons/addon-image/src/IIPMetrics.ts

@@ -32,13 +32,8 @@ export function imageType(d: Uint8Array): IMetrics {
       height: d[20] << 24 | d[21] << 16 | d[22] << 8 | d[23]
     };
   }
-  // JPEG: FF D8 FF E0 xx xx JFIF  or  FF D8 FF E1 xx xx Exif 00 00
-  if ((d32[0] === 0xE0FFD8FF || d32[0] === 0xE1FFD8FF)
-    &&  (
-      (d[6] === 0x4a && d[7] === 0x46 && d[8] === 0x49 && d[9] === 0x46)
-        ||  (d[6] === 0x45 && d[7] === 0x78 && d[8] === 0x69 && d[9] === 0x66)
-    )
-  ) {
+  // JPEG: FF D8 FF
+  if (d[0] === 0xFF && d[1] === 0xD8 && d[2] === 0xFF) {
     const [width, height] = jpgSize(d);
     return { mime: 'image/jpeg', width, height };
   }

addons/addon-image/src/ImageRenderer.ts

@@ -6,8 +6,7 @@
 import { toRGBA8888 } from 'sixel/lib/Colors';
 import { IDisposable } from '@xterm/xterm';
 import { ICellSize, ITerminalExt, IImageSpec, IRenderDimensions, IRenderService } from './Types';
-import { Disposable, MutableDisposable, toDisposable } from 'common/Lifecycle';
-
+import { Disposable, MutableDisposable, toDisposable } from 'vs/base/common/lifecycle';
 
 const PLACEHOLDER_LENGTH = 4096;
 const PLACEHOLDER_HEIGHT = 24;
@@ -23,7 +22,7 @@ export class ImageRenderer extends Disposable implements IDisposable {
   private _ctx: CanvasRenderingContext2D | null | undefined;
   private _placeholder: HTMLCanvasElement | undefined;
   private _placeholderBitmap: ImageBitmap | undefined;
-  private _optionsRefresh = this.register(new MutableDisposable());
+  private _optionsRefresh = this._register(new MutableDisposable());
   private _oldOpen: ((parent: HTMLElement) => void) | undefined;
   private _renderService: IRenderService | undefined;
   private _oldSetRenderer: ((renderer: any) => void) | undefined;
@@ -85,7 +84,7 @@ export class ImageRenderer extends Disposable implements IDisposable {
         this._renderService?.refreshRows(0, this._terminal.rows);
       }
     });
-    this.register(toDisposable(() => {
+    this._register(toDisposable(() => {
       this.removeLayerFromDom();
       if (this._terminal._core && this._oldOpen) {
         this._terminal._core.open = this._oldOpen;
@@ -125,7 +124,7 @@ export class ImageRenderer extends Disposable implements IDisposable {
    * Forwarded from internal render service.
    */
   public get dimensions(): IRenderDimensions | undefined {
-    return this._renderService?.dimensions;
+    return this._terminal.dimensions;
   }
 
   /**

addons/addon-image/src/SixelHandler.ts

@@ -99,7 +99,7 @@ export class SixelHandler implements IDcsHandler, IResetHandler {
     }
 
     const canvas = ImageRenderer.createCanvas(undefined, width, height);
-    canvas.getContext('2d')?.putImageData(new ImageData(this._dec.data8, width, height), 0, 0);
+    canvas.getContext('2d')?.putImageData(new ImageData(this._dec.data8 as Uint8ClampedArray<ArrayBuffer>, width, height), 0, 0);
     if (this._dec.memoryUsage > MEM_PERMA_LIMIT) {
       this._dec.release();
     }

addons/addon-image/src/tsconfig.json

@@ -15,6 +15,7 @@
     "paths": {
       "browser/*": [ "../../../src/browser/*" ],
       "common/*": [ "../../../src/common/*" ],
+      "vs/*": [ "../../../src/vs/*" ],
       "@xterm/addon-image": [ "../typings/addon-image.d.ts" ]
     }
   },
@@ -24,6 +25,7 @@
   ],
   "references": [
     { "path": "../../../src/browser" },
-    { "path": "../../../src/common" }
+    { "path": "../../../src/common" },
+    { "path": "../../../src/vs" }
   ]
 }

addons/addon-image/test/ImageAddon.api.ts

@@ -1,321 +0,0 @@
-/**
- * Copyright (c) 2020 The xterm.js authors. All rights reserved.
- * @license MIT
- */
-
-import { assert } from 'chai';
-import { openTerminal, launchBrowser, pollFor } from '../../../out-test/api/TestUtils';
-import { Browser, Page } from '@playwright/test';
-import { IImageAddonOptions } from '../src/Types';
-import { FINALIZER, introducer, sixelEncode } from 'sixel';
-import { readFileSync } from 'fs';
-
-const APP = 'http://127.0.0.1:3001/test';
-
-let browser: Browser;
-let page: Page;
-const width = 800;
-const height = 600;
-
-// eslint-disable-next-line
-declare const ImageAddon: {
-  new(options?: Partial<IImageAddonOptions>): any;
-};
-
-interface ITestData {
-  width: number;
-  height: number;
-  bytes: Uint8Array;
-  palette: number[];
-  sixel: string;
-}
-
-interface IDimensions {
-  cellWidth: number;
-  cellHeight: number;
-  width: number;
-  height: number;
-}
-
-// image: 640 x 80, 512 color
-const TESTDATA: ITestData = (() => {
-  const data8 = readFileSync('./addons/addon-image/fixture/palette.blob');
-  const data32 = new Uint32Array(data8.buffer);
-  const palette = new Set<number>();
-  for (let i = 0; i < data32.length; ++i) palette.add(data32[i]);
-  const sixel = sixelEncode(data8, 640, 80, [...palette]);
-  return {
-    width: 640,
-    height: 80,
-    bytes: data8,
-    palette: [...palette],
-    sixel
-  };
-})();
-const SIXEL_SEQ_0 = introducer(0) + TESTDATA.sixel + FINALIZER;
-// const SIXEL_SEQ_1 = introducer(1) + TESTDATA.sixel + FINALIZER;
-// const SIXEL_SEQ_2 = introducer(2) + TESTDATA.sixel + FINALIZER;
-
-// NOTE: the data is loaded as string for easier transport through playwright
-const TESTDATA_IIP: [string, [number, number]][] = [
-  [readFileSync('./addons/addon-image/fixture/iip/palette.iip', { encoding: 'utf-8' }), [640, 80]],
-  [readFileSync('./addons/addon-image/fixture/iip/spinfox.iip', { encoding: 'utf-8' }), [148, 148]],
-  [readFileSync('./addons/addon-image/fixture/iip/w3c_gif.iip', { encoding: 'utf-8' }), [72, 48]],
-  [readFileSync('./addons/addon-image/fixture/iip/w3c_jpg.iip', { encoding: 'utf-8' }), [72, 48]],
-  [readFileSync('./addons/addon-image/fixture/iip/w3c_png.iip', { encoding: 'utf-8' }), [72, 48]]
-];
-
-describe('ImageAddon', () => {
-  before(async () => {
-    browser = await launchBrowser();
-    page = await (await browser.newContext()).newPage();
-    await page.setViewportSize({ width, height });
-  });
-
-  after(async () => {
-    await browser.close();
-  });
-
-  beforeEach(async () => {
-    await page.goto(APP);
-    await openTerminal(page);
-    await page.evaluate(opts => {
-      (window as any).imageAddon = new ImageAddon(opts.opts);
-      (window as any).term.loadAddon((window as any).imageAddon);
-    }, { opts: { sixelPaletteLimit: 512 } });
-  });
-
-  it('test for private accessors', async () => {
-    // terminal privates
-    const accessors = [
-      '_core',
-      '_core._renderService',
-      '_core._inputHandler',
-      '_core._inputHandler._parser',
-      '_core._inputHandler._curAttrData',
-      '_core._inputHandler._dirtyRowTracker',
-      '_core._themeService.colors',
-      '_core._coreBrowserService'
-    ];
-    for (const prop of accessors) {
-      assert.equal(
-        await page.evaluate('(() => { const v = window.term.' + prop + '; return v !== undefined && v !== null; })()'),
-        true, `problem at ${prop}`
-      );
-    }
-    // bufferline privates
-    assert.equal(await page.evaluate('window.term._core.buffer.lines.get(0)._data instanceof Uint32Array'), true);
-    assert.equal(await page.evaluate('window.term._core.buffer.lines.get(0)._extendedAttrs instanceof Object'), true);
-    // inputhandler privates
-    assert.equal(await page.evaluate('window.term._core._inputHandler._curAttrData.constructor.name'), 'AttributeData');
-    assert.equal(await page.evaluate('window.term._core._inputHandler._parser.constructor.name'), 'EscapeSequenceParser');
-  });
-
-  describe('ctor options', () => {
-    it('empty settings should load defaults', async () => {
-      const DEFAULT_OPTIONS: IImageAddonOptions = {
-        enableSizeReports: true,
-        pixelLimit: 16777216,
-        sixelSupport: true,
-        sixelScrolling: true,
-        sixelPaletteLimit: 512,  // set to 512 to get example image working
-        sixelSizeLimit: 25000000,
-        storageLimit: 128,
-        showPlaceholder: true,
-        iipSupport: true,
-        iipSizeLimit: 20000000
-      };
-      assert.deepEqual(await page.evaluate(`window.imageAddon._opts`), DEFAULT_OPTIONS);
-    });
-    it('custom settings should overload defaults', async () => {
-      const customSettings: IImageAddonOptions = {
-        enableSizeReports: false,
-        pixelLimit: 5,
-        sixelSupport: false,
-        sixelScrolling: false,
-        sixelPaletteLimit: 1024,
-        sixelSizeLimit: 1000,
-        storageLimit: 10,
-        showPlaceholder: false,
-        iipSupport: false,
-        iipSizeLimit: 1000
-      };
-      await page.evaluate(opts => {
-        (window as any).imageAddonCustom = new ImageAddon(opts.opts);
-        (window as any).term.loadAddon((window as any).imageAddonCustom);
-      }, { opts: customSettings });
-      assert.deepEqual(await page.evaluate(`window.imageAddonCustom._opts`), customSettings);
-    });
-  });
-
-  describe('scrolling & cursor modes', () => {
-    it('testdata default (scrolling with VT240 cursor pos)', async () => {
-      const dim = await getDimensions();
-      await writeToTerminal(SIXEL_SEQ_0);
-      assert.deepEqual(await getCursor(), [0, Math.floor(TESTDATA.height/dim.cellHeight)]);
-      // moved to right by 10 cells
-      await writeToTerminal('#'.repeat(10) + SIXEL_SEQ_0);
-      assert.deepEqual(await getCursor(), [10, Math.floor(TESTDATA.height/dim.cellHeight) * 2]);
-    });
-    it('write testdata noScrolling', async () => {
-      await writeToTerminal('\x1b[?80h' + SIXEL_SEQ_0);
-      assert.deepEqual(await getCursor(), [0, 0]);
-      // second draw does not change anything
-      await writeToTerminal(SIXEL_SEQ_0);
-      assert.deepEqual(await getCursor(), [0, 0]);
-    });
-    it('testdata cursor always at VT240 pos', async () => {
-      const dim = await getDimensions();
-      // offset 0
-      await writeToTerminal(SIXEL_SEQ_0);
-      assert.deepEqual(await getCursor(), [0, Math.floor(TESTDATA.height/dim.cellHeight)]);
-      // moved to right by 10 cells
-      await writeToTerminal('#'.repeat(10) + SIXEL_SEQ_0);
-      assert.deepEqual(await getCursor(), [10, Math.floor(TESTDATA.height/dim.cellHeight) * 2]);
-      // moved by 30 cells (+10 prev)
-      await writeToTerminal('#'.repeat(30) + SIXEL_SEQ_0);
-      assert.deepEqual(await getCursor(), [10 + 30, Math.floor(TESTDATA.height/dim.cellHeight) * 3]);
-    });
-  });
-
-  describe('image lifecycle & eviction', () => {
-    it('delete image once scrolled off', async () => {
-      await writeToTerminal(SIXEL_SEQ_0);
-      pollFor(page, 'window.imageAddon._storage._images.size', 1);
-      // scroll to scrollback + rows - 1
-      await page.evaluate(
-        scrollback => new Promise(res => (window as any).term.write('\n'.repeat(scrollback), res)),
-        (await getScrollbackPlusRows() - 1)
-      );
-      // wait here, as we have to make sure, that eviction did not yet occur
-      await new Promise(r => setTimeout(r, 100));
-      pollFor(page, 'window.imageAddon._storage._images.size', 1);
-      // scroll one further should delete the image
-      await page.evaluate(() => new Promise(res => (window as any).term.write('\n', res)));
-      pollFor(page, 'window.imageAddon._storage._images.size', 0);
-    });
-    it('get storageUsage', async () => {
-      assert.equal(await page.evaluate('imageAddon.storageUsage'), 0);
-      await writeToTerminal(SIXEL_SEQ_0);
-      assert.closeTo(await page.evaluate('imageAddon.storageUsage'), 640 * 80 * 4 / 1000000, 0.05);
-    });
-    it('get/set storageLimit', async () => {
-      assert.equal(await page.evaluate('imageAddon.storageLimit'), 128);
-      assert.equal(await page.evaluate('imageAddon.storageLimit = 1'), 1);
-      assert.equal(await page.evaluate('imageAddon.storageLimit'), 1);
-    });
-    it('remove images by storage limit pressure', async () => {
-      assert.equal(await page.evaluate('imageAddon.storageLimit = 1'), 1);
-      // never go beyond storage limit
-      await writeToTerminal(SIXEL_SEQ_0);
-      await writeToTerminal(SIXEL_SEQ_0);
-      await writeToTerminal(SIXEL_SEQ_0);
-      await writeToTerminal(SIXEL_SEQ_0);
-      await new Promise(r => setTimeout(r, 50));
-      const usage = await page.evaluate('imageAddon.storageUsage');
-      await writeToTerminal(SIXEL_SEQ_0);
-      await writeToTerminal(SIXEL_SEQ_0);
-      await writeToTerminal(SIXEL_SEQ_0);
-      await writeToTerminal(SIXEL_SEQ_0);
-      await new Promise(r => setTimeout(r, 50));
-      assert.equal(await page.evaluate('imageAddon.storageUsage'), usage);
-      assert.equal(usage as number < 1, true);
-    });
-    it('set storageLimit removes images synchronously', async () => {
-      await writeToTerminal(SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0);
-      const usage: number = await page.evaluate('imageAddon.storageUsage');
-      const newUsage: number = await page.evaluate('imageAddon.storageLimit = 0.5; imageAddon.storageUsage');
-      assert.equal(newUsage < usage, true);
-      assert.equal(newUsage < 0.5, true);
-    });
-    it('clear alternate images on buffer change', async () => {
-      assert.equal(await page.evaluate('imageAddon.storageUsage'), 0);
-      await writeToTerminal('\x1b[?1049h' + SIXEL_SEQ_0);
-      assert.closeTo(await page.evaluate('imageAddon.storageUsage'), 640 * 80 * 4 / 1000000, 0.05);
-      await writeToTerminal('\x1b[?1049l');
-      assert.equal(await page.evaluate('imageAddon.storageUsage'), 0);
-    });
-    it('evict tiles by in-place overwrites (only full overwrite tested)', async () => {
-      await new Promise(r => setTimeout(r, 50));
-      await writeToTerminal('\x1b[H' + SIXEL_SEQ_0 + '\x1b[100;100H');
-      let usage = await page.evaluate('imageAddon.storageUsage');
-      while (usage === 0) {
-        await new Promise(r => setTimeout(r, 50));
-        usage = await page.evaluate('imageAddon.storageUsage');
-      }
-      await writeToTerminal('\x1b[H' + SIXEL_SEQ_0 + '\x1b[100;100H');
-      await new Promise(r => setTimeout(r, 200));  // wait some time and re-check
-      assert.equal(await page.evaluate('imageAddon.storageUsage'), usage);
-    });
-    it('manual eviction on alternate buffer must not miss images', async () => {
-      await writeToTerminal('\x1b[?1049h');
-      await writeToTerminal(SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0);
-      await new Promise(r => setTimeout(r, 50));
-      const usage: number = await page.evaluate('imageAddon.storageUsage');
-      await writeToTerminal(SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0);
-      await writeToTerminal(SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0);
-      await new Promise(r => setTimeout(r, 50));
-      const newUsage: number = await page.evaluate('imageAddon.storageUsage');
-      assert.equal(newUsage, usage);
-    });
-  });
-
-  describe('IIP support - testimages', () => {
-    it('palette.png', async () => {
-      await writeToTerminal(TESTDATA_IIP[0][0]);
-      assert.deepEqual(await getOrigSize(1), TESTDATA_IIP[0][1]);
-    });
-    it('spinfox.png', async () => {
-      await writeToTerminal(TESTDATA_IIP[1][0]);
-      assert.deepEqual(await getOrigSize(1), TESTDATA_IIP[1][1]);
-    });
-    it('w3c gif', async () => {
-      await writeToTerminal(TESTDATA_IIP[2][0]);
-      assert.deepEqual(await getOrigSize(1), TESTDATA_IIP[2][1]);
-    });
-    it('w3c jpeg', async () => {
-      await writeToTerminal(TESTDATA_IIP[3][0]);
-      assert.deepEqual(await getOrigSize(1), TESTDATA_IIP[3][1]);
-    });
-    it('w3c png', async () => {
-      await writeToTerminal(TESTDATA_IIP[4][0]);
-      assert.deepEqual(await getOrigSize(1), TESTDATA_IIP[4][1]);
-    });
-  });
-});
-
-/**
- * terminal access helpers.
- */
-async function getDimensions(): Promise<IDimensions> {
-  const dimensions: any = await page.evaluate(`term._core._renderService.dimensions`);
-  return {
-    cellWidth: Math.round(dimensions.css.cell.width),
-    cellHeight: Math.round(dimensions.css.cell.height),
-    width: Math.round(dimensions.css.canvas.width),
-    height: Math.round(dimensions.css.canvas.height)
-  };
-}
-
-async function getCursor(): Promise<[number, number]> {
-  return page.evaluate('[window.term.buffer.active.cursorX, window.term.buffer.active.cursorY]');
-}
-
-async function getImageStorageLength(): Promise<number> {
-  return page.evaluate('window.imageAddon._storage._images.size');
-}
-
-async function getScrollbackPlusRows(): Promise<number> {
-  return page.evaluate('window.term.options.scrollback + window.term.rows');
-}
-
-async function writeToTerminal(d: string): Promise<any> {
-  return page.evaluate(data => new Promise(res => (window as any).term.write(data, res)), d);
-}
-
-async function getOrigSize(id: number): Promise<[number, number]> {
-  return page.evaluate<any>(`[
-    window.imageAddon._storage._images.get(${id}).orig.width,
-    window.imageAddon._storage._images.get(${id}).orig.height
-  ]`);
-}

addons/addon-image/test/ImageAddon.test.ts

@@ -0,0 +1,329 @@
+/**
+ * Copyright (c) 2020 The xterm.js authors. All rights reserved.
+ * @license MIT
+ */
+
+import test from '@playwright/test';
+import { readFileSync } from 'fs';
+import { FINALIZER, introducer, sixelEncode } from 'sixel';
+import { ITestContext, createTestContext, openTerminal, pollFor, timeout } from '../../../test/playwright/TestUtils';
+import { deepStrictEqual, ok, strictEqual } from 'assert';
+
+/**
+ * Plugin ctor options.
+ */
+export interface IImageAddonOptions {
+  enableSizeReports: boolean;
+  pixelLimit: number;
+  storageLimit: number;
+  showPlaceholder: boolean;
+  sixelSupport: boolean;
+  sixelScrolling: boolean;
+  sixelPaletteLimit: number;
+  sixelSizeLimit: number;
+  iipSupport: boolean;
+  iipSizeLimit: number;
+}
+
+// eslint-disable-next-line
+declare const ImageAddon: {
+  new(options?: Partial<IImageAddonOptions>): any;
+};
+
+interface ITestData {
+  width: number;
+  height: number;
+  bytes: Uint8Array;
+  palette: number[];
+  sixel: string;
+}
+
+interface IDimensions {
+  cellWidth: number;
+  cellHeight: number;
+  width: number;
+  height: number;
+}
+
+// image: 640 x 80, 512 color
+const TESTDATA: ITestData = (() => {
+  const data8 = readFileSync('./addons/addon-image/fixture/palette.blob');
+  const data32 = new Uint32Array(data8.buffer);
+  const palette = new Set<number>();
+  for (let i = 0; i < data32.length; ++i) palette.add(data32[i]);
+  const sixel = sixelEncode(data8, 640, 80, [...palette]);
+  return {
+    width: 640,
+    height: 80,
+    bytes: data8,
+    palette: [...palette],
+    sixel
+  };
+})();
+const SIXEL_SEQ_0 = introducer(0) + TESTDATA.sixel + FINALIZER;
+// const SIXEL_SEQ_1 = introducer(1) + TESTDATA.sixel + FINALIZER;
+// const SIXEL_SEQ_2 = introducer(2) + TESTDATA.sixel + FINALIZER;
+
+// NOTE: the data is loaded as string for easier transport through playwright
+const TESTDATA_IIP: [string, [number, number]][] = [
+  [readFileSync('./addons/addon-image/fixture/iip/palette.iip', { encoding: 'utf-8' }), [640, 80]],
+  [readFileSync('./addons/addon-image/fixture/iip/spinfox.iip', { encoding: 'utf-8' }), [148, 148]],
+  [readFileSync('./addons/addon-image/fixture/iip/w3c_gif.iip', { encoding: 'utf-8' }), [72, 48]],
+  [readFileSync('./addons/addon-image/fixture/iip/w3c_jpg.iip', { encoding: 'utf-8' }), [72, 48]],
+  [readFileSync('./addons/addon-image/fixture/iip/w3c_png.iip', { encoding: 'utf-8' }), [72, 48]]
+];
+
+let ctx: ITestContext;
+test.beforeAll(async ({ browser }) => {
+  ctx = await createTestContext(browser);
+  await openTerminal(ctx, { cols: 80, rows: 24 });
+});
+test.afterAll(async () => await ctx.page.close());
+
+test.describe('ImageAddon', () => {
+
+  test.beforeEach(async ({}, testInfo) => {
+    // DEBT: This test never worked on webkit
+    if (ctx.browser.browserType().name() === 'webkit') {
+      testInfo.skip();
+      return;
+    }
+    await ctx.page.evaluate(`
+      window.term.reset()
+      window.imageAddon?.dispose();
+      window.imageAddon = new ImageAddon({ sixelPaletteLimit: 512 });
+      window.term.loadAddon(window.imageAddon);
+    `);
+  });
+
+  test('test for private accessors', async () => {
+    // terminal privates
+    const accessors = [
+      '_core',
+      '_core._renderService',
+      '_core._inputHandler',
+      '_core._inputHandler._parser',
+      '_core._inputHandler._curAttrData',
+      '_core._inputHandler._dirtyRowTracker',
+      '_core._themeService.colors',
+      '_core._coreBrowserService'
+    ];
+    for (const prop of accessors) {
+      strictEqual(
+        await ctx.page.evaluate('(() => { const v = window.term.' + prop + '; return v !== undefined && v !== null; })()'),
+        true, `problem at ${prop}`
+      );
+    }
+    // bufferline privates
+    strictEqual(await ctx.page.evaluate('window.term._core.buffer.lines.get(0)._data instanceof Uint32Array'), true);
+    strictEqual(await ctx.page.evaluate('window.term._core.buffer.lines.get(0)._extendedAttrs instanceof Object'), true);
+    // inputhandler privates
+    strictEqual(await ctx.page.evaluate('window.term._core._inputHandler._curAttrData.constructor.name'), '_AttributeData');
+    strictEqual(await ctx.page.evaluate('window.term._core._inputHandler._parser.constructor.name'), 'EscapeSequenceParser');
+  });
+
+  test.describe('ctor options', () => {
+    test('empty settings should load defaults', async () => {
+      const DEFAULT_OPTIONS: IImageAddonOptions = {
+        enableSizeReports: true,
+        pixelLimit: 16777216,
+        sixelSupport: true,
+        sixelScrolling: true,
+        sixelPaletteLimit: 512,  // set to 512 to get example image working
+        sixelSizeLimit: 25000000,
+        storageLimit: 128,
+        showPlaceholder: true,
+        iipSupport: true,
+        iipSizeLimit: 20000000
+      };
+      deepStrictEqual(await ctx.page.evaluate(`window.imageAddon._opts`), DEFAULT_OPTIONS);
+    });
+    test('custom settings should overload defaults', async () => {
+      const customSettings: IImageAddonOptions = {
+        enableSizeReports: false,
+        pixelLimit: 5,
+        sixelSupport: false,
+        sixelScrolling: false,
+        sixelPaletteLimit: 1024,
+        sixelSizeLimit: 1000,
+        storageLimit: 10,
+        showPlaceholder: false,
+        iipSupport: false,
+        iipSizeLimit: 1000
+      };
+      await ctx.page.evaluate(opts => {
+        (window as any).imageAddonCustom = new ImageAddon(opts.opts);
+        (window as any).term.loadAddon((window as any).imageAddonCustom);
+      }, { opts: customSettings });
+      deepStrictEqual(await ctx.page.evaluate(`window.imageAddonCustom._opts`), customSettings);
+    });
+  });
+
+  test.describe('scrolling & cursor modes', () => {
+    test('testdata default (scrolling with VT240 cursor pos)', async () => {
+      const dim = await getDimensions();
+      await ctx.proxy.write(SIXEL_SEQ_0);
+      deepStrictEqual(await getCursor(), [0, Math.floor(TESTDATA.height/dim.cellHeight)]);
+      // moved to right by 10 cells
+      await ctx.proxy.write('#'.repeat(10) + SIXEL_SEQ_0);
+      deepStrictEqual(await getCursor(), [10, Math.floor(TESTDATA.height/dim.cellHeight) * 2]);
+    });
+    test('write testdata noScrolling', async () => {
+      await ctx.proxy.write('\x1b[?80h' + SIXEL_SEQ_0);
+      deepStrictEqual(await getCursor(), [0, 0]);
+      // second draw does not change anything
+      await ctx.proxy.write(SIXEL_SEQ_0);
+      deepStrictEqual(await getCursor(), [0, 0]);
+    });
+    test('testdata cursor always at VT240 pos', async () => {
+      const dim = await getDimensions();
+      // offset 0
+      await ctx.proxy.write(SIXEL_SEQ_0);
+      deepStrictEqual(await getCursor(), [0, Math.floor(TESTDATA.height/dim.cellHeight)]);
+      // moved to right by 10 cells
+      await ctx.proxy.write('#'.repeat(10) + SIXEL_SEQ_0);
+      deepStrictEqual(await getCursor(), [10, Math.floor(TESTDATA.height/dim.cellHeight) * 2]);
+      // moved by 30 cells (+10 prev)
+      await ctx.proxy.write('#'.repeat(30) + SIXEL_SEQ_0);
+      deepStrictEqual(await getCursor(), [10 + 30, Math.floor(TESTDATA.height/dim.cellHeight) * 3]);
+    });
+  });
+
+  test.describe('image lifecycle & eviction', () => {
+    test('delete image once scrolled off', async () => {
+      await ctx.proxy.write(SIXEL_SEQ_0);
+      pollFor(ctx.page, 'window.imageAddon._storage._images.size', 1);
+      // scroll to scrollback + rows - 1
+      await ctx.page.evaluate(
+        scrollback => new Promise(res => (window as any).term.write('\n'.repeat(scrollback), res)),
+        (await getScrollbackPlusRows() - 1)
+      );
+      // wait here, as we have to make sure, that eviction did not yet occur
+      await timeout(100);
+      pollFor(ctx.page, 'window.imageAddon._storage._images.size', 1);
+      // scroll one further should delete the image
+      await ctx.page.evaluate(() => new Promise(res => (window as any).term.write('\n', res)));
+      pollFor(ctx.page, 'window.imageAddon._storage._images.size', 0);
+    });
+    test('get storageUsage', async () => {
+      strictEqual(await ctx.page.evaluate('window.imageAddon.storageUsage'), 0);
+      await ctx.proxy.write(SIXEL_SEQ_0);
+      ok(Math.abs((await ctx.page.evaluate<number>('window.imageAddon.storageUsage')) - 640 * 80 * 4 / 1000000) < 0.05);
+    });
+    test('get/set storageLimit', async () => {
+      strictEqual(await ctx.page.evaluate('window.imageAddon.storageLimit'), 128);
+      strictEqual(await ctx.page.evaluate('window.imageAddon.storageLimit = 1'), 1);
+      strictEqual(await ctx.page.evaluate('window.imageAddon.storageLimit'), 1);
+    });
+    test('remove images by storage limit pressure', async () => {
+      strictEqual(await ctx.page.evaluate('window.imageAddon.storageLimit = 1'), 1);
+      // never go beyond storage limit
+      await ctx.proxy.write(SIXEL_SEQ_0);
+      await ctx.proxy.write(SIXEL_SEQ_0);
+      await ctx.proxy.write(SIXEL_SEQ_0);
+      await ctx.proxy.write(SIXEL_SEQ_0);
+      await timeout(100);
+      const usage = await ctx.page.evaluate('window.imageAddon.storageUsage');
+      await ctx.proxy.write(SIXEL_SEQ_0);
+      await ctx.proxy.write(SIXEL_SEQ_0);
+      await ctx.proxy.write(SIXEL_SEQ_0);
+      await ctx.proxy.write(SIXEL_SEQ_0);
+      await timeout(100);
+      strictEqual(await ctx.page.evaluate('window.imageAddon.storageUsage'), usage);
+      strictEqual(usage as number < 1, true);
+    });
+    test('set storageLimit removes images synchronously', async () => {
+      await ctx.proxy.write(SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0);
+      const usage: number = await ctx.page.evaluate('window.imageAddon.storageUsage');
+      const newUsage: number = await ctx.page.evaluate('window.imageAddon.storageLimit = 0.5; window.imageAddon.storageUsage');
+      strictEqual(newUsage < usage, true);
+      strictEqual(newUsage < 0.5, true);
+    });
+    test('clear alternate images on buffer change', async () => {
+      strictEqual(await ctx.page.evaluate('window.imageAddon.storageUsage'), 0);
+      await ctx.proxy.write('\x1b[?1049h' + SIXEL_SEQ_0);
+      ok(Math.abs((await ctx.page.evaluate<number>('window.imageAddon.storageUsage')) - 640 * 80 * 4 / 1000000) < 0.05);
+      await ctx.proxy.write('\x1b[?1049l');
+      strictEqual(await ctx.page.evaluate('window.imageAddon.storageUsage'), 0);
+    });
+    test('evict tiles by in-place overwrites (only full overwrite tested)', async () => {
+      await timeout(50);
+      await ctx.proxy.write('\x1b[H' + SIXEL_SEQ_0 + '\x1b[100;100H');
+      await timeout(50);
+      let usage = await ctx.page.evaluate('window.imageAddon.storageUsage');
+      while (usage === 0) {
+        await timeout(50);
+        usage = await ctx.page.evaluate('window.imageAddon.storageUsage');
+      }
+      await ctx.proxy.write('\x1b[H' + SIXEL_SEQ_0 + '\x1b[100;100H');
+      await timeout(200); // wait some time and re-check
+      strictEqual(await ctx.page.evaluate('window.imageAddon.storageUsage'), usage);
+    });
+    test('manual eviction on alternate buffer must not miss images', async () => {
+      await ctx.proxy.write('\x1b[?1049h');
+      await ctx.proxy.write(SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0);
+      await timeout(100);
+      const usage: number = await ctx.page.evaluate('window.imageAddon.storageUsage');
+      await ctx.proxy.write(SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0);
+      await ctx.proxy.write(SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0 + SIXEL_SEQ_0);
+      await timeout(100);
+      const newUsage: number = await ctx.page.evaluate('window.imageAddon.storageUsage');
+      strictEqual(newUsage, usage);
+    });
+  });
+
+  test.describe('IIP support - testimages', () => {
+    test('palette.png', async () => {
+      await ctx.proxy.write(TESTDATA_IIP[0][0]);
+      deepStrictEqual(await getOrigSize(1), TESTDATA_IIP[0][1]);
+    });
+    test('spinfox.png', async () => {
+      await ctx.proxy.write(TESTDATA_IIP[1][0]);
+      deepStrictEqual(await getOrigSize(1), TESTDATA_IIP[1][1]);
+    });
+    test('w3c gif', async () => {
+      await ctx.proxy.write(TESTDATA_IIP[2][0]);
+      deepStrictEqual(await getOrigSize(1), TESTDATA_IIP[2][1]);
+    });
+    test('w3c jpeg', async () => {
+      await ctx.proxy.write(TESTDATA_IIP[3][0]);
+      deepStrictEqual(await getOrigSize(1), TESTDATA_IIP[3][1]);
+    });
+    test('w3c png', async () => {
+      await ctx.proxy.write(TESTDATA_IIP[4][0]);
+      deepStrictEqual(await getOrigSize(1), TESTDATA_IIP[4][1]);
+    });
+  });
+});
+
+/**
+ * terminal access helpers.
+ */
+async function getDimensions(): Promise<IDimensions> {
+  const dimensions: any = await ctx.page.evaluate(`term.dimensions`);
+  return {
+    cellWidth: Math.round(dimensions.css.cell.width),
+    cellHeight: Math.round(dimensions.css.cell.height),
+    width: Math.round(dimensions.css.canvas.width),
+    height: Math.round(dimensions.css.canvas.height)
+  };
+}
+
+async function getCursor(): Promise<[number, number]> {
+  return ctx.page.evaluate('[window.term.buffer.active.cursorX, window.term.buffer.active.cursorY]');
+}
+
+async function getImageStorageLength(): Promise<number> {
+  return ctx.page.evaluate('window.imageAddon._storage._images.size');
+}
+
+async function getScrollbackPlusRows(): Promise<number> {
+  return ctx.page.evaluate('window.term.options.scrollback + window.term.rows');
+}
+
+async function getOrigSize(id: number): Promise<[number, number]> {
+  return ctx.page.evaluate<any>(`[
+    window.imageAddon._storage._images.get(${id}).orig.width,
+    window.imageAddon._storage._images.get(${id}).orig.height
+  ]`);
+}

addons/addon-image/test/playwright.config.ts

@@ -0,0 +1,35 @@
+import { PlaywrightTestConfig } from '@playwright/test';
+
+const config: PlaywrightTestConfig = {
+  testDir: '.',
+  timeout: 10000,
+  projects: [
+    {
+      name: 'ChromeStable',
+      use: {
+        browserName: 'chromium',
+        channel: 'chrome'
+      }
+    },
+    {
+      name: 'FirefoxStable',
+      use: {
+        browserName: 'firefox'
+      }
+    },
+    {
+      name: 'WebKit',
+      use: {
+        browserName: 'webkit'
+      }
+    }
+  ],
+  reporter: 'list',
+  webServer: {
+    command: 'npm run start',
+    port: 3000,
+    timeout: 120000,
+    reuseExistingServer: !process.env.CI
+  }
+};
+export default config;

addons/addon-image/test/tsconfig.json

@@ -1,21 +1,26 @@
 {
   "compilerOptions": {
     "module": "commonjs",
-    "target": "es2017",
+    "target": "ESNext",
+    "lib": [
+      "es2021",
+    ],
     "rootDir": ".",
     "outDir": "../out-test",
     "sourceMap": true,
     "removeComments": true,
-    "strict": true,
     "baseUrl": ".",
     "paths": {
-      "browser/*": [ "../../../src/browser/*" ],
-      "common/*": [ "../../../src/common/*" ]
+      "common/*": [
+        "../../../src/common/*"
+      ],
+      "browser/*": [
+        "../../../src/browser/*"
+      ]
     },
+    "strict": true,
     "types": [
-      "../../../node_modules/@types/mocha",
-      "../../../node_modules/@types/node",
-      "../../../out-test/api/TestUtils"
+      "../../../node_modules/@types/node"
     ]
   },
   "include": [
@@ -23,7 +28,14 @@
     "../../../typings/xterm.d.ts"
   ],
   "references": [
-    { "path": "../../../src/browser" },
-    { "path": "../../../src/common" }
+    {
+      "path": "../../../src/common"
+    },
+    {
+      "path": "../../../src/browser"
+    },
+    {
+      "path": "../../../test/playwright"
+    }
   ]
 }

addons/addon-image/webpack.config.js

@@ -26,14 +26,17 @@ const addon = {
     extensions: [ '.js' ],
     alias: {
       common: path.resolve('../../out/common'),
-      browser: path.resolve('../../out/browser')
+      browser: path.resolve('../../out/browser'),
+      vs: path.resolve('../../out/vs')
     }
   },
   output: {
     filename: mainFile,
     path: path.resolve('./lib'),
     library: addonName,
-    libraryTarget: 'umd'
+    libraryTarget: 'umd',
+    // Force usage of globalThis instead of global / self. (This is cross-env compatible)
+    globalObject: 'globalThis',
   },
   mode: 'production'
 };

addons/addon-ligatures/.gitignore

@@ -3,11 +3,9 @@ node_modules/
 coverage/
 
 lib/
-fonts/
 
 .env
 .vscode/
 *.swp
 *.tgz
 npm-debug.log*
-yarn-error.log*

addons/addon-ligatures/.npmignore

@@ -8,6 +8,9 @@
 !lib/**/*.js
 !lib/**/*.js.map
 
+!lib/**/*.mjs
+!lib/**/*.mjs.map
+
 !lib/**/*.css
 
 # Whitelist - src/

addons/addon-ligatures/LICENSE

@@ -1,6 +1,30 @@
-MIT License
-
-Copyright (c) 2018
+Copyright (c) 2019, The xterm.js authors (https://github.com/xtermjs/xterm.js)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+The code that analyzes font ligatures is forked from https://github.com/princjef/font-ligatures with this license:
+
+MIT License
+
+Copyright (c) 2018 Jeffrey Principe
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

addons/addon-ligatures/bin/download-fonts.js

@@ -1,78 +0,0 @@
-/**
- * Copyright (c) 2018 The xterm.js authors. All rights reserved.
- * @license MIT
- */
-
-const fs = require('fs');
-const path = require('path');
-const util = require('util');
-
-const axios = require('axios').default;
-const mkdirp = require('mkdirp');
-const yauzl = require('yauzl');
-
-const urls = {
-  fira: 'https://github.com/tonsky/FiraCode/raw/d42e7276fa925e5f82748f3ec9ea429736611b48/distr/otf/FiraCode-Regular.otf',
-  iosevka: 'https://github.com/be5invis/Iosevka/releases/download/v1.14.3/01-iosevka-1.14.3.zip'
-};
-
-const writeFile = util.promisify(fs.writeFile);
-const fontsFolder = path.join(__dirname, '../fonts');
-
-async function download() {
-  await mkdirp(fontsFolder);
-
-  try {
-    await downloadFiraCode();
-    await downloadIosevka();
-    console.log('Loaded all fonts for testing')
-  } catch (e) {
-    console.warn('Fonts failed to download, ligature tests will not work', e);
-  }
-}
-
-async function downloadFiraCode() {
-  const file = path.join(fontsFolder, 'firaCode.otf');
-  if (await util.promisify(fs.exists)(file)) {
-    console.log('Fira Code already loaded');
-  } else {
-    console.log('Downloading Fira Code...');
-    await writeFile(
-      file,
-      (await axios.get(urls.fira, { responseType: 'arraybuffer' })).data
-    );
-  }
-}
-
-async function downloadIosevka() {
-  const file = path.join(fontsFolder, 'iosevka.ttf');
-  if (await util.promisify(fs.exists)(file)) {
-    console.log('Iosevka already loaded');
-  } else {
-    console.log('Downloading Iosevka...');
-    const iosevkaContents = (await axios.get(urls.iosevka, { responseType: 'arraybuffer' })).data;
-    const iosevkaZipfile = await util.promisify(yauzl.fromBuffer)(iosevkaContents);
-    await new Promise((resolve, reject) => {
-      iosevkaZipfile.on('entry', entry => {
-        if (entry.fileName === 'ttf/iosevka-regular.ttf') {
-          iosevkaZipfile.openReadStream(entry, (err, stream) => {
-            if (err) {
-              return reject(err);
-            }
-
-            const writeStream = fs.createWriteStream(file);
-            stream.pipe(writeStream);
-            writeStream.on('close', () => resolve());
-          });
-        }
-      });
-    });
-  }
-}
-
-download();
-
-process.on('unhandledRejection', e => {
-  console.error(e);
-  process.exit(1);
-});

addons/addon-ligatures/package.json

@@ -1,19 +1,19 @@
 {
   "name": "@xterm/addon-ligatures",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "Add support for programming ligatures to xterm.js",
   "author": {
     "name": "The xterm.js authors",
     "url": "https://xtermjs.org/"
   },
   "main": "lib/addon-ligatures.js",
+  "module": "lib/addon-ligatures.mjs",
   "types": "typings/addon-ligatures.d.ts",
   "repository": "https://github.com/xtermjs/xterm.js/tree/master/addons/addon-ligatures",
   "engines": {
     "node": ">8.0.0"
   },
   "scripts": {
-    "prepare": "node bin/download-fonts.js",
     "build": "tsc -p src",
     "watch": "tsc -w -p src",
     "prepackage": "npm run build",
@@ -31,17 +31,15 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "font-finder": "^1.1.0",
-    "font-ligatures": "^1.4.1"
+    "lru-cache": "^6.0.0",
+    "opentype.js": "^0.8.0"
   },
   "devDependencies": {
-    "@types/sinon": "^5.0.1",
+    "@types/lru-cache": "^5.1.0",
+    "@types/opentype.js": "^0.7.0",
     "axios": "^1.6.0",
+    "font-finder": "^1.1.0",
     "mkdirp": "0.5.5",
-    "sinon": "6.3.5",
     "yauzl": "^2.10.0"
-  },
-  "peerDependencies": {
-    "@xterm/xterm": "^5.0.0"
   }
 }

addons/addon-ligatures/src/LigaturesAddon.ts

@@ -15,24 +15,31 @@ export interface ITerminalAddon {
 
 export class LigaturesAddon implements ITerminalAddon , ILigaturesApi {
   private readonly _fallbackLigatures: string[];
+  private readonly _fontFeatureSettings?: string;
 
   private _terminal: Terminal | undefined;
   private _characterJoinerId: number | undefined;
 
   constructor(options?: Partial<ILigatureOptions>) {
+    // Source: calt set from https://github.com/be5invis/Iosevka?tab=readme-ov-file#ligations
     this._fallbackLigatures = (options?.fallbackLigatures || [
       '<--', '<---', '<<-', '<-', '->', '->>', '-->', '--->',
       '<==', '<===', '<<=', '<=', '=>', '=>>', '==>', '===>', '>=', '>>=',
-      '<->', '<-->', '<--->', '<---->', '<=>', '<==>', '<===>', '<====>', '-------->',
-      '<~~', '<~', '~>', '~~>', '::', ':::', '==', '!=', '===', '!==',
-      ':=', ':-', ':+', '<*', '<*>', '*>', '<|', '<|>', '|>', '+:', '-:', '=:', ':>',
-      '++', '+++', '<!--', '<!---', '<***>'
+      '<->', '<-->', '<--->', '<---->', '<=>', '<==>', '<===>', '<====>', '::', ':::',
+      '<~~', '</', '</>', '/>', '~~>', '==', '!=', '/=', '~=', '<>', '===', '!==', '!===',
+      '<:', ':=', '*=', '*+', '<*', '<*>', '*>', '<|', '<|>', '|>', '+*', '=*', '=:', ':>',
+      '/*', '*/', '+++', '<!--', '<!---'
     ]).sort((a, b) => b.length - a.length);
+    this._fontFeatureSettings = options?.fontFeatureSettings;
   }
 
   public activate(terminal: Terminal): void {
+    if (!terminal.element) {
+      throw new Error('Cannot activate LigaturesAddon before open is called');
+    }
     this._terminal = terminal;
     this._characterJoinerId = enableLigatures(terminal, this._fallbackLigatures);
+    terminal.element.style.fontFeatureSettings = this._fontFeatureSettings ?? '"calt" on';
   }
 
   public dispose(): void {
@@ -40,5 +47,8 @@ export class LigaturesAddon implements ITerminalAddon , ILigaturesApi {
       this._terminal?.deregisterCharacterJoiner(this._characterJoinerId);
       this._characterJoinerId = undefined;
     }
+    if (this._terminal?.element) {
+      this._terminal.element.style.fontFeatureSettings = '';
+    }
   }
 }

addons/addon-ligatures/src/Types.ts

@@ -5,4 +5,5 @@
 
 export interface ILigatureOptions {
   fallbackLigatures: string[];
+  fontFeatureSettings: string;
 }

addons/addon-ligatures/src/font.ts

@@ -3,7 +3,7 @@
  * @license MIT
  */
 
-import { Font, loadBuffer } from 'font-ligatures';
+import { Font, loadBuffer } from './fontLigatures/index';
 
 import parse from './parse';
 

addons/addon-ligatures/src/fontLigatures/flatten.ts

@@ -0,0 +1,40 @@
+import { ILookupTree, IFlattenedLookupTree, ILookupTreeEntry, IFlattenedLookupTreeEntry } from './types';
+
+export default function flatten(tree: ILookupTree, visited: Map<ILookupTreeEntry, IFlattenedLookupTreeEntry> = new Map()): IFlattenedLookupTree {
+  const result: IFlattenedLookupTree = {};
+  for (const [glyphId, entry] of Object.entries(tree.individual)) {
+    result[glyphId] = flattenEntry(entry, visited);
+  }
+
+  for (const { range, entry } of tree.range) {
+    const flattened = flattenEntry(entry, visited);
+    for (let glyphId = range[0]; glyphId < range[1]; glyphId++) {
+      result[glyphId] = flattened;
+    }
+  }
+
+  return result;
+}
+
+function flattenEntry(entry: ILookupTreeEntry, visited: Map<ILookupTreeEntry, IFlattenedLookupTreeEntry>): IFlattenedLookupTreeEntry {
+  if (visited.has(entry)) {
+    return visited.get(entry)!;
+  }
+
+  const result: IFlattenedLookupTreeEntry = {};
+  visited.set(entry, result);
+
+  if (entry.forward) {
+    result.forward = flatten(entry.forward, visited);
+  }
+
+  if (entry.reverse) {
+    result.reverse = flatten(entry.reverse, visited);
+  }
+
+  if (entry.lookup) {
+    result.lookup = entry.lookup;
+  }
+
+  return result;
+}

addons/addon-ligatures/src/fontLigatures/index.test.ts

@@ -0,0 +1,358 @@
+/**
+ * Copyright (c) 2018 The xterm.js authors. All rights reserved.
+ * @license MIT
+ */
+
+import * as path from 'path';
+import * as fs from 'fs';
+import { assert } from 'chai';
+import { loadBuffer } from './index';
+
+interface IFont {
+  findLigatures(text: string): { outputGlyphs: number[], contextRanges: [number, number][] };
+  findLigatureRanges(text: string): [number, number][];
+}
+
+interface ITestCase {
+  font: string;
+  input: string;
+  glyphs: number[];
+  ranges: [number, number][];
+}
+
+const fira = (input: string, glyphs: number[], ranges: [number, number][]): ITestCase =>
+  ({ font: 'Fira Code', input, glyphs, ranges });
+
+const iosevka = (input: string, glyphs: number[], ranges: [number, number][]): ITestCase =>
+  ({ font: 'Iosevka', input, glyphs, ranges });
+
+const monoid = (input: string, glyphs: number[], ranges: [number, number][]): ITestCase =>
+  ({ font: 'Monoid', input, glyphs, ranges });
+
+const ubuntu = (input: string, glyphs: number[], ranges: [number, number][]): ITestCase =>
+  ({ font: 'Ubuntu Mono', input, glyphs, ranges });
+
+const firaCases: ITestCase[] = [
+  fira('abc', [133, 145, 146], []),
+  fira('.=', [1614, 1081], [[0, 2]]),
+  fira('..=', [1614, 1614, 1083], [[0, 3]]),
+  fira('.-', [1614, 1080], [[0, 2]]),
+  fira(':=', [1614, 1055], [[0, 2]]),
+  fira('=:=', [1614, 1614, 1483], [[0, 3]]),
+  fira('=!=', [1614, 1614, 1484], [[0, 3]]),
+  fira('__', [1614, 1099], [[0, 2]]),
+  fira('==', [1614, 1485], [[0, 2]]),
+  fira('!=', [1614, 1058], [[0, 2]]),
+  fira('===', [1614, 1614, 1486], [[0, 3]]),
+  fira('!==', [1614, 1614, 1059], [[0, 3]]),
+  fira('=/=', [1614, 1614, 1491], [[0, 3]]),
+  fira('<-<', [1614, 1614, 1513], [[0, 3]]),
+  fira('<<-', [1614, 1614, 1522], [[0, 3]]),
+  fira('<--', [1614, 1614, 1511], [[0, 3]]),
+  fira('<-', [1614, 1510], [[0, 2]]),
+  fira('<->', [1614, 1614, 1512], [[0, 3]]),
+  fira('->', [1614, 1064], [[0, 2]]),
+  fira('-->', [1614, 1614, 1063], [[0, 3]]),
+  fira('->>', [1614, 1614, 1065], [[0, 3]]),
+  fira('>->', [1614, 1614, 1493], [[0, 3]]),
+  fira('<=<', [1614, 1614, 1519], [[0, 3]]),
+  fira('<<=', [1614, 1614, 1523], [[0, 3]]),
+  fira('<==', [1614, 1614, 1517], [[0, 3]]),
+  fira('<=>', [1614, 1614, 1518], [[0, 3]]),
+  fira('=>', [1614, 1488], [[0, 2]]),
+  fira('==>', [1614, 1614, 1487], [[0, 3]]),
+  fira('=>>', [1614, 1614, 1489], [[0, 3]]),
+  fira('>=>', [1614, 1614, 1495], [[0, 3]]),
+  fira('>>=', [1614, 1614, 1498], [[0, 3]]),
+  fira('>>-', [1614, 1614, 1497], [[0, 3]]),
+  fira('>-', [1614, 1492], [[0, 2]]),
+  fira('<~>', [1614, 1614, 1526], [[0, 3]]),
+  fira('-<', [1614, 1066], [[0, 2]]),
+  fira('-<<', [1614, 1614, 1067], [[0, 3]]),
+  fira('=<<', [1614, 1614, 1490], [[0, 3]]),
+  fira('<~~', [1614, 1614, 1527], [[0, 3]]),
+  fira('<~', [1614, 1525], [[0, 2]]),
+  fira('~~', [1614, 1534], [[0, 2]]),
+  fira('~>', [1614, 1533], [[0, 2]]),
+  fira('~~>', [1614, 1614, 1535], [[0, 3]]),
+  fira('<<<', [1614, 1614, 1524], [[0, 3]]),
+  fira('<<', [1614, 1521], [[0, 2]]),
+  fira('<=', [1614, 1516], [[0, 2]]),
+  fira('<>', [1614, 1520], [[0, 2]]),
+  fira('>=', [1614, 1494], [[0, 2]]),
+  fira('>>', [1614, 1496], [[0, 2]]),
+  fira('>>>', [1614, 1614, 1499], [[0, 3]]),
+  fira('{.', [1001, 977], [[0, 2]]),
+  fira('{|', [1614, 1049], [[0, 2]]),
+  fira('[|', [1614, 1050], [[0, 2]]),
+  fira('<:', [1614, 1506], [[0, 2]]),
+  fira(':>', [1614, 1056], [[0, 2]]),
+  fira('|]', [1614, 1474], [[0, 2]]),
+  fira('|}', [1614, 1473], [[0, 2]]),
+  fira('.}', [977, 1002], [[0, 2]]),
+  fira('<|||', [1614, 1614, 1614, 1504], [[0, 4]]),
+  fira('<||', [1614, 1614, 1503], [[0, 3]]),
+  fira('<|', [1614, 1502], [[0, 2]]),
+  fira('<|>', [1614, 1614, 1505], [[0, 3]]),
+  fira('|>', [1614, 1477], [[0, 2]]),
+  fira('||>', [1614, 1614, 1472], [[0, 3]]),
+  fira('|||>', [1614, 1614, 1614, 1470], [[0, 4]]),
+  fira('<$', [1614, 1507], [[0, 2]]),
+  fira('<$>', [1614, 1614, 1508], [[0, 3]]),
+  fira('$>', [1614, 1479], [[0, 2]]),
+  fira('<+', [1614, 1514], [[0, 2]]),
+  fira('<+>', [1614, 1614, 1515], [[0, 3]]),
+  fira('+>', [1614, 1482], [[0, 2]]),
+  fira('<*', [1614, 1500], [[0, 2]]),
+  fira('<*>', [1614, 1614, 1501], [[0, 3]]),
+  fira('*>', [1614, 1047], [[0, 2]]),
+  fira('/*', [1614, 1092], [[0, 2]]),
+  fira('*/', [1614, 1048], [[0, 2]]),
+  fira('///', [1614, 1614, 1097], [[0, 3]]),
+  fira('//', [1614, 1096], [[0, 2]]),
+  fira('</', [1614, 1528], [[0, 2]]),
+  fira('<!--', [1614, 1614, 1614, 1509], [[0, 4]]),
+  fira('</>', [1614, 1614, 1529], [[0, 3]]),
+  fira('/>', [1614, 1095], [[0, 2]]),
+  fira('0xff', [895, 270, 166, 166], [[0, 3]]),
+  fira('10x10', [896, 895, 270, 896, 895], [[1, 4]]),
+  fira('9:45', [904, 998, 899, 900], [[0, 2]]),
+  fira('[:]', [1003, 998, 1004], [[0, 2]]),
+  fira(';;', [1614, 1091], [[0, 2]]),
+  fira('::', [1614, 1052], [[0, 2]]),
+  fira(':::', [1614, 1614, 1053], [[0, 3]]),
+  fira('..', [1614, 1082], [[0, 2]]),
+  fira('...', [1614, 1614, 1085], [[0, 3]]),
+  fira('..<', [1614, 1614, 1084], [[0, 3]]),
+  fira('!!', [1614, 1057], [[0, 2]]),
+  fira('??', [1614, 1090], [[0, 2]]),
+  fira('%%', [1614, 1536], [[0, 2]]),
+  fira('&&', [1614, 1468], [[0, 2]]),
+  fira('||', [1614, 1469], [[0, 2]]),
+  fira('?.', [1614, 1089], [[0, 2]]),
+  fira('?:', [1614, 1087], [[0, 2]]),
+  fira('++', [1614, 1480], [[0, 2]]),
+  fira('+++', [1614, 1614, 1481], [[0, 3]]),
+  fira('--', [1614, 1061], [[0, 2]]),
+  fira('---', [1614, 1614, 1062], [[0, 3]]),
+  fira('**', [1614, 1045], [[0, 2]]),
+  fira('***', [1614, 1614, 1046], [[0, 3]]),
+  fira('~=', [1614, 1532], [[0, 2]]),
+  fira('~-', [1614, 1531], [[0, 2]]),
+  fira('www', [1614, 1614, 271], [[0, 3]]),
+  fira('-~', [1614, 1068], [[0, 2]]),
+  fira('~@', [1614, 1530], [[0, 2]]),
+  fira('^=', [1614, 1478], [[0, 2]]),
+  fira('?=', [1614, 1088], [[0, 2]]),
+  fira('/=', [1614, 1093], [[0, 2]]),
+  fira('/==', [1614, 1614, 1094], [[0, 3]]),
+  fira('-|', [1614, 1060], [[0, 2]]),
+  fira('_|_', [1614, 1614, 1098], [[0, 3]]),
+  fira('|-', [1614, 1475], [[0, 2]]),
+  fira('|=', [1614, 1476], [[0, 2]]),
+  fira('||=', [1614, 1614, 1471], [[0, 3]]),
+  fira('#!', [1614, 1071], [[0, 2]]),
+  fira('#=', [1614, 1075], [[0, 2]]),
+  fira('##', [1614, 1072], [[0, 2]]),
+  fira('###', [1614, 1614, 1073], [[0, 3]]),
+  fira('####', [1614, 1614, 1614, 1074], [[0, 4]]),
+  fira('#{', [1614, 1069], [[0, 2]]),
+  fira('#[', [1614, 1070], [[0, 2]]),
+  fira(']#', [1614, 1051], [[0, 2]]),
+  fira('#(', [1614, 1076], [[0, 2]]),
+  fira('#?', [1614, 1077], [[0, 2]]),
+  fira('#_', [1614, 1078], [[0, 2]]),
+  fira('#_(', [1614, 1614, 1079], [[0, 3]]),
+  fira('::=', [1614, 1614, 1054], [[0, 3]]),
+  fira('.?', [1614, 1086], [[0, 2]]),
+  fira('===>', [1614, 1614, 1486, 1148], [[0, 4]])
+];
+
+const iosevkaCases: ITestCase[] = [
+  iosevka('<-', [31, 3127], [[0, 2]]),
+  iosevka('<--', [31, 3129, 3139], [[0, 3]]),
+  iosevka('<---', [31, 3129, 3150, 3139], [[0, 4]]),
+  iosevka('<-----', [31, 3129, 3150, 3139, 3151, 3151], [[0, 6]]),
+  iosevka('->', [3126, 33], [[0, 2]]),
+  iosevka('-->', [3140, 3128, 33], [[0, 3]]),
+  iosevka('--->', [3140, 3150, 3128, 33], [[0, 4]]),
+  iosevka('----->', [3153, 3153, 3140, 3150, 3128, 33], [[0, 6]]),
+  iosevka('<->', [31, 3149, 33], [[0, 3]]),
+  iosevka('<-->', [31, 3129, 3128, 33], [[0, 4]]),
+  iosevka('<--->', [31, 3129, 3150, 3128, 33], [[0, 5]]),
+  iosevka('<----->', [31, 3129, 3150, 3150, 3150, 3128, 33], [[0, 7]]),
+  iosevka('<=', [3094, 3095], [[0, 2]]),
+  iosevka('<==', [31, 3158, 3168], [[0, 3]]),
+  iosevka('<===', [31, 3158, 3179, 3168], [[0, 4]]),
+  iosevka('<=====', [31, 3158, 3179, 3168, 3180, 3180], [[0, 6]]),
+  iosevka('=>', [3155, 33], [[0, 2]]),
+  iosevka('==>', [3169, 3157, 33], [[0, 3]]),
+  iosevka('===>', [3169, 3179, 3157, 33], [[0, 4]]),
+  iosevka('=====>', [3182, 3182, 3169, 3179, 3157, 33], [[0, 6]]),
+  iosevka('<=>', [31, 3178, 33], [[0, 3]]),
+  iosevka('<==>', [31, 3158, 3157, 33], [[0, 4]]),
+  iosevka('<===>', [31, 3158, 3179, 3157, 33], [[0, 5]]),
+  iosevka('<=====>', [31, 3158, 3179, 3179, 3179, 3157, 33], [[0, 7]]),
+  iosevka('<!--', [31, 3184, 3130, 3139], [[0, 4]]),
+  iosevka('<!---', [31, 3184, 3130, 3150, 3139], [[0, 5]]),
+  iosevka('<!-----', [31, 3184, 3130, 3150, 3139, 3151, 3151], [[0, 7]]),
+  iosevka('a:b', [68, 29, 69], []),
+  iosevka('a::b', [68, 3012, 3013, 69], [[1, 3]]),
+  iosevka('a:::b', [68, 3012, 3010, 3013, 69], [[1, 4]]),
+  iosevka(':=', [3011, 32], [[0, 2]]),
+  iosevka(':-', [3011, 16], [[0, 2]]),
+  iosevka(':+', [3011, 14], [[0, 2]]),
+  iosevka('=:', [32, 3011], [[0, 2]]),
+  iosevka('-:', [16, 3011], [[0, 2]]),
+  iosevka('+:', [14, 3011], [[0, 2]]),
+  iosevka('<*', [31, 3023], [[0, 2]]),
+  iosevka('*>', [3023, 33], [[0, 2]]),
+  iosevka('<*>', [31, 3023, 33], [[1, 3]]),
+  iosevka('<**>', [31, 3023, 3023, 33], [[1, 4]]),
+  iosevka('<****>', [31, 3023, 3023, 3023, 3023, 33], [[0, 3], [3, 6]]),
+  iosevka('==', [3083, 3084], [[0, 2]]),
+  iosevka('!=', [3098, 3084], [[0, 2]]),
+  iosevka('===', [3083, 3085, 3084], [[0, 3]]),
+  iosevka('!==', [3099, 3085, 3084], [[0, 3]]),
+  iosevka('====', [3083, 3085, 3085, 3084], [[0, 4]]),
+  iosevka('!===', [3100, 3085, 3085, 3084], [[0, 4]])
+];
+
+const monoidCases: ITestCase[] = [
+  monoid('<!--', [775, 775, 775, 643], [[0, 4]]),
+  monoid('-->', [779, 779, 628], [[0, 3]]),
+  monoid('<--', [776, 776, 627], [[0, 3]]),
+  monoid('->>', [780, 780, 626], [[0, 3]]),
+  monoid('<<-', [777, 777, 625], [[0, 3]]),
+  monoid('->', [781, 623], [[0, 2]]),
+  monoid('<-', [778, 624], [[0, 2]]),
+  monoid('=>', [793, 666], [[0, 2]]),
+  monoid('<=>', [785, 785, 760], [[0, 3]]),
+  monoid('<==>', [786, 786, 786, 771], [[0, 4]]),
+  monoid('==>', [787, 787, 672], [[0, 3]]),
+  monoid('<==', [788, 788, 671], [[0, 3]]),
+  monoid('>>=', [791, 791, 758], [[0, 3]]),
+  monoid('=<<', [792, 792, 759], [[0, 3]]),
+  monoid('--', [667, 667], [[0, 2]]),
+  monoid(':=', [29, 761], [[0, 2]]),
+  monoid('=:=', [789, 789, 665], [[0, 3]]),
+  monoid('==', [794, 641], [[0, 2]]),
+  monoid('!==', [782, 782, 646], [[0, 3]]),
+  monoid('!=', [783, 629], [[0, 2]]),
+  monoid('<=', [790, 630], [[0, 2]]),
+  monoid('>=', [792, 631], [[0, 2]]),
+  monoid('//', [621, 664], [[0, 2]]),
+  monoid('/**', [18, 753, 753], [[0, 3]]),
+  monoid('/*', [18, 753], [[0, 2]]),
+  monoid('*/', [754, 18], [[0, 2]]),
+  monoid('&&', [633, 775], [[0, 2]]),
+  monoid('.&', [17, 755], [[0, 2]]),
+  monoid('||', [634, 635], [[0, 2]]),
+  monoid('!!', [769, 770], [[0, 2]]),
+  monoid('::', [772, 773], [[0, 2]]),
+  monoid('>>', [637, 638], [[0, 2]]),
+  monoid('<<', [639, 640], [[0, 2]]),
+  monoid('¯\\_(ツ)_/¯', [113, 765, 66, 767, 613, 768, 66, 766, 113], [[0, 3], [3, 6], [6, 9]]),
+  monoid('__', [763, 764], [[0, 2]])
+];
+
+const ubuntuCases: ITestCase[] = [
+  ubuntu('==>', [32, 32, 33], [])
+];
+
+const fontPaths: Record<string, string> = {
+  'Fira Code': path.join(__dirname, '../../fonts/FiraCode-Regular.otf'),
+  'Iosevka': path.join(__dirname, '../../fonts/iosevka-regular.ttf'),
+  'Monoid': path.join(__dirname, '../../fonts/Monoid-Regular.ttf'),
+  'Ubuntu Mono': path.join(__dirname, '../../fonts/UbuntuMono-Regular.ttf')
+};
+
+const fontCache: Map<string, IFont> = new Map();
+
+function loadFont(fontName: string): IFont {
+  let font = fontCache.get(fontName);
+  if (!font) {
+    const fontPath = fontPaths[fontName];
+    const buffer = fs.readFileSync(fontPath);
+    font = loadBuffer(buffer.buffer.slice(buffer.byteOffset, buffer.byteOffset + buffer.byteLength));
+    fontCache.set(fontName, font);
+  }
+  return font;
+}
+
+describe('addon-ligatures - index', () => {
+  describe('findLigatures', () => {
+    for (const { font: fontName, input, glyphs, ranges } of [...firaCases, ...iosevkaCases, ...monoidCases, ...ubuntuCases]) {
+      it(`${fontName}: '${input}'`, () => {
+        const font = loadFont(fontName);
+        const result = font.findLigatures(input);
+        assert.deepEqual(result.outputGlyphs, glyphs);
+        assert.deepEqual(result.contextRanges, ranges);
+      });
+    }
+  });
+
+  describe('findLigatureRanges', () => {
+    for (const { font: fontName, input, ranges } of [...firaCases, ...iosevkaCases, ...monoidCases, ...ubuntuCases]) {
+      it(`${fontName}: '${input}'`, () => {
+        const font = loadFont(fontName);
+        const result = font.findLigatureRanges(input);
+        assert.deepEqual(result, ranges);
+      });
+    }
+  });
+
+  describe('caching', () => {
+    it('findLigatures caches successive calls correctly', () => {
+      const fontPath = fontPaths['Fira Code'];
+      const buffer = fs.readFileSync(fontPath);
+      const font = loadBuffer(buffer.buffer.slice(buffer.byteOffset, buffer.byteOffset + buffer.byteLength), { cacheSize: 100 });
+      const result1 = font.findLigatures('in --> out');
+      const result2 = font.findLigatures('in --> out');
+      assert.deepEqual(result1, result2);
+    });
+
+    it('findLigatureRanges caches successive calls correctly', () => {
+      const fontPath = fontPaths['Fira Code'];
+      const buffer = fs.readFileSync(fontPath);
+      const font = loadBuffer(buffer.buffer.slice(buffer.byteOffset, buffer.byteOffset + buffer.byteLength), { cacheSize: 100 });
+      const result1 = font.findLigatureRanges('in --> out');
+      const result2 = font.findLigatureRanges('in --> out');
+      assert.deepEqual(result1, result2);
+    });
+
+    it('caches calls to findLigatures after findLigatureRanges correctly', () => {
+      const fontPath = fontPaths['Fira Code'];
+      const buffer = fs.readFileSync(fontPath);
+
+      const uncached = loadBuffer(buffer.buffer.slice(buffer.byteOffset, buffer.byteOffset + buffer.byteLength));
+      const uncachedResult1 = uncached.findLigatureRanges('in --> out');
+      const uncachedResult2 = uncached.findLigatures('in --> out');
+
+      const font = loadBuffer(buffer.buffer.slice(buffer.byteOffset, buffer.byteOffset + buffer.byteLength), { cacheSize: 100 });
+      const result1 = font.findLigatureRanges('in --> out');
+      const result2 = font.findLigatures('in --> out');
+
+      assert.deepEqual(result1, uncachedResult1);
+      assert.deepEqual(result2, uncachedResult2);
+      assert.deepEqual(result1, result2.contextRanges);
+    });
+
+    it('caches calls to findLigatureRanges after findLigatures correctly', () => {
+      const fontPath = fontPaths['Fira Code'];
+      const buffer = fs.readFileSync(fontPath);
+
+      const uncached = loadBuffer(buffer.buffer.slice(buffer.byteOffset, buffer.byteOffset + buffer.byteLength));
+      const uncachedResult1 = uncached.findLigatures('in --> out');
+      const uncachedResult2 = uncached.findLigatureRanges('in --> out');
+
+      const font = loadBuffer(buffer.buffer.slice(buffer.byteOffset, buffer.byteOffset + buffer.byteLength), { cacheSize: 100 });
+      const result1 = font.findLigatures('in --> out');
+      const result2 = font.findLigatureRanges('in --> out');
+
+      assert.deepEqual(result1, uncachedResult1);
+      assert.deepEqual(result2, uncachedResult2);
+      assert.deepEqual(result1.contextRanges, result2);
+    });
+  });
+});

addons/addon-ligatures/src/fontLigatures/index.ts

@@ -0,0 +1,262 @@
+import * as opentype from 'opentype.js';
+import LRUCache = require('lru-cache');
+
+import { IFont, ILigatureData, IFlattenedLookupTree, ILookupTree, IOptions } from './types';
+import mergeTrees from './merge';
+import walkTree from './walk';
+import mergeRange from './mergeRange';
+
+import buildTreeGsubType6Format1 from './processors/6-1';
+import buildTreeGsubType6Format2 from './processors/6-2';
+import buildTreeGsubType6Format3 from './processors/6-3';
+import buildTreeGsubType8Format1 from './processors/8-1';
+import flatten from './flatten';
+
+class FontImpl implements IFont {
+  private _font: opentype.Font;
+  private _lookupTrees: { tree: IFlattenedLookupTree, processForward: boolean }[] = [];
+  private _glyphLookups: { [glyphId: string]: number[] } = {};
+  private _cache?: LRUCache<string, ILigatureData | [number, number][]>;
+
+  constructor(font: opentype.Font, options: Required<IOptions>) {
+    this._font = font;
+
+    if (options.cacheSize > 0) {
+      this._cache = new LRUCache({
+        max: options.cacheSize,
+        length: ((val: ILigatureData | [number, number][], key: string) => key.length) as any
+      });
+    }
+
+    const caltFeatures = this._font.tables.gsub && this._font.tables.gsub.features.filter((f: { tag: string }) => f.tag === 'calt') || [];
+    const lookupIndices: number[] = caltFeatures
+      .reduce((acc: number[], val: { feature: { lookupListIndexes: number[] } }) => [...acc, ...val.feature.lookupListIndexes], []);
+
+    const allLookups = this._font.tables.gsub && this._font.tables.gsub.lookups || [];
+    const lookupGroups = allLookups.filter((l: unknown, i: number) => lookupIndices.some(idx => idx === i));
+
+    for (const [index, lookup] of lookupGroups.entries()) {
+      const trees: ILookupTree[] = [];
+      switch (lookup.lookupType) {
+        case 6:
+          for (const [index, table] of lookup.subtables.entries()) {
+            switch (table.substFormat) {
+              case 1:
+                trees.push(buildTreeGsubType6Format1(table, allLookups, index));
+                break;
+              case 2:
+                trees.push(buildTreeGsubType6Format2(table, allLookups, index));
+                break;
+              case 3:
+                trees.push(buildTreeGsubType6Format3(table, allLookups, index));
+                break;
+            }
+          }
+          break;
+        case 8:
+          for (const [index, table] of lookup.subtables.entries()) {
+            trees.push(buildTreeGsubType8Format1(table, index));
+          }
+          break;
+      }
+
+      const tree = flatten(mergeTrees(trees));
+
+      this._lookupTrees.push({
+        tree,
+        processForward: lookup.lookupType !== 8
+      });
+
+      for (const glyphId of Object.keys(tree)) {
+        if (!this._glyphLookups[glyphId]) {
+          this._glyphLookups[glyphId] = [];
+        }
+
+        this._glyphLookups[glyphId].push(index);
+      }
+    }
+  }
+
+  public findLigatures(text: string): ILigatureData {
+    const cached = this._cache && this._cache.get(text);
+    if (cached && !Array.isArray(cached)) {
+      return cached;
+    }
+
+    const glyphIds: number[] = [];
+    for (const char of text) {
+      glyphIds.push(this._font.charToGlyphIndex(char));
+    }
+
+    // If there are no lookup groups, there's no point looking for
+    // replacements. This gives us a minor performance boost for fonts with
+    // no ligatures
+    if (this._lookupTrees.length === 0) {
+      return {
+        inputGlyphs: glyphIds,
+        outputGlyphs: glyphIds,
+        contextRanges: []
+      };
+    }
+
+    const result = this._findInternal(glyphIds.slice());
+    const finalResult: ILigatureData = {
+      inputGlyphs: glyphIds,
+      outputGlyphs: result.sequence,
+      contextRanges: result.ranges
+    };
+    if (this._cache) {
+      this._cache.set(text, finalResult);
+    }
+
+    return finalResult;
+  }
+
+  public findLigatureRanges(text: string): [number, number][] {
+    // Short circuit the process if there are no possible ligatures in the
+    // font
+    if (this._lookupTrees.length === 0) {
+      return [];
+    }
+
+    const cached = this._cache && this._cache.get(text);
+    if (cached) {
+      return Array.isArray(cached) ? cached : cached.contextRanges;
+    }
+
+    const glyphIds: number[] = [];
+    for (const char of text) {
+      glyphIds.push(this._font.charToGlyphIndex(char));
+    }
+
+    const result = this._findInternal(glyphIds);
+    if (this._cache) {
+      this._cache.set(text, result.ranges);
+    }
+
+    return result.ranges;
+  }
+
+  private _findInternal(sequence: number[]): { sequence: number[], ranges: [number, number][] } {
+    const ranges: [number, number][] = [];
+
+    let nextLookup = this._getNextLookup(sequence, 0);
+    while (nextLookup.index !== null) {
+      const lookup = this._lookupTrees[nextLookup.index];
+      if (lookup.processForward) {
+        let lastGlyphIndex = nextLookup.last;
+        for (let i = nextLookup.first; i < lastGlyphIndex; i++) {
+          const result = walkTree(lookup.tree, sequence, i, i);
+          if (result) {
+            for (let j = 0; j < result.substitutions.length; j++) {
+              const sub = result.substitutions[j];
+              if (sub !== null) {
+                sequence[i + j] = sub;
+              }
+            }
+
+            mergeRange(
+              ranges,
+              result.contextRange[0] + i,
+              result.contextRange[1] + i
+            );
+
+            // Substitutions can end up extending the search range
+            if (i + result.length >= lastGlyphIndex) {
+              lastGlyphIndex = i + result.length + 1;
+            }
+
+            i += result.length - 1;
+          }
+        }
+      } else {
+        // We don't need to do the lastGlyphIndex tracking here because
+        // reverse processing isn't allowed to replace more than one
+        // character at a time.
+        for (let i = nextLookup.last - 1; i >= nextLookup.first; i--) {
+          const result = walkTree(lookup.tree, sequence, i, i);
+          if (result) {
+            for (let j = 0; j < result.substitutions.length; j++) {
+              const sub = result.substitutions[j];
+              if (sub !== null) {
+                sequence[i + j] = sub;
+              }
+            }
+
+            mergeRange(
+              ranges,
+              result.contextRange[0] + i,
+              result.contextRange[1] + i
+            );
+
+            i -= result.length - 1;
+          }
+        }
+      }
+
+      nextLookup = this._getNextLookup(sequence, nextLookup.index + 1);
+    }
+
+    return { sequence, ranges };
+  }
+
+  /**
+   * Returns the lookup and glyph range for the first lookup that might
+   * contain a match.
+   *
+   * @param sequence Input glyph sequence
+   * @param start The first input to try
+   */
+  private _getNextLookup(sequence: number[], start: number): { index: number | null, first: number, last: number } {
+    const result: { index: number | null, first: number, last: number } = {
+      index: null,
+      first: Infinity,
+      last: -1
+    };
+
+    // Loop through each glyph and find the first valid lookup for it
+    for (let i = 0; i < sequence.length; i++) {
+      const lookups = this._glyphLookups[sequence[i]];
+      if (!lookups) {
+        continue;
+      }
+
+      for (let j = 0; j < lookups.length; j++) {
+        const lookupIndex = lookups[j];
+        if (lookupIndex >= start) {
+          // Update the lookup information if it's the one we're
+          // storing or earlier than it.
+          if (result.index === null || lookupIndex <= result.index) {
+            result.index = lookupIndex;
+
+            if (result.first > i) {
+              result.first = i;
+            }
+
+            result.last = i + 1;
+          }
+
+          break;
+        }
+      }
+    }
+
+    return result;
+  }
+}
+
+/**
+ * Load the font from it's binary data. The returned value can be used to find
+ * ligatures for the font.
+ *
+ * @param buffer ArrayBuffer of the font to load
+ */
+export function loadBuffer(buffer: ArrayBuffer, options?: IOptions): IFont {
+  const font = opentype.parse(buffer);
+  return new FontImpl(font, {
+    cacheSize: 0,
+    ...options
+  });
+}
+
+export { IFont as Font, ILigatureData as LigatureData, IOptions as Options };

addons/addon-ligatures/src/fontLigatures/merge.test.ts

@@ -0,0 +1,225 @@
+/**
+ * Copyright (c) 2018 The xterm.js authors. All rights reserved.
+ * @license MIT
+ */
+
+import { assert } from 'chai';
+import mergeTrees from './merge';
+
+interface ILookupResult {
+  contextRange: [number, number];
+  index: number;
+  subIndex: number;
+  length: number;
+  substitutions: number[];
+}
+
+function lookup(substitutionGlyph: number, index?: number, subIndex?: number): ILookupResult {
+  return {
+    contextRange: [0, 1],
+    index: index || 0,
+    subIndex: subIndex || 0,
+    length: 1,
+    substitutions: [substitutionGlyph]
+  };
+}
+
+describe('addon-ligatures - merge', () => {
+  describe('mergeTrees', () => {
+    it('combines disjoint trees', () => {
+      const result = mergeTrees([
+        {
+          individual: {
+            '1': { lookup: lookup(1) }
+          },
+          range: []
+        },
+        {
+          individual: {},
+          range: [{
+            entry: { lookup: lookup(2) },
+            range: [2, 4]
+          }]
+        },
+        {
+          individual: {
+            '5': { lookup: lookup(3) }
+          },
+          range: []
+        },
+        {
+          individual: {},
+          range: [{
+            entry: { lookup: lookup(4) },
+            range: [8, 10]
+          }]
+        }
+      ]);
+
+      assert.deepEqual(result, {
+        individual: {
+          '1': { lookup: lookup(1) },
+          '5': { lookup: lookup(3) }
+        },
+        range: [{
+          entry: { lookup: lookup(2) },
+          range: [2, 4]
+        }, {
+          entry: { lookup: lookup(4) },
+          range: [8, 10]
+        }]
+      });
+    });
+
+    it('merges matching individual glyphs', () => {
+      const result = mergeTrees([
+        {
+          individual: {
+            '1': { lookup: lookup(1, 1) }
+          },
+          range: []
+        },
+        {
+          individual: {
+            '1': { lookup: lookup(2, 0) }
+          },
+          range: []
+        },
+        {
+          individual: {
+            '1': { lookup: lookup(3, 2) }
+          },
+          range: []
+        }
+      ]);
+
+      assert.deepEqual(result, {
+        individual: {
+          '1': { lookup: lookup(2, 0) }
+        },
+        range: []
+      });
+    });
+
+    it('merges range glyphs overlapping individual glyphs', () => {
+      const result = mergeTrees([
+        {
+          individual: {
+            '1': { lookup: lookup(1, 0) }
+          },
+          range: []
+        },
+        {
+          individual: {},
+          range: [{
+            entry: { lookup: lookup(2, 1) },
+            range: [0, 4]
+          }]
+        }
+      ]);
+
+      assert.deepEqual(result, {
+        individual: {
+          '0': { lookup: lookup(2, 1) },
+          '1': { lookup: lookup(1, 0) }
+        },
+        range: [{
+          entry: { lookup: lookup(2, 1) },
+          range: [2, 4]
+        }]
+      });
+    });
+
+    it('merges individual glyphs overlapping range glyphs', () => {
+      const result = mergeTrees([
+        {
+          individual: {},
+          range: [{
+            entry: { lookup: lookup(2, 1) },
+            range: [0, 4]
+          }]
+        },
+        {
+          individual: {
+            '1': { lookup: lookup(1, 0) }
+          },
+          range: []
+        }
+      ]);
+
+      assert.deepEqual(result, {
+        individual: {
+          '0': { lookup: lookup(2, 1) },
+          '1': { lookup: lookup(1, 0) }
+        },
+        range: [{
+          entry: { lookup: lookup(2, 1) },
+          range: [2, 4]
+        }]
+      });
+    });
+
+    it('merges multiple overlapping ranges', () => {
+      const result = mergeTrees([
+        {
+          individual: {},
+          range: [{
+            entry: { lookup: lookup(1, 2) },
+            range: [0, 3]
+          }, {
+            entry: { lookup: lookup(2, 1) },
+            range: [6, 12]
+          }, {
+            entry: { lookup: lookup(5, 3) },
+            range: [15, 20]
+          }, {
+            entry: { lookup: lookup(7, 4) },
+            range: [20, 22]
+          }]
+        },
+        {
+          individual: {},
+          range: [{
+            entry: { lookup: lookup(3, 0) },
+            range: [2, 8]
+          }, {
+            entry: { lookup: lookup(4, 0) },
+            range: [10, 13]
+          }, {
+            entry: { lookup: lookup(6, 0) },
+            range: [16, 21]
+          }]
+        }
+      ]);
+
+      assert.deepEqual(result, {
+        individual: {
+          '2': { lookup: lookup(3, 0) },
+          '12': { lookup: lookup(4, 0) },
+          '15': { lookup: lookup(5, 3) },
+          '20': { lookup: lookup(6, 0) },
+          '21': { lookup: lookup(7, 4) }
+        },
+        range: [{
+          entry: { lookup: lookup(1, 2) },
+          range: [0, 2]
+        }, {
+          entry: { lookup: lookup(3, 0) },
+          range: [6, 8]
+        }, {
+          entry: { lookup: lookup(3, 0) },
+          range: [3, 6]
+        }, {
+          entry: { lookup: lookup(2, 1) },
+          range: [8, 10]
+        }, {
+          entry: { lookup: lookup(4, 0) },
+          range: [10, 12]
+        }, {
+          entry: { lookup: lookup(6, 0) },
+          range: [16, 20]
+        }]
+      });
+    });
+  });
+});

addons/addon-ligatures/src/fontLigatures/merge.ts

@@ -0,0 +1,393 @@
+import { ILookupTree, ILookupTreeEntry } from './types';
+
+/**
+ * Merges the provided trees into a single lookup tree. When conflicting lookups
+ * are encountered between two trees, the one with the lower index, then the
+ * lower subindex is chosen.
+ *
+ * @param trees Array of trees to merge. Entries in earlier trees are favored
+ *              over those in later trees when there is a choice.
+ */
+export default function mergeTrees(trees: ILookupTree[]): ILookupTree {
+  const result: ILookupTree = {
+    individual: {},
+    range: []
+  };
+
+  const mergedEntries = new WeakMap<ILookupTreeEntry, Set<ILookupTreeEntry>>();
+  for (const tree of trees) {
+    mergeSubtree(result, tree, mergedEntries);
+  }
+
+  return result;
+}
+
+/**
+ * Recursively merges the data for the mergeTree into the mainTree.
+ *
+ * @param mainTree The tree where the values should be merged
+ * @param mergeTree The tree to be merged into the mainTree
+ * @param mergedEntries WeakMap to track already merged entry pairs
+ */
+function mergeSubtree(mainTree: ILookupTree, mergeTree: ILookupTree, mergedEntries: WeakMap<ILookupTreeEntry, Set<ILookupTreeEntry>>): void {
+  // Need to fix this recursively (and handle lookups)
+  for (const [glyphId, value] of Object.entries(mergeTree.individual)) {
+    // The main tree is guaranteed to have no overlaps between the
+    // individual and range values, so if we match an invididual, there
+    // must not be a range
+    if (mainTree.individual[glyphId]) {
+      mergeTreeEntry(mainTree.individual[glyphId], value, mergedEntries);
+    } else {
+      let matched = false;
+      for (const [index, { range, entry }] of mainTree.range.entries()) {
+        const overlap = getIndividualOverlap(Number(glyphId), range);
+
+        // Don't overlap
+        if (overlap.both === null) {
+          continue;
+        }
+
+        matched = true;
+
+        // If they overlap, we have to split the range and then
+        // merge the overlap
+        mainTree.individual[glyphId] = value;
+        mergeTreeEntry(mainTree.individual[glyphId], cloneEntry(entry), mergedEntries);
+
+        // When there's an overlap, we also have to fix up the range
+        // that we had already processed
+        mainTree.range.splice(index, 1);
+        for (const glyph of overlap.second) {
+          if (Array.isArray(glyph)) {
+            mainTree.range.push({
+              range: glyph,
+              entry: cloneEntry(entry)
+            });
+          } else {
+            mainTree.individual[glyph] = cloneEntry(entry);
+          }
+        }
+      }
+
+      if (!matched) {
+        mainTree.individual[glyphId] = value;
+      }
+    }
+  }
+
+  for (const { range, entry } of mergeTree.range) {
+    // Ranges are more complicated, because they can overlap with
+    // multiple things, individual and range alike. We start by
+    // eliminating ranges that are already present in another range
+    let remainingRanges: (number | [number, number])[] = [range];
+
+    for (let index = 0; index < mainTree.range.length; index++) {
+      const { range, entry: resultEntry } = mainTree.range[index];
+      for (const [remainingIndex, remainingRange] of remainingRanges.entries()) {
+        if (Array.isArray(remainingRange)) {
+          const overlap = getRangeOverlap(remainingRange, range);
+          if (overlap.both === null) {
+            continue;
+          }
+
+          mainTree.range.splice(index, 1);
+          index--;
+
+          const entryToMerge: ILookupTreeEntry = cloneEntry(resultEntry);
+          if (Array.isArray(overlap.both)) {
+            mainTree.range.push({
+              range: overlap.both,
+              entry: entryToMerge
+            });
+          } else {
+            mainTree.individual[overlap.both] = entryToMerge;
+          }
+
+          mergeTreeEntry(entryToMerge, cloneEntry(entry), mergedEntries);
+
+          for (const second of overlap.second) {
+            if (Array.isArray(second)) {
+              mainTree.range.push({
+                range: second,
+                entry: cloneEntry(resultEntry)
+              });
+            } else {
+              mainTree.individual[second] = cloneEntry(resultEntry);
+            }
+          }
+
+          remainingRanges = overlap.first;
+        } else {
+          const overlap = getIndividualOverlap(remainingRange, range);
+          if (overlap.both === null) {
+            continue;
+          }
+
+          // If they overlap, we have to split the range and then
+          // merge the overlap
+          mainTree.individual[remainingRange] = cloneEntry(entry);
+          mergeTreeEntry(mainTree.individual[remainingRange], cloneEntry(resultEntry), mergedEntries);
+
+          // When there's an overlap, we also have to fix up the range
+          // that we had already processed
+          mainTree.range.splice(index, 1);
+          index--;
+
+          for (const glyph of overlap.second) {
+            if (Array.isArray(glyph)) {
+              mainTree.range.push({
+                range: glyph,
+                entry: cloneEntry(resultEntry)
+              });
+            } else {
+              mainTree.individual[glyph] = cloneEntry(resultEntry);
+            }
+          }
+
+          remainingRanges.splice(remainingIndex, 1, ...overlap.first);
+          break;
+        }
+      }
+    }
+
+    // Next, we run the same against any individual glyphs
+    for (const glyphId of Object.keys(mainTree.individual)) {
+      for (const [remainingIndex, remainingRange] of remainingRanges.entries()) {
+        if (Array.isArray(remainingRange)) {
+          const overlap = getIndividualOverlap(Number(glyphId), remainingRange);
+          if (overlap.both === null) {
+            continue;
+          }
+
+          // If they overlap, we have to merge the overlap
+          mergeTreeEntry(mainTree.individual[glyphId], cloneEntry(entry), mergedEntries);
+
+          // Update the remaining ranges
+          remainingRanges.splice(remainingIndex, 1, ...overlap.second);
+          break;
+        } else {
+          if (Number(glyphId) === remainingRange) {
+            mergeTreeEntry(mainTree.individual[glyphId], cloneEntry(entry), mergedEntries);
+            break;
+          }
+        }
+      }
+    }
+
+    // Any remaining ranges should just be added directly
+    for (const remainingRange of remainingRanges) {
+      if (Array.isArray(remainingRange)) {
+        mainTree.range.push({
+          range: remainingRange,
+          entry: cloneEntry(entry)
+        });
+      } else {
+        mainTree.individual[remainingRange] = cloneEntry(entry);
+      }
+    }
+  }
+}
+
+/**
+ * Recursively merges the entry forr the mergeTree into the mainTree
+ *
+ * @param mainTree The entry where the values should be merged
+ * @param mergeTree The entry to merge into the mainTree
+ * @param mergedEntries WeakMap to track already merged entry pairs
+ */
+function mergeTreeEntry(mainTree: ILookupTreeEntry, mergeTree: ILookupTreeEntry, mergedEntries: WeakMap<ILookupTreeEntry, Set<ILookupTreeEntry>>): void {
+  // Check if we've already merged this pair
+  let mergedSet = mergedEntries.get(mainTree);
+  if (mergedSet?.has(mergeTree)) {
+    return;
+  }
+  if (!mergedSet) {
+    mergedSet = new Set();
+    mergedEntries.set(mainTree, mergedSet);
+  }
+  mergedSet.add(mergeTree);
+
+  if (
+    mergeTree.lookup && (
+      !mainTree.lookup ||
+      mainTree.lookup.index > mergeTree.lookup.index ||
+      (mainTree.lookup.index === mergeTree.lookup.index && mainTree.lookup.subIndex > mergeTree.lookup.subIndex)
+    )
+  ) {
+    mainTree.lookup = mergeTree.lookup;
+  }
+
+  if (mergeTree.forward) {
+    if (!mainTree.forward) {
+      mainTree.forward = mergeTree.forward;
+    } else {
+      mergeSubtree(mainTree.forward, mergeTree.forward, mergedEntries);
+    }
+  }
+
+  if (mergeTree.reverse) {
+    if (!mainTree.reverse) {
+      mainTree.reverse = mergeTree.reverse;
+    } else {
+      mergeSubtree(mainTree.reverse, mergeTree.reverse, mergedEntries);
+    }
+  }
+}
+
+interface IOverlap {
+  first: (number | [number, number])[];
+  second: (number | [number, number])[];
+  both: number | [number, number] | null;
+}
+
+/**
+ * Determines the overlap (if any) between two ranges. Returns the distinct
+ * ranges for each range and the overlap (if any).
+ *
+ * @param first First range
+ * @param second Second range
+ */
+function getRangeOverlap(first: [number, number], second: [number, number]): IOverlap {
+  const result: IOverlap = {
+    first: [],
+    second: [],
+    both: null
+  };
+
+  // Both
+  if (first[0] < second[1] && second[0] < first[1]) {
+    const start = Math.max(first[0], second[0]);
+    const end = Math.min(first[1], second[1]);
+    result.both = rangeOrIndividual(start, end);
+  }
+
+  // Before
+  if (first[0] < second[0]) {
+    const start = first[0];
+    const end = Math.min(second[0], first[1]);
+    result.first.push(rangeOrIndividual(start, end));
+  } else if (second[0] < first[0]) {
+    const start = second[0];
+    const end = Math.min(second[1], first[0]);
+    result.second.push(rangeOrIndividual(start, end));
+  }
+
+  // After
+  if (first[1] > second[1]) {
+    const start = Math.max(first[0], second[1]);
+    const end = first[1];
+    result.first.push(rangeOrIndividual(start, end));
+  } else if (second[1] > first[1]) {
+    const start = Math.max(first[1], second[0]);
+    const end = second[1];
+    result.second.push(rangeOrIndividual(start, end));
+  }
+
+  return result;
+}
+
+/**
+ * Determines the overlap (if any) between the individual glyph and the range
+ * provided. Returns the glyphs and/or ranges that are unique to each provided
+ * and the overlap (if any).
+ *
+ * @param first Individual glyph
+ * @param second Range
+ */
+function getIndividualOverlap(first: number, second: [number, number]): IOverlap {
+  // Disjoint
+  if (first < second[0] || first > second[1]) {
+    return {
+      first: [first],
+      second: [second],
+      both: null
+    };
+  }
+
+  const result: IOverlap = {
+    first: [],
+    second: [],
+    both: first
+  };
+
+  if (second[0] < first) {
+    result.second.push(rangeOrIndividual(second[0], first));
+  }
+
+  if (second[1] > first) {
+    result.second.push(rangeOrIndividual(first + 1, second[1]));
+  }
+
+  return result;
+}
+
+/**
+ * Returns an individual glyph if the range is of size one or a range if it is
+ * larger.
+ *
+ * @param start Beginning of the range (inclusive)
+ * @param end End of the range (exclusive)
+ */
+function rangeOrIndividual(start: number, end: number): number | [number, number] {
+  if (end - start === 1) {
+    return start;
+  }
+  return [start, end];
+
+}
+
+/**
+ * Clones an individual lookup tree entry.
+ *
+ * @param entry Lookup tree entry to clone
+ * @param visited Map to track already cloned entries (prevents infinite loops)
+ */
+function cloneEntry(entry: ILookupTreeEntry, visited: Map<ILookupTreeEntry, ILookupTreeEntry> = new Map()): ILookupTreeEntry {
+  if (visited.has(entry)) {
+    return visited.get(entry)!;
+  }
+
+  const result: ILookupTreeEntry = {};
+  visited.set(entry, result);
+
+  if (entry.forward) {
+    result.forward = cloneTree(entry.forward, visited);
+  }
+
+  if (entry.reverse) {
+    result.reverse = cloneTree(entry.reverse, visited);
+  }
+
+  if (entry.lookup) {
+    result.lookup = {
+      contextRange: entry.lookup.contextRange.slice() as [number, number],
+      index: entry.lookup.index,
+      length: entry.lookup.length,
+      subIndex: entry.lookup.subIndex,
+      substitutions: entry.lookup.substitutions.slice()
+    };
+  }
+
+  return result;
+}
+
+/**
+ * Clones a lookup tree.
+ *
+ * @param tree Lookup tree to clone
+ * @param visited Map to track already cloned entries (prevents infinite loops)
+ */
+function cloneTree(tree: ILookupTree, visited: Map<ILookupTreeEntry, ILookupTreeEntry> = new Map()): ILookupTree {
+  const individual: { [glyphId: string]: ILookupTreeEntry } = {};
+  for (const [glyphId, entry] of Object.entries(tree.individual)) {
+    individual[glyphId] = cloneEntry(entry, visited);
+  }
+
+  return {
+    individual,
+    range: tree.range.map(({ range, entry }) => ({
+      range: range.slice() as [number, number],
+      entry: cloneEntry(entry, visited)
+    }))
+  };
+}