Use cpptools API v5 (#6823)

Author: michelleangela

Extension/package.json

@@ -2450,7 +2450,7 @@
     "mkdirp": "^0.5.1",
     "plist": "^3.0.1",
     "tmp": "^0.1.0",
-    "vscode-cpptools": "^4.0.1",
+    "vscode-cpptools": "^5.0.0",
     "vscode-extension-telemetry": "^0.1.2",
     "vscode-languageclient": "^5.2.1",
     "vscode-nls": "^4.1.1",

Extension/src/LanguageServer/client.ts

@@ -1702,7 +1702,7 @@ export class DefaultClient implements Client {
             return this.callTaskWithTimeout(provideConfigurationAsync, configProviderTimeout, tokenSource).then(
                 (configs?: SourceFileConfigurationItem[] | null) => {
                     if (configs && configs.length > 0) {
-                        this.sendCustomConfigurations(configs);
+                        this.sendCustomConfigurations(configs, provider.version);
                     }
                     onFinished();
                 },
@@ -2364,19 +2364,24 @@ export class DefaultClient implements Client {
         this.notifyWhenReady(() => this.languageClient.sendNotification(ChangeCompileCommandsNotification, params));
     }
 
-    private isSourceFileConfigurationItem(input: any): input is SourceFileConfigurationItem {
+    private isSourceFileConfigurationItem(input: any, providerVersion: Version): input is SourceFileConfigurationItem {
+        // IntelliSenseMode and standard are optional for version 5+. However, they are required when compilerPath is not defined.
+        let areOptionalsValid: boolean = false;
+        if (providerVersion < Version.v5 || input.configuration.compilerPath === undefined) {
+            areOptionalsValid = util.isString(input.configuration.intelliSenseMode) && util.isString(input.configuration.standard);
+        } else if (util.isString(input.configuration.compilerPath)) {
+            areOptionalsValid = util.isOptionalString(input.configuration.intelliSenseMode) && util.isOptionalString(input.configuration.standard);
+        }
         return (input && (util.isString(input.uri) || util.isUri(input.uri)) &&
             input.configuration &&
+            areOptionalsValid &&
             util.isArrayOfString(input.configuration.includePath) &&
             util.isArrayOfString(input.configuration.defines) &&
-            util.isString(input.configuration.intelliSenseMode) &&
-            util.isString(input.configuration.standard) &&
-            util.isOptionalString(input.configuration.compilerPath) &&
             util.isOptionalArrayOfString(input.configuration.compilerArgs) &&
             util.isOptionalArrayOfString(input.configuration.forcedInclude));
     }
 
-    private sendCustomConfigurations(configs: any): void {
+    private sendCustomConfigurations(configs: any, providerVersion: Version): void {
         // configs is marked as 'any' because it is untrusted data coming from a 3rd-party. We need to sanitize it before sending it to the language server.
         if (!configs || !(configs instanceof Array)) {
             console.warn("discarding invalid SourceFileConfigurationItems[]: " + configs);
@@ -2390,7 +2395,7 @@ export class DefaultClient implements Client {
         }
         const sanitized: SourceFileConfigurationItemAdapter[] = [];
         configs.forEach(item => {
-            if (this.isSourceFileConfigurationItem(item)) {
+            if (this.isSourceFileConfigurationItem(item, providerVersion)) {
                 this.configurationLogging.set(item.uri.toString(), JSON.stringify(item.configuration, null, 4));
                 if (settings.loggingLevel === "Debug") {
                     out.appendLine(`  uri: ${item.uri.toString()}`);
@@ -2432,6 +2437,15 @@ export class DefaultClient implements Client {
     private browseConfigurationLogging: string = "";
     private configurationLogging: Map<string, string> = new Map<string, string>();
 
+    private isWorkspaceBrowseConfiguration(input: any): boolean {
+        const areOptionalsValid: boolean = (input.compilerPath === undefined && util.isString(input.standard)) ||
+            (util.isString(input.compilerPath) && util.isOptionalString(input.standard));
+        return areOptionalsValid &&
+        util.isArrayOfString(input.browsePath) &&
+        util.isOptionalString(input.compilerArgs) &&
+        util.isOptionalString(input.windowsSdkVersion);
+    }
+
     private sendCustomBrowseConfiguration(config: any, providerId?: string, timeoutOccured?: boolean): void {
         const rootFolder: vscode.WorkspaceFolder | undefined = this.RootFolder;
         if (!rootFolder) {
@@ -2461,11 +2475,7 @@ export class DefaultClient implements Client {
             }
 
             sanitized = {...<WorkspaceBrowseConfiguration>config};
-            if (!util.isArrayOfString(sanitized.browsePath) ||
-                !util.isOptionalString(sanitized.compilerPath) ||
-                !util.isOptionalArrayOfString(sanitized.compilerArgs) ||
-                !util.isOptionalString(sanitized.standard) ||
-                !util.isOptionalString(sanitized.windowsSdkVersion)) {
+            if (!this.isWorkspaceBrowseConfiguration(sanitized)) {
                 console.log("Received an invalid browse configuration from configuration provider.");
                 const configValue: WorkspaceBrowseConfiguration | undefined = lastCustomBrowseConfiguration.Value;
                 if (configValue) {

Extension/src/LanguageServer/configurations.ts

@@ -481,18 +481,18 @@ export class CppProperties {
     private getIntelliSenseModeForPlatform(name?: string): string {
         // Do the built-in configs first.
         if (name === "Linux") {
-            return "gcc-x64";
+            return "linux-gcc-x64";
         } else if (name === "Mac") {
-            return "clang-x64";
+            return "macos-clang-x64";
         } else if (name === "Win32") {
-            return "msvc-x64";
+            return "windows-msvc-x64";
         } else if (process.platform === 'win32') {
             // Custom configs default to the OS's preference.
-            return "msvc-x64";
+            return "windows-msvc-x64";
         } else if (process.platform === 'darwin') {
-            return "clang-x64";
+            return "macos-clang-x64";
         } else {
-            return "gcc-x64";
+            return "linux-gcc-x64";
         }
     }
 

Extension/src/LanguageServer/customProviders.ts

@@ -83,7 +83,7 @@ class CustomProviderWrapper implements CustomConfigurationProvider1 {
         return this._version < Version.v2 ? Promise.resolve(false) : this.provider.canProvideBrowseConfiguration(token);
     }
 
-    public provideBrowseConfiguration(token?: vscode.CancellationToken): Thenable<WorkspaceBrowseConfiguration> {
+    public provideBrowseConfiguration(token?: vscode.CancellationToken): Thenable<WorkspaceBrowseConfiguration | null> {
         console.assert(this._version >= Version.v2);
         return this._version < Version.v2 ? Promise.resolve({browsePath: []}) : this.provider.provideBrowseConfiguration(token);
     }
@@ -92,7 +92,7 @@ class CustomProviderWrapper implements CustomConfigurationProvider1 {
         return this._version < Version.v3 ? Promise.resolve(false) : this.provider.canProvideBrowseConfigurationsPerFolder(token);
     }
 
-    public provideFolderBrowseConfiguration(uri: vscode.Uri, token?: vscode.CancellationToken): Thenable<WorkspaceBrowseConfiguration> {
+    public provideFolderBrowseConfiguration(uri: vscode.Uri, token?: vscode.CancellationToken): Thenable<WorkspaceBrowseConfiguration | null> {
         console.assert(this._version >= Version.v3);
         return this._version < Version.v3 ? Promise.resolve({browsePath: []}) : this.provider.provideFolderBrowseConfiguration(uri, token);
     }

Extension/yarn.lock

@@ -5631,10 +5631,10 @@ vm-browserify@^1.0.1:
   resolved "https://registry.yarnpkg.com/vm-browserify/-/vm-browserify-1.1.2.tgz#78641c488b8e6ca91a75f511e7a3b32a86e5dda0"
   integrity sha512-2ham8XPWTONajOR0ohOKOHXkm3+gaBmGut3SRuu75xLd/RRaY6vqgh8NBYYk7+RW3u5AtzPQZG8F10LHkl0lAQ==
 
-vscode-cpptools@^4.0.1:
-  version "4.0.1"
-  resolved "https://registry.yarnpkg.com/vscode-cpptools/-/vscode-cpptools-4.0.1.tgz#7e591572b437a6aca47b767487b52bc253e6d911"
-  integrity sha512-2IjtWe7rjIp20J+5m0Yjpa8TjGhdQWChwE49iYJBUUTHFqJDFq0aXNAyiDNw6BDWI1Q2Z/gmeQGsJBoxTb0J0Q==
+vscode-cpptools@^5.0.0:
+  version "5.0.0"
+  resolved "https://registry.yarnpkg.com/vscode-cpptools/-/vscode-cpptools-5.0.0.tgz#f1195736af1cfa10727482be57093a3997c8f63b"
+  integrity sha512-TPG6/o9+DisDj2U4AiTOihtfjEzBb/4CErYaB1JIWFMZTQE7zlNTdsgCs+l4xIS2Y34us0RMBIC6On1mBuwxww==
 
 vscode-debugadapter@^1.35.0:
   version "1.38.0"