Merge branch 'master' into 1567_npe

This commit is contained in:
Daniel Imms
2018-08-06 07:14:33 -07:00
committed by GitHub
24 changed files with 275 additions and 92 deletions
+70 -44
View File
@@ -25,7 +25,7 @@ import { IInputHandlingTerminal, IViewport, ICompositionHelper, ITerminalOptions
import { IMouseZoneManager } from './ui/Types';
import { IRenderer } from './renderer/Types';
import { BufferSet } from './BufferSet';
import { Buffer, MAX_BUFFER_SIZE, DEFAULT_ATTR } from './Buffer';
import { Buffer, MAX_BUFFER_SIZE, DEFAULT_ATTR, NULL_CELL_CODE, NULL_CELL_WIDTH, NULL_CELL_CHAR } from './Buffer';
import { CompositionHelper } from './CompositionHelper';
import { EventEmitter } from './EventEmitter';
import { Viewport } from './Viewport';
@@ -72,7 +72,7 @@ const WRITE_BATCH_SIZE = 300;
/**
* The set of options that only have an effect when set in the Terminal constructor.
*/
const CONSTRUCTOR_ONLY_OPTIONS = ['cols', 'rows', 'rendererType'];
const CONSTRUCTOR_ONLY_OPTIONS = ['cols', 'rows'];
const DEFAULT_OPTIONS: ITerminalOptions = {
cols: 80,
@@ -208,6 +208,7 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
public mouseHelper: MouseHelper;
private _accessibilityManager: AccessibilityManager;
private _screenDprMonitor: ScreenDprMonitor;
private _theme: ITheme;
public cols: number;
public rows: number;
@@ -215,7 +216,7 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
/**
* Creates a new `Terminal` object.
*
* @param {object} options An object containing a set of options, the available options are:
* @param options An object containing a set of options, the available options are:
* - `cursorBlink` (boolean): Whether the terminal cursor blinks
* - `cols` (number): The number of columns of the terminal (horizontal size)
* - `rows` (number): The number of rows of the terminal (vertical size)
@@ -350,7 +351,7 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
/**
* Retrieves an option's value from the terminal.
* @param {string} key The option key.
* @param key The option key.
*/
public getOption(key: string): any {
if (!(key in DEFAULT_OPTIONS)) {
@@ -362,8 +363,8 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
/**
* Sets an option on the terminal.
* @param {string} key The option key.
* @param {any} value The option value.
* @param key The option key.
* @param value The option value.
*/
public setOption(key: string, value: any): void {
if (!(key in DEFAULT_OPTIONS)) {
@@ -372,6 +373,9 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
if (CONSTRUCTOR_ONLY_OPTIONS.indexOf(key) !== -1) {
console.error(`Option "${key}" can only be set in the constructor`);
}
if (this.options[key] === value) {
return;
}
switch (key) {
case 'bellStyle':
if (!value) {
@@ -398,6 +402,11 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
console.warn(`${key} cannot be less than 1, value: ${value}`);
return;
}
case 'rendererType':
if (!value) {
value = 'canvas';
}
break;
case 'tabStopWidth':
if (value < 1) {
console.warn(`${key} cannot be less than 1, value: ${value}`);
@@ -457,6 +466,18 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
this.renderer.onResize(this.cols, this.rows);
this.refresh(0, this.rows - 1);
}
case 'rendererType':
if (this.renderer) {
this.unregister(this.renderer);
this.renderer.dispose();
this.renderer = null;
}
this._setupRenderer();
this.renderer.onCharSizeChanged();
if (this._theme) {
this.renderer.setTheme(this._theme);
}
break;
case 'scrollback':
this.buffers.resize(this.cols, this.rows);
if (this.viewport) {
@@ -604,7 +625,7 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
/**
* Opens the terminal within an element.
*
* @param {HTMLElement} parent The element to create the terminal within.
* @param parent The element to create the terminal within.
*/
public open(parent: HTMLElement): void {
this._parent = parent || this._parent;
@@ -676,12 +697,8 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
// Performance: Add viewport and helper elements from the fragment
this.element.appendChild(fragment);
switch (this.options.rendererType) {
case 'canvas': this.renderer = new Renderer(this, this.options.theme); break;
case 'dom': this.renderer = new DomRenderer(this, this.options.theme); break;
default: throw new Error(`Unrecognized rendererType "${this.options.rendererType}"`);
}
this.register(this.renderer);
this._setupRenderer();
this._theme = this.options.theme;
this.options.theme = null;
this.viewport = new Viewport(this, this._viewportElement, this._viewportScrollArea, this.charMeasure);
this.viewport.onThemeChanged(this.renderer.colorManager.colors);
@@ -738,11 +755,21 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
}
private _setupRenderer(): void {
switch (this.options.rendererType) {
case 'canvas': this.renderer = new Renderer(this, this.options.theme); break;
case 'dom': this.renderer = new DomRenderer(this, this.options.theme); break;
default: throw new Error(`Unrecognized rendererType "${this.options.rendererType}"`);
}
this.register(this.renderer);
}
/**
* Sets the theme on the renderer. The renderer must have been initialized.
* @param theme The theme to ste.
* @param theme The theme to set.
*/
private _setTheme(theme: ITheme): void {
this._theme = theme;
const colors = this.renderer.setTheme(theme);
if (this.viewport) {
this.viewport.onThemeChanged(colors);
@@ -1100,8 +1127,8 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
/**
* Tells the renderer to refresh terminal content between two rows (inclusive) at the next
* opportunity.
* @param {number} start The row to start from (between 0 and this.rows - 1).
* @param {number} end The row to end at (between start and this.rows - 1).
* @param start The row to start from (between 0 and this.rows - 1).
* @param end The row to end at (between start and this.rows - 1).
*/
public refresh(start: number, end: number): void {
if (this.renderer) {
@@ -1111,8 +1138,8 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
/**
* Queues linkification for the specified rows.
* @param {number} start The row to start from (between 0 and this.rows - 1).
* @param {number} end The row to end at (between start and this.rows - 1).
* @param start The row to start from (between 0 and this.rows - 1).
* @param end The row to end at (between start and this.rows - 1).
*/
private _queueLinkification(start: number, end: number): void {
if (this.linkifier) {
@@ -1204,8 +1231,8 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
/**
* Scroll the display of the terminal
* @param {number} disp The number of lines to scroll down (negative scroll up).
* @param {boolean} suppressScrollEvent Don't emit the scroll event as scrollLines. This is used
* @param disp The number of lines to scroll down (negative scroll up).
* @param suppressScrollEvent Don't emit the scroll event as scrollLines. This is used
* to avoid unwanted events being handled by the viewport when the event was triggered from the
* viewport originally.
*/
@@ -1236,7 +1263,7 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
/**
* Scroll the display of the terminal by a number of pages.
* @param {number} pageCount The number of pages to scroll (negative scrolls up).
* @param pageCount The number of pages to scroll (negative scrolls up).
*/
public scrollPages(pageCount: number): void {
this.scrollLines(pageCount * (this.rows - 1));
@@ -1265,7 +1292,7 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
/**
* Writes text to the terminal.
* @param {string} data The text to write to the terminal.
* @param data The text to write to the terminal.
*/
public write(data: string): void {
// Ensure the terminal isn't disposed
@@ -1341,7 +1368,7 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
/**
* Writes text to the terminal, followed by a break line character (\n).
* @param {string} data The text to write to the terminal.
* @param data The text to write to the terminal.
*/
public writeln(data: string): void {
this.write(data + '\r\n');
@@ -1454,7 +1481,7 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
* Handle a keydown event
* Key Resources:
* - https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent
* @param {KeyboardEvent} ev The keydown event to be handled.
* @param ev The keydown event to be handled.
*/
protected _keyDown(event: KeyboardEvent): boolean {
if (this._customKeyEventHandler && this._customKeyEventHandler(event) === false) {
@@ -1551,7 +1578,7 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
* Handle a keypress event.
* Key Resources:
* - https://developer.mozilla.org/en-US/docs/DOM/KeyboardEvent
* @param {KeyboardEvent} ev The keypress event to be handled.
* @param ev The keypress event to be handled.
*/
protected _keyPress(ev: KeyboardEvent): boolean {
let key;
@@ -1590,7 +1617,6 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
/**
* Send data for handling to the terminal
* @param {string} data
*/
public send(data: string): void {
if (!this._sendDataQueue) {
@@ -1643,8 +1669,8 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
/**
* Resizes the terminal.
*
* @param {number} x The number of columns to resize to.
* @param {number} y The number of rows to resize to.
* @param x The number of columns to resize to.
* @param y The number of rows to resize to.
*/
public resize(x: number, y: number): void {
if (isNaN(x) || isNaN(y)) {
@@ -1678,7 +1704,7 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
/**
* Updates the range of rows to refresh
* @param {number} y The number of rows to refresh next.
* @param y The number of rows to refresh next.
*/
public updateRange(y: number): void {
if (y < this._refreshStart) this._refreshStart = y;
@@ -1701,15 +1727,15 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
/**
* Erase in the identified line everything from "x" to the end of the line (right).
* @param {number} x The column from which to start erasing to the end of the line.
* @param {number} y The line in which to operate.
* @param x The column from which to start erasing to the end of the line.
* @param y The line in which to operate.
*/
public eraseRight(x: number, y: number): void {
const line = this.buffer.lines.get(this.buffer.ybase + y);
if (!line) {
return;
}
const ch: CharData = [this.eraseAttr(), ' ', 1, 32 /* ' '.charCodeAt(0) */]; // xterm
const ch: CharData = [this.eraseAttr(), NULL_CELL_CHAR, NULL_CELL_WIDTH, NULL_CELL_CODE]; // xterm
for (; x < this.cols; x++) {
line[x] = ch;
}
@@ -1718,15 +1744,15 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
/**
* Erase in the identified line everything from "x" to the start of the line (left).
* @param {number} x The column from which to start erasing to the start of the line.
* @param {number} y The line in which to operate.
* @param x The column from which to start erasing to the start of the line.
* @param y The line in which to operate.
*/
public eraseLeft(x: number, y: number): void {
const line = this.buffer.lines.get(this.buffer.ybase + y);
if (!line) {
return;
}
const ch: CharData = [this.eraseAttr(), ' ', 1, 32 /* ' '.charCodeAt(0) */]; // xterm
const ch: CharData = [this.eraseAttr(), NULL_CELL_CHAR, NULL_CELL_WIDTH, NULL_CELL_CODE]; // xterm
x++;
while (x--) {
line[x] = ch;
@@ -1756,7 +1782,7 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
/**
* Erase all content in the given line
* @param {number} y The line to erase all of its contents.
* @param y The line to erase all of its contents.
*/
public eraseLine(y: number): void {
this.eraseRight(0, y);
@@ -1764,15 +1790,15 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
/**
* Return the data array of a blank line
* @param {boolean} cur First bunch of data for each "blank" character.
* @param {boolean} isWrapped Whether the new line is wrapped from the previous line.
* @param {boolean} cols The number of columns in the terminal, if this is not
* @param cur First bunch of data for each "blank" character.
* @param isWrapped Whether the new line is wrapped from the previous line.
* @param cols The number of columns in the terminal, if this is not
* set, the terminal's current column count would be used.
*/
public blankLine(cur?: boolean, isWrapped?: boolean, cols?: number): LineData {
const attr = cur ? this.eraseAttr() : DEFAULT_ATTR;
const ch: CharData = [attr, ' ', 1, 32 /* ' '.charCodeAt(0) */]; // width defaults to 1 halfwidth character
const ch: CharData = [attr, NULL_CELL_CHAR, NULL_CELL_WIDTH, NULL_CELL_CODE]; // width defaults to 1 halfwidth character
const line: LineData = [];
// TODO: It is not ideal that this is a property on an array, a buffer line
@@ -1795,9 +1821,9 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
*/
public ch(cur?: boolean): CharData {
if (cur) {
return [this.eraseAttr(), ' ', 1, 32 /* ' '.charCodeAt(0) */];
return [this.eraseAttr(), NULL_CELL_CHAR, NULL_CELL_WIDTH, NULL_CELL_CODE];
}
return [DEFAULT_ATTR, ' ', 1, 32 /* ' '.charCodeAt(0) */];
return [DEFAULT_ATTR, NULL_CELL_CHAR, NULL_CELL_WIDTH, NULL_CELL_CODE];
}
/**
@@ -1810,7 +1836,7 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
/**
* Emit the 'data' event and populate the given data.
* @param {string} data The data to populate in the event.
* @param data The data to populate in the event.
*/
public handler(data: string): void {
// Prevents all events to pty process if stdin is disabled
@@ -1832,7 +1858,7 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
/**
* Emit the 'title' event and populate the given title.
* @param {string} title The title to populate in the event.
* @param title The title to populate in the event.
*/
public handleTitle(title: string): void {
/**