/** * Copyright (c) 2018 The xterm.js authors. All rights reserved. * @license MIT */ import { Terminal as ITerminalApi, ITerminalOptions, IMarker, IDisposable, ILinkMatcherOptions, ITheme, ILocalizableStrings } from 'xterm'; import { ITerminal } from '../Types'; import { Terminal as TerminalCore } from '../Terminal'; import * as Strings from '../Strings'; export class Terminal implements ITerminalApi { private _core: ITerminal; constructor(options?: ITerminalOptions) { this._core = new TerminalCore(options); } public get element(): HTMLElement { return this._core.element; } public get textarea(): HTMLTextAreaElement { return this._core.textarea; } public get rows(): number { return this._core.rows; } public get cols(): number { return this._core.cols; } public get markers(): IMarker[] { return this._core.markers; } public blur(): void { this._core.blur(); } public focus(): void { this._core.focus(); } public on(type: 'blur' | 'focus' | 'linefeed' | 'selection', listener: () => void): void; public on(type: 'data', listener: (...args: any[]) => void): void; public on(type: 'key', listener: (key?: string, event?: KeyboardEvent) => void): void; public on(type: 'keypress' | 'keydown', listener: (event?: KeyboardEvent) => void): void; public on(type: 'refresh', listener: (data?: { start: number; end: number; }) => void): void; public on(type: 'resize', listener: (data?: { cols: number; rows: number; }) => void): void; public on(type: 'scroll', listener: (ydisp?: number) => void): void; public on(type: 'title', listener: (title?: string) => void): void; public on(type: string, listener: (...args: any[]) => void): void; public on(type: any, listener: any): void { this._core.on(type, listener); } public off(type: string, listener: (...args: any[]) => void): void { this._core.off(type, listener); } public emit(type: string, data?: any): void { this._core.emit(type, data); } public addDisposableListener(type: string, handler: (...args: any[]) => void): IDisposable { return this.addDisposableListener(type, handler); } public resize(columns: number, rows: number): void { this._core.resize(columns, rows); } public writeln(data: string): void { this._core.writeln(data); } public open(parent: HTMLElement): void { this._core.open(parent); } public attachCustomKeyEventHandler(customKeyEventHandler: (event: KeyboardEvent) => boolean): void { this._core.attachCustomKeyEventHandler(customKeyEventHandler); } public registerLinkMatcher(regex: RegExp, handler: (event: MouseEvent, uri: string) => void, options?: ILinkMatcherOptions): number { return this._core.registerLinkMatcher(regex, handler, options); } public deregisterLinkMatcher(matcherId: number): void { this._core.deregisterLinkMatcher(matcherId); } public addMarker(cursorYOffset: number): IMarker { return this._core.addMarker(cursorYOffset); } public hasSelection(): boolean { return this._core.hasSelection(); } public getSelection(): string { return this._core.getSelection(); } public clearSelection(): void { this._core.clearSelection(); } public selectAll(): void { this._core.selectAll(); } public selectLines(start: number, end: number): void { this._core.selectLines(start, end); } public dispose(): void { this._core.dispose(); } public destroy(): void { this._core.destroy(); } public scrollLines(amount: number): void { this._core.scrollLines(amount); } public scrollPages(pageCount: number): void { this._core.scrollPages(pageCount); } public scrollToTop(): void { this._core.scrollToTop(); } public scrollToBottom(): void { this._core.scrollToBottom(); } public scrollToLine(line: number): void { this._core.scrollToLine(line); } public clear(): void { this._core.clear(); } public write(data: string): void { this._core.write(data); } public getOption(key: 'bellSound' | 'bellStyle' | 'cursorStyle' | 'fontFamily' | 'fontWeight' | 'fontWeightBold' | 'rendererType' | 'termName'): string; public getOption(key: 'allowTransparency' | 'cancelEvents' | 'convertEol' | 'cursorBlink' | 'debug' | 'disableStdin' | 'enableBold' | 'macOptionIsMeta' | 'rightClickSelectsWord' | 'popOnBell' | 'screenKeys' | 'useFlowControl' | 'visualBell'): boolean; public getOption(key: 'colors'): string[]; public getOption(key: 'cols' | 'fontSize' | 'letterSpacing' | 'lineHeight' | 'rows' | 'tabStopWidth' | 'scrollback'): number; public getOption(key: 'handler'): (data: string) => void; public getOption(key: string): any; public getOption(key: any): any { return this._core.getOption(key); } public setOption(key: 'bellSound' | 'fontFamily' | 'termName', value: string): void; public setOption(key: 'fontWeight' | 'fontWeightBold', value: 'normal' | 'bold' | '100' | '200' | '300' | '400' | '500' | '600' | '700' | '800' | '900'): void; public setOption(key: 'bellStyle', value: 'none' | 'visual' | 'sound' | 'both'): void; public setOption(key: 'cursorStyle', value: 'block' | 'underline' | 'bar'): void; public setOption(key: 'allowTransparency' | 'cancelEvents' | 'convertEol' | 'cursorBlink' | 'debug' | 'disableStdin' | 'enableBold' | 'macOptionIsMeta' | 'rightClickSelectsWord' | 'popOnBell' | 'screenKeys' | 'useFlowControl' | 'visualBell', value: boolean): void; public setOption(key: 'colors', value: string[]): void; public setOption(key: 'fontSize' | 'letterSpacing' | 'lineHeight' | 'tabStopWidth' | 'scrollback', value: number): void; public setOption(key: 'handler', value: (data: string) => void): void; public setOption(key: 'theme', value: ITheme): void; public setOption(key: 'cols' | 'rows', value: number): void; public setOption(key: string, value: any): void; public setOption(key: any, value: any): void { this._core.setOption(key, value); } public refresh(start: number, end: number): void { this._core.refresh(start, end); } public reset(): void { this._core.reset(); } public static applyAddon(addon: any): void { addon.apply(Terminal); } public static get strings(): ILocalizableStrings { return Strings; } }