Merge branch 'main' into robertbrignull/extract_progress

Author: robertbrignull

extensions/ql-vscode/src/ast-cfg-commands.ts

@@ -0,0 +1,90 @@
+import { Uri, window } from "vscode";
+import { withProgress } from "./commandRunner";
+import { AstViewer } from "./astViewer";
+import {
+  TemplatePrintAstProvider,
+  TemplatePrintCfgProvider,
+} from "./contextual/templateProvider";
+import { compileAndRunQuery } from "./local-queries";
+import { QueryRunner } from "./queryRunner";
+import { QueryHistoryManager } from "./query-history/query-history-manager";
+import { DatabaseUI } from "./local-databases-ui";
+import { ResultsView } from "./interface";
+import { AstCfgCommands } from "./common/commands";
+
+type AstCfgOptions = {
+  queryRunner: QueryRunner;
+  queryHistoryManager: QueryHistoryManager;
+  databaseUI: DatabaseUI;
+  localQueryResultsView: ResultsView;
+  queryStorageDir: string;
+
+  astViewer: AstViewer;
+  astTemplateProvider: TemplatePrintAstProvider;
+  cfgTemplateProvider: TemplatePrintCfgProvider;
+};
+
+export function getAstCfgCommands({
+  queryRunner,
+  queryHistoryManager,
+  databaseUI,
+  localQueryResultsView,
+  queryStorageDir,
+  astViewer,
+  astTemplateProvider,
+  cfgTemplateProvider,
+}: AstCfgOptions): AstCfgCommands {
+  const viewAst = async (selectedFile: Uri) =>
+    withProgress(
+      async (progress, token) => {
+        const ast = await astTemplateProvider.provideAst(
+          progress,
+          token,
+          selectedFile ?? window.activeTextEditor?.document.uri,
+        );
+        if (ast) {
+          astViewer.updateRoots(await ast.getRoots(), ast.db, ast.fileName);
+        }
+      },
+      {
+        cancellable: true,
+        title: "Calculate AST",
+      },
+    );
+
+  const viewCfg = async () =>
+    withProgress(
+      async (progress, token) => {
+        const res = await cfgTemplateProvider.provideCfgUri(
+          window.activeTextEditor?.document,
+        );
+        if (res) {
+          await compileAndRunQuery(
+            queryRunner,
+            queryHistoryManager,
+            databaseUI,
+            localQueryResultsView,
+            queryStorageDir,
+            false,
+            res[0],
+            progress,
+            token,
+            undefined,
+          );
+        }
+      },
+      {
+        title: "Calculating Control Flow Graph",
+        cancellable: true,
+      },
+    );
+
+  return {
+    "codeQL.viewAst": viewAst,
+    "codeQL.viewAstContextExplorer": viewAst,
+    "codeQL.viewAstContextEditor": viewAst,
+    "codeQL.viewCfg": viewCfg,
+    "codeQL.viewCfgContextExplorer": viewCfg,
+    "codeQL.viewCfgContextEditor": viewCfg,
+  };
+}

extensions/ql-vscode/src/astViewer.ts

@@ -23,11 +23,11 @@ import {
   isWholeFileLoc,
   isLineColumnLoc,
 } from "./pure/bqrs-utils";
-import { commandRunner } from "./commandRunner";
 import { DisposableObject } from "./pure/disposable-object";
 import { showAndLogExceptionWithTelemetry } from "./helpers";
 import { asError, getErrorMessage } from "./pure/helpers-pure";
 import { redactableError } from "./pure/errors";
+import { AstViewerCommands } from "./common/commands";
 
 export interface AstItem {
   id: BqrsId;
@@ -55,15 +55,6 @@ class AstViewerDataProvider
   readonly onDidChangeTreeData: Event<AstItem | undefined> =
     this._onDidChangeTreeData.event;
 
-  constructor() {
-    super();
-    this.push(
-      commandRunner("codeQLAstViewer.gotoCode", async (item: AstItem) => {
-        await showLocation(item.fileLocation);
-      }),
-    );
-  }
-
   refresh(): void {
     this._onDidChangeTreeData.fire(undefined);
   }
@@ -126,16 +117,20 @@ export class AstViewer extends DisposableObject {
 
     this.push(this.treeView);
     this.push(this.treeDataProvider);
-    this.push(
-      commandRunner("codeQLAstViewer.clear", async () => {
-        this.clear();
-      }),
-    );
     this.push(
       window.onDidChangeTextEditorSelection(this.updateTreeSelection, this),
     );
   }
 
+  getCommands(): AstViewerCommands {
+    return {
+      "codeQLAstViewer.clear": async () => this.clear(),
+      "codeQLAstViewer.gotoCode": async (item: AstItem) => {
+        await showLocation(item.fileLocation);
+      },
+    };
+  }
+
   updateRoots(roots: AstItem[], db: DatabaseItem, fileUri: Uri) {
     this.treeDataProvider.roots = roots;
     this.treeDataProvider.db = db;

extensions/ql-vscode/src/common/commands.ts

@@ -1,5 +1,6 @@
 import type { CommandManager } from "../packages/commands";
 import type { Uri, Range } from "vscode";
+import type { AstItem } from "../astViewer";
 import type { DbTreeViewItem } from "../databases/ui/db-tree-view-item";
 import type { DatabaseItem } from "../local-databases";
 import type { QueryHistoryInfo } from "../query-history/query-history-info";
@@ -167,6 +168,20 @@ export type DatabasePanelCommands = {
   "codeQLVariantAnalysisRepositories.removeItemContextMenu": SingleSelectionCommandFunction<DbTreeViewItem>;
 };
 
+export type AstCfgCommands = {
+  "codeQL.viewAst": (selectedFile: Uri) => Promise<void>;
+  "codeQL.viewAstContextExplorer": (selectedFile: Uri) => Promise<void>;
+  "codeQL.viewAstContextEditor": (selectedFile: Uri) => Promise<void>;
+  "codeQL.viewCfg": () => Promise<void>;
+  "codeQL.viewCfgContextExplorer": () => Promise<void>;
+  "codeQL.viewCfgContextEditor": () => Promise<void>;
+};
+
+export type AstViewerCommands = {
+  "codeQLAstViewer.clear": () => Promise<void>;
+  "codeQLAstViewer.gotoCode": (item: AstItem) => Promise<void>;
+};
+
 export type PackagingCommands = {
   "codeQL.installPackDependencies": () => Promise<void>;
   "codeQL.downloadPacks": () => Promise<void>;
@@ -176,13 +191,20 @@ export type EvalLogViewerCommands = {
   "codeQLEvalLogViewer.clear": () => Promise<void>;
 };
 
+export type SummaryLanguageSupportCommands = {
+  "codeQL.gotoQL": () => Promise<void>;
+};
+
 export type AllCommands = BaseCommands &
   QueryHistoryCommands &
   LocalDatabasesCommands &
   VariantAnalysisCommands &
   DatabasePanelCommands &
+  AstCfgCommands &
+  AstViewerCommands &
   PackagingCommands &
-  EvalLogViewerCommands;
+  EvalLogViewerCommands &
+  SummaryLanguageSupportCommands;
 
 export type AppCommandManager = CommandManager<AllCommands>;