Add cmake.cacheVariable command (#4422)

* Add cmake.cacheVariable for command substitution

* Add PR #4422 to CHANGELOG

* cacheVariable: report usage errors

* cacheVariable: configure before lookup if needed

* Fix "second argument of a localize call must be a string literal."

* move quotes into main localization string

Author: malsyned

CHANGELOG.md

@@ -8,6 +8,7 @@ Features:
 - Add a setting to enable/disable our built-in language services. [#4290](https://github.com/microsoft/vscode-cmake-tools/issues/4290)
 - Add an option to group the default build target dropdown using CMake groups [#3953](https://github.com/microsoft/vscode-cmake-tools/pull/3953) [@itzandroidtab](https://github.com/itzandroidtab)
 - Add `cmake.exclude` setting that allows users to set folders that they want the CMake Tools extension to ignore. [#4112](https://github.com/microsoft/vscode-cmake-tools/issues/4112)
+- Add a command to substitute CMake Cache variables in `launch.json` and `tasks.json`. [#4422](https://github.com/microsoft/vscode-cmake-tools/pull/4422)
 
 Improvements:
 

docs/debug-launch.md

@@ -186,8 +186,28 @@ Here are minimal examples of a `launch.json` file that uses `cmake.launchTargetP
 
 The value of the `program` attribute is expanded by CMake Tools to be the absolute path of the program to run.
 
+### Cache variable substitution
+
+You can substitute the value of any variable in the CMake cache by adding a `command`-type input for the `cmake.cacheVariable` command to the `inputs` section of `launch.json` with `args.name` as the name of the cache variable. That input can then be used with input variable substitution of values in the `configuration` section of `launch.json`. The optional `args.default` can provide a default value if the named variable isn't found in the CMake cache.
+
+```jsonc
+{
+    "version": "0.2.0",
+    "inputs": [
+        {
+            "id": "cmakeCache.TOOLCHAIN_FILE",
+            "type": "command",
+            "command": "cmake.cacheVariable",
+            "args": {
+                "name": "CMAKE_TOOLCHAIN_FILE"
+            }
+        }
+    ]
+}
+```
+
 > **Note:**
-> You must successfully [configure](configure.md) before `cmake.launchTargetPath` and `cmake.getLaunchTargetDirectory` will resolve correctly.
+> You must successfully [configure](configure.md) before `cmake.launchTargetPath`, `cmake.getLaunchTargetDirectory` and `cmake.cacheVariable` will resolve correctly.
 
 ## Debugging tests
 

package.json

@@ -35,6 +35,7 @@
   },
   "icon": "res/logo.png",
   "activationEvents": [
+    "onCommand:cmake.cacheVariable",
     "onCommand:cmake.activeFolderName",
     "onCommand:cmake.activeFolderPath",
     "onCommand:cmake.activeConfigurePresetName",

src/cmakeProject.ts

@@ -2874,6 +2874,22 @@ export class CMakeProject {
         return env;
     }
 
+    async cacheVariable(name?: string, defaultValue?: string): Promise<string | null> {
+        if (await this.needsReconfigure()) {
+            await this.configureInternal(ConfigureTrigger.api, [], ConfigureType.Normal);
+        }
+        if (!name) {
+            void vscode.window.showErrorMessage(localize('cachevariable.missing.required.argument.name', 'cacheVariable: missing required argument "name".'));
+            return null;
+        }
+        const value = (await CMakeCache.fromPath(await this.cachePath))?.get(name)?.value ?? defaultValue;
+        if (value === null || value === undefined) {
+            void vscode.window.showErrorMessage(localize('cachevariable.not.found', 'Variable "{0}" not found in CMake cache, and no default provided.', name));
+            return null;
+        }
+        return value;
+    }
+
     /**
      * Implementation of `cmake.debugTarget`
      */

src/extension.ts

@@ -1809,6 +1809,11 @@ export class ExtensionManager implements vscode.Disposable {
         return this.queryCMakeProject(cmakeProject => cmakeProject.tasksBuildCommand(), folder);
     }
 
+    cacheVariable(args: { name?: string; default?: string }) {
+        telemetry.logEvent("substitution", { input: "cacheVariable", ...args });
+        return this.queryCMakeProject(cmakeProject => cmakeProject.cacheVariable(args.name, args.default));
+    }
+
     debugTarget(folder?: vscode.WorkspaceFolder, name?: string, sourceDir?: string): Promise<vscode.DebugSession | null> {
         telemetry.logEvent("debug", { all: "false" });
         return this.runCMakeCommand(cmakeProject => cmakeProject.debugTarget(name), folder, undefined, true, sourceDir);
@@ -2371,6 +2376,7 @@ async function setup(context: vscode.ExtensionContext, progress?: ProgressHandle
         'buildType',
         'buildDirectory',
         'executableTargets',
+        'cacheVariable',
         'debugTarget',
         'debugTargetAll',
         'launchTarget',