Merge pull request #2196 from github/koesie10/ast-cfg-typed-commands

Convert AST and CFG commands to typed commands

Author: koesie10

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/common/commands.ts

@@ -167,6 +167,15 @@ 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 PackagingCommands = {
   "codeQL.installPackDependencies": () => Promise<void>;
   "codeQL.downloadPacks": () => Promise<void>;
@@ -181,6 +190,7 @@ export type AllCommands = BaseCommands &
   LocalDatabasesCommands &
   VariantAnalysisCommands &
   DatabasePanelCommands &
+  AstCfgCommands &
   PackagingCommands &
   EvalLogViewerCommands;