Reimplement the sidebar UI.

Author: whitequark

package.json

@@ -49,17 +49,20 @@
       {
         "command": "rtlDebugger.startSession",
         "category": "RTL Debugger",
-        "title": "Start Session"
+        "title": "Start Session",
+        "icon": "$(debug-start)"
       },
       {
         "command": "rtlDebugger.stopSession",
         "category": "RTL Debugger",
-        "title": "Stop Session"
+        "title": "Stop Session",
+        "icon": "$(debug-stop)"
       },
       {
         "command": "rtlDebugger.runSimulation",
         "category": "RTL Debugger",
-        "title": "Run Simulation"
+        "title": "Run Simulation",
+        "icon": "$(debug-continue)"
       },
       {
         "command": "rtlDebugger.runSimulationUntil",
@@ -69,17 +72,20 @@
       {
         "command": "rtlDebugger.pauseSimulation",
         "category": "RTL Debugger",
-        "title": "Pause Simulation"
+        "title": "Pause Simulation",
+        "icon": "$(debug-pause)"
       },
       {
         "command": "rtlDebugger.stepForward",
         "category": "RTL Debugger",
-        "title": "Step Forward"
+        "title": "Step Forward",
+        "icon": "$(debug-step-over)"
       },
       {
         "command": "rtlDebugger.stepBackward",
         "category": "RTL Debugger",
-        "title": "Step Backward"
+        "title": "Step Backward",
+        "icon": "$(debug-step-back)"
       }
     ],
     "viewsContainers": {
@@ -94,34 +100,21 @@
     "views": {
       "rtlDebugger": [
         {
-          "id": "rtlDebugger.hierarchy",
-          "name": "Hierarchy"
-        },
-        {
-          "id": "rtlDebugger.variables",
-          "name": "Variables"
+          "id": "rtlDebugger.sidebar",
+          "name": "Session"
         }
       ]
     },
     "viewsWelcome": [
       {
-        "view": "rtlDebugger.hierarchy",
+        "view": "rtlDebugger.sidebar",
         "contents": "The debug session is not running.\n[Start Session](command:rtlDebugger.startSession)",
         "when": "rtlDebugger.sessionStatus == absent"
       },
       {
-        "view": "rtlDebugger.hierarchy",
+        "view": "rtlDebugger.sidebar",
         "contents": "The debug session is initializing...",
         "when": "rtlDebugger.sessionStatus == starting"
-      },
-      {
-        "view": "rtlDebugger.hierarchy",
-        "contents": "There are no scopes in the simulation.",
-        "when": "rtlDebugger.sessionStatus == running"
-      },
-      {
-        "view": "rtlDebugger.variables",
-        "contents": "The selected scope is empty."
       }
     ],
     "menus": {
@@ -154,6 +147,38 @@
           "command": "rtlDebugger.stepBackward",
           "when": "rtlDebugger.sessionStatus == running"
         }
+      ],
+      "view/title": [
+        {
+          "command": "rtlDebugger.stepBackward",
+          "when": "view == rtlDebugger.sidebar && rtlDebugger.sessionStatus == running",
+          "group": "navigation@1"
+        },
+        {
+          "command": "rtlDebugger.stepForward",
+          "when": "view == rtlDebugger.sidebar && rtlDebugger.sessionStatus == running",
+          "group": "navigation@2"
+        },
+        {
+          "command": "rtlDebugger.runSimulation",
+          "when": "view == rtlDebugger.sidebar && rtlDebugger.sessionStatus == running && rtlDebugger.simulationStatus == paused",
+          "group": "navigation@3"
+        },
+        {
+          "command": "rtlDebugger.pauseSimulation",
+          "when": "view == rtlDebugger.sidebar && rtlDebugger.sessionStatus == running && rtlDebugger.simulationStatus == running",
+          "group": "navigation@3"
+        },
+        {
+          "command": "rtlDebugger.startSession",
+          "when": "view == rtlDebugger.sidebar && rtlDebugger.sessionStatus == absent",
+          "group": "navigation@4"
+        },
+        {
+          "command": "rtlDebugger.stopSession",
+          "when": "view == rtlDebugger.sidebar && rtlDebugger.sessionStatus == running",
+          "group": "navigation@5"
+        }
       ]
     }
   },

src/connection.ts

@@ -1,52 +1,13 @@
 import * as cxxrtlLink from './cxxrtl/link';
-import * as cxxrtlServer from './cxxrtl/server';
-import { TimeInterval, TimePoint } from './time';
-
-export interface ICXXRTLAgentError {
-    name: string;
-    message: string;
-}
-
-export interface ICXXRTLSourceLocation {
-    file: string;
-    startLine: number;
-    startColumn?: number;
-    endLine?: number;
-    endColumn?: number;
-}
-
-class YosysSourceLocation implements ICXXRTLSourceLocation {
-    constructor(
-        public file: string,
-        public startLine: number,
-        public startColumn?: number,
-        public endLine?: number,
-        public endColumn?: number,
-    ) {}
-
-    public static parse(src: string): YosysSourceLocation | null {
-        const matches = src.match(/^(.+?):(\d+)(?:\.(\d+)(?:-(\d+)\.(\d+)))?$/);
-        if (!matches) {
-            return null;
-        }
-        return new YosysSourceLocation(
-            matches[1],
-            parseInt(matches[2]),
-            matches.length >= 4 ? parseInt(matches[3]) : undefined,
-            matches.length >= 4 ? parseInt(matches[4]) : undefined,
-            matches.length >= 6 ? parseInt(matches[5]) : undefined,
-        );
-    }
-}
+import * as cxxrtlClient from './cxxrtl/client';
+import { TimeInterval, TimePoint } from './model/time';
 
 export enum CXXRTLDebugItemType {
     Node = "node",
     Memory = "memory"
 }
 
 export class CXXRTLDebugItem {
-    sourceLocations: ICXXRTLSourceLocation[] = [];
-
     constructor(
         public readonly name: string,
         public readonly type: CXXRTLDebugItemType,
@@ -156,10 +117,10 @@ export class CXXRTLSample {
 }
 
 export class CXXRTLConnection {
-    private connection: cxxrtlServer.Connection;
+    public connection: cxxrtlClient.Connection;
 
     constructor(link: cxxrtlLink.ILink) {
-        this.connection = new cxxrtlServer.Connection(link);
+        this.connection = new cxxrtlClient.Connection(link);
         this.connection.onEvent = async (event) => {
             console.log("event received", event);
         };
@@ -169,31 +130,7 @@ export class CXXRTLConnection {
         this.connection.dispose();
     }
 
-    public async listScopes(): Promise<string[]> {
-        const response = await this.connection.listScopes({
-            type: 'command',
-            command: 'list_scopes'
-        });
-        return Object.keys(response.scopes);
-    }
-
-    public async listItems(scope: string | null): Promise<Map<string, CXXRTLDebugItem>> {
-        const response = await this.connection.listItems({
-            type: 'command',
-            command: 'list_items',
-            scope
-        });
-        return new Map(Object.entries(response.items).map(([name, itemDesc]: [string, any]) => {
-            const debugItem = new CXXRTLDebugItem(name, itemDesc.type, itemDesc.width, itemDesc.lsb_at, itemDesc.depth, itemDesc.zero_at);
-            for (const rawSrc of (<{src: string}>itemDesc).src?.split('|') ?? []) {
-                const sourceLocation = YosysSourceLocation.parse(rawSrc);
-                if (sourceLocation !== null) {
-                    debugItem.sourceLocations.push(sourceLocation);
-                }
-            }
-            return [name, debugItem];
-        }));
-    }
+    // Everything below is deprecated
 
     public async referenceItems(name: string, designations: ICXXRTLDesignation[]): Promise<ICXXRTLReference> {
         await this.connection.referenceItems({

src/cxxrtl/client.ts

@@ -87,11 +87,18 @@ export class Connection {
     }
 
     private rejectPromises(error: Error): void {
-        for (const commandPromise of this.promises.splice(0, this.promises.length)) {
-            commandPromise.reject(error);
+        for (const promise of this.promises.splice(0, this.promises.length)) {
+            promise.reject(error);
         }
     }
 
+    private async perform(command: proto.AnyCommand): Promise<proto.AnyResponse> {
+        await this.send(command);
+        return new Promise((resolve, reject) => {
+            this.promises.push({ resolve, reject });
+        });
+    }
+
     public async onConnected(): Promise<void> {}
 
     public async onDisconnected(): Promise<void> {}
@@ -114,13 +121,6 @@ export class Connection {
         return this._itemValuesEncodings.slice();
     }
 
-    private async perform(command: proto.AnyCommand): Promise<proto.AnyResponse> {
-        await this.send(command);
-        return new Promise((resolve, reject) => {
-            this.promises.push({ resolve, reject });
-        });
-    }
-
     public async listScopes(command: proto.CommandListScopes): Promise<proto.ResponseListScopes> {
         return await this.perform(command) as proto.ResponseListScopes;
     }

src/cxxrtl/link.ts

@@ -1,18 +1,18 @@
 import * as stream from 'node:stream';
-import * as wire from './proto';
+import * as proto from './proto';
 
 export interface ILink {
     dispose(): void;
 
-    onRecv: (packet: wire.ServerPacket) => Promise<void>;
+    onRecv: (packet: proto.ServerPacket) => Promise<void>;
     onDone: () => Promise<void>;
 
-    send(packet: wire.ClientPacket): Promise<void>;
+    send(packet: proto.ClientPacket): Promise<void>;
 };
 
 export class MockLink implements ILink {
     constructor(
-        private conversation: [wire.ClientPacket, wire.ServerPacket | wire.ServerPacket[]][]
+        private conversation: [proto.ClientPacket, proto.ServerPacket | proto.ServerPacket[]][]
     ) {}
 
     public dispose(): void {
@@ -21,11 +21,11 @@ export class MockLink implements ILink {
         }
     }
 
-    public async onRecv(_serverPacket: wire.ServerPacket): Promise<void> {}
+    public async onRecv(_serverPacket: proto.ServerPacket): Promise<void> {}
 
     public async onDone(): Promise<void> {}
 
-    public async send(clientPacket: wire.ClientPacket): Promise<void> {
+    public async send(clientPacket: proto.ClientPacket): Promise<void> {
         if (this.conversation.length === 0) {
             throw new Error('premature end of conversation');
         }
@@ -84,7 +84,7 @@ export class NodeStreamLink implements ILink {
         this.stream.pause();
         for (const packetText of packetTexts) {
             try {
-                const packet = JSON.parse(packetText) as wire.ServerPacket;
+                const packet = JSON.parse(packetText) as proto.ServerPacket;
                 try {
                     await this.onRecv(packet);
                     this.stream.resume();
@@ -112,11 +112,11 @@ export class NodeStreamLink implements ILink {
         this.stream.destroy();
     }
 
-    public async onRecv(_serverPacket: wire.ServerPacket): Promise<void> {}
+    public async onRecv(_serverPacket: proto.ServerPacket): Promise<void> {}
 
     public async onDone(): Promise<void> {}
 
-    public async send(clientPacket: wire.ClientPacket): Promise<void> {
+    public async send(clientPacket: proto.ClientPacket): Promise<void> {
         this.stream.write(JSON.stringify(clientPacket) + '\0');
     }
 }