Merge pull request #978 from intersystems-community/feature-974

implementing #974

Author: daimor

package.json

@@ -1247,7 +1247,12 @@
         "objectscript.debug.debugThisMethod": {
           "type": "boolean",
           "default": true,
-          "markdownDescription": "Show inline `Debug this method` CodeLens action for ClassMethods."
+          "markdownDescription": "Show inline `Debug Method` CodeLens action for ClassMethods and Routine Labels."
+        },
+        "objectscript.debug.copyToClipboard": {
+          "type": "boolean",
+          "default": true,
+          "markdownDescription": "Show inline `Copy Invocation` CodeLens action for ClassMethods and Routine Labels."
         },
         "objectscript.studioActionDebugOutput": {
           "type": "boolean",

src/extension.ts

@@ -58,7 +58,7 @@ import { ObjectScriptDefinitionProvider } from "./providers/ObjectScriptDefiniti
 import { ObjectScriptFoldingRangeProvider } from "./providers/ObjectScriptFoldingRangeProvider";
 import { ObjectScriptHoverProvider } from "./providers/ObjectScriptHoverProvider";
 import { ObjectScriptRoutineSymbolProvider } from "./providers/ObjectScriptRoutineSymbolProvider";
-import { ObjectScriptClassCodeLensProvider } from "./providers/ObjectScriptClassCodeLensProvider";
+import { ObjectScriptCodeLensProvider } from "./providers/ObjectScriptCodeLensProvider";
 import { XmlContentProvider } from "./providers/XmlContentProvider";
 
 import { AtelierAPI } from "./api";
@@ -705,9 +705,12 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
       Promise.all(files.map((file) => importFileOrFolder(file, true)))
     ),
     vscode.commands.registerCommand("vscode-objectscript.export", exportAll),
+    vscode.commands.registerCommand("vscode-objectscript.copyToClipboard", (command: string) => {
+      vscode.env.clipboard.writeText(command);
+    }),
     vscode.commands.registerCommand("vscode-objectscript.debug", (program: string, askArgs: boolean) => {
       const startDebugging = (args) => {
-        const programWithArgs = program + `(${args})`;
+        const programWithArgs = program + (program.includes("##class") || args.length ? `(${args})` : "");
         vscode.debug.startDebugging(undefined, {
           type: "objectscript",
           request: "launch",
@@ -848,8 +851,8 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
     vscode.debug.registerDebugAdapterDescriptorFactory("objectscript", debugAdapterFactory),
     debugAdapterFactory,
     vscode.languages.registerCodeLensProvider(
-      documentSelector("objectscript-class"),
-      new ObjectScriptClassCodeLensProvider()
+      documentSelector("objectscript-class", "objectscript"),
+      new ObjectScriptCodeLensProvider()
     ),
     vscode.commands.registerCommand("vscode-objectscript.compileOnly", () => compileOnly(false)),
     vscode.commands.registerCommand("vscode-objectscript.compileOnlyWithFlags", () => compileOnly(true)),

src/providers/ObjectScriptClassCodeLensProvider.ts

@@ -0,0 +1,130 @@
+import * as vscode from "vscode";
+import { config } from "../extension";
+import { currentFile } from "../utils";
+
+export class ObjectScriptCodeLensProvider implements vscode.CodeLensProvider {
+  public provideCodeLenses(
+    document: vscode.TextDocument,
+    token: vscode.CancellationToken
+  ): vscode.ProviderResult<vscode.CodeLens[]> {
+    const result = new Array<vscode.CodeLens>();
+
+    if (document.fileName.toLowerCase().endsWith(".cls")) {
+      result.push(...this.classMethods(document));
+    }
+    if (document.fileName.toLowerCase().endsWith(".mac")) {
+      result.push(...this.routineLabels(document));
+    }
+    return result;
+  }
+
+  private classMethods(document: vscode.TextDocument): vscode.CodeLens[] {
+    const file = currentFile(document);
+    const result = new Array<vscode.CodeLens>();
+
+    if (!file.name.match(/\.cls$/i)) {
+      return result;
+    }
+    const className = file.name.split(".").slice(0, -1).join(".");
+
+    const { debugThisMethod, copyToClipboard } = config("debug");
+    const pattern = /(?:^ClassMethod\s)([^(]+)\((.*)/i;
+    let inComment = false;
+    for (let i = 0; i < document.lineCount; i++) {
+      const line = document.lineAt(i);
+      const text = this.stripLineComments(line.text);
+
+      if (text.match(/\/\*/)) {
+        inComment = true;
+      }
+
+      if (inComment) {
+        if (text.match(/\*\//)) {
+          inComment = false;
+        }
+        continue;
+      }
+
+      const methodMatch = text.match(pattern);
+      if (methodMatch) {
+        const [, name, paramsRaw] = methodMatch;
+        let params = paramsRaw;
+        params = params.replace(/"[^"]*"/g, '""');
+        params = params.replace(/{[^{}]*}|{[^{}]*{[^{}]*}[^{}]*}/g, '""');
+        params = params.replace(/\([^()]*\)/g, "");
+        params = params.split(")")[0];
+        const paramsCount = params.length ? params.split(",").length : 0;
+
+        debugThisMethod && result.push(this.addDebugThisMethod(i, [`##class(${className}).${name}`, paramsCount > 0]));
+        copyToClipboard &&
+          result.push(this.addCopyToClipboard(i, [`##class(${className}).${name}(${Array(paramsCount).join(",")})`]));
+      }
+    }
+    return result;
+  }
+
+  private routineLabels(document: vscode.TextDocument): vscode.CodeLens[] {
+    const file = currentFile(document);
+    const result = new Array<vscode.CodeLens>();
+
+    if (!file.name.match(/\.mac$/i)) {
+      return result;
+    }
+    const routineName = file.name.split(".").slice(0, -1).join(".");
+
+    const { debugThisMethod, copyToClipboard } = config("debug");
+
+    debugThisMethod && result.push(this.addDebugThisMethod(0, [`^${routineName}`, false]));
+    copyToClipboard && result.push(this.addCopyToClipboard(0, [`^${routineName}`]));
+
+    let inComment = false;
+    for (let i = 1; i < document.lineCount; i++) {
+      const line = document.lineAt(i);
+      const text = this.stripLineComments(line.text);
+
+      if (text.match(/\/\*/)) {
+        inComment = true;
+      }
+
+      if (inComment) {
+        if (text.match(/\*\//)) {
+          inComment = false;
+        }
+        continue;
+      }
+
+      const labelMatch = text.match(/^(\w[^(\n\s]+)(?:\(([^)]*)\))?/i);
+      if (labelMatch) {
+        const [, name, parens] = labelMatch;
+
+        debugThisMethod && result.push(this.addDebugThisMethod(i, [`${name}^${routineName}`, parens !== "()"]));
+        copyToClipboard && result.push(this.addCopyToClipboard(i, [`${name}^${routineName}`]));
+      }
+    }
+
+    return result;
+  }
+
+  private addDebugThisMethod(line: number, args: any[]) {
+    return new vscode.CodeLens(new vscode.Range(line, 0, line, 80), {
+      title: `Debug this Method`,
+      command: "vscode-objectscript.debug",
+      arguments: args,
+    });
+  }
+
+  private addCopyToClipboard(line: number, args: any[]) {
+    return new vscode.CodeLens(new vscode.Range(line, 0, line, 80), {
+      title: `Copy Invocation`,
+      command: "vscode-objectscript.copyToClipboard",
+      arguments: args,
+    });
+  }
+
+  private stripLineComments(text: string) {
+    text = text.replace(/\/\/.*$/, "");
+    text = text.replace(/#+;.*$/, "");
+    text = text.replace(/;.*$/, "");
+    return text;
+  }
+}