implement export registers feature (#33)

* implement export registers feature * implement export registers feature * implement export registers feature * implement export registers feature
eclipse-cdt-cloud · Dec 31, 2024 · 89663e2 · 89663e2
1 parent 5787e16
commit 89663e2
Show file tree

Hide file tree

Showing 12 changed files with 223 additions and 6 deletions.
diff --git a/package.json b/package.json
@@ -53,7 +53,8 @@
     "vscode-messenger": "^0.4.5",
     "vscode-messenger-common": "^0.4.5",
     "vscode-messenger-webview": "^0.4.5",
-    "xml2js": "^0.4.23"
+    "xml2js": "^0.4.23",
+    "xmlbuilder2": "^3.0.0"
   },
   "devDependencies": {
     "@types/node": "^12.20.0",
@@ -97,6 +98,11 @@
         "title": "Update Value",
         "icon": "$(edit)"
       },
+      {
+        "command": "peripheral-inspector.svd.exportNode",
+        "title": "Export Register",
+        "icon": "$(desktop-download)"
+      },
       {
         "command": "peripheral-inspector.svd.copyValue",
         "title": "Copy Value",
@@ -131,6 +137,11 @@
         "command": "peripheral-inspector.svd.collapseAll",
         "title": "Collapse All",
         "icon": "$(collapse-all)"
+      },
+      {
+        "command": "peripheral-inspector.svd.exportAll",
+        "title": "Export All",
+        "icon": "$(desktop-download)"
       }
     ],
     "menus": {
@@ -143,6 +154,14 @@
           "command": "peripheral-inspector.svd.copyValue",
           "when": "false"
         },
+        {
+          "command": "peripheral-inspector.svd.exportNode",
+          "when": "false"
+        },
+        {
+          "command": "peripheral-inspector.svd.exportAll",
+          "when": "false"
+        },
         {
           "command": "peripheral-inspector.svd.forceRefresh",
           "when": "false"
@@ -181,6 +200,26 @@
           "command": "peripheral-inspector.svd.forceRefresh",
           "when": "view == peripheral-inspector.svd && viewItem =~ /peripheral.*/"
         },
+        {
+          "command": "peripheral-inspector.svd.exportNode",
+          "when": "view == peripheral-inspector.svd && viewItem == cluster"
+        },
+        {
+          "command": "peripheral-inspector.svd.exportNode",
+          "when": "view == peripheral-inspector.svd && viewItem == registerRW"
+        },
+        {
+          "command": "peripheral-inspector.svd.exportNode",
+          "when": "view == peripheral-inspector.svd && viewItem == register"
+        },
+        {
+          "command": "peripheral-inspector.svd.exportNode",
+          "when": "view == peripheral-inspector.svd && viewItem == registerRO"
+        },
+        {
+          "command": "peripheral-inspector.svd.exportNode",
+          "when": "view == peripheral-inspector.svd"
+        },
         {
           "command": "peripheral-inspector.svd.pin",
           "when": "view == peripheral-inspector.svd && viewItem == peripheral"
@@ -200,6 +239,11 @@
           "command": "peripheral-inspector.svd.collapseAll",
           "when": "view =~ /peripheral-inspector.peripheral-*/ && debugState == stopped",
           "group": "navigation"
+        },
+        {
+          "command": "peripheral-inspector.svd.exportAll",
+          "when": "view =~ /peripheral-inspector.peripheral-*/ && debugState == stopped",
+          "group": "navigation"
         }
       ],
       "webview/context": [
@@ -264,4 +308,4 @@
     "workspace",
     "ui"
   ]
-}
+}
diff --git a/src/commands.ts b/src/commands.ts
@@ -13,6 +13,7 @@ import { CTDTreeWebviewContext } from './components/tree/types';
 import { Commands } from './manifest';
 import { PeripheralBaseNode } from './plugin/peripheral/nodes';
 import { PeripheralDataTracker } from './plugin/peripheral/tree/peripheral-data-tracker';
+import { getFilePath } from './fileUtils';
 
 export class PeripheralCommands {
     public constructor(
@@ -22,13 +23,15 @@ export class PeripheralCommands {
     public async activate(context: vscode.ExtensionContext): Promise<void> {
         context.subscriptions.push(
             vscode.commands.registerCommand(Commands.UPDATE_NODE_COMMAND.commandId, (node, value) => this.peripheralsUpdateNode(node, value)),
+            vscode.commands.registerCommand(Commands.EXPORT_NODE_COMMAND.commandId, node => this.peripheralsExportNode(node)),
             vscode.commands.registerCommand(Commands.COPY_VALUE_COMMAND.commandId, (node, value) => this.peripheralsCopyValue(node, value)),
             vscode.commands.registerCommand(Commands.SET_FORMAT_COMMAND.commandId, (node) => this.peripheralsSetFormat(node)),
             vscode.commands.registerCommand(Commands.FORCE_REFRESH_COMMAND.commandId, (node) => this.peripheralsForceRefresh(node)),
             vscode.commands.registerCommand(Commands.PIN_COMMAND.commandId, (node, _, context) => this.peripheralsTogglePin(node, context)),
             vscode.commands.registerCommand(Commands.UNPIN_COMMAND.commandId, (node, _, context) => this.peripheralsTogglePin(node, context)),
             vscode.commands.registerCommand(Commands.REFRESH_ALL_COMMAND.commandId, () => this.peripheralsForceRefresh()),
             vscode.commands.registerCommand(Commands.COLLAPSE_ALL_COMMAND.commandId, () => this.collapseAll()),
+            vscode.commands.registerCommand(Commands.EXPORT_ALL_COMMAND.commandId, () => this.peripheralsExportAll()),
         );
     }
 
@@ -45,6 +48,26 @@ export class PeripheralCommands {
         }
     }
 
+    private async peripheralsExportNode(
+        node: PeripheralBaseNode,
+    ): Promise<void> {
+        const filePath = await getFilePath();
+        if (!filePath) {
+            this.dataTracker.fireOnDidChange();
+            return;
+        }
+        this.dataTracker.exportNodeToXml(node, filePath);
+    }
+
+    private async peripheralsExportAll(): Promise<void> {
+        const filePath = await getFilePath();
+        if (!filePath) {
+            this.dataTracker.fireOnDidChange();
+            return;
+        }
+        this.dataTracker.exportAllNodesToXml(filePath);
+    }
+
     private peripheralsCopyValue(_node: PeripheralBaseNode, value?: string): void {
         if (value) {
             vscode.env.clipboard.writeText(value);

diff --git a/src/common/peripheral-dto.ts b/src/common/peripheral-dto.ts
@@ -42,6 +42,7 @@ export namespace PeripheralBaseTreeNodeDTO {
 
 export const PERIPHERAL_ID_SEP = '-';
 export interface PeripheralBaseNodeDTO extends PeripheralBaseTreeNodeDTO {
+    name: string;
     format: NumberFormat;
     pinned?: boolean;
     session: string | undefined;
@@ -159,6 +160,7 @@ export interface PeripheralRegisterNodeDTO extends ClusterOrRegisterBaseNodeDTO,
     resetValue: number;
     hexLength: number;
     offset: number;
+    size: number;
     address: number;
 }
 export namespace PeripheralRegisterNodeDTO {

diff --git a/src/components/tree/integration/peripheral-tree-converter.ts b/src/components/tree/integration/peripheral-tree-converter.ts
@@ -90,7 +90,7 @@ export class PeripheralNodeConverter implements TreeResourceConverter<Peripheral
             },
             'actions': {
                 type: 'action',
-                commands: [Commands.FORCE_REFRESH_COMMAND]
+                commands: [Commands.FORCE_REFRESH_COMMAND, Commands.EXPORT_NODE_COMMAND]
             }
         };
     }
@@ -127,9 +127,9 @@ export class PeripheralRegisterNodeConverter implements TreeResourceConverter<Pe
 
         switch (contextValue) {
             case 'registerRO':
-                return [copyValue, Commands.FORCE_REFRESH_COMMAND];
+                return [copyValue, Commands.FORCE_REFRESH_COMMAND, Commands.EXPORT_NODE_COMMAND];
             case 'registerRW':
-                return [copyValue, Commands.FORCE_REFRESH_COMMAND, updateNode];
+                return [copyValue, Commands.FORCE_REFRESH_COMMAND, updateNode, Commands.EXPORT_NODE_COMMAND];
             case 'registerWO':
                 return [];
             default:
@@ -256,6 +256,11 @@ export class PeripheralClusterNodeConverter {
 
     // ==== Rendering ====
 
+    private getCommands(): CDTTreeTableActionColumnCommand[] {
+
+        return [Commands.EXPORT_NODE_COMMAND];
+    }
+
     private getColumns(peripheral: PeripheralClusterNodeDTO, _context: TreeConverterContext<PeripheralTreeNodeDTOs>): Record<string, CDTTreeTableColumn> {
         const labelValue = hexFormat(peripheral.offset, 0);
 
@@ -269,6 +274,10 @@ export class PeripheralClusterNodeConverter {
                 type: 'string',
                 label: labelValue,
                 tooltip: labelValue
+            },
+            'actions': {
+                type: 'action',
+                commands: this.getCommands()
             }
         };
     }

diff --git a/src/fileUtils.ts b/src/fileUtils.ts
@@ -0,0 +1,16 @@
+import * as vscode from 'vscode';
+
+export async function getFilePath(): Promise<vscode.Uri | undefined> {
+    const workspaceFolder = vscode.workspace.workspaceFolders ? vscode.workspace.workspaceFolders[0].uri : undefined;
+    if (!workspaceFolder) {
+        return;
+    }
+    const defaultFilePath = vscode.Uri.joinPath(workspaceFolder, 'registers.xml');
+    const fileUri = await vscode.window.showSaveDialog({
+        defaultUri: defaultFilePath,
+        filters: {
+            'xml': ['xml'],
+        },
+    });
+    return fileUri;
+}
diff --git a/src/manifest.ts b/src/manifest.ts
@@ -29,6 +29,11 @@ export namespace Commands {
         icon: 'edit',
         title: 'Update Value'
     } as const;
+    export const EXPORT_NODE_COMMAND: CommandDefinition = {
+        commandId: `${PACKAGE_NAME}.svd.exportNode`,
+        icon: 'desktop-download',
+        title: 'Export Register'
+    } as const;
     export const COPY_VALUE_COMMAND: CommandDefinition = {
         commandId: `${PACKAGE_NAME}.svd.copyValue`,
         icon: 'files',
@@ -64,6 +69,11 @@ export namespace Commands {
         icon: 'collapse-all',
         title: 'Collapse All'
     } as const;
+    export const EXPORT_ALL_COMMAND: CommandDefinition = {
+        commandId: `${PACKAGE_NAME}.svd.exportAll`,
+        icon: 'desktop-download',
+        title: 'Export All'
+    } as const;
 }
 
 export namespace IgnorePeripherals {

diff --git a/src/plugin/peripheral/nodes/base-node.ts b/src/plugin/peripheral/nodes/base-node.ts
@@ -90,6 +90,7 @@ export abstract class PeripheralBaseNode extends BaseTreeNode {
         return PeripheralBaseNodeDTO.create({
             ...super.serialize(),
             id: this.getId(),
+            name: this.name || '',
             format: this.format,
             pinned: this.pinned,
             session: this.session?.id,

diff --git a/src/plugin/peripheral/nodes/peripheral-cluster-node.ts b/src/plugin/peripheral/nodes/peripheral-cluster-node.ts
@@ -144,6 +144,7 @@ export class PeripheralClusterNode extends ClusterOrRegisterBaseNode {
         return PeripheralClusterNodeDTO.create({
             ...super.serialize(),
             ...this.options,
+            name: this.name,
             offset: this.offset,
             children: []
         });

diff --git a/src/plugin/peripheral/nodes/peripheral-field-node.ts b/src/plugin/peripheral/nodes/peripheral-field-node.ts
@@ -174,6 +174,7 @@ export class PeripheralFieldNode extends PeripheralBaseNode {
         return PeripheralFieldNodeDTO.create({
             ...super.serialize(),
             ...this.options,
+            name: this.name,
             parentAddress: this.parent.getAddress(),
             previousValue: this.previousValue,
             currentValue: this.getCurrentValue(),

diff --git a/src/plugin/peripheral/nodes/peripheral-node.ts b/src/plugin/peripheral/nodes/peripheral-node.ts
@@ -229,6 +229,7 @@ export class PeripheralNode extends PeripheralBaseNode {
             ...super.serialize(),
             ...this.options,
             groupName: this.groupName,
+            name: this.name,
             children: []
         });
     }

diff --git a/src/plugin/peripheral/nodes/peripheral-register-node.ts b/src/plugin/peripheral/nodes/peripheral-register-node.ts
@@ -208,10 +208,12 @@ export class PeripheralRegisterNode extends ClusterOrRegisterBaseNode {
         return PeripheralRegisterNodeDTO.create({
             ...super.serialize(),
             ...this.options,
+            name: this.name,
             previousValue: this.previousValue,
             currentValue: this.currentValue,
             resetValue: this.resetValue,
             offset: this.offset,
+            size: this.size,
             hexLength: this.hexLength,
             children: [],
             address: this.getAddress()