Add search result count to SearchAddon

addons/xterm-addon-search/src/SearchAddon.ts

@@ -4,6 +4,7 @@
  */
 
 import { Terminal, IDisposable, ITerminalAddon, ISelectionPosition, IDecoration } from 'xterm';
+import { EventEmitter } from 'common/EventEmitter';
 
 export interface ISearchOptions {
   regex?: boolean;
@@ -53,8 +54,8 @@ export class SearchAddon implements ITerminalAddon {
   private _dataChanged: boolean = false;
   private _cachedSearchTerm: string | undefined;
   private _selectedDecoration: IDecoration | undefined;
-  private _resultDecorations: Map<number, IDecoration[]> = new Map<number, IDecoration[]>();
-  private _searchResults:  Map<string, ISearchResult> = new Map();
+  private _resultDecorations: Map<number, IDecoration[]> | undefined;
+  private _searchResults:  Map<string, ISearchResult> | undefined;
   private _onDataDisposable: IDisposable | undefined;
   private _lastSearchOptions: ISearchOptions | undefined;
   private _highlightTimeout: number | undefined;
@@ -68,6 +69,11 @@ export class SearchAddon implements ITerminalAddon {
   private _cursorMoveListener: IDisposable | undefined;
   private _resizeListener: IDisposable | undefined;
 
+  private _resultIndex: number | undefined;
+
+  private readonly _onDidChangeResults = new EventEmitter<void>();
+  public readonly onDidChangeResults = this._onDidChangeResults.event;
+
   public activate(terminal: Terminal): void {
     this._terminal = terminal;
     this._onDataDisposable = this._terminal.onData(() => {
@@ -76,7 +82,7 @@ export class SearchAddon implements ITerminalAddon {
         window.clearTimeout(this._highlightTimeout);
       }
       this._highlightTimeout = setTimeout(() => {
-        if (this._lastSearchOptions?.decorations && this._cachedSearchTerm && this._resultDecorations.size > 0 && this._lastSearchOptions) {
+        if (this._lastSearchOptions?.decorations && this._cachedSearchTerm && this._resultDecorations?.size && this._resultDecorations.size > 0 && this._lastSearchOptions) {
           this._highlightAllMatches(this._cachedSearchTerm, this._lastSearchOptions);
         }
       }, 200);
@@ -90,14 +96,18 @@ export class SearchAddon implements ITerminalAddon {
 
   public clearDecorations(): void {
     this._selectedDecoration?.dispose();
-    this._terminal?.clearSelection();
-    this._searchResults.clear();
+    // this._terminal?.clearSelection();
+    this._searchResults?.clear();
     this._disposeDecorations();
     this._cachedSearchTerm = undefined;
     this._dataChanged = true;
+    this._resultIndex = undefined;
   }
 
   private _disposeDecorations(): void {
+    if (!this._resultDecorations) {
+      return;
+    }
     this._resultDecorations.forEach(decorations => {
       for (const d of decorations) {
         d.dispose();
@@ -113,22 +123,28 @@ export class SearchAddon implements ITerminalAddon {
    * @param searchOptions Search options.
    * @return Whether a result was found.
    */
-  public findNext(term: string, searchOptions?: ISearchOptions): boolean {
+  public findNext(term: string, searchOptions?: ISearchOptions): boolean | { resultIndex: number, resultCount: number } {
     if (!this._terminal) {
       throw new Error('Cannot use addon until it has been loaded');
     }
     this._lastSearchOptions = searchOptions;
-    const findNextResult = this._findNextAndSelect(term, searchOptions);
     if (searchOptions?.decorations) {
       this._highlightAllMatches(term, searchOptions);
     }
-    return findNextResult;
+    const findNextResult = this._findNextAndSelect(term, searchOptions);
+    return this._resultIndex ? { resultIndex: this._resultIndex!, resultCount: this._searchResults?.size || 0 } : findNextResult;
   }
 
   private _highlightAllMatches(term: string, searchOptions: ISearchOptions): void {
     if (!this._terminal) {
       throw new Error('Cannot use addon until it has been loaded');
     }
+    if (!this._searchResults) {
+      this._searchResults = new Map<string, ISearchResult>();
+    }
+    if (!this._resultDecorations) {
+      this._resultDecorations = new Map<number, IDecoration[]>();
+    }
     if (!term || term.length === 0) {
       this.clearDecorations();
       return;
@@ -137,8 +153,10 @@ export class SearchAddon implements ITerminalAddon {
     if (term === this._cachedSearchTerm && !this._dataChanged) {
       return;
     }
+    const dataDrivenChange = term === this._cachedSearchTerm && this._dataChanged;
+    const lastSearchCount = this._searchResults.size;
     // new search, clear out the old decorations
-    this._disposeDecorations();
+    this.clearDecorations();
     this._searchResults.clear();
     let result = this._find(term, 0, 0, searchOptions);
     while (result && !this._searchResults.get(`${result.row}-${result.col}`)) {
@@ -153,9 +171,9 @@ export class SearchAddon implements ITerminalAddon {
     this._searchResults.forEach(result => {
       const resultDecoration = this._createResultDecoration(result, searchOptions.decorations!);
       if (resultDecoration) {
-        const decorationsForLine = this._resultDecorations.get(resultDecoration.marker.line) || [];
+        const decorationsForLine = this._resultDecorations!.get(resultDecoration.marker.line) || [];
         decorationsForLine.push(resultDecoration);
-        this._resultDecorations.set(resultDecoration.marker.line, decorationsForLine);
+        this._resultDecorations!.set(resultDecoration.marker.line, decorationsForLine);
       }
     });
     if (this._dataChanged) {
@@ -164,6 +182,9 @@ export class SearchAddon implements ITerminalAddon {
     if (this._searchResults.size > 0) {
       this._cachedSearchTerm = term;
     }
+    if (dataDrivenChange && lastSearchCount !== this._searchResults.size) {
+      this._onDidChangeResults.fire();
+    }
   }
 
   private _find(term: string, startRow: number, startCol: number, searchOptions?: ISearchOptions): ISearchResult | undefined {
@@ -210,6 +231,16 @@ export class SearchAddon implements ITerminalAddon {
       this.clearDecorations();
       return false;
     }
+    if (this._searchResults) {
+      if (!this._resultIndex) {
+        this._resultIndex = 1;
+      } else {
+        this._resultIndex++;
+        if (this._resultIndex > this._searchResults.size) {
+          this._resultIndex = 1;
+        }
+      }
+    }
 
     let startCol = 0;
     let startRow = 0;
@@ -264,7 +295,6 @@ export class SearchAddon implements ITerminalAddon {
       searchPosition.startCol = 0;
       result = this._findInLine(term, searchPosition, searchOptions);
     }
-
     // Set selection and scroll if a result was found
     return this._selectResult(result, searchOptions?.decorations);
   }
@@ -275,16 +305,16 @@ export class SearchAddon implements ITerminalAddon {
    * @param searchOptions Search options.
    * @return Whether a result was found.
    */
-  public findPrevious(term: string, searchOptions?: ISearchOptions): boolean {
+  public findPrevious(term: string, searchOptions?: ISearchOptions): boolean | { resultIndex: number, resultCount: number } {
     if (!this._terminal) {
       throw new Error('Cannot use addon until it has been loaded');
     }
     this._lastSearchOptions = searchOptions;
-    const findPreviousResult = this._findAndSelectPrevious(term, searchOptions);
     if (searchOptions?.decorations) {
       this._highlightAllMatches(term, searchOptions);
     }
-    return findPreviousResult;
+    const findPreviousResult = this._findAndSelectPrevious(term, searchOptions);
+    return this._resultIndex ? { resultIndex: this._resultIndex, resultCount: this._searchResults?.size || 0 }: findPreviousResult;
   }
 
   private _findAndSelectPrevious(term: string, searchOptions?: ISearchOptions): boolean {
@@ -299,6 +329,16 @@ export class SearchAddon implements ITerminalAddon {
       return false;
     }
 
+    if (this._searchResults) {
+      if (!this._resultIndex) {
+        this._resultIndex = this._searchResults?.size;
+      } else {
+        this._resultIndex--;
+        if (this._resultIndex === 0) {
+          this._resultIndex = this._searchResults?.size;
+        }
+      }
+    }
     let startRow = this._terminal.buffer.active.baseY + this._terminal.rows;
     let startCol = this._terminal.cols;
     const isReverseSearch = true;
@@ -355,7 +395,6 @@ export class SearchAddon implements ITerminalAddon {
         }
       }
     }
-
     // If there is only one result, return true.
     if (!result && currentSelection) return true;
 
@@ -669,7 +708,7 @@ export class SearchAddon implements ITerminalAddon {
       marker,
       x: result.col,
       width: result.size,
-      overviewRulerOptions: this._resultDecorations.get(marker.line) && !this._dataChanged ? undefined : {
+      overviewRulerOptions: this._resultDecorations?.get(marker.line) && !this._dataChanged ? undefined : {
         color: decorations.matchOverviewRuler, position: 'center'
       }
     });

addons/xterm-addon-search/src/tsconfig.json

@@ -13,10 +13,26 @@
     "strict": true,
     "types": [
       "../../../node_modules/@types/mocha"
-    ]
+    ],
+    "paths": {
+      "common/*": [
+        "../../../src/common/*"
+      ],
+      "browser/*": [
+        "../../../src/browser/*"
+      ]
+    }
   },
   "include": [
     "./**/*",
     "../../../typings/xterm.d.ts"
+  ],
+  "references": [
+    {
+      "path": "../../../src/common"
+    },
+    {
+      "path": "../../../src/browser"
+    }
   ]
 }

addons/xterm-addon-search/tsconfig.json

@@ -3,6 +3,6 @@
   "include": [],
   "references": [
     { "path": "./src" },
-    { "path": "./test" }
+    { "path": "./test" },
   ]
 }

addons/xterm-addon-search/typings/xterm-addon-search.d.ts

@@ -3,7 +3,7 @@
  * @license MIT
  */
 
-import { Terminal, ILinkMatcherOptions, IDisposable, ITerminalAddon } from 'xterm';
+import { Terminal, ITerminalAddon, IEvent } from 'xterm';
 
 declare module 'xterm-addon-search' {
   /**
@@ -95,20 +95,30 @@ declare module 'xterm-addon-search' {
      * options.
      * @param term The search term.
      * @param searchOptions The options for the search.
+     * @returns the result index and result count if decorations are provided or a boolean
+     * indicating if there was a match
      */
-    public findNext(term: string, searchOptions?: ISearchOptions): boolean;
+    public findNext(term: string, searchOptions?: ISearchOptions): boolean | { resultIndex: number, resultCount: number };
 
     /**
      * Search backwards for the previous result that matches the search term and
      * options.
      * @param term The search term.
      * @param searchOptions The options for the search.
+     * @returns the result index and result count if decorations are provided or a boolean
+     * indicating if there was a match
      */
-    public findPrevious(term: string, searchOptions?: ISearchOptions): boolean;
+    public findPrevious(term: string, searchOptions?: ISearchOptions): boolean | { resultIndex: number, resultCount: number };
 
     /**
      * Clears the decorations and selection
      */
     public clearDecorations(): void;
+
+    /**
+     * An event listener for when the search results change
+     * as a result of the buffer changing
+     */
+    onDidChangeResults: IEvent<void>;
   }
 }