Prefer use built-in pyocd if 'server' setting is 'pyocd' (#24)

use builtin pyocd if server says `pyocd` and if available in extension

---------

Signed-off-by: Jens Reinecke <[email protected]>

Author: jreineckearm

src/debug-configuration/gdbtarget-configuration.ts

@@ -40,7 +40,7 @@ interface UARTConfiguration {
     eolCharacter?: string;
 };
 
-interface TargetConfiguration {
+export interface TargetConfiguration {
     type?: string;
     parameters?: string[];
     host?: string;

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

@@ -16,11 +16,15 @@
 
 import * as vscode from 'vscode';
 import { logger } from '../../logger';
-import { GDBTargetConfiguration } from '../gdbtarget-configuration';
+import { GDBTargetConfiguration, TargetConfiguration } from '../gdbtarget-configuration';
+import { BuiltinToolPath } from '../../desktop/builtin-tool-path';
 
+const PYOCD_BUILTIN_PATH = 'tools/pyocd/pyocd';
+export const PYOCD_EXECUTABLE_ONLY_REGEXP = /^\s*pyocd(|.exe)\s*$/i;
 export const PYOCD_SERVER_TYPE_REGEXP = /.*pyocd(|.exe)\s*$/i;
 
 export class PyocdConfigurationProvider implements vscode.DebugConfigurationProvider {
+    protected builtinPyocd = new BuiltinToolPath(PYOCD_BUILTIN_PATH);
 
     protected async hasCommand(commandName: string): Promise<boolean> {
         const commands = await vscode.commands.getCommands();
@@ -35,10 +39,22 @@ export class PyocdConfigurationProvider implements vscode.DebugConfigurationProv
         return !this.hasParam(paramName, params) && (!commandName || await this.hasCommand(commandName));
     }
 
+    protected resolveServerPath(target: TargetConfiguration): void {
+        const targetServer = target.server;
+        const useBuiltin = !targetServer || PYOCD_EXECUTABLE_ONLY_REGEXP.test(targetServer);
+        const builtinUri = useBuiltin ? this.builtinPyocd.getAbsolutePath() : undefined;
+        if (builtinUri) {
+            target.server = builtinUri.fsPath;
+        }
+    }
+
     protected async resolveServerParameters(debugConfiguration: GDBTargetConfiguration): Promise<GDBTargetConfiguration> {
         if (!debugConfiguration.target) {
             return debugConfiguration;
         }
+        // server
+        this.resolveServerPath(debugConfiguration.target);
+        // serverParameters
         const parameters = debugConfiguration.target.serverParameters ??= [];
         // gdbserver
         if (await this.shouldAppendParam(parameters, 'gdbserver')) {

src/desktop/builtin-tool-path.ts

@@ -0,0 +1,36 @@
+/**
+ * Copyright 2025 Arm Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import assert from 'assert';
+import * as fs from 'fs';
+import { EXTENSION_ID } from '../manifest';
+import * as os from 'os';
+import * as vscode from 'vscode';
+
+const isWindows = os.platform() === 'win32';
+
+export class BuiltinToolPath {
+    constructor(protected toolPath: string) {
+        assert(toolPath.length, 'BuiltinToolManager: \'toolPath\' must not be empty');
+    }
+
+    public getAbsolutePath(): vscode.Uri | undefined {
+        const extensionUri = vscode.extensions.getExtension(EXTENSION_ID)?.extensionUri;
+        const absoluteUri = extensionUri?.with({ path: `${extensionUri.path}/${this.toolPath}${isWindows ? '.exe' : ''}` });
+        const fsPath = absoluteUri?.fsPath;
+        return (fsPath && fs.existsSync(fsPath)) ? absoluteUri : undefined;
+    }
+}

src/manifest.ts

@@ -14,5 +14,7 @@
  * limitations under the License.
  */
 
-export const PACKAGE_NAME = 'vscode-cmsis-debugger';
+export const PUBLISHER_NAME = 'arm';
+export const EXTENSION_NAME = 'vscode-cmsis-debugger';
+export const EXTENSION_ID = `${PUBLISHER_NAME}.${EXTENSION_NAME}`;
 export const DISPLAY_NAME = 'Arm CMSIS Debugger';