Merge remote-tracking branch 'origin/master' into webgl2

README.md

@@ -172,6 +172,7 @@ computational environment for Jupyter, supporting interactive data science and s
 - [**Shellvault**](https://www.shellvault.io): The cloud-based SSH terminal you can access from anywhere.
 - [**Juno**](http://junolab.org/): A flexible Julia IDE, based on Atom.
 - [**webssh**](https://github.com/huashengdun/webssh): Web based ssh client.
+- [**info-beamer hosted**](https://info-beamer.com): Uses Xterm.js to manage digital signage devices from the web dashboard.
 
 [And much more...](https://github.com/xtermjs/xterm.js/network/dependents)
 

package.json

@@ -39,7 +39,7 @@
     "ts-loader": "^4.5.0",
     "tslint": "^5.9.1",
     "tslint-consistent-codestyle": "^1.13.0",
-    "typescript": "3.0",
+    "typescript": "3.1",
     "vinyl-buffer": "^1.0.0",
     "vinyl-source-stream": "^1.1.0",
     "webpack": "^4.17.1",

src/AccessibilityManager.ts

@@ -5,7 +5,7 @@
 
 import * as Strings from './Strings';
 import { ITerminal, IBuffer } from './Types';
-import { isMac } from './shared/utils/Browser';
+import { isMac } from './core/Platform';
 import { RenderDebouncer } from './ui/RenderDebouncer';
 import { addDisposableDomListener } from './ui/Lifecycle';
 import { Disposable } from './common/Lifecycle';

src/Buffer.ts

@@ -7,7 +7,7 @@ import { CircularList } from './common/CircularList';
 import { CharData, ITerminal, IBuffer, IBufferLine, BufferIndex, IBufferStringIterator, IBufferStringIteratorResult, IBufferLineConstructor } from './Types';
 import { EventEmitter } from './common/EventEmitter';
 import { IMarker } from 'xterm';
-import { BufferLine, BufferLineTypedArray } from './BufferLine';
+import { BufferLine, BufferLineJSArray } from './BufferLine';
 import { DEFAULT_COLOR } from './renderer/atlas/Types';
 
 export const DEFAULT_ATTR = (0 << 18) | (DEFAULT_COLOR << 9) | (256 << 0);
@@ -57,9 +57,9 @@ export class Buffer implements IBuffer {
   }
 
   public setBufferLineFactory(type: string): void {
-    if (type === 'TypedArray') {
-      if (this._bufferLineConstructor !== BufferLineTypedArray) {
-        this._bufferLineConstructor = BufferLineTypedArray;
+    if (type === 'JsArray') {
+      if (this._bufferLineConstructor !== BufferLineJSArray) {
+        this._bufferLineConstructor = BufferLineJSArray;
         this._recreateLines();
       }
     } else {

src/BufferLine.ts

@@ -7,8 +7,10 @@ import { NULL_CELL_CODE, NULL_CELL_WIDTH, NULL_CELL_CHAR } from './Buffer';
 
 /**
  * Class representing a terminal line.
+ *
+ * @deprecated to be removed with one of the next releases
  */
-export class BufferLine implements IBufferLine {
+export class BufferLineJSArray implements IBufferLine {
   protected _data: CharData[];
   public isWrapped = false;
   public length: number;
@@ -94,14 +96,14 @@ export class BufferLine implements IBufferLine {
     }
   }
 
-  public copyFrom(line: BufferLine): void {
+  public copyFrom(line: BufferLineJSArray): void {
     this._data = line._data.slice(0);
     this.length = line.length;
     this.isWrapped = line.isWrapped;
   }
 
   public clone(): IBufferLine {
-    const newLine = new BufferLine(0);
+    const newLine = new BufferLineJSArray(0);
     newLine.copyFrom(this);
     return newLine;
   }
@@ -119,17 +121,8 @@ const enum Cell {
 
 /**
  * Typed array based bufferline implementation.
- * Note:  Unlike the JS variant the access to the data
- *        via set/get is always a copy action.
- *        Sloppy ref style coding will not work anymore:
- *           line = new BufferLine(10);
- *           char = line.get(0);        // char is a copy
- *           char[some_index] = 123;    // will not update the line
- *           line.set(0, ch);           // do this to update line data
- * TODO:
- *    - provide getData/setData to directly access the data
  */
-export class BufferLineTypedArray implements IBufferLine {
+export class BufferLine implements IBufferLine {
   protected _data: Uint32Array | null = null;
   protected _combined: {[index: number]: string} = {};
   public length: number;
@@ -248,7 +241,7 @@ export class BufferLineTypedArray implements IBufferLine {
   }
 
   /** alter to a full copy of line  */
-  public copyFrom(line: BufferLineTypedArray): void {
+  public copyFrom(line: BufferLine): void {
     if (this.length !== line.length) {
       this._data = new Uint32Array(line._data);
     } else {
@@ -265,7 +258,7 @@ export class BufferLineTypedArray implements IBufferLine {
 
   /** create a new clone */
   public clone(): IBufferLine {
-    const newLine = new BufferLineTypedArray(0);
+    const newLine = new BufferLine(0);
     // creation of new typed array from another is actually pretty slow :(
     // still faster than copying values one by one
     newLine._data = new Uint32Array(this._data);

src/SelectionManager.ts

@@ -6,7 +6,7 @@
 import { ITerminal, ISelectionManager, IBuffer, CharData, IBufferLine } from './Types';
 import { XtermListener } from './common/Types';
 import { MouseHelper } from './utils/MouseHelper';
-import * as Browser from './shared/utils/Browser';
+import * as Browser from './core/Platform';
 import { CharMeasure } from './ui/CharMeasure';
 import { EventEmitter } from './common/EventEmitter';
 import { SelectionModel } from './SelectionModel';

src/Terminal.ts

@@ -29,14 +29,14 @@ import { Buffer, MAX_BUFFER_SIZE, DEFAULT_ATTR, NULL_CELL_CODE, NULL_CELL_WIDTH,
 import { CompositionHelper } from './CompositionHelper';
 import { EventEmitter } from './common/EventEmitter';
 import { Viewport } from './Viewport';
-import { rightClickHandler, moveTextAreaUnderMouseCursor, pasteHandler, copyHandler } from './handlers/Clipboard';
+import { rightClickHandler, moveTextAreaUnderMouseCursor, pasteHandler, copyHandler } from './ui/Clipboard';
 import { C0 } from './common/data/EscapeSequences';
 import { InputHandler } from './InputHandler';
 import { Renderer } from './renderer/Renderer';
 import { Linkifier } from './Linkifier';
 import { SelectionManager } from './SelectionManager';
 import { CharMeasure } from './ui/CharMeasure';
-import * as Browser from './shared/utils/Browser';
+import * as Browser from './core/Platform';
 import { addDisposableDomListener } from './ui/Lifecycle';
 import * as Strings from './Strings';
 import { MouseHelper } from './utils/MouseHelper';
@@ -107,7 +107,7 @@ const DEFAULT_OPTIONS: ITerminalOptions = {
   theme: null,
   rightClickSelectsWord: Browser.isMac,
   rendererType: 'canvas',
-  experimentalBufferLineImpl: 'JsArray'
+  experimentalBufferLineImpl: 'TypedArray'
 };
 
 export class Terminal extends EventEmitter implements ITerminal, IDisposable, IInputHandlingTerminal {
@@ -1182,7 +1182,7 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
    */
   public scroll(isWrapped: boolean = false): void {
     let newLine: IBufferLine;
-    const useRecycling = this.options.experimentalBufferLineImpl === 'TypedArray';
+    const useRecycling = this.options.experimentalBufferLineImpl !== 'JsArray';
     if (useRecycling) {
       newLine = this._blankLine;
       if (!newLine || newLine.length !== this.cols || newLine.get(0)[CHAR_DATA_ATTR_INDEX] !== this.eraseAttr()) {

src/renderer/ColorManager.ts

@@ -3,8 +3,7 @@
  * @license MIT
  */
 
-import { IColorManager } from './Types';
-import { IColor, IColorSet } from '../shared/Types';
+import { IColorManager, IColor, IColorSet } from './Types';
 import { ITheme } from 'xterm';
 
 const DEFAULT_FOREGROUND = fromHex('#ffffff');

src/renderer/Types.ts

@@ -5,7 +5,6 @@
 
 import { ITerminal, CharacterJoinerHandler } from '../Types';
 import { IEventEmitter, ITheme, IDisposable } from 'xterm';
-import { IColorSet } from '../shared/Types';
 
 /**
  * Flags used to render terminal text properly.
@@ -48,9 +47,6 @@ export interface IColorManager {
   colors: IColorSet;
 }
 
-// TODO: We should probably rewrite the imports for IColorSet, but there's a lot of them
-export { IColorSet };
-
 export interface IRenderDimensions {
   scaledCharWidth: number;
   scaledCharHeight: number;
@@ -134,3 +130,17 @@ export interface ICharacterJoinerRegistry {
   deregisterCharacterJoiner(joinerId: number): boolean;
   getJoinedCharacters(row: number): [number, number][];
 }
+
+export interface IColor {
+  css: string;
+  rgba: number; // 32-bit int with rgba in each byte
+}
+
+export interface IColorSet {
+  foreground: IColor;
+  background: IColor;
+  cursor: IColor;
+  cursorAccent: IColor;
+  selection: IColor;
+  ansi: IColor[];
+}

src/renderer/atlas/CharAtlasCache.ts

@@ -5,13 +5,13 @@
 
 import { ITerminal } from '../../Types';
 import { IColorSet } from '../Types';
-import { ICharAtlasConfig } from '../../shared/atlas/Types';
 import { generateConfig, configEquals } from './CharAtlasUtils';
 import BaseCharAtlas from './BaseCharAtlas';
 import DynamicCharAtlas from './DynamicCharAtlas';
 import NoneCharAtlas from './NoneCharAtlas';
 import StaticCharAtlas from './StaticCharAtlas';
 import WebglCharAtlas from '../webgl/WebglCharAtlas';
+import { ICharAtlasConfig } from './Types';
 
 const charAtlasImplementations = {
   'none': NoneCharAtlas,

src/renderer/atlas/CharAtlasGenerator.ts

@@ -4,18 +4,9 @@
  */
 
 import { FontWeight } from 'xterm';
-import { CHAR_ATLAS_CELL_SPACING, ICharAtlasConfig } from './Types';
+import { isFirefox, isSafari } from '../../core/Platform';
 import { IColor } from '../Types';
-import { isFirefox, isSafari } from '../utils/Browser';
-
-declare const Promise: any;
-
-export interface IOffscreenCanvas {
-  width: number;
-  height: number;
-  getContext(type: '2d', config?: Canvas2DContextAttributes): CanvasRenderingContext2D;
-  transferToImageBitmap(): ImageBitmap;
-}
+import { ICharAtlasConfig, CHAR_ATLAS_CELL_SPACING } from './Types';
 
 /**
  * Generates a char atlas.
@@ -23,7 +14,7 @@ export interface IOffscreenCanvas {
  * @param canvasFactory A function to generate a canvas with a width or height.
  * @param config The config for the new char atlas.
  */
-export function generateStaticCharAtlasTexture(context: Window, canvasFactory: (width: number, height: number) => HTMLCanvasElement | IOffscreenCanvas, config: ICharAtlasConfig): HTMLCanvasElement | Promise<ImageBitmap> {
+export function generateStaticCharAtlasTexture(context: Window, canvasFactory: (width: number, height: number) => HTMLCanvasElement, config: ICharAtlasConfig): HTMLCanvasElement | Promise<ImageBitmap> {
   const cellWidth = config.scaledCharWidth + CHAR_ATLAS_CELL_SPACING;
   const cellHeight = config.scaledCharHeight + CHAR_ATLAS_CELL_SPACING;
   const canvas = canvasFactory(
@@ -101,12 +92,7 @@ export function generateStaticCharAtlasTexture(context: Window, canvasFactory: (
   // performance (tested on v55).
   if (!('createImageBitmap' in context) || isFirefox || isSafari) {
     // Don't attempt to clear background colors if createImageBitmap is not supported
-    if (canvas instanceof HTMLCanvasElement) {
-      // Just return the HTMLCanvas if it's a HTMLCanvasElement
-      return canvas;
-    }
-    // Transfer to an ImageBitmap is this is an OffscreenCanvas
-    return new Promise((r: (bitmap: ImageBitmap) => void) => r(canvas.transferToImageBitmap()));
+    return canvas;
   }
 
   const charAtlasImageData = ctx.getImageData(0, 0, canvas.width, canvas.height);

src/renderer/atlas/CharAtlasUtils.ts

@@ -5,8 +5,7 @@
 
 import { ITerminal } from '../../Types';
 import { IColorSet } from '../Types';
-import { ICharAtlasConfig } from '../../shared/atlas/Types';
-import { DEFAULT_COLOR } from './Types';
+import { DEFAULT_COLOR, ICharAtlasConfig } from './Types';
 
 export function generateConfig(scaledCharWidth: number, scaledCharHeight: number, terminal: ITerminal, colors: IColorSet, devicePixelRatio: number = window.devicePixelRatio): ICharAtlasConfig {
   // null out some fields that don't matter

src/renderer/atlas/DynamicCharAtlas.ts

@@ -3,14 +3,13 @@
  * @license MIT
  */
 
-import { DIM_OPACITY, IGlyphIdentifier, INVERTED_DEFAULT_COLOR } from './Types';
-import { ICharAtlasConfig } from '../../shared/atlas/Types';
-import { IColor } from '../../shared/Types';
+import { DIM_OPACITY, IGlyphIdentifier, INVERTED_DEFAULT_COLOR, ICharAtlasConfig } from './Types';
 import BaseCharAtlas from './BaseCharAtlas';
 import { DEFAULT_ANSI_COLORS } from '../ColorManager';
-import { clearColor } from '../../shared/atlas/CharAtlasGenerator';
+import { clearColor } from './CharAtlasGenerator';
 import LRUMap from './LRUMap';
-import { isFirefox, isSafari } from '../../shared/utils/Browser';
+import { isFirefox, isSafari } from '../../core/Platform';
+import { IColor } from '../Types';
 
 // In practice we're probably never going to exhaust a texture this large. For debugging purposes,
 // however, it can be useful to set this to a really tiny value, to verify that LRU eviction works.

src/renderer/atlas/NoneCharAtlas.ts

@@ -5,8 +5,7 @@
  * A dummy CharAtlas implementation that always fails to draw characters.
  */
 
-import { IGlyphIdentifier } from './Types';
-import { ICharAtlasConfig } from '../../shared/atlas/Types';
+import { IGlyphIdentifier, ICharAtlasConfig } from './Types';
 import BaseCharAtlas from './BaseCharAtlas';
 
 export default class NoneCharAtlas extends BaseCharAtlas {

src/renderer/atlas/StaticCharAtlas.ts

@@ -3,9 +3,8 @@
  * @license MIT
  */
 
-import { DIM_OPACITY, IGlyphIdentifier, DEFAULT_COLOR } from './Types';
-import { CHAR_ATLAS_CELL_SPACING, ICharAtlasConfig } from '../../shared/atlas/Types';
-import { generateStaticCharAtlasTexture } from '../../shared/atlas/CharAtlasGenerator';
+import { DIM_OPACITY, IGlyphIdentifier, DEFAULT_COLOR, ICharAtlasConfig, CHAR_ATLAS_CELL_SPACING } from './Types';
+import { generateStaticCharAtlasTexture } from './CharAtlasGenerator';
 import BaseCharAtlas from './BaseCharAtlas';
 import { is256Color } from './CharAtlasUtils';
 

src/renderer/atlas/Types.ts

@@ -3,10 +3,15 @@
  * @license MIT
  */
 
+import { FontWeight } from 'xterm';
+import { IColorSet } from '../Types';
+
 export const DEFAULT_COLOR = 256;
 export const INVERTED_DEFAULT_COLOR = 257;
 export const DIM_OPACITY = 0.5;
 
+export const CHAR_ATLAS_CELL_SPACING = 1;
+
 export interface IGlyphIdentifier {
   chars: string;
   code: number;
@@ -16,3 +21,16 @@ export interface IGlyphIdentifier {
   dim: boolean;
   italic: boolean;
 }
+
+export interface ICharAtlasConfig {
+  type: 'none' | 'static' | 'dynamic' | 'webgl';
+  devicePixelRatio: number;
+  fontSize: number;
+  fontFamily: string;
+  fontWeight: FontWeight;
+  fontWeightBold: FontWeight;
+  scaledCharWidth: number;
+  scaledCharHeight: number;
+  allowTransparency: boolean;
+  colors: IColorSet;
+}

src/renderer/webgl/RectangleRenderer.ts

@@ -4,9 +4,8 @@
  */
 
 import { ITerminal } from '../../Types';
-import { IColorManager, IRenderDimensions } from '../Types';
+import { IColorManager, IRenderDimensions, IColor } from '../Types';
 import { createProgram, expandFloat32Array, PROJECTION_MATRIX } from './WebglUtils';
-import { IColor } from '../../shared/Types';
 import { IRenderModel, IWebGLVertexArrayObject, IWebGL2RenderingContext, ISelectionRenderModel } from './Types';
 import { fill } from '../../common/TypedArrayUtils';
 import { INVERTED_DEFAULT_COLOR, DEFAULT_COLOR } from '../atlas/Types';

src/renderer/webgl/WebglCharAtlas.ts

@@ -3,16 +3,14 @@
  * @license MIT
  */
 
-import { DIM_OPACITY, IGlyphIdentifier, INVERTED_DEFAULT_COLOR, DEFAULT_COLOR } from '../atlas/Types';
-import { ICharAtlasConfig } from '../../shared/atlas/Types';
-import { IColor } from '../../shared/Types';
+import { DIM_OPACITY, IGlyphIdentifier, INVERTED_DEFAULT_COLOR, DEFAULT_COLOR, ICharAtlasConfig } from '../atlas/Types';
 import BaseCharAtlas from '../atlas/BaseCharAtlas';
 import { DEFAULT_ANSI_COLORS } from '../ColorManager';
-import { clearColor } from '../../shared/atlas/CharAtlasGenerator';
 import { IRasterizedGlyph, IBoundingBox, IRasterizedGlyphSet } from './Types';
 import { DEFAULT_ATTR } from '../../Buffer';
-import { FLAGS } from '../Types';
+import { FLAGS, IColor } from '../Types';
 import { is256Color } from '../atlas/CharAtlasUtils';
+import { clearColor } from '../atlas/CharAtlasGenerator';
 
 // In practice we're probably never going to exhaust a texture this large. For debugging purposes,
 // however, it can be useful to set this to a really tiny value, to verify that LRU eviction works.

src/shared/Types.ts

@@ -1,18 +0,0 @@
-/**
- * Copyright (c) 2017 The xterm.js authors. All rights reserved.
- * @license MIT
- */
-
-export interface IColor {
-  css: string;
-  rgba: number; // 32-bit int with rgba in each byte
-}
-
-export interface IColorSet {
-  foreground: IColor;
-  background: IColor;
-  cursor: IColor;
-  cursorAccent: IColor;
-  selection: IColor;
-  ansi: IColor[];
-}