Stop UTILITY targets from breaking IntelliSense (#4404) (#4405)

* Stop UTILITY targets from affecting IntelliSense

Some `UTILITY` targets, such as the ones created by `Doxygen.cmake`,
have a list of associated sources but don't have any useful
`includePath`, `defines`, etc. If the selected Build Target is `all` or
some other non-artifact target, these targets could be chosen as a
fallback source of configuration instead of a more complete one. Filter
out targets with empty configurations before selecting a fallback, so
that doesn't happen.

* changelog: move update to 1.22

Author: malsyned

CHANGELOG.md

@@ -21,7 +21,7 @@ Bugs:
 - Ensure Visual Studio developer environment propagation preserves `VCPKG_ROOT`, enabling vcpkg-dependent configure runs after using the Set Visual Studio Developer Environment command. [microsoft/vscode-cpptools#14083](https://github.com/microsoft/vscode-cpptools/issues/14083)
 - Fix auto-focusing the "Search" input field in the CMake Cache view. [#4552](https://github.com/microsoft/vscode-cmake-tools/pull/4552) [@simhof-basyskom](https://github.com/simhof-basyskom)
 - Remove the demangling feature in the code coverage implementation for now since it doesn't work properly. 
-
+- Fix incorrect IntelliSense configuration when a `UTILITY` has source files. [#4404](https://github.com/microsoft/vscode-cmake-tools/issues/4404)
 
 ## 1.21
 

src/cpptools.ts

@@ -310,6 +310,27 @@ export function getIntelliSenseMode(cptVersion: cpptools.Version, compilerPath:
     }
 }
 
+/**
+ * Try to find a target configuration with some populated properties.
+ *
+ * All targets get defaults for `compilerPath`, `compilerArgs`, and
+ * `compilerFragments`, even `UTILITY` targets defined with
+ * `add_custom_command()` that provide no other useful configuration, so if
+ * possible, return one with more than just those populated.
+ */
+function fallbackConfiguration(configurations: Map<string, cpptools.SourceFileConfigurationItem> | undefined) {
+    if (!configurations) {
+        return undefined;
+    }
+    for (const item of configurations.values()) {
+        const { configuration: { includePath, defines, intelliSenseMode, standard} } = item;
+        if (includePath.length || defines.length || intelliSenseMode || standard) {
+            return item;
+        }
+    }
+    return configurations.values().next().value;
+}
+
 /**
  * The actual class that provides information to the cpptools extension. See
  * the `CustomConfigurationProvider` interface for information on how this class
@@ -345,7 +366,7 @@ export class CppConfigurationProvider implements cpptools.CustomConfigurationPro
         if (this.activeTarget && configurations?.has(this.activeTarget)) {
             return configurations!.get(this.activeTarget);
         } else {
-            return configurations?.values().next().value; // Any value is fine if the target doesn't match
+            return fallbackConfiguration(configurations);
         }
     }
 

test/unit-tests/cpptools.test.ts

@@ -335,12 +335,21 @@ suite('CppTools tests', () => {
                     name: 'cpptools-test2',
                     sourceDirectory: smokeFolder,
                     targets: [
+                        {
+                            name: 'utilityTarget',
+                            type: 'UTILITY',
+                            fileGroups: [{
+                                sources: [sourceFile3],
+                                isGenerated: false
+                            }]
+                        },
                         {
                             name: 'target3',
                             type: 'EXECUTABLE',
                             fileGroups: [{
                                 sources: [sourceFile3],
                                 isGenerated: false,
+                                defines: ['DEFINE3'], // make this a more attractive fallback than utilityTarget
                                 compileCommandFragments: ['-DFRAGMENT3'],
                                 language: 'CXX'
                             }]
@@ -390,7 +399,8 @@ suite('CppTools tests', () => {
         // Verify the browsePath with a different folder.
         const configurations2 = await provider.provideConfigurations([uri3]);
         expect(configurations2.length).to.eq(1);
-        expect(configurations2[0].configuration.defines).to.be.empty;
+        expect(configurations2[0].configuration.defines.length).to.eq(1);
+        expect(configurations2[0].configuration.defines).to.contain('DEFINE3');
         expect(configurations2[0].configuration.compilerFragments).to.contain('-DFRAGMENT3');
         const browseConfig2 = await provider.provideFolderBrowseConfiguration(vscode.Uri.file(smokeFolder));
         expect(browseConfig2?.browsePath.length).to.eq(1);