add "add configuration" feature (ready) (#9226)

Elaheh Rashedi · web-flow · commit 91380b3f585e · 2022-04-29T13:51:05.000-07:00
diff --git a/Extension/package.json b/Extension/package.json
@@ -50,7 +50,6 @@
     "onLanguage:cuda-cpp",
     "onCommand:extension.pickNativeProcess",
     "onCommand:extension.pickRemoteNativeProcess",
-    "onCommand:C_Cpp.BuildAndDebugActiveFile",
     "onCommand:C_Cpp.RestartIntelliSenseForFile",
     "onCommand:C_Cpp.ConfigurationEditJSON",
     "onCommand:C_Cpp.ConfigurationEditUI",
@@ -2752,6 +2751,12 @@
         "title": "%c_cpp.command.BuildAndRunFile.title%",
         "category": "C/C++",
         "icon": "$(run)"
+      },
+      {
+        "command": "C_Cpp.AddDebugConfiguration",
+        "title": "%c_cpp.command.AddDebugConfiguration.title%",
+        "category": "C/C++",
+        "icon": "$(debug-configure)"      
       }
     ],
     "keybindings": [
@@ -3883,31 +3888,43 @@
           "group": "navigation@1"
         }
       ],
+      "editor/title": [
+        {
+          "command": "C_Cpp.AddDebugConfiguration",
+          "when": "editorLangId == 'c' && config.C_Cpp.debugShortcut && BuildAndDebug.isSourceFile && BuildAndDebug.isFolderOpen || editorLangId == 'cpp' && config.C_Cpp.debugShortcut && BuildAndDebug.isSourceFile && BuildAndDebug.isFolderOpen || editorLangId == 'cuda-cpp' && config.C_Cpp.debugShortcut && BuildAndDebug.isSourceFile && BuildAndDebug.isFolderOpen",
+          "group": "navigation"
+        }
+      ],
       "editor/context": [
         {
           "when": "editorLangId == 'c' || editorLangId == 'cpp' || editorLangId == 'cuda-cpp'",
           "command": "C_Cpp.SwitchHeaderSource",
-          "group": "other1_navigation@1"
+          "group": "custom1@1"
         },
         {
           "when": "editorLangId == 'c' || editorLangId == 'cpp' || editorLangId == 'cuda-cpp'",
           "command": "workbench.action.gotoSymbol",
-          "group": "other1_navigation@3"
+          "group": "custom1@2"
         },
         {
           "when": "editorLangId == 'c' || editorLangId == 'cpp' || editorLangId == 'cuda-cpp'",
           "command": "workbench.action.showAllSymbols",
-          "group": "other1_navigation@4"
+          "group": "custom1@3"
         },
         {
-          "when": "editorLangId == 'c' || editorLangId == 'cpp' || editorLangId == 'cuda-cpp'",
           "command": "C_Cpp.RunCodeAnalysisOnActiveFile",
-          "group": "other2@2"
+          "when": "editorLangId == 'c' || editorLangId == 'cpp' || editorLangId == 'cuda-cpp'",
+          "group": "custom2@1"
         },
         {
-          "when": "editorLangId == 'c' || editorLangId == 'cpp' || editorLangId == 'cuda-cpp'",
           "command": "C_Cpp.RestartIntelliSenseForFile",
-          "group": "other2@3"
+          "when": "editorLangId == 'c' || editorLangId == 'cpp' || editorLangId == 'cuda-cpp'",
+          "group": "custom2@2"
+        },
+        {
+          "command": "C_Cpp.AddDebugConfiguration",
+          "when": "editorLangId == 'c' && config.C_Cpp.debugShortcut && BuildAndDebug.isSourceFile && BuildAndDebug.isFolderOpen || editorLangId == 'cpp' && config.C_Cpp.debugShortcut && BuildAndDebug.isSourceFile && BuildAndDebug.isFolderOpen || editorLangId == 'cuda-cpp' && config.C_Cpp.debugShortcut && BuildAndDebug.isSourceFile && BuildAndDebug.isFolderOpen",
+          "group": "custom2@3"
         }
       ],
       "commandPalette": [
diff --git a/Extension/package.nls.json b/Extension/package.nls.json
@@ -27,6 +27,7 @@
     "c_cpp.command.ClearCodeAnalysisSquiggles.title": "Clear Code Analysis Squiggles",
     "c_cpp.command.BuildAndDebugFile.title": "Debug C/C++ File",
     "c_cpp.command.BuildAndRunFile.title": "Run C/C++ File",
+    "c_cpp.command.AddDebugConfiguration.title": "Add Debug Configuration",
     "c_cpp.configuration.maxConcurrentThreads.markdownDescription": { "message": "The maximum number of concurrent threads to use for language service processing. The value is a hint and may not always be used. The default of `null` (empty) uses the number of logical processors available.", "comment": [ "Markdown text between `` should not be translated or localized (they represent literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered." ] },
     "c_cpp.configuration.maxCachedProcesses.markdownDescription": { "message": "The maximum number of cached processes to use for language service processing. The default of `null` (empty) uses twice the number of logical processors available.", "comment": [ "Markdown text between `` should not be translated or localized (they represent literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered." ] },
     "c_cpp.configuration.maxMemory.markdownDescription": { "message": "The maximum memory (in MB) available for language service processing. Fewer processes will be cached and run concurrently after this memory usage is exceeded. The default of `null` (empty) uses the system's free memory.", "comment": [ "Markdown text between `` should not be translated or localized (they represent literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered." ] },
diff --git a/Extension/src/Debugger/configurationProvider.ts b/Extension/src/Debugger/configurationProvider.ts
@@ -14,10 +14,10 @@ import * as Telemetry from '../telemetry';
 import * as logger from '../logger';
 import * as nls from 'vscode-nls';
 import { IConfiguration, IConfigurationSnippet, DebuggerType, DebuggerEvent, MIConfigurations, WindowsConfigurations, WSLConfigurations, PipeTransportConfigurations } from './configurations';
-import { parse } from 'comment-json';
+import * as jsonc from 'comment-json';
 import { PlatformInformation } from '../platform';
 import { Environment, ParsedEnvironmentFile } from './ParsedEnvironmentFile';
-import { CppSettings } from '../LanguageServer/settings';
+import { CppSettings, OtherSettings } from '../LanguageServer/settings';
 import { configPrefix } from '../LanguageServer/extension';
 
 nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })();
@@ -593,13 +593,93 @@ export class DebugConfigurationProvider implements vscode.DebugConfigurationProv
         return false;
     }
 
+    private getLaunchJsonPath(): string | undefined {
+        return util.getJsonPath("launch.json");
+    }
+
+    public getRawLaunchJson(): Promise<any> {
+        const path: string | undefined = this.getLaunchJsonPath();
+        return util.getRawJson(path);
+    }
+
+    public async writeDebugConfig(config: vscode.DebugConfiguration, folder?: vscode.WorkspaceFolder): Promise<void> {
+        const launchJsonPath: string | undefined = this.getLaunchJsonPath();
+
+        if (this.checkDebugConfigExists(config.name, folder)) {
+            if (launchJsonPath) {
+                const doc: vscode.TextDocument = await vscode.workspace.openTextDocument(launchJsonPath);
+                if (doc) {
+                    vscode.window.showTextDocument(doc);
+                }
+            }
+            return;
+        }
+        const rawLaunchJson: any = await this.getRawLaunchJson();
+        if (!rawLaunchJson.configurations) {
+            rawLaunchJson.configurations = new Array();
+        }
+        if (!rawLaunchJson.version) {
+            rawLaunchJson.version = "2.0.0";
+        }
+
+        config.detail = undefined;
+        config.existing = undefined;
+        config.isDefault = undefined;
+        rawLaunchJson.configurations.push(config);
+
+        if (!launchJsonPath) {
+            throw new Error("Failed to get tasksJsonPath in checkBuildTaskExists()");
+        }
+
+        const settings: OtherSettings = new OtherSettings();
+        await util.writeFileText(launchJsonPath, jsonc.stringify(rawLaunchJson, null, settings.editorTabSize));
+        await vscode.workspace.openTextDocument(launchJsonPath);
+        const doc: vscode.TextDocument = await vscode.workspace.openTextDocument(launchJsonPath);
+        if (doc) {
+            vscode.window.showTextDocument(doc);
+        }
+    }
+
+    public async addDebugConfiguration(textEditor: vscode.TextEditor): Promise<void> {
+        const folder: vscode.WorkspaceFolder | undefined = vscode.workspace.getWorkspaceFolder(textEditor.document.uri);
+        if (!folder) {
+            return;
+        }
+        const selectedConfig: vscode.DebugConfiguration | undefined = await this.selectConfiguration(textEditor, true);
+        if (!selectedConfig) {
+            Telemetry.logDebuggerEvent(DebuggerEvent.launchPlayButton, { "debugType": "AddConfigurationOnly", "folderMode": folder ? "folder" : "singleFile", "cancelled": "true" });
+            return; // User canceled it.
+        }
+
+        // Write preLaunchTask into tasks.json file.
+        if (selectedConfig.preLaunchTask) {
+            await cppBuildTaskProvider.writeBuildTask(selectedConfig.preLaunchTask);
+        }
+        // Write debug configuraion in launch.json file.
+        await this.writeDebugConfig(selectedConfig, folder);
+
+    }
+
     public async buildAndRun(textEditor: vscode.TextEditor): Promise<void> {
         // Turn off the debug mode.
         return this.buildAndDebug(textEditor, false);
     }
 
     public async buildAndDebug(textEditor: vscode.TextEditor, debugModeOn: boolean = true): Promise<void> {
+        const folder: vscode.WorkspaceFolder | undefined = vscode.workspace.getWorkspaceFolder(textEditor.document.uri);
+        const selectedConfig: vscode.DebugConfiguration | undefined = await this.selectConfiguration(textEditor, true);
+        if (!selectedConfig) {
+            Telemetry.logDebuggerEvent(DebuggerEvent.launchPlayButton, { "debugType": debugModeOn ? "debug" : "run", "folderMode": folder ? "folder" : "singleFile", "cancelled": "true" });
+            return; // User canceled it.
+        }
+
+        // Keep track of the entry point where the debug has been selected, for telemetry purposes.
+        selectedConfig.debuggerEvent = DebuggerEvent.launchPlayButton;
+        // startDebugging will trigger a call to resolveDebugConfiguration.
+        await vscode.debug.startDebugging(folder, selectedConfig, {noDebug: !debugModeOn});
+    }
 
+    private async selectConfiguration(textEditor: vscode.TextEditor, pickDefault: boolean = false): Promise<vscode.DebugConfiguration | undefined> {
         const folder: vscode.WorkspaceFolder | undefined = vscode.workspace.getWorkspaceFolder(textEditor.document.uri);
         if (!util.isCppOrCFile(textEditor.document.uri)) {
             vscode.window.showErrorMessage(localize("cannot.build.non.cpp", 'Cannot build and debug because the active file is not a C or C++ source file.'));
@@ -612,14 +692,14 @@ export class DebugConfigurationProvider implements vscode.DebugConfigurationProv
             configs = configs.concat(await this.provideDebugConfigurationsForType(DebuggerType.cppvsdbg, folder));
         }
 
-        const defaultConfig: vscode.DebugConfiguration[] = findDefaultConfig(configs);
+        const defaultConfig: vscode.DebugConfiguration[] | undefined = pickDefault ? findDefaultConfig(configs) : undefined;
 
         const items: MenuItem[] = configs.map<MenuItem>(config => ({ label: config.name, configuration: config, description: config.detail, detail: config.existing }));
 
         let selection: MenuItem | undefined;
 
         // if there was only one config for the default task, choose that config, otherwise ask the user to choose.
-        if (defaultConfig.length === 1) {
+        if (defaultConfig && defaultConfig.length === 1) {
             selection = { label: defaultConfig[0].name, configuration: defaultConfig[0], description: defaultConfig[0].detail, detail: defaultConfig[0].existing };
         } else {
             let sortedItems: MenuItem[] = [];
@@ -636,21 +716,10 @@ export class DebugConfigurationProvider implements vscode.DebugConfigurationProv
                 placeHolder: (items.length === 0 ? localize("no.compiler.found", "No compiler found") : localize("select.debug.configuration", "Select a debug configuration"))
             });
         }
-
-        if (!selection) {
-            Telemetry.logDebuggerEvent(DebuggerEvent.launchPlayButton, { "debugType": debugModeOn ? "debug" : "run", "folderMode": folder ? "folder" : "singleFile", "cancelled": "true" });
-            return; // User canceled it.
-        }
-
-        if (this.isClConfiguration(selection.label) && this.showErrorIfClNotAvailable(selection.label)) {
+        if (selection && this.isClConfiguration(selection.configuration.name) && this.showErrorIfClNotAvailable(selection.configuration.name)) {
             return;
         }
-
-        // Keep track of the entry point where the debug has been selected, for telemetry purposes.
-        selection.configuration.debuggerEvent = DebuggerEvent.launchPlayButton;
-        // startDebugging will trigger a call to resolveDebugConfiguration.
-        await vscode.debug.startDebugging(folder, selection.configuration, {noDebug: !debugModeOn});
-
+        return selection?.configuration;
     }
 
     private async resolvePreLaunchTask(folder: vscode.WorkspaceFolder | undefined, configuration: vscode.DebugConfiguration, debugModeOn: boolean = true): Promise<void> {
@@ -662,7 +731,7 @@ export class DebugConfigurationProvider implements vscode.DebugConfigurationProv
         if (configuration.preLaunchTask) {
             try {
                 if (folder) {
-                    await cppBuildTaskProvider.checkBuildTaskExists(configuration.preLaunchTask);
+                    await cppBuildTaskProvider.writeBuildTask(configuration.preLaunchTask);
                 } else {
                     // In case of singleFile, remove the preLaunch task from the debug configuration and run it here instead.
                     await cppBuildTaskProvider.runBuildTask(configuration.preLaunchTask);
@@ -832,7 +901,7 @@ export class ConfigurationSnippetProvider implements vscode.CompletionItemProvid
     public provideCompletionItems(document: vscode.TextDocument, position: vscode.Position, token: vscode.CancellationToken, context: vscode.CompletionContext): Thenable<vscode.CompletionList> {
         let items: vscode.CompletionItem[] = this.snippets;
 
-        const launch: any = parse(document.getText());
+        const launch: any = jsonc.parse(document.getText());
         // Check to see if the array is empty, so any additional inserted snippets will need commas.
         if (launch.configurations.length !== 0) {
             items = [];
diff --git a/Extension/src/Debugger/extension.ts b/Extension/src/Debugger/extension.ts
@@ -10,9 +10,11 @@ import { NativeAttachItemsProviderFactory } from './nativeAttach';
 import { DebugConfigurationProvider, ConfigurationAssetProviderFactory, ConfigurationSnippetProvider, IConfigurationAssetProvider } from './configurationProvider';
 import { CppdbgDebugAdapterDescriptorFactory, CppvsdbgDebugAdapterDescriptorFactory } from './debugAdapterDescriptorFactory';
 import { DebuggerType } from './configurations';
+import * as nls from 'vscode-nls';
 
 // The extension deactivate method is asynchronous, so we handle the disposables ourselves instead of using extensonContext.subscriptions.
 const disposables: vscode.Disposable[] = [];
+const localize: nls.LocalizeFunc = nls.loadMessageBundle();
 
 export async function initialize(context: vscode.ExtensionContext): Promise<void> {
     // Activate Process Picker Commands
@@ -39,6 +41,13 @@ export async function initialize(context: vscode.ExtensionContext): Promise<void
     const debugProvider: DebugConfigurationProvider = new DebugConfigurationProvider(assetProvider, DebuggerType.all);
     disposables.push(vscode.commands.registerTextEditorCommand("C_Cpp.BuildAndDebugFile", async (textEditor: vscode.TextEditor, edit: vscode.TextEditorEdit, ...args: any[]) => { await debugProvider.buildAndDebug(textEditor); }));
     disposables.push(vscode.commands.registerTextEditorCommand("C_Cpp.BuildAndRunFile", async (textEditor: vscode.TextEditor, edit: vscode.TextEditorEdit, ...args: any[]) => { await debugProvider.buildAndRun(textEditor); }));
+    disposables.push(vscode.commands.registerTextEditorCommand("C_Cpp.AddDebugConfiguration", async (textEditor: vscode.TextEditor, edit: vscode.TextEditorEdit, ...args: any[]) => {
+        const folder: vscode.WorkspaceFolder | undefined = vscode.workspace.getWorkspaceFolder(textEditor.document.uri);
+        if (!folder) {
+            vscode.window.showWarningMessage(localize("add.debug.configuration.not.available.for.single.file", "Add debug configuration is not available for single file."));
+        }
+        await debugProvider.addDebugConfiguration(textEditor);
+    }));
 
     assetProvider.getConfigurationSnippets();
 
diff --git a/Extension/src/LanguageServer/client.ts b/Extension/src/LanguageServer/client.ts
@@ -1730,6 +1730,7 @@ export class DefaultClient implements Client {
             const uri: string = document.uri.toString();
             openFileVersions.set(uri, document.version);
             vscode.commands.executeCommand('setContext', 'BuildAndDebug.isSourceFile', util.isCppOrCFile(document.uri));
+            vscode.commands.executeCommand('setContext', 'BuildAndDebug.isFolderOpen', util.isFolderOpen(document.uri));
         } else {
             vscode.commands.executeCommand('setContext', 'BuildAndDebug.isSourceFile', false);
         }
@@ -2668,6 +2669,7 @@ export class DefaultClient implements Client {
                 || editor.document.languageId === "cpp"
                 || editor.document.languageId === "cuda-cpp")) {
             vscode.commands.executeCommand('setContext', 'BuildAndDebug.isSourceFile', util.isCppOrCFile(editor.document.uri));
+            vscode.commands.executeCommand('setContext', 'BuildAndDebug.isFolderOpen', util.isFolderOpen(editor.document.uri));
             // If using vcFormat, check for a ".editorconfig" file, and apply those text options to the active document.
             const settings: CppSettings = new CppSettings(this.RootUri);
             if (settings.useVcFormat(editor.document)) {
diff --git a/Extension/src/LanguageServer/cppBuildTaskProvider.ts b/Extension/src/LanguageServer/cppBuildTaskProvider.ts
diff --git a/Extension/src/common.ts b/Extension/src/common.ts
