src/Interfaces.ts

   1 /**
   2  * @license MIT
   3  */
   4
   5 import { LinkMatcherOptions } from './Interfaces';
   6 import { LinkMatcherHandler, LinkMatcherValidationCallback } from './Types';
   7
   8 export interface IBrowser {
   9   isNode: boolean;
  10   userAgent: string;
  11   platform: string;
  12   isFirefox: boolean;
  13   isMSIE: boolean;
  14   isMac: boolean;
  15   isIpad: boolean;
  16   isIphone: boolean;
  17   isMSWindows: boolean;
  18 }
  19
  20 export interface ITerminal {
  21   element: HTMLElement;
  22   rowContainer: HTMLElement;
  23   selectionContainer: HTMLElement;
  24   selectionManager: ISelectionManager;
  25   charMeasure: ICharMeasure;
  26   textarea: HTMLTextAreaElement;
  27   ybase: number;
  28   ydisp: number;
  29   lines: ICircularList<string>;
  30   rows: number;
  31   cols: number;
  32   browser: IBrowser;
  33   writeBuffer: string[];
  34   children: HTMLElement[];
  35   cursorHidden: boolean;
  36   cursorState: number;
  37   x: number;
  38   y: number;
  39   defAttr: number;
  40   scrollback: number;
  41   buffer: any;  // This should be a `Buffer` class, but it would result in circular dependency
  42   viewport: any;  // This should be a `Viewport` class, but it would result in circular dependency
  43
  44   /**
  45    * Emit the 'data' event and populate the given data.
  46    * @param data The data to populate in the event.
  47    */
  48   handler(data: string);
  49   on(event: string, callback: () => void);
  50   scrollDisp(disp: number, suppressScrollEvent: boolean);
  51   cancel(ev: Event, force?: boolean);
  52   log(text: string): void;
  53   emit(event: string, data: any);
  54   reset(): void;
  55   showCursor(): void;
  56 }
  57
  58 export interface ISelectionManager {
  59   selectionText: string;
  60   selectionStart: [number, number];
  61   selectionEnd: [number, number];
  62
  63   setSelection(row: number, col: number, length: number);
  64 }
  65
  66 export interface ICharMeasure {
  67   width: number;
  68   height: number;
  69   measure(): void;
  70 }
  71
  72 export interface ILinkifier {
  73   linkifyRow(rowIndex: number): void;
  74   attachHypertextLinkHandler(handler: LinkMatcherHandler): void;
  75   registerLinkMatcher(regex: RegExp, handler: LinkMatcherHandler, options?: LinkMatcherOptions): number;
  76   deregisterLinkMatcher(matcherId: number): boolean;
  77 }
  78
  79 interface ICircularList<T> {
  80   length: number;
  81   maxLength: number;
  82
  83   forEach(callbackfn: (value: T, index: number, array: T[]) => void): void;
  84   get(index: number): T;
  85   set(index: number, value: T): void;
  86   push(value: T): void;
  87   pop(): T;
  88   splice(start: number, deleteCount: number, ...items: T[]): void;
  89   trimStart(count: number): void;
  90   shiftElements(start: number, count: number, offset: number): void;
  91 }
  92
  93 export interface LinkMatcherOptions {
  94   /**
  95    * The index of the link from the regex.match(text) call. This defaults to 0
  96    * (for regular expressions without capture groups).
  97    */
  98   matchIndex?: number;
  99   /**
 100    * A callback that validates an individual link, returning true if valid and
 101    * false if invalid.
 102    */
 103   validationCallback?: LinkMatcherValidationCallback;
 104   /**
 105    * The priority of the link matcher, this defines the order in which the link
 106    * matcher is evaluated relative to others, from highest to lowest. The
 107    * default value is 0.
 108    */
 109   priority?: number;
 110 }
 111
 112 /**
 113  * Handles actions generated by the parser.
 114  */
 115 export interface IInputHandler {
 116   addChar(char: string, code: number): void;
 117
 118   /** C0 BEL */ bell(): void;
 119   /** C0 LF */ lineFeed(): void;
 120   /** C0 CR */ carriageReturn(): void;
 121   /** C0 BS */ backspace(): void;
 122   /** C0 HT */ tab(): void;
 123   /** C0 SO */ shiftOut(): void;
 124   /** C0 SI */ shiftIn(): void;
 125
 126   /** CSI @ */ insertChars(params?: number[]): void;
 127   /** CSI A */ cursorUp(params?: number[]): void;
 128   /** CSI B */ cursorDown(params?: number[]): void;
 129   /** CSI C */ cursorForward(params?: number[]): void;
 130   /** CSI D */ cursorBackward(params?: number[]): void;
 131   /** CSI E */ cursorNextLine(params?: number[]): void;
 132   /** CSI F */ cursorPrecedingLine(params?: number[]): void;
 133   /** CSI G */ cursorCharAbsolute(params?: number[]): void;
 134   /** CSI H */ cursorPosition(params?: number[]): void;
 135   /** CSI I */ cursorForwardTab(params?: number[]): void;
 136   /** CSI J */ eraseInDisplay(params?: number[]): void;
 137   /** CSI K */ eraseInLine(params?: number[]): void;
 138   /** CSI L */ insertLines(params?: number[]): void;
 139   /** CSI M */ deleteLines(params?: number[]): void;
 140   /** CSI P */ deleteChars(params?: number[]): void;
 141   /** CSI S */ scrollUp(params?: number[]): void;
 142   /** CSI T */ scrollDown(params?: number[]): void;
 143   /** CSI X */ eraseChars(params?: number[]): void;
 144   /** CSI Z */ cursorBackwardTab(params?: number[]): void;
 145   /** CSI ` */ charPosAbsolute(params?: number[]): void;
 146   /** CSI a */ HPositionRelative(params?: number[]): void;
 147   /** CSI b */ repeatPrecedingCharacter(params?: number[]): void;
 148   /** CSI c */ sendDeviceAttributes(params?: number[]): void;
 149   /** CSI d */ linePosAbsolute(params?: number[]): void;
 150   /** CSI e */ VPositionRelative(params?: number[]): void;
 151   /** CSI f */ HVPosition(params?: number[]): void;
 152   /** CSI g */ tabClear(params?: number[]): void;
 153   /** CSI h */ setMode(params?: number[]): void;
 154   /** CSI l */ resetMode(params?: number[]): void;
 155   /** CSI m */ charAttributes(params?: number[]): void;
 156   /** CSI n */ deviceStatus(params?: number[]): void;
 157   /** CSI p */ softReset(params?: number[]): void;
 158   /** CSI q */ setCursorStyle(params?: number[]): void;
 159   /** CSI r */ setScrollRegion(params?: number[]): void;
 160   /** CSI s */ saveCursor(params?: number[]): void;
 161   /** CSI u */ restoreCursor(params?: number[]): void;
 162 }