Merge branch 'main' into feature/add-cpp-name-demangling

Author: rjaegers

CHANGELOG.md

@@ -2,9 +2,20 @@
 
 ## 1.21
 
+Features:
+
+- Add an option to specify the launch target for debugging CTest tests. [#4273](https://github.com/microsoft/vscode-cmake-tools/pull/4273)
+
 Improvements:
 
 - Add name de-mangling for C++ symbols in the Test Explorer view when running tests with coverage. [#4340](https://github.com/microsoft/vscode-cmake-tools/pull/4340) [@rjaegers](https://github.com/rjaegers)
+- No longer convert paths on lowercase on MacOS to enable cpp tools to resolve them. [#4325](https://github.com/microsoft/vscode-cmake-tools/pull/4325) [@tringenbach](https://github.com/tringenbach)
+
+Bug Fixes:
+
+- Fix bug that makes `Configure Task` lists only first folder in workspace. [#3232](https//github.com/microsoft/vscode-cmake-tools/issues/3232)
+- Fix displaying "Go to Test" in the Test Explorer when the DEF_SOURCE_LINE property is set, but there is no backtrace information present. [#4321](https://github.com/microsoft/vscode-cmake-tools/pull/4321) [@rjaegers](https://github.com/rjaegers)
+- Fix gnuld error parsing false positive on make errors, false negative due to trailing \r, and false parsing of new "multiple definitions" error [#2864](https://github.com/microsoft/vscode-cmake-tools/issues/2864) [@0xemgy](https://github.com/0xemgy)
 
 ## 1.20.53
 

docs/debug-launch.md

@@ -227,6 +227,8 @@ A couple of examples:
 
 Depending on your configuration or your settings, there may need to be additional configuration options set.
 
+To use a specific launch configuration when debugging tests, set `cmake.ctest.debugLaunchTarget` to the desired name of the configuration (e.g. `(ctest) Launch`).
+
 ## Run without debugging
 
 You can run a target without debugging it, by running the *CMake: Run Without Debugging* from VS Code's command palette, by selecting the play button in the status bar or the play button to the left of the Launch node, or by pressing the keyboard shortcut (**Shift+Ctrl+F5**).

package.json

@@ -2255,6 +2255,12 @@
           "markdownDescription": "%cmake-tools.configuration.cmake.ctest.testSuiteDelimiter.markdownDescription%",
           "scope": "machine-overridable"
         },
+        "cmake.ctest.debugLaunchTarget": {
+          "type": "string",
+          "default": null,
+          "description": "%cmake-tools.configuration.cmake.ctest.debugLaunchTarget.description%",
+          "scope": "resource"
+        },
         "cmake.parseBuildDiagnostics": {
           "type": "boolean",
           "default": true,

package.nls.json

@@ -112,6 +112,7 @@
             "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."
         ]
     }, 
+	"cmake-tools.configuration.cmake.ctest.debugLaunchTarget.description": "Target name from launch.json to start when debugging a test with CTest. By default and in case of a non-existing target, this will show a picker with all available targets.",
     "cmake-tools.configuration.cmake.parseBuildDiagnostics.description": "Parse compiler output for warnings and errors.",
     "cmake-tools.configuration.cmake.enabledOutputParsers.description": {
         "message": "Output parsers to use. Supported parsers `cmake`, `gcc`, `gnuld` for GNULD-style linker output, `msvc` for Microsoft Visual C++, `ghs` for the Green Hills compiler with --no_wrap_diagnostics --brief_diagnostics, and `diab` for the Wind River Diab compiler.",

src/cmakeTaskProvider.ts

@@ -173,7 +173,7 @@ export interface ExtensionConfigurationSettings {
     buildToolArgs: string[];
     parallelJobs: number;
     ctestPath: string;
-    ctest: { parallelJobs: number; allowParallelJobs: boolean; testExplorerIntegrationEnabled: boolean; testSuiteDelimiter: string };
+    ctest: { parallelJobs: number; allowParallelJobs: boolean; testExplorerIntegrationEnabled: boolean; testSuiteDelimiter: string; debugLaunchTarget: string | null };
     parseBuildDiagnostics: boolean;
     enabledOutputParsers: string[];
     debugConfig: CppDebugConfiguration;
@@ -387,6 +387,9 @@ export class ConfigurationReader implements vscode.Disposable {
     get testSuiteDelimiter(): string {
         return this.configData.ctest.testSuiteDelimiter;
     }
+    get ctestDebugLaunchTarget(): string | null {
+        return this.configData.ctest.debugLaunchTarget;
+    }
     get parseBuildDiagnostics(): boolean {
         return !!this.configData.parseBuildDiagnostics;
     }
@@ -602,7 +605,7 @@ export class ConfigurationReader implements vscode.Disposable {
         parallelJobs: new vscode.EventEmitter<number>(),
         ctestPath: new vscode.EventEmitter<string>(),
         cpackPath: new vscode.EventEmitter<string>(),
-        ctest: new vscode.EventEmitter<{ parallelJobs: number; allowParallelJobs: boolean; testExplorerIntegrationEnabled: boolean; testSuiteDelimiter: string }>(),
+        ctest: new vscode.EventEmitter<{ parallelJobs: number; allowParallelJobs: boolean; testExplorerIntegrationEnabled: boolean; testSuiteDelimiter: string; debugLaunchTarget: string | null }>(),
         parseBuildDiagnostics: new vscode.EventEmitter<boolean>(),
         enabledOutputParsers: new vscode.EventEmitter<string[]>(),
         debugConfig: new vscode.EventEmitter<CppDebugConfiguration>(),

src/config.ts

@@ -799,29 +799,27 @@ export class CTestDriver implements vscode.Disposable {
                     let testDefFile: string | undefined;
                     let testDefLine: number | undefined;
 
-                    if (test.backtrace !== undefined && this.tests!.backtraceGraph.nodes[test.backtrace] !== undefined) {
-                        // Use DEF_SOURCE_LINE CMake test property to find file and line number
-                        // Property must be set in the test's CMakeLists.txt file or its included modules for this to work
-                        const defSourceLineProperty = test.properties.filter(property => property.name === "DEF_SOURCE_LINE")[0];
-                        if (defSourceLineProperty && defSourceLineProperty.value && typeof defSourceLineProperty.value === 'string') {
-                            // Use RegEx to match the format "file_path:line" in value[0]
-                            const match = defSourceLineProperty.value.match(/(.*):(\d+)/);
-                            if (match && match[1] && match[2]) {
-                                testDefFile = match[1];
-                                testDefLine = parseInt(match[2]);
-                                if (isNaN(testDefLine)) {
-                                    testDefLine = undefined;
-                                    testDefFile = undefined;
-                                }
+                    // Use DEF_SOURCE_LINE CMake test property to find file and line number
+                    // Property must be set in the test's CMakeLists.txt file or its included modules for this to work
+                    const defSourceLineProperty = test.properties.filter(property => property.name === "DEF_SOURCE_LINE")[0];
+                    if (defSourceLineProperty && defSourceLineProperty.value && typeof defSourceLineProperty.value === 'string') {
+                        // Use RegEx to match the format "file_path:line" in value[0]
+                        const match = defSourceLineProperty.value.match(/(.*):(\d+)/);
+                        if (match && match[1] && match[2]) {
+                            testDefFile = match[1];
+                            testDefLine = parseInt(match[2]);
+                            if (isNaN(testDefLine)) {
+                                testDefLine = undefined;
+                                testDefFile = undefined;
                             }
                         }
+                    }
 
-                        if (!testDefFile) {
-                            // Use the backtrace graph to find the file and line number
-                            // This finds the CMake module's file and line number and not the test file and line number
-                            testDefFile = this.tests!.backtraceGraph.files[this.tests!.backtraceGraph.nodes[test.backtrace].file];
-                            testDefLine = this.tests!.backtraceGraph.nodes[test.backtrace].line;
-                        }
+                    if (!testDefFile && test.backtrace !== undefined && this.tests!.backtraceGraph.nodes[test.backtrace] !== undefined) {
+                        // Use the backtrace graph to find the file and line number
+                        // This finds the CMake module's file and line number and not the test file and line number
+                        testDefFile = this.tests!.backtraceGraph.files[this.tests!.backtraceGraph.nodes[test.backtrace].file];
+                        testDefLine = this.tests!.backtraceGraph.nodes[test.backtrace].line;
                     }
 
                     const testAndParentSuite = this.createTestItemAndSuiteTree(test.name, testExplorerRoot, initializedTestExplorer, testDefFile ? vscode.Uri.file(testDefFile) : undefined);
@@ -1074,7 +1072,12 @@ export class CTestDriver implements vscode.Disposable {
         let chosenConfig: ConfigItem | undefined;
         if (allConfigItems.length === 1) {
             chosenConfig = allConfigItems[0];
-        } else {
+        }
+        if (!chosenConfig && this.ws.config.ctestDebugLaunchTarget) {
+            chosenConfig = allConfigItems.find(x => x.label === this.ws.config.ctestDebugLaunchTarget);
+        }
+
+        if (!chosenConfig) {
             // TODO: we can remember the last choice once the CMake side panel work is done
             const chosen = await vscode.window.showQuickPick(allConfigItems, { placeHolder: localize('choose.launch.config', 'Choose a launch configuration to debug the test with.') });
             if (chosen) {

src/ctest.ts

@@ -12,6 +12,10 @@ const regexPatterns: RegexPattern[] = [
         regexPattern: /^(?:.*ld(?:\.exe)?:)(?:\s*)?(.+):(\d+):\s+(?:fatal )?(\w+):\s+(.+)/,
         matchTypes: [MatchType.Full, MatchType.File, MatchType.Line, MatchType.Severity, MatchType.Message]
     },
+    {   // path/to/ld[.exe]:[ ]path/to/file.obj:path/to/file:line: message
+        regexPattern: /^(?:.*ld(?:\.exe)?\:)(?:\s*)(?:.+?\.obj:)(.+?):(\d+):\s+(.+)/,
+        matchTypes: [MatchType.Full, MatchType.File, MatchType.Line, MatchType.Message]
+    },
     {   // path/to/ld[.exe]:[ ]path/to/file:line: message
         regexPattern: /^(?:.*ld(?:\.exe)?\:)(?:\s*)?(.+):(\d+):\s+(.+)/,
         matchTypes: [MatchType.Full, MatchType.File, MatchType.Line, MatchType.Message]
@@ -21,11 +25,11 @@ const regexPatterns: RegexPattern[] = [
         matchTypes: [MatchType.Full, MatchType.File, MatchType.Severity, MatchType.Message]
     },
     {   // path/to/ld[.exe]: message (without trailing colon)
-        regexPattern: /^(.*ld(?:\.exe)?):\s+(.+)(?<!:)$/,
+        regexPattern: /^(.*ld(?:\.exe)?):\s+(.+)(?<!:)\s*$/,
         matchTypes: [MatchType.Full, MatchType.File, MatchType.Message]
     },
-    {   // /path/to/file:line: message (without "[fatal] severity:" or trailing colon)
-        regexPattern: /^(.+?):(\d+):\s+(?!fatal\s+\w+:)(?!\w+:)(.+)(?<!:)$/,
+    {   // path/to/file:line: message (with neither "[fatal] severity:" nor trailing colon nor leading "make: *** [" nor leading "make[line]: *** [")
+        regexPattern: /^(?!\s*make.*:\s\*\*\*\s\[)(.+?):(\d+):\s+(?!fatal\s+\w+:)(?!\w+:)(.+)(?<!:)\s*$/,
         matchTypes: [MatchType.Full, MatchType.File, MatchType.Line, MatchType.Message]
     }
 ];

src/diagnostics/gnu-ld.ts

@@ -2002,7 +2002,7 @@ export abstract class CMakeDriver implements vscode.Disposable {
             }
             const useBuildTask: boolean = this.config.buildTask && isBuildCommand === true;
             if (useBuildTask) {
-                const task: CMakeTask | undefined = await CMakeTaskProvider.findBuildTask(this._buildPreset?.name, targets, this.expansionOptions);
+                const task: CMakeTask | undefined = await CMakeTaskProvider.findBuildTask(this.workspaceFolder, this._buildPreset?.name, targets, this.expansionOptions);
                 if (task) {
                     const resolvedTask: CMakeTask | undefined = await CMakeTaskProvider.resolveInternalTask(task);
                     if (resolvedTask) {

src/drivers/cmakeDriver.ts

@@ -1830,6 +1830,25 @@ export class ExtensionManager implements vscode.Disposable {
         return projects.some(project => project.hasCMakeLists());
     }
 
+    /**
+     * Get all CMake projects in the workspace
+     *
+     * @returns All CMake projects in the workspace
+     */
+    getAllCMakeProjects(): CMakeProject[] {
+        return this.projectController.getAllCMakeProjects();
+    }
+
+    /**
+     * Get the CMake project for the given folder
+     *
+     * @param folder The folder to get the project for
+     * @returns The CMake project for the folder
+     */
+    async getProjectForFolder(folder: vscode.WorkspaceFolder): Promise<CMakeProject | undefined> {
+        return this.projectController.getProjectForFolder(folder.uri.path);
+    }
+
     activeConfigurePresetName(): string {
         telemetry.logEvent("substitution", { command: "activeConfigurePresetName" });
         return this.getActiveProject()?.configurePreset?.name || '';