Expose paste API

Fixes #2390

src/Terminal.test.ts

@@ -224,6 +224,31 @@ describe('Terminal', () => {
     });
   });
 
+  describe('paste', () => {
+    it('should fire data event', done => {
+      term.onData(e => {
+        assert.equal(e, 'foo');
+        done();
+      });
+      term.paste('foo');
+    });
+    it('should sanitize \n chars', done => {
+      term.onData(e => {
+        assert.equal(e, '\rfoo\r');
+        done();
+      });
+      term.paste('\r\nfoo\n');
+    });
+    it('should respect bracketed paste mode', done => {
+      term.onData(e => {
+        assert.equal(e, '\x1b[200~foo\x1b[201~');
+        done();
+      });
+      term.write('\x1b[?2004h');
+      term.paste('foo');
+    });
+  });
+
   describe('scroll', () => {
     describe('scrollLines', () => {
       let startYDisp: number;

src/Terminal.ts

@@ -25,7 +25,7 @@ import { IInputHandlingTerminal, ICompositionHelper, ITerminalOptions, ITerminal
 import { IRenderer, CharacterJoinerHandler } from 'browser/renderer/Types';
 import { CompositionHelper } from 'browser/input/CompositionHelper';
 import { Viewport } from 'browser/Viewport';
-import { rightClickHandler, moveTextAreaUnderMouseCursor, pasteHandler, copyHandler } from 'browser/Clipboard';
+import { rightClickHandler, moveTextAreaUnderMouseCursor, handlePasteEvent, copyHandler, paste } from 'browser/Clipboard';
 import { C0 } from 'common/data/EscapeSequences';
 import { InputHandler } from './InputHandler';
 import { Renderer } from './renderer/Renderer';
@@ -498,7 +498,7 @@ export class Terminal extends Disposable implements ITerminal, IDisposable, IInp
       }
       copyHandler(event, this._selectionService);
     }));
-    const pasteHandlerWrapper = (event: ClipboardEvent) => pasteHandler(event, this.textarea, this.bracketedPasteMode, e => this._coreService.triggerDataEvent(e, true));
+    const pasteHandlerWrapper = (event: ClipboardEvent) => handlePasteEvent(event, this.textarea, this.bracketedPasteMode, this._coreService);
     this.register(addDisposableDomListener(this.textarea, 'paste', pasteHandlerWrapper));
     this.register(addDisposableDomListener(this.element, 'paste', pasteHandlerWrapper));
 
@@ -1387,6 +1387,10 @@ export class Terminal extends Disposable implements ITerminal, IDisposable, IInp
     this.write(data + '\r\n');
   }
 
+  public paste(data: string): void {
+    paste(data, this.textarea, this.bracketedPasteMode, this._coreService);
+  }
+
   /**
    * Attaches a custom key event handler which is run before keys are processed,
    * giving consumers of xterm.js ultimate control as to what keys should be

src/TestUtils.test.ts

@@ -68,6 +68,9 @@ export class MockTerminal implements ITerminal {
   writeln(data: string): void {
     throw new Error('Method not implemented.');
   }
+  paste(data: string): void {
+    throw new Error('Method not implemented.');
+  }
   open(parent: HTMLElement): void {
     throw new Error('Method not implemented.');
   }

src/Types.d.ts

@@ -226,6 +226,7 @@ export interface IPublicTerminal extends IDisposable {
   clear(): void;
   write(data: string): void;
   writeUtf8(data: Uint8Array): void;
+  paste(data: string): void;
   refresh(start: number, end: number): void;
   reset(): void;
 }

src/browser/Clipboard.ts

@@ -4,6 +4,7 @@
  */
 
 import { ISelectionService } from 'browser/services/Services';
+import { ICoreService } from 'common/services/Services';
 
 /**
  * Prepares text to be pasted into the terminal by normalizing the line endings
@@ -41,24 +42,21 @@ export function copyHandler(ev: ClipboardEvent, selectionService: ISelectionServ
  * @param ev The original paste event to be handled
  * @param term The terminal on which to apply the handled paste event
  */
-export function pasteHandler(ev: ClipboardEvent, textarea: HTMLTextAreaElement, bracketedPasteMode: boolean, triggerUserInput: (data: string) => void): void {
+export function handlePasteEvent(ev: ClipboardEvent, textarea: HTMLTextAreaElement, bracketedPasteMode: boolean, coreService: ICoreService): void {
   ev.stopPropagation();
-
-  let text: string;
-
-  const dispatchPaste = function(text: string): void {
-    text = prepareTextForTerminal(text);
-    text = bracketTextForPaste(text, bracketedPasteMode);
-    triggerUserInput(text);
-    textarea.value = '';
-  };
-
   if (ev.clipboardData) {
-    text = ev.clipboardData.getData('text/plain');
-    dispatchPaste(text);
+    const text = ev.clipboardData.getData('text/plain');
+    paste(text, textarea, bracketedPasteMode, coreService);
   }
 }
 
+export function paste(text: string, textarea: HTMLTextAreaElement, bracketedPasteMode: boolean, coreService: ICoreService): void {
+  text = prepareTextForTerminal(text);
+  text = bracketTextForPaste(text, bracketedPasteMode);
+  coreService.triggerDataEvent(text, true);
+  textarea.value = '';
+}
+
 /**
  * Moves the textarea under the mouse cursor and focuses it.
  * @param ev The original right click event to be handled.

src/public/Terminal.ts

@@ -134,6 +134,9 @@ export class Terminal implements ITerminalApi {
   public writeUtf8(data: Uint8Array): void {
     this._core.writeUtf8(data);
   }
+  public paste(data: string): void {
+    this._core.paste(data);
+  }
   public getOption(key: 'bellSound' | 'bellStyle' | 'cursorStyle' | 'fontFamily' | 'fontWeight' | 'fontWeightBold' | 'logLevel' | 'rendererType' | 'termName' | 'wordSeparator'): string;
   public getOption(key: 'allowTransparency' | 'cancelEvents' | 'convertEol' | 'cursorBlink' | 'disableStdin' | 'macOptionIsMeta' | 'rightClickSelectsWord' | 'popOnBell' | 'screenKeys' | 'useFlowControl' | 'visualBell'): boolean;
   public getOption(key: 'colors'): string[];

typings/xterm.d.ts

@@ -669,6 +669,12 @@ declare module 'xterm' {
      */
     writeUtf8(data: Uint8Array): void;
 
+    /**
+     * Writes text to the terminal, performing the necessary transformations for pasted text.
+     * @param data The text to write to the terminal.
+     */
+    paste(data: string): void;
+
     /**
      * Retrieves an option's value from the terminal.
      * @param key The option key.