image support

addons/xterm-addon-image/.gitignore

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

addons/xterm-addon-image/.npmignore

@@ -0,0 +1,5 @@
+**/*.api.js
+**/*.api.ts
+tsconfig.json
+.yarnrc
+webpack.config.js

addons/xterm-addon-image/LICENSE

@@ -0,0 +1,19 @@
+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.

addons/xterm-addon-image/README.md

@@ -0,0 +1,3 @@
+## xterm-addon-image
+
+TODO...

addons/xterm-addon-image/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "xterm-addon-image",
+  "version": "0.0.1",
+  "author": {
+    "name": "The xterm.js authors",
+    "url": "https://xtermjs.org/"
+  },
+  "main": "lib/xterm-addon-image.js",
+  "types": "typings/xterm-addon-image.d.ts",
+  "repository": "https://github.com/xtermjs/xterm.js",
+  "license": "MIT",
+  "scripts": {
+    "build": "../../node_modules/.bin/tsc -p src",
+    "prepackage": "npm run build",
+    "package": "../../node_modules/.bin/webpack",
+    "prepublishOnly": "npm run package"
+  },
+  "peerDependencies": {
+    "xterm": "^4.0.0"
+  },
+  "dependencies": {
+    "sixel": "^0.12.0"
+  }
+}

addons/xterm-addon-image/src/ImageAddon.ts

@@ -0,0 +1,67 @@
+/**
+ * Copyright (c) 2019 The xterm.js authors. All rights reserved.
+ * @license MIT
+ *
+ * Implements image support for the terminal.
+ */
+
+import { Terminal, IDisposable, ITerminalAddon } from 'xterm';
+import { SixelDecoder, DEFAULT_BACKGROUND, PALETTE_ANSI_256, PALETTE_VT340_COLOR, PALETTE_VT340_GREY, RGBA8888 } from 'sixel';
+import { ImageStorage } from './ImageStorage';
+
+interface IImageAddonOptions {
+  sixelSupport?: boolean;
+  sixelScroll?: boolean;
+  sixelPaletteLimit?: number;
+  sixelPrivatePalette?: boolean;
+  sixelDefaultPalette: 'VT340-COLOR' | 'VT340-GREY' | 'ANSI256';
+}
+
+const DEFAULT_OPTIONS: IImageAddonOptions = {
+  sixelSupport: true,
+  sixelScroll: true,
+  sixelPaletteLimit: 256,
+  sixelPrivatePalette: true,
+  sixelDefaultPalette: 'ANSI256'
+};
+
+export class ImageAddon implements ITerminalAddon {
+  private _opts: IImageAddonOptions;
+  private _storage: ImageStorage | undefined;
+  private _sixelHandler: IDisposable | undefined;
+  private _sixelPalette: RGBA8888[];
+  constructor(opts: IImageAddonOptions = DEFAULT_OPTIONS) {
+    this._opts = Object.assign({}, DEFAULT_OPTIONS, opts);
+    this._sixelPalette = this._opts.sixelDefaultPalette === 'VT340-COLOR' ? PALETTE_VT340_COLOR
+                        : this._opts.sixelDefaultPalette === 'VT340-GREY' ? PALETTE_VT340_GREY
+                        : PALETTE_ANSI_256;
+  }
+  public activate(terminal: Terminal): void {
+    this._storage = new ImageStorage(terminal);
+    if (this._opts.sixelSupport && !this._sixelHandler) {
+      this._sixelHandler = terminal.parser.addDcsHandler({final: 'q'}, (data, params) => {
+        const pal = this._opts.sixelPrivatePalette ? Object.assign([], this._sixelPalette) : this._sixelPalette;
+        // TODO: 0 - get startup background, 2 - get BCE
+        const dec = new SixelDecoder(params[1] === 1 ? 0 : DEFAULT_BACKGROUND, pal, this._opts.sixelPaletteLimit);
+        dec.decodeString(data);
+        if (this._storage) {
+          this._storage.addImageFromSixel(dec);
+        }
+        return true;
+      });
+    }
+
+    terminal.onRender(this._storage.render.bind(this._storage));
+  }
+
+  public dispose(): void {
+    if (this._sixelHandler) {
+      this._sixelHandler.dispose();
+      this._sixelHandler = undefined;
+    }
+    if (this._storage) {
+      this._storage.dispose();
+      this._storage = undefined;
+    }
+  }
+}