add support for force includes in c_cpp_properties.json (#1630)

Author: bobbrow

Extension/CHANGELOG.md

@@ -5,6 +5,7 @@
 * Support additional multiline comment patterns. [#1100](https://github.com/Microsoft/vscode-cpptools/issues/1100),[#1539](https://github.com/Microsoft/vscode-cpptools/issues/1539)
   * Added new setting: `C_Cpp.commentContinuationPatterns`
 * Add a setting to disable inactive region highlighting. [#1592](https://github.com/Microsoft/vscode-cpptools/issues/1592)
+* Add support for forced includes. [#852](https://github.com/Microsoft/vscode-cpptools/issues/852)
 
 ## Version 0.15.0: February 15, 2018
 * Add colorization for inactive regions. [#1466](https://github.com/Microsoft/vscode-cpptools/issues/1466)

Extension/c_cpp_properties.schema.json

@@ -47,6 +47,13 @@
                         ],
                         "description": "If set, it overrides the default mode used by the IntelliSense engine. Windows defaults to msvc-x64 and Linux/Mac default to clang-x64."
                     },
+                    "forcedInclude": {
+                        "description": "A list of files that should be included before any include file in a translation unit.",
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
+                    },
                     "browse": {
                         "type": "object",
                         "properties": {

Extension/src/LanguageServer/configurations.ts

@@ -94,6 +94,7 @@ export interface Configuration {
     defines?: string[];
     intelliSenseMode?: string;
     compileCommands?: string;
+    forcedInclude?: string[];
     browse?: Browse;
 }
 
@@ -275,28 +276,33 @@ export class CppProperties {
         this.onSelectionChanged();
     }
 
-    private resolveAndSplit(paths: string[]): string[] {
+    private resolveAndSplit(paths: string[] | undefined): string[] {
         let result: string[] = [];
-        paths.forEach(entry => {
-            let entries: string[] = util.resolveVariables(entry).split(";").filter(e => e);
-            result = result.concat(entries);
-        });
+        if (paths) {
+            paths.forEach(entry => {
+                let entries: string[] = util.resolveVariables(entry).split(";").filter(e => e);
+                result = result.concat(entries);
+            });
+        }
         return result;
     }
 
     private updateServerOnFolderSettingsChange(): void {
         for (let i: number = 0; i < this.configurationJson.configurations.length; i++) {
             let configuration: Configuration = this.configurationJson.configurations[i];
-            if (configuration.includePath !== undefined) {
+            if (configuration.includePath) {
                 configuration.includePath = this.resolveAndSplit(configuration.includePath);
             }
-            if (configuration.browse !== undefined && configuration.browse.path !== undefined) {
+            if (configuration.browse) {
                 configuration.browse.path = this.resolveAndSplit(configuration.browse.path);
             }
-            if (configuration.macFrameworkPath !== undefined) {
+            if (configuration.macFrameworkPath) {
                 configuration.macFrameworkPath = this.resolveAndSplit(configuration.macFrameworkPath);
             }
-            if (configuration.compileCommands !== undefined) {
+            if (configuration.forcedInclude) {
+                configuration.forcedInclude = this.resolveAndSplit(configuration.forcedInclude);
+            }
+            if (configuration.compileCommands) {
                 configuration.compileCommands = util.resolveVariables(configuration.compileCommands);
             }
         }

Extension/src/common.ts

@@ -120,7 +120,7 @@ export function showReleaseNotes(): void {
 }
 
 export function resolveVariables(input: string): string {
-    if (input === null) {
+    if (!input) {
         return "";
     }