Stop UTILITY targets from breaking IntelliSense (#4404)

[malsyned]

This change addresses item #4404

This changes visible behavior

The following changes are proposed:

Avoid passing UTILITY targets to updateConfigurationData() so that they don't interfere with the assumptions made by getConfiguration().

The purpose of this change

Prevent UTILITY targets with sources, such as the ones created by Doxygen.cmake, from causing incorrect IntelliSense generation.

[malsyned]

@microsoft-github-policy-service agree

…

On 2025-04-14 22:37, microsoft-github-policy-service[bot] wrote: @malsyned [1] please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information. @microsoft-github-policy-service agree [company="{your company}"] > Options: > > * (default - no company specified) I have sole ownership of > intellectual property rights to my Submissions and I am not making > Submissions in the course of work for my employer. > > @microsoft-github-policy-service agree > > * (when company given) I am making Submissions in the course of > work for my employer (or my employer has intellectual property > rights in my Submissions by contract or applicable law). I have > permission from my employer to make Submissions and enter into this > Agreement on behalf of my employer. By signing below, the defined > term “You” includes me and my employer. > > @microsoft-github-policy-service agree company="Microsoft" Contributor License Agreement CONTRIBUTION LICENSE AGREEMENT This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below. * Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, that is delivered by You to Microsoft under this Agreement. “Project” means any of the projects owned or managed by Microsoft and offered under a license approved by the Open Source Initiative (www.opensource.org [2]). “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any Project, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving that Project, but excluding communication that is conspicuously marked or otherwise designated in writing by You as “Not a Submission.” “Submission” means the Code and any other copyrightable material Submitted by You, including any associated comments and documentation. * Your Submission. You must agree to the terms of this Agreement before making a Submission to any Project. This Agreement covers any and all Submissions that You, now or in the future (except as described in Section 4 below), Submit to any Project. * Originality of Work. You represent that each of Your Submissions is entirely Your original work. Should You wish to Submit materials that are not Your original work, You may Submit them separately to the Project if You (a) retain all copyright and license information that was in the materials as You received them, (b) in the description accompanying Your Submission, include the phrase “Submission containing materials of a third party:” followed by the names of the third party and any licenses or other restrictions of which You are aware, and (c) follow any other instructions in the Project’s written guidelines concerning Submissions. * Your Employer. References to “employer” in this Agreement include Your employer or anyone else for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your Submission is made in the course of Your work for an employer or Your employer has intellectual property rights in Your Submission by contract or applicable law, You must secure permission from Your employer to make the Submission before signing this Agreement. In that case, the term “You” in this Agreement will refer to You and the employer collectively. If You change employers in the future and desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement and secure permission from the new employer before Submitting those Submissions. * Licenses. * Copyright License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third parties. * Patent License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under Your patent claims that are necessarily infringed by the Submission or the combination of the Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and import or otherwise dispose of the Submission alone or with the Project. * Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are granted by implication, exhaustion, estoppel or otherwise. * Representations and Warranties. You represent that You are legally entitled to grant the above licenses. You represent that each of Your Submissions is entirely Your original work (except as You may have disclosed under Section 3). You represent that You have secured permission from Your employer to make the Submission in cases where Your Submission is made in the course of Your work for Your employer or Your employer has intellectual property rights in Your Submission by contract or applicable law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You have the necessary authority to bind the listed employer to the obligations contained in this Agreement. You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. * Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which You later become aware that would make Your representations in this Agreement inaccurate in any respect. * Information about Submissions. You agree that contributions to Projects and information about contributions may be maintained indefinitely and disclosed publicly, including Your name and other information that You submit with Your Submission. * Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County, Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all defenses of lack of personal jurisdiction and forum non-conveniens. * Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and supersedes any and all prior agreements, understandings or communications, written or oral, between the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft. -- Reply to this email directly, view it on GitHub [3], or unsubscribe [4]. You are receiving this because you were mentioned.Message ID: ***@***.***> microsoft-github-policy-service[bot] left a comment (microsoft/vscode-cmake-tools#4405) [3] @malsyned [1] please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information. @microsoft-github-policy-service agree [company="{your company}"] > Options: > > * (default - no company specified) I have sole ownership of > intellectual property rights to my Submissions and I am not making > Submissions in the course of work for my employer. > > @microsoft-github-policy-service agree > > * (when company given) I am making Submissions in the course of > work for my employer (or my employer has intellectual property > rights in my Submissions by contract or applicable law). I have > permission from my employer to make Submissions and enter into this > Agreement on behalf of my employer. By signing below, the defined > term “You” includes me and my employer. > > @microsoft-github-policy-service agree company="Microsoft" Contributor License Agreement CONTRIBUTION LICENSE AGREEMENT This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below. * Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, that is delivered by You to Microsoft under this Agreement. “Project” means any of the projects owned or managed by Microsoft and offered under a license approved by the Open Source Initiative (www.opensource.org [2]). “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any Project, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving that Project, but excluding communication that is conspicuously marked or otherwise designated in writing by You as “Not a Submission.” “Submission” means the Code and any other copyrightable material Submitted by You, including any associated comments and documentation. * Your Submission. You must agree to the terms of this Agreement before making a Submission to any Project. This Agreement covers any and all Submissions that You, now or in the future (except as described in Section 4 below), Submit to any Project. * Originality of Work. You represent that each of Your Submissions is entirely Your original work. Should You wish to Submit materials that are not Your original work, You may Submit them separately to the Project if You (a) retain all copyright and license information that was in the materials as You received them, (b) in the description accompanying Your Submission, include the phrase “Submission containing materials of a third party:” followed by the names of the third party and any licenses or other restrictions of which You are aware, and (c) follow any other instructions in the Project’s written guidelines concerning Submissions. * Your Employer. References to “employer” in this Agreement include Your employer or anyone else for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your Submission is made in the course of Your work for an employer or Your employer has intellectual property rights in Your Submission by contract or applicable law, You must secure permission from Your employer to make the Submission before signing this Agreement. In that case, the term “You” in this Agreement will refer to You and the employer collectively. If You change employers in the future and desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement and secure permission from the new employer before Submitting those Submissions. * Licenses. * Copyright License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third parties. * Patent License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under Your patent claims that are necessarily infringed by the Submission or the combination of the Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and import or otherwise dispose of the Submission alone or with the Project. * Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are granted by implication, exhaustion, estoppel or otherwise. * Representations and Warranties. You represent that You are legally entitled to grant the above licenses. You represent that each of Your Submissions is entirely Your original work (except as You may have disclosed under Section 3). You represent that You have secured permission from Your employer to make the Submission in cases where Your Submission is made in the course of Your work for Your employer or Your employer has intellectual property rights in Your Submission by contract or applicable law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You have the necessary authority to bind the listed employer to the obligations contained in this Agreement. You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. * Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which You later become aware that would make Your representations in this Agreement inaccurate in any respect. * Information about Submissions. You agree that contributions to Projects and information about contributions may be maintained indefinitely and disclosed publicly, including Your name and other information that You submit with Your Submission. * Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County, Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all defenses of lack of personal jurisdiction and forum non-conveniens. * Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and supersedes any and all prior agreements, understandings or communications, written or oral, between the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft. -- Reply to this email directly, view it on GitHub [3], or unsubscribe [4]. You are receiving this because you were mentioned.Message ID: ***@***.***> Links: ------ [1] https://github.com/malsyned [2] http://www.opensource.org [3] #4405 (comment) [4] https://github.com/notifications/unsubscribe-auth/AAPIDUOPDGNMILL4OHZEETD2ZRWEZAVCNFSM6AAAAAB3ENFC4WVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDQMBTGU4TCNJVGI

[malsyned]

The strategy of this PR relies on the assumption that UTILITY targets (i.e. targets created by add_custom_target()) aren't going to contribute anything of value to C/C++ compilation information. I think that's a pretty safe assumption, and certainly safer than the assumption made in the current source very safe assumption, because CMake won't accept calls to target_include_directories() or target_compile_definitions() on UTILITY targets, so there's not really a supported way to provide those targets with the configuration information we want.

Still, if filtering them all out indiscriminately seems too risky a change to you, I can imagine a few other strategies for addressing #4404,

In increasing order of complexity:

1. Filter out configurations that don't contribute any non-undefined, non-empty properties before returning the first remaining one.
2. Make a new composite configuration by iterating over all target configurations and using each non-undefined, non-empty value encountered for each property
3. Like 2, but combine array properties like includePath instead of picking the first one

I have implementations for (1) and (3) already written up, and (2) would be pretty simple to make. If you'd prefer a PR for any of those strategies, let me know and I'll push it shortly after.

[malsyned]

@gcampbell-msft I'm having a hard time seeing why this change would affect the macOS and Windows end-to-end tests but not the Linux ones. It's hard to see through all of the spurious "Error" lines about deprecation warnings and "Hello" output, but I think it's saying that the failing test is "Good Run test with coverage", is that right?

Can you give me some guidance on how to even start troubleshooting this? I don't have access to a Windows or macOS PC, and this change in the cpptools integration shouldn't be going anywhere near anything test explorer related, I don't think.

[gcampbell-msft]

@malsyned Unfortunately these are known flaky issues with our tests. The Mac has a flakiness in one test and the Windows occasionally hits a timeout. I requeued the tests.

[malsyned]

Still no love from the Mac CI test, huh?

@gcampbell-msft does this PR look good otherwise to you?

[gcampbell-msft]

@malsyned What about an option where we simply sort the configurations we provide, and essentially de-prioritize the Utility targets? It makes me nervous to fully remove a target from intellisense inclusion, but if we simply de-prioritize it such that it's more of a last resort, this feels safer.

This is very similar to the Option 1 you mentioned, and I do think I prefer something like that, so that it can still be used if there are no other configurations available.

[malsyned]

@malsyned What about an option where we simply sort the configurations we provide, and essentially de-prioritize the Utility targets? It makes me nervous to fully remove a target from intellisense inclusion, but if we simply de-prioritize it such that it's more of a last resort, this feels safer.

This is very similar to the Option 1 you mentioned, and I do think I prefer something like that, so that it can still be used if there are no other configurations available.

OK yeah, no problem. I can think of a couple ways to implement this, do you have a preference?

1. Explicitly look at UTILITY targets and move them to the back of the line

This has to happen at updateConfigurationData() time because target type isn't easily available at provideConfigurations() time.

diff --git a/src/cpptools.ts b/src/cpptools.ts
index 50a3a50d..34fefc19 100644
--- a/src/cpptools.ts
+++ b/src/cpptools.ts
@@ -595,7 +595,11 @@ export class CppConfigurationProvider implements cpptools.CustomConfigurationPro
             // Update only the active build type variant.
             if (config.name === opts.activeBuildTypeVariant || (!opts.activeBuildTypeVariant && config.name === "")) {
                 for (const project of config.projects) {
-                    for (const target of project.targets) {
+                    // Move utility targets to the end so executable and library
+                    // targets which contribute more to IntelliSense
+                    // configuration take precedence.
+                    const targets = project.targets.sort((a, b) => Number(a.type === 'UTILITY') - Number(b.type === 'UTILITY'));
+                    for (const target of targets) {
                         // Now some shenanigans since header files don't have config data:
                         // 1. Accumulate some "defaults" based on the set of all options for each file group
                         // 2. Pass these "defaults" down when rebuilding the config data

2. Only use non-contributing configurations as a last resort

This can happen at provideConfigurations() time. It's more like an implicit check for UTILITY targets. It might be marginally more future-proof or self documenting?

diff --git a/src/cpptools.ts b/src/cpptools.ts
index 50a3a50d..a6cfe68b 100644
--- a/src/cpptools.ts
+++ b/src/cpptools.ts
@@ -315,6 +315,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
@@ -350,7 +371,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);
         }
     }
 

[gcampbell-msft]

@malsyned I think I like option 2 as it's more generic, and as you said, it might be more future-proof, thanks!