Merge remote-tracking branch 'upstream/master' into 459_parser__on_460

[mirror_xterm.js.git] / src / Interfaces.ts

/**
 * @license MIT
 */

export interface IBrowser {
  isNode: boolean;
  userAgent: string;
  platform: string;
  isFirefox: boolean;
  isMSIE: boolean;
  isMac: boolean;
  isIpad: boolean;
  isIphone: boolean;
  isMSWindows: boolean;
}

export interface ITerminal {
  element: HTMLElement;
  rowContainer: HTMLElement;
  textarea: HTMLTextAreaElement;
  ydisp: number;
  lines: string[];
  rows: number;
  browser: IBrowser;

  /**
   * Emit the 'data' event and populate the given data.
   * @param data The data to populate in the event.
   */
  handler(data: string);
  on(event: string, callback: () => void);
  scrollDisp(disp: number, suppressScrollEvent: boolean);
  cancel(ev: Event, force?: boolean);
}

/**
 * Handles actions generated by the parser.
 */
export interface IInputHandler {
  bell(): void;
  lineFeed(): void;
  carriageReturn(): void;
  backspace(): void;
  tab(): void;
  shiftOut(): void;
  shiftIn(): void;
  insertChars(params);
  cursorUp(params: number[]): void;
  cursorDown(params: number[]): void;
  cursorForward(params: number[]): void;
  cursorBackward(params: number[]): void;
  cursorNextLine(params: number[]): void;
  cursorPrecedingLine(params: number[]): void;
  cursorCharAbsolute(params: number[]): void;
  cursorPosition(params: number[]): void;
  eraseInDisplay(params: number[]): void;
  eraseInLine(params: number[]): void;
  charAttributes(params: number[]): void;
  deviceStatus(params: number[]): void;
}