]> git.proxmox.com Git - mirror_xterm.js.git/blobdiff - src/InputHandler.ts
Merge pull request #733 from Tyriar/732_drop_selection_on_alt
[mirror_xterm.js.git] / src / InputHandler.ts
index 42c847697bf8723623022763f9df502d5cb6039a..34131a15a1ff296453fc2ecc9884fedd2fa840cd 100644 (file)
+/**
+ * @license MIT
+ */
+
 import { IInputHandler, ITerminal } from './Interfaces';
 import { C0 } from './EscapeSequences';
-import { CHARSETS } from './Charsets';
-
+import { DEFAULT_CHARSET } from './Charsets';
+
+/**
+ * The terminal's standard implementation of IInputHandler, this handles all
+ * input from the Parser.
+ *
+ * Refer to http://invisible-island.net/xterm/ctlseqs/ctlseqs.html to understand
+ * each function's header comment.
+ */
 export class InputHandler implements IInputHandler {
   // TODO: We want to type _terminal when it's pulled into TS
   constructor(private _terminal: any) { }
 
+  public addChar(char: string, code: number): void {
+    if (char >= ' ') {
+      // calculate print space
+      // expensive call, therefore we save width in line buffer
+      const ch_width = wcwidth(code);
+
+      if (this._terminal.charset && this._terminal.charset[char]) {
+        char = this._terminal.charset[char];
+      }
+
+      let row = this._terminal.y + this._terminal.ybase;
+
+      // insert combining char in last cell
+      // FIXME: needs handling after cursor jumps
+      if (!ch_width && this._terminal.x) {
+        // dont overflow left
+        if (this._terminal.lines.get(row)[this._terminal.x - 1]) {
+          if (!this._terminal.lines.get(row)[this._terminal.x - 1][2]) {
+
+            // found empty cell after fullwidth, need to go 2 cells back
+            if (this._terminal.lines.get(row)[this._terminal.x - 2])
+              this._terminal.lines.get(row)[this._terminal.x - 2][1] += char;
+
+          } else {
+            this._terminal.lines.get(row)[this._terminal.x - 1][1] += char;
+          }
+          this._terminal.updateRange(this._terminal.y);
+        }
+        return;
+      }
+
+      // goto next line if ch would overflow
+      // TODO: needs a global min terminal width of 2
+      if (this._terminal.x + ch_width - 1 >= this._terminal.cols) {
+        // autowrap - DECAWM
+        if (this._terminal.wraparoundMode) {
+          this._terminal.x = 0;
+          this._terminal.y++;
+          if (this._terminal.y > this._terminal.scrollBottom) {
+            this._terminal.y--;
+            this._terminal.scroll(true);
+          }
+        } else {
+          if (ch_width === 2)  // FIXME: check for xterm behavior
+            return;
+        }
+      }
+      row = this._terminal.y + this._terminal.ybase;
+
+      // insert mode: move characters to right
+      if (this._terminal.insertMode) {
+        // do this twice for a fullwidth char
+        for (let moves = 0; moves < ch_width; ++moves) {
+          // remove last cell, if it's width is 0
+          // we have to adjust the second last cell as well
+          const removed = this._terminal.lines.get(this._terminal.y + this._terminal.ybase).pop();
+          if (removed[2] === 0
+              && this._terminal.lines.get(row)[this._terminal.cols - 2]
+              && this._terminal.lines.get(row)[this._terminal.cols - 2][2] === 2) {
+            this._terminal.lines.get(row)[this._terminal.cols - 2] = [this._terminal.curAttr, ' ', 1];
+          }
+
+          // insert empty cell at cursor
+          this._terminal.lines.get(row).splice(this._terminal.x, 0, [this._terminal.curAttr, ' ', 1]);
+        }
+      }
+
+      this._terminal.lines.get(row)[this._terminal.x] = [this._terminal.curAttr, char, ch_width];
+      this._terminal.x++;
+      this._terminal.updateRange(this._terminal.y);
+
+      // fullwidth char - set next cell width to zero and advance cursor
+      if (ch_width === 2) {
+        this._terminal.lines.get(row)[this._terminal.x] = [this._terminal.curAttr, '', 0];
+        this._terminal.x++;
+      }
+    }
+  }
+
   /**
    * BEL
    * Bell (Ctrl-G).
@@ -34,6 +124,10 @@ export class InputHandler implements IInputHandler {
       this._terminal.y--;
       this._terminal.scroll();
     }
+    // If the end of the line is hit, prevent this action from wrapping around to the next line.
+    if (this._terminal.x >= this._terminal.cols) {
+      this._terminal.x--;
+    }
   }
 
   /**
@@ -128,6 +222,10 @@ export class InputHandler implements IInputHandler {
     if (this._terminal.y >= this._terminal.rows) {
       this._terminal.y = this._terminal.rows - 1;
     }
+    // If the end of the line is hit, prevent this action from wrapping around to the next line.
+    if (this._terminal.x >= this._terminal.cols) {
+      this._terminal.x--;
+    }
   }
 
   /**
@@ -154,6 +252,10 @@ export class InputHandler implements IInputHandler {
     if (param < 1) {
       param = 1;
     }
+    // If the end of the line is hit, prevent this action from wrapping around to the next line.
+    if (this._terminal.x >= this._terminal.cols) {
+      this._terminal.x--;
+    }
     this._terminal.x -= param;
     if (this._terminal.x < 0) {
       this._terminal.x = 0;
@@ -284,7 +386,13 @@ export class InputHandler implements IInputHandler {
         while (j--) this._terminal.eraseLine(j);
         break;
       case 3:
-        ; // no saved lines
+        // Clear scrollback (everything not in viewport)
+        const scrollBackSize = this._terminal.lines.length - this._terminal.rows;
+        if (scrollBackSize > 0) {
+          this._terminal.lines.trimStart(scrollBackSize);
+          this._terminal.ybase = Math.max(this._terminal.ybase - scrollBackSize, 0);
+          this._terminal.ydisp = Math.max(this._terminal.ydisp - scrollBackSize, 0);
+        }
         break;
     }
   }
@@ -603,6 +711,10 @@ export class InputHandler implements IInputHandler {
     if (this._terminal.y >= this._terminal.rows) {
       this._terminal.y = this._terminal.rows - 1;
     }
+    // If the end of the line is hit, prevent this action from wrapping around to the next line.
+    if (this._terminal.x >= this._terminal.cols) {
+      this._terminal.x--;
+    }
   }
 
   /**
@@ -731,7 +843,7 @@ export class InputHandler implements IInputHandler {
   public setMode(params: number[]): void {
     if (params.length > 1) {
       for (let i = 0; i < params.length; i++) {
-        this._terminal.setMode(params[i]);
+        this.setMode([params[i]]);
       }
 
       return;
@@ -752,10 +864,10 @@ export class InputHandler implements IInputHandler {
           this._terminal.applicationCursor = true;
           break;
         case 2:
-          this._terminal.setgCharset(0, CHARSETS.US);
-          this._terminal.setgCharset(1, CHARSETS.US);
-          this._terminal.setgCharset(2, CHARSETS.US);
-          this._terminal.setgCharset(3, CHARSETS.US);
+          this._terminal.setgCharset(0, DEFAULT_CHARSET);
+          this._terminal.setgCharset(1, DEFAULT_CHARSET);
+          this._terminal.setgCharset(2, DEFAULT_CHARSET);
+          this._terminal.setgCharset(3, DEFAULT_CHARSET);
           // set VT100 mode here
           break;
         case 3: // 132 col mode
@@ -792,7 +904,8 @@ export class InputHandler implements IInputHandler {
           this._terminal.vt200Mouse = params[0] === 1000;
           this._terminal.normalMouse = params[0] > 1000;
           this._terminal.mouseEvents = true;
-          this._terminal.element.style.cursor = 'default';
+          this._terminal.element.classList.add('enable-mouse-events');
+          this._terminal.selectionManager.disable();
           this._terminal.log('Binding to mouse events.');
           break;
         case 1004: // send focusin/focusout events
@@ -937,7 +1050,7 @@ export class InputHandler implements IInputHandler {
   public resetMode(params: number[]): void {
     if (params.length > 1) {
       for (let i = 0; i < params.length; i++) {
-        this._terminal.resetMode(params[i]);
+        this.resetMode([params[i]]);
       }
 
       return;
@@ -985,7 +1098,8 @@ export class InputHandler implements IInputHandler {
           this._terminal.vt200Mouse = false;
           this._terminal.normalMouse = false;
           this._terminal.mouseEvents = false;
-          this._terminal.element.style.cursor = '';
+          this._terminal.element.classList.remove('enable-mouse-events');
+          this._terminal.selectionManager.enable();
           break;
         case 1004: // send focusin/focusout events
           this._terminal.sendFocus = false;
@@ -1016,11 +1130,13 @@ export class InputHandler implements IInputHandler {
             this._terminal.scrollBottom = this._terminal.normal.scrollBottom;
             this._terminal.tabs = this._terminal.normal.tabs;
             this._terminal.normal = null;
+            // Ensure the selection manager has the correct buffer
+            this._terminal.selectionManager.setBuffer(this._terminal.lines);
             // if (params === 1049) {
             //   this.x = this.savedX;
             //   this.y = this.savedY;
             // }
-            this._terminal.queueRefresh(0, this._terminal.rows - 1);
+            this._terminal.refresh(0, this._terminal.rows - 1);
             this._terminal.viewport.syncScrollArea();
             this._terminal.showCursor();
           }
@@ -1289,7 +1405,7 @@ export class InputHandler implements IInputHandler {
     this._terminal.cursorHidden = false;
     this._terminal.insertMode = false;
     this._terminal.originMode = false;
-    this._terminal.wraparoundMode = false; // autowrap
+    this._terminal.wraparoundMode = true;  // defaults: xterm - true, vt100 - false
     this._terminal.applicationKeypad = false; // ?
     this._terminal.viewport.syncScrollArea();
     this._terminal.applicationCursor = false;
@@ -1302,6 +1418,36 @@ export class InputHandler implements IInputHandler {
     this._terminal.charsets = [null]; // ??
   }
 
+  /**
+   * CSI Ps SP q  Set cursor style (DECSCUSR, VT520).
+   *   Ps = 0  -> blinking block.
+   *   Ps = 1  -> blinking block (default).
+   *   Ps = 2  -> steady block.
+   *   Ps = 3  -> blinking underline.
+   *   Ps = 4  -> steady underline.
+   *   Ps = 5  -> blinking bar (xterm).
+   *   Ps = 6  -> steady bar (xterm).
+   */
+  public setCursorStyle(params?: number[]): void {
+    const param = params[0] < 1 ? 1 : params[0];
+    switch (param) {
+      case 1:
+      case 2:
+        this._terminal.setOption('cursorStyle', 'block');
+        break;
+      case 3:
+      case 4:
+        this._terminal.setOption('cursorStyle', 'underline');
+        break;
+      case 5:
+      case 6:
+        this._terminal.setOption('cursorStyle', 'bar');
+        break;
+    }
+    const isBlinking = param % 2 === 1;
+    this._terminal.setOption('cursorBlink', isBlinking);
+  }
+
   /**
    * CSI Ps ; Ps r
    *   Set Scrolling Region [top;bottom] (default = full size of win-
@@ -1311,7 +1457,7 @@ export class InputHandler implements IInputHandler {
   public setScrollRegion(params: number[]): void {
     if (this._terminal.prefix) return;
     this._terminal.scrollTop = (params[0] || 1) - 1;
-    this._terminal.scrollBottom = (params[1] || this._terminal.rows) - 1;
+    this._terminal.scrollBottom = (params[1] && params[1] <= this._terminal.rows ? params[1] : this._terminal.rows) - 1;
     this._terminal.x = 0;
     this._terminal.y = 0;
   }
@@ -1336,3 +1482,108 @@ export class InputHandler implements IInputHandler {
     this._terminal.y = this._terminal.savedY || 0;
   }
 }
+
+const wcwidth = (function(opts) {
+  // extracted from https://www.cl.cam.ac.uk/%7Emgk25/ucs/wcwidth.c
+  // combining characters
+  const COMBINING = [
+    [0x0300, 0x036F], [0x0483, 0x0486], [0x0488, 0x0489],
+    [0x0591, 0x05BD], [0x05BF, 0x05BF], [0x05C1, 0x05C2],
+    [0x05C4, 0x05C5], [0x05C7, 0x05C7], [0x0600, 0x0603],
+    [0x0610, 0x0615], [0x064B, 0x065E], [0x0670, 0x0670],
+    [0x06D6, 0x06E4], [0x06E7, 0x06E8], [0x06EA, 0x06ED],
+    [0x070F, 0x070F], [0x0711, 0x0711], [0x0730, 0x074A],
+    [0x07A6, 0x07B0], [0x07EB, 0x07F3], [0x0901, 0x0902],
+    [0x093C, 0x093C], [0x0941, 0x0948], [0x094D, 0x094D],
+    [0x0951, 0x0954], [0x0962, 0x0963], [0x0981, 0x0981],
+    [0x09BC, 0x09BC], [0x09C1, 0x09C4], [0x09CD, 0x09CD],
+    [0x09E2, 0x09E3], [0x0A01, 0x0A02], [0x0A3C, 0x0A3C],
+    [0x0A41, 0x0A42], [0x0A47, 0x0A48], [0x0A4B, 0x0A4D],
+    [0x0A70, 0x0A71], [0x0A81, 0x0A82], [0x0ABC, 0x0ABC],
+    [0x0AC1, 0x0AC5], [0x0AC7, 0x0AC8], [0x0ACD, 0x0ACD],
+    [0x0AE2, 0x0AE3], [0x0B01, 0x0B01], [0x0B3C, 0x0B3C],
+    [0x0B3F, 0x0B3F], [0x0B41, 0x0B43], [0x0B4D, 0x0B4D],
+    [0x0B56, 0x0B56], [0x0B82, 0x0B82], [0x0BC0, 0x0BC0],
+    [0x0BCD, 0x0BCD], [0x0C3E, 0x0C40], [0x0C46, 0x0C48],
+    [0x0C4A, 0x0C4D], [0x0C55, 0x0C56], [0x0CBC, 0x0CBC],
+    [0x0CBF, 0x0CBF], [0x0CC6, 0x0CC6], [0x0CCC, 0x0CCD],
+    [0x0CE2, 0x0CE3], [0x0D41, 0x0D43], [0x0D4D, 0x0D4D],
+    [0x0DCA, 0x0DCA], [0x0DD2, 0x0DD4], [0x0DD6, 0x0DD6],
+    [0x0E31, 0x0E31], [0x0E34, 0x0E3A], [0x0E47, 0x0E4E],
+    [0x0EB1, 0x0EB1], [0x0EB4, 0x0EB9], [0x0EBB, 0x0EBC],
+    [0x0EC8, 0x0ECD], [0x0F18, 0x0F19], [0x0F35, 0x0F35],
+    [0x0F37, 0x0F37], [0x0F39, 0x0F39], [0x0F71, 0x0F7E],
+    [0x0F80, 0x0F84], [0x0F86, 0x0F87], [0x0F90, 0x0F97],
+    [0x0F99, 0x0FBC], [0x0FC6, 0x0FC6], [0x102D, 0x1030],
+    [0x1032, 0x1032], [0x1036, 0x1037], [0x1039, 0x1039],
+    [0x1058, 0x1059], [0x1160, 0x11FF], [0x135F, 0x135F],
+    [0x1712, 0x1714], [0x1732, 0x1734], [0x1752, 0x1753],
+    [0x1772, 0x1773], [0x17B4, 0x17B5], [0x17B7, 0x17BD],
+    [0x17C6, 0x17C6], [0x17C9, 0x17D3], [0x17DD, 0x17DD],
+    [0x180B, 0x180D], [0x18A9, 0x18A9], [0x1920, 0x1922],
+    [0x1927, 0x1928], [0x1932, 0x1932], [0x1939, 0x193B],
+    [0x1A17, 0x1A18], [0x1B00, 0x1B03], [0x1B34, 0x1B34],
+    [0x1B36, 0x1B3A], [0x1B3C, 0x1B3C], [0x1B42, 0x1B42],
+    [0x1B6B, 0x1B73], [0x1DC0, 0x1DCA], [0x1DFE, 0x1DFF],
+    [0x200B, 0x200F], [0x202A, 0x202E], [0x2060, 0x2063],
+    [0x206A, 0x206F], [0x20D0, 0x20EF], [0x302A, 0x302F],
+    [0x3099, 0x309A], [0xA806, 0xA806], [0xA80B, 0xA80B],
+    [0xA825, 0xA826], [0xFB1E, 0xFB1E], [0xFE00, 0xFE0F],
+    [0xFE20, 0xFE23], [0xFEFF, 0xFEFF], [0xFFF9, 0xFFFB],
+    [0x10A01, 0x10A03], [0x10A05, 0x10A06], [0x10A0C, 0x10A0F],
+    [0x10A38, 0x10A3A], [0x10A3F, 0x10A3F], [0x1D167, 0x1D169],
+    [0x1D173, 0x1D182], [0x1D185, 0x1D18B], [0x1D1AA, 0x1D1AD],
+    [0x1D242, 0x1D244], [0xE0001, 0xE0001], [0xE0020, 0xE007F],
+    [0xE0100, 0xE01EF]
+  ];
+  // binary search
+  function bisearch(ucs) {
+    let min = 0;
+    let max = COMBINING.length - 1;
+    let mid;
+    if (ucs < COMBINING[0][0] || ucs > COMBINING[max][1])
+      return false;
+    while (max >= min) {
+      mid = Math.floor((min + max) / 2);
+      if (ucs > COMBINING[mid][1])
+        min = mid + 1;
+      else if (ucs < COMBINING[mid][0])
+        max = mid - 1;
+      else
+        return true;
+    }
+    return false;
+  }
+  function wcwidth(ucs) {
+    // test for 8-bit control characters
+    if (ucs === 0)
+      return opts.nul;
+    if (ucs < 32 || (ucs >= 0x7f && ucs < 0xa0))
+      return opts.control;
+    // binary search in table of non-spacing characters
+    if (bisearch(ucs))
+      return 0;
+    // if we arrive here, ucs is not a combining or C0/C1 control character
+    if (isWide(ucs)) {
+      return 2;
+    }
+    return 1;
+  }
+  function isWide(ucs) {
+    return (
+      ucs >= 0x1100 && (
+        ucs <= 0x115f ||                // Hangul Jamo init. consonants
+        ucs === 0x2329 ||
+        ucs === 0x232a ||
+        (ucs >= 0x2e80 && ucs <= 0xa4cf && ucs !== 0x303f) ||  // CJK..Yi
+        (ucs >= 0xac00 && ucs <= 0xd7a3) ||    // Hangul Syllables
+        (ucs >= 0xf900 && ucs <= 0xfaff) ||    // CJK Compat Ideographs
+        (ucs >= 0xfe10 && ucs <= 0xfe19) ||    // Vertical forms
+        (ucs >= 0xfe30 && ucs <= 0xfe6f) ||    // CJK Compat Forms
+        (ucs >= 0xff00 && ucs <= 0xff60) ||    // Fullwidth Forms
+        (ucs >= 0xffe0 && ucs <= 0xffe6) ||
+        (ucs >= 0x20000 && ucs <= 0x2fffd) ||
+        (ucs >= 0x30000 && ucs <= 0x3fffd)));
+  }
+  return wcwidth;
+})({nul: 0, control: 0});  // configurable options