Merge pull request #38 from nberth/cobol-statement-in-stack

Show current COBOL statement in stackframe summary

Author: nberth

.vscode-test-workspace/.dummy

@@ -14,7 +14,7 @@
 				// "--user-data-dir=${workspaceFolder}/.vscode-test/user-data",
 				"--extensionDevelopmentPath=${workspaceFolder}",
 				"--trace-deprecation",
-				"${workspaceFolder}/.vscode-test-workspace",
+				"${workspaceFolder}/test/resources",
 			],
 			"autoAttachChildProcesses": true,
 			"sourceMaps": true,

.vscode/launch.json

@@ -6,16 +6,17 @@
 			"command": "npm",
 			"type": "shell",
 			"presentation": {
-				"reveal": "always",
-				"panel": "new"
+				"reveal": "silent",
+				"revealProblems": "onProblem",
+				"panel": "dedicated"
 			},
 			"args": [
 				"run",
 				"compile",
 				"--loglevel",
 				"silent"
 			],
-			"isBackground": true,
+			"isBackground": false,
 			"problemMatcher": "$tsc-watch",
 			"group": {
 				"kind": "build",

.vscode/tasks.json

@@ -1,5 +1,6 @@
 ## Next
 
+* Show COBOL statements in entries of stackframe summary [PR #38](https://github.com/ocamlpro/superbol-vscode-debug/pull/38)
 * Remove `gdbpath` and `libcobpath` from launch configurations (these are provided in extension settings) [PR #36](https://github.com/ocamlpro/superbol-vscode-debug/pull/36)
 * Fix enforcement of a default `preLaunchTask` that is not available [PR #34](https://github.com/ocamlpro/superbol-vscode-debug/pull/34)
 * Support cases where the COBOL source code and the corresponding C files are in distinct directories [PR #29](https://github.com/ocamlpro/superbol-vscode-debug/pull/29)

CHANGELOG.md

@@ -1,7 +1,7 @@
 import {MINode} from "./parser.mi2";
 import {DebugProtocol} from "@vscode/debugprotocol/lib/debugProtocol";
 import {removeLeadingZeroes} from "./functions";
-import {SourceMap} from "./parser.c";
+import {SourceMap, Line} from "./parser.c";
 
 export interface Breakpoint {
     file?: string;
@@ -19,11 +19,8 @@ export interface Thread {
 
 export interface Stack {
     level: number;
-    address: string;
     function: string;
-    fileName: string;
-    file: string;
-    line: number;
+    line: Line;
 }
 
 const repeatTimeRegex = /(\"\,\s|^)\'(\s|0)\'\s\<repeats\s(\d+)\stimes\>/i;

package-lock.json

@@ -391,23 +391,21 @@ export class GDBDebugSession extends DebugSession {
 
     protected stackTraceRequest(response: DebugProtocol.StackTraceResponse, args: DebugProtocol.StackTraceArguments): void {
         this.miDebugger.getStack(args.levels, args.threadId).then(stack => {
-            const ret: StackFrame[] = [];
-            stack.forEach(element => {
-                let source: Source = undefined;
-                const file = element.file;
-                if (file) {
-                    source = new Source(element.fileName, file);
-                }
-
-                ret.push(new StackFrame(
+            const ret = stack.map(element => {
+                const file = element.line.fileCobol;
+                const fileBasename = path.basename(file);
+                const cobolLine = element.line.cobolLine?.trim();
+                const frameDescr = cobolLine
+                    ? `${element.function} (${cobolLine})`
+                    : `${element.function}`;
+                return new StackFrame(
                     this.threadAndLevelToFrameId(args.threadId, element.level),
-                    element.function + "@" + element.address,
-                    source,
-                    element.line,
-                    0));
+                    frameDescr, // + "@" + element.address,
+                    file ? new Source(fileBasename, file) : undefined,
+                    element.line.lineCobol, 0);
             });
             response.body = {
-                stackFrames: ret
+                stackFrames: Array.from(ret)
             };
             this.sendResponse(response);
         }, (err: Error) => {

src/debugger.ts

@@ -46,29 +46,11 @@ export class MI2 extends EventEmitter implements IDebugger {
     constructor(public gdbpath: string, public gdbArgs: string[], procEnv: NodeJS.ProcessEnv, public noDebug: boolean, public gdbtty: boolean, public cobcrunPath: string, public useCobcrun: boolean, public sourceDirs: string[]) {
         super();
         if (procEnv) {
-            const env = {};
-            // Duplicate process.env so we don't override it
-            for (const key in process.env)
-                if (key in process.env) {
-                    env[key] = process.env[key];
-                }
-            // Overwrite with user specified variables
-            for (const key in procEnv) {
-                if (key in procEnv) {
-                    if (procEnv === null) {
-                        delete env[key];
-                    } else {
-                        env[key] = procEnv[key];
-                    }
-                }
-            }
-            this.procEnv = env;
+            this.procEnv = {...process.env, ...procEnv};
         }
     }
 
     load(cwd: string, target: string, targetargs: string, group: string[], gdbtty: boolean): Thenable<unknown> {
-        group.map(e => { path.join(cwd, e); });
-
         return new Promise(async (resolve, reject) => {
             if (!fs.existsSync(cwd)) {
                 reject(new Error("cwd does not exist."));
@@ -123,7 +105,6 @@ export class MI2 extends EventEmitter implements IDebugger {
         if (!path.isAbsolute(target)) {
             target = path.join(cwd, target);
         }
-        group.map(e => { path.join(cwd, e) });
 
         return new Promise((resolve, reject) => {
             if (!fs.existsSync(cwd)) {
@@ -744,9 +725,7 @@ export class MI2 extends EventEmitter implements IDebugger {
         const stack = <Stack[]>result.result("stack");
         return stack.map(element => {
             const level = MINode.valueOf(element, "@frame.level");
-            const addr = MINode.valueOf(element, "@frame.addr");
             const func = MINode.valueOf(element, "@frame.func");
-            const filename = MINode.valueOf(element, "@frame.file");
             let file: string = MINode.valueOf(element, "@frame.fullname");
             if (file) {
                 file = path.normalize(file);
@@ -759,14 +738,10 @@ export class MI2 extends EventEmitter implements IDebugger {
                 line = parseInt(lnstr);
             }
 
-            const map = this.map.getLineCobol(file, line);
             return {
-                address: addr,
-                fileName: path.basename(map.fileCobol),
-                file: map.fileCobol,
                 function: func || from,
                 level: level,
-                line: map.lineCobol
+                line: this.map.getLineCobol(file, line)
             };
         });
     }

src/gdb.ts

@@ -39,8 +39,29 @@ function cobEncodeInvalidChars (s: string): string {
     return s.replace("-","__");
 }
 
+// Minimalistic one-entry cache.
+let currentCOBOLFileName: string = null;
+let currentCOBOLFileContents: string[] = [];
+
+function lookupLineInCobolFile(fileCobol: string, lineCobol: number) : string | undefined {
+    if (fileCobol && currentCOBOLFileName != fileCobol) {
+        currentCOBOLFileName = fileCobol;
+        try {
+            currentCOBOLFileContents = fs.readFileSync(fileCobol).toString().split('\n');
+        } catch (e) {
+            log.debug(e.message);
+            currentCOBOLFileContents = [];
+        }
+    }
+    if (currentCOBOLFileContents) {
+        return currentCOBOLFileContents[lineCobol - 1];
+    }
+    return undefined;
+}
+
 export class Line {
     endPerformLine: number;   // 002 - stepOver in routines with "perform"
+    public cobolLine: string | undefined;
 
     public constructor
         (public fileCobol: string,
@@ -50,6 +71,7 @@ export class Line {
          public lineC: number,
          public functionName: string) {
         this.endPerformLine = -1;          // 002 - stepOver in routines with "perform"
+        this.cobolLine = lookupLineInCobolFile (fileCobol, lineCobol);
     }
 
     public toString(): string {