Merge pull request #4 from grahambates/disassembly_view

Port disassembly view from vscode-amiga-assembly

Author: matthiesenj

.vscode/launch.json

@@ -9,26 +9,11 @@
       "name": "Extension",
       "outFiles": ["${workspaceFolder}/out/**/*.js"],
       "request": "launch",
-      "type": "extensionHost"
-    },
-    {
-      "name": "Server",
-      "type": "node",
-      "request": "launch",
-      "cwd": "${workspaceFolder}",
-      "program": "${workspaceFolder}/src/debugAdapter.ts",
-      "args": ["--server=4711"],
-      "outFiles": ["${workspaceFolder}/out/**/*.js"],
+      "type": "extensionHost",
       "preLaunchTask": {
         "type": "npm",
         "script": "build-dev"
       }
     }
-  ],
-  "compounds": [
-    {
-      "name": "Extension + Server",
-      "configurations": ["Extension", "Server"]
-    }
   ]
 }

package.json

@@ -42,6 +42,20 @@
     "mame"
   ],
   "contributes": {
+    "views": {
+      "debug": [
+        {
+          "id": "disassembledMemory",
+          "name": "DISASSEMBLED MEMORY"
+        }
+      ]
+    },
+    "commands": [
+      {
+        "command": "disassembledMemory.setDisassembledMemory",
+        "title": "Set disassembled memory"
+      }
+    ],
     "breakpoints": [
       {
         "language": "m68k"
@@ -185,7 +199,11 @@
             "noDebug": true,
             "program": "${workspaceFolder}/build/myprogram.rom",
             "mappings": "${workspaceFolder}/build/mappings.txt",
-            "emulatorArgs": [ "-debug", "-debugger", "none" ],
+            "emulatorArgs": [
+              "-debug",
+              "-debugger",
+              "none"
+            ],
             "preLaunchTask": "build"
           }
         ],

src/debugSessionVsc.ts

@@ -0,0 +1,21 @@
+import * as vscode from "vscode";
+import { UAEDebugSession } from "./debugSession";
+
+export class UAEDebugSessionVsc extends UAEDebugSession {
+  protected currentMemoryViewPc = -1;
+
+  protected async onCpuFrame(address: number): Promise<void> {
+    super.onCpuFrame(address);
+    if (address !== this.currentMemoryViewPc) {
+      this.currentMemoryViewPc = address;
+      const dLines = await this.disassemblyManager().disassemble({
+        memoryReference: address.toString(),
+        instructionCount: 25,
+      });
+      await vscode.commands.executeCommand(
+        "disassembledMemory.setDisassembledMemory",
+        dLines
+      );
+    }
+  }
+}

src/index.ts

@@ -1,2 +1,88 @@
-// Intentionally left empty
-// Extension only provides debug adapter
+import * as vscode from "vscode";
+import { DebugProtocol } from "@vscode/debugprotocol";
+import { UAEDebugSessionVsc } from "./debugSessionVsc";
+
+export async function activate(
+  context: vscode.ExtensionContext
+): Promise<void> {
+  const disassembledMemoryDataProvider = new DisassembledMemoryDataProvider();
+  vscode.window.registerTreeDataProvider(
+    "disassembledMemory",
+    disassembledMemoryDataProvider
+  );
+
+  vscode.commands.registerCommand(
+    "disassembledMemory.setDisassembledMemory",
+    (memory: DebugProtocol.DisassembledInstruction[]) =>
+      disassembledMemoryDataProvider.setDisassembledMemory(memory)
+  );
+
+  context.subscriptions.push(
+    vscode.debug.registerDebugAdapterDescriptorFactory(
+      "mame-m68k-debugger",
+      new InlineDebugAdapterFactory()
+    )
+  );
+}
+
+class InlineDebugAdapterFactory
+  implements vscode.DebugAdapterDescriptorFactory
+{
+  createDebugAdapterDescriptor(
+    _session: vscode.DebugSession
+  ): vscode.ProviderResult<vscode.DebugAdapterDescriptor> {
+    // since DebugAdapterInlineImplementation is proposed API, a cast to <any> is required for now
+    return new (vscode as any).DebugAdapterInlineImplementation(
+      new UAEDebugSessionVsc()
+    );
+  }
+}
+
+export class DisassembledMemoryDataProvider
+  implements vscode.TreeDataProvider<ViewLineItem>
+{
+  private _onDidChangeTreeData: vscode.EventEmitter<ViewLineItem | undefined> =
+    new vscode.EventEmitter<ViewLineItem | undefined>();
+  readonly onDidChangeTreeData: vscode.Event<ViewLineItem | undefined> =
+    this._onDidChangeTreeData.event;
+  private currentValues?: Array<ViewLineItem>;
+
+  refresh(): void {
+    this._onDidChangeTreeData.fire(undefined);
+  }
+
+  getTreeItem(element: ViewLineItem): vscode.TreeItem {
+    return element;
+  }
+
+  async getChildren(element?: ViewLineItem): Promise<ViewLineItem[]> {
+    if (!element && this.currentValues) {
+      return this.currentValues;
+    } else {
+      return [];
+    }
+  }
+  setDisassembledMemory(memory: DebugProtocol.DisassembledInstruction[]): void {
+    this.currentValues = new Array<ViewLineItem>();
+    for (const dl of memory) {
+      const item = new ViewLineItem(`${dl.address}: ${dl.instruction}`);
+      if (dl.instructionBytes) {
+        item.description = dl.instructionBytes;
+      }
+      this.currentValues.push(item);
+    }
+    this.refresh();
+  }
+}
+
+export class ViewLineItem extends vscode.TreeItem {
+  public description = "";
+
+  constructor(label: string) {
+    super(label, vscode.TreeItemCollapsibleState.None);
+  }
+
+  getDescription(): string {
+    return this.description;
+  }
+}