FOLDER grouping in default build target dropdown (#3953)

* added FOLDER grouping in default build target dropdown

* added option to enable/disable folder grouping

* reworked folder grouping to use new option

* Added folder grouping to changelog.md

* Fix url and CMake capitalisation

* changed variables to lowerCamelCase

* bugfix showing folder popup when selecting a target with the same name as a folder

* Moved FolderTarget to cmakeDriver

* Changed the default of 'useFolderPropertyInBuildTargetDropdown' to false

Author: itzandroidtab

CHANGELOG.md

@@ -6,6 +6,7 @@ Features:
 
 - Add an option to specify the launch target for debugging CTest tests. [#4273](https://github.com/microsoft/vscode-cmake-tools/pull/4273)
 - 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)
 
 Improvements:
 

package.json

@@ -3650,6 +3650,12 @@
           "default": [],
           "description": "%cmake-tools.configuration.cmake.coverageInfoFiles.description%",
           "scope": "resource"
+        },
+        "cmake.useFolderPropertyInBuildTargetDropdown": {
+            "type": "boolean",
+            "default": false,
+            "description": "%cmake-tools.configuration.cmake.useFolderPropertyInBuildTargetDropdown.description%",
+            "scope": "resource"
         }
       }
     },

package.nls.json

@@ -298,6 +298,7 @@
     "cmake-tools.configuration.cmake.preRunCoverageTarget.description": "Target to build before running tests with coverage using the test explorer",
     "cmake-tools.configuration.cmake.postRunCoverageTarget.description": "Target to build after running tests with coverage using the test explorer",
     "cmake-tools.configuration.cmake.coverageInfoFiles.description": "LCOV coverage info files to be processed after running tests with coverage using the test explorer.",
+    "cmake-tools.configuration.cmake.useFolderPropertyInBuildTargetDropdown.description": "Controls if the default build target dropdown is grouped by the CMake folder groups.",
     "cmake-tools.debugger.pipeName.description": "Name of the pipe (on Windows) or domain socket (on Unix) to use for debugger communication.",
     "cmake-tools.debugger.clean.description": "Clean prior to configuring.",
     "cmake-tools.debugger.configureAll.description": "Configure for all projects.",

src/cmakeProject.ts

@@ -52,6 +52,7 @@ import { ProjectController } from '@cmt/projectController';
 import { MessageItem } from 'vscode';
 import { DebugTrackerFactory, DebuggerInformation, getDebuggerPipeName } from '@cmt/debug/cmakeDebugger/debuggerConfigureDriver';
 import { ConfigurationType } from 'vscode-cmake-tools';
+import { NamedTarget, RichTarget, FolderTarget } from '@cmt/drivers/cmakeDriver';
 
 nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })();
 const localize: nls.LocalizeFunc = nls.loadMessageBundle();
@@ -2272,7 +2273,65 @@ export class CMakeProject {
         if (!drv.targets.length) {
             return await vscode.window.showInputBox({ prompt: localize('enter.target.name', 'Enter a target name') }) || null;
         } else {
-            const choices = drv.uniqueTargets.map((t): vscode.QuickPickItem => {
+            const folders: string[] = [];
+            const itemsGroup: (RichTarget | NamedTarget | FolderTarget)[] = [];
+
+            // group the data
+            drv.uniqueTargets.forEach((t) => {
+                switch (t.type) {
+                    case 'named': {
+                        itemsGroup.push(t);
+                        break;
+                    }
+                    case 'rich': {
+                        // check if we need to group by folder
+                        if (this.workspaceContext.config.useFolderPropertyInBuildTargetDropdown && t.folder) {
+                            if (!folders.includes(t.folder.name)) {
+                                folders.push(t.folder.name);
+                                itemsGroup.push({ type: 'folder', name: t.folder.name });
+                            }
+                        } else {
+                            itemsGroup.push(t);
+                        }
+                        break;
+                    }
+                }
+            });
+
+            const choicesGroup = itemsGroup.map((t): vscode.QuickPickItem => {
+                switch (t.type) {
+                    case 'named': {
+                        return {
+                            label: t.name,
+                            description: localize('target.to.build.description', 'Target to build')
+                        };
+                    }
+                    case 'rich': {
+                        return { label: t.name, description: t.targetType, detail: t.filepath };
+                    }
+                    case 'folder': {
+                        return { label: t.name, description: 'FOLDER' };
+                    }
+                }
+            });
+
+            const selGroup = await vscode.window.showQuickPick(choicesGroup, { placeHolder: localize('select.active.target.tooltip', 'Select the default build target') });
+
+            // exit if we do not group the folders or if we got something other than a folder
+            if (!selGroup || !this.workspaceContext.config.useFolderPropertyInBuildTargetDropdown || selGroup.description !== "FOLDER") {
+                return selGroup ? selGroup.label : null;
+            }
+
+            const items: (RichTarget | NamedTarget)[] = [];
+
+            // the user has selected a folder group
+            drv.uniqueTargets.forEach((t) => {
+                if (t.type === 'rich' && t.folder && t.folder.name === selGroup.label) {
+                    items.push(t);
+                }
+            });
+
+            const choices = items.map((t): vscode.QuickPickItem => {
                 switch (t.type) {
                     case 'named': {
                         return {
@@ -2285,6 +2344,7 @@ export class CMakeProject {
                     }
                 }
             });
+
             const sel = await vscode.window.showQuickPick(choices, { placeHolder: localize('select.active.target.tooltip', 'Select the default build target') });
             return sel ? sel.label : null;
         }

src/config.ts

@@ -221,6 +221,7 @@ export interface ExtensionConfigurationSettings {
     preRunCoverageTarget: string | null;
     postRunCoverageTarget: string | null;
     coverageInfoFiles: string[];
+    useFolderPropertyInBuildTargetDropdown: boolean;
 }
 
 type EmittersOf<T> = {
@@ -588,6 +589,10 @@ export class ConfigurationReader implements vscode.Disposable {
         return this.configData.coverageInfoFiles;
     }
 
+    get useFolderPropertyInBuildTargetDropdown(): boolean {
+        return this.configData.useFolderPropertyInBuildTargetDropdown;
+    }
+
     private readonly emitters: EmittersOf<ExtensionConfigurationSettings> = {
         autoSelectActiveFolder: new vscode.EventEmitter<boolean>(),
         defaultActiveFolder: new vscode.EventEmitter<string | null>(),
@@ -656,7 +661,8 @@ export class ConfigurationReader implements vscode.Disposable {
         enableLanguageServices: new vscode.EventEmitter<boolean>(),
         preRunCoverageTarget: new vscode.EventEmitter<string | null>(),
         postRunCoverageTarget: new vscode.EventEmitter<string | null>(),
-        coverageInfoFiles: new vscode.EventEmitter<string[]>()
+        coverageInfoFiles: new vscode.EventEmitter<string[]>(),
+        useFolderPropertyInBuildTargetDropdown: new vscode.EventEmitter<boolean>()
     };
 
     /**

src/drivers/cmakeDriver.ts

@@ -36,6 +36,7 @@ import { CacheEntry } from '@cmt/cache';
 import { CMakeBuildRunner } from '@cmt/cmakeBuildRunner';
 import { DebuggerInformation } from '@cmt/debug/cmakeDebugger/debuggerConfigureDriver';
 import { onBuildSettingsChange, onTestSettingsChange, onPackageSettingsChange } from '@cmt/ui/util';
+import { CodeModelKind } from '@cmt/drivers/cmakeFileApi';
 nls.config({ messageFormat: nls.MessageFormat.bundle, bundleFormat: nls.BundleFormat.standalone })();
 const localize: nls.LocalizeFunc = nls.loadMessageBundle();
 
@@ -96,6 +97,15 @@ export interface ExecutableTarget {
     isInstallTarget?: boolean;
 }
 
+/**
+ * A target with a name, but no output. Only used for targets that have a
+ * folder property.
+ */
+export interface FolderTarget {
+    type: 'folder';
+    name: string;
+}
+
 /**
  * A target with a name, but no output. This may be created via `add_custom_command()`.
  */
@@ -105,13 +115,14 @@ export interface NamedTarget {
 }
 
 /**
- * A target with a name, path, and type.
+ * A target with a name, path, type and folder.
  */
 export interface RichTarget {
     type: 'rich';
     name: string;
     filepath: string;
     targetType: string;
+    folder?: CodeModelKind.TargetObject;
     installPaths?: InstallPath[];
 }
 

src/drivers/cmakeFileApi.ts

@@ -419,6 +419,7 @@ async function convertTargetObjectFileToExtensionTarget(buildDirectory: string,
         name: targetObject.name,
         filepath: executablePath,
         targetType: targetObject.type,
+        folder: targetObject.folder,
         type: 'rich' as 'rich',
         installPaths: installPaths
     } as RichTarget;

src/drivers/cmakeServerDriver.ts

@@ -470,7 +470,7 @@ export class CMakeServerDriver extends CMakeDriver {
  * @t the RichTarget currently being examined.
  */
 function targetReducer(set: RichTarget[], t: RichTarget): RichTarget[] {
-    if (!set.find(t2 => t.name === t2.name && t.filepath === t2.filepath && t.targetType === t2.targetType)) {
+    if (!set.find(t2 => t.name === t2.name && t.filepath === t2.filepath && t.targetType === t2.targetType && t.folder === t2.folder)) {
         set.push(t);
     }
     return set;

test/unit-tests/config.test.ts

@@ -81,7 +81,8 @@ function createConfig(conf: Partial<ExtensionConfigurationSettings>): Configurat
         enableLanguageServices: true,
         preRunCoverageTarget: null,
         postRunCoverageTarget: null,
-        coverageInfoFiles: []
+        coverageInfoFiles: [],
+        useFolderPropertyInBuildTargetDropdown: true
     });
     ret.updatePartial(conf);
     return ret;