Add search result count to SearchAddon

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

@@ -4,6 +4,69 @@
  */
 
 import { Terminal, IDisposable, ITerminalAddon, ISelectionPosition, IDecoration } from 'xterm';
+interface IListener<T, U = void> {
+  (arg1: T, arg2: U): void;
+}
+
+export interface IEvent<T, U = void> {
+  (listener: (arg1: T, arg2: U) => any): IDisposable;
+}
+
+export interface IEventEmitter<T, U = void> {
+  event: IEvent<T, U>;
+  fire(arg1: T, arg2: U): void;
+  dispose(): void;
+}
+
+export class EventEmitter<T, U = void> implements IEventEmitter<T, U> {
+  private _listeners: IListener<T, U>[] = [];
+  private _event?: IEvent<T, U>;
+  private _disposed: boolean = false;
+
+  public get event(): IEvent<T, U> {
+    if (!this._event) {
+      this._event = (listener: (arg1: T, arg2: U) => any) => {
+        this._listeners.push(listener);
+        const disposable = {
+          dispose: () => {
+            if (!this._disposed) {
+              for (let i = 0; i < this._listeners.length; i++) {
+                if (this._listeners[i] === listener) {
+                  this._listeners.splice(i, 1);
+                  return;
+                }
+              }
+            }
+          }
+        };
+        return disposable;
+      };
+    }
+    return this._event;
+  }
+
+  public fire(arg1: T, arg2: U): void {
+    const queue: IListener<T, U>[] = [];
+    for (let i = 0; i < this._listeners.length; i++) {
+      queue.push(this._listeners[i]);
+    }
+    for (let i = 0; i < queue.length; i++) {
+      queue[i].call(undefined, arg1, arg2);
+    }
+  }
+
+  public dispose(): void {
+    if (this._listeners) {
+      this._listeners.length = 0;
+    }
+    this._disposed = true;
+  }
+}
+
+export function forwardEvent<T>(from: IEvent<T>, to: IEventEmitter<T>): IDisposable {
+  return from(e => to.fire(e));
+}
+
 
 export interface ISearchOptions {
   regex?: boolean;
@@ -53,8 +116,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 +131,9 @@ export class SearchAddon implements ITerminalAddon {
   private _cursorMoveListener: IDisposable | undefined;
   private _resizeListener: IDisposable | 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 +142,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);
@@ -91,13 +157,16 @@ export class SearchAddon implements ITerminalAddon {
   public clearDecorations(): void {
     this._selectedDecoration?.dispose();
     this._terminal?.clearSelection();
-    this._searchResults.clear();
+    this._searchResults?.clear();
     this._disposeDecorations();
     this._cachedSearchTerm = undefined;
     this._dataChanged = true;
   }
 
   private _disposeDecorations(): void {
+    if (!this._resultDecorations) {
+      return;
+    }
     this._resultDecorations.forEach(decorations => {
       for (const d of decorations) {
         d.dispose();
@@ -106,6 +175,14 @@ export class SearchAddon implements ITerminalAddon {
     this._resultDecorations.clear();
   }
 
+  /**
+   * @returns the last search result count or undefined
+   * if decorations aren't enabled
+   */
+  public get resultCount(): number | undefined {
+    return this._searchResults?.size || undefined;
+  }
+
   /**
    * Find the next instance of the term, then scroll to and select it. If it
    * doesn't exist, do nothing.
@@ -129,6 +206,12 @@ export class SearchAddon implements ITerminalAddon {
     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,6 +220,8 @@ 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._searchResults.clear();
@@ -153,9 +238,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 +249,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 {
@@ -669,7 +757,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/typings/xterm-addon-search.d.ts

@@ -3,7 +3,8 @@
  * @license MIT
  */
 
-import { Terminal, ILinkMatcherOptions, IDisposable, ITerminalAddon } from 'xterm';
+import { IEvent } from 'node-pty';
+import { Terminal, ITerminalAddon } from 'xterm';
 
 declare module 'xterm-addon-search' {
   /**
@@ -110,5 +111,17 @@ declare module 'xterm-addon-search' {
      * Clears the decorations and selection
      */
     public clearDecorations(): void;
+
+    /**
+     * @returns the last search result count or undefined
+     * if decorations aren't enabled
+     */
+    public get resultCount(): number | undefined;
+
+    /**
+     * An event listener for when the search results change
+     * as a result of the buffer changing
+     */
+    onDidChangeResults: IEvent<void>;
   }
 }