First PoC of .applyAddon

src/Terminal.test.ts

@@ -3,8 +3,9 @@
  * @license MIT
  */
 
- import { assert, expect } from 'chai';
+import { assert, expect } from 'chai';
 import { Terminal } from './Terminal';
+import * as attach from './addons/attach/attach';
 import { MockViewport, MockCompositionHelper, MockRenderer } from './utils/TestUtils.test';
 import { CHAR_DATA_CHAR_INDEX, CHAR_DATA_WIDTH_INDEX } from './Buffer';
 
@@ -42,9 +43,9 @@ describe('term.js addons', () => {
     };
   });
 
-  it('should load addons with Terminal.loadAddon', () => {
-    Terminal.loadAddon('attach');
-    // Test that addon was loaded successfully, adding attach to Terminal's
+  it('should apply addons with Terminal.applyAddon', () => {
+    Terminal.applyAddon(attach);
+    // Test that addon was applied successfully, adding attach to Terminal's
     // prototype.
     assert.equal(typeof (<any>Terminal).prototype.attach, 'function');
   });

src/Terminal.ts

@@ -47,12 +47,6 @@ import { MouseZoneManager } from './input/MouseZoneManager';
 import { initialize as initializeCharAtlas } from './renderer/CharAtlas';
 import { IRenderer } from './renderer/Interfaces';
 
-// Declares required for loadAddon
-declare var exports: any;
-declare var module: any;
-declare var define: any;
-declare var require: any;
-
 // Let it work inside Node.js for automated testing purposes.
 const document = (typeof window !== 'undefined') ? window.document : null;
 
@@ -687,22 +681,11 @@ export class Terminal extends EventEmitter implements ITerminal, IInputHandlingT
   }
 
   /**
-   * Attempts to load an add-on using CommonJS or RequireJS (whichever is available).
-   * @param {string} addon The name of the addon to load
-   * @static
+   * Apply the provided addon on the `Terminal` class.
+   * @param addon The addon to apply.
    */
-  public static loadAddon(addon: string, callback?: Function): boolean | any {
-    // TODO: Improve return type and documentation
-    if (typeof exports === 'object' && typeof module === 'object') {
-      // CommonJS
-      return require('./addons/' + addon + '/' + addon);
-    } else if (typeof define === 'function') {
-      // RequireJS
-      return (<any>require)(['./addons/' + addon + '/' + addon], callback);
-    } else {
-      console.error('Cannot load a module without a CommonJS or RequireJS environment.');
-      return false;
-    }
+  public static applyAddon(addon: any): void {
+    addon.default(Terminal);
   }
 
   /**

src/addons/attach/attach.ts

@@ -0,0 +1,119 @@
+/**
+ * Copyright (c) 2014 The xterm.js authors. All rights reserved.
+ * @license MIT
+ *
+ * Implements the attach method, that attaches the terminal to a WebSocket stream.
+ */
+
+/**
+ * Attaches the given terminal to the given socket.
+ *
+ * @param {Terminal} term - The terminal to be attached to the given socket.
+ * @param {WebSocket} socket - The socket to attach the current terminal.
+ * @param {boolean} bidirectional - Whether the terminal should send data
+ *                                  to the socket as well.
+ * @param {boolean} buffered - Whether the rendering of incoming data
+ *                             should happen instantly or at a maximum
+ *                             frequency of 1 rendering per 10ms.
+ */
+function attach (term, socket, bidirectional, buffered) {
+  bidirectional = (typeof bidirectional == 'undefined') ? true : bidirectional;
+  term.socket = socket;
+
+  term._flushBuffer = function () {
+    term.write(term._attachSocketBuffer);
+    term._attachSocketBuffer = null;
+  };
+
+  term._pushToBuffer = function (data) {
+    if (term._attachSocketBuffer) {
+      term._attachSocketBuffer += data;
+    } else {
+      term._attachSocketBuffer = data;
+      setTimeout(term._flushBuffer, 10);
+    }
+  };
+
+  var myTextDecoder;
+
+  term._getMessage = function (ev) {
+    var str;
+    if (typeof ev.data === "object") {
+      if (ev.data instanceof ArrayBuffer) {
+          if (!myTextDecoder) {
+            myTextDecoder = new TextDecoder();
+          }
+
+          str = myTextDecoder.decode( ev.data );
+      }
+      else {
+        throw "TODO: handle Blob?";
+      }
+    }
+
+    if (buffered) {
+      term._pushToBuffer(str || ev.data);
+    } else {
+      term.write(str || ev.data);
+    }
+  };
+
+  term._sendData = function (data) {
+    socket.send(data);
+  };
+
+  socket.addEventListener('message', term._getMessage);
+
+  if (bidirectional) {
+    term.on('data', term._sendData);
+  }
+
+  socket.addEventListener('close', term.detach.bind(term, socket));
+  socket.addEventListener('error', term.detach.bind(term, socket));
+};
+
+/**
+ * Detaches the given terminal from the given socket
+ *
+ * @param {Terminal} term - The terminal to be detached from the given socket.
+ * @param {WebSocket} socket - The socket from which to detach the current
+ *                             terminal.
+ */
+function detach (term, socket) {
+  term.off('data', term._sendData);
+
+  socket = (typeof socket == 'undefined') ? term.socket : socket;
+
+  if (socket) {
+    socket.removeEventListener('message', term._getMessage);
+  }
+
+  delete term.socket;
+};
+
+
+export default function applyOn(terminalConstructor) {
+  /**
+   * Attaches the current terminal to the given socket
+   *
+   * @param {WebSocket} socket - The socket to attach the current terminal.
+   * @param {boolean} bidirectional - Whether the terminal should send data
+   *                                  to the socket as well.
+   * @param {boolean} buffered - Whether the rendering of incoming data
+   *                             should happen instantly or at a maximum
+   *                             frequency of 1 rendering per 10ms.
+   */
+  terminalConstructor.prototype.attach = function (socket, bidirectional, buffered) {
+    return exports.attach(this, socket, bidirectional, buffered);
+  };
+
+  /**
+   * Detaches the current terminal from the given socket.
+   *
+   * @param {WebSocket} socket - The socket from which to detach the current
+   *                             terminal.
+   */
+  terminalConstructor.prototype.detach = function (socket) {
+    return exports.detach(this, socket);
+  };
+}

src/addons/attach/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es5",
+    "rootDir": ".",
+    "outDir": "../../../lib/addons/attach/",
+    "sourceMap": true,
+    "removeComments": true
+  }
+}