From 376c790e1d3feb5facc6817c383b296378d4f3cd Mon Sep 17 00:00:00 2001 From: Noam Date: Fri, 30 Nov 2018 20:39:05 +0200 Subject: [PATCH 1/7] implement find multiple matches in line. start search from current selection. add unit tests. --- src/addons/search/Interfaces.ts | 7 ++- src/addons/search/SearchHelper.ts | 86 +++++++++++++++++++------------ src/addons/search/search.test.ts | 70 +++++++++++++++++++++++-- 3 files changed, 126 insertions(+), 37 deletions(-) diff --git a/src/addons/search/Interfaces.ts b/src/addons/search/Interfaces.ts index af06c5d1ad..e03b70c4c4 100644 --- a/src/addons/search/Interfaces.ts +++ b/src/addons/search/Interfaces.ts @@ -25,10 +25,13 @@ export interface ISearchOptions { regex?: boolean; wholeWord?: boolean; caseSensitive?: boolean; + reverseSearch?: boolean; } -export interface ISearchResult { - term: string; +export interface ISearchIndex { col: number; row: number; } +export interface ISearchResult extends ISearchIndex { + term: string; +} diff --git a/src/addons/search/SearchHelper.ts b/src/addons/search/SearchHelper.ts index 7919932a1d..dd0559917e 100644 --- a/src/addons/search/SearchHelper.ts +++ b/src/addons/search/SearchHelper.ts @@ -3,7 +3,7 @@ * @license MIT */ -import { ISearchHelper, ISearchAddonTerminal, ISearchOptions, ISearchResult } from './Interfaces'; +import { ISearchHelper, ISearchAddonTerminal, ISearchOptions, ISearchResult, ISearchIndex } from './Interfaces'; const nonWordCharacters = ' ~!@#$%^&*()+`-=[]{}|\;:"\',./<>?'; /** @@ -29,27 +29,30 @@ export class SearchHelper implements ISearchHelper { } let result: ISearchResult; - let startRow = this._terminal._core.buffer.ydisp; + let startCol: number = 0; if (this._terminal._core.selectionManager.selectionEnd) { // Start from the selection end if there is a selection if (this._terminal.getSelection().length !== 0) { startRow = this._terminal._core.selectionManager.selectionEnd[1]; + startCol = this._terminal._core.selectionManager.selectionEnd[0]; } } // Search from ydisp + 1 to end - for (let y = startRow + 1; y < this._terminal._core.buffer.ybase + this._terminal.rows; y++) { - result = this._findInLine(term, y, searchOptions); + for (let y = startRow; y < this._terminal._core.buffer.ybase + this._terminal.rows; y++) { + result = this._findInLine(term, {row: y, col: startCol}, searchOptions); if (result) { break; } + startCol = 0; } // Search from the top to the current ydisp if (!result) { for (let y = 0; y < startRow; y++) { - result = this._findInLine(term, y, searchOptions); + startCol = 0; + result = this._findInLine(term, {row: y, col: startCol}, searchOptions); if (result) { break; } @@ -72,28 +75,35 @@ export class SearchHelper implements ISearchHelper { return false; } - let result: ISearchResult; + searchOptions.reverseSearch = true; + let result: ISearchResult; let startRow = this._terminal._core.buffer.ydisp; + let startCol: number = this._terminal._core.buffer.lines.get(startRow).length; + if (this._terminal._core.selectionManager.selectionStart) { // Start from the selection end if there is a selection if (this._terminal.getSelection().length !== 0) { startRow = this._terminal._core.selectionManager.selectionStart[1]; + startCol = this._terminal._core.selectionManager.selectionStart[0]; } } // Search from ydisp + 1 to end - for (let y = startRow - 1; y >= 0; y--) { - result = this._findInLine(term, y, searchOptions); + for (let y = startRow; y >= 0; y--) { + result = this._findInLine(term, {row: y, col: startCol}, searchOptions); if (result) { break; } + startCol = y > 0 ? this._terminal._core.buffer.lines.get(y - 1).length : 0; } // Search from the top to the current ydisp if (!result) { - for (let y = this._terminal._core.buffer.ybase + this._terminal.rows - 1; y > startRow; y--) { - result = this._findInLine(term, y, searchOptions); + const searchFrom = this._terminal._core.buffer.ybase + this._terminal.rows - 1; + for (let y = searchFrom; y > startRow; y--) { + startCol = this._terminal._core.buffer.lines.get(y).length; + result = this._findInLine(term, {row: y, col: startCol}, searchOptions); if (result) { break; } @@ -125,61 +135,73 @@ export class SearchHelper implements ISearchHelper { * @param searchOptions Search options. * @return The search result if it was found. */ - protected _findInLine(term: string, y: number, searchOptions: ISearchOptions = {}): ISearchResult { - if (this._terminal._core.buffer.lines.get(y).isWrapped) { + protected _findInLine(term: string, searchIndex: ISearchIndex, searchOptions: ISearchOptions = {}): ISearchResult { + if (this._terminal._core.buffer.lines.get(searchIndex.row).isWrapped) { return; } - const stringLine = this.translateBufferLineToStringWithWrap(y, true); - const searchStringLine = searchOptions.caseSensitive ? stringLine : stringLine.toLowerCase(); + const stringLine = this.translateBufferLineToStringWithWrap(searchIndex.row, true); const searchTerm = searchOptions.caseSensitive ? term : term.toLowerCase(); - let searchIndex = -1; + const searchStringLine = searchOptions.caseSensitive ? stringLine : stringLine.toLowerCase(); + let resultIndex = -1; if (searchOptions.regex) { const searchRegex = RegExp(searchTerm, 'g'); - const foundTerm = searchRegex.exec(searchStringLine); - if (foundTerm && foundTerm[0].length > 0) { - searchIndex = searchRegex.lastIndex - foundTerm[0].length; - term = foundTerm[0]; + let foundTerm: RegExpExecArray; + if (searchOptions.reverseSearch) { + while (foundTerm = searchRegex.exec(searchStringLine.slice(0, searchIndex.col))) { + resultIndex = searchRegex.lastIndex - foundTerm[0].length; + term = foundTerm[0]; + searchRegex.lastIndex -= (term.length - 1); + } + } else { + foundTerm = searchRegex.exec(searchStringLine.slice(searchIndex.col)); + if (foundTerm && foundTerm[0].length > 0) { + resultIndex = searchIndex.col + (searchRegex.lastIndex - foundTerm[0].length); + term = foundTerm[0]; + } } } else { - searchIndex = searchStringLine.indexOf(searchTerm); + if (searchOptions.reverseSearch) { + resultIndex = searchStringLine.lastIndexOf(searchTerm, searchIndex.col - searchTerm.length); + } else { + resultIndex = searchStringLine.indexOf(searchTerm, searchIndex.col); + } } - if (searchIndex >= 0) { + if (resultIndex >= 0) { // Adjust the row number and search index if needed since a "line" of text can span multiple rows - if (searchIndex >= this._terminal.cols) { - y += Math.floor(searchIndex / this._terminal.cols); - searchIndex = searchIndex % this._terminal.cols; + if (resultIndex >= this._terminal.cols) { + searchIndex.row += Math.floor(resultIndex / this._terminal.cols); + resultIndex = resultIndex % this._terminal.cols; } - if (searchOptions.wholeWord && !this._isWholeWord(searchIndex, searchStringLine, term)) { + if (searchOptions.wholeWord && !this._isWholeWord(resultIndex, searchStringLine, term)) { return; } - const line = this._terminal._core.buffer.lines.get(y); + const line = this._terminal._core.buffer.lines.get(searchIndex.row); - for (let i = 0; i < searchIndex; i++) { + for (let i = 0; i < resultIndex; i++) { const charData = line.get(i); // Adjust the searchIndex to normalize emoji into single chars const char = charData[1/*CHAR_DATA_CHAR_INDEX*/]; if (char.length > 1) { - searchIndex -= char.length - 1; + resultIndex -= char.length - 1; } // Adjust the searchIndex for empty characters following wide unicode // chars (eg. CJK) const charWidth = charData[2/*CHAR_DATA_WIDTH_INDEX*/]; if (charWidth === 0) { - searchIndex++; + resultIndex++; } } return { term, - col: searchIndex, - row: y + col: resultIndex, + row: searchIndex.row }; } } - /** * Translates a buffer line to a string, including subsequent lines if they are wraps. * Wide characters will count as two columns in the resulting string. This diff --git a/src/addons/search/search.test.ts b/src/addons/search/search.test.ts index 3e0b815456..be9ec4796c 100644 --- a/src/addons/search/search.test.ts +++ b/src/addons/search/search.test.ts @@ -7,7 +7,7 @@ declare var require: any; import { assert, expect } from 'chai'; import * as search from './search'; import { SearchHelper } from './SearchHelper'; -import { ISearchOptions, ISearchResult } from './Interfaces'; +import { ISearchOptions, ISearchResult, ISearchIndex } from './Interfaces'; class MockTerminalPlain {} @@ -29,8 +29,11 @@ class MockTerminal { } class TestSearchHelper extends SearchHelper { - public findInLine(term: string, y: number, searchOptions?: ISearchOptions): ISearchResult { - return this._findInLine(term, y, searchOptions); + public findInLine(term: string, rowNumber: number, searchOptions?: ISearchOptions): ISearchResult { + return this._findInLine(term, {row: rowNumber, col: 0}, searchOptions); + } + public findFromIndex(term: string, searchIndex: ISearchIndex, searchOptions?: ISearchOptions): ISearchResult { + return this._findInLine(term, searchIndex, searchOptions); } } @@ -247,5 +250,66 @@ describe('search addon', () => { expect(hello4).eql(undefined); expect(hello5).eql(undefined); }); + it('should find multiple matches in line', function(): void { + search.apply(MockTerminal); + const term = new MockTerminal({cols: 20, rows: 5}); + term.core.write('helloooo helloooo\r\naaaAAaaAAA'); + term.pushWriteData(); + const searchOptions = { + regex: false, + wholeWord: false, + caseSensitive: false + }; + const find0 = term.searchHelper.findFromIndex('hello', {row: 0, col: 0}, searchOptions); + const find1 = term.searchHelper.findFromIndex('hello', {row: 0, col: find0.col + find0.term.length}, searchOptions); + const find2 = term.searchHelper.findFromIndex('aaaa', {row: 1, col: 0}, searchOptions); + const find3 = term.searchHelper.findFromIndex('aaaa', {row: 1, col: find2.col + find2.term.length}, searchOptions); + const find4 = term.searchHelper.findFromIndex('aaaa', {row: 1, col: find3.col + find3.term.length}, searchOptions); + expect(find0).eql({col: 0, row: 0, term: 'hello'}); + expect(find1).eql({col: 9, row: 0, term: 'hello'}); + expect(find2).eql({col: 0, row: 1, term: 'aaaa'}); + expect(find3).eql({col: 4, row: 1, term: 'aaaa'}); + expect(find4).eql(undefined); + }); + it('should find multiple matches in line - reverse search', function(): void { + search.apply(MockTerminal); + const term = new MockTerminal({cols: 20, rows: 5}); + term.core.write('it is what it is'); + term.pushWriteData(); + const searchOptions = { + regex: false, + wholeWord: false, + caseSensitive: false, + reverseSearch: true + }; + const find0 = term.searchHelper.findFromIndex('is', {row: 0, col: 16}, searchOptions); + const find1 = term.searchHelper.findFromIndex('is', {row: 0, col: find0.col}, searchOptions); + const find2 = term.searchHelper.findFromIndex('it', {row: 0, col: 16}, searchOptions); + const find3 = term.searchHelper.findFromIndex('it', {row: 0, col: find2.col}, searchOptions); + expect(find0).eql({col: 14, row: 0, term: 'is'}); + expect(find1).eql({col: 3, row: 0, term: 'is'}); + expect(find2).eql({col: 11, row: 0, term: 'it'}); + expect(find3).eql({col: 0, row: 0, term: 'it'}); + }); + it('should find multiple matches in line - reverse search with regex', function(): void { + search.apply(MockTerminal); + const term = new MockTerminal({cols: 20, rows: 5}); + term.core.write('zzzABCzzzzABCABC'); + term.pushWriteData(); + const searchOptions = { + regex: true, + wholeWord: false, + caseSensitive: true, + reverseSearch: true + }; + const find0 = term.searchHelper.findFromIndex('[A-Z]{3}', {row: 0, col: 16}, searchOptions); + const find1 = term.searchHelper.findFromIndex('[A-Z]{3}', {row: 0, col: find0.col}, searchOptions); + const find2 = term.searchHelper.findFromIndex('[A-Z]{3}', {row: 0, col: find1.col}, searchOptions); + const find3 = term.searchHelper.findFromIndex('[A-Z]{3}', {row: 0, col: find2.col}, searchOptions); + expect(find0).eql({col: 13, row: 0, term: 'ABC'}); + expect(find1).eql({col: 10, row: 0, term: 'ABC'}); + expect(find2).eql({col: 3, row: 0, term: 'ABC'}); + expect(find3).eql(undefined); + }); }); }); From 278d696709b799c20481107ebf2a6ff53ae0764b Mon Sep 17 00:00:00 2001 From: Noam Date: Fri, 7 Dec 2018 22:56:57 +0200 Subject: [PATCH 2/7] remove reverseSearch from ISearchOptions add isReverseSearch argument to findInLine modify unit tests --- src/addons/search/Interfaces.ts | 2 +- src/addons/search/SearchHelper.ts | 15 ++++++--------- src/addons/search/search.test.ts | 28 ++++++++++++++-------------- 3 files changed, 21 insertions(+), 24 deletions(-) diff --git a/src/addons/search/Interfaces.ts b/src/addons/search/Interfaces.ts index e03b70c4c4..e15224d170 100644 --- a/src/addons/search/Interfaces.ts +++ b/src/addons/search/Interfaces.ts @@ -25,13 +25,13 @@ export interface ISearchOptions { regex?: boolean; wholeWord?: boolean; caseSensitive?: boolean; - reverseSearch?: boolean; } export interface ISearchIndex { col: number; row: number; } + export interface ISearchResult extends ISearchIndex { term: string; } diff --git a/src/addons/search/SearchHelper.ts b/src/addons/search/SearchHelper.ts index dd0559917e..5052a07d37 100644 --- a/src/addons/search/SearchHelper.ts +++ b/src/addons/search/SearchHelper.ts @@ -5,7 +5,6 @@ import { ISearchHelper, ISearchAddonTerminal, ISearchOptions, ISearchResult, ISearchIndex } from './Interfaces'; const nonWordCharacters = ' ~!@#$%^&*()+`-=[]{}|\;:"\',./<>?'; - /** * A class that knows how to search the terminal and how to display the results. */ @@ -74,9 +73,7 @@ export class SearchHelper implements ISearchHelper { if (!term || term.length === 0) { return false; } - - searchOptions.reverseSearch = true; - + const isReverseSearch = true; let result: ISearchResult; let startRow = this._terminal._core.buffer.ydisp; let startCol: number = this._terminal._core.buffer.lines.get(startRow).length; @@ -91,7 +88,7 @@ export class SearchHelper implements ISearchHelper { // Search from ydisp + 1 to end for (let y = startRow; y >= 0; y--) { - result = this._findInLine(term, {row: y, col: startCol}, searchOptions); + result = this._findInLine(term, {row: y, col: startCol}, searchOptions, isReverseSearch); if (result) { break; } @@ -103,7 +100,7 @@ export class SearchHelper implements ISearchHelper { const searchFrom = this._terminal._core.buffer.ybase + this._terminal.rows - 1; for (let y = searchFrom; y > startRow; y--) { startCol = this._terminal._core.buffer.lines.get(y).length; - result = this._findInLine(term, {row: y, col: startCol}, searchOptions); + result = this._findInLine(term, {row: y, col: startCol}, searchOptions, isReverseSearch); if (result) { break; } @@ -135,7 +132,7 @@ export class SearchHelper implements ISearchHelper { * @param searchOptions Search options. * @return The search result if it was found. */ - protected _findInLine(term: string, searchIndex: ISearchIndex, searchOptions: ISearchOptions = {}): ISearchResult { + protected _findInLine(term: string, searchIndex: ISearchIndex, searchOptions: ISearchOptions = {}, isReverseSearch: boolean = false): ISearchResult { if (this._terminal._core.buffer.lines.get(searchIndex.row).isWrapped) { return; } @@ -148,7 +145,7 @@ export class SearchHelper implements ISearchHelper { if (searchOptions.regex) { const searchRegex = RegExp(searchTerm, 'g'); let foundTerm: RegExpExecArray; - if (searchOptions.reverseSearch) { + if (isReverseSearch) { while (foundTerm = searchRegex.exec(searchStringLine.slice(0, searchIndex.col))) { resultIndex = searchRegex.lastIndex - foundTerm[0].length; term = foundTerm[0]; @@ -162,7 +159,7 @@ export class SearchHelper implements ISearchHelper { } } } else { - if (searchOptions.reverseSearch) { + if (isReverseSearch) { resultIndex = searchStringLine.lastIndexOf(searchTerm, searchIndex.col - searchTerm.length); } else { resultIndex = searchStringLine.indexOf(searchTerm, searchIndex.col); diff --git a/src/addons/search/search.test.ts b/src/addons/search/search.test.ts index be9ec4796c..0a38f755e0 100644 --- a/src/addons/search/search.test.ts +++ b/src/addons/search/search.test.ts @@ -32,8 +32,8 @@ class TestSearchHelper extends SearchHelper { public findInLine(term: string, rowNumber: number, searchOptions?: ISearchOptions): ISearchResult { return this._findInLine(term, {row: rowNumber, col: 0}, searchOptions); } - public findFromIndex(term: string, searchIndex: ISearchIndex, searchOptions?: ISearchOptions): ISearchResult { - return this._findInLine(term, searchIndex, searchOptions); + public findFromIndex(term: string, searchIndex: ISearchIndex, searchOptions?: ISearchOptions, isReverseSearch?: boolean): ISearchResult { + return this._findInLine(term, searchIndex, searchOptions, isReverseSearch); } } @@ -279,13 +279,13 @@ describe('search addon', () => { const searchOptions = { regex: false, wholeWord: false, - caseSensitive: false, - reverseSearch: true + caseSensitive: false }; - const find0 = term.searchHelper.findFromIndex('is', {row: 0, col: 16}, searchOptions); - const find1 = term.searchHelper.findFromIndex('is', {row: 0, col: find0.col}, searchOptions); - const find2 = term.searchHelper.findFromIndex('it', {row: 0, col: 16}, searchOptions); - const find3 = term.searchHelper.findFromIndex('it', {row: 0, col: find2.col}, searchOptions); + const isReverseSearch = true; + const find0 = term.searchHelper.findFromIndex('is', {row: 0, col: 16}, searchOptions, isReverseSearch); + const find1 = term.searchHelper.findFromIndex('is', {row: 0, col: find0.col}, searchOptions, isReverseSearch); + const find2 = term.searchHelper.findFromIndex('it', {row: 0, col: 16}, searchOptions, isReverseSearch); + const find3 = term.searchHelper.findFromIndex('it', {row: 0, col: find2.col}, searchOptions, isReverseSearch); expect(find0).eql({col: 14, row: 0, term: 'is'}); expect(find1).eql({col: 3, row: 0, term: 'is'}); expect(find2).eql({col: 11, row: 0, term: 'it'}); @@ -299,13 +299,13 @@ describe('search addon', () => { const searchOptions = { regex: true, wholeWord: false, - caseSensitive: true, - reverseSearch: true + caseSensitive: true }; - const find0 = term.searchHelper.findFromIndex('[A-Z]{3}', {row: 0, col: 16}, searchOptions); - const find1 = term.searchHelper.findFromIndex('[A-Z]{3}', {row: 0, col: find0.col}, searchOptions); - const find2 = term.searchHelper.findFromIndex('[A-Z]{3}', {row: 0, col: find1.col}, searchOptions); - const find3 = term.searchHelper.findFromIndex('[A-Z]{3}', {row: 0, col: find2.col}, searchOptions); + const isReverseSearch = true; + const find0 = term.searchHelper.findFromIndex('[A-Z]{3}', {row: 0, col: 16}, searchOptions, isReverseSearch); + const find1 = term.searchHelper.findFromIndex('[A-Z]{3}', {row: 0, col: find0.col}, searchOptions, isReverseSearch); + const find2 = term.searchHelper.findFromIndex('[A-Z]{3}', {row: 0, col: find1.col}, searchOptions, isReverseSearch); + const find3 = term.searchHelper.findFromIndex('[A-Z]{3}', {row: 0, col: find2.col}, searchOptions, isReverseSearch); expect(find0).eql({col: 13, row: 0, term: 'ABC'}); expect(find1).eql({col: 10, row: 0, term: 'ABC'}); expect(find2).eql({col: 3, row: 0, term: 'ABC'}); From 204e42a1513fdbdeb0a664e2471161d770f8c2c1 Mon Sep 17 00:00:00 2001 From: Daniel Imms Date: Wed, 26 Dec 2018 15:15:12 -0800 Subject: [PATCH 3/7] Fix incremental search --- src/addons/search/SearchHelper.ts | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/addons/search/SearchHelper.ts b/src/addons/search/SearchHelper.ts index 408e1f29ce..d3040f7376 100644 --- a/src/addons/search/SearchHelper.ts +++ b/src/addons/search/SearchHelper.ts @@ -49,8 +49,7 @@ export class SearchHelper implements ISearchHelper { // For incremental search, use existing row if (this._terminal.getSelection().length !== 0) { startRow = incremental ? selectionManager.selectionStart[1] : selectionManager.selectionEnd[1]; - // TODO: Fix for incremental - startCol = this._terminal._core.selectionManager.selectionEnd[0]; + startCol = incremental ? selectionManager.selectionStart[0] : selectionManager.selectionEnd[0]; } } From 76302e2146bb2724137a86aa73d6b3b3c4f709c6 Mon Sep 17 00:00:00 2001 From: Daniel Imms Date: Wed, 26 Dec 2018 15:32:34 -0800 Subject: [PATCH 4/7] Get multiple matches working after incremental changes --- src/addons/search/SearchHelper.ts | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/addons/search/SearchHelper.ts b/src/addons/search/SearchHelper.ts index d3040f7376..0a66fdfff7 100644 --- a/src/addons/search/SearchHelper.ts +++ b/src/addons/search/SearchHelper.ts @@ -52,11 +52,12 @@ export class SearchHelper implements ISearchHelper { startCol = incremental ? selectionManager.selectionStart[0] : selectionManager.selectionEnd[0]; } } + console.log(`Start from ${startCol},${startRow}`); this._initLinesCache(); // Search from startRow to end - for (let y = incremental ? startRow : startRow + 1; y < this._terminal._core.buffer.ybase + this._terminal.rows; y++) { + for (let y = startRow; y < this._terminal._core.buffer.ybase + this._terminal.rows; y++) { result = this._findInLine(term, { row: y, col: startCol }, searchOptions); if (result) { break; @@ -111,7 +112,7 @@ export class SearchHelper implements ISearchHelper { this._initLinesCache(); // Search from startRow to top - for (let y = incremental ? startRow : startRow - 1; y >= 0; y--) { + for (let y = startRow; y >= 0; y--) { result = this._findInLine(term, {row: y, col: startCol}, searchOptions, isReverseSearch); if (result) { break; @@ -216,6 +217,7 @@ export class SearchHelper implements ISearchHelper { resultIndex = searchStringLine.lastIndexOf(searchTerm, searchIndex.col - searchTerm.length); } else { resultIndex = searchStringLine.indexOf(searchTerm, searchIndex.col); + console.log('resultIndex', resultIndex); } } From e0d535e0da1050aaa19860747c0cdedf6017cd38 Mon Sep 17 00:00:00 2001 From: Daniel Imms Date: Wed, 26 Dec 2018 15:49:08 -0800 Subject: [PATCH 5/7] Fix previous search, remove incremental previous search --- demo/client.ts | 6 ++-- src/addons/search/Interfaces.ts | 5 ++- src/addons/search/SearchHelper.ts | 57 ++++++++++++++++++------------- 3 files changed, 41 insertions(+), 27 deletions(-) diff --git a/demo/client.ts b/demo/client.ts index d99ff66d91..acc83cb86f 100644 --- a/demo/client.ts +++ b/demo/client.ts @@ -113,9 +113,9 @@ function createTerminal(): void { }); addDomListener(actionElements.findPrevious, 'keyup', (e) => { - const searchOptions = getSearchOptions(); - searchOptions.incremental = e.key !== `Enter`; - term.findPrevious(actionElements.findPrevious.value, searchOptions); + if (e.key === `Enter`) { + term.findPrevious(actionElements.findPrevious.value, getSearchOptions()); + } }); // fit is called within a setTimeout, cols and rows need this. diff --git a/src/addons/search/Interfaces.ts b/src/addons/search/Interfaces.ts index 76fe4bc9b0..2489844eea 100644 --- a/src/addons/search/Interfaces.ts +++ b/src/addons/search/Interfaces.ts @@ -25,7 +25,10 @@ export interface ISearchOptions { regex?: boolean; wholeWord?: boolean; caseSensitive?: boolean; - /** Assume caller implements 'search as you type' where findNext gets called when search input changes */ + /** + * Use this when you want the selection to expand if it still matches as the + * user types. Note that this only affects findNext. + */ incremental?: boolean; } diff --git a/src/addons/search/SearchHelper.ts b/src/addons/search/SearchHelper.ts index 0a66fdfff7..8972917bce 100644 --- a/src/addons/search/SearchHelper.ts +++ b/src/addons/search/SearchHelper.ts @@ -52,24 +52,27 @@ export class SearchHelper implements ISearchHelper { startCol = incremental ? selectionManager.selectionStart[0] : selectionManager.selectionEnd[0]; } } - console.log(`Start from ${startCol},${startRow}`); this._initLinesCache(); - // Search from startRow to end - for (let y = startRow; y < this._terminal._core.buffer.ybase + this._terminal.rows; y++) { - result = this._findInLine(term, { row: y, col: startCol }, searchOptions); - if (result) { - break; + // Search startRow + result = this._findInLine(term, { row: startRow, col: startCol }, searchOptions); + + // Search from startRow + 1 to end + if (!result) { + for (let y = startRow + 1; y < this._terminal._core.buffer.ybase + this._terminal.rows; y++) { + result = this._findInLine(term, { row: y, col: 0 }, searchOptions); + if (result) { + break; + } } - startCol = 0; } - // Search from the top to the startRow + // Search from the top to the startRow (search the whole startRow again in + // case startCol > 0) if (!result) { - for (let y = 0; y < startRow; y++) { - startCol = 0; - result = this._findInLine(term, {row: y, col: startCol}, searchOptions); + for (let y = 0; y <= startRow; y++) { + result = this._findInLine(term, {row: y, col: 0}, searchOptions); if (result) { break; } @@ -89,7 +92,6 @@ export class SearchHelper implements ISearchHelper { */ public findPrevious(term: string, searchOptions?: ISearchOptions): boolean { const selectionManager = this._terminal._core.selectionManager; - const {incremental} = searchOptions; let result: ISearchResult; if (!term || term.length === 0) { @@ -111,21 +113,31 @@ export class SearchHelper implements ISearchHelper { this._initLinesCache(); - // Search from startRow to top - for (let y = startRow; y >= 0; y--) { - result = this._findInLine(term, {row: y, col: startCol}, searchOptions, isReverseSearch); - if (result) { - break; + // Search startRow + result = this._findInLine(term, { row: startRow, col: startCol }, searchOptions, isReverseSearch); + + // Search from startRow - 1 to top + if (!result) { + for (let y = startRow - 1; y >= 0; y--) { + result = this._findInLine(term, { + row: y, + col: this._terminal._core.buffer.lines.get(y).length + }, searchOptions, isReverseSearch); + if (result) { + break; + } } - startCol = y > 0 ? this._terminal._core.buffer.lines.get(y - 1).length : 0; } - // Search from the bottom to startRow + // Search from the bottom to startRow (search the whole startRow again in + // case startCol > 0) if (!result) { const searchFrom = this._terminal._core.buffer.ybase + this._terminal.rows - 1; - for (let y = searchFrom; y > startRow; y--) { - startCol = this._terminal._core.buffer.lines.get(y).length; - result = this._findInLine(term, {row: y, col: startCol}, searchOptions, isReverseSearch); + for (let y = searchFrom; y >= startRow; y--) { + result = this._findInLine(term, { + row: y, + col: this._terminal._core.buffer.lines.get(y).length + }, searchOptions, isReverseSearch); if (result) { break; } @@ -217,7 +229,6 @@ export class SearchHelper implements ISearchHelper { resultIndex = searchStringLine.lastIndexOf(searchTerm, searchIndex.col - searchTerm.length); } else { resultIndex = searchStringLine.indexOf(searchTerm, searchIndex.col); - console.log('resultIndex', resultIndex); } } From 1a1f7e984fcda6ca4f565a717d8f5ed8fe0a993f Mon Sep 17 00:00:00 2001 From: Daniel Imms Date: Wed, 26 Dec 2018 16:03:31 -0800 Subject: [PATCH 6/7] Remove ISearchIndex object --- src/addons/search/Interfaces.ts | 7 ++--- src/addons/search/SearchHelper.ts | 49 ++++++++++++++----------------- src/addons/search/search.test.ts | 34 ++++++++++----------- 3 files changed, 41 insertions(+), 49 deletions(-) diff --git a/src/addons/search/Interfaces.ts b/src/addons/search/Interfaces.ts index 2489844eea..a1f05895e7 100644 --- a/src/addons/search/Interfaces.ts +++ b/src/addons/search/Interfaces.ts @@ -32,11 +32,8 @@ export interface ISearchOptions { incremental?: boolean; } -export interface ISearchIndex { +export interface ISearchResult { + term: string; col: number; row: number; } - -export interface ISearchResult extends ISearchIndex { - term: string; -} diff --git a/src/addons/search/SearchHelper.ts b/src/addons/search/SearchHelper.ts index 8972917bce..756f2da73f 100644 --- a/src/addons/search/SearchHelper.ts +++ b/src/addons/search/SearchHelper.ts @@ -3,7 +3,7 @@ * @license MIT */ -import { ISearchHelper, ISearchAddonTerminal, ISearchOptions, ISearchResult, ISearchIndex } from './Interfaces'; +import { ISearchHelper, ISearchAddonTerminal, ISearchOptions, ISearchResult } from './Interfaces'; const NON_WORD_CHARACTERS = ' ~!@#$%^&*()+`-=[]{}|\;:"\',./<>?'; const LINES_CACHE_TIME_TO_LIVE = 15 * 1000; // 15 secs @@ -56,12 +56,12 @@ export class SearchHelper implements ISearchHelper { this._initLinesCache(); // Search startRow - result = this._findInLine(term, { row: startRow, col: startCol }, searchOptions); + result = this._findInLine(term, startRow, startCol, searchOptions); // Search from startRow + 1 to end if (!result) { for (let y = startRow + 1; y < this._terminal._core.buffer.ybase + this._terminal.rows; y++) { - result = this._findInLine(term, { row: y, col: 0 }, searchOptions); + result = this._findInLine(term, y, 0, searchOptions); if (result) { break; } @@ -72,7 +72,7 @@ export class SearchHelper implements ISearchHelper { // case startCol > 0) if (!result) { for (let y = 0; y <= startRow; y++) { - result = this._findInLine(term, {row: y, col: 0}, searchOptions); + result = this._findInLine(term, y, 0, searchOptions); if (result) { break; } @@ -114,15 +114,12 @@ export class SearchHelper implements ISearchHelper { this._initLinesCache(); // Search startRow - result = this._findInLine(term, { row: startRow, col: startCol }, searchOptions, isReverseSearch); + result = this._findInLine(term, startRow, startCol, searchOptions, isReverseSearch); // Search from startRow - 1 to top if (!result) { for (let y = startRow - 1; y >= 0; y--) { - result = this._findInLine(term, { - row: y, - col: this._terminal._core.buffer.lines.get(y).length - }, searchOptions, isReverseSearch); + result = this._findInLine(term, y, this._terminal._core.buffer.lines.get(y).length, searchOptions, isReverseSearch); if (result) { break; } @@ -134,10 +131,7 @@ export class SearchHelper implements ISearchHelper { if (!result) { const searchFrom = this._terminal._core.buffer.ybase + this._terminal.rows - 1; for (let y = searchFrom; y >= startRow; y--) { - result = this._findInLine(term, { - row: y, - col: this._terminal._core.buffer.lines.get(y).length - }, searchOptions, isReverseSearch); + result = this._findInLine(term, y, this._terminal._core.buffer.lines.get(y).length, searchOptions, isReverseSearch); if (result) { break; } @@ -187,20 +181,21 @@ export class SearchHelper implements ISearchHelper { * started on an earlier line then it is skipped since it will be properly searched when the terminal line that the * text starts on is searched. * @param term The search term. - * @param y The line to search. + * @param row The line to start the search from. + * @param col The column to start the search from. * @param searchOptions Search options. * @return The search result if it was found. */ - protected _findInLine(term: string, searchIndex: ISearchIndex, searchOptions: ISearchOptions = {}, isReverseSearch: boolean = false): ISearchResult { - if (this._terminal._core.buffer.lines.get(searchIndex.row).isWrapped) { + protected _findInLine(term: string, row: number, col: number, searchOptions: ISearchOptions = {}, isReverseSearch: boolean = false): ISearchResult { + if (this._terminal._core.buffer.lines.get(row).isWrapped) { return; } - let stringLine = this._linesCache ? this._linesCache[searchIndex.row] : void 0; + let stringLine = this._linesCache ? this._linesCache[row] : void 0; if (stringLine === void 0) { - stringLine = this.translateBufferLineToStringWithWrap(searchIndex.row, true); + stringLine = this.translateBufferLineToStringWithWrap(row, true); if (this._linesCache) { - this._linesCache[searchIndex.row] = stringLine; + this._linesCache[row] = stringLine; } } @@ -212,37 +207,37 @@ export class SearchHelper implements ISearchHelper { const searchRegex = RegExp(searchTerm, 'g'); let foundTerm: RegExpExecArray; if (isReverseSearch) { - while (foundTerm = searchRegex.exec(searchStringLine.slice(0, searchIndex.col))) { + while (foundTerm = searchRegex.exec(searchStringLine.slice(0, col))) { resultIndex = searchRegex.lastIndex - foundTerm[0].length; term = foundTerm[0]; searchRegex.lastIndex -= (term.length - 1); } } else { - foundTerm = searchRegex.exec(searchStringLine.slice(searchIndex.col)); + foundTerm = searchRegex.exec(searchStringLine.slice(col)); if (foundTerm && foundTerm[0].length > 0) { - resultIndex = searchIndex.col + (searchRegex.lastIndex - foundTerm[0].length); + resultIndex = col + (searchRegex.lastIndex - foundTerm[0].length); term = foundTerm[0]; } } } else { if (isReverseSearch) { - resultIndex = searchStringLine.lastIndexOf(searchTerm, searchIndex.col - searchTerm.length); + resultIndex = searchStringLine.lastIndexOf(searchTerm, col - searchTerm.length); } else { - resultIndex = searchStringLine.indexOf(searchTerm, searchIndex.col); + resultIndex = searchStringLine.indexOf(searchTerm, col); } } if (resultIndex >= 0) { // Adjust the row number and search index if needed since a "line" of text can span multiple rows if (resultIndex >= this._terminal.cols) { - searchIndex.row += Math.floor(resultIndex / this._terminal.cols); + row += Math.floor(resultIndex / this._terminal.cols); resultIndex = resultIndex % this._terminal.cols; } if (searchOptions.wholeWord && !this._isWholeWord(resultIndex, searchStringLine, term)) { return; } - const line = this._terminal._core.buffer.lines.get(searchIndex.row); + const line = this._terminal._core.buffer.lines.get(row); for (let i = 0; i < resultIndex; i++) { const charData = line.get(i); @@ -261,7 +256,7 @@ export class SearchHelper implements ISearchHelper { return { term, col: resultIndex, - row: searchIndex.row + row }; } } diff --git a/src/addons/search/search.test.ts b/src/addons/search/search.test.ts index e9c11fb2be..6551fa8b52 100644 --- a/src/addons/search/search.test.ts +++ b/src/addons/search/search.test.ts @@ -7,7 +7,7 @@ declare var require: any; import { assert, expect } from 'chai'; import * as search from './search'; import { SearchHelper } from './SearchHelper'; -import { ISearchOptions, ISearchResult, ISearchIndex } from './Interfaces'; +import { ISearchOptions, ISearchResult } from './Interfaces'; class MockTerminalPlain {} @@ -30,10 +30,10 @@ class MockTerminal { class TestSearchHelper extends SearchHelper { public findInLine(term: string, rowNumber: number, searchOptions?: ISearchOptions): ISearchResult { - return this._findInLine(term, {row: rowNumber, col: 0}, searchOptions); + return this._findInLine(term, rowNumber, 0, searchOptions); } - public findFromIndex(term: string, searchIndex: ISearchIndex, searchOptions?: ISearchOptions, isReverseSearch?: boolean): ISearchResult { - return this._findInLine(term, searchIndex, searchOptions, isReverseSearch); + public findFromIndex(term: string, row: number, col: number, searchOptions?: ISearchOptions, isReverseSearch?: boolean): ISearchResult { + return this._findInLine(term, row, col, searchOptions, isReverseSearch); } } @@ -258,11 +258,11 @@ describe('search addon', () => { wholeWord: false, caseSensitive: false }; - const find0 = term.searchHelper.findFromIndex('hello', {row: 0, col: 0}, searchOptions); - const find1 = term.searchHelper.findFromIndex('hello', {row: 0, col: find0.col + find0.term.length}, searchOptions); - const find2 = term.searchHelper.findFromIndex('aaaa', {row: 1, col: 0}, searchOptions); - const find3 = term.searchHelper.findFromIndex('aaaa', {row: 1, col: find2.col + find2.term.length}, searchOptions); - const find4 = term.searchHelper.findFromIndex('aaaa', {row: 1, col: find3.col + find3.term.length}, searchOptions); + const find0 = term.searchHelper.findFromIndex('hello', 0, 0, searchOptions); + const find1 = term.searchHelper.findFromIndex('hello', 0, find0.col + find0.term.length, searchOptions); + const find2 = term.searchHelper.findFromIndex('aaaa', 1, 0, searchOptions); + const find3 = term.searchHelper.findFromIndex('aaaa', 1, find2.col + find2.term.length, searchOptions); + const find4 = term.searchHelper.findFromIndex('aaaa', 1, find3.col + find3.term.length, searchOptions); expect(find0).eql({col: 0, row: 0, term: 'hello'}); expect(find1).eql({col: 9, row: 0, term: 'hello'}); expect(find2).eql({col: 0, row: 1, term: 'aaaa'}); @@ -280,10 +280,10 @@ describe('search addon', () => { caseSensitive: false }; const isReverseSearch = true; - const find0 = term.searchHelper.findFromIndex('is', {row: 0, col: 16}, searchOptions, isReverseSearch); - const find1 = term.searchHelper.findFromIndex('is', {row: 0, col: find0.col}, searchOptions, isReverseSearch); - const find2 = term.searchHelper.findFromIndex('it', {row: 0, col: 16}, searchOptions, isReverseSearch); - const find3 = term.searchHelper.findFromIndex('it', {row: 0, col: find2.col}, searchOptions, isReverseSearch); + const find0 = term.searchHelper.findFromIndex('is', 0, 16, searchOptions, isReverseSearch); + const find1 = term.searchHelper.findFromIndex('is', 0, find0.col, searchOptions, isReverseSearch); + const find2 = term.searchHelper.findFromIndex('it', 0, 16, searchOptions, isReverseSearch); + const find3 = term.searchHelper.findFromIndex('it', 0, find2.col, searchOptions, isReverseSearch); expect(find0).eql({col: 14, row: 0, term: 'is'}); expect(find1).eql({col: 3, row: 0, term: 'is'}); expect(find2).eql({col: 11, row: 0, term: 'it'}); @@ -300,10 +300,10 @@ describe('search addon', () => { caseSensitive: true }; const isReverseSearch = true; - const find0 = term.searchHelper.findFromIndex('[A-Z]{3}', {row: 0, col: 16}, searchOptions, isReverseSearch); - const find1 = term.searchHelper.findFromIndex('[A-Z]{3}', {row: 0, col: find0.col}, searchOptions, isReverseSearch); - const find2 = term.searchHelper.findFromIndex('[A-Z]{3}', {row: 0, col: find1.col}, searchOptions, isReverseSearch); - const find3 = term.searchHelper.findFromIndex('[A-Z]{3}', {row: 0, col: find2.col}, searchOptions, isReverseSearch); + const find0 = term.searchHelper.findFromIndex('[A-Z]{3}', 0, 16, searchOptions, isReverseSearch); + const find1 = term.searchHelper.findFromIndex('[A-Z]{3}', 0, find0.col, searchOptions, isReverseSearch); + const find2 = term.searchHelper.findFromIndex('[A-Z]{3}', 0, find1.col, searchOptions, isReverseSearch); + const find3 = term.searchHelper.findFromIndex('[A-Z]{3}', 0, find2.col, searchOptions, isReverseSearch); expect(find0).eql({col: 13, row: 0, term: 'ABC'}); expect(find1).eql({col: 10, row: 0, term: 'ABC'}); expect(find2).eql({col: 3, row: 0, term: 'ABC'}); From d698faa18366df2592f5992ace5517d366382f79 Mon Sep 17 00:00:00 2001 From: Daniel Imms Date: Wed, 26 Dec 2018 16:12:53 -0800 Subject: [PATCH 7/7] Comment how the regex reverse search while works --- src/addons/search/SearchHelper.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/src/addons/search/SearchHelper.ts b/src/addons/search/SearchHelper.ts index 756f2da73f..42a3a1226e 100644 --- a/src/addons/search/SearchHelper.ts +++ b/src/addons/search/SearchHelper.ts @@ -207,6 +207,7 @@ export class SearchHelper implements ISearchHelper { const searchRegex = RegExp(searchTerm, 'g'); let foundTerm: RegExpExecArray; if (isReverseSearch) { + // This loop will get the resultIndex of the _last_ regex match in the range 0..col while (foundTerm = searchRegex.exec(searchStringLine.slice(0, col))) { resultIndex = searchRegex.lastIndex - foundTerm[0].length; term = foundTerm[0];