Add new search addon, move AddonManager to public

Because addons build on top of the API it needs to live in public, the main
reason for this is because the implementation of buffer differs on
public/Terminal and src/Terminal.
This commit is contained in:
Daniel Imms
2019-05-12 10:22:29 -07:00
parent 0c588a7333
commit eda04bcb23
8 changed files with 21 additions and 17 deletions
+6 -3
View File
@@ -9,6 +9,7 @@
import { Terminal } from '../lib/public/Terminal'; import { Terminal } from '../lib/public/Terminal';
import { AttachAddon } from 'xterm-addon-attach'; import { AttachAddon } from 'xterm-addon-attach';
import { SearchAddon } from 'xterm-addon-search';
import { WebLinksAddon } from 'xterm-addon-web-links'; import { WebLinksAddon } from 'xterm-addon-web-links';
import * as fit from '../lib/addons/fit/fit'; import * as fit from '../lib/addons/fit/fit';
@@ -28,10 +29,10 @@ declare let window: IWindowWithTerminal;
Terminal.applyAddon(fit); Terminal.applyAddon(fit);
Terminal.applyAddon(fullscreen); Terminal.applyAddon(fullscreen);
Terminal.applyAddon(search);
let term; let term;
let attachAddon: AttachAddon; let attachAddon: AttachAddon;
let searchAddon: SearchAddon;
let protocol; let protocol;
let socketURL; let socketURL;
let socket; let socket;
@@ -95,6 +96,8 @@ function createTerminal(): void {
typedTerm.loadAddon(new WebLinksAddon()); typedTerm.loadAddon(new WebLinksAddon());
attachAddon = new AttachAddon(); attachAddon = new AttachAddon();
typedTerm.loadAddon(attachAddon); typedTerm.loadAddon(attachAddon);
searchAddon = new SearchAddon();
typedTerm.loadAddon(searchAddon);
window.term = term; // Expose `term` to window for debugging purposes window.term = term; // Expose `term` to window for debugging purposes
term.onResize((size: { cols: number, rows: number }) => { term.onResize((size: { cols: number, rows: number }) => {
@@ -119,12 +122,12 @@ function createTerminal(): void {
addDomListener(actionElements.findNext, 'keyup', (e) => { addDomListener(actionElements.findNext, 'keyup', (e) => {
const searchOptions = getSearchOptions(); const searchOptions = getSearchOptions();
searchOptions.incremental = e.key !== `Enter`; searchOptions.incremental = e.key !== `Enter`;
term.findNext(actionElements.findNext.value, searchOptions); searchAddon.findNext(actionElements.findNext.value, searchOptions);
}); });
addDomListener(actionElements.findPrevious, 'keyup', (e) => { addDomListener(actionElements.findPrevious, 'keyup', (e) => {
if (e.key === `Enter`) { if (e.key === `Enter`) {
term.findPrevious(actionElements.findPrevious.value, getSearchOptions()); searchAddon.findPrevious(actionElements.findPrevious.value, getSearchOptions());
} }
}); });
+1
View File
@@ -45,6 +45,7 @@
"webpack": "^4.17.1", "webpack": "^4.17.1",
"webpack-cli": "^3.1.0", "webpack-cli": "^3.1.0",
"xterm-addon-attach": "0.1.0-beta7", "xterm-addon-attach": "0.1.0-beta7",
"xterm-addon-search": "0.1.0-beta3",
"xterm-addon-web-links": "0.1.0-beta6", "xterm-addon-web-links": "0.1.0-beta6",
"zmodem.js": "^0.1.5" "zmodem.js": "^0.1.5"
}, },
+1 -9
View File
@@ -43,14 +43,13 @@ import { DEFAULT_BELL_SOUND, SoundManager } from './SoundManager';
import { MouseZoneManager } from './MouseZoneManager'; import { MouseZoneManager } from './MouseZoneManager';
import { AccessibilityManager } from './AccessibilityManager'; import { AccessibilityManager } from './AccessibilityManager';
import { ScreenDprMonitor } from './ui/ScreenDprMonitor'; import { ScreenDprMonitor } from './ui/ScreenDprMonitor';
import { ITheme, IMarker, IDisposable, ITerminalAddon, ISelectionPosition } from 'xterm'; import { ITheme, IMarker, IDisposable, ISelectionPosition } from 'xterm';
import { removeTerminalFromCache } from './renderer/atlas/CharAtlasCache'; import { removeTerminalFromCache } from './renderer/atlas/CharAtlasCache';
import { DomRenderer } from './renderer/dom/DomRenderer'; import { DomRenderer } from './renderer/dom/DomRenderer';
import { IKeyboardEvent } from './common/Types'; import { IKeyboardEvent } from './common/Types';
import { evaluateKeyboardEvent } from './core/input/Keyboard'; import { evaluateKeyboardEvent } from './core/input/Keyboard';
import { KeyboardResultType, ICharset, IBufferLine, IAttributeData } from './core/Types'; import { KeyboardResultType, ICharset, IBufferLine, IAttributeData } from './core/Types';
import { clone } from './common/Clone'; import { clone } from './common/Clone';
import { AddonManager } from './ui/AddonManager';
import { EventEmitter2, IEvent } from './common/EventEmitter2'; import { EventEmitter2, IEvent } from './common/EventEmitter2';
import { Attributes, DEFAULT_ATTR_DATA } from './core/buffer/BufferLine'; import { Attributes, DEFAULT_ATTR_DATA } from './core/buffer/BufferLine';
import { applyWindowsMode } from './WindowsMode'; import { applyWindowsMode } from './WindowsMode';
@@ -212,7 +211,6 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
private _mouseZoneManager: IMouseZoneManager; private _mouseZoneManager: IMouseZoneManager;
public mouseHelper: MouseHelper; public mouseHelper: MouseHelper;
private _accessibilityManager: AccessibilityManager; private _accessibilityManager: AccessibilityManager;
private _addonManager: AddonManager;
private _screenDprMonitor: ScreenDprMonitor; private _screenDprMonitor: ScreenDprMonitor;
private _theme: ITheme; private _theme: ITheme;
private _windowsMode: IDisposable | undefined; private _windowsMode: IDisposable | undefined;
@@ -275,7 +273,6 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
} }
public dispose(): void { public dispose(): void {
this._addonManager.dispose();
super.dispose(); super.dispose();
if (this._windowsMode) { if (this._windowsMode) {
this._windowsMode.dispose(); this._windowsMode.dispose();
@@ -361,7 +358,6 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
this.linkifier = this.linkifier || new Linkifier(this); this.linkifier = this.linkifier || new Linkifier(this);
this._mouseZoneManager = this._mouseZoneManager || null; this._mouseZoneManager = this._mouseZoneManager || null;
this.soundManager = this.soundManager || new SoundManager(this); this.soundManager = this.soundManager || new SoundManager(this);
this._addonManager = this._addonManager || new AddonManager();
// Create the terminal's buffers and set the current buffer // Create the terminal's buffers and set the current buffer
this.buffers = new BufferSet(this); this.buffers = new BufferSet(this);
@@ -1973,10 +1969,6 @@ export class Terminal extends EventEmitter implements ITerminal, IDisposable, II
// return this.options.bellStyle === 'sound' || // return this.options.bellStyle === 'sound' ||
// this.options.bellStyle === 'both'; // this.options.bellStyle === 'both';
} }
public loadAddon(addon: ITerminalAddon): void {
return this._addonManager.loadAddon(this, addon);
}
} }
/** /**
+1 -1
View File
@@ -220,6 +220,7 @@ export interface ITerminal extends IPublicTerminal, IElementAccessor, IBufferAcc
showCursor(): void; showCursor(): void;
} }
// Portions of the public API that are required by the internal Terminal
export interface IPublicTerminal extends IDisposable, IEventEmitter { export interface IPublicTerminal extends IDisposable, IEventEmitter {
textarea: HTMLTextAreaElement; textarea: HTMLTextAreaElement;
rows: number; rows: number;
@@ -268,7 +269,6 @@ export interface IPublicTerminal extends IDisposable, IEventEmitter {
setOption(key: string, value: any): void; setOption(key: string, value: any): void;
refresh(start: number, end: number): void; refresh(start: number, end: number): void;
reset(): void; reset(): void;
loadAddon(addon: ITerminalAddon): void;
} }
export interface ITerminalAddon extends IDisposable { export interface ITerminalAddon extends IDisposable {
@@ -3,8 +3,7 @@
* @license MIT * @license MIT
*/ */
import { ITerminalAddon, IDisposable } from 'xterm'; import { ITerminalAddon, IDisposable, Terminal } from 'xterm';
import { IPublicTerminal } from '../Types';
export interface ILoadedAddon { export interface ILoadedAddon {
instance: ITerminalAddon; instance: ITerminalAddon;
@@ -24,7 +23,7 @@ export class AddonManager implements IDisposable {
} }
} }
public loadAddon(terminal: IPublicTerminal, instance: ITerminalAddon): void { public loadAddon(terminal: Terminal, instance: ITerminalAddon): void {
const loadedAddon: ILoadedAddon = { const loadedAddon: ILoadedAddon = {
instance, instance,
dispose: instance.dispose, dispose: instance.dispose,
+5 -1
View File
@@ -9,12 +9,15 @@ import { IBufferLine } from '../core/Types';
import { Terminal as TerminalCore } from '../Terminal'; import { Terminal as TerminalCore } from '../Terminal';
import * as Strings from '../Strings'; import * as Strings from '../Strings';
import { IEvent } from '../common/EventEmitter2'; import { IEvent } from '../common/EventEmitter2';
import { AddonManager } from './AddonManager';
export class Terminal implements ITerminalApi { export class Terminal implements ITerminalApi {
private _core: ITerminal; private _core: ITerminal;
private _addonManager: AddonManager;
constructor(options?: ITerminalOptions) { constructor(options?: ITerminalOptions) {
this._core = new TerminalCore(options); this._core = new TerminalCore(options);
this._addonManager = new AddonManager();
} }
public get onCursorMove(): IEvent<void> { return this._core.onCursorMove; } public get onCursorMove(): IEvent<void> { return this._core.onCursorMove; }
@@ -115,6 +118,7 @@ export class Terminal implements ITerminalApi {
this._core.selectLines(start, end); this._core.selectLines(start, end);
} }
public dispose(): void { public dispose(): void {
this._addonManager.dispose();
this._core.dispose(); this._core.dispose();
} }
public destroy(): void { public destroy(): void {
@@ -174,7 +178,7 @@ export class Terminal implements ITerminalApi {
addon.apply(Terminal); addon.apply(Terminal);
} }
public loadAddon(addon: ITerminalAddon): void { public loadAddon(addon: ITerminalAddon): void {
return this._core.loadAddon(addon); return this._addonManager.loadAddon(this, addon);
} }
public static get strings(): ILocalizableStrings { public static get strings(): ILocalizableStrings {
return Strings; return Strings;
+5
View File
@@ -7231,6 +7231,11 @@ xterm-addon-attach@0.1.0-beta7:
resolved "https://registry.yarnpkg.com/xterm-addon-attach/-/xterm-addon-attach-0.1.0-beta7.tgz#787f6cce709611ee08ab731b95a62fa1c0bce6a9" resolved "https://registry.yarnpkg.com/xterm-addon-attach/-/xterm-addon-attach-0.1.0-beta7.tgz#787f6cce709611ee08ab731b95a62fa1c0bce6a9"
integrity sha512-nQr6LcYtpZcyDoHyL/BDIPJcTgL7qlHR/rvm8lSizQysGVT0pSzr5M7SjY3kQHw33U3hTer3c6oZzwjfj4ohOw== integrity sha512-nQr6LcYtpZcyDoHyL/BDIPJcTgL7qlHR/rvm8lSizQysGVT0pSzr5M7SjY3kQHw33U3hTer3c6oZzwjfj4ohOw==
xterm-addon-search@0.1.0-beta3:
version "0.1.0-beta3"
resolved "https://registry.yarnpkg.com/xterm-addon-search/-/xterm-addon-search-0.1.0-beta3.tgz#0754fa329cd505d6591abf24aac560c72f865636"
integrity sha512-09w/h3wsFtCveH1C0Fu8dwVvjiNvWRgp2lDABSK/yQEGETq4nznLzRSiMnFMz1y1rilFUi3Xn+l4+tQK+8iORg==
xterm-addon-web-links@0.1.0-beta6: xterm-addon-web-links@0.1.0-beta6:
version "0.1.0-beta6" version "0.1.0-beta6"
resolved "https://registry.yarnpkg.com/xterm-addon-web-links/-/xterm-addon-web-links-0.1.0-beta6.tgz#9b4e862be8928ef455a667745bea479665db6c6b" resolved "https://registry.yarnpkg.com/xterm-addon-web-links/-/xterm-addon-web-links-0.1.0-beta6.tgz#9b4e862be8928ef455a667745bea479665db6c6b"