Add a command to change the active custom config provider (#2247)

bobbrow · web-flow · commit 16c4defcd0d3 · 2018-07-09T16:03:35.000-07:00
diff --git a/Extension/package.json b/Extension/package.json
@@ -415,6 +415,11 @@
         "title": "Select a Configuration...",
         "category": "C/Cpp"
       },
+      {
+        "command": "C_Cpp.ConfigurationProviderSelect",
+        "title": "Change Configuration Provider...",
+        "category": "C/Cpp"
+      },
       {
         "command": "C_Cpp.ConfigurationEdit",
         "title": "Edit Configurations...",
diff --git a/Extension/src/LanguageServer/client.ts b/Extension/src/LanguageServer/client.ts
@@ -119,6 +119,7 @@ const ChangeCompileCommandsNotification: NotificationType<FileChangedParams, voi
 const ChangeSelectedSettingNotification: NotificationType<FolderSelectedSettingParams, void> = new NotificationType<FolderSelectedSettingParams, void>('cpptools/didChangeSelectedSetting');
 const IntervalTimerNotification: NotificationType<void, void> = new NotificationType<void, void>('cpptools/onIntervalTimer');
 const CustomConfigurationNotification: NotificationType<CustomConfigurationParams, void> = new NotificationType<CustomConfigurationParams, void>('cpptools/didChangeCustomConfiguration');
+const ClearCustomConfigurationsNotification: NotificationType<void, void> = new NotificationType<void, void>('cpptools/clearCustomConfigurations');
 
 // Notifications from the server
 const ReloadWindowNotification: NotificationType<void, void> = new NotificationType<void, void>('cpptools/reloadWindow');
@@ -175,6 +176,7 @@ export interface Client {
     pauseParsing(): void;
     resumeParsing(): void;
     handleConfigurationSelectCommand(): void;
+    handleConfigurationProviderSelectCommand(): void;
     handleShowParsingCommands(): void;
     handleConfigurationEditCommand(): void;
     handleAddToIncludePathCommand(path: string): void;
@@ -433,7 +435,7 @@ class DefaultClient implements Client {
                     vscode.window.showInformationMessage(message, allow, notNow, dontAskAgain).then(result => {
                         switch (result) {
                             case allow: {
-                                this.configuration.addCustomConfigurationProvider(provider.extensionId).then(() => {
+                                this.configuration.updateCustomConfigurationProvider(provider.extensionId).then(() => {
                                     telemetry.logLanguageServerEvent("customConfigurationProvider", { "providerId": provider.extensionId });
                                 });
                                 break;
@@ -451,7 +453,7 @@ class DefaultClient implements Client {
             } else if (selectedProvider === provider.extensionId) {
                 telemetry.logLanguageServerEvent("customConfigurationProvider", { "providerId": provider.extensionId });
             } else if (selectedProvider === provider.name) {
-                this.configuration.addCustomConfigurationProvider(provider.extensionId); // update the configurationProvider in c_cpp_properties.json
+                this.configuration.updateCustomConfigurationProvider(provider.extensionId); // v0 -> v1 upgrade. Update the configurationProvider in c_cpp_properties.json
             }
         });
     }
@@ -1031,6 +1033,10 @@ class DefaultClient implements Client {
         this.notifyWhenReady(() => this.languageClient.sendNotification(CustomConfigurationNotification, params));
     }
 
+    private clearCustomConfigurations(): void {
+        this.notifyWhenReady(() => this.languageClient.sendNotification(ClearCustomConfigurationsNotification));
+    }
+
     /*********************************************
      * command handlers
      *********************************************/
@@ -1046,6 +1052,27 @@ class DefaultClient implements Client {
         });
     }
 
+    public handleConfigurationProviderSelectCommand(): void {
+        this.notifyWhenReady(() => {
+            ui.showConfigurationProviders()
+                .then(extensionId => {
+                    if (extensionId === undefined) {
+                        // operation was cancelled.
+                        return;
+                    }
+                    this.configuration.updateCustomConfigurationProvider(extensionId)
+                        .then(() => {
+                            if (extensionId) {
+                                this.updateCustomConfigurations(getCustomConfigProviders().get(extensionId));
+                                telemetry.logLanguageServerEvent("customConfigurationProvider", { "providerId": extensionId });
+                            } else {
+                                this.clearCustomConfigurations();
+                            }
+                        });
+                });
+        });
+    }
+
     public handleShowParsingCommands(): void {
         this.notifyWhenReady(() => {
             ui.showParsingCommands()
@@ -1143,6 +1170,7 @@ class NullClient implements Client {
     pauseParsing(): void {}
     resumeParsing(): void {}
     handleConfigurationSelectCommand(): void {}
+    handleConfigurationProviderSelectCommand(): void {}
     handleShowParsingCommands(): void {}
     handleConfigurationEditCommand(): void {}
     handleAddToIncludePathCommand(path: string): void {}
diff --git a/Extension/src/LanguageServer/configurations.ts b/Extension/src/LanguageServer/configurations.ts
@@ -319,13 +319,17 @@ export class CppProperties {
         });
     }
 
-    public addCustomConfigurationProvider(providerId: string): Thenable<void> {
+    public updateCustomConfigurationProvider(providerId: string): Thenable<void> {
         return new Promise<void>((resolve) => {
             if (this.propertiesFile) {
                 this.handleConfigurationEditCommand((document: vscode.TextDocument) => {
                     this.parsePropertiesFile(); // Clear out any modifications we may have made internally.
                     let config: Configuration = this.CurrentConfiguration;
-                    config.configurationProvider = providerId;
+                    if (providerId) {
+                        config.configurationProvider = providerId;
+                    } else {
+                        delete config.configurationProvider;
+                    }
                     fs.writeFileSync(this.propertiesFile.fsPath, JSON.stringify(this.configurationJson, null, 4));
                     this.handleConfigurationChange();
                     resolve();
diff --git a/Extension/src/LanguageServer/extension.ts b/Extension/src/LanguageServer/extension.ts
@@ -210,6 +210,7 @@ function registerCommands(): void {
     disposables.push(vscode.commands.registerCommand('C_Cpp.SwitchHeaderSource', onSwitchHeaderSource));
     disposables.push(vscode.commands.registerCommand('C_Cpp.ResetDatabase', onResetDatabase));
     disposables.push(vscode.commands.registerCommand('C_Cpp.ConfigurationSelect', onSelectConfiguration));
+    disposables.push(vscode.commands.registerCommand('C_Cpp.ConfigurationProviderSelect', onSelectConfigurationProvider));
     disposables.push(vscode.commands.registerCommand('C_Cpp.ConfigurationEdit', onEditConfiguration));
     disposables.push(vscode.commands.registerCommand('C_Cpp.AddToIncludePath', onAddToIncludePath));
     disposables.push(vscode.commands.registerCommand('C_Cpp.ToggleErrorSquiggles', onToggleSquiggles));
@@ -311,7 +312,7 @@ function selectClient(): Thenable<Client> {
 function onResetDatabase(): void {
     onActivationEvent();
     /* need to notify the affected client(s) */
-    selectClient().then(client => client.resetDatabase(), rejected => { });
+    selectClient().then(client => client.resetDatabase(), rejected => {});
 }
 
 function onSelectConfiguration(): void {
@@ -325,12 +326,21 @@ function onSelectConfiguration(): void {
     }
 }
 
+function onSelectConfigurationProvider(): void {
+    onActivationEvent();
+    if (!isFolderOpen()) {
+        vscode.window.showInformationMessage('Open a folder first to select a configuration provider');
+    } else {
+        selectClient().then(client => client.handleConfigurationProviderSelectCommand(), rejected => {});
+    }
+}
+
 function onEditConfiguration(): void {
     onActivationEvent();
     if (!isFolderOpen()) {
         vscode.window.showInformationMessage('Open a folder first to edit configurations');
     } else {
-        selectClient().then(client => client.handleConfigurationEditCommand(), rejected => { });
+        selectClient().then(client => client.handleConfigurationEditCommand(), rejected => {});
     }
 }
 
@@ -413,17 +423,17 @@ function onShowReleaseNotes(): void {
 
 function onPauseParsing(): void {
     onActivationEvent();
-    selectClient().then(client => client.pauseParsing(), rejected => { });
+    selectClient().then(client => client.pauseParsing(), rejected => {});
 }
 
 function onResumeParsing(): void {
     onActivationEvent();
-    selectClient().then(client => client.resumeParsing(), rejected => { });
+    selectClient().then(client => client.resumeParsing(), rejected => {});
 }
 
 function onShowParsingCommands(): void {
     onActivationEvent();
-    selectClient().then(client => client.handleShowParsingCommands(), rejected => { });
+    selectClient().then(client => client.handleShowParsingCommands(), rejected => {});
 }
 
 function onTakeSurvey(): void {
diff --git a/Extension/src/LanguageServer/ui.ts b/Extension/src/LanguageServer/ui.ts
@@ -6,6 +6,7 @@
 
 import * as vscode from 'vscode';
 import { Client } from './client';
+import { getCustomConfigProviders, CustomConfigurationProviderCollection } from './customProviders';
 
 let ui: UI;
 
@@ -160,12 +161,22 @@ export class UI {
         items.push({ label: "Edit Configurations...", description: "", index: configurationNames.length });
 
         return vscode.window.showQuickPick(items, options)
-            .then(selection => {
-                if (!selection) {
-                    return -1;
-                }
-                return selection.index;
-            });
+            .then(selection => (selection) ? selection.index : -1);
+    }
+
+    public showConfigurationProviders(): Thenable<string|undefined> {
+        let options: vscode.QuickPickOptions = {};
+        options.placeHolder = "Select a Configuration Provider...";
+        let providers: CustomConfigurationProviderCollection = getCustomConfigProviders();
+
+        let items: KeyedQuickPickItem[] = [];
+        providers.forEach(provider => {
+            items.push({ label: provider.name, description: "", key: provider.extensionId });
+        });
+        items.push({ label: "(none)", description: "Disable the active configuration provider, if applicable.", key: "" });
+
+        return vscode.window.showQuickPick(items, options)
+            .then(selection => (selection) ? selection.key : undefined);
     }
 
     public showCompileCommands(paths: string[]): Thenable<number> {
@@ -178,12 +189,7 @@ export class UI {
         }
 
         return vscode.window.showQuickPick(items, options)
-            .then(selection => {
-                if (!selection) {
-                    return -1;
-                }
-                return selection.index;
-            });
+            .then(selection => (selection) ? selection.index : -1);
     }
 
     public showWorkspaces(workspaceNames: { name: string; key: string }[]): Thenable<string> {
@@ -194,12 +200,7 @@ export class UI {
         workspaceNames.forEach(name => items.push({ label: name.name, description: "", key: name.key }));
 
         return vscode.window.showQuickPick(items, options)
-            .then(selection => {
-                if (!selection) {
-                    return "";
-                }
-                return selection.key;
-            });
+            .then(selection => (selection) ? selection.key : "");
     }
 
     public showParsingCommands(): Thenable<number> {
@@ -215,12 +216,7 @@ export class UI {
         }
         
         return vscode.window.showQuickPick(items, options)
-            .then(selection => {
-                if (!selection) {
-                    return -1;
-                }
-                return selection.index;
-            });
+            .then(selection => (selection) ? selection.index : -1);
     }
 
     public dispose(): void {
diff --git a/Extension/src/commands.ts b/Extension/src/commands.ts
@@ -15,6 +15,7 @@ class TemporaryCommandRegistrar {
     private commandsToRegister: string[] = [
         "C_Cpp.ConfigurationEdit",
         "C_Cpp.ConfigurationSelect",
+        "C_Cpp.ConfigurationProviderSelect",
         "C_Cpp.SwitchHeaderSource",
         "C_Cpp.Navigate",
         "C_Cpp.GoToDeclaration",
diff --git a/Extension/src/main.ts b/Extension/src/main.ts
@@ -311,6 +311,7 @@ function rewriteManifest(): Promise<void> {
         "onCommand:extension.pickRemoteNativeProcess",
         "onCommand:C_Cpp.ConfigurationEdit",
         "onCommand:C_Cpp.ConfigurationSelect",
+        "onCommand:C_Cpp.ConfigurationProviderSelect",
         "onCommand:C_Cpp.SwitchHeaderSource",
         "onCommand:C_Cpp.Navigate",
         "onCommand:C_Cpp.GoToDeclaration",
