Merge pull request #1097 from jdanbrown/pr-bracketedpaste

Support bracketed paste mode

src/InputHandler.test.ts

@@ -65,4 +65,18 @@ describe('InputHandler', () => {
       assert.equal(terminal.options['cursorBlink'], false);
     });
   });
+  describe('setMode', () => {
+    it('should toggle Terminal.bracketedPasteMode', () => {
+      let terminal = new MockInputHandlingTerminal();
+      terminal.prefix = '?';
+      terminal.bracketedPasteMode = false;
+      let inputHandler = new InputHandler(terminal);
+      // Set bracketed paste mode
+      inputHandler.setMode([2004]);
+      assert.equal(terminal.bracketedPasteMode, true);
+      // Reset bracketed paste mode
+      inputHandler.resetMode([2004]);
+      assert.equal(terminal.bracketedPasteMode, false);
+    });
+  });
 });

src/InputHandler.ts

@@ -932,6 +932,9 @@ export class InputHandler implements IInputHandler {
           this._terminal.viewport.syncScrollArea();
           this._terminal.showCursor();
           break;
+        case 2004: // bracketed paste mode (https://cirw.in/blog/bracketed-paste)
+          this._terminal.bracketedPasteMode = true;
+          break;
       }
     }
   }
@@ -1102,6 +1105,9 @@ export class InputHandler implements IInputHandler {
           this._terminal.viewport.syncScrollArea();
           this._terminal.showCursor();
           break;
+        case 2004: // bracketed paste mode (https://cirw.in/blog/bracketed-paste)
+          this._terminal.bracketedPasteMode = false;
+          break;
       }
     }
   }

src/Interfaces.ts

@@ -48,6 +48,7 @@ export interface ITerminal extends ILinkifierAccessor, IBufferAccessor, IElement
   buffers: IBufferSet;
   isFocused: boolean;
   mouseHelper: IMouseHelper;
+  bracketedPasteMode: boolean;
 
   /**
    * Emit the 'data' event and populate the given data.
@@ -82,6 +83,7 @@ export interface IInputHandlingTerminal extends IEventEmitter {
   originMode: boolean;
   insertMode: boolean;
   wraparoundMode: boolean;
+  bracketedPasteMode: boolean;
   defAttr: number;
   curAttr: number;
   prefix: string;

src/Terminal.ts

@@ -132,6 +132,7 @@ export class Terminal extends EventEmitter implements ITerminal, IInputHandlingT
   public originMode: boolean;
   public insertMode: boolean;
   public wraparoundMode: boolean; // defaults: xterm - true, vt100 - false
+  public bracketedPasteMode: boolean;
 
   // charset
   // The current charset
@@ -260,6 +261,7 @@ export class Terminal extends EventEmitter implements ITerminal, IInputHandlingT
     this.originMode = false;
     this.insertMode = false;
     this.wraparoundMode = true; // defaults: xterm - true, vt100 - false
+    this.bracketedPasteMode = false;
 
     // charset
     this.charset = null;

src/handlers/Clipboard.test.ts

@@ -16,4 +16,12 @@ describe('evaluatePastedTextProcessing', () => {
     assert.equal(processedText, 'foo\r\nbar\r\n');
     assert.equal(windowsProcessedText, 'foo\rbar\r');
   });
+  it('should bracket pasted text in bracketedPasteMode', () => {
+    const pastedText = 'foo bar';
+    const unbracketedText = Clipboard.bracketTextForPaste(pastedText, false);
+    const bracketedText = Clipboard.bracketTextForPaste(pastedText, true);
+
+    assert.equal(unbracketedText, 'foo bar');
+    assert.equal(bracketedText, '\x1b[200~foo bar\x1b[201~');
+  });
 });

src/handlers/Clipboard.ts

@@ -25,6 +25,17 @@ export function prepareTextForTerminal(text: string, isMSWindows: boolean): stri
   return text;
 }
 
+/**
+ * Bracket text for paste, if necessary, as per https://cirw.in/blog/bracketed-paste
+ * @param text The pasted text to bracket
+ */
+export function bracketTextForPaste(text: string, bracketedPasteMode: boolean): string {
+  if (bracketedPasteMode) {
+    return '\x1b[200~' + text + '\x1b[201~';
+  }
+  return text;
+}
+
 /**
  * Binds copy functionality to the given terminal.
  * @param {ClipboardEvent} ev The original copy event to be handled
@@ -52,6 +63,7 @@ export function pasteHandler(ev: ClipboardEvent, term: ITerminal): void {
 
   let dispatchPaste = function(text: string): void {
     text = prepareTextForTerminal(text, term.browser.isMSWindows);
+    text = bracketTextForPaste(text, term.bracketedPasteMode);
     term.handler(text);
     term.textarea.value = '';
     term.emit('paste', text);

src/utils/TestUtils.test.ts

@@ -10,6 +10,7 @@ import * as Browser from './Browser';
 import { IColorSet, IRenderer, IRenderDimensions, IColorManager } from '../renderer/Interfaces';
 
 export class MockTerminal implements ITerminal {
+  bracketedPasteMode: boolean;
   mouseHelper: IMouseHelper;
   renderer: IRenderer;
   linkifier: ILinkifier;
@@ -94,6 +95,7 @@ export class MockInputHandlingTerminal implements IInputHandlingTerminal {
   originMode: boolean;
   insertMode: boolean;
   wraparoundMode: boolean;
+  bracketedPasteMode: boolean;
   defAttr: number;
   curAttr: number;
   prefix: string;