make browse.path optional (#2135)

Author: bobbrow

Extension/CHANGELOG.md

@@ -1,5 +1,13 @@
 # C/C++ for Visual Studio Code Change Log
 
+## Version 0.17.5: June 18, 2018
+* Change inactive regions from gray to translucent. [#1907](https://github.com/Microsoft/vscode-cpptools/issues/1907)
+* Improve performance of recursive includes paths. [#2068](https://github.com/Microsoft/vscode-cpptools/issues/2068)
+* Fix #include completion with headers in the same directory. [#2031](https://github.com/Microsoft/vscode-cpptools/issues/2031)
+* Support asm clobber registers on Windows. [#2090](https://github.com/Microsoft/vscode-cpptools/issues/2090)
+* Fix some crashes. [#2080](https://github.com/Microsoft/vscode-cpptools/issues/2080)
+* `browse.path` now inherits `includePath` if not set in `c_cpp_properties.json`.
+
 ## Version 0.17.4: May 31, 2018
 * Fix infinite loop (caused by deadlock) when using recursive includes. [#2043](https://github.com/Microsoft/vscode-cpptools/issues/2043)
 * Stop using recursive includes in the default configuration.

Extension/src/LanguageServer/configurations.ts

@@ -18,11 +18,11 @@ const configVersion: number = 4;
 // The property defaults are moved down to applyDefaultIncludePathsAndFrameworks.
 function getDefaultConfig(): Configuration {
     if (process.platform === 'darwin') {
-        return { name: "Mac", browse: {} };
+        return { name: "Mac" };
     } else if (process.platform === 'win32') {
-        return { name: "Win32", browse: {} };
+        return { name: "Win32" };
     } else {
-        return { name: "Linux", browse: {} };
+        return { name: "Linux" };
     }
 }
 
@@ -209,10 +209,7 @@ export class CppProperties {
                 // We don't add system includes to the includePath anymore. The language server has this information.
                 configuration.includePath = ["${workspaceFolder}"].concat(this.vcpkgIncludes);
             }
-            if (!settings.defaultBrowsePath) {
-                // We don't add system includes to the includePath anymore. The language server has this information.
-                configuration.browse.path = ["${workspaceFolder}"].concat(this.vcpkgIncludes);
-            }
+            // browse.path is not set by default anymore. When it is not set, the includePath will be used instead.
             if (!settings.defaultDefines) {
                 configuration.defines = (process.platform === 'win32') ? ["_DEBUG", "UNICODE", "_UNICODE"] : [];
             }
@@ -297,15 +294,6 @@ export class CppProperties {
         }
     }
 
-    private includePathConverted(): boolean {
-        for (let i: number = 0; i < this.configurationJson.configurations.length; i++) {
-            if (this.configurationJson.configurations[i].browse === undefined || this.configurationJson.configurations[i].browse.path === undefined) {
-                return false;
-            }
-        }
-        return true;
-    }
-
     public addToIncludePathCommand(path: string): void {
         this.handleConfigurationEditCommand((document: vscode.TextDocument) => {
             telemetry.logLanguageServerEvent("addToIncludePath");
@@ -403,7 +391,23 @@ export class CppProperties {
             if (!configuration.browse) {
                 configuration.browse = {};
             }
-            configuration.browse.path = this.updateConfiguration(configuration.browse.path, settings.defaultBrowsePath);
+
+            if (!configuration.browse.path) {
+                if (settings.defaultBrowsePath) {
+                    configuration.browse.path = settings.defaultBrowsePath;
+                } else if (configuration.includePath) {
+                    // If the user doesn't set browse.path, copy the includePath over. Make sure ${workspaceFolder} is in there though...
+                    configuration.browse.path = configuration.includePath.slice(0);
+                    if (-1 === configuration.includePath.findIndex((value: string, index: number) => {
+                        return !!value.match(/^\$\{(workspaceRoot|workspaceFolder)\}(\\|\\\*\*|\/|\/\*\*)?$/g);
+                    })) {
+                        configuration.browse.path.push("${workspaceFolder}");
+                    }
+                }
+            } else {
+                configuration.browse.path = this.updateConfiguration(configuration.browse.path, settings.defaultBrowsePath);
+            }
+
             configuration.browse.limitSymbolsToIncludedHeaders = this.updateConfiguration(configuration.browse.limitSymbolsToIncludedHeaders, settings.defaultLimitSymbolsToIncludedHeaders);
             configuration.browse.databaseFilename = this.updateConfiguration(configuration.browse.databaseFilename, settings.defaultDatabaseFilename);
         }
@@ -452,7 +456,7 @@ export class CppProperties {
                     let filePath: vscode.Uri = vscode.Uri.parse("untitled:" + fullPathToFile);
                     vscode.workspace.openTextDocument(filePath).then((document: vscode.TextDocument) => {
                         let edit: vscode.WorkspaceEdit = new vscode.WorkspaceEdit();
-                        if (this.configurationJson === undefined) {
+                        if (this.configurationJson) {
                             this.resetToDefaultSettings(true);
                         }
                         this.applyDefaultIncludePathsAndFrameworks();
@@ -571,17 +575,8 @@ export class CppProperties {
 
     private updateToVersion2(): void {
         this.configurationJson.version = 2;
-        if (!this.includePathConverted()) {
-            for (let i: number = 0; i < this.configurationJson.configurations.length; i++) {
-                let config: Configuration = this.configurationJson.configurations[i];
-                if (config.browse === undefined) {
-                    config.browse = {};
-                }
-                if (config.browse.path === undefined && (this.defaultIncludes !== undefined || config.includePath !== undefined)) {
-                    config.browse.path = (config.includePath === undefined) ? this.defaultIncludes.slice(0) : config.includePath.slice(0);
-                }
-            }
-        }
+        // no-op. We don't automatically populate the browse.path anymore.
+        // We use includePath if browse.path is not present which is what this code used to do.
     }
 
     private updateToVersion3(): void {