refactor

Signed-off-by: Jens Reinecke <jens.reinecke@arm.com>

Author: jreineckearm

src/cbuild-run/cbuild-run-reader.ts

@@ -17,19 +17,46 @@
 import * as yaml from 'yaml';
 import { CbuildRunType } from './cbuild-run-types';
 import { FileReader, VscodeFileReader } from '../desktop/file-reader';
+import { getCmsisPackRootPath } from '../utils';
 
 const ROOT_NODE = 'cbuild-run';
+const CMSIS_PACK_ROOT_ENVVAR = '${CMSIS_PACK_ROOT}';
 
 export class CbuildRunReader {
+    private cbuildRun?: CbuildRunType;
+
     constructor(private reader: FileReader = new VscodeFileReader()) {}
 
-    public async parse(filePath: string): Promise<CbuildRunType> {
+    public hasContents(): boolean {
+        return !!this.cbuildRun;
+    }
+
+    public async parse(filePath: string): Promise<void> {
         const fileContents = await this.reader.readFileToString(filePath);
         const fileRoot = yaml.parse(fileContents);
-        const cbuildRun = fileRoot ? fileRoot[ROOT_NODE] : undefined;
-        if (!cbuildRun) {
+        this.cbuildRun = fileRoot ? fileRoot[ROOT_NODE] : undefined;
+        if (!this.cbuildRun) {
             throw new Error(`Invalid '*.cbuild-run.yml' file: ${filePath}`);
         }
-        return cbuildRun;
     }
+
+    public getSvdFilePaths(cmsisPackRoot?: string): string[] {
+        if (!this.cbuildRun) {
+            return [];
+        }
+        // Get SVD file descriptors
+        const systemDescriptions = this.cbuildRun['system-descriptions'];
+        const svdFileDescriptors = systemDescriptions?.filter(descriptor => descriptor.type === 'svd') ?? [];
+        if (svdFileDescriptors.length === 0) {
+            return [];
+        }
+        // Replace potential ${CMSIS_PACK_ROOT} placeholder
+        const effectiveCmsisPackRoot = cmsisPackRoot ?? getCmsisPackRootPath();
+        // Map to copies, leave originals untouched
+        const svdFilePaths = svdFileDescriptors.map(descriptor => `${effectiveCmsisPackRoot
+            ? descriptor.file.replaceAll(CMSIS_PACK_ROOT_ENVVAR, effectiveCmsisPackRoot)
+            : descriptor.file}`);
+        return svdFilePaths;
+    }
+
 }

src/debug-configuration/gdbtarget-configuration.ts

@@ -54,7 +54,7 @@ export interface TargetConfiguration {
 };
 
 interface CMSISConfiguration {
-    cbuildRunFile: string;
+    cbuildRunFile?: string;
 }
 
 export interface GDBTargetConfiguration extends vscode.DebugConfiguration {

src/debug-configuration/subproviders/base-configuration-provider.ts

@@ -16,13 +16,29 @@
 
 import * as vscode from 'vscode';
 import { GDBTargetConfiguration } from '../gdbtarget-configuration';
-import { CbuildRunReader, CbuildRunType } from '../../cbuild-run';
-import { getCmsisPackRootPath } from '../../utils';
+import { CbuildRunReader } from '../../cbuild-run';
+import { logger } from '../../logger';
 
 const DEFAULT_SVD_SETTING_NAME = 'definitionPath';
-const CMSIS_PACK_ROOT_ENVVAR = '${CMSIS_PACK_ROOT}';
 
 export abstract class BaseConfigurationProvider implements vscode.DebugConfigurationProvider {
+    protected _cbuildRunReader?: CbuildRunReader;
+
+    protected get cbuildRunReader(): CbuildRunReader {
+        this._cbuildRunReader ??= new CbuildRunReader();
+        return this._cbuildRunReader;
+    };
+
+    protected async parseCbuildRunFile(debugConfiguration: GDBTargetConfiguration): Promise<void> {
+        if (!debugConfiguration.cmsis?.cbuildRunFile?.length) {
+            return;
+        }
+        try {
+            await this.cbuildRunReader.parse(debugConfiguration.cmsis.cbuildRunFile);
+        } catch (error) {
+            logger.warn((error as Error).message);
+        }
+    }
 
     protected async commandExists(commandName: string): Promise<boolean> {
         const commands = await vscode.commands.getCommands();
@@ -37,29 +53,15 @@ export abstract class BaseConfigurationProvider implements vscode.DebugConfigura
         return !this.parameterExists(paramName, params) && (!commandName || await this.commandExists(commandName));
     }
 
-    protected async resolveSvdFile(debugConfiguration: GDBTargetConfiguration) {
+    protected resolveSvdFile(debugConfiguration: GDBTargetConfiguration) {
         const cbuildRunFilePath = debugConfiguration.cmsis?.cbuildRunFile;
         // 'definitionPath' is current default name for SVD file settings in Eclipse CDT Cloud Peripheral Inspector.
         if (debugConfiguration[DEFAULT_SVD_SETTING_NAME] || !cbuildRunFilePath?.length) {
             return;
         }
-        const cbuildRunReader = new CbuildRunReader();
-        let cbuildRunContents: CbuildRunType|undefined;
-        try {
-            cbuildRunContents = await cbuildRunReader.parse(cbuildRunFilePath);
-        } catch {
-            // Failed to read file, nothing to set
-            return;
-        }
-        const systemDescriptions = cbuildRunContents['system-descriptions'];
-        const svdFileDescriptors = systemDescriptions?.filter(descriptor => descriptor.type === 'svd') ?? [];
-        if (svdFileDescriptors.length === 0) {
-            return;
-        }
-        const cmsisPackRootValue = debugConfiguration?.target?.environment?.CMSIS_PACK_ROOT ?? getCmsisPackRootPath();
-        debugConfiguration[DEFAULT_SVD_SETTING_NAME] = cmsisPackRootValue
-            ? svdFileDescriptors[0].file.replaceAll(CMSIS_PACK_ROOT_ENVVAR, cmsisPackRootValue)
-            : svdFileDescriptors[0].file;
+        const svdFilePaths = this.cbuildRunReader.getSvdFilePaths(debugConfiguration?.target?.environment?.CMSIS_PACK_ROOT);
+        // Needs update when we better support multiple `debugger:` YAML nodes
+        debugConfiguration[DEFAULT_SVD_SETTING_NAME] = svdFilePaths[0];
     }
 
     protected abstract resolveServerParameters(debugConfiguration: GDBTargetConfiguration): Promise<GDBTargetConfiguration>;
@@ -69,7 +71,8 @@ export abstract class BaseConfigurationProvider implements vscode.DebugConfigura
         debugConfiguration: vscode.DebugConfiguration,
         _token?: vscode.CancellationToken
     ): Promise<vscode.DebugConfiguration | null | undefined> {
-        await this.resolveSvdFile(debugConfiguration);
+        await this.parseCbuildRunFile(debugConfiguration);
+        this.resolveSvdFile(debugConfiguration);
         return this.resolveServerParameters(debugConfiguration);
     }