Allow merge of C_Cpp_Properties & configuration provider. (#8174)

willson556 · web-flow · commit a62acdb5a524 · 2021-10-04T17:28:41.000-07:00
* Allow merge of C_Cpp_Properties &amp; configuration provider.
diff --git a/Extension/c_cpp_properties.schema.json b/Extension/c_cpp_properties.schema.json
@@ -155,6 +155,11 @@
                         "description": "The id of a VS Code extension that can provide IntelliSense configuration information for source files.",
                         "type": "string"
                     },
+                    "mergeConfigurations": {
+                        "markdownDescription": "Set to `true` to merge include paths, defines, and forced includes with those from a configuration provider.",
+                        "descriptionHint": "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.",
+                        "type": "boolean"
+                    },
                     "browse": {
                         "type": "object",
                         "properties": {
diff --git a/Extension/package.json b/Extension/package.json
@@ -1146,6 +1146,11 @@
           "markdownDescription": "%c_cpp.configuration.default.configurationProvider.markdownDescription%",
           "scope": "resource"
         },
+        "C_Cpp.default.mergeConfigurations": {
+          "type": "boolean",
+          "markdownDescription": "%c_cpp.configuration.default.mergeConfigurations.markdownDescription%",
+          "scope": "resource"
+        },
         "C_Cpp.default.browse.path": {
           "type": "array",
           "items": {
diff --git a/Extension/package.nls.json b/Extension/package.nls.json
@@ -159,6 +159,7 @@
     "c_cpp.configuration.default.cStandard.markdownDescription": { "message": "The value to use in a configuration if `cStandard` is either not specified or set to `${default}`.", "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.default.cppStandard.markdownDescription": { "message": "The value to use in a configuration if `cppStandard` is either not specified or set to `${default}`.", "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.default.configurationProvider.markdownDescription": { "message": "The value to use in a configuration if `configurationProvider` is either not specified or set to `${default}`.", "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.default.mergeConfigurations.markdownDescription": { "message": "Set to `true` to merge include paths, defines, and forced includes with those from a configuration provider.", "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.default.browse.path.markdownDescription": { "message": "The value to use in a configuration if `browse.path` is not specified, or the values to insert if `${default}` is present in `browse.path`.", "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.default.browse.databaseFilename.markdownDescription": { "message": "The value to use in a configuration if `browse.databaseFilename` is either not specified or set to `${default}`.", "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.default.browse.limitSymbolsToIncludedHeaders.markdownDescription": { "message": "The value to use in a configuration if `browse.limitSymbolsToIncludedHeaders` is either not specified or set to `${default}`.", "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/LanguageServer/client.ts b/Extension/src/LanguageServer/client.ts
@@ -1797,9 +1797,44 @@ export class DefaultClient implements Client {
                             const candidate: string = response.candidates[i];
                             const tuUri: vscode.Uri = vscode.Uri.parse(candidate);
                             if (await provider.canProvideConfiguration(tuUri, tokenSource.token)) {
-                                const configs: SourceFileConfigurationItem[] = await provider.provideConfigurations([tuUri], tokenSource.token);
+                                const configs: util.Mutable<SourceFileConfigurationItem>[] = await provider.provideConfigurations([tuUri], tokenSource.token);
                                 if (configs && configs.length > 0 && configs[0]) {
-                                    return configs;
+                                    const fileConfiguration: configs.Configuration | undefined = this.configuration.CurrentConfiguration;
+                                    if (fileConfiguration?.mergeConfigurations) {
+                                        configs.forEach(config => {
+                                            if (fileConfiguration.includePath) {
+                                                fileConfiguration.includePath.forEach(p => {
+                                                    if (!config.configuration.includePath.includes(p)) {
+                                                        config.configuration.includePath.push(p);
+                                                    }
+                                                });
+                                            }
+
+                                            if (fileConfiguration.defines) {
+                                                fileConfiguration.defines.forEach(d => {
+                                                    if (!config.configuration.defines.includes(d)) {
+                                                        config.configuration.defines.push(d);
+                                                    }
+                                                });
+                                            }
+
+                                            if (!config.configuration.forcedInclude) {
+                                                config.configuration.forcedInclude = [];
+                                            }
+
+                                            if (fileConfiguration.forcedInclude) {
+                                                fileConfiguration.forcedInclude.forEach(i => {
+                                                    if (config.configuration.forcedInclude) {
+                                                        if (!config.configuration.forcedInclude.includes(i)) {
+                                                            config.configuration.forcedInclude.push(i);
+                                                        }
+                                                    }
+                                                });
+                                            }
+                                        });
+                                    }
+
+                                    return configs as SourceFileConfigurationItem[];
                                 }
                             }
                             if (tokenSource.token.isCancellationRequested) {
diff --git a/Extension/src/LanguageServer/configurations.ts b/Extension/src/LanguageServer/configurations.ts
@@ -73,6 +73,7 @@ export interface Configuration {
     compileCommands?: string;
     forcedInclude?: string[];
     configurationProvider?: string;
+    mergeConfigurations?: boolean;
     browse?: Browse;
     customConfigurationVariables?: {[key: string]: string};
 }
@@ -741,6 +742,18 @@ export class CppProperties {
         return util.resolveVariables(property, env);
     }
 
+    private updateConfigurationBoolean(property: boolean | undefined | null, defaultValue: boolean | undefined | null): boolean | undefined {
+        if (property === null || property === undefined) {
+            property = defaultValue;
+        }
+
+        if (property === null) {
+            return undefined;
+        }
+
+        return property;
+    }
+
     private updateConfigurationStringDictionary(property: { [key: string]: string } | undefined, defaultValue: { [key: string]: string } | undefined, env: Environment): { [key: string]: string } | undefined {
         if (!property || property === {}) {
             property = defaultValue;
@@ -780,6 +793,7 @@ export class CppProperties {
             configuration.intelliSenseModeIsExplicit = configuration.intelliSenseModeIsExplicit || settings.defaultIntelliSenseMode !== "";
             configuration.cStandardIsExplicit = configuration.cStandardIsExplicit || settings.defaultCStandard !== "";
             configuration.cppStandardIsExplicit = configuration.cppStandardIsExplicit || settings.defaultCppStandard !== "";
+            configuration.mergeConfigurations = this.updateConfigurationBoolean(configuration.mergeConfigurations, settings.defaultMergeConfigurations);
             if (!configuration.compileCommands) {
                 // compile_commands.json already specifies a compiler. compilerPath overrides the compile_commands.json compiler so
                 // don't set a default when compileCommands is in use.
diff --git a/Extension/src/LanguageServer/settings.ts b/Extension/src/LanguageServer/settings.ts
@@ -160,6 +160,7 @@ export class CppSettings extends Settings {
     public get defaultCStandard(): string | undefined { return super.Section.get<string>("default.cStandard"); }
     public get defaultCppStandard(): string | undefined { return super.Section.get<string>("default.cppStandard"); }
     public get defaultConfigurationProvider(): string | undefined { return super.Section.get<string>("default.configurationProvider"); }
+    public get defaultMergeConfigurations(): boolean | undefined { return super.Section.get<boolean>("default.mergeConfigurations"); }
     public get defaultBrowsePath(): string[] | undefined { return super.Section.get<string[] | null>("default.browse.path") ?? undefined; }
     public get defaultDatabaseFilename(): string | undefined { return super.Section.get<string>("default.browse.databaseFilename"); }
     public get defaultLimitSymbolsToIncludedHeaders(): boolean | undefined { return super.Section.get<boolean>("default.browse.limitSymbolsToIncludedHeaders"); }
diff --git a/Extension/src/LanguageServer/settingsPanel.ts b/Extension/src/LanguageServer/settingsPanel.ts
@@ -39,6 +39,7 @@ const elementId: { [key: string]: string } = {
     windowsSdkVersion: "windowsSdkVersion",
     macFrameworkPath: "macFrameworkPath",
     compileCommands: "compileCommands",
+    mergeConfigurations: "mergeConfigurations",
     configurationProvider: "configurationProvider",
     forcedInclude: "forcedInclude",
 
@@ -325,6 +326,9 @@ export class SettingsPanel {
             case elementId.compileCommands:
                 this.configValues.compileCommands = message.value;
                 break;
+            case elementId.mergeConfigurations:
+                this.configValues.mergeConfigurations = message.value;
+                break;
             case elementId.configurationProvider:
                 this.configValues.configurationProvider = message.value;
                 break;
diff --git a/Extension/ui/settings.html b/Extension/ui/settings.html
@@ -667,6 +667,15 @@
             </div>
         </div>
 
+        <div class="section">
+            <div class="section-title" data-loc-id="merge.configurations">Merge configurations</div>
+            <div>
+                <input type="checkbox" id="mergeConfigurations" style="vertical-align: middle; transform: scale(1.5)">
+                    <span data-loc-id="merge.configurations.description">When true (or checked), merge include paths, defines, and forced includes with those from a configuration provider.</span>
+                </input>
+            </div>
+        </div>
+
         <div class="section">
             <div class="section-title" data-loc-id="browse.path">Browse: path</div>
             <div class="section-text">
diff --git a/Extension/ui/settings.ts b/Extension/ui/settings.ts
@@ -39,6 +39,7 @@ const elementId: { [key: string]: string } = {
     configurationProvider: "configurationProvider",
     forcedInclude: "forcedInclude",
     forcedIncludeInvalid: "forcedIncludeInvalid",
+    mergeConfigurations: "mergeConfigurations",
 
     // Browse properties
     browsePath: "browsePath",
@@ -92,8 +93,9 @@ class SettingsApp {
             el.addEventListener("change", this.onChanged.bind(this, el.id));
         });
 
-        // Special case for checkbox element
+        // Special case for checkbox elements
         document.getElementById(elementId.limitSymbolsToIncludedHeaders).addEventListener("change", this.onChangedCheckbox.bind(this, elementId.limitSymbolsToIncludedHeaders));
+        document.getElementById(elementId.mergeConfigurations).addEventListener("change", this.onChangedCheckbox.bind(this, elementId.mergeConfigurations));
     }
 
     private addEventsToConfigNameChanges(): void {
@@ -268,6 +270,7 @@ class SettingsApp {
             (<HTMLInputElement>document.getElementById(elementId.windowsSdkVersion)).value = config.windowsSdkVersion ? config.windowsSdkVersion : "";
             (<HTMLInputElement>document.getElementById(elementId.macFrameworkPath)).value = joinEntries(config.macFrameworkPath);
             (<HTMLInputElement>document.getElementById(elementId.compileCommands)).value = config.compileCommands ? config.compileCommands : "";
+            (<HTMLInputElement>document.getElementById(elementId.mergeConfigurations)).checked = config.mergeConfigurations;
             (<HTMLInputElement>document.getElementById(elementId.configurationProvider)).value = config.configurationProvider ? config.configurationProvider : "";
             (<HTMLInputElement>document.getElementById(elementId.forcedInclude)).value = joinEntries(config.forcedInclude);
 
