QuickEval and other debug commands

Author: Dave Bartolomeo

extensions/ql-vscode/package.json

@@ -351,6 +351,30 @@
         "command": "codeQL.runQueryContextEditor",
         "title": "CodeQL: Run Query on Selected Database"
       },
+      {
+        "command": "codeQL.debugQuery",
+        "title": "CodeQL: Debug Query"
+      },
+      {
+        "command": "codeQL.debugQueryContextEditor",
+        "title": "CodeQL: Debug Query"
+      },
+      {
+        "command": "codeQL.startDebuggingSelection",
+        "title": "CodeQL: Debug Selection"
+      },
+      {
+        "command": "codeQL.startDebuggingSelectionContextEditor",
+        "title": "CodeQL: Debug Selection"
+      },
+      {
+        "command": "codeQL.continueDebuggingSelection",
+        "title": "CodeQL: Debug Selection"
+      },
+      {
+        "command": "codeQL.continueDebuggingSelectionContextEditor",
+        "title": "CodeQL: Debug Selection"
+      },
       {
         "command": "codeQL.runQueryOnMultipleDatabases",
         "title": "CodeQL: Run Query on Multiple Databases"
@@ -1072,6 +1096,30 @@
           "command": "codeQL.runQueryContextEditor",
           "when": "false"
         },
+        {
+          "command": "codeQL.debugQuery",
+          "when": "config.codeQL.canary && editorLangId == ql && resourceExtname == .ql && !inDebugMode"
+        },
+        {
+          "command": "codeQL.debugQueryContextEditor",
+          "when": "false"
+        },
+        {
+          "command": "codeQL.startDebuggingSelection",
+          "when": "config.codeQL.canary && editorLangId == ql && debugState == inactive && debugConfigurationType == codeql"
+        },
+        {
+          "command": "codeQL.startDebuggingSelectionContextEditor",
+          "when": "false"
+        },
+        {
+          "command": "codeQL.continueDebuggingSelection",
+          "when": "config.codeQL.canary && editorLangId == ql && debugState == stopped && debugType == codeql"
+        },
+        {
+          "command": "codeQL.continueDebuggingSelectionContextEditor",
+          "when": "false"
+        },
         {
           "command": "codeQL.runQueryOnMultipleDatabases",
           "when": "resourceLangId == ql && resourceExtname == .ql"
@@ -1388,7 +1436,7 @@
       "editor/context": [
         {
           "command": "codeQL.runQueryContextEditor",
-          "when": "editorLangId == ql && resourceExtname == .ql"
+          "when": "editorLangId == ql && resourceExtname == .ql && !inDebugMode"
         },
         {
           "command": "codeQL.runQueryOnMultipleDatabasesContextEditor",
@@ -1408,11 +1456,19 @@
         },
         {
           "command": "codeQL.quickEvalContextEditor",
-          "when": "editorLangId == ql"
+          "when": "editorLangId == ql && debugState == inactive"
         },
         {
-          "command": "codeQL.debug.quickEvalContextEditor",
-          "when": "config.codeQL.canary && editorLangId == ql"
+          "command": "codeQL.debugQueryContextEditor",
+          "when": "config.codeQL.canary && editorLangId == ql && resourceExtname == .ql && !inDebugMode"
+        },
+        {
+          "command": "codeQL.startDebuggingSelectionContextEditor",
+          "when": "config.codeQL.canary && editorLangId == ql && debugState == inactive && debugConfigurationType == codeql"
+        },
+        {
+          "command": "codeQL.continueDebuggingSelectionContextEditor",
+          "when": "config.codeQL.canary && editorLangId == ql && debugState == stopped && debugType == codeql"
         },
         {
           "command": "codeQL.openReferencedFileContextEditor",

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

@@ -101,8 +101,12 @@ export type LocalQueryCommands = {
 
 // Debugger commands
 export type DebuggerCommands = {
-  "codeQL.debug.quickEval": (uri: Uri) => Promise<void>;
-  "codeQL.debug.quickEvalContextEditor": (uri: Uri) => Promise<void>;
+  "codeQL.debugQuery": (uri: Uri) => Promise<void>;
+  "codeQL.debugQueryContextEditor": (uri: Uri) => Promise<void>;
+  "codeQL.startDebuggingSelection": () => Promise<void>;
+  "codeQL.startDebuggingSelectionContextEditor": () => Promise<void>;
+  "codeQL.continueDebuggingSelection": () => Promise<void>;
+  "codeQL.continueDebuggingSelectionContextEditor": () => Promise<void>;
 };
 
 export type ResultsViewCommands = {

extensions/ql-vscode/src/debugger/debug-protocol.ts

@@ -15,6 +15,7 @@ export type OutputEvent = DebugProtocol.OutputEvent &
 export interface EvaluationStartedEventBody {
   id: string;
   outputDir: string;
+  quickEvalPosition: Position | undefined;
 }
 
 /**
@@ -48,6 +49,13 @@ export type AnyEvent =
 
 export type Request = DebugProtocol.Request & { type: "request" };
 
+export interface QuickEvalRequest extends Request {
+  command: "codeql-quickeval";
+  arguments: {
+    quickEvalPosition: Position;
+  };
+}
+
 export interface DebugResultRequest extends Request {
   command: "codeql-debug-result";
   arguments: undefined;
@@ -56,13 +64,19 @@ export interface DebugResultRequest extends Request {
 export type InitializeRequest = DebugProtocol.InitializeRequest &
   Request & { command: "initialize" };
 
-export type AnyRequest = InitializeRequest | DebugResultRequest;
+export type AnyRequest =
+  | InitializeRequest
+  | DebugResultRequest
+  | QuickEvalRequest;
 
 export type Response = DebugProtocol.Response & { type: "response" };
 
 export type InitializeResponse = DebugProtocol.InitializeResponse &
   Response & { command: "initialize" };
 
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface QuickEvalResponse extends Response {}
+
 export type AnyResponse = InitializeResponse;
 
 export type AnyProtocolMessage = AnyEvent | AnyRequest | AnyResponse;