column sequences

src/InputHandler.test.ts

@@ -25,6 +25,14 @@ function getCursor(term: TestTerminal): number[] {
   ];
 }
 
+function getLines(term: TestTerminal, limit: number = term.rows): string[] {
+  const res: string[] = [];
+  for (let i = 0; i < limit; ++i) {
+    res.push(term.buffer.lines.get(i).translateToString(true));
+  }
+  return res;
+}
+
 describe('InputHandler', () => {
   describe('save and restore cursor', () => {
     const terminal = new MockInputHandlingTerminal();
@@ -1125,13 +1133,6 @@ describe('InputHandler', () => {
     beforeEach(() => {
       term = new TestTerminal({cols: 10, rows: 10});
     });
-    function getLines(term: TestTerminal, limit: number = term.rows): string[] {
-      const res: string[] = [];
-      for (let i = 0; i < limit; ++i) {
-        res.push(term.buffer.lines.get(i).translateToString(true));
-      }
-      return res;
-    }
     it('scrollUp', () => {
       term.writeSync('0\r\n1\r\n2\r\n3\r\n4\r\n5\r\n6\r\n7\r\n8\r\n9\x1b[2;4r\x1b[2Sm');
       assert.deepEqual(getLines(term), ['m', '3', '', '', '4', '5', '6', '7', '8', '9']);
@@ -1191,4 +1192,60 @@ describe('InputHandler', () => {
       assert.deepEqual(getLines(term), ['0', '1', 'n', 'm',  '',  '', '6', '7', '8', '9']);
     });
   });
+  describe('SL/SR/DECIC/DECDC', () => {
+    let term: TestTerminal;
+    beforeEach(() => {
+      term = new TestTerminal({cols: 5, rows: 5, scrollback: 1});
+    });
+    it('SL (scrollLeft)', () => {
+      term.writeSync('12345'.repeat(6));
+      term.writeSync('\x1b[ @');
+      assert.deepEqual(getLines(term, term.rows + 1), ['12345', '2345', '2345', '2345', '2345', '2345']);
+      term.writeSync('\x1b[0 @');
+      assert.deepEqual(getLines(term, term.rows + 1), ['12345', '345', '345', '345', '345', '345']);
+      term.writeSync('\x1b[2 @');
+      assert.deepEqual(getLines(term, term.rows + 1), ['12345', '5', '5', '5', '5', '5']);
+    });
+    it('SR (scrollRight)', () => {
+      term.writeSync('12345'.repeat(6));
+      term.writeSync('\x1b[ A');
+      assert.deepEqual(getLines(term, term.rows + 1), ['12345', ' 1234', ' 1234', ' 1234', ' 1234', ' 1234']);
+      term.writeSync('\x1b[0 A');
+      assert.deepEqual(getLines(term, term.rows + 1), ['12345', '  123', '  123', '  123', '  123', '  123']);
+      term.writeSync('\x1b[2 A');
+      assert.deepEqual(getLines(term, term.rows + 1), ['12345', '    1', '    1', '    1', '    1', '    1']);
+    });
+    it('insertColumns (DECIC)', () => {
+      term.writeSync('12345'.repeat(6));
+      term.writeSync('\x1b[3;3H');
+      term.writeSync('\x1b[\'}');
+      assert.deepEqual(getLines(term, term.rows + 1), ['12345', '12 34', '12 34', '12 34', '12 34', '12 34']);
+      term.reset();
+      term.writeSync('12345'.repeat(6));
+      term.writeSync('\x1b[3;3H');
+      term.writeSync('\x1b[1\'}');
+      assert.deepEqual(getLines(term, term.rows + 1), ['12345', '12 34', '12 34', '12 34', '12 34', '12 34']);
+      term.reset();
+      term.writeSync('12345'.repeat(6));
+      term.writeSync('\x1b[3;3H');
+      term.writeSync('\x1b[2\'}');
+      assert.deepEqual(getLines(term, term.rows + 1), ['12345', '12  3', '12  3', '12  3', '12  3', '12  3']);
+    });
+    it('deleteColumns (DECDC)', () => {
+      term.writeSync('12345'.repeat(6));
+      term.writeSync('\x1b[3;3H');
+      term.writeSync('\x1b[\'~');
+      assert.deepEqual(getLines(term, term.rows + 1), ['12345', '1245', '1245', '1245', '1245', '1245']);
+      term.reset();
+      term.writeSync('12345'.repeat(6));
+      term.writeSync('\x1b[3;3H');
+      term.writeSync('\x1b[1\'~');
+      assert.deepEqual(getLines(term, term.rows + 1), ['12345', '1245', '1245', '1245', '1245', '1245']);
+      term.reset();
+      term.writeSync('12345'.repeat(6));
+      term.writeSync('\x1b[3;3H');
+      term.writeSync('\x1b[2\'~');
+      assert.deepEqual(getLines(term, term.rows + 1), ['12345', '125', '125', '125', '125', '125']);
+    });
+  });
 });

src/InputHandler.ts

@@ -175,7 +175,9 @@ export class InputHandler extends Disposable implements IInputHandler {
      * CSI handler
      */
     this._parser.setCsiHandler({final: '@'}, params => this.insertChars(params));
+    this._parser.setCsiHandler({intermediates: ' ', final: '@'}, params => this.scrollLeft(params));
     this._parser.setCsiHandler({final: 'A'}, params => this.cursorUp(params));
+    this._parser.setCsiHandler({intermediates: ' ', final: 'A'}, params => this.scrollRight(params));
     this._parser.setCsiHandler({final: 'B'}, params => this.cursorDown(params));
     this._parser.setCsiHandler({final: 'C'}, params => this.cursorForward(params));
     this._parser.setCsiHandler({final: 'D'}, params => this.cursorBackward(params));
@@ -216,6 +218,8 @@ export class InputHandler extends Disposable implements IInputHandler {
     this._parser.setCsiHandler({final: 'r'}, params => this.setScrollRegion(params));
     this._parser.setCsiHandler({final: 's'}, params => this.saveCursor(params));
     this._parser.setCsiHandler({final: 'u'}, params => this.restoreCursor(params));
+    this._parser.setCsiHandler({intermediates: '\'', final: '}'}, params => this.insertColumns(params));
+    this._parser.setCsiHandler({intermediates: '\'', final: '~'}, params => this.deleteColumns(params));
 
     /**
      * execute handler
@@ -1033,17 +1037,87 @@ export class InputHandler extends Disposable implements IInputHandler {
    * CSI Ps T  Scroll down Ps lines (default = 1) (SD).
    */
   public scrollDown(params: IParams): void {
-    if (params.length < 2) {
-      let param = params.params[0] || 1;
+    let param = params.params[0] || 1;
 
-      // make buffer local for faster access
-      const buffer = this._bufferService.buffer;
+    // make buffer local for faster access
+    const buffer = this._bufferService.buffer;
 
-      while (param--) {
-        buffer.lines.splice(buffer.ybase + buffer.scrollBottom, 1);
-        buffer.lines.splice(buffer.ybase + buffer.scrollTop, 0, buffer.getBlankLine(this._terminal.eraseAttrData()));
-      }
-      this._dirtyRowService.markRangeDirty(buffer.scrollTop, buffer.scrollBottom);
+    while (param--) {
+      buffer.lines.splice(buffer.ybase + buffer.scrollBottom, 1);
+      buffer.lines.splice(buffer.ybase + buffer.scrollTop, 0, buffer.getBlankLine(DEFAULT_ATTR_DATA));
+    }
+    this._dirtyRowService.markRangeDirty(buffer.scrollTop, buffer.scrollBottom);
+  }
+
+  /**
+   * CSI Ps SP @  Scroll left Ps columns (default = 1) (SL) ECMA-48
+   *
+   * Notation: (Pn)
+   * Representation: CSI Pn 02/00 04/00
+   * Parameter default value: Pn = 1
+   * SL causes the data in the presentation component to be moved by n character positions
+   * if the line orientation is horizontal, or by n line positions if the line orientation
+   * is vertical, such that the data appear to move to the left; where n equals the value of Pn.
+   * The active presentation position is not affected by this control function.
+   *
+   * Supported:
+   *   - always left shift (no line orientation setting respected)
+   */
+  public scrollLeft(params: IParams): void {
+    const param = params.params[0] || 1;
+    for (let y = 0; y < this._bufferService.rows; ++y) {
+      const line = this._bufferService.buffer.lines.get(this._bufferService.buffer.ybase + y);
+      line.deleteCells(0, param, this._bufferService.buffer.getNullCell(this._terminal.eraseAttrData()));
+      line.isWrapped = false;
+    }
+  }
+
+  /**
+   * CSI Ps SP A  Scroll right Ps columns (default = 1) (SL) ECMA-48
+   *
+   * Notation: (Pn)
+   * Representation: CSI Pn 02/00 04/01
+   * Parameter default value: Pn = 1
+   * SR causes the data in the presentation component to be moved by n character positions
+   * if the line orientation is horizontal, or by n line positions if the line orientation
+   * is vertical, such that the data appear to move to the right; where n equals the value of Pn.
+   * The active presentation position is not affected by this control function.
+   *
+   * Supported:
+   *   - always right shift (no line orientation setting respected)
+   */
+  public scrollRight(params: IParams): void {
+    const param = params.params[0] || 1;
+    for (let y = 0; y < this._bufferService.rows; ++y) {
+      const line = this._bufferService.buffer.lines.get(this._bufferService.buffer.ybase + y);
+      line.insertCells(0, param, this._bufferService.buffer.getNullCell(this._terminal.eraseAttrData()));
+      line.isWrapped = false;
+    }
+  }
+
+  /**
+   * CSI Pm ' }
+   * Insert Ps Column(s) (default = 1) (DECIC), VT420 and up.
+   */
+  public insertColumns(params: IParams): void {
+    const param = params.params[0] || 1;
+    for (let y = 0; y < this._bufferService.rows; ++y) {
+      const line = this._bufferService.buffer.lines.get(this._bufferService.buffer.ybase + y);
+      line.insertCells(this._bufferService.buffer.x, param, this._bufferService.buffer.getNullCell(this._terminal.eraseAttrData()));
+      line.isWrapped = false;
+    }
+  }
+
+  /**
+   * CSI Pm ' ~
+   * Delete Ps Column(s) (default = 1) (DECDC), VT420 and up.
+   */
+  public deleteColumns(params: IParams): void {
+    const param = params.params[0] || 1;
+    for (let y = 0; y < this._bufferService.rows; ++y) {
+      const line = this._bufferService.buffer.lines.get(this._bufferService.buffer.ybase + y);
+      line.deleteCells(this._bufferService.buffer.x, param, this._bufferService.buffer.getNullCell(this._terminal.eraseAttrData()));
+      line.isWrapped = false;
     }
   }
 

src/Types.d.ts

@@ -85,7 +85,9 @@ export interface IInputHandler {
   /** C0 SI */ shiftIn(): void;
 
   /** CSI @ */ insertChars(params: IParams): void;
+  /** CSI SP @ */ scrollLeft(params: IParams): void;
   /** CSI A */ cursorUp(params: IParams): void;
+  /** CSI SP A */ scrollRight(params: IParams): void;
   /** CSI B */ cursorDown(params: IParams): void;
   /** CSI C */ cursorForward(params: IParams): void;
   /** CSI D */ cursorBackward(params: IParams): void;
@@ -121,6 +123,8 @@ export interface IInputHandler {
   /** CSI r */ setScrollRegion(params: IParams, collect?: string): void;
   /** CSI s */ saveCursor(params: IParams): void;
   /** CSI u */ restoreCursor(params: IParams): void;
+  /** CSI ' } */ insertColumns(params: IParams): void;
+  /** CSI ' ~ */ deleteColumns(params: IParams): void;
   /** OSC 0
       OSC 2 */ setTitle(data: string): void;
   /** ESC E */ nextLine(): void;