Date: Fri, 18 Mar 2022 19:07:39 -0400
Subject: [PATCH 132/245] pull apart and refactor findNext
---
addons/xterm-addon-search/src/SearchAddon.ts | 96 ++++++++++----------
demo/client.ts | 8 +-
demo/index.html | 2 +-
typings/xterm.d.ts | 12 +++
4 files changed, 63 insertions(+), 55 deletions(-)
diff --git a/addons/xterm-addon-search/src/SearchAddon.ts b/addons/xterm-addon-search/src/SearchAddon.ts
index 90749e92..f592b78e 100644
--- a/addons/xterm-addon-search/src/SearchAddon.ts
+++ b/addons/xterm-addon-search/src/SearchAddon.ts
@@ -10,10 +10,9 @@ export interface ISearchOptions {
wholeWord?: boolean;
caseSensitive?: boolean;
incremental?: boolean;
+ highlightAllMatches?: boolean;
startRow?: number;
startCol?: number;
- overviewRulerResultDecorationColor?: string;
- overviewRulerSelectionDecorationColor?: string;
}
export interface ISearchPosition {
@@ -72,6 +71,7 @@ export class SearchAddon implements ITerminalAddon {
}
public clear(): void {
+ this._selectedDecoration?.dispose();
this._terminal?.clearSelection();
this._searchResults.clear();
this._resultDecorations.forEach(decorations => decorations.forEach(d=> d.dispose()));
@@ -81,17 +81,23 @@ export class SearchAddon implements ITerminalAddon {
}
/**
- * Find all instances of the term, selecting the next one with each
- * enter. If it doesn't exist, do nothing.
+ * Find the next instance of the term, then scroll to and select it. If it
+ * doesn't exist, do nothing.
* @param term The search term.
* @param searchOptions Search options.
* @return Whether a result was found.
*/
- public find(term: string, searchOptions?: ISearchOptions): boolean {
+ public findNext(term: string, searchOptions?: ISearchOptions): boolean {
if (!this._terminal) {
throw new Error('Cannot use addon until it has been loaded');
}
+ return searchOptions?.highlightAllMatches ? this._highlightAllMatches(term, searchOptions) : this._findAndSelectNext(term, searchOptions);
+ }
+ private _highlightAllMatches(term: string, searchOptions: ISearchOptions): boolean {
+ if (!this._terminal) {
+ throw new Error('cannot find all matches with no terminal');
+ }
if (!term || term.length === 0) {
this.clear();
return false;
@@ -99,7 +105,7 @@ export class SearchAddon implements ITerminalAddon {
searchOptions = searchOptions || {};
if (term === this._cachedSearchTerm) {
if (!this._dataChanged) {
- return this.findNext(term, searchOptions);
+ return this._findAndSelectNext(term, searchOptions);
}
// set start row and col to avoid redoing work
const key = Array.from(this._searchResults.keys()).pop()?.split('-');
@@ -113,51 +119,45 @@ export class SearchAddon implements ITerminalAddon {
this._resultDecorations.clear();
this._searchResults.clear();
}
-
+ if (!this._terminal.options.overviewRulerWidth) {
+ this._terminal.options.overviewRulerWidth = 10;
+ }
+ if (!this._terminal.options.findResultDecorationColor) {
+ this._terminal.options.findResultDecorationColor = '#555753';
+ }
+ if (!this._terminal.options.findResultSelectedDecorationColor) {
+ this._terminal.options.findResultSelectedDecorationColor = '#ef2929';
+ }
searchOptions.incremental = false;
- let found = this.findNext(term, searchOptions);
+ let found = this._findAndSelectNext(term, searchOptions);
while (found && (!this._result || !this._searchResults.get(`${this._result.row}-${this._result.col}`))) {
if (this._result) {
this._searchResults.set(`${this._result.row}-${this._result.col}`, this._result);
}
- found = this.findNext(term, searchOptions);
+ found = this._findAndSelectNext(term, searchOptions);
}
- if (searchOptions.overviewRulerResultDecorationColor && searchOptions.overviewRulerSelectionDecorationColor) {
- this._searchResults.forEach(result => {
- const resultDecoration = this._createResultDecoration(result, searchOptions!.overviewRulerResultDecorationColor!);
- if (resultDecoration) {
- const decorationsForLine = this._resultDecorations.get(resultDecoration.marker.line) || [];
- decorationsForLine.push(resultDecoration);
- this._resultDecorations.set(resultDecoration.marker.line, decorationsForLine);
- }
- });
- }
-
+ this._searchResults.forEach(result => {
+ const resultDecoration = this._createResultDecoration(result);
+ if (resultDecoration) {
+ const decorationsForLine = this._resultDecorations.get(resultDecoration.marker.line) || [];
+ decorationsForLine.push(resultDecoration);
+ this._resultDecorations.set(resultDecoration.marker.line, decorationsForLine);
+ }
+ });
if (this._dataChanged) {
this._dataChanged = false;
}
if (this._searchResults.size > 0) {
this._cachedSearchTerm = term;
}
- return true;
+ return this._searchResults.size > 0;
}
-
- /**
- * Find the next instance of the term, then scroll to and select it. If it
- * doesn't exist, do nothing.
- * @param term The search term.
- * @param searchOptions Search options.
- * @return Whether a result was found.
- */
- public findNext(term: string, searchOptions?: ISearchOptions): boolean {
- if (!this._terminal) {
- throw new Error('Cannot use addon until it has been loaded');
- }
-
- if (!term || term.length === 0) {
+ private _findAndSelectNext(term: string, searchOptions?: ISearchOptions): boolean {
+ if (!this._terminal || !term || term.length === 0) {
this._result = undefined;
- this._terminal.clearSelection();
+ this._terminal?.clearSelection();
+ this.clear();
return false;
}
@@ -219,9 +219,8 @@ export class SearchAddon implements ITerminalAddon {
}
// Set selection and scroll if a result was found
- return this._selectResult(this._result, searchOptions?.overviewRulerSelectionDecorationColor);
+ return this._selectResult(this._result, searchOptions?.highlightAllMatches);
}
-
/**
* Find the previous instance of the term, then scroll to and select it. If it
* doesn't exist, do nothing.
@@ -300,7 +299,7 @@ export class SearchAddon implements ITerminalAddon {
if (!result && currentSelection) return true;
// Set selection and scroll if a result was found
- return this._selectResult(result, searchOptions?.overviewRulerSelectionDecorationColor);
+ return this._selectResult(result, searchOptions?.highlightAllMatches);
}
@@ -538,7 +537,7 @@ export class SearchAddon implements ITerminalAddon {
* @param result The result to select.
* @return Whether a result was selected.
*/
- private _selectResult(result: ISearchResult | undefined, color?: string): boolean {
+ private _selectResult(result: ISearchResult | undefined, highlightAllMatches?: boolean): boolean {
const terminal = this._terminal!;
this._selectedDecoration?.dispose();
if (!result) {
@@ -546,11 +545,11 @@ export class SearchAddon implements ITerminalAddon {
return false;
}
terminal.select(result.col, result.row, result.size);
- if (color) {
+ if (this._terminal?.options.findResultSelectedDecorationColor && highlightAllMatches) {
const marker = terminal.registerMarker(-terminal.buffer.active.baseY - terminal.buffer.active.cursorY + result.row);
if (marker) {
- this._selectedDecoration = terminal.registerDecoration({ marker, overviewRulerOptions: { color } });
- this._selectedDecoration?.onRender((e) => this._applyStyles(e, color, result));
+ this._selectedDecoration = terminal.registerDecoration({ marker, overviewRulerOptions: { color: this._terminal!.options.findResultSelectedDecorationColor } });
+ this._selectedDecoration?.onRender((e) => this._applyStyles(e, this._terminal!.options.findResultSelectedDecorationColor!, result));
}
}
@@ -589,14 +588,17 @@ export class SearchAddon implements ITerminalAddon {
* @param color the color to use for the decoration
* @returns the {@link IDecoration} or undefined if the marker has already been disposed of
*/
- private _createResultDecoration(result: ISearchResult, color: string): IDecoration | undefined {
+ private _createResultDecoration(result: ISearchResult): IDecoration | undefined {
const terminal = this._terminal!;
const marker = terminal.registerMarker(-terminal.buffer.active.baseY - terminal.buffer.active.cursorY + result.row);
- if (!marker) {
+ if (!marker || !this._terminal?.options.findResultDecorationColor) {
return undefined;
}
- const findResultDecoration = terminal.registerDecoration({ marker, overviewRulerOptions: this._resultDecorations.get(marker.line) && !this._dataChanged ? undefined : { color, position: 'center' } });
- findResultDecoration?.onRender((e) => this._applyStyles(e, color, result));
+ const findResultDecoration = terminal.registerDecoration(
+ { marker,
+ overviewRulerOptions: this._resultDecorations.get(marker.line) && !this._dataChanged ? undefined : { color: this._terminal.options.findResultDecorationColor, position: 'center' }
+ });
+ findResultDecoration?.onRender((e) => this._applyStyles(e, this._terminal!.options.findResultDecorationColor!, result));
return findResultDecoration;
}
}
diff --git a/demo/client.ts b/demo/client.ts
index 404435c4..98aa2e31 100644
--- a/demo/client.ts
+++ b/demo/client.ts
@@ -109,8 +109,7 @@ function getSearchOptions(e: KeyboardEvent): ISearchOptions {
wholeWord: (document.getElementById('whole-word') as HTMLInputElement).checked,
caseSensitive: (document.getElementById('case-sensitive') as HTMLInputElement).checked,
incremental: e.key !== `Enter`,
- overviewRulerResultDecorationColor: '#555753',
- overviewRulerSelectionDecorationColor: '#ef2929'
+ highlightAllMatches: (document.getElementById('highlight-all-matches') as HTMLInputElement).checked,
};
}
@@ -203,11 +202,6 @@ function createTerminal(): void {
addDomListener(paddingElement, 'change', setPadding);
- addDomListener(actionElements.find, 'keyup', (e) => {
- term.options.overviewRulerWidth = 10;
- addons.search.instance.find(actionElements.find.value, getSearchOptions(e));
- });
-
addDomListener(actionElements.findNext, 'keyup', (e) => {
addons.search.instance.findNext(actionElements.findNext.value, getSearchOptions(e));
});
diff --git a/demo/index.html b/demo/index.html
index 13748e9b..b89726de 100644
--- a/demo/index.html
+++ b/demo/index.html
@@ -38,12 +38,12 @@
Addons Control
SearchAddon
-
+
SerializeAddon
diff --git a/typings/xterm.d.ts b/typings/xterm.d.ts
index d1eb3890..3513feb7 100644
--- a/typings/xterm.d.ts
+++ b/typings/xterm.d.ts
@@ -272,6 +272,18 @@ declare module 'xterm' {
* ruler will be hidden when not set.
*/
overviewRulerWidth?: number;
+
+ /**
+ * The color for all find result decorations
+ * in the overview ruler
+ */
+ findResultDecorationColor?: string;
+
+ /**
+ * The color for the currently selected decoration
+ * when all matches are displayed
+ */
+ findResultSelectedDecorationColor?: string;
}
/**
From e79c21d4b2c490f0d9a70263a91f20efe6fe5007 Mon Sep 17 00:00:00 2001
From: meganrogge
Date: Fri, 18 Mar 2022 19:24:27 -0400
Subject: [PATCH 133/245] get it to work for previous too
---
addons/xterm-addon-search/src/SearchAddon.ts | 53 +++++++++++---------
1 file changed, 30 insertions(+), 23 deletions(-)
diff --git a/addons/xterm-addon-search/src/SearchAddon.ts b/addons/xterm-addon-search/src/SearchAddon.ts
index f592b78e..627c4a63 100644
--- a/addons/xterm-addon-search/src/SearchAddon.ts
+++ b/addons/xterm-addon-search/src/SearchAddon.ts
@@ -91,10 +91,10 @@ export class SearchAddon implements ITerminalAddon {
if (!this._terminal) {
throw new Error('Cannot use addon until it has been loaded');
}
- return searchOptions?.highlightAllMatches ? this._highlightAllMatches(term, searchOptions) : this._findAndSelectNext(term, searchOptions);
+ return searchOptions?.highlightAllMatches ? this._highlightAllMatches(term, searchOptions, 'next') : this._findAndSelectNext(term, searchOptions);
}
- private _highlightAllMatches(term: string, searchOptions: ISearchOptions): boolean {
+ private _highlightAllMatches(term: string, searchOptions: ISearchOptions, type: 'next' | 'previous'): boolean {
if (!this._terminal) {
throw new Error('cannot find all matches with no terminal');
}
@@ -129,12 +129,12 @@ export class SearchAddon implements ITerminalAddon {
this._terminal.options.findResultSelectedDecorationColor = '#ef2929';
}
searchOptions.incremental = false;
- let found = this._findAndSelectNext(term, searchOptions);
+ let found = type === 'next' ? this._findAndSelectNext(term, searchOptions) : this._findAndSelectPrevious(term, searchOptions);
while (found && (!this._result || !this._searchResults.get(`${this._result.row}-${this._result.col}`))) {
if (this._result) {
this._searchResults.set(`${this._result.row}-${this._result.col}`, this._result);
}
- found = this._findAndSelectNext(term, searchOptions);
+ found = type === 'next' ? this._findAndSelectNext(term, searchOptions) : this._findAndSelectPrevious(term, searchOptions);
}
this._searchResults.forEach(result => {
const resultDecoration = this._createResultDecoration(result);
@@ -232,16 +232,24 @@ export class SearchAddon implements ITerminalAddon {
if (!this._terminal) {
throw new Error('Cannot use addon until it has been loaded');
}
+ return searchOptions?.highlightAllMatches ? this._highlightAllMatches(term, searchOptions, 'previous') : this._findAndSelectPrevious(term, searchOptions);
+ }
- if (!term || term.length === 0) {
- this._terminal.clearSelection();
+ private _findAndSelectPrevious(term: string, searchOptions?: ISearchOptions): boolean {
+ if (!this._terminal) {
+ throw new Error('Cannot use addon until it has been loaded');
+ }
+
+ if (!this._terminal || !term || term.length === 0) {
+ this._result = undefined;
+ this._terminal?.clearSelection();
+ this.clear();
return false;
}
const isReverseSearch = true;
- let startRow = this._terminal.buffer.active.baseY + this._terminal.rows;
- let startCol = this._terminal.cols;
- let result: ISearchResult | undefined;
+ let startRow = searchOptions?.startRow || this._terminal.buffer.active.baseY + this._terminal.rows;
+ let startCol = searchOptions?.startCol || this._terminal.cols;
const incremental = searchOptions ? searchOptions.incremental : false;
let currentSelection: ISelectionPosition | undefined;
if (this._terminal.hasSelection()) {
@@ -259,50 +267,49 @@ export class SearchAddon implements ITerminalAddon {
if (incremental) {
// Try to expand selection to right first.
- result = this._findInLine(term, searchPosition, searchOptions, false);
- const isOldResultHighlighted = result && result.row === startRow && result.col === startCol;
+ this._result = this._findInLine(term, searchPosition, searchOptions, false);
+ const isOldResultHighlighted = this._result && this._result.row === startRow && this._result.col === startCol;
if (!isOldResultHighlighted) {
// If selection was not able to be expanded to the right, then try reverse search
if (currentSelection) {
searchPosition.startRow = currentSelection.endRow;
searchPosition.startCol = currentSelection.endColumn;
}
- result = this._findInLine(term, searchPosition, searchOptions, true);
+ this._result = this._findInLine(term, searchPosition, searchOptions, true);
}
} else {
- result = this._findInLine(term, searchPosition, searchOptions, isReverseSearch);
+ this._result = this._findInLine(term, searchPosition, searchOptions, isReverseSearch);
}
// Search from startRow - 1 to top
- if (!result) {
+ if (!this._result) {
searchPosition.startCol = Math.max(searchPosition.startCol, this._terminal.cols);
for (let y = startRow - 1; y >= 0; y--) {
searchPosition.startRow = y;
- result = this._findInLine(term, searchPosition, searchOptions, isReverseSearch);
- if (result) {
+ this._result = this._findInLine(term, searchPosition, searchOptions, isReverseSearch);
+ if (this._result) {
break;
}
}
}
// If we hit the top and didn't search from the very bottom wrap back down
- if (!result && startRow !== (this._terminal.buffer.active.baseY + this._terminal.rows)) {
+ if (!this._result && startRow !== (this._terminal.buffer.active.baseY + this._terminal.rows)) {
for (let y = (this._terminal.buffer.active.baseY + this._terminal.rows); y >= startRow; y--) {
searchPosition.startRow = y;
- result = this._findInLine(term, searchPosition, searchOptions, isReverseSearch);
- if (result) {
+ this._result = this._findInLine(term, searchPosition, searchOptions, isReverseSearch);
+ if (this._result) {
break;
}
}
}
// If there is only one result, return true.
- if (!result && currentSelection) return true;
+ if (!this._result && currentSelection) return true;
- // Set selection and scroll if a result was found
- return this._selectResult(result, searchOptions?.highlightAllMatches);
+ // Set selection and scroll if a this._result was found
+ return this._selectResult(this._result, searchOptions?.highlightAllMatches);
}
-
/**
* Sets up a line cache with a ttl
*/
From a0aae62cb7f1344bed280bbe15602cc9f6fe7ec4 Mon Sep 17 00:00:00 2001
From: meganrogge
Date: Fri, 18 Mar 2022 19:43:00 -0400
Subject: [PATCH 134/245] get rid of start col end col
---
addons/xterm-addon-search/src/SearchAddon.ts | 39 ++++++++++++++------
1 file changed, 27 insertions(+), 12 deletions(-)
diff --git a/addons/xterm-addon-search/src/SearchAddon.ts b/addons/xterm-addon-search/src/SearchAddon.ts
index 627c4a63..422f060b 100644
--- a/addons/xterm-addon-search/src/SearchAddon.ts
+++ b/addons/xterm-addon-search/src/SearchAddon.ts
@@ -11,8 +11,6 @@ export interface ISearchOptions {
caseSensitive?: boolean;
incremental?: boolean;
highlightAllMatches?: boolean;
- startRow?: number;
- startCol?: number;
}
export interface ISearchPosition {
@@ -50,6 +48,7 @@ export class SearchAddon implements ITerminalAddon {
private _resultDecorations: Map = new Map();
private _searchResults: Map = new Map();
private _onDataDisposable: IDisposable | undefined;
+ private _addToPrior: boolean = false;
/**
* translateBufferLineToStringWithWrap is a fairly expensive call.
* We memoize the calls into an array that has a time based ttl.
@@ -107,12 +106,7 @@ export class SearchAddon implements ITerminalAddon {
if (!this._dataChanged) {
return this._findAndSelectNext(term, searchOptions);
}
- // set start row and col to avoid redoing work
- const key = Array.from(this._searchResults.keys()).pop()?.split('-');
- if (key?.length === 2) {
- searchOptions.startRow = Number.parseInt(key[0]);
- searchOptions.startCol = Number.parseInt(key[1]) + 1;
- }
+ this._addToPrior = true;
} else {
// new search, clear out the old decorations
this._resultDecorations.forEach(decorations => decorations.forEach(d=> d.dispose()));
@@ -147,6 +141,9 @@ export class SearchAddon implements ITerminalAddon {
if (this._dataChanged) {
this._dataChanged = false;
}
+ if (this._addToPrior) {
+ this._addToPrior = false;
+ }
if (this._searchResults.size > 0) {
this._cachedSearchTerm = term;
}
@@ -161,8 +158,16 @@ export class SearchAddon implements ITerminalAddon {
return false;
}
- let startCol = searchOptions?.startCol || 0;
- let startRow = searchOptions?.startRow || 0;
+ let startCol = 0;
+ let startRow = 0;
+ if (searchOptions?.highlightAllMatches && this._addToPrior) {
+ // set start row and col to avoid redoing work
+ const key = Array.from(this._searchResults.keys()).pop()?.split('-');
+ if (key?.length === 2) {
+ startRow = Number.parseInt(key[0]);
+ startCol = Number.parseInt(key[1]) + 1;
+ }
+ }
let currentSelection: ISelectionPosition | undefined;
if (this._terminal.hasSelection()) {
const incremental = searchOptions ? searchOptions.incremental : false;
@@ -247,9 +252,19 @@ export class SearchAddon implements ITerminalAddon {
return false;
}
+ let startRow = this._terminal.buffer.active.baseY + this._terminal.rows;
+ let startCol = this._terminal.cols;
const isReverseSearch = true;
- let startRow = searchOptions?.startRow || this._terminal.buffer.active.baseY + this._terminal.rows;
- let startCol = searchOptions?.startCol || this._terminal.cols;
+ // if (searchOptions?.highlightAllMatches && this._addToPrior) {
+ // // set start row and col to avoid redoing work
+ // // TODO: fix this will mess with the order that they're iterated through
+ // const key = Array.from(this._searchResults.keys()).pop()?.split('-');
+ // if (key?.length === 2) {
+ // startRow = Number.parseInt(key[0]);
+ // startCol = Number.parseInt(key[1]) + 1;
+ // }
+ // }
+
const incremental = searchOptions ? searchOptions.incremental : false;
let currentSelection: ISelectionPosition | undefined;
if (this._terminal.hasSelection()) {
From 8225ecd3bad9b66df1e7341822c1a34c54bf8e96 Mon Sep 17 00:00:00 2001
From: meganrogge
Date: Mon, 21 Mar 2022 10:24:46 -0400
Subject: [PATCH 135/245] refactor from highlightAllMatches -> decorations
---
addons/xterm-addon-search/src/SearchAddon.ts | 41 ++++++++++----------
demo/client.ts | 2 +-
typings/xterm.d.ts | 12 ------
3 files changed, 21 insertions(+), 34 deletions(-)
diff --git a/addons/xterm-addon-search/src/SearchAddon.ts b/addons/xterm-addon-search/src/SearchAddon.ts
index 422f060b..f7cf5175 100644
--- a/addons/xterm-addon-search/src/SearchAddon.ts
+++ b/addons/xterm-addon-search/src/SearchAddon.ts
@@ -10,7 +10,12 @@ export interface ISearchOptions {
wholeWord?: boolean;
caseSensitive?: boolean;
incremental?: boolean;
- highlightAllMatches?: boolean;
+ decorations?: IDecorationColor;
+}
+
+interface IDecorationColor {
+ matchColor: string;
+ selectedColor: string;
}
export interface ISearchPosition {
@@ -90,7 +95,7 @@ export class SearchAddon implements ITerminalAddon {
if (!this._terminal) {
throw new Error('Cannot use addon until it has been loaded');
}
- return searchOptions?.highlightAllMatches ? this._highlightAllMatches(term, searchOptions, 'next') : this._findAndSelectNext(term, searchOptions);
+ return searchOptions?.decorations ? this._highlightAllMatches(term, searchOptions, 'next') : this._findAndSelectNext(term, searchOptions);
}
private _highlightAllMatches(term: string, searchOptions: ISearchOptions, type: 'next' | 'previous'): boolean {
@@ -116,12 +121,6 @@ export class SearchAddon implements ITerminalAddon {
if (!this._terminal.options.overviewRulerWidth) {
this._terminal.options.overviewRulerWidth = 10;
}
- if (!this._terminal.options.findResultDecorationColor) {
- this._terminal.options.findResultDecorationColor = '#555753';
- }
- if (!this._terminal.options.findResultSelectedDecorationColor) {
- this._terminal.options.findResultSelectedDecorationColor = '#ef2929';
- }
searchOptions.incremental = false;
let found = type === 'next' ? this._findAndSelectNext(term, searchOptions) : this._findAndSelectPrevious(term, searchOptions);
while (found && (!this._result || !this._searchResults.get(`${this._result.row}-${this._result.col}`))) {
@@ -131,7 +130,7 @@ export class SearchAddon implements ITerminalAddon {
found = type === 'next' ? this._findAndSelectNext(term, searchOptions) : this._findAndSelectPrevious(term, searchOptions);
}
this._searchResults.forEach(result => {
- const resultDecoration = this._createResultDecoration(result);
+ const resultDecoration = this._createResultDecoration(result, searchOptions.decorations);
if (resultDecoration) {
const decorationsForLine = this._resultDecorations.get(resultDecoration.marker.line) || [];
decorationsForLine.push(resultDecoration);
@@ -160,7 +159,7 @@ export class SearchAddon implements ITerminalAddon {
let startCol = 0;
let startRow = 0;
- if (searchOptions?.highlightAllMatches && this._addToPrior) {
+ if (searchOptions?.decorations && this._addToPrior) {
// set start row and col to avoid redoing work
const key = Array.from(this._searchResults.keys()).pop()?.split('-');
if (key?.length === 2) {
@@ -224,7 +223,7 @@ export class SearchAddon implements ITerminalAddon {
}
// Set selection and scroll if a result was found
- return this._selectResult(this._result, searchOptions?.highlightAllMatches);
+ return this._selectResult(this._result, searchOptions?.decorations);
}
/**
* Find the previous instance of the term, then scroll to and select it. If it
@@ -237,7 +236,7 @@ export class SearchAddon implements ITerminalAddon {
if (!this._terminal) {
throw new Error('Cannot use addon until it has been loaded');
}
- return searchOptions?.highlightAllMatches ? this._highlightAllMatches(term, searchOptions, 'previous') : this._findAndSelectPrevious(term, searchOptions);
+ return searchOptions?.decorations ? this._highlightAllMatches(term, searchOptions, 'previous') : this._findAndSelectPrevious(term, searchOptions);
}
private _findAndSelectPrevious(term: string, searchOptions?: ISearchOptions): boolean {
@@ -322,7 +321,7 @@ export class SearchAddon implements ITerminalAddon {
if (!this._result && currentSelection) return true;
// Set selection and scroll if a this._result was found
- return this._selectResult(this._result, searchOptions?.highlightAllMatches);
+ return this._selectResult(this._result, searchOptions?.decorations);
}
/**
@@ -559,7 +558,7 @@ export class SearchAddon implements ITerminalAddon {
* @param result The result to select.
* @return Whether a result was selected.
*/
- private _selectResult(result: ISearchResult | undefined, highlightAllMatches?: boolean): boolean {
+ private _selectResult(result: ISearchResult | undefined, decorations?: IDecorationColor): boolean {
const terminal = this._terminal!;
this._selectedDecoration?.dispose();
if (!result) {
@@ -567,11 +566,11 @@ export class SearchAddon implements ITerminalAddon {
return false;
}
terminal.select(result.col, result.row, result.size);
- if (this._terminal?.options.findResultSelectedDecorationColor && highlightAllMatches) {
+ if (decorations?.selectedColor) {
const marker = terminal.registerMarker(-terminal.buffer.active.baseY - terminal.buffer.active.cursorY + result.row);
if (marker) {
- this._selectedDecoration = terminal.registerDecoration({ marker, overviewRulerOptions: { color: this._terminal!.options.findResultSelectedDecorationColor } });
- this._selectedDecoration?.onRender((e) => this._applyStyles(e, this._terminal!.options.findResultSelectedDecorationColor!, result));
+ this._selectedDecoration = terminal.registerDecoration({ marker, overviewRulerOptions: { color: decorations.selectedColor } });
+ this._selectedDecoration?.onRender((e) => this._applyStyles(e, decorations.selectedColor, result));
}
}
@@ -610,17 +609,17 @@ export class SearchAddon implements ITerminalAddon {
* @param color the color to use for the decoration
* @returns the {@link IDecoration} or undefined if the marker has already been disposed of
*/
- private _createResultDecoration(result: ISearchResult): IDecoration | undefined {
+ private _createResultDecoration(result: ISearchResult, decorations?: IDecorationColor): IDecoration | undefined {
const terminal = this._terminal!;
const marker = terminal.registerMarker(-terminal.buffer.active.baseY - terminal.buffer.active.cursorY + result.row);
- if (!marker || !this._terminal?.options.findResultDecorationColor) {
+ if (!marker || !decorations?.matchColor) {
return undefined;
}
const findResultDecoration = terminal.registerDecoration(
{ marker,
- overviewRulerOptions: this._resultDecorations.get(marker.line) && !this._dataChanged ? undefined : { color: this._terminal.options.findResultDecorationColor, position: 'center' }
+ overviewRulerOptions: this._resultDecorations.get(marker.line) && !this._dataChanged ? undefined : { color: decorations.matchColor, position: 'center' }
});
- findResultDecoration?.onRender((e) => this._applyStyles(e, this._terminal!.options.findResultDecorationColor!, result));
+ findResultDecoration?.onRender((e) => this._applyStyles(e, decorations.matchColor, result));
return findResultDecoration;
}
}
diff --git a/demo/client.ts b/demo/client.ts
index 98aa2e31..faf3e0be 100644
--- a/demo/client.ts
+++ b/demo/client.ts
@@ -109,7 +109,7 @@ function getSearchOptions(e: KeyboardEvent): ISearchOptions {
wholeWord: (document.getElementById('whole-word') as HTMLInputElement).checked,
caseSensitive: (document.getElementById('case-sensitive') as HTMLInputElement).checked,
incremental: e.key !== `Enter`,
- highlightAllMatches: (document.getElementById('highlight-all-matches') as HTMLInputElement).checked,
+ decorations: (document.getElementById('highlight-all-matches') as HTMLInputElement).checked ? { matchColor: '#555753', selectedColor: '#ef2929' } : undefined
};
}
diff --git a/typings/xterm.d.ts b/typings/xterm.d.ts
index 3513feb7..d1eb3890 100644
--- a/typings/xterm.d.ts
+++ b/typings/xterm.d.ts
@@ -272,18 +272,6 @@ declare module 'xterm' {
* ruler will be hidden when not set.
*/
overviewRulerWidth?: number;
-
- /**
- * The color for all find result decorations
- * in the overview ruler
- */
- findResultDecorationColor?: string;
-
- /**
- * The color for the currently selected decoration
- * when all matches are displayed
- */
- findResultSelectedDecorationColor?: string;
}
/**
From 12a999dfe051422006bcd6a69b85dc004d79b8fb Mon Sep 17 00:00:00 2001
From: meganrogge
Date: Mon, 21 Mar 2022 10:54:01 -0400
Subject: [PATCH 136/245] get rid of start row/col code
---
addons/xterm-addon-search/src/SearchAddon.ts | 42 ++++----------------
1 file changed, 8 insertions(+), 34 deletions(-)
diff --git a/addons/xterm-addon-search/src/SearchAddon.ts b/addons/xterm-addon-search/src/SearchAddon.ts
index f7cf5175..7ec081f5 100644
--- a/addons/xterm-addon-search/src/SearchAddon.ts
+++ b/addons/xterm-addon-search/src/SearchAddon.ts
@@ -53,7 +53,6 @@ export class SearchAddon implements ITerminalAddon {
private _resultDecorations: Map = new Map();
private _searchResults: Map = new Map();
private _onDataDisposable: IDisposable | undefined;
- private _addToPrior: boolean = false;
/**
* translateBufferLineToStringWithWrap is a fairly expensive call.
* We memoize the calls into an array that has a time based ttl.
@@ -107,17 +106,14 @@ export class SearchAddon implements ITerminalAddon {
return false;
}
searchOptions = searchOptions || {};
- if (term === this._cachedSearchTerm) {
- if (!this._dataChanged) {
- return this._findAndSelectNext(term, searchOptions);
- }
- this._addToPrior = true;
- } else {
- // new search, clear out the old decorations
- this._resultDecorations.forEach(decorations => decorations.forEach(d=> d.dispose()));
- this._resultDecorations.clear();
- this._searchResults.clear();
+ if (term === this._cachedSearchTerm && !this._dataChanged) {
+ return type === 'next' ? this._findAndSelectNext(term, searchOptions) : this._findAndSelectPrevious(term, searchOptions);
}
+ // new search, clear out the old decorations
+ this._resultDecorations.forEach(decorations => decorations.forEach(d=> d.dispose()));
+ this._resultDecorations.clear();
+ this._searchResults.clear();
+
if (!this._terminal.options.overviewRulerWidth) {
this._terminal.options.overviewRulerWidth = 10;
}
@@ -137,12 +133,7 @@ export class SearchAddon implements ITerminalAddon {
this._resultDecorations.set(resultDecoration.marker.line, decorationsForLine);
}
});
- if (this._dataChanged) {
- this._dataChanged = false;
- }
- if (this._addToPrior) {
- this._addToPrior = false;
- }
+ this._dataChanged = false;
if (this._searchResults.size > 0) {
this._cachedSearchTerm = term;
}
@@ -159,14 +150,6 @@ export class SearchAddon implements ITerminalAddon {
let startCol = 0;
let startRow = 0;
- if (searchOptions?.decorations && this._addToPrior) {
- // set start row and col to avoid redoing work
- const key = Array.from(this._searchResults.keys()).pop()?.split('-');
- if (key?.length === 2) {
- startRow = Number.parseInt(key[0]);
- startCol = Number.parseInt(key[1]) + 1;
- }
- }
let currentSelection: ISelectionPosition | undefined;
if (this._terminal.hasSelection()) {
const incremental = searchOptions ? searchOptions.incremental : false;
@@ -254,15 +237,6 @@ export class SearchAddon implements ITerminalAddon {
let startRow = this._terminal.buffer.active.baseY + this._terminal.rows;
let startCol = this._terminal.cols;
const isReverseSearch = true;
- // if (searchOptions?.highlightAllMatches && this._addToPrior) {
- // // set start row and col to avoid redoing work
- // // TODO: fix this will mess with the order that they're iterated through
- // const key = Array.from(this._searchResults.keys()).pop()?.split('-');
- // if (key?.length === 2) {
- // startRow = Number.parseInt(key[0]);
- // startCol = Number.parseInt(key[1]) + 1;
- // }
- // }
const incremental = searchOptions ? searchOptions.incremental : false;
let currentSelection: ISelectionPosition | undefined;
From bec4cb37d4031dadbbeff495d0d41436d2d03e06 Mon Sep 17 00:00:00 2001
From: meganrogge
Date: Mon, 21 Mar 2022 10:58:44 -0400
Subject: [PATCH 137/245] set data changed to false if true
---
addons/xterm-addon-search/src/SearchAddon.ts | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/addons/xterm-addon-search/src/SearchAddon.ts b/addons/xterm-addon-search/src/SearchAddon.ts
index 7ec081f5..33e38e95 100644
--- a/addons/xterm-addon-search/src/SearchAddon.ts
+++ b/addons/xterm-addon-search/src/SearchAddon.ts
@@ -133,7 +133,9 @@ export class SearchAddon implements ITerminalAddon {
this._resultDecorations.set(resultDecoration.marker.line, decorationsForLine);
}
});
- this._dataChanged = false;
+ if (this._dataChanged) {
+ this._dataChanged = false;
+ }
if (this._searchResults.size > 0) {
this._cachedSearchTerm = term;
}
From 8ff34a6aee1e2f083056af15dc4c06822d3c7003 Mon Sep 17 00:00:00 2001
From: meganrogge
Date: Mon, 21 Mar 2022 11:17:24 -0400
Subject: [PATCH 138/245] update decorations dynamically when the buffer
changes
---
addons/xterm-addon-search/src/SearchAddon.ts | 19 ++++++++++++++-----
1 file changed, 14 insertions(+), 5 deletions(-)
diff --git a/addons/xterm-addon-search/src/SearchAddon.ts b/addons/xterm-addon-search/src/SearchAddon.ts
index 33e38e95..457e0853 100644
--- a/addons/xterm-addon-search/src/SearchAddon.ts
+++ b/addons/xterm-addon-search/src/SearchAddon.ts
@@ -53,6 +53,7 @@ export class SearchAddon implements ITerminalAddon {
private _resultDecorations: Map = new Map();
private _searchResults: Map = new Map();
private _onDataDisposable: IDisposable | undefined;
+ private _lastSearchOptions: ISearchOptions | undefined;
/**
* translateBufferLineToStringWithWrap is a fairly expensive call.
* We memoize the calls into an array that has a time based ttl.
@@ -65,7 +66,13 @@ export class SearchAddon implements ITerminalAddon {
public activate(terminal: Terminal): void {
this._terminal = terminal;
- this._onDataDisposable = this._terminal.onData(() => this._dataChanged = true);
+ this._onDataDisposable = this._terminal.onData(() => {
+ //TODO: debounce
+ this._dataChanged = true;
+ if (this._cachedSearchTerm && this._resultDecorations.size > 0 && this._lastSearchOptions) {
+ this._highlightAllMatches(this._cachedSearchTerm, this._lastSearchOptions,'previous');
+ }
+ });
}
public dispose(): void {
@@ -94,10 +101,11 @@ export class SearchAddon implements ITerminalAddon {
if (!this._terminal) {
throw new Error('Cannot use addon until it has been loaded');
}
+ this._lastSearchOptions = searchOptions;
return searchOptions?.decorations ? this._highlightAllMatches(term, searchOptions, 'next') : this._findAndSelectNext(term, searchOptions);
}
- private _highlightAllMatches(term: string, searchOptions: ISearchOptions, type: 'next' | 'previous'): boolean {
+ private _highlightAllMatches(term: string, searchOptions: ISearchOptions, selectionType: 'next' | 'previous'): boolean {
if (!this._terminal) {
throw new Error('cannot find all matches with no terminal');
}
@@ -107,7 +115,7 @@ export class SearchAddon implements ITerminalAddon {
}
searchOptions = searchOptions || {};
if (term === this._cachedSearchTerm && !this._dataChanged) {
- return type === 'next' ? this._findAndSelectNext(term, searchOptions) : this._findAndSelectPrevious(term, searchOptions);
+ return selectionType === 'next' ? this._findAndSelectNext(term, searchOptions) : this._findAndSelectPrevious(term, searchOptions);
}
// new search, clear out the old decorations
this._resultDecorations.forEach(decorations => decorations.forEach(d=> d.dispose()));
@@ -118,12 +126,12 @@ export class SearchAddon implements ITerminalAddon {
this._terminal.options.overviewRulerWidth = 10;
}
searchOptions.incremental = false;
- let found = type === 'next' ? this._findAndSelectNext(term, searchOptions) : this._findAndSelectPrevious(term, searchOptions);
+ let found = selectionType === 'next' ? this._findAndSelectNext(term, searchOptions) : this._findAndSelectPrevious(term, searchOptions);
while (found && (!this._result || !this._searchResults.get(`${this._result.row}-${this._result.col}`))) {
if (this._result) {
this._searchResults.set(`${this._result.row}-${this._result.col}`, this._result);
}
- found = type === 'next' ? this._findAndSelectNext(term, searchOptions) : this._findAndSelectPrevious(term, searchOptions);
+ found = selectionType === 'next' ? this._findAndSelectNext(term, searchOptions) : this._findAndSelectPrevious(term, searchOptions);
}
this._searchResults.forEach(result => {
const resultDecoration = this._createResultDecoration(result, searchOptions.decorations);
@@ -221,6 +229,7 @@ export class SearchAddon implements ITerminalAddon {
if (!this._terminal) {
throw new Error('Cannot use addon until it has been loaded');
}
+ this._lastSearchOptions = searchOptions;
return searchOptions?.decorations ? this._highlightAllMatches(term, searchOptions, 'previous') : this._findAndSelectPrevious(term, searchOptions);
}
From 1098173908af0894e2637467ea9b233debe3c6c5 Mon Sep 17 00:00:00 2001
From: meganrogge
Date: Mon, 21 Mar 2022 11:45:45 -0400
Subject: [PATCH 139/245] use set timeout
---
addons/xterm-addon-search/src/SearchAddon.ts | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/addons/xterm-addon-search/src/SearchAddon.ts b/addons/xterm-addon-search/src/SearchAddon.ts
index 457e0853..4bca88cc 100644
--- a/addons/xterm-addon-search/src/SearchAddon.ts
+++ b/addons/xterm-addon-search/src/SearchAddon.ts
@@ -67,11 +67,12 @@ export class SearchAddon implements ITerminalAddon {
public activate(terminal: Terminal): void {
this._terminal = terminal;
this._onDataDisposable = this._terminal.onData(() => {
- //TODO: debounce
this._dataChanged = true;
- if (this._cachedSearchTerm && this._resultDecorations.size > 0 && this._lastSearchOptions) {
- this._highlightAllMatches(this._cachedSearchTerm, this._lastSearchOptions,'previous');
- }
+ setTimeout(() => {
+ if (this._cachedSearchTerm && this._resultDecorations.size > 0 && this._lastSearchOptions) {
+ this._highlightAllMatches(this._cachedSearchTerm, this._lastSearchOptions,'previous');
+ }
+ }, 200);
});
}
From 97e4af3707e2343d0d8770d3dbed2a03929bbc02 Mon Sep 17 00:00:00 2001
From: meganrogge
Date: Mon, 21 Mar 2022 13:07:25 -0400
Subject: [PATCH 140/245] only highlight all matches when decorations are
requested
---
addons/xterm-addon-search/src/SearchAddon.ts | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/addons/xterm-addon-search/src/SearchAddon.ts b/addons/xterm-addon-search/src/SearchAddon.ts
index 4bca88cc..6e4b5f9b 100644
--- a/addons/xterm-addon-search/src/SearchAddon.ts
+++ b/addons/xterm-addon-search/src/SearchAddon.ts
@@ -69,7 +69,7 @@ export class SearchAddon implements ITerminalAddon {
this._onDataDisposable = this._terminal.onData(() => {
this._dataChanged = true;
setTimeout(() => {
- if (this._cachedSearchTerm && this._resultDecorations.size > 0 && this._lastSearchOptions) {
+ if (this._lastSearchOptions?.decorations && this._cachedSearchTerm && this._resultDecorations.size > 0 && this._lastSearchOptions) {
this._highlightAllMatches(this._cachedSearchTerm, this._lastSearchOptions,'previous');
}
}, 200);
From 4cea6b3f4136f5626a00229b68ade83076776971 Mon Sep 17 00:00:00 2001
From: meganrogge
Date: Mon, 21 Mar 2022 13:35:56 -0400
Subject: [PATCH 141/245] revert a breaking change
---
addons/xterm-addon-search/src/SearchAddon.ts | 3 ---
1 file changed, 3 deletions(-)
diff --git a/addons/xterm-addon-search/src/SearchAddon.ts b/addons/xterm-addon-search/src/SearchAddon.ts
index 6e4b5f9b..6b84421d 100644
--- a/addons/xterm-addon-search/src/SearchAddon.ts
+++ b/addons/xterm-addon-search/src/SearchAddon.ts
@@ -169,9 +169,6 @@ export class SearchAddon implements ITerminalAddon {
currentSelection = this._terminal.getSelectionPosition()!;
startRow = incremental ? currentSelection.startRow : currentSelection.endRow;
startCol = incremental ? currentSelection.startColumn : currentSelection.endColumn;
- } else if (!startRow) {
- startRow = this._terminal.buffer.active.cursorY;
- startCol = this._terminal.buffer.active.cursorX;
}
this._initLinesCache();
From 64d5af38f5fbea10958c205ebb7556d19f107da0 Mon Sep 17 00:00:00 2001
From: Megan Rogge
Date: Mon, 21 Mar 2022 15:35:01 -0400
Subject: [PATCH 142/245] Update addons/xterm-addon-search/src/SearchAddon.ts
Co-authored-by: Daniel Imms <2193314+Tyriar@users.noreply.github.com>
---
addons/xterm-addon-search/src/SearchAddon.ts | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/addons/xterm-addon-search/src/SearchAddon.ts b/addons/xterm-addon-search/src/SearchAddon.ts
index 6b84421d..c2089f11 100644
--- a/addons/xterm-addon-search/src/SearchAddon.ts
+++ b/addons/xterm-addon-search/src/SearchAddon.ts
@@ -70,7 +70,7 @@ export class SearchAddon implements ITerminalAddon {
this._dataChanged = true;
setTimeout(() => {
if (this._lastSearchOptions?.decorations && this._cachedSearchTerm && this._resultDecorations.size > 0 && this._lastSearchOptions) {
- this._highlightAllMatches(this._cachedSearchTerm, this._lastSearchOptions,'previous');
+ this._highlightAllMatches(this._cachedSearchTerm, this._lastSearchOptions, 'previous');
}
}, 200);
});
From e8aa4eba75522877af05799020b91b7b2829ab76 Mon Sep 17 00:00:00 2001
From: meganrogge
Date: Mon, 21 Mar 2022 15:36:39 -0400
Subject: [PATCH 143/245] IDecorationColor -> ISearchDecorationOptions
---
addons/xterm-addon-search/src/SearchAddon.ts | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/addons/xterm-addon-search/src/SearchAddon.ts b/addons/xterm-addon-search/src/SearchAddon.ts
index 6b84421d..bf4d6330 100644
--- a/addons/xterm-addon-search/src/SearchAddon.ts
+++ b/addons/xterm-addon-search/src/SearchAddon.ts
@@ -10,10 +10,10 @@ export interface ISearchOptions {
wholeWord?: boolean;
caseSensitive?: boolean;
incremental?: boolean;
- decorations?: IDecorationColor;
+ decorations?: ISearchDecorationOptions;
}
-interface IDecorationColor {
+interface ISearchDecorationOptions {
matchColor: string;
selectedColor: string;
}
@@ -541,7 +541,7 @@ export class SearchAddon implements ITerminalAddon {
* @param result The result to select.
* @return Whether a result was selected.
*/
- private _selectResult(result: ISearchResult | undefined, decorations?: IDecorationColor): boolean {
+ private _selectResult(result: ISearchResult | undefined, decorations?: ISearchDecorationOptions): boolean {
const terminal = this._terminal!;
this._selectedDecoration?.dispose();
if (!result) {
@@ -592,7 +592,7 @@ export class SearchAddon implements ITerminalAddon {
* @param color the color to use for the decoration
* @returns the {@link IDecoration} or undefined if the marker has already been disposed of
*/
- private _createResultDecoration(result: ISearchResult, decorations?: IDecorationColor): IDecoration | undefined {
+ private _createResultDecoration(result: ISearchResult, decorations?: ISearchDecorationOptions): IDecoration | undefined {
const terminal = this._terminal!;
const marker = terminal.registerMarker(-terminal.buffer.active.baseY - terminal.buffer.active.cursorY + result.row);
if (!marker || !decorations?.matchColor) {
From 7a502c6b83ff1fdd32c9f8d76343b680cfa926e8 Mon Sep 17 00:00:00 2001
From: meganrogge