Honor debugger.workingDirectory from CMake File API when debugging targets (#4753)

* Initial plan

* feat: honor debugger.workingDirectory from CMake File API when debugging targets

- Add `debugger` property to CodeModelKind.TargetObject to parse the
  debugger.workingDirectory field from CMake File API target JSON
- Thread debuggerWorkingDirectory through RichTarget and ExecutableTarget
- Use debuggerWorkingDirectory as cwd in GDB, LLDB, and MSVC debug
  configurations, falling back to the target's build directory
- Add DEBUGGER_WORKING_DIRECTORY and CMAKE_DEBUGGER_WORKING_DIRECTORY
  entries to assets/variables.json

Co-authored-by: snehara99 <113148726+snehara99@users.noreply.github.com>

* revert: undo changes to assets/variables.json (updated via script separately)

Co-authored-by: snehara99 <113148726+snehara99@users.noreply.github.com>

* Add changelog entry for debugger.workingDirectory support (#4595)

Co-authored-by: snehara99 <113148726+snehara99@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: snehara99 <113148726+snehara99@users.noreply.github.com>

Author: Copilot

CHANGELOG.md

@@ -24,6 +24,7 @@ Improvements:
 - Allow preset modification commands to target CMakeUserPresets.json. The target file is determined by the focused editor, or by prompting the user when both files exist. [#4564](https://github.com/microsoft/vscode-cmake-tools/issues/4564)
 - Display info tooltip when hovering over CMake policy identifiers (e.g., `CMP0177`), showing the CMake version that introduced the policy, a short description, and a link to the official documentation. [#4544](https://github.com/microsoft/vscode-cmake-tools/issues/4544)
 - Append `cmake` to diagnostics that this extension contributes to the Problems Pane. [PR #4766](https://github.com/microsoft/vscode-cmake-tools/pull/4766)
+- Honor `debugger.workingDirectory` from the CMake File API when debugging a target, so that the `DEBUGGER_WORKING_DIRECTORY` target property is used as the debugger working directory. [#4595](https://github.com/microsoft/vscode-cmake-tools/issues/4595)
 
 Bug Fixes:
 - Fix configure/build sometimes using stale preset values when unsaved changes to included preset files are auto-saved before configure. The extension now explicitly refreshes presets from disk after saving, instead of relying solely on the asynchronous file watcher. [#4502](https://github.com/microsoft/vscode-cmake-tools/issues/4502)

src/debug/debugger.ts

@@ -95,7 +95,7 @@ async function createGDBDebugConfiguration(debuggerPath: string, target: Executa
         type: 'cppdbg',
         name: `Debug ${target.name}`,
         request: 'launch',
-        cwd: path.dirname(target.path),
+        cwd: target.debuggerWorkingDirectory || path.dirname(target.path),
         args: [],
         MIMode: MIModes.gdb,
         miDebuggerPath: debuggerPath,
@@ -127,7 +127,7 @@ async function createLLDBDebugConfiguration(debuggerPath: string, target: Execut
         type: 'cppdbg',
         name: `Debug ${target.name}`,
         request: 'launch',
-        cwd: path.dirname(target.path),
+        cwd: target.debuggerWorkingDirectory || path.dirname(target.path),
         args: [],
         MIMode: MIModes.lldb,
         miDebuggerPath: debuggerPath,
@@ -146,7 +146,7 @@ function createMsvcDebugConfiguration(target: ExecutableTarget): VSCodeDebugConf
         type: 'cppvsdbg',
         name: `Debug ${target.name}`,
         request: 'launch',
-        cwd: path.dirname(target.path),
+        cwd: target.debuggerWorkingDirectory || path.dirname(target.path),
         args: [],
         program: target.path
     };

src/drivers/cmakeDriver.ts

@@ -95,6 +95,10 @@ export interface ExecutableTarget {
      * The install locations of the target.
      */
     isInstallTarget?: boolean;
+    /**
+     * The working directory for the debugger, from the DEBUGGER_WORKING_DIRECTORY target property.
+     */
+    debuggerWorkingDirectory?: string;
 }
 
 /**
@@ -124,6 +128,7 @@ export interface RichTarget {
     targetType: string;
     folder?: CodeModelKind.TargetObject;
     installPaths?: InstallPath[];
+    debuggerWorkingDirectory?: string;
 }
 
 export type Target = NamedTarget | RichTarget;

src/drivers/cmakeFileApi.ts

@@ -171,6 +171,10 @@ export namespace CodeModelKind {
         name: string;
     }
 
+    export interface DebuggerInfo {
+        workingDirectory?: string;
+    }
+
     export interface TargetObject {
         name: string;
         type: string;
@@ -183,6 +187,7 @@ export namespace CodeModelKind {
         folder?: Folder;
         isGeneratorProvided?: boolean;
         install?: InstallInfo;
+        debugger?: DebuggerInfo;
     }
 }
 
@@ -427,7 +432,8 @@ async function convertTargetObjectFileToExtensionTarget(buildDirectory: string,
         targetType: targetObject.type,
         folder: targetObject.folder,
         type: 'rich' as 'rich',
-        installPaths: installPaths
+        installPaths: installPaths,
+        debuggerWorkingDirectory: targetObject.debugger?.workingDirectory
     } as RichTarget;
 }
 

src/drivers/cmakeFileApiDriver.ts

@@ -428,7 +428,8 @@ export class CMakeFileApiDriver extends CMakeDriver {
         const executableTargetsWithInstall = uniqueExecTargets.map(t => ({
             name: t.name,
             path: (t as RichTarget).filepath,
-            isInstallTarget: false
+            isInstallTarget: false,
+            debuggerWorkingDirectory: (t as RichTarget).debuggerWorkingDirectory
         }));
 
         const installLoc = localize("cmake.install.name", "Install");
@@ -440,7 +441,8 @@ export class CMakeFileApiDriver extends CMakeDriver {
                     executableTargetsWithInstall.push({
                         name: `${target.name} (${installLoc}${includePath ? ` - ${installPath.subPath}` : ''})`,
                         path: installPath.path,
-                        isInstallTarget: true
+                        isInstallTarget: true,
+                        debuggerWorkingDirectory: target.debuggerWorkingDirectory
                     });
                 }
             }