Merge pull request #7258 from mlucool/output-search

Support for output search
jupyterlab · Dec 24, 2019 · 37c7a64 · 37c7a64
2 parents 023828a + ee1f1d0
commit 37c7a64
Show file tree

Hide file tree

Showing 8 changed files with 791 additions and 68 deletions.
diff --git a/packages/documentsearch/package.json b/packages/documentsearch/package.json
@@ -38,6 +38,7 @@
     "@jupyterlab/codemirror": "^2.0.0-alpha.4",
     "@jupyterlab/fileeditor": "^2.0.0-alpha.4",
     "@jupyterlab/notebook": "^2.0.0-alpha.4",
+    "@lumino/algorithm": "^1.2.1",
     "@lumino/coreutils": "^1.4.0",
     "@lumino/disposable": "^1.3.2",
     "@lumino/polling": "^1.0.1",

diff --git a/packages/documentsearch/src/interfaces.ts b/packages/documentsearch/src/interfaces.ts
@@ -4,6 +4,10 @@
 import { ISignal } from '@lumino/signaling';
 import { Widget } from '@lumino/widgets';
 
+export interface IFiltersType {
+  output: boolean;
+}
+
 export interface IDisplayState {
   /**
    * The index of the currently selected match
@@ -64,6 +68,16 @@ export interface IDisplayState {
    * Whether or not the replace entry row is visible
    */
   replaceEntryShown: boolean;
+
+  /**
+   * What should we include when we search?
+   */
+  filters: IFiltersType;
+
+  /**
+   * Is the filters view open?
+   */
+  filtersOpen: boolean;
 }
 
 export interface ISearchMatch {
@@ -123,10 +137,15 @@ export interface ISearchProvider<T extends Widget = Widget> {
    *
    * @param query A RegExp to be use to perform the search
    * @param searchTarget The widget to be searched
+   * @param filters Filter parameters to pass to provider
    *
    * @returns A promise that resolves with a list of all matches
    */
-  startQuery(query: RegExp, searchTarget: T): Promise<ISearchMatch[]>;
+  startQuery(
+    query: RegExp,
+    searchTarget: T,
+    filters: IFiltersType
+  ): Promise<ISearchMatch[]>;
 
   /**
    * Clears state of a search provider to prepare for startQuery to be called
@@ -194,4 +213,10 @@ export interface ISearchProvider<T extends Widget = Widget> {
    * the replace option.
    */
   readonly isReadOnly: boolean;
+
+  /**
+   * Set to true if the widget under search has outputs to search.
+   * Defaults to false.
+   */
+  readonly hasOutputs?: boolean;
 }
diff --git a/packages/documentsearch/src/providers/codemirrorsearchprovider.ts b/packages/documentsearch/src/providers/codemirrorsearchprovider.ts
@@ -69,12 +69,14 @@ export class CodeMirrorSearchProvider
    *
    * @param query A RegExp to be use to perform the search
    * @param searchTarget The widget to be searched
+   * @param [filters={}] Filter parameters to pass to provider
    *
    * @returns A promise that resolves with a list of all matches
    */
   async startQuery(
     query: RegExp,
-    searchTarget: Widget
+    searchTarget: Widget,
+    filters = {}
   ): Promise<ISearchMatch[]> {
     if (!CodeMirrorSearchProvider.canSearchOn(searchTarget)) {
       throw new Error('Cannot find Codemirror instance to search');
@@ -298,6 +300,9 @@ export class CodeMirrorSearchProvider
     return undefined;
   }
 
+  get editor(): CodeMirrorEditor {
+    return this._cm;
+  }
   /**
    * Set whether or not the CodemirrorSearchProvider will wrap to the beginning
    * or end of the document on invocations of highlightNext or highlightPrevious, respectively