Send editor selection from extension to webview

Author: asgerf

extensions/ql-vscode/src/common/interface-types.ts

@@ -220,6 +220,27 @@ interface UntoggleShowProblemsMsg {
   t: "untoggleShowProblems";
 }
 
+/**
+ * Information about the current editor selection, sent to the results view
+ * so it can filter results to only those overlapping the selection.
+ */
+export interface EditorSelection {
+  /** The file URI in result-compatible format. */
+  fileUri: string;
+  startLine: number;
+  endLine: number;
+  startColumn: number;
+  endColumn: number;
+  /** True if the selection is empty (just a cursor), in which case we match the whole file. */
+  isEmpty: boolean;
+}
+
+interface SetEditorSelectionMsg {
+  t: "setEditorSelection";
+  selection: EditorSelection | undefined;
+  wasFromUserInteraction?: boolean;
+}
+
 /**
  * A message sent into the results view.
  */
@@ -229,7 +250,8 @@ export type IntoResultsViewMsg =
   | SetUserSettingsMsg
   | ShowInterpretedPageMsg
   | NavigateMsg
-  | UntoggleShowProblemsMsg;
+  | UntoggleShowProblemsMsg
+  | SetEditorSelectionMsg;
 
 /**
  * A message sent from the results view.

extensions/ql-vscode/src/local-queries/results-view.ts

@@ -1,5 +1,9 @@
 import type { Location, Result, Run } from "sarif";
-import type { WebviewPanel, TextEditorSelectionChangeEvent } from "vscode";
+import type {
+  WebviewPanel,
+  TextEditorSelectionChangeEvent,
+  Range,
+} from "vscode";
 import {
   Diagnostic,
   DiagnosticRelatedInformation,
@@ -18,6 +22,10 @@ import type {
   DatabaseManager,
 } from "../databases/local-databases";
 import { DatabaseEventKind } from "../databases/local-databases";
+import {
+  decodeSourceArchiveUri,
+  zipArchiveScheme,
+} from "../common/vscode/archive-filesystem-provider";
 import {
   asError,
   assertNever,
@@ -35,6 +43,7 @@ import type {
   InterpretedResultsSortState,
   RawResultsSortState,
   ParsedResultSets,
+  EditorSelection,
 } from "../common/interface-types";
 import {
   SortDirection,
@@ -197,6 +206,12 @@ export class ResultsView extends AbstractWebview<
       ),
     );
 
+    this.disposableEventListeners.push(
+      window.onDidChangeActiveTextEditor(() => {
+        this.sendEditorSelectionToWebview();
+      }),
+    );
+
     this.disposableEventListeners.push(
       this.databaseManager.onDidChangeDatabaseItem(({ kind }) => {
         if (kind === DatabaseEventKind.Remove) {
@@ -573,6 +588,9 @@ export class ResultsView extends AbstractWebview<
       queryName: this.labelProvider.getLabel(fullQuery),
       queryPath: fullQuery.initialInfo.queryPath,
     });
+
+    // Send the current editor selection so the webview can apply filtering immediately
+    this.sendEditorSelectionToWebview();
   }
 
   /**
@@ -1021,7 +1039,10 @@ export class ResultsView extends AbstractWebview<
   }
 
   private handleSelectionChange(event: TextEditorSelectionChangeEvent): void {
-    if (event.kind === TextEditorSelectionChangeKind.Command) {
+    const wasFromUserInteraction =
+      event.kind !== TextEditorSelectionChangeKind.Command;
+    this.sendEditorSelectionToWebview(wasFromUserInteraction);
+    if (!wasFromUserInteraction) {
       return; // Ignore selection events we caused ourselves.
     }
     const editor = window.activeTextEditor;
@@ -1031,6 +1052,77 @@ export class ResultsView extends AbstractWebview<
     }
   }
 
+  /**
+   * Sends the current editor selection to the webview so it can filter results.
+   * Does not send when there is no active text editor (e.g. when the webview
+   * gains focus), so the webview retains the last known selection.
+   */
+  private sendEditorSelectionToWebview(wasFromUserInteraction = false): void {
+    if (!this.isShowingPanel) {
+      return;
+    }
+    const selection = this.computeEditorSelection();
+    if (selection === undefined) {
+      return;
+    }
+    void this.postMessage({
+      t: "setEditorSelection",
+      selection,
+      wasFromUserInteraction,
+    });
+  }
+
+  /**
+   * Computes the current editor selection in a format compatible with result locations.
+   */
+  private computeEditorSelection(): EditorSelection | undefined {
+    const editor = window.activeTextEditor;
+    if (!editor) {
+      return undefined;
+    }
+
+    return this.rangeToEditorSelection(editor.document.uri, editor.selection);
+  }
+
+  private rangeToEditorSelection(uri: Uri, range: Range) {
+    const fileUri = this.getEditorFileUri(uri);
+    if (fileUri == null) {
+      return undefined;
+    }
+    return {
+      fileUri,
+      // VS Code selections are 0-based; result locations are 1-based
+      startLine: range.start.line + 1,
+      endLine: range.end.line + 1,
+      startColumn: range.start.character + 1,
+      endColumn: range.end.character + 1,
+      isEmpty: range.isEmpty,
+    };
+  }
+
+  /**
+   * Gets a file URI from the editor that can be compared with result location URIs.
+   *
+   * Result URIs (in BQRS and SARIF) use the original source file paths.
+   * For `file:` scheme editors, the URI already matches.
+   * For source archive editors, we extract the path within the archive,
+   * which corresponds to the original source file path.
+   */
+  private getEditorFileUri(editorUri: Uri): string | undefined {
+    if (editorUri.scheme === "file") {
+      return editorUri.toString();
+    }
+    if (editorUri.scheme === zipArchiveScheme) {
+      try {
+        const { pathWithinSourceArchive } = decodeSourceArchiveUri(editorUri);
+        return `file://${pathWithinSourceArchive}`;
+      } catch {
+        return undefined;
+      }
+    }
+    return undefined;
+  }
+
   dispose() {
     super.dispose();
 

extensions/ql-vscode/src/view/results/ResultsApp.tsx

@@ -1,6 +1,7 @@
 import { assertNever, getErrorMessage } from "../../common/helpers-pure";
 import type {
   DatabaseInfo,
+  EditorSelection,
   Interpretation,
   IntoResultsViewMsg,
   SortedResultSetInfo,
@@ -66,6 +67,7 @@ interface ResultsViewState {
   nextResultsInfo: ResultsInfo | null;
   isExpectingResultsUpdate: boolean;
   selectionFilterEnabled: boolean;
+  editorSelection: EditorSelection | undefined;
   selectedTable: string | undefined;
 }
 
@@ -82,6 +84,7 @@ export function ResultsApp() {
     nextResultsInfo: null,
     isExpectingResultsUpdate: true,
     selectionFilterEnabled: false,
+    editorSelection: undefined,
     selectedTable: undefined,
   });
 
@@ -224,6 +227,18 @@ export function ResultsApp() {
           setProblemsViewSelected(false);
           break;
 
+        case "setEditorSelection":
+          if (msg.selection) {
+            const selection = msg.selection;
+            setState((prev) => {
+              return {
+                ...prev,
+                editorSelection: selection,
+              };
+            });
+          }
+          break;
+
         default:
           assertNever(msg);
       }