@xterm/addon-search 0.16.0-beta.12 → 0.16.0-beta.120

package/src/SearchAddon.ts

@@ -5,8 +5,8 @@
 
 import type { Terminal, IDisposable, ITerminalAddon, IDecoration } from '@xterm/xterm';
 import type { SearchAddon as ISearchApi } from '@xterm/addon-search';
-import { EventEmitter } from 'common/EventEmitter';
-import { Disposable, toDisposable, disposeArray, MutableDisposable, getDisposeArrayDisposable } from 'common/Lifecycle';
+import { Emitter, Event } from 'vs/base/common/event';
+import { combinedDisposable, Disposable, dispose, MutableDisposable, toDisposable } from 'vs/base/common/lifecycle';
 
 export interface ISearchOptions {
   regex?: boolean;
@@ -31,6 +31,11 @@ export interface ISearchPosition {
   startRow: number;
 }
 
+export interface ISearchResultChangeEvent {
+  resultIndex: number;
+  resultCount: number;
+}
+
 export interface ISearchAddonOptions {
   highlightLimit: number;
 }
@@ -58,6 +63,11 @@ interface IHighlight extends IDisposable {
   match: ISearchResult;
 }
 
+interface IMultiHighlight extends IDisposable {
+  decorations: IDecoration[];
+  match: ISearchResult;
+}
+
 const NON_WORD_CHARACTERS = ' ~!@#$%^&*()+`-=[]{}|\\;:"\',./<>?';
 const LINES_CACHE_TIME_TO_LIVE = 15 * 1000; // 15 secs
 const DEFAULT_HIGHLIGHT_LIMIT = 1000;
@@ -67,7 +77,8 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
   private _cachedSearchTerm: string | undefined;
   private _highlightedLines: Set<number> = new Set();
   private _highlightDecorations: IHighlight[] = [];
-  private _selectedDecoration: MutableDisposable<IHighlight> = this.register(new MutableDisposable());
+  private _searchResultsWithHighlight: ISearchResult[] = [];
+  private _selectedDecoration: MutableDisposable<IMultiHighlight> = this._register(new MutableDisposable());
   private _highlightLimit: number;
   private _lastSearchOptions: ISearchOptions | undefined;
   private _highlightTimeout: number | undefined;
@@ -80,8 +91,8 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
   private _linesCacheTimeoutId = 0;
   private _linesCacheDisposables = new MutableDisposable();
 
-  private readonly _onDidChangeResults = this.register(new EventEmitter<{ resultIndex: number, resultCount: number }>());
-  public readonly onDidChangeResults = this._onDidChangeResults.event;
+  private readonly _onDidChangeResults = this._register(new Emitter<ISearchResultChangeEvent>());
+  public get onDidChangeResults(): Event<ISearchResultChangeEvent> { return this._onDidChangeResults.event; }
 
   constructor(options?: Partial<ISearchAddonOptions>) {
     super();
@@ -91,9 +102,9 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
 
   public activate(terminal: Terminal): void {
     this._terminal = terminal;
-    this.register(this._terminal.onWriteParsed(() => this._updateMatches()));
-    this.register(this._terminal.onResize(() => this._updateMatches()));
-    this.register(toDisposable(() => this.clearDecorations()));
+    this._register(this._terminal.onWriteParsed(() => this._updateMatches()));
+    this._register(this._terminal.onResize(() => this._updateMatches()));
+    this._register(toDisposable(() => this.clearDecorations()));
   }
 
   private _updateMatches(): void {
@@ -111,8 +122,9 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
 
   public clearDecorations(retainCachedSearchTerm?: boolean): void {
     this._selectedDecoration.clear();
-    disposeArray(this._highlightDecorations);
+    dispose(this._highlightDecorations);
     this._highlightDecorations = [];
+    this._searchResultsWithHighlight = [];
     this._highlightedLines.clear();
     if (!retainCachedSearchTerm) {
       this._cachedSearchTerm = undefined;
@@ -162,15 +174,14 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
     // new search, clear out the old decorations
     this.clearDecorations(true);
 
-    const searchResultsWithHighlight: ISearchResult[] = [];
     let prevResult: ISearchResult | undefined = undefined;
     let result = this._find(term, 0, 0, searchOptions);
     while (result && (prevResult?.row !== result.row || prevResult?.col !== result.col)) {
-      if (searchResultsWithHighlight.length >= this._highlightLimit) {
+      if (this._searchResultsWithHighlight.length >= this._highlightLimit) {
         break;
       }
       prevResult = result;
-      searchResultsWithHighlight.push(prevResult);
+      this._searchResultsWithHighlight.push(prevResult);
       result = this._find(
         term,
         prevResult.col + prevResult.term.length >= this._terminal.cols ? prevResult.row + 1 : prevResult.row,
@@ -178,15 +189,21 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
         searchOptions
       );
     }
-    for (const match of searchResultsWithHighlight) {
-      const decoration = this._createResultDecoration(match, searchOptions.decorations!);
-      if (decoration) {
-        this._highlightedLines.add(decoration.marker.line);
-        this._highlightDecorations.push({ decoration, match, dispose() { decoration.dispose(); } });
+    for (const match of this._searchResultsWithHighlight) {
+      const decorations = this._createResultDecorations(match, searchOptions.decorations!, false);
+      if (decorations) {
+        for (const decoration of decorations) {
+          this._storeDecoration(decoration, match);
+        }
       }
     }
   }
 
+  private _storeDecoration(decoration: IDecoration, match: ISearchResult): void {
+    this._highlightedLines.add(decoration.marker.line);
+    this._highlightDecorations.push({ decoration, match, dispose() { decoration.dispose(); } });
+  }
+
   private _find(term: string, startRow: number, startCol: number, searchOptions?: ISearchOptions): ISearchResult | undefined {
     if (!this._terminal || !term || term.length === 0) {
       this._terminal?.clearSelection();
@@ -339,15 +356,15 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
       let resultIndex = -1;
       if (this._selectedDecoration.value) {
         const selectedMatch = this._selectedDecoration.value.match;
-        for (let i = 0; i < this._highlightDecorations.length; i++) {
-          const match = this._highlightDecorations[i].match;
+        for (let i = 0; i < this._searchResultsWithHighlight.length; i++) {
+          const match = this._searchResultsWithHighlight[i];
           if (match.row === selectedMatch.row && match.col === selectedMatch.col && match.size === selectedMatch.size) {
             resultIndex = i;
             break;
           }
         }
       }
-      this._onDidChangeResults.fire({ resultIndex, resultCount: this._highlightDecorations.length });
+      this._onDidChangeResults.fire({ resultIndex, resultCount: this._searchResultsWithHighlight.length });
     }
   }
 
@@ -426,11 +443,11 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
     const terminal = this._terminal!;
     if (!this._linesCache) {
       this._linesCache = new Array(terminal.buffer.active.length);
-      this._linesCacheDisposables.value = getDisposeArrayDisposable([
+      this._linesCacheDisposables.value = combinedDisposable(
         terminal.onLineFeed(() => this._destroyLinesCache()),
         terminal.onCursorMove(() => this._destroyLinesCache()),
         terminal.onResize(() => this._destroyLinesCache())
-      ]);
+      );
     }
 
     window.clearTimeout(this._linesCacheTimeoutId);
@@ -499,12 +516,16 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
     const [stringLine, offsets] = cache;
 
     const offset = this._bufferColsToStringOffset(row, col);
-    const searchTerm = searchOptions.caseSensitive ? term : term.toLowerCase();
-    const searchStringLine = searchOptions.caseSensitive ? stringLine : stringLine.toLowerCase();
+    let searchTerm = term;
+    let searchStringLine = stringLine;
+    if (!searchOptions.regex) {
+      searchTerm = searchOptions.caseSensitive ? term : term.toLowerCase();
+      searchStringLine = searchOptions.caseSensitive ? stringLine : stringLine.toLowerCase();
+    }
 
     let resultIndex = -1;
     if (searchOptions.regex) {
-      const searchRegex = RegExp(searchTerm, 'g');
+      const searchRegex = RegExp(searchTerm, searchOptions.caseSensitive ? 'g' : 'gi');
       let foundTerm: RegExpExecArray | null;
       if (isReverseSearch) {
         // This loop will get the resultIndex of the _last_ regex match in the range 0..offset
@@ -662,25 +683,9 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
     }
     terminal.select(result.col, result.row, result.size);
     if (options) {
-      const marker = terminal.registerMarker(-terminal.buffer.active.baseY - terminal.buffer.active.cursorY + result.row);
-      if (marker) {
-        const decoration = terminal.registerDecoration({
-          marker,
-          x: result.col,
-          width: result.size,
-          backgroundColor: options.activeMatchBackground,
-          layer: 'top',
-          overviewRulerOptions: {
-            color: options.activeMatchColorOverviewRuler
-          }
-        });
-        if (decoration) {
-          const disposables: IDisposable[] = [];
-          disposables.push(marker);
-          disposables.push(decoration.onRender((e) => this._applyStyles(e, options.activeMatchBorder, true)));
-          disposables.push(decoration.onDispose(() => disposeArray(disposables)));
-          this._selectedDecoration.value = { decoration, match: result, dispose() { decoration.dispose(); } };
-        }
+      const decorations = this._createResultDecorations(result, options, true);
+      if (decorations) {
+        this._selectedDecoration.value = { decorations, match: result, dispose() { dispose(decorations); } };
       }
     }
 
@@ -720,28 +725,45 @@ export class SearchAddon extends Disposable implements ITerminalAddon , ISearchA
    * @param options the options for the decoration
    * @returns the {@link IDecoration} or undefined if the marker has already been disposed of
    */
-  private _createResultDecoration(result: ISearchResult, options: ISearchDecorationOptions): IDecoration | undefined {
+  private _createResultDecorations(result: ISearchResult, options: ISearchDecorationOptions, isActiveResult: boolean): IDecoration[] | undefined {
     const terminal = this._terminal!;
-    const marker = terminal.registerMarker(-terminal.buffer.active.baseY - terminal.buffer.active.cursorY + result.row);
-    if (!marker) {
-      return undefined;
-    }
-    const findResultDecoration = terminal.registerDecoration({
-      marker,
-      x: result.col,
-      width: result.size,
-      backgroundColor: options.matchBackground,
-      overviewRulerOptions: this._highlightedLines.has(marker.line) ? undefined : {
-        color: options.matchOverviewRuler,
-        position: 'center'
+
+    // Gather decoration ranges for this match as it could wrap
+    const decorationRanges: [number, number, number][] = [];
+    let currentCol = result.col;
+    let remainingSize = result.size;
+    let markerOffset = -terminal.buffer.active.baseY - terminal.buffer.active.cursorY + result.row;
+    while (remainingSize > 0) {
+      const amountThisRow = Math.min(terminal.cols - currentCol, remainingSize);
+      decorationRanges.push([markerOffset, currentCol, amountThisRow]);
+      currentCol = 0;
+      remainingSize -= amountThisRow;
+      markerOffset++;
+    }
+
+    // Create the decorations
+    const decorations: IDecoration[] = [];
+    for (const range of decorationRanges) {
+      const marker = terminal.registerMarker(range[0]);
+      const decoration = terminal.registerDecoration({
+        marker,
+        x: range[1],
+        width: range[2],
+        backgroundColor: isActiveResult ? options.activeMatchBackground : options.matchBackground,
+        overviewRulerOptions: this._highlightedLines.has(marker.line) ? undefined : {
+          color: isActiveResult ? options.activeMatchColorOverviewRuler : options.matchOverviewRuler,
+          position: 'center'
+        }
+      });
+      if (decoration) {
+        const disposables: IDisposable[] = [];
+        disposables.push(marker);
+        disposables.push(decoration.onRender((e) => this._applyStyles(e, isActiveResult ? options.activeMatchBorder : options.matchBorder, false)));
+        disposables.push(decoration.onDispose(() => dispose(disposables)));
+        decorations.push(decoration);
       }
-    });
-    if (findResultDecoration) {
-      const disposables: IDisposable[] = [];
-      disposables.push(marker);
-      disposables.push(findResultDecoration.onRender((e) => this._applyStyles(e, options.matchBorder, false)));
-      disposables.push(findResultDecoration.onDispose(() => disposeArray(disposables)));
-    }
-    return findResultDecoration;
+    }
+
+    return decorations.length === 0 ? undefined : decorations;
   }
 }

package/typings/addon-search.d.ts

@@ -75,6 +75,21 @@ declare module '@xterm/addon-search' {
     activeMatchColorOverviewRuler: string;
   }
 
+  /**
+   * Event data fired when search results change.
+   */
+  export interface ISearchResultChangeEvent {
+    /**
+     * The index of the currently active result, -1 when the threshold of matches is exceeded.
+     */
+    resultIndex: number;
+
+    /**
+     * The total number of search results found.
+     */
+    resultCount: number;
+  }
+
   /**
    * Options for the search addon.
    */
@@ -139,8 +154,7 @@ declare module '@xterm/addon-search' {
     /**
      * When decorations are enabled, fires when
      * the search results change.
-     * @returns -1 for resultIndex when the threshold of matches is exceeded.
      */
-    readonly onDidChangeResults: IEvent<{ resultIndex: number, resultCount: number }>;
+    readonly onDidChangeResults: IEvent<ISearchResultChangeEvent>;
   }
 }