src/InputHandler.ts

   1 /**
   2  * @license MIT
   3  */
   4
   5 import { IInputHandler, ITerminal } from './Interfaces';
   6 import { C0 } from './EscapeSequences';
   7 import { DEFAULT_CHARSET } from './Charsets';
   8
   9 /**
  10  * The terminal's standard implementation of IInputHandler, this handles all
  11  * input from the Parser.
  12  *
  13  * Refer to http://invisible-island.net/xterm/ctlseqs/ctlseqs.html to understand
  14  * each function's header comment.
  15  */
  16 export class InputHandler implements IInputHandler {
  17   // TODO: We want to type _terminal when it's pulled into TS
  18   constructor(private _terminal: any) { }
  19
  20   public addChar(char: string, code: number): void {
  21     if (char >= ' ') {
  22       // calculate print space
  23       // expensive call, therefore we save width in line buffer
  24       const ch_width = wcwidth(code);
  25
  26       if (this._terminal.charset && this._terminal.charset[char]) {
  27         char = this._terminal.charset[char];
  28       }
  29
  30       let row = this._terminal.buffer.y + this._terminal.buffer.ybase;
  31
  32       // insert combining char in last cell
  33       // FIXME: needs handling after cursor jumps
  34       if (!ch_width && this._terminal.buffer.x) {
  35         // dont overflow left
  36         if (this._terminal.buffer.lines.get(row)[this._terminal.buffer.x - 1]) {
  37           if (!this._terminal.buffer.lines.get(row)[this._terminal.buffer.x - 1][2]) {
  38
  39             // found empty cell after fullwidth, need to go 2 cells back
  40             if (this._terminal.buffer.lines.get(row)[this._terminal.buffer.x - 2])
  41               this._terminal.buffer.lines.get(row)[this._terminal.buffer.x - 2][1] += char;
  42
  43           } else {
  44             this._terminal.buffer.lines.get(row)[this._terminal.buffer.x - 1][1] += char;
  45           }
  46           this._terminal.updateRange(this._terminal.buffer.y);
  47         }
  48         return;
  49       }
  50
  51       // goto next line if ch would overflow
  52       // TODO: needs a global min terminal width of 2
  53       if (this._terminal.buffer.x + ch_width - 1 >= this._terminal.cols) {
  54         // autowrap - DECAWM
  55         if (this._terminal.wraparoundMode) {
  56           this._terminal.buffer.x = 0;
  57           this._terminal.buffer.y++;
  58           if (this._terminal.buffer.y > this._terminal.buffer.scrollBottom) {
  59             this._terminal.buffer.y--;
  60             this._terminal.scroll(true);
  61           } else {
  62             // The line already exists (eg. the initial viewport), mark it as a
  63             // wrapped line
  64             this._terminal.buffer.lines.get(this._terminal.buffer.y).isWrapped = true;
  65           }
  66         } else {
  67           if (ch_width === 2)  // FIXME: check for xterm behavior
  68             return;
  69         }
  70       }
  71       row = this._terminal.buffer.y + this._terminal.buffer.ybase;
  72
  73       // insert mode: move characters to right
  74       if (this._terminal.insertMode) {
  75         // do this twice for a fullwidth char
  76         for (let moves = 0; moves < ch_width; ++moves) {
  77           // remove last cell, if it's width is 0
  78           // we have to adjust the second last cell as well
  79           const removed = this._terminal.buffer.lines.get(this._terminal.buffer.y + this._terminal.buffer.ybase).pop();
  80           if (removed[2] === 0
  81               && this._terminal.buffer.lines.get(row)[this._terminal.cols - 2]
  82               && this._terminal.buffer.lines.get(row)[this._terminal.cols - 2][2] === 2) {
  83             this._terminal.buffer.lines.get(row)[this._terminal.cols - 2] = [this._terminal.curAttr, ' ', 1];
  84           }
  85
  86           // insert empty cell at cursor
  87           this._terminal.buffer.lines.get(row).splice(this._terminal.buffer.x, 0, [this._terminal.curAttr, ' ', 1]);
  88         }
  89       }
  90
  91       this._terminal.buffer.lines.get(row)[this._terminal.buffer.x] = [this._terminal.curAttr, char, ch_width];
  92       this._terminal.buffer.x++;
  93       this._terminal.updateRange(this._terminal.buffer.y);
  94
  95       // fullwidth char - set next cell width to zero and advance cursor
  96       if (ch_width === 2) {
  97         this._terminal.buffer.lines.get(row)[this._terminal.buffer.x] = [this._terminal.curAttr, '', 0];
  98         this._terminal.buffer.x++;
  99       }
 100     }
 101   }
 102
 103   /**
 104    * BEL
 105    * Bell (Ctrl-G).
 106    */
 107   public bell(): void {
 108     if (!this._terminal.visualBell) {
 109       return;
 110     }
 111     this._terminal.element.style.borderColor = 'white';
 112     setTimeout(() => this._terminal.element.style.borderColor = '', 10);
 113     if (this._terminal.popOnBell) {
 114       this._terminal.focus();
 115     }
 116   }
 117
 118   /**
 119    * LF
 120    * Line Feed or New Line (NL).  (LF  is Ctrl-J).
 121    */
 122   public lineFeed(): void {
 123     if (this._terminal.convertEol) {
 124       this._terminal.buffer.x = 0;
 125     }
 126     this._terminal.buffer.y++;
 127     if (this._terminal.buffer.y > this._terminal.buffer.scrollBottom) {
 128       this._terminal.buffer.y--;
 129       this._terminal.scroll();
 130     }
 131     // If the end of the line is hit, prevent this action from wrapping around to the next line.
 132     if (this._terminal.buffer.x >= this._terminal.cols) {
 133       this._terminal.buffer.x--;
 134     }
 135   }
 136
 137   /**
 138    * CR
 139    * Carriage Return (Ctrl-M).
 140    */
 141   public carriageReturn(): void {
 142     this._terminal.buffer.x = 0;
 143   }
 144
 145   /**
 146    * BS
 147    * Backspace (Ctrl-H).
 148    */
 149   public backspace(): void {
 150     if (this._terminal.buffer.x > 0) {
 151       this._terminal.buffer.x--;
 152     }
 153   }
 154
 155   /**
 156    * TAB
 157    * Horizontal Tab (HT) (Ctrl-I).
 158    */
 159   public tab(): void {
 160     this._terminal.buffer.x = this._terminal.nextStop();
 161   }
 162
 163   /**
 164    * SO
 165    * Shift Out (Ctrl-N) -> Switch to Alternate Character Set.  This invokes the
 166    * G1 character set.
 167    */
 168   public shiftOut(): void {
 169     this._terminal.setgLevel(1);
 170   }
 171
 172   /**
 173    * SI
 174    * Shift In (Ctrl-O) -> Switch to Standard Character Set.  This invokes the G0
 175    * character set (the default).
 176    */
 177   public shiftIn(): void {
 178     this._terminal.setgLevel(0);
 179   }
 180
 181   /**
 182    * CSI Ps @
 183    * Insert Ps (Blank) Character(s) (default = 1) (ICH).
 184    */
 185   public insertChars(params: number[]): void {
 186     let param, row, j, ch;
 187
 188     param = params[0];
 189     if (param < 1) param = 1;
 190
 191     row = this._terminal.buffer.y + this._terminal.buffer.ybase;
 192     j = this._terminal.buffer.x;
 193     ch = [this._terminal.eraseAttr(), ' ', 1]; // xterm
 194
 195     while (param-- && j < this._terminal.cols) {
 196       this._terminal.buffer.lines.get(row).splice(j++, 0, ch);
 197       this._terminal.buffer.lines.get(row).pop();
 198     }
 199   }
 200
 201   /**
 202    * CSI Ps A
 203    * Cursor Up Ps Times (default = 1) (CUU).
 204    */
 205   public cursorUp(params: number[]): void {
 206     let param = params[0];
 207     if (param < 1) {
 208       param = 1;
 209     }
 210     this._terminal.buffer.y -= param;
 211     if (this._terminal.buffer.y < 0) {
 212       this._terminal.buffer.y = 0;
 213     }
 214   }
 215
 216   /**
 217    * CSI Ps B
 218    * Cursor Down Ps Times (default = 1) (CUD).
 219    */
 220   public cursorDown(params: number[]) {
 221     let param = params[0];
 222     if (param < 1) {
 223       param = 1;
 224     }
 225     this._terminal.buffer.y += param;
 226     if (this._terminal.buffer.y >= this._terminal.rows) {
 227       this._terminal.buffer.y = this._terminal.rows - 1;
 228     }
 229     // If the end of the line is hit, prevent this action from wrapping around to the next line.
 230     if (this._terminal.buffer.x >= this._terminal.cols) {
 231       this._terminal.buffer.x--;
 232     }
 233   }
 234
 235   /**
 236    * CSI Ps C
 237    * Cursor Forward Ps Times (default = 1) (CUF).
 238    */
 239   public cursorForward(params: number[]) {
 240     let param = params[0];
 241     if (param < 1) {
 242       param = 1;
 243     }
 244     this._terminal.buffer.x += param;
 245     if (this._terminal.buffer.x >= this._terminal.cols) {
 246       this._terminal.buffer.x = this._terminal.cols - 1;
 247     }
 248   }
 249
 250   /**
 251    * CSI Ps D
 252    * Cursor Backward Ps Times (default = 1) (CUB).
 253    */
 254   public cursorBackward(params: number[]) {
 255     let param = params[0];
 256     if (param < 1) {
 257       param = 1;
 258     }
 259     // If the end of the line is hit, prevent this action from wrapping around to the next line.
 260     if (this._terminal.buffer.x >= this._terminal.cols) {
 261       this._terminal.buffer.x--;
 262     }
 263     this._terminal.buffer.x -= param;
 264     if (this._terminal.buffer.x < 0) {
 265       this._terminal.buffer.x = 0;
 266     }
 267   }
 268
 269   /**
 270    * CSI Ps E
 271    * Cursor Next Line Ps Times (default = 1) (CNL).
 272    * same as CSI Ps B ?
 273    */
 274   public cursorNextLine(params: number[]): void {
 275     let param = params[0];
 276     if (param < 1) {
 277       param = 1;
 278     }
 279     this._terminal.buffer.y += param;
 280     if (this._terminal.buffer.y >= this._terminal.rows) {
 281       this._terminal.buffer.y = this._terminal.rows - 1;
 282     }
 283     this._terminal.buffer.x = 0;
 284   };
 285
 286
 287   /**
 288    * CSI Ps F
 289    * Cursor Preceding Line Ps Times (default = 1) (CNL).
 290    * reuse CSI Ps A ?
 291    */
 292   public cursorPrecedingLine(params: number[]): void {
 293     let param = params[0];
 294     if (param < 1) {
 295       param = 1;
 296     }
 297     this._terminal.buffer.y -= param;
 298     if (this._terminal.buffer.y < 0) {
 299       this._terminal.buffer.y = 0;
 300     }
 301     this._terminal.buffer.x = 0;
 302   };
 303
 304
 305   /**
 306    * CSI Ps G
 307    * Cursor Character Absolute  [column] (default = [row,1]) (CHA).
 308    */
 309   public cursorCharAbsolute(params: number[]): void {
 310     let param = params[0];
 311     if (param < 1) {
 312       param = 1;
 313     }
 314     this._terminal.buffer.x = param - 1;
 315   }
 316
 317   /**
 318    * CSI Ps ; Ps H
 319    * Cursor Position [row;column] (default = [1,1]) (CUP).
 320    */
 321   public cursorPosition(params: number[]): void {
 322     let row, col;
 323
 324     row = params[0] - 1;
 325
 326     if (params.length >= 2) {
 327       col = params[1] - 1;
 328     } else {
 329       col = 0;
 330     }
 331
 332     if (row < 0) {
 333       row = 0;
 334     } else if (row >= this._terminal.rows) {
 335       row = this._terminal.rows - 1;
 336     }
 337
 338     if (col < 0) {
 339       col = 0;
 340     } else if (col >= this._terminal.cols) {
 341       col = this._terminal.cols - 1;
 342     }
 343
 344     this._terminal.buffer.x = col;
 345     this._terminal.buffer.y = row;
 346   }
 347
 348   /**
 349    * CSI Ps I
 350    *   Cursor Forward Tabulation Ps tab stops (default = 1) (CHT).
 351    */
 352   public cursorForwardTab(params: number[]): void {
 353     let param = params[0] || 1;
 354     while (param--) {
 355       this._terminal.buffer.x = this._terminal.nextStop();
 356     }
 357   }
 358
 359   /**
 360    * CSI Ps J  Erase in Display (ED).
 361    *     Ps = 0  -> Erase Below (default).
 362    *     Ps = 1  -> Erase Above.
 363    *     Ps = 2  -> Erase All.
 364    *     Ps = 3  -> Erase Saved Lines (xterm).
 365    * CSI ? Ps J
 366    *   Erase in Display (DECSED).
 367    *     Ps = 0  -> Selective Erase Below (default).
 368    *     Ps = 1  -> Selective Erase Above.
 369    *     Ps = 2  -> Selective Erase All.
 370    */
 371   public eraseInDisplay(params: number[]): void {
 372     let j;
 373     switch (params[0]) {
 374       case 0:
 375         this._terminal.eraseRight(this._terminal.buffer.x, this._terminal.buffer.y);
 376         j = this._terminal.buffer.y + 1;
 377         for (; j < this._terminal.rows; j++) {
 378           this._terminal.eraseLine(j);
 379         }
 380         break;
 381       case 1:
 382         this._terminal.eraseLeft(this._terminal.buffer.x, this._terminal.buffer.y);
 383         j = this._terminal.buffer.y;
 384         while (j--) {
 385           this._terminal.eraseLine(j);
 386         }
 387         break;
 388       case 2:
 389         j = this._terminal.rows;
 390         while (j--) this._terminal.eraseLine(j);
 391         break;
 392       case 3:
 393         // Clear scrollback (everything not in viewport)
 394         const scrollBackSize = this._terminal.buffer.lines.length - this._terminal.rows;
 395         if (scrollBackSize > 0) {
 396           this._terminal.buffer.lines.trimStart(scrollBackSize);
 397           this._terminal.buffer.ybase = Math.max(this._terminal.buffer.ybase - scrollBackSize, 0);
 398           this._terminal.buffer.ydisp = Math.max(this._terminal.buffer.ydisp - scrollBackSize, 0);
 399           // Force a scroll event to refresh viewport
 400           this._terminal.emit('scroll', 0);
 401         }
 402         break;
 403     }
 404   }
 405
 406   /**
 407    * CSI Ps K  Erase in Line (EL).
 408    *     Ps = 0  -> Erase to Right (default).
 409    *     Ps = 1  -> Erase to Left.
 410    *     Ps = 2  -> Erase All.
 411    * CSI ? Ps K
 412    *   Erase in Line (DECSEL).
 413    *     Ps = 0  -> Selective Erase to Right (default).
 414    *     Ps = 1  -> Selective Erase to Left.
 415    *     Ps = 2  -> Selective Erase All.
 416    */
 417   public eraseInLine(params: number[]): void {
 418     switch (params[0]) {
 419       case 0:
 420         this._terminal.eraseRight(this._terminal.buffer.x, this._terminal.buffer.y);
 421         break;
 422       case 1:
 423         this._terminal.eraseLeft(this._terminal.buffer.x, this._terminal.buffer.y);
 424         break;
 425       case 2:
 426         this._terminal.eraseLine(this._terminal.buffer.y);
 427         break;
 428     }
 429   }
 430
 431   /**
 432    * CSI Ps L
 433    * Insert Ps Line(s) (default = 1) (IL).
 434    */
 435   public insertLines(params: number[]): void {
 436     let param, row, j;
 437
 438     param = params[0];
 439     if (param < 1) {
 440       param = 1;
 441     }
 442     row = this._terminal.buffer.y + this._terminal.buffer.ybase;
 443
 444     j = this._terminal.rows - 1 - this._terminal.buffer.scrollBottom;
 445     j = this._terminal.rows - 1 + this._terminal.buffer.ybase - j + 1;
 446
 447     while (param--) {
 448       if (this._terminal.buffer.lines.length === this._terminal.buffer.lines.maxLength) {
 449         // Trim the start of lines to make room for the new line
 450         this._terminal.buffer.lines.trimStart(1);
 451         this._terminal.buffer.ybase--;
 452         this._terminal.buffer.ydisp--;
 453         row--;
 454         j--;
 455       }
 456       // test: echo -e '\e[44m\e[1L\e[0m'
 457       // blankLine(true) - xterm/linux behavior
 458       this._terminal.buffer.lines.splice(row, 0, this._terminal.blankLine(true));
 459       this._terminal.buffer.lines.splice(j, 1);
 460     }
 461
 462     // this.maxRange();
 463     this._terminal.updateRange(this._terminal.buffer.y);
 464     this._terminal.updateRange(this._terminal.buffer.scrollBottom);
 465   }
 466
 467   /**
 468    * CSI Ps M
 469    * Delete Ps Line(s) (default = 1) (DL).
 470    */
 471   public deleteLines(params: number[]): void {
 472     let param, row, j;
 473
 474     param = params[0];
 475     if (param < 1) {
 476       param = 1;
 477     }
 478     row = this._terminal.buffer.y + this._terminal.buffer.ybase;
 479
 480     j = this._terminal.rows - 1 - this._terminal.buffer.scrollBottom;
 481     j = this._terminal.rows - 1 + this._terminal.buffer.ybase - j;
 482
 483     while (param--) {
 484       if (this._terminal.buffer.lines.length === this._terminal.buffer.lines.maxLength) {
 485         // Trim the start of lines to make room for the new line
 486         this._terminal.buffer.lines.trimStart(1);
 487         this._terminal.buffer.ybase -= 1;
 488         this._terminal.buffer.ydisp -= 1;
 489       }
 490       // test: echo -e '\e[44m\e[1M\e[0m'
 491       // blankLine(true) - xterm/linux behavior
 492       this._terminal.buffer.lines.splice(j + 1, 0, this._terminal.blankLine(true));
 493       this._terminal.buffer.lines.splice(row, 1);
 494     }
 495
 496     // this.maxRange();
 497     this._terminal.updateRange(this._terminal.buffer.y);
 498     this._terminal.updateRange(this._terminal.buffer.scrollBottom);
 499   }
 500
 501   /**
 502    * CSI Ps P
 503    * Delete Ps Character(s) (default = 1) (DCH).
 504    */
 505   public deleteChars(params: number[]): void {
 506     let param, row, ch;
 507
 508     param = params[0];
 509     if (param < 1) {
 510       param = 1;
 511     }
 512
 513     row = this._terminal.buffer.y + this._terminal.buffer.ybase;
 514     ch = [this._terminal.eraseAttr(), ' ', 1]; // xterm
 515
 516     while (param--) {
 517       this._terminal.buffer.lines.get(row).splice(this._terminal.buffer.x, 1);
 518       this._terminal.buffer.lines.get(row).push(ch);
 519     }
 520   }
 521
 522   /**
 523    * CSI Ps S  Scroll up Ps lines (default = 1) (SU).
 524    */
 525   public scrollUp(params: number[]): void {
 526     let param = params[0] || 1;
 527     while (param--) {
 528       this._terminal.buffer.lines.splice(this._terminal.buffer.ybase + this._terminal.buffer.scrollTop, 1);
 529       this._terminal.buffer.lines.splice(this._terminal.buffer.ybase + this._terminal.buffer.scrollBottom, 0, this._terminal.blankLine());
 530     }
 531     // this.maxRange();
 532     this._terminal.updateRange(this._terminal.buffer.scrollTop);
 533     this._terminal.updateRange(this._terminal.buffer.scrollBottom);
 534   }
 535
 536   /**
 537    * CSI Ps T  Scroll down Ps lines (default = 1) (SD).
 538    */
 539   public scrollDown(params: number[]): void {
 540     let param = params[0] || 1;
 541     while (param--) {
 542       this._terminal.buffer.lines.splice(this._terminal.buffer.ybase + this._terminal.buffer.scrollBottom, 1);
 543       this._terminal.buffer.lines.splice(this._terminal.buffer.ybase + this._terminal.buffer.scrollTop, 0, this._terminal.blankLine());
 544     }
 545     // this.maxRange();
 546     this._terminal.updateRange(this._terminal.buffer.scrollTop);
 547     this._terminal.updateRange(this._terminal.buffer.scrollBottom);
 548   }
 549
 550   /**
 551    * CSI Ps X
 552    * Erase Ps Character(s) (default = 1) (ECH).
 553    */
 554   public eraseChars(params: number[]): void {
 555     let param, row, j, ch;
 556
 557     param = params[0];
 558     if (param < 1) {
 559       param = 1;
 560     }
 561
 562     row = this._terminal.buffer.y + this._terminal.buffer.ybase;
 563     j = this._terminal.buffer.x;
 564     ch = [this._terminal.eraseAttr(), ' ', 1]; // xterm
 565
 566     while (param-- && j < this._terminal.cols) {
 567       this._terminal.buffer.lines.get(row)[j++] = ch;
 568     }
 569   }
 570
 571   /**
 572    * CSI Ps Z  Cursor Backward Tabulation Ps tab stops (default = 1) (CBT).
 573    */
 574   public cursorBackwardTab(params: number[]): void {
 575     let param = params[0] || 1;
 576     while (param--) {
 577       this._terminal.buffer.x = this._terminal.prevStop();
 578     }
 579   }
 580
 581   /**
 582    * CSI Pm `  Character Position Absolute
 583    *   [column] (default = [row,1]) (HPA).
 584    */
 585   public charPosAbsolute(params: number[]): void {
 586     let param = params[0];
 587     if (param < 1) {
 588       param = 1;
 589     }
 590     this._terminal.buffer.x = param - 1;
 591     if (this._terminal.buffer.x >= this._terminal.cols) {
 592       this._terminal.buffer.x = this._terminal.cols - 1;
 593     }
 594   }
 595
 596   /**
 597    * CSI Pm a  Character Position Relative
 598    *   [columns] (default = [row,col+1]) (HPR)
 599    * reuse CSI Ps C ?
 600    */
 601   public HPositionRelative(params: number[]): void {
 602     let param = params[0];
 603     if (param < 1) {
 604       param = 1;
 605     }
 606     this._terminal.buffer.x += param;
 607     if (this._terminal.buffer.x >= this._terminal.cols) {
 608       this._terminal.buffer.x = this._terminal.cols - 1;
 609     }
 610   }
 611
 612   /**
 613    * CSI Ps b  Repeat the preceding graphic character Ps times (REP).
 614    */
 615   public repeatPrecedingCharacter(params: number[]): void {
 616     let param = params[0] || 1
 617       , line = this._terminal.buffer.lines.get(this._terminal.buffer.ybase + this._terminal.buffer.y)
 618       , ch = line[this._terminal.buffer.x - 1] || [this._terminal.defAttr, ' ', 1];
 619
 620     while (param--) {
 621       line[this._terminal.buffer.x++] = ch;
 622     }
 623   }
 624
 625   /**
 626    * CSI Ps c  Send Device Attributes (Primary DA).
 627    *     Ps = 0  or omitted -> request attributes from terminal.  The
 628    *     response depends on the decTerminalID resource setting.
 629    *     -> CSI ? 1 ; 2 c  (``VT100 with Advanced Video Option'')
 630    *     -> CSI ? 1 ; 0 c  (``VT101 with No Options'')
 631    *     -> CSI ? 6 c  (``VT102'')
 632    *     -> CSI ? 6 0 ; 1 ; 2 ; 6 ; 8 ; 9 ; 1 5 ; c  (``VT220'')
 633    *   The VT100-style response parameters do not mean anything by
 634    *   themselves.  VT220 parameters do, telling the host what fea-
 635    *   tures the terminal supports:
 636    *     Ps = 1  -> 132-columns.
 637    *     Ps = 2  -> Printer.
 638    *     Ps = 6  -> Selective erase.
 639    *     Ps = 8  -> User-defined keys.
 640    *     Ps = 9  -> National replacement character sets.
 641    *     Ps = 1 5  -> Technical characters.
 642    *     Ps = 2 2  -> ANSI color, e.g., VT525.
 643    *     Ps = 2 9  -> ANSI text locator (i.e., DEC Locator mode).
 644    * CSI > Ps c
 645    *   Send Device Attributes (Secondary DA).
 646    *     Ps = 0  or omitted -> request the terminal's identification
 647    *     code.  The response depends on the decTerminalID resource set-
 648    *     ting.  It should apply only to VT220 and up, but xterm extends
 649    *     this to VT100.
 650    *     -> CSI  > Pp ; Pv ; Pc c
 651    *   where Pp denotes the terminal type
 652    *     Pp = 0  -> ``VT100''.
 653    *     Pp = 1  -> ``VT220''.
 654    *   and Pv is the firmware version (for xterm, this was originally
 655    *   the XFree86 patch number, starting with 95).  In a DEC termi-
 656    *   nal, Pc indicates the ROM cartridge registration number and is
 657    *   always zero.
 658    * More information:
 659    *   xterm/charproc.c - line 2012, for more information.
 660    *   vim responds with ^[[?0c or ^[[?1c after the terminal's response (?)
 661    */
 662   public sendDeviceAttributes(params: number[]): void {
 663     if (params[0] > 0) {
 664       return;
 665     }
 666
 667     if (!this._terminal.prefix) {
 668       if (this._terminal.is('xterm') || this._terminal.is('rxvt-unicode') || this._terminal.is('screen')) {
 669         this._terminal.send(C0.ESC + '[?1;2c');
 670       } else if (this._terminal.is('linux')) {
 671         this._terminal.send(C0.ESC + '[?6c');
 672       }
 673     } else if (this._terminal.prefix === '>') {
 674       // xterm and urxvt
 675       // seem to spit this
 676       // out around ~370 times (?).
 677       if (this._terminal.is('xterm')) {
 678         this._terminal.send(C0.ESC + '[>0;276;0c');
 679       } else if (this._terminal.is('rxvt-unicode')) {
 680         this._terminal.send(C0.ESC + '[>85;95;0c');
 681       } else if (this._terminal.is('linux')) {
 682         // not supported by linux console.
 683         // linux console echoes parameters.
 684         this._terminal.send(params[0] + 'c');
 685       } else if (this._terminal.is('screen')) {
 686         this._terminal.send(C0.ESC + '[>83;40003;0c');
 687       }
 688     }
 689   }
 690
 691   /**
 692    * CSI Pm d  Vertical Position Absolute (VPA)
 693    *   [row] (default = [1,column])
 694    */
 695   public linePosAbsolute(params: number[]): void {
 696     let param = params[0];
 697     if (param < 1) {
 698       param = 1;
 699     }
 700     this._terminal.buffer.y = param - 1;
 701     if (this._terminal.buffer.y >= this._terminal.rows) {
 702       this._terminal.buffer.y = this._terminal.rows - 1;
 703     }
 704   }
 705
 706   /**
 707    * CSI Pm e  Vertical Position Relative (VPR)
 708    *   [rows] (default = [row+1,column])
 709    * reuse CSI Ps B ?
 710    */
 711   public VPositionRelative(params: number[]): void {
 712     let param = params[0];
 713     if (param < 1) {
 714       param = 1;
 715     }
 716     this._terminal.buffer.y += param;
 717     if (this._terminal.buffer.y >= this._terminal.rows) {
 718       this._terminal.buffer.y = this._terminal.rows - 1;
 719     }
 720     // If the end of the line is hit, prevent this action from wrapping around to the next line.
 721     if (this._terminal.buffer.x >= this._terminal.cols) {
 722       this._terminal.buffer.x--;
 723     }
 724   }
 725
 726   /**
 727    * CSI Ps ; Ps f
 728    *   Horizontal and Vertical Position [row;column] (default =
 729    *   [1,1]) (HVP).
 730    */
 731   public HVPosition(params: number[]): void {
 732     if (params[0] < 1) params[0] = 1;
 733     if (params[1] < 1) params[1] = 1;
 734
 735     this._terminal.buffer.y = params[0] - 1;
 736     if (this._terminal.buffer.y >= this._terminal.rows) {
 737       this._terminal.buffer.y = this._terminal.rows - 1;
 738     }
 739
 740     this._terminal.buffer.x = params[1] - 1;
 741     if (this._terminal.buffer.x >= this._terminal.cols) {
 742       this._terminal.buffer.x = this._terminal.cols - 1;
 743     }
 744   }
 745
 746   /**
 747    * CSI Ps g  Tab Clear (TBC).
 748    *     Ps = 0  -> Clear Current Column (default).
 749    *     Ps = 3  -> Clear All.
 750    * Potentially:
 751    *   Ps = 2  -> Clear Stops on Line.
 752    *   http://vt100.net/annarbor/aaa-ug/section6.html
 753    */
 754   public tabClear(params: number[]): void {
 755     let param = params[0];
 756     if (param <= 0) {
 757       delete this._terminal.buffer.tabs[this._terminal.buffer.x];
 758     } else if (param === 3) {
 759       this._terminal.buffer.tabs = {};
 760     }
 761   }
 762
 763   /**
 764    * CSI Pm h  Set Mode (SM).
 765    *     Ps = 2  -> Keyboard Action Mode (AM).
 766    *     Ps = 4  -> Insert Mode (IRM).
 767    *     Ps = 1 2  -> Send/receive (SRM).
 768    *     Ps = 2 0  -> Automatic Newline (LNM).
 769    * CSI ? Pm h
 770    *   DEC Private Mode Set (DECSET).
 771    *     Ps = 1  -> Application Cursor Keys (DECCKM).
 772    *     Ps = 2  -> Designate USASCII for character sets G0-G3
 773    *     (DECANM), and set VT100 mode.
 774    *     Ps = 3  -> 132 Column Mode (DECCOLM).
 775    *     Ps = 4  -> Smooth (Slow) Scroll (DECSCLM).
 776    *     Ps = 5  -> Reverse Video (DECSCNM).
 777    *     Ps = 6  -> Origin Mode (DECOM).
 778    *     Ps = 7  -> Wraparound Mode (DECAWM).
 779    *     Ps = 8  -> Auto-repeat Keys (DECARM).
 780    *     Ps = 9  -> Send Mouse X & Y on button press.  See the sec-
 781    *     tion Mouse Tracking.
 782    *     Ps = 1 0  -> Show toolbar (rxvt).
 783    *     Ps = 1 2  -> Start Blinking Cursor (att610).
 784    *     Ps = 1 8  -> Print form feed (DECPFF).
 785    *     Ps = 1 9  -> Set print extent to full screen (DECPEX).
 786    *     Ps = 2 5  -> Show Cursor (DECTCEM).
 787    *     Ps = 3 0  -> Show scrollbar (rxvt).
 788    *     Ps = 3 5  -> Enable font-shifting functions (rxvt).
 789    *     Ps = 3 8  -> Enter Tektronix Mode (DECTEK).
 790    *     Ps = 4 0  -> Allow 80 -> 132 Mode.
 791    *     Ps = 4 1  -> more(1) fix (see curses resource).
 792    *     Ps = 4 2  -> Enable Nation Replacement Character sets (DECN-
 793    *     RCM).
 794    *     Ps = 4 4  -> Turn On Margin Bell.
 795    *     Ps = 4 5  -> Reverse-wraparound Mode.
 796    *     Ps = 4 6  -> Start Logging.  This is normally disabled by a
 797    *     compile-time option.
 798    *     Ps = 4 7  -> Use Alternate Screen Buffer.  (This may be dis-
 799    *     abled by the titeInhibit resource).
 800    *     Ps = 6 6  -> Application keypad (DECNKM).
 801    *     Ps = 6 7  -> Backarrow key sends backspace (DECBKM).
 802    *     Ps = 1 0 0 0  -> Send Mouse X & Y on button press and
 803    *     release.  See the section Mouse Tracking.
 804    *     Ps = 1 0 0 1  -> Use Hilite Mouse Tracking.
 805    *     Ps = 1 0 0 2  -> Use Cell Motion Mouse Tracking.
 806    *     Ps = 1 0 0 3  -> Use All Motion Mouse Tracking.
 807    *     Ps = 1 0 0 4  -> Send FocusIn/FocusOut events.
 808    *     Ps = 1 0 0 5  -> Enable Extended Mouse Mode.
 809    *     Ps = 1 0 1 0  -> Scroll to bottom on tty output (rxvt).
 810    *     Ps = 1 0 1 1  -> Scroll to bottom on key press (rxvt).
 811    *     Ps = 1 0 3 4  -> Interpret "meta" key, sets eighth bit.
 812    *     (enables the eightBitInput resource).
 813    *     Ps = 1 0 3 5  -> Enable special modifiers for Alt and Num-
 814    *     Lock keys.  (This enables the numLock resource).
 815    *     Ps = 1 0 3 6  -> Send ESC   when Meta modifies a key.  (This
 816    *     enables the metaSendsEscape resource).
 817    *     Ps = 1 0 3 7  -> Send DEL from the editing-keypad Delete
 818    *     key.
 819    *     Ps = 1 0 3 9  -> Send ESC  when Alt modifies a key.  (This
 820    *     enables the altSendsEscape resource).
 821    *     Ps = 1 0 4 0  -> Keep selection even if not highlighted.
 822    *     (This enables the keepSelection resource).
 823    *     Ps = 1 0 4 1  -> Use the CLIPBOARD selection.  (This enables
 824    *     the selectToClipboard resource).
 825    *     Ps = 1 0 4 2  -> Enable Urgency window manager hint when
 826    *     Control-G is received.  (This enables the bellIsUrgent
 827    *     resource).
 828    *     Ps = 1 0 4 3  -> Enable raising of the window when Control-G
 829    *     is received.  (enables the popOnBell resource).
 830    *     Ps = 1 0 4 7  -> Use Alternate Screen Buffer.  (This may be
 831    *     disabled by the titeInhibit resource).
 832    *     Ps = 1 0 4 8  -> Save cursor as in DECSC.  (This may be dis-
 833    *     abled by the titeInhibit resource).
 834    *     Ps = 1 0 4 9  -> Save cursor as in DECSC and use Alternate
 835    *     Screen Buffer, clearing it first.  (This may be disabled by
 836    *     the titeInhibit resource).  This combines the effects of the 1
 837    *     0 4 7  and 1 0 4 8  modes.  Use this with terminfo-based
 838    *     applications rather than the 4 7  mode.
 839    *     Ps = 1 0 5 0  -> Set terminfo/termcap function-key mode.
 840    *     Ps = 1 0 5 1  -> Set Sun function-key mode.
 841    *     Ps = 1 0 5 2  -> Set HP function-key mode.
 842    *     Ps = 1 0 5 3  -> Set SCO function-key mode.
 843    *     Ps = 1 0 6 0  -> Set legacy keyboard emulation (X11R6).
 844    *     Ps = 1 0 6 1  -> Set VT220 keyboard emulation.
 845    *     Ps = 2 0 0 4  -> Set bracketed paste mode.
 846    * Modes:
 847    *   http: *vt100.net/docs/vt220-rm/chapter4.html
 848    */
 849   public setMode(params: number[]): void {
 850     if (params.length > 1) {
 851       for (let i = 0; i < params.length; i++) {
 852         this.setMode([params[i]]);
 853       }
 854
 855       return;
 856     }
 857
 858     if (!this._terminal.prefix) {
 859       switch (params[0]) {
 860         case 4:
 861           this._terminal.insertMode = true;
 862           break;
 863         case 20:
 864           // this._terminal.convertEol = true;
 865           break;
 866       }
 867     } else if (this._terminal.prefix === '?') {
 868       switch (params[0]) {
 869         case 1:
 870           this._terminal.applicationCursor = true;
 871           break;
 872         case 2:
 873           this._terminal.setgCharset(0, DEFAULT_CHARSET);
 874           this._terminal.setgCharset(1, DEFAULT_CHARSET);
 875           this._terminal.setgCharset(2, DEFAULT_CHARSET);
 876           this._terminal.setgCharset(3, DEFAULT_CHARSET);
 877           // set VT100 mode here
 878           break;
 879         case 3: // 132 col mode
 880           this._terminal.savedCols = this._terminal.cols;
 881           this._terminal.resize(132, this._terminal.rows);
 882           break;
 883         case 6:
 884           this._terminal.originMode = true;
 885           break;
 886         case 7:
 887           this._terminal.wraparoundMode = true;
 888           break;
 889         case 12:
 890           // this.cursorBlink = true;
 891           break;
 892         case 66:
 893           this._terminal.log('Serial port requested application keypad.');
 894           this._terminal.applicationKeypad = true;
 895           this._terminal.viewport.syncScrollArea();
 896           break;
 897         case 9: // X10 Mouse
 898           // no release, no motion, no wheel, no modifiers.
 899         case 1000: // vt200 mouse
 900           // no motion.
 901           // no modifiers, except control on the wheel.
 902         case 1002: // button event mouse
 903         case 1003: // any event mouse
 904           // any event - sends motion events,
 905           // even if there is no button held down.
 906
 907           // TODO: Why are params[0] compares nested within a switch for params[0]?
 908
 909           this._terminal.x10Mouse = params[0] === 9;
 910           this._terminal.vt200Mouse = params[0] === 1000;
 911           this._terminal.normalMouse = params[0] > 1000;
 912           this._terminal.mouseEvents = true;
 913           this._terminal.element.classList.add('enable-mouse-events');
 914           this._terminal.selectionManager.disable();
 915           this._terminal.log('Binding to mouse events.');
 916           break;
 917         case 1004: // send focusin/focusout events
 918           // focusin: ^[[I
 919           // focusout: ^[[O
 920           this._terminal.sendFocus = true;
 921           break;
 922         case 1005: // utf8 ext mode mouse
 923           this._terminal.utfMouse = true;
 924           // for wide terminals
 925           // simply encodes large values as utf8 characters
 926           break;
 927         case 1006: // sgr ext mode mouse
 928           this._terminal.sgrMouse = true;
 929           // for wide terminals
 930           // does not add 32 to fields
 931           // press: ^[[<b;x;yM
 932           // release: ^[[<b;x;ym
 933           break;
 934         case 1015: // urxvt ext mode mouse
 935           this._terminal.urxvtMouse = true;
 936           // for wide terminals
 937           // numbers for fields
 938           // press: ^[[b;x;yM
 939           // motion: ^[[b;x;yT
 940           break;
 941         case 25: // show cursor
 942           this._terminal.cursorHidden = false;
 943           break;
 944         case 1049: // alt screen buffer cursor
 945           this.saveCursor(params);
 946           // FALL-THROUGH
 947         case 47: // alt screen buffer
 948         case 1047: // alt screen buffer
 949           this._terminal.buffers.activateAltBuffer();
 950           this._terminal.reset();
 951           this._terminal.viewport.syncScrollArea();
 952           this._terminal.showCursor();
 953           break;
 954       }
 955     }
 956   }
 957
 958   /**
 959    * CSI Pm l  Reset Mode (RM).
 960    *     Ps = 2  -> Keyboard Action Mode (AM).
 961    *     Ps = 4  -> Replace Mode (IRM).
 962    *     Ps = 1 2  -> Send/receive (SRM).
 963    *     Ps = 2 0  -> Normal Linefeed (LNM).
 964    * CSI ? Pm l
 965    *   DEC Private Mode Reset (DECRST).
 966    *     Ps = 1  -> Normal Cursor Keys (DECCKM).
 967    *     Ps = 2  -> Designate VT52 mode (DECANM).
 968    *     Ps = 3  -> 80 Column Mode (DECCOLM).
 969    *     Ps = 4  -> Jump (Fast) Scroll (DECSCLM).
 970    *     Ps = 5  -> Normal Video (DECSCNM).
 971    *     Ps = 6  -> Normal Cursor Mode (DECOM).
 972    *     Ps = 7  -> No Wraparound Mode (DECAWM).
 973    *     Ps = 8  -> No Auto-repeat Keys (DECARM).
 974    *     Ps = 9  -> Don't send Mouse X & Y on button press.
 975    *     Ps = 1 0  -> Hide toolbar (rxvt).
 976    *     Ps = 1 2  -> Stop Blinking Cursor (att610).
 977    *     Ps = 1 8  -> Don't print form feed (DECPFF).
 978    *     Ps = 1 9  -> Limit print to scrolling region (DECPEX).
 979    *     Ps = 2 5  -> Hide Cursor (DECTCEM).
 980    *     Ps = 3 0  -> Don't show scrollbar (rxvt).
 981    *     Ps = 3 5  -> Disable font-shifting functions (rxvt).
 982    *     Ps = 4 0  -> Disallow 80 -> 132 Mode.
 983    *     Ps = 4 1  -> No more(1) fix (see curses resource).
 984    *     Ps = 4 2  -> Disable Nation Replacement Character sets (DEC-
 985    *     NRCM).
 986    *     Ps = 4 4  -> Turn Off Margin Bell.
 987    *     Ps = 4 5  -> No Reverse-wraparound Mode.
 988    *     Ps = 4 6  -> Stop Logging.  (This is normally disabled by a
 989    *     compile-time option).
 990    *     Ps = 4 7  -> Use Normal Screen Buffer.
 991    *     Ps = 6 6  -> Numeric keypad (DECNKM).
 992    *     Ps = 6 7  -> Backarrow key sends delete (DECBKM).
 993    *     Ps = 1 0 0 0  -> Don't send Mouse X & Y on button press and
 994    *     release.  See the section Mouse Tracking.
 995    *     Ps = 1 0 0 1  -> Don't use Hilite Mouse Tracking.
 996    *     Ps = 1 0 0 2  -> Don't use Cell Motion Mouse Tracking.
 997    *     Ps = 1 0 0 3  -> Don't use All Motion Mouse Tracking.
 998    *     Ps = 1 0 0 4  -> Don't send FocusIn/FocusOut events.
 999    *     Ps = 1 0 0 5  -> Disable Extended Mouse Mode.
1000    *     Ps = 1 0 1 0  -> Don't scroll to bottom on tty output
1001    *     (rxvt).
1002    *     Ps = 1 0 1 1  -> Don't scroll to bottom on key press (rxvt).
1003    *     Ps = 1 0 3 4  -> Don't interpret "meta" key.  (This disables
1004    *     the eightBitInput resource).
1005    *     Ps = 1 0 3 5  -> Disable special modifiers for Alt and Num-
1006    *     Lock keys.  (This disables the numLock resource).
1007    *     Ps = 1 0 3 6  -> Don't send ESC  when Meta modifies a key.
1008    *     (This disables the metaSendsEscape resource).
1009    *     Ps = 1 0 3 7  -> Send VT220 Remove from the editing-keypad
1010    *     Delete key.
1011    *     Ps = 1 0 3 9  -> Don't send ESC  when Alt modifies a key.
1012    *     (This disables the altSendsEscape resource).
1013    *     Ps = 1 0 4 0  -> Do not keep selection when not highlighted.
1014    *     (This disables the keepSelection resource).
1015    *     Ps = 1 0 4 1  -> Use the PRIMARY selection.  (This disables
1016    *     the selectToClipboard resource).
1017    *     Ps = 1 0 4 2  -> Disable Urgency window manager hint when
1018    *     Control-G is received.  (This disables the bellIsUrgent
1019    *     resource).
1020    *     Ps = 1 0 4 3  -> Disable raising of the window when Control-
1021    *     G is received.  (This disables the popOnBell resource).
1022    *     Ps = 1 0 4 7  -> Use Normal Screen Buffer, clearing screen
1023    *     first if in the Alternate Screen.  (This may be disabled by
1024    *     the titeInhibit resource).
1025    *     Ps = 1 0 4 8  -> Restore cursor as in DECRC.  (This may be
1026    *     disabled by the titeInhibit resource).
1027    *     Ps = 1 0 4 9  -> Use Normal Screen Buffer and restore cursor
1028    *     as in DECRC.  (This may be disabled by the titeInhibit
1029    *     resource).  This combines the effects of the 1 0 4 7  and 1 0
1030    *     4 8  modes.  Use this with terminfo-based applications rather
1031    *     than the 4 7  mode.
1032    *     Ps = 1 0 5 0  -> Reset terminfo/termcap function-key mode.
1033    *     Ps = 1 0 5 1  -> Reset Sun function-key mode.
1034    *     Ps = 1 0 5 2  -> Reset HP function-key mode.
1035    *     Ps = 1 0 5 3  -> Reset SCO function-key mode.
1036    *     Ps = 1 0 6 0  -> Reset legacy keyboard emulation (X11R6).
1037    *     Ps = 1 0 6 1  -> Reset keyboard emulation to Sun/PC style.
1038    *     Ps = 2 0 0 4  -> Reset bracketed paste mode.
1039    */
1040   public resetMode(params: number[]): void {
1041     if (params.length > 1) {
1042       for (let i = 0; i < params.length; i++) {
1043         this.resetMode([params[i]]);
1044       }
1045
1046       return;
1047     }
1048
1049     if (!this._terminal.prefix) {
1050       switch (params[0]) {
1051         case 4:
1052           this._terminal.insertMode = false;
1053           break;
1054         case 20:
1055           // this._terminal.convertEol = false;
1056           break;
1057       }
1058     } else if (this._terminal.prefix === '?') {
1059       switch (params[0]) {
1060         case 1:
1061           this._terminal.applicationCursor = false;
1062           break;
1063         case 3:
1064           if (this._terminal.cols === 132 && this._terminal.savedCols) {
1065             this._terminal.resize(this._terminal.savedCols, this._terminal.rows);
1066           }
1067           delete this._terminal.savedCols;
1068           break;
1069         case 6:
1070           this._terminal.originMode = false;
1071           break;
1072         case 7:
1073           this._terminal.wraparoundMode = false;
1074           break;
1075         case 12:
1076           // this.cursorBlink = false;
1077           break;
1078         case 66:
1079           this._terminal.log('Switching back to normal keypad.');
1080           this._terminal.applicationKeypad = false;
1081           this._terminal.viewport.syncScrollArea();
1082           break;
1083         case 9: // X10 Mouse
1084         case 1000: // vt200 mouse
1085         case 1002: // button event mouse
1086         case 1003: // any event mouse
1087           this._terminal.x10Mouse = false;
1088           this._terminal.vt200Mouse = false;
1089           this._terminal.normalMouse = false;
1090           this._terminal.mouseEvents = false;
1091           this._terminal.element.classList.remove('enable-mouse-events');
1092           this._terminal.selectionManager.enable();
1093           break;
1094         case 1004: // send focusin/focusout events
1095           this._terminal.sendFocus = false;
1096           break;
1097         case 1005: // utf8 ext mode mouse
1098           this._terminal.utfMouse = false;
1099           break;
1100         case 1006: // sgr ext mode mouse
1101           this._terminal.sgrMouse = false;
1102           break;
1103         case 1015: // urxvt ext mode mouse
1104           this._terminal.urxvtMouse = false;
1105           break;
1106         case 25: // hide cursor
1107           this._terminal.cursorHidden = true;
1108           break;
1109         case 1049: // alt screen buffer cursor
1110           ; // FALL-THROUGH
1111         case 47: // normal screen buffer
1112         case 1047: // normal screen buffer - clearing it first
1113           // Ensure the selection manager has the correct buffer
1114           this._terminal.buffers.activateNormalBuffer();
1115           if (params[0] === 1049) {
1116             this.restoreCursor(params);
1117           }
1118           this._terminal.selectionManager.setBuffer(this._terminal.buffer.lines);
1119           this._terminal.refresh(0, this._terminal.rows - 1);
1120           this._terminal.viewport.syncScrollArea();
1121           this._terminal.showCursor();
1122           break;
1123       }
1124     }
1125   }
1126
1127   /**
1128    * CSI Pm m  Character Attributes (SGR).
1129    *     Ps = 0  -> Normal (default).
1130    *     Ps = 1  -> Bold.
1131    *     Ps = 4  -> Underlined.
1132    *     Ps = 5  -> Blink (appears as Bold).
1133    *     Ps = 7  -> Inverse.
1134    *     Ps = 8  -> Invisible, i.e., hidden (VT300).
1135    *     Ps = 2 2  -> Normal (neither bold nor faint).
1136    *     Ps = 2 4  -> Not underlined.
1137    *     Ps = 2 5  -> Steady (not blinking).
1138    *     Ps = 2 7  -> Positive (not inverse).
1139    *     Ps = 2 8  -> Visible, i.e., not hidden (VT300).
1140    *     Ps = 3 0  -> Set foreground color to Black.
1141    *     Ps = 3 1  -> Set foreground color to Red.
1142    *     Ps = 3 2  -> Set foreground color to Green.
1143    *     Ps = 3 3  -> Set foreground color to Yellow.
1144    *     Ps = 3 4  -> Set foreground color to Blue.
1145    *     Ps = 3 5  -> Set foreground color to Magenta.
1146    *     Ps = 3 6  -> Set foreground color to Cyan.
1147    *     Ps = 3 7  -> Set foreground color to White.
1148    *     Ps = 3 9  -> Set foreground color to default (original).
1149    *     Ps = 4 0  -> Set background color to Black.
1150    *     Ps = 4 1  -> Set background color to Red.
1151    *     Ps = 4 2  -> Set background color to Green.
1152    *     Ps = 4 3  -> Set background color to Yellow.
1153    *     Ps = 4 4  -> Set background color to Blue.
1154    *     Ps = 4 5  -> Set background color to Magenta.
1155    *     Ps = 4 6  -> Set background color to Cyan.
1156    *     Ps = 4 7  -> Set background color to White.
1157    *     Ps = 4 9  -> Set background color to default (original).
1158    *
1159    *   If 16-color support is compiled, the following apply.  Assume
1160    *   that xterm's resources are set so that the ISO color codes are
1161    *   the first 8 of a set of 16.  Then the aixterm colors are the
1162    *   bright versions of the ISO colors:
1163    *     Ps = 9 0  -> Set foreground color to Black.
1164    *     Ps = 9 1  -> Set foreground color to Red.
1165    *     Ps = 9 2  -> Set foreground color to Green.
1166    *     Ps = 9 3  -> Set foreground color to Yellow.
1167    *     Ps = 9 4  -> Set foreground color to Blue.
1168    *     Ps = 9 5  -> Set foreground color to Magenta.
1169    *     Ps = 9 6  -> Set foreground color to Cyan.
1170    *     Ps = 9 7  -> Set foreground color to White.
1171    *     Ps = 1 0 0  -> Set background color to Black.
1172    *     Ps = 1 0 1  -> Set background color to Red.
1173    *     Ps = 1 0 2  -> Set background color to Green.
1174    *     Ps = 1 0 3  -> Set background color to Yellow.
1175    *     Ps = 1 0 4  -> Set background color to Blue.
1176    *     Ps = 1 0 5  -> Set background color to Magenta.
1177    *     Ps = 1 0 6  -> Set background color to Cyan.
1178    *     Ps = 1 0 7  -> Set background color to White.
1179    *
1180    *   If xterm is compiled with the 16-color support disabled, it
1181    *   supports the following, from rxvt:
1182    *     Ps = 1 0 0  -> Set foreground and background color to
1183    *     default.
1184    *
1185    *   If 88- or 256-color support is compiled, the following apply.
1186    *     Ps = 3 8  ; 5  ; Ps -> Set foreground color to the second
1187    *     Ps.
1188    *     Ps = 4 8  ; 5  ; Ps -> Set background color to the second
1189    *     Ps.
1190    */
1191   public charAttributes(params: number[]): void {
1192     // Optimize a single SGR0.
1193     if (params.length === 1 && params[0] === 0) {
1194       this._terminal.curAttr = this._terminal.defAttr;
1195       return;
1196     }
1197
1198     let l = params.length
1199     , i = 0
1200     , flags = this._terminal.curAttr >> 18
1201     , fg = (this._terminal.curAttr >> 9) & 0x1ff
1202     , bg = this._terminal.curAttr & 0x1ff
1203     , p;
1204
1205     for (; i < l; i++) {
1206       p = params[i];
1207       if (p >= 30 && p <= 37) {
1208         // fg color 8
1209         fg = p - 30;
1210       } else if (p >= 40 && p <= 47) {
1211         // bg color 8
1212         bg = p - 40;
1213       } else if (p >= 90 && p <= 97) {
1214         // fg color 16
1215         p += 8;
1216         fg = p - 90;
1217       } else if (p >= 100 && p <= 107) {
1218         // bg color 16
1219         p += 8;
1220         bg = p - 100;
1221       } else if (p === 0) {
1222         // default
1223         flags = this._terminal.defAttr >> 18;
1224         fg = (this._terminal.defAttr >> 9) & 0x1ff;
1225         bg = this._terminal.defAttr & 0x1ff;
1226         // flags = 0;
1227         // fg = 0x1ff;
1228         // bg = 0x1ff;
1229       } else if (p === 1) {
1230         // bold text
1231         flags |= 1;
1232       } else if (p === 4) {
1233         // underlined text
1234         flags |= 2;
1235       } else if (p === 5) {
1236         // blink
1237         flags |= 4;
1238       } else if (p === 7) {
1239         // inverse and positive
1240         // test with: echo -e '\e[31m\e[42mhello\e[7mworld\e[27mhi\e[m'
1241         flags |= 8;
1242       } else if (p === 8) {
1243         // invisible
1244         flags |= 16;
1245       } else if (p === 22) {
1246         // not bold
1247         flags &= ~1;
1248       } else if (p === 24) {
1249         // not underlined
1250         flags &= ~2;
1251       } else if (p === 25) {
1252         // not blink
1253         flags &= ~4;
1254       } else if (p === 27) {
1255         // not inverse
1256         flags &= ~8;
1257       } else if (p === 28) {
1258         // not invisible
1259         flags &= ~16;
1260       } else if (p === 39) {
1261         // reset fg
1262         fg = (this._terminal.defAttr >> 9) & 0x1ff;
1263       } else if (p === 49) {
1264         // reset bg
1265         bg = this._terminal.defAttr & 0x1ff;
1266       } else if (p === 38) {
1267         // fg color 256
1268         if (params[i + 1] === 2) {
1269           i += 2;
1270           fg = this._terminal.matchColor(
1271             params[i] & 0xff,
1272             params[i + 1] & 0xff,
1273             params[i + 2] & 0xff);
1274           if (fg === -1) fg = 0x1ff;
1275           i += 2;
1276         } else if (params[i + 1] === 5) {
1277           i += 2;
1278           p = params[i] & 0xff;
1279           fg = p;
1280         }
1281       } else if (p === 48) {
1282         // bg color 256
1283         if (params[i + 1] === 2) {
1284           i += 2;
1285           bg = this._terminal.matchColor(
1286             params[i] & 0xff,
1287             params[i + 1] & 0xff,
1288             params[i + 2] & 0xff);
1289           if (bg === -1) bg = 0x1ff;
1290           i += 2;
1291         } else if (params[i + 1] === 5) {
1292           i += 2;
1293           p = params[i] & 0xff;
1294           bg = p;
1295         }
1296       } else if (p === 100) {
1297         // reset fg/bg
1298         fg = (this._terminal.defAttr >> 9) & 0x1ff;
1299         bg = this._terminal.defAttr & 0x1ff;
1300       } else {
1301         this._terminal.error('Unknown SGR attribute: %d.', p);
1302       }
1303     }
1304
1305     this._terminal.curAttr = (flags << 18) | (fg << 9) | bg;
1306   }
1307
1308   /**
1309    * CSI Ps n  Device Status Report (DSR).
1310    *     Ps = 5  -> Status Report.  Result (``OK'') is
1311    *   CSI 0 n
1312    *     Ps = 6  -> Report Cursor Position (CPR) [row;column].
1313    *   Result is
1314    *   CSI r ; c R
1315    * CSI ? Ps n
1316    *   Device Status Report (DSR, DEC-specific).
1317    *     Ps = 6  -> Report Cursor Position (CPR) [row;column] as CSI
1318    *     ? r ; c R (assumes page is zero).
1319    *     Ps = 1 5  -> Report Printer status as CSI ? 1 0  n  (ready).
1320    *     or CSI ? 1 1  n  (not ready).
1321    *     Ps = 2 5  -> Report UDK status as CSI ? 2 0  n  (unlocked)
1322    *     or CSI ? 2 1  n  (locked).
1323    *     Ps = 2 6  -> Report Keyboard status as
1324    *   CSI ? 2 7  ;  1  ;  0  ;  0  n  (North American).
1325    *   The last two parameters apply to VT400 & up, and denote key-
1326    *   board ready and LK01 respectively.
1327    *     Ps = 5 3  -> Report Locator status as
1328    *   CSI ? 5 3  n  Locator available, if compiled-in, or
1329    *   CSI ? 5 0  n  No Locator, if not.
1330    */
1331   public deviceStatus(params: number[]): void {
1332     if (!this._terminal.prefix) {
1333       switch (params[0]) {
1334         case 5:
1335           // status report
1336           this._terminal.send(C0.ESC + '[0n');
1337           break;
1338         case 6:
1339           // cursor position
1340           this._terminal.send(C0.ESC + '['
1341                     + (this._terminal.buffer.y + 1)
1342                     + ';'
1343                     + (this._terminal.buffer.x + 1)
1344                     + 'R');
1345           break;
1346       }
1347     } else if (this._terminal.prefix === '?') {
1348       // modern xterm doesnt seem to
1349       // respond to any of these except ?6, 6, and 5
1350       switch (params[0]) {
1351         case 6:
1352           // cursor position
1353           this._terminal.send(C0.ESC + '[?'
1354                     + (this._terminal.buffer.y + 1)
1355                     + ';'
1356                     + (this._terminal.buffer.x + 1)
1357                     + 'R');
1358           break;
1359         case 15:
1360           // no printer
1361           // this.send(C0.ESC + '[?11n');
1362           break;
1363         case 25:
1364           // dont support user defined keys
1365           // this.send(C0.ESC + '[?21n');
1366           break;
1367         case 26:
1368           // north american keyboard
1369           // this.send(C0.ESC + '[?27;1;0;0n');
1370           break;
1371         case 53:
1372           // no dec locator/mouse
1373           // this.send(C0.ESC + '[?50n');
1374           break;
1375       }
1376     }
1377   }
1378
1379   /**
1380    * CSI ! p   Soft terminal reset (DECSTR).
1381    * http://vt100.net/docs/vt220-rm/table4-10.html
1382    */
1383   public softReset(params: number[]): void {
1384     this._terminal.cursorHidden = false;
1385     this._terminal.insertMode = false;
1386     this._terminal.originMode = false;
1387     this._terminal.wraparoundMode = true;  // defaults: xterm - true, vt100 - false
1388     this._terminal.applicationKeypad = false; // ?
1389     this._terminal.viewport.syncScrollArea();
1390     this._terminal.applicationCursor = false;
1391     this._terminal.buffer.scrollTop = 0;
1392     this._terminal.buffer.scrollBottom = this._terminal.rows - 1;
1393     this._terminal.curAttr = this._terminal.defAttr;
1394     this._terminal.buffer.x = this._terminal.buffer.y = 0; // ?
1395     this._terminal.charset = null;
1396     this._terminal.glevel = 0; // ??
1397     this._terminal.charsets = [null]; // ??
1398   }
1399
1400   /**
1401    * CSI Ps SP q  Set cursor style (DECSCUSR, VT520).
1402    *   Ps = 0  -> blinking block.
1403    *   Ps = 1  -> blinking block (default).
1404    *   Ps = 2  -> steady block.
1405    *   Ps = 3  -> blinking underline.
1406    *   Ps = 4  -> steady underline.
1407    *   Ps = 5  -> blinking bar (xterm).
1408    *   Ps = 6  -> steady bar (xterm).
1409    */
1410   public setCursorStyle(params?: number[]): void {
1411     const param = params[0] < 1 ? 1 : params[0];
1412     switch (param) {
1413       case 1:
1414       case 2:
1415         this._terminal.setOption('cursorStyle', 'block');
1416         break;
1417       case 3:
1418       case 4:
1419         this._terminal.setOption('cursorStyle', 'underline');
1420         break;
1421       case 5:
1422       case 6:
1423         this._terminal.setOption('cursorStyle', 'bar');
1424         break;
1425     }
1426     const isBlinking = param % 2 === 1;
1427     this._terminal.setOption('cursorBlink', isBlinking);
1428   }
1429
1430   /**
1431    * CSI Ps ; Ps r
1432    *   Set Scrolling Region [top;bottom] (default = full size of win-
1433    *   dow) (DECSTBM).
1434    * CSI ? Pm r
1435    */
1436   public setScrollRegion(params: number[]): void {
1437     if (this._terminal.prefix) return;
1438     this._terminal.buffer.scrollTop = (params[0] || 1) - 1;
1439     this._terminal.buffer.scrollBottom = (params[1] && params[1] <= this._terminal.rows ? params[1] : this._terminal.rows) - 1;
1440     this._terminal.buffer.x = 0;
1441     this._terminal.buffer.y = 0;
1442   }
1443
1444
1445   /**
1446    * CSI s
1447    *   Save cursor (ANSI.SYS).
1448    */
1449   public saveCursor(params: number[]): void {
1450     this._terminal.buffers.active.x = this._terminal.buffer.x;
1451     this._terminal.buffers.active.y = this._terminal.buffer.y;
1452   }
1453
1454
1455   /**
1456    * CSI u
1457    *   Restore cursor (ANSI.SYS).
1458    */
1459   public restoreCursor(params: number[]): void {
1460     this._terminal.buffer.x = this._terminal.buffers.active.x || 0;
1461     this._terminal.buffer.y = this._terminal.buffers.active.y || 0;
1462   }
1463 }
1464
1465 export const wcwidth = (function(opts) {
1466     // extracted from https://www.cl.cam.ac.uk/%7Emgk25/ucs/wcwidth.c
1467     // combining characters
1468     const COMBINING_BMP = [
1469       [0x0300, 0x036F], [0x0483, 0x0486], [0x0488, 0x0489],
1470       [0x0591, 0x05BD], [0x05BF, 0x05BF], [0x05C1, 0x05C2],
1471       [0x05C4, 0x05C5], [0x05C7, 0x05C7], [0x0600, 0x0603],
1472       [0x0610, 0x0615], [0x064B, 0x065E], [0x0670, 0x0670],
1473       [0x06D6, 0x06E4], [0x06E7, 0x06E8], [0x06EA, 0x06ED],
1474       [0x070F, 0x070F], [0x0711, 0x0711], [0x0730, 0x074A],
1475       [0x07A6, 0x07B0], [0x07EB, 0x07F3], [0x0901, 0x0902],
1476       [0x093C, 0x093C], [0x0941, 0x0948], [0x094D, 0x094D],
1477       [0x0951, 0x0954], [0x0962, 0x0963], [0x0981, 0x0981],
1478       [0x09BC, 0x09BC], [0x09C1, 0x09C4], [0x09CD, 0x09CD],
1479       [0x09E2, 0x09E3], [0x0A01, 0x0A02], [0x0A3C, 0x0A3C],
1480       [0x0A41, 0x0A42], [0x0A47, 0x0A48], [0x0A4B, 0x0A4D],
1481       [0x0A70, 0x0A71], [0x0A81, 0x0A82], [0x0ABC, 0x0ABC],
1482       [0x0AC1, 0x0AC5], [0x0AC7, 0x0AC8], [0x0ACD, 0x0ACD],
1483       [0x0AE2, 0x0AE3], [0x0B01, 0x0B01], [0x0B3C, 0x0B3C],
1484       [0x0B3F, 0x0B3F], [0x0B41, 0x0B43], [0x0B4D, 0x0B4D],
1485       [0x0B56, 0x0B56], [0x0B82, 0x0B82], [0x0BC0, 0x0BC0],
1486       [0x0BCD, 0x0BCD], [0x0C3E, 0x0C40], [0x0C46, 0x0C48],
1487       [0x0C4A, 0x0C4D], [0x0C55, 0x0C56], [0x0CBC, 0x0CBC],
1488       [0x0CBF, 0x0CBF], [0x0CC6, 0x0CC6], [0x0CCC, 0x0CCD],
1489       [0x0CE2, 0x0CE3], [0x0D41, 0x0D43], [0x0D4D, 0x0D4D],
1490       [0x0DCA, 0x0DCA], [0x0DD2, 0x0DD4], [0x0DD6, 0x0DD6],
1491       [0x0E31, 0x0E31], [0x0E34, 0x0E3A], [0x0E47, 0x0E4E],
1492       [0x0EB1, 0x0EB1], [0x0EB4, 0x0EB9], [0x0EBB, 0x0EBC],
1493       [0x0EC8, 0x0ECD], [0x0F18, 0x0F19], [0x0F35, 0x0F35],
1494       [0x0F37, 0x0F37], [0x0F39, 0x0F39], [0x0F71, 0x0F7E],
1495       [0x0F80, 0x0F84], [0x0F86, 0x0F87], [0x0F90, 0x0F97],
1496       [0x0F99, 0x0FBC], [0x0FC6, 0x0FC6], [0x102D, 0x1030],
1497       [0x1032, 0x1032], [0x1036, 0x1037], [0x1039, 0x1039],
1498       [0x1058, 0x1059], [0x1160, 0x11FF], [0x135F, 0x135F],
1499       [0x1712, 0x1714], [0x1732, 0x1734], [0x1752, 0x1753],
1500       [0x1772, 0x1773], [0x17B4, 0x17B5], [0x17B7, 0x17BD],
1501       [0x17C6, 0x17C6], [0x17C9, 0x17D3], [0x17DD, 0x17DD],
1502       [0x180B, 0x180D], [0x18A9, 0x18A9], [0x1920, 0x1922],
1503       [0x1927, 0x1928], [0x1932, 0x1932], [0x1939, 0x193B],
1504       [0x1A17, 0x1A18], [0x1B00, 0x1B03], [0x1B34, 0x1B34],
1505       [0x1B36, 0x1B3A], [0x1B3C, 0x1B3C], [0x1B42, 0x1B42],
1506       [0x1B6B, 0x1B73], [0x1DC0, 0x1DCA], [0x1DFE, 0x1DFF],
1507       [0x200B, 0x200F], [0x202A, 0x202E], [0x2060, 0x2063],
1508       [0x206A, 0x206F], [0x20D0, 0x20EF], [0x302A, 0x302F],
1509       [0x3099, 0x309A], [0xA806, 0xA806], [0xA80B, 0xA80B],
1510       [0xA825, 0xA826], [0xFB1E, 0xFB1E], [0xFE00, 0xFE0F],
1511       [0xFE20, 0xFE23], [0xFEFF, 0xFEFF], [0xFFF9, 0xFFFB],
1512     ];
1513     const COMBINING_HIGH = [
1514       [0x10A01, 0x10A03], [0x10A05, 0x10A06], [0x10A0C, 0x10A0F],
1515       [0x10A38, 0x10A3A], [0x10A3F, 0x10A3F], [0x1D167, 0x1D169],
1516       [0x1D173, 0x1D182], [0x1D185, 0x1D18B], [0x1D1AA, 0x1D1AD],
1517       [0x1D242, 0x1D244], [0xE0001, 0xE0001], [0xE0020, 0xE007F],
1518       [0xE0100, 0xE01EF]
1519     ];
1520     // binary search
1521     function bisearch(ucs, data) {
1522       let min = 0;
1523       let max = data.length - 1;
1524       let mid;
1525       if (ucs < data[0][0] || ucs > data[max][1])
1526         return false;
1527       while (max >= min) {
1528         mid = (min + max) >> 1;
1529         if (ucs > data[mid][1])
1530           min = mid + 1;
1531         else if (ucs < data[mid][0])
1532           max = mid - 1;
1533         else
1534           return true;
1535       }
1536       return false;
1537     }
1538     function wcwidthBMP(ucs) {
1539       // test for 8-bit control characters
1540       if (ucs === 0)
1541         return opts.nul;
1542       if (ucs < 32 || (ucs >= 0x7f && ucs < 0xa0))
1543         return opts.control;
1544       // binary search in table of non-spacing characters
1545       if (bisearch(ucs, COMBINING_BMP))
1546         return 0;
1547       // if we arrive here, ucs is not a combining or C0/C1 control character
1548       if (isWideBMP(ucs)) {
1549         return 2;
1550       }
1551       return 1;
1552     }
1553     function isWideBMP(ucs) {
1554       return (
1555         ucs >= 0x1100 && (
1556         ucs <= 0x115f ||                // Hangul Jamo init. consonants
1557         ucs === 0x2329 ||
1558         ucs === 0x232a ||
1559         (ucs >= 0x2e80 && ucs <= 0xa4cf && ucs !== 0x303f) ||  // CJK..Yi
1560         (ucs >= 0xac00 && ucs <= 0xd7a3) ||    // Hangul Syllables
1561         (ucs >= 0xf900 && ucs <= 0xfaff) ||    // CJK Compat Ideographs
1562         (ucs >= 0xfe10 && ucs <= 0xfe19) ||    // Vertical forms
1563         (ucs >= 0xfe30 && ucs <= 0xfe6f) ||    // CJK Compat Forms
1564         (ucs >= 0xff00 && ucs <= 0xff60) ||    // Fullwidth Forms
1565         (ucs >= 0xffe0 && ucs <= 0xffe6)));
1566     }
1567     function wcwidthHigh(ucs) {
1568       if (bisearch(ucs, COMBINING_HIGH))
1569         return 0;
1570       if ((ucs >= 0x20000 && ucs <= 0x2fffd) || (ucs >= 0x30000 && ucs <= 0x3fffd)) {
1571         return 2;
1572       }
1573       return 1;
1574     }
1575     const control = opts.control | 0;
1576     let table = null;
1577     function init_table() {
1578       // lookup table for BMP
1579       const CODEPOINTS = 65536;  // BMP holds 65536 codepoints
1580       const BITWIDTH = 2;        // a codepoint can have a width of 0, 1 or 2
1581       const ITEMSIZE = 32;       // using uint32_t
1582       const CONTAINERSIZE = CODEPOINTS * BITWIDTH / ITEMSIZE;
1583       const CODEPOINTS_PER_ITEM = ITEMSIZE / BITWIDTH;
1584       table = (typeof Uint32Array === 'undefined')
1585         ? new Array(CONTAINERSIZE)
1586         : new Uint32Array(CONTAINERSIZE);
1587       for (let i = 0; i < CONTAINERSIZE; ++i) {
1588         let num = 0;
1589         let pos = CODEPOINTS_PER_ITEM;
1590         while (pos--)
1591           num = (num << 2) | wcwidthBMP(CODEPOINTS_PER_ITEM * i + pos);
1592         table[i] = num;
1593       }
1594     return table;
1595     }
1596     // get width from lookup table
1597     //   position in container   : num / CODEPOINTS_PER_ITEM
1598     //     ==> n = table[Math.floor(num / 16)]
1599     //     ==> n = table[num >> 4]
1600     //   16 codepoints per number:       FFEEDDCCBBAA99887766554433221100
1601     //   position in number      : (num % CODEPOINTS_PER_ITEM) * BITWIDTH
1602     //     ==> m = (n % 16) * 2
1603     //     ==> m = (num & 15) << 1
1604     //   right shift to position m
1605     //     ==> n = n >> m     e.g. m=12  000000000000FFEEDDCCBBAA99887766
1606     //   we are only interested in 2 LSBs, cut off higher bits
1607     //     ==> n = n & 3      e.g.       000000000000000000000000000000XX
1608     return function (num) {
1609       num = num | 0;  // get asm.js like optimization under V8
1610       if (num < 32)
1611         return control | 0;
1612       if (num < 127)
1613         return 1;
1614       let t = table || init_table();
1615       if (num < 65536)
1616         return t[num >> 4] >> ((num & 15) << 1) & 3;
1617       // do a full search for high codepoints
1618       return wcwidthHigh(num);
1619     };
1620 })({nul: 0, control: 0});  // configurable options