Merge branch 'master' into fix/1840

This commit is contained in:
Jörg Breitbart
2018-12-18 00:04:48 +01:00
4 changed files with 93 additions and 42 deletions
+18 -20
View File
@@ -14,6 +14,7 @@ import * as fullscreen from '../lib/addons/fullscreen/fullscreen';
import * as search from '../lib/addons/search/search'; import * as search from '../lib/addons/search/search';
import * as webLinks from '../lib/addons/webLinks/webLinks'; import * as webLinks from '../lib/addons/webLinks/webLinks';
import * as winptyCompat from '../lib/addons/winptyCompat/winptyCompat'; import * as winptyCompat from '../lib/addons/winptyCompat/winptyCompat';
import { ISearchOptions } from '../lib/addons/search/Interfaces';
// Pulling in the module's types relies on the <reference> above, it's looks a // Pulling in the module's types relies on the <reference> above, it's looks a
// little weird here as we're importing "this" module // little weird here as we're importing "this" module
@@ -50,6 +51,14 @@ function setPadding(): void {
term.fit(); term.fit();
} }
function getSearchOptions(): ISearchOptions {
return {
regex: (document.getElementById('regex') as HTMLInputElement).checked,
wholeWord: (document.getElementById('whole-word') as HTMLInputElement).checked,
caseSensitive: (document.getElementById('case-sensitive') as HTMLInputElement).checked
};
}
createTerminal(); createTerminal();
const disposeRecreateButtonHandler = () => { const disposeRecreateButtonHandler = () => {
@@ -97,27 +106,16 @@ function createTerminal(): void {
addDomListener(paddingElement, 'change', setPadding); addDomListener(paddingElement, 'change', setPadding);
addDomListener(actionElements.findNext, 'keypress', (e) => { addDomListener(actionElements.findNext, 'keyup', (e) => {
if (e.key === 'Enter') { const searchOptions = getSearchOptions();
e.preventDefault(); searchOptions.incremental = e.key !== `Enter`;
const searchOptions = { term.findNext(actionElements.findNext.value, searchOptions);
regex: (document.getElementById('regex') as HTMLInputElement).checked,
wholeWord: (document.getElementById('whole-word') as HTMLInputElement).checked,
caseSensitive: (document.getElementById('case-sensitive') as HTMLInputElement).checked
};
term.findNext(actionElements.findNext.value, searchOptions);
}
}); });
addDomListener(actionElements.findPrevious, 'keypress', (e) => {
if (e.key === 'Enter') { addDomListener(actionElements.findPrevious, 'keyup', (e) => {
e.preventDefault(); const searchOptions = getSearchOptions();
const searchOptions = { searchOptions.incremental = e.key !== `Enter`;
regex: (document.getElementById('regex') as HTMLInputElement).checked, term.findPrevious(actionElements.findPrevious.value, searchOptions);
wholeWord: (document.getElementById('whole-word') as HTMLInputElement).checked,
caseSensitive: (document.getElementById('case-sensitive') as HTMLInputElement).checked
};
term.findPrevious(actionElements.findPrevious.value, searchOptions);
}
}); });
// fit is called within a setTimeout, cols and rows need this. // fit is called within a setTimeout, cols and rows need this.
+2
View File
@@ -25,6 +25,8 @@ export interface ISearchOptions {
regex?: boolean; regex?: boolean;
wholeWord?: boolean; wholeWord?: boolean;
caseSensitive?: boolean; caseSensitive?: boolean;
/** Assume caller implements 'search as you type' where findNext gets called when search input changes */
incremental?: boolean;
} }
export interface ISearchResult { export interface ISearchResult {
+72 -22
View File
@@ -4,16 +4,24 @@
*/ */
import { ISearchHelper, ISearchAddonTerminal, ISearchOptions, ISearchResult } from './Interfaces'; import { ISearchHelper, ISearchAddonTerminal, ISearchOptions, ISearchResult } from './Interfaces';
const nonWordCharacters = ' ~!@#$%^&*()+`-=[]{}|\;:"\',./<>?';
const NON_WORD_CHARACTERS = ' ~!@#$%^&*()+`-=[]{}|\;:"\',./<>?';
const LINES_CACHE_TIME_TO_LIVE = 15 * 1000; // 15 secs
/** /**
* A class that knows how to search the terminal and how to display the results. * A class that knows how to search the terminal and how to display the results.
*/ */
export class SearchHelper implements ISearchHelper { export class SearchHelper implements ISearchHelper {
/**
* translateBufferLineToStringWithWrap is a fairly expensive call.
* We memoize the calls into an array that has a time based ttl.
* _linesCache is also invalidated when the terminal cursor moves.
*/
private _linesCache: string[] = null;
private _linesCacheTimeoutId = 0;
constructor(private _terminal: ISearchAddonTerminal) { constructor(private _terminal: ISearchAddonTerminal) {
// TODO: Search for multiple instances on 1 line this._destroyLinesCache = this._destroyLinesCache.bind(this);
// TODO: Don't use the actual selection, instead use a "find selection" so multiple instances can be highlighted
// TODO: Highlight other instances in the viewport
} }
/** /**
@@ -24,29 +32,36 @@ export class SearchHelper implements ISearchHelper {
* @return Whether a result was found. * @return Whether a result was found.
*/ */
public findNext(term: string, searchOptions?: ISearchOptions): boolean { public findNext(term: string, searchOptions?: ISearchOptions): boolean {
const selectionManager = this._terminal._core.selectionManager;
const {incremental} = searchOptions;
let result: ISearchResult;
if (!term || term.length === 0) { if (!term || term.length === 0) {
selectionManager.clearSelection();
return false; return false;
} }
let result: ISearchResult;
let startRow = this._terminal._core.buffer.ydisp; let startRow = this._terminal._core.buffer.ydisp;
if (this._terminal._core.selectionManager.selectionEnd) {
if (selectionManager.selectionEnd) {
// Start from the selection end if there is a selection // Start from the selection end if there is a selection
// For incremental search, use existing row
if (this._terminal.getSelection().length !== 0) { if (this._terminal.getSelection().length !== 0) {
startRow = this._terminal._core.selectionManager.selectionEnd[1]; startRow = incremental ? selectionManager.selectionStart[1] : selectionManager.selectionEnd[1];
} }
} }
// Search from ydisp + 1 to end this._initLinesCache();
for (let y = startRow + 1; y < this._terminal._core.buffer.ybase + this._terminal.rows; y++) {
// Search from startRow to end
for (let y = incremental ? startRow : startRow + 1; y < this._terminal._core.buffer.ybase + this._terminal.rows; y++) {
result = this._findInLine(term, y, searchOptions); result = this._findInLine(term, y, searchOptions);
if (result) { if (result) {
break; break;
} }
} }
// Search from the top to the current ydisp // Search from the top to the startRow
if (!result) { if (!result) {
for (let y = 0; y < startRow; y++) { for (let y = 0; y < startRow; y++) {
result = this._findInLine(term, y, searchOptions); result = this._findInLine(term, y, searchOptions);
@@ -68,29 +83,35 @@ export class SearchHelper implements ISearchHelper {
* @return Whether a result was found. * @return Whether a result was found.
*/ */
public findPrevious(term: string, searchOptions?: ISearchOptions): boolean { public findPrevious(term: string, searchOptions?: ISearchOptions): boolean {
const selectionManager = this._terminal._core.selectionManager;
const {incremental} = searchOptions;
let result: ISearchResult;
if (!term || term.length === 0) { if (!term || term.length === 0) {
selectionManager.clearSelection();
return false; return false;
} }
let result: ISearchResult;
let startRow = this._terminal._core.buffer.ydisp; let startRow = this._terminal._core.buffer.ydisp;
if (this._terminal._core.selectionManager.selectionStart) {
// Start from the selection end if there is a selection if (selectionManager.selectionStart) {
// Start from the selection start if there is a selection
if (this._terminal.getSelection().length !== 0) { if (this._terminal.getSelection().length !== 0) {
startRow = this._terminal._core.selectionManager.selectionStart[1]; startRow = selectionManager.selectionStart[1];
} }
} }
// Search from ydisp + 1 to end this._initLinesCache();
for (let y = startRow - 1; y >= 0; y--) {
// Search from startRow to top
for (let y = incremental ? startRow : startRow - 1; y >= 0; y--) {
result = this._findInLine(term, y, searchOptions); result = this._findInLine(term, y, searchOptions);
if (result) { if (result) {
break; break;
} }
} }
// Search from the top to the current ydisp // Search from the bottom to startRow
if (!result) { if (!result) {
for (let y = this._terminal._core.buffer.ybase + this._terminal.rows - 1; y > startRow; y--) { for (let y = this._terminal._core.buffer.ybase + this._terminal.rows - 1; y > startRow; y--) {
result = this._findInLine(term, y, searchOptions); result = this._findInLine(term, y, searchOptions);
@@ -104,6 +125,28 @@ export class SearchHelper implements ISearchHelper {
return this._selectResult(result); return this._selectResult(result);
} }
/**
* Sets up a line cache with a ttl
*/
private _initLinesCache(): void {
if (!this._linesCache) {
this._linesCache = new Array(this._terminal._core.buffer.length);
this._terminal.on('cursormove', this._destroyLinesCache);
}
window.clearTimeout(this._linesCacheTimeoutId);
this._linesCacheTimeoutId = window.setTimeout(() => this._destroyLinesCache(), LINES_CACHE_TIME_TO_LIVE);
}
private _destroyLinesCache(): void {
this._linesCache = null;
this._terminal.off('cursormove', this._destroyLinesCache);
if (this._linesCacheTimeoutId) {
window.clearTimeout(this._linesCacheTimeoutId);
this._linesCacheTimeoutId = 0;
}
}
/** /**
* A found substring is a whole word if it doesn't have an alphanumeric character directly adjacent to it. * A found substring is a whole word if it doesn't have an alphanumeric character directly adjacent to it.
* @param searchIndex starting indext of the potential whole word substring * @param searchIndex starting indext of the potential whole word substring
@@ -111,8 +154,8 @@ export class SearchHelper implements ISearchHelper {
* @param term the substring that starts at searchIndex * @param term the substring that starts at searchIndex
*/ */
private _isWholeWord(searchIndex: number, line: string, term: string): boolean { private _isWholeWord(searchIndex: number, line: string, term: string): boolean {
return (((searchIndex === 0) || (nonWordCharacters.indexOf(line[searchIndex - 1]) !== -1)) && return (((searchIndex === 0) || (NON_WORD_CHARACTERS.indexOf(line[searchIndex - 1]) !== -1)) &&
(((searchIndex + term.length) === line.length) || (nonWordCharacters.indexOf(line[searchIndex + term.length]) !== -1))); (((searchIndex + term.length) === line.length) || (NON_WORD_CHARACTERS.indexOf(line[searchIndex + term.length]) !== -1)));
} }
/** /**
@@ -130,7 +173,14 @@ export class SearchHelper implements ISearchHelper {
return; return;
} }
const stringLine = this.translateBufferLineToStringWithWrap(y, true); let stringLine = this._linesCache ? this._linesCache[y] : void 0;
if (stringLine === void 0) {
stringLine = this.translateBufferLineToStringWithWrap(y, true);
if (this._linesCache) {
this._linesCache[y] = stringLine;
}
}
const searchStringLine = searchOptions.caseSensitive ? stringLine : stringLine.toLowerCase(); const searchStringLine = searchOptions.caseSensitive ? stringLine : stringLine.toLowerCase();
const searchTerm = searchOptions.caseSensitive ? term : term.toLowerCase(); const searchTerm = searchOptions.caseSensitive ? term : term.toLowerCase();
let searchIndex = -1; let searchIndex = -1;
+1
View File
@@ -3,6 +3,7 @@
"module": "commonjs", "module": "commonjs",
"target": "es5", "target": "es5",
"lib": [ "lib": [
"dom",
"es5" "es5"
], ],
"rootDir": ".", "rootDir": ".",