Merge pull request #1645 from jerch/fix_convertEol

fix convertEol option

src/InputHandler.test.ts

@@ -10,6 +10,7 @@ import { NULL_CELL_CHAR, NULL_CELL_CODE, NULL_CELL_WIDTH, CHAR_DATA_CHAR_INDEX }
 import { Terminal } from './Terminal';
 import { IBufferLine } from './Types';
 
+
 // TODO: This and the sections related to this object in associated tests can be
 // removed safely after InputHandler refactors are finished
 class OldInputHandler extends InputHandler {
@@ -445,4 +446,33 @@ describe('InputHandler', () => {
       expect(termContent(termNew)).eql(termContent(termOld));
     });
   });
+  it('convertEol setting', function(): void {
+    // not converting
+    let s = '';
+    const termNotConverting = new Terminal({cols: 15, rows: 10});
+    (termNotConverting as any)._inputHandler.parse('Hello\nWorld');
+    for (let i = 0; i < termNotConverting.cols; ++i) {
+      s += termNotConverting.buffer.lines.get(0).get(i)[CHAR_DATA_CHAR_INDEX];
+    }
+    expect(s).equals('Hello          ');
+    s = '';
+    for (let i = 0; i < termNotConverting.cols; ++i) {
+      s += termNotConverting.buffer.lines.get(1).get(i)[CHAR_DATA_CHAR_INDEX];
+    }
+    expect(s).equals('     World     ');
+
+    // converting
+    s = '';
+    const termConverting = new Terminal({cols: 15, rows: 10, convertEol: true});
+    (termConverting as any)._inputHandler.parse('Hello\nWorld');
+    for (let i = 0; i < termConverting.cols; ++i) {
+      s += termConverting.buffer.lines.get(0).get(i)[CHAR_DATA_CHAR_INDEX];
+    }
+    expect(s).equals('Hello          ');
+    s = '';
+    for (let i = 0; i < termConverting.cols; ++i) {
+      s += termConverting.buffer.lines.get(1).get(i)[CHAR_DATA_CHAR_INDEX];
+    }
+    expect(s).equals('World          ');
+  });
 });

src/InputHandler.ts

@@ -477,7 +477,7 @@ export class InputHandler extends Disposable implements IInputHandler {
     // make buffer local for faster access
     const buffer = this._terminal.buffer;
 
-    if (this._terminal.convertEol) {
+    if (this._terminal.options.convertEol) {
       buffer.x = 0;
     }
     buffer.y++;

src/Terminal.ts

@@ -134,7 +134,6 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
   // TODO: This can be changed to an enum or boolean, 0 and 1 seem to be the only options
   public cursorState: number;
   public cursorHidden: boolean;
-  public convertEol: boolean;
 
   private _customKeyEventHandler: CustomKeyEventHandler;
 

src/Types.ts

@@ -66,7 +66,6 @@ export interface IInputHandlingTerminal extends IEventEmitter {
 
   bell(): void;
   focus(): void;
-  convertEol: boolean;
   updateRange(y: number): void;
   scroll(isWrapped?: boolean): void;
   setgLevel(g: number): void;

typings/xterm.d.ts

@@ -39,6 +39,16 @@ declare module 'xterm' {
      */
     bellStyle?: 'none' /*| 'visual'*/ | 'sound' /*| 'both'*/;
 
+    /**
+     * When enabled the cursor will be set to the beginning of the next line
+     * with every new line. This equivalent to sending '\r\n' for each '\n'.
+     * Normally the termios settings of the underlying PTY deals with the
+     * translation of '\n' to '\r\n' and this setting should not be used. If you
+     * deal with data from a non-PTY related source, this settings might be
+     * useful.
+     */
+    convertEol?: boolean;
+
     /**
      * The number of columns in the terminal.
      */