Add expandVSCodeVariables()

Author: vadimcn

extension/cargo.ts

@@ -10,7 +10,7 @@ import { inspect } from 'util';
 import { Dict } from './novsc/commonTypes';
 import { getExtensionConfig } from './main';
 import { output } from './logging';
-import { expandVariablesInObject } from './novsc/expand';
+import { expandVariables } from './novsc/expand';
 import { LaunchEnvironment } from 'codelldb';
 import { RpcServer, waitEndOfDebugSession } from './externalLaunch';
 import YAML from 'yaml';
@@ -310,7 +310,7 @@ export class Cargo {
         return cargo;
     }
 
-    getCargoCwd(cwd: string | undefined) : string {
+    getCargoCwd(cwd: string | undefined): string {
         return cwd ?? (this.workspaceFolder?.uri?.fsPath!);
     }
 }
@@ -357,16 +357,15 @@ async function runTask<T, R>(
 
 // Expands ${cargo: ...} placeholders.
 export function expandCargo(launchConfig: DebugConfiguration, cargoDict: Dict<string>): DebugConfiguration {
-    let expander = (type: string | null, key: string) => {
+    return expandVariables(launchConfig, (type, key) => {
         if (type == 'cargo') {
             let value = cargoDict[key];
             if (value == undefined)
                 throw new Error('cargo:' + key + ' is not defined');
             return value.toString();
         }
         return null;
-    };
-    return expandVariablesInObject(launchConfig, expander);
+    });
 }
 
 interface CargoConfigOptions {

extension/configUtils.ts

@@ -1,8 +1,10 @@
-import { QuickPickItem, WorkspaceConfiguration, DebugConfiguration, OutputChannel } from 'vscode';
+import { QuickPickItem, WorkspaceConfiguration, DebugConfiguration, OutputChannel, WorkspaceFolder, workspace } from 'vscode';
 import * as cp from 'child_process';
 import * as async from './novsc/async';
+import * as path from 'path';
+import * as os from 'os';
 import { Dict } from './novsc/commonTypes';
-import { expandVariablesInObject } from './novsc/expand';
+import { expandVariables } from './novsc/expand';
 
 // Expands variable references of the form ${dbgconfig:name} in all properties of launch configuration.
 export function expandDbgConfig(debugConfig: DebugConfiguration, dbgconfigConfig: WorkspaceConfiguration): DebugConfiguration {
@@ -27,12 +29,12 @@ export function expandDbgConfig(debugConfig: DebugConfiguration, dbgconfigConfig
         converged = true;
         for (let prop of Object.keys(dbgconfig)) {
             expanding = prop;
-            dbgconfig[prop] = expandVariablesInObject(dbgconfig[prop], expander);
+            dbgconfig[prop] = expandVariables(dbgconfig[prop], expander);
         }
     } while (!converged);
 
     // Now expand dbgconfigs in the launch configuration.
-    debugConfig = expandVariablesInObject(debugConfig, (type, key) => {
+    debugConfig = expandVariables(debugConfig, (type, key) => {
         if (type == 'dbgconfig') {
             let value = dbgconfig[key];
             if (value == undefined)
@@ -44,6 +46,30 @@ export function expandDbgConfig(debugConfig: DebugConfiguration, dbgconfigConfig
     return debugConfig;
 }
 
+export function expandVSCodeVariables<T extends any>(obj: T, folder?: WorkspaceFolder): T {
+    return expandVariables(obj, (type, key) => {
+        if (type == null) {
+            if (key == 'workspaceFolder') {
+                return folder ? folder.uri.fsPath : '';
+            } else if (key == 'workspaceFolderBasename') {
+                return folder ? path.basename(folder.uri.fsPath) : '';
+            } else if (key == 'userHome') {
+                return os.homedir();
+            } else if (key == 'pathSeparator' || key == '/') {
+                return path.sep;
+            } else {
+                return null;
+            }
+        } else if (type == 'env') {
+            return process.env[key] ?? '';
+        } else if (type == 'config') {
+            return workspace.getConfiguration(undefined, folder).get<string>(key) ?? '';
+        } else {
+            return null;
+        }
+    });
+}
+
 export function isEmpty(obj: any): boolean {
     if (obj === null || obj === undefined)
         return true;

extension/main.ts

@@ -29,6 +29,7 @@ import { LaunchCompletionProvider } from './launchCompletions';
 import { output, showErrorWithLog } from './logging';
 import { LLDBCommandTool, SessionInfoTool } from './vibeDebug';
 import { alternateBackend, selfTest, commandPrompt } from './adapterUtils';
+import { expandVSCodeVariables } from './configUtils';
 
 export function getExtensionConfig(scope?: ConfigurationScope, subkey?: string): WorkspaceConfiguration {
     let key = 'lldb';
@@ -438,10 +439,10 @@ class Extension implements DebugAdapterDescriptorFactory {
         let authToken = crypto.randomBytes(16).toString('base64');
         return {
             extensionPath: this.context.extensionPath,
-            liblldb: liblldb,
-            lldbServer: lldbServer,
-            extraEnv: adapterEnv,
-            workDir: workspace.rootPath,
+            liblldb: expandVSCodeVariables(liblldb, folder),
+            lldbServer: expandVSCodeVariables(lldbServer, folder),
+            extraEnv: expandVSCodeVariables(adapterEnv, folder),
+            workDir: folder?.uri.fsPath,
             port: port,
             connect: true,
             authToken: authToken,

extension/novsc/expand.ts

@@ -1,30 +1,31 @@
+import { Dict } from "./commonTypes";
 
 // Returning null means "keep the original text".
 type Expander = (type: string | null, key: string) => string | null;
 
 let expandVarRegex = /\$\{(?:([^:}]+):)?([^}]+)\}/g;
 
-export function expandVariables(str: string | String, expander: Expander): string {
-    let result = str.replace(expandVarRegex, (all: string, type: string, key: string): string => {
-        let replacement = expander(type, key);
-        return replacement != null ? replacement : all;
-    });
-    return result;
-}
+export function expandVariables<T extends any>(obj: T, expander: Expander): T {
+    if (obj === undefined || obj === null)
+        return obj;
 
-export function expandVariablesInObject(obj: any, expander: Expander): any {
-    if (typeof obj == 'string' || obj instanceof String)
-        return expandVariables(obj, expander);
+    if (typeof obj == 'string' || obj instanceof String) {
+        return obj.replace(expandVarRegex, (all: string, type: string, key: string): string => {
+            let replacement = expander(type, key);
+            return replacement != null ? replacement : all;
+        }) as T;
+    }
 
     if (isScalarValue(obj))
         return obj;
 
     if (obj instanceof Array)
-        return obj.map(v => expandVariablesInObject(v, expander));
+        return obj.map(v => expandVariables(v, expander)) as T;
 
-    for (let prop of Object.keys(obj))
-        obj[prop] = expandVariablesInObject(obj[prop], expander)
-    return obj;
+    let result: Dict<any> = {};
+    for (let prop of Object.getOwnPropertyNames(obj))
+        result[prop] = expandVariables((obj as Dict<any>)[prop], expander);
+    return result as T;
 }
 
 function isScalarValue(value: any): boolean {

tests/util.test.ts

@@ -15,7 +15,7 @@ suite('Versions', () => {
 
 suite('Util', () => {
     test('expandVariables', async () => {
-        function expander(type: string, key: string) {
+        function expander(type: string | null, key: string) {
             if (type == 'echo') return key;
             if (type == 'reverse') return key.split('').reverse().join('');
             throw new Error('Unknown ' + type + ' ' + key);