src/Interfaces.ts

   1 /**
   2  * @license MIT
   3  */
   4
   5 export interface IBrowser {
   6   isNode: boolean;
   7   userAgent: string;
   8   platform: string;
   9   isFirefox: boolean;
  10   isMSIE: boolean;
  11   isMac: boolean;
  12   isIpad: boolean;
  13   isIphone: boolean;
  14   isMSWindows: boolean;
  15 }
  16
  17 export interface ITerminal {
  18   element: HTMLElement;
  19   rowContainer: HTMLElement;
  20   textarea: HTMLTextAreaElement;
  21   ybase: number;
  22   ydisp: number;
  23   lines: ICircularList<string>;
  24   rows: number;
  25   cols: number;
  26   browser: IBrowser;
  27   writeBuffer: string[];
  28   children: HTMLElement[];
  29   cursorHidden: boolean;
  30   cursorState: number;
  31   x: number;
  32   y: number;
  33   defAttr: number;
  34
  35   /**
  36    * Emit the 'data' event and populate the given data.
  37    * @param data The data to populate in the event.
  38    */
  39   handler(data: string);
  40   on(event: string, callback: () => void);
  41   scrollDisp(disp: number, suppressScrollEvent: boolean);
  42   cancel(ev: Event, force?: boolean);
  43   log(text: string): void;
  44   emit(event: string, data: any);
  45 }
  46
  47 interface ICircularList<T> {
  48   length: number;
  49   maxLength: number;
  50
  51   forEach(callbackfn: (value: T, index: number, array: T[]) => void): void;
  52   get(index: number): T;
  53   set(index: number, value: T): void;
  54   push(value: T): void;
  55   pop(): T;
  56   splice(start: number, deleteCount: number, ...items: T[]): void;
  57   trimStart(count: number): void;
  58   shiftElements(start: number, count: number, offset: number): void;
  59 }
  60
  61 /**
  62  * Handles actions generated by the parser.
  63  */
  64 export interface IInputHandler {
  65   addChar(char: string, code: number): void;
  66
  67   /** C0 BEL */ bell(): void;
  68   /** C0 LF */ lineFeed(): void;
  69   /** C0 CR */ carriageReturn(): void;
  70   /** C0 BS */ backspace(): void;
  71   /** C0 HT */ tab(): void;
  72   /** C0 SO */ shiftOut(): void;
  73   /** C0 SI */ shiftIn(): void;
  74
  75   /** CSI @ */ insertChars(params?: number[]): void;
  76   /** CSI A */ cursorUp(params?: number[]): void;
  77   /** CSI B */ cursorDown(params?: number[]): void;
  78   /** CSI C */ cursorForward(params?: number[]): void;
  79   /** CSI D */ cursorBackward(params?: number[]): void;
  80   /** CSI E */ cursorNextLine(params?: number[]): void;
  81   /** CSI F */ cursorPrecedingLine(params?: number[]): void;
  82   /** CSI G */ cursorCharAbsolute(params?: number[]): void;
  83   /** CSI H */ cursorPosition(params?: number[]): void;
  84   /** CSI I */ cursorForwardTab(params?: number[]): void;
  85   /** CSI J */ eraseInDisplay(params?: number[]): void;
  86   /** CSI K */ eraseInLine(params?: number[]): void;
  87   /** CSI L */ insertLines(params?: number[]): void;
  88   /** CSI M */ deleteLines(params?: number[]): void;
  89   /** CSI P */ deleteChars(params?: number[]): void;
  90   /** CSI S */ scrollUp(params?: number[]): void;
  91   /** CSI T */ scrollDown(params?: number[]): void;
  92   /** CSI X */ eraseChars(params?: number[]): void;
  93   /** CSI Z */ cursorBackwardTab(params?: number[]): void;
  94   /** CSI ` */ charPosAbsolute(params?: number[]): void;
  95   /** CSI a */ HPositionRelative(params?: number[]): void;
  96   /** CSI b */ repeatPrecedingCharacter(params?: number[]): void;
  97   /** CSI c */ sendDeviceAttributes(params?: number[]): void;
  98   /** CSI d */ linePosAbsolute(params?: number[]): void;
  99   /** CSI e */ VPositionRelative(params?: number[]): void;
 100   /** CSI f */ HVPosition(params?: number[]): void;
 101   /** CSI g */ tabClear(params?: number[]): void;
 102   /** CSI h */ setMode(params?: number[]): void;
 103   /** CSI l */ resetMode(params?: number[]): void;
 104   /** CSI m */ charAttributes(params?: number[]): void;
 105   /** CSI n */ deviceStatus(params?: number[]): void;
 106   /** CSI p */ softReset(params?: number[]): void;
 107   /** CSI q */ setCursorStyle(params?: number[]): void;
 108   /** CSI r */ setScrollRegion(params?: number[]): void;
 109   /** CSI s */ saveCursor(params?: number[]): void;
 110   /** CSI u */ restoreCursor(params?: number[]): void;
 111 }