@xterm/addon-search 0.17.0-beta.21 → 0.17.0-beta.211

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xterm/addon-search",
-  "version": "0.17.0-beta.21",
+  "version": "0.17.0-beta.211",
   "author": {
     "name": "The xterm.js authors",
     "url": "https://xtermjs.org/"
@@ -16,13 +16,13 @@
     "xterm.js"
   ],
   "scripts": {
-    "prepackage": "../../node_modules/.bin/tsc -p .",
+    "prepackage": "../../node_modules/.bin/tsgo -p .",
     "package": "../../node_modules/.bin/webpack",
     "prepublishOnly": "npm run package",
     "start": "node ../../demo/start"
   },
-  "commit": "edf100a24ba540665083b24e2edcf4c3958deca3",
+  "commit": "605a7c6e3020b23155ad0544c3e56e88dd295c20",
   "peerDependencies": {
-    "@xterm/xterm": "^6.1.0-beta.21"
+    "@xterm/xterm": "^6.1.0-beta.211"
   }
 }

package/src/DecorationManager.ts

@@ -5,7 +5,7 @@
 
 import type { Terminal, IDisposable, IDecoration } from '@xterm/xterm';
 import type { ISearchDecorationOptions } from '@xterm/addon-search';
-import { dispose, Disposable, toDisposable } from 'vs/base/common/lifecycle';
+import { dispose, Disposable, toDisposable } from 'common/Lifecycle';
 import type { ISearchResult } from './SearchEngine';
 
 /**
@@ -135,6 +135,7 @@ export class DecorationManager extends Disposable {
         marker,
         x: range[1],
         width: range[2],
+        layer: isActiveResult ? 'top' : 'bottom',
         backgroundColor: isActiveResult ? options.activeMatchBackground : options.matchBackground,
         overviewRulerOptions: this._highlightedLines.has(marker.line) ? undefined : {
           color: isActiveResult ? options.activeMatchColorOverviewRuler : options.matchOverviewRuler,

package/src/SearchAddon.ts

@@ -4,10 +4,10 @@
  */
 
 import type { Terminal, IDisposable, ITerminalAddon } from '@xterm/xterm';
-import type { SearchAddon as ISearchApi, ISearchOptions, ISearchAddonOptions, ISearchResultChangeEvent } from '@xterm/addon-search';
-import { Event } from 'vs/base/common/event';
-import { Disposable, MutableDisposable, toDisposable } from 'vs/base/common/lifecycle';
-import { disposableTimeout } from 'vs/base/common/async';
+import type { SearchAddon as ISearchApi, ISearchOptions, ISearchAddonOptions, ISearchResultChangeEvent, ISearchDecorationOptions } from '@xterm/addon-search';
+import { Emitter, type IEvent } from 'common/Event';
+import { Disposable, MutableDisposable, toDisposable } from 'common/Lifecycle';
+import { disposableTimeout } from 'common/Async';
 import { SearchLineCache } from './SearchLineCache';
 import { SearchState } from './SearchState';
 import { SearchEngine, type ISearchResult } from './SearchEngine';
@@ -42,7 +42,12 @@ export class SearchAddon extends Disposable implements ITerminalAddon, ISearchAp
   private _decorationManager: DecorationManager | undefined;
   private _resultTracker = this._register(new SearchResultTracker());
 
-  public get onDidChangeResults(): Event<ISearchResultChangeEvent> {
+  private readonly _onAfterSearch = this._register(new Emitter<void>());
+  public readonly onAfterSearch = this._onAfterSearch.event;
+  private readonly _onBeforeSearch = this._register(new Emitter<void>());
+  public readonly onBeforeSearch = this._onBeforeSearch.event;
+
+  public get onDidChangeResults(): IEvent<ISearchResultChangeEvent> {
     return this._resultTracker.onDidChangeResults;
   }
 
@@ -98,6 +103,8 @@ export class SearchAddon extends Disposable implements ITerminalAddon, ISearchAp
       throw new Error('Cannot use addon until it has been loaded');
     }
 
+    this._onBeforeSearch.fire();
+
     this._state.lastSearchOptions = searchOptions;
 
     if (this._state.shouldUpdateHighlighting(term, searchOptions)) {
@@ -108,6 +115,8 @@ export class SearchAddon extends Disposable implements ITerminalAddon, ISearchAp
     this._fireResults(searchOptions);
     this._state.cachedSearchTerm = term;
 
+    this._onAfterSearch.fire();
+
     return found;
   }
 
@@ -173,6 +182,8 @@ export class SearchAddon extends Disposable implements ITerminalAddon, ISearchAp
       throw new Error('Cannot use addon until it has been loaded');
     }
 
+    this._onBeforeSearch.fire();
+
     this._state.lastSearchOptions = searchOptions;
 
     if (this._state.shouldUpdateHighlighting(term, searchOptions)) {
@@ -183,6 +194,8 @@ export class SearchAddon extends Disposable implements ITerminalAddon, ISearchAp
     this._fireResults(searchOptions);
     this._state.cachedSearchTerm = term;
 
+    this._onAfterSearch.fire();
+
     return found;
   }
 
@@ -209,7 +222,7 @@ export class SearchAddon extends Disposable implements ITerminalAddon, ISearchAp
    * @param result The result to select.
    * @returns Whether a result was selected.
    */
-  private _selectResult(result: ISearchResult | undefined, options?: any, noScroll?: boolean): boolean {
+  private _selectResult(result: ISearchResult | undefined, options?: ISearchDecorationOptions, noScroll?: boolean): boolean {
     if (!this._terminal || !this._decorationManager) {
       return false;
     }

package/src/SearchEngine.ts

@@ -198,9 +198,7 @@ export class SearchEngine {
       }
     }
 
-    if (!result) {
-      result = this._findInLine(term, searchPosition, searchOptions, isReverseSearch);
-    }
+    result ??= this._findInLine(term, searchPosition, searchOptions, isReverseSearch);
 
     // Search from startRow - 1 to top
     if (!result) {

package/src/SearchLineCache.ts

@@ -4,8 +4,8 @@
  */
 
 import type { Terminal } from '@xterm/xterm';
-import { combinedDisposable, Disposable, MutableDisposable, toDisposable } from 'vs/base/common/lifecycle';
-import { disposableTimeout } from 'vs/base/common/async';
+import { combinedDisposable, Disposable, MutableDisposable, toDisposable } from 'common/Lifecycle';
+import { disposableTimeout } from 'common/Async';
 
 export type LineCacheEntry = [
   /**
@@ -38,6 +38,9 @@ export class SearchLineCache extends Disposable {
   private _linesCache: LineCacheEntry[] | undefined;
   private _linesCacheTimeout = this._register(new MutableDisposable());
   private _linesCacheDisposables = this._register(new MutableDisposable());
+  // Track access to avoid recreating a timeout on every init call which occurs once per search
+  // result (findNext/findPrevious -> _highlightAllMatches -> find loop).
+  private _lastAccessTimestamp = 0;
 
   constructor(private readonly _terminal: Terminal) {
     super();
@@ -57,15 +60,34 @@ export class SearchLineCache extends Disposable {
       );
     }
 
-    this._linesCacheTimeout.value = disposableTimeout(() => this._destroyLinesCache(), Constants.LINES_CACHE_TIME_TO_LIVE);
+    this._lastAccessTimestamp = Date.now();
+    if (!this._linesCacheTimeout.value) {
+      this._scheduleLinesCacheTimeout(Constants.LINES_CACHE_TIME_TO_LIVE);
+    }
   }
 
   private _destroyLinesCache(): void {
     this._linesCache = undefined;
+    this._lastAccessTimestamp = 0;
     this._linesCacheDisposables.clear();
     this._linesCacheTimeout.clear();
   }
 
+  private _scheduleLinesCacheTimeout(delay: number): void {
+    this._linesCacheTimeout.value = disposableTimeout(() => {
+      if (!this._linesCache) {
+        return;
+      }
+      const now = Date.now();
+      const elapsed = now - this._lastAccessTimestamp;
+      if (elapsed >= Constants.LINES_CACHE_TIME_TO_LIVE) {
+        this._destroyLinesCache();
+        return;
+      }
+      this._scheduleLinesCacheTimeout(Constants.LINES_CACHE_TIME_TO_LIVE - elapsed);
+    }, delay);
+  }
+
   public getLineFromCache(row: number): LineCacheEntry | undefined {
     return this._linesCache?.[row];
   }

package/src/SearchResultTracker.ts

@@ -5,8 +5,8 @@
 
 import type { ISearchResultChangeEvent } from '@xterm/addon-search';
 import type { IDisposable } from '@xterm/xterm';
-import { Emitter, Event } from 'vs/base/common/event';
-import { Disposable } from 'vs/base/common/lifecycle';
+import { Emitter, type IEvent } from 'common/Event';
+import { Disposable } from 'common/Lifecycle';
 import type { ISearchResult } from './SearchEngine';
 
 /**
@@ -25,7 +25,7 @@ export class SearchResultTracker extends Disposable {
   private _selectedDecoration: ISelectedDecoration | undefined;
 
   private readonly _onDidChangeResults = this._register(new Emitter<ISearchResultChangeEvent>());
-  public get onDidChangeResults(): Event<ISearchResultChangeEvent> { return this._onDidChangeResults.event; }
+  public get onDidChangeResults(): IEvent<ISearchResultChangeEvent> { return this._onDidChangeResults.event; }
 
   /**
    * Gets the current search results.

package/typings/addon-search.d.ts

@@ -152,8 +152,17 @@ declare module '@xterm/addon-search' {
     public clearActiveDecoration(): void;
 
     /**
-     * When decorations are enabled, fires when
-     * the search results change.
+     * Fires after a search is performed.
+     */
+    readonly onAfterSearch: IEvent<void>;
+
+    /**
+     * Fires before a search is performed.
+     */
+    readonly onBeforeSearch: IEvent<void>;
+
+    /**
+     * When decorations are enabled, fires when the search results change.
      */
     readonly onDidChangeResults: IEvent<ISearchResultChangeEvent>;
   }