Enable hide/show of type size/alignment (#14822)

Author: Colengms

Extension/package.json

@@ -1061,6 +1061,12 @@
                         "markdownDescription": "%c_cpp.configuration.hoverShowIntegralValuesInHexadecimal.markdownDescription%",
                         "scope": "resource"
                     },
+                    "C_Cpp.hoverShowTypeSizeAndAlignment": {
+                        "type": "boolean",
+                        "default": true,
+                        "markdownDescription": "%c_cpp.configuration.hoverShowTypeSizeAndAlignment.markdownDescription%",
+                        "scope": "resource"
+                    },
                     "C_Cpp.errorSquiggles": {
                         "type": "string",
                         "enum": [
@@ -4025,6 +4031,11 @@
                 "title": "%c_cpp.command.toggleDimInactiveRegions.title%",
                 "category": "C/C++"
             },
+            {
+                "command": "C_Cpp.ToggleTypeSizeAndAlignment",
+                "title": "%c_cpp.command.toggleTypeSizeAndAlignment.title%",
+                "category": "C/C++"
+            },
             {
                 "command": "C_Cpp.FoldAllInactiveRegions",
                 "title": "%c_cpp.command.foldAllInactiveRegions.title%",
@@ -6588,6 +6599,10 @@
                     "command": "C_Cpp.ToggleDimInactiveRegions",
                     "when": "config.C_Cpp.intelliSenseEngine =~ /^[dD]efault$/"
                 },
+                {
+                    "command": "C_Cpp.ToggleTypeSizeAndAlignment",
+                    "when": "config.C_Cpp.intelliSenseEngine =~ /^[dD]efault$/"
+                },
                 {
                     "command": "C_Cpp.FoldAllInactiveRegions",
                     "when": "editorLangId =~ /^(c|(cuda-)?cpp)$/ && config.C_Cpp.intelliSenseEngine =~ /^[dD]efault$/ && config.C_Cpp.codeFolding =~ /^[eE]nabled$/"

Extension/package.nls.json

@@ -19,6 +19,7 @@
     "c_cpp.command.enableErrorSquiggles.title": "Enable Error Squiggles",
     "c_cpp.command.disableErrorSquiggles.title": "Disable Error Squiggles",
     "c_cpp.command.toggleDimInactiveRegions.title": "Toggle Inactive Region Colorization",
+    "c_cpp.command.toggleTypeSizeAndAlignment.title": "Toggle Type Size and Alignment in Hovers",
     "c_cpp.command.foldAllInactiveRegions.title": "Fold All Inactive Regions",
     "c_cpp.command.unfoldAllInactiveRegions.title": "Unfold All Inactive Regions",
     "c_cpp.command.resetDatabase.title": "Reset IntelliSense Database",
@@ -785,6 +786,12 @@
             "Markdown text between `` should not be translated or localized (it represents literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered."
         ]
     },
+    "c_cpp.configuration.hoverShowTypeSizeAndAlignment.markdownDescription": {
+        "message": "Displays the size and alignment of types in IntelliSense hovers. This setting only applies if `#C_Cpp.intelliSenseEngine#` is set to `default`.",
+        "comment": [
+            "Markdown text between `` should not be translated or localized (it represents literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered."
+        ]
+    },
     "c_cpp.configuration.vcpkg.enabled.markdownDescription": {
         "message": "Enable integration services for the [vcpkg dependency manager](https://aka.ms/vcpkg/).",
         "comment": [

Extension/src/LanguageServer/client.ts

@@ -1506,6 +1506,7 @@ export class DefaultClient implements Client {
             markdownInComments: settings.markdownInComments,
             hover: settings.hover,
             hoverShowIntegralValuesInHexadecimal: settings.hoverShowIntegralValuesInHexadecimal,
+            hoverShowTypeSizeAndAlignment: settings.hoverShowTypeSizeAndAlignment,
             vcFormatIndentBraces: settings.vcFormatIndentBraces,
             vcFormatIndentMultiLineRelativeTo: settings.vcFormatIndentMultiLineRelativeTo,
             vcFormatIndentWithinParentheses: settings.vcFormatIndentWithinParentheses,
@@ -1848,10 +1849,6 @@ export class DefaultClient implements Client {
 
     public async onDidChangeSettings(_event: vscode.ConfigurationChangeEvent): Promise<Record<string, string>> {
         const defaultClient: Client = clients.getDefaultClient();
-        if (this === defaultClient) {
-            // Only send the updated settings information once, as it includes values for all folders.
-            void this.sendDidChangeSettings().catch(logAndReturn.undefined);
-        }
         const changedSettings: Record<string, string> = this.settingsTracker.getChangedSettings();
 
         await this.ready;

Extension/src/LanguageServer/configurations.ts

@@ -687,9 +687,9 @@ export class CppProperties implements vscode.Disposable {
         if (!this.propertiesFile) {
             const settings: CppSettings = new CppSettings(this.rootUri);
             if (providerId) {
-                settings.update("default.configurationProvider", providerId);
+                void settings.update("default.configurationProvider", providerId);
             } else {
-                settings.update("default.configurationProvider", undefined); // delete the setting
+                void settings.update("default.configurationProvider", undefined); // delete the setting
             }
             const config: Configuration | undefined = this.CurrentConfiguration;
             if (config) {

Extension/src/LanguageServer/extension.ts

@@ -291,13 +291,23 @@ export function updateLanguageConfigurations(): void {
  * workspace events
  */
 async function onDidChangeSettings(event: vscode.ConfigurationChangeEvent): Promise<void> {
+    let settingsChanged: boolean = false;
     clients.forEach(client => {
         if (client instanceof DefaultClient) {
             if (trackedSections.some(section => event.affectsConfiguration(section, client.RootUri))) {
+                settingsChanged = true;
                 void client.onDidChangeSettings(event).catch(logAndReturn.undefined);
             }
         }
     });
+    if (settingsChanged) {
+        // Send the updated settings once through the default client because the payload includes all workspace folders.
+        const defaultClient: Client = clients.getDefaultClient();
+        void defaultClient.sendDidChangeSettings().catch(logAndReturn.undefined);
+        if (event.affectsConfiguration("C_Cpp.hoverShowTypeSizeAndAlignment")) {
+            defaultClient.getCopilotHoverProvider()?.reset();
+        }
+    }
 }
 
 function onDidChangeTextDocument(event: vscode.TextDocumentChangeEvent): void {
@@ -396,6 +406,7 @@ export async function registerCommands(enabled: boolean): Promise<void> {
     commandDisposables.push(vscode.commands.registerCommand('C_Cpp.EnableErrorSquiggles', enabled ? onEnableSquiggles : onDisabledCommand));
     commandDisposables.push(vscode.commands.registerCommand('C_Cpp.DisableErrorSquiggles', enabled ? onDisableSquiggles : onDisabledCommand));
     commandDisposables.push(vscode.commands.registerCommand('C_Cpp.ToggleDimInactiveRegions', enabled ? onToggleDimInactiveRegions : onDisabledCommand));
+    commandDisposables.push(vscode.commands.registerCommand('C_Cpp.ToggleTypeSizeAndAlignment', enabled ? onToggleTypeSizeAndAlignment : onDisabledCommand));
     commandDisposables.push(vscode.commands.registerCommand('C_Cpp.FoldAllInactiveRegions', enabled ? onFoldAllInactiveRegions : onDisabledCommand));
     commandDisposables.push(vscode.commands.registerCommand('C_Cpp.UnfoldAllInactiveRegions', enabled ? onUnfoldAllInactiveRegions : onDisabledCommand));
     commandDisposables.push(vscode.commands.registerCommand('C_Cpp.PauseParsing', enabled ? onPauseParsing : onDisabledCommand));
@@ -912,19 +923,25 @@ async function onAddToIncludePath(path: string): Promise<void> {
 function onEnableSquiggles(): void {
     // This only applies to the active client.
     const settings: CppSettings = new CppSettings(clients.ActiveClient.RootUri);
-    settings.update<string>("errorSquiggles", "enabled");
+    void settings.update<string>("errorSquiggles", "enabled");
 }
 
 function onDisableSquiggles(): void {
     // This only applies to the active client.
     const settings: CppSettings = new CppSettings(clients.ActiveClient.RootUri);
-    settings.update<string>("errorSquiggles", "disabled");
+    void settings.update<string>("errorSquiggles", "disabled");
 }
 
 function onToggleDimInactiveRegions(): void {
     // This only applies to the active client.
     const settings: CppSettings = new CppSettings(clients.ActiveClient.RootUri);
-    settings.update<boolean>("dimInactiveRegions", !settings.dimInactiveRegions);
+    void settings.update<boolean>("dimInactiveRegions", !settings.dimInactiveRegions);
+}
+
+function onToggleTypeSizeAndAlignment(): Thenable<void> {
+    // This only applies to the active client.
+    const settings: CppSettings = new CppSettings(clients.ActiveClient.RootUri);
+    return settings.update<boolean>("hoverShowTypeSizeAndAlignment", !settings.hoverShowTypeSizeAndAlignment);
 }
 
 function onFoldAllInactiveRegions(): Promise<void> {

Extension/src/LanguageServer/settings.ts

@@ -72,6 +72,7 @@ export interface WorkspaceFolderSettingsParams {
     clangTidyChecksDisabled: string[] | undefined;
     hover: string;
     hoverShowIntegralValuesInHexadecimal: boolean;
+    hoverShowTypeSizeAndAlignment: boolean;
     markdownInComments: string;
     vcFormatIndentBraces: boolean;
     vcFormatIndentMultiLineRelativeTo: string;
@@ -490,6 +491,7 @@ export class CppSettings extends Settings {
     public get doxygenSectionTags(): string[] { return this.getAsArrayOfStrings("doxygen.sectionTags"); }
     public get hover(): string { return this.getAsString("hover"); }
     public get hoverShowIntegralValuesInHexadecimal(): boolean { return this.getAsBoolean("hoverShowIntegralValuesInHexadecimal"); }
+    public get hoverShowTypeSizeAndAlignment(): boolean { return this.getAsBoolean("hoverShowTypeSizeAndAlignment"); }
     public get markdownInComments(): string { return this.getAsString("markdownInComments"); }
     public get legacyCompilerArgsBehavior(): boolean { return this.getAsBoolean("legacyCompilerArgsBehavior"); }
     public get inlayHintsAutoDeclarationTypes(): boolean { return this.getAsBoolean("inlayHints.autoDeclarationTypes.enabled"); }
@@ -777,8 +779,8 @@ export class CppSettings extends Settings {
         void super.Section.update(name, value?.toLowerCase() === value1.toLowerCase() ? value2 : value1, getTarget());
     }
 
-    public update<T>(name: string, value: T): void {
-        void super.Section.update(name, value);
+    public update<T>(name: string, value: T): Thenable<void> {
+        return super.Section.update(name, value);
     }
 
     public populateEditorConfig(document: vscode.TextDocument): void {

Extension/test/minBinaryVersion.json

@@ -1,3 +1,3 @@
 {
-    "minBinaryVersion": "1.35.3"
+    "minBinaryVersion": "1.35.4"
 }

Extension/test/scenarios/MultirootDeadlockTest/assets/SingleRootProject/quickInfo.cpp

@@ -35,4 +35,9 @@ int main()
     myfunction(false);
     bool result = isEven(1);
     testDoxygen(2, 3);
-}
+}
+
+struct HoverType
+{
+    int value;
+};

Extension/test/scenarios/MultirootDeadlockTest/tests/quickInfo.test.ts

@@ -58,6 +58,34 @@ suite("[Quick info test]", function(): void {
         disposables.forEach(d => d.dispose());
     });
 
+    async function getTypeHoverText(): Promise<string> {
+        const result: vscode.Hover[] = <vscode.Hover[]>(await vscode.commands.executeCommand(
+            'vscode.executeHoverProvider',
+            fileUri,
+            new vscode.Position(39, 8)));
+        assert.ok(result.length > 0, "Expected a hover for HoverType.");
+        return result.flatMap(hover => hover.contents)
+            .map(content => typeof content === "string" ? content : content.value)
+            .join("\n");
+    }
+
+    async function waitForTypeHover(showSizeAndAlignment: boolean): Promise<string> {
+        const deadline: number = Date.now() + 5000;
+        let hoverText: string = "";
+        while (Date.now() < deadline) {
+            hoverText = await getTypeHoverText();
+            const showsSize: boolean = hoverText.includes("**Size:**");
+            const showsAlignment: boolean = hoverText.includes("**Alignment:**");
+            if (hoverText.includes("struct HoverType")
+                && showsSize === showSizeAndAlignment
+                && showsAlignment === showSizeAndAlignment) {
+                return hoverText;
+            }
+            await testHelpers.delay(50);
+        }
+        assert.fail(`Timed out waiting for type size and alignment to be ${showSizeAndAlignment ? "shown" : "hidden"}. Last hover:\n${hoverText}`);
+    }
+
     test("[Hover over function call - normal comment]", async () => {
         const result: vscode.Hover[] = <vscode.Hover[]>(await vscode.commands.executeCommand('vscode.executeHoverProvider', fileUri, new vscode.Position(35, 23)));
         const expected_full_comment: string = `\`\`\`cpp\nbool isEven(int value)\n\`\`\`  \nVerifies if input is even number or not`;
@@ -111,15 +139,23 @@ suite("[Quick info test]", function(): void {
         const originalHover: string | undefined = configuration.inspect<string>("hover")?.workspaceFolderValue;
         const originalShowIntegralValuesInHexadecimal: boolean | undefined =
             configuration.inspect<boolean>("hoverShowIntegralValuesInHexadecimal")?.workspaceFolderValue;
+        const originalShowTypeSizeAndAlignment: boolean | undefined =
+            configuration.inspect<boolean>("hoverShowTypeSizeAndAlignment")?.workspaceFolderValue;
 
         try {
             await configuration.update("hover", "disabled", vscode.ConfigurationTarget.WorkspaceFolder);
             await configuration.update("hoverShowIntegralValuesInHexadecimal", true, vscode.ConfigurationTarget.WorkspaceFolder);
+            await configuration.update("hoverShowTypeSizeAndAlignment", false, vscode.ConfigurationTarget.WorkspaceFolder);
 
             const settings: CppSettings = new CppSettings(fileUri);
             assert.strictEqual(settings.hover, "disabled");
             assert.strictEqual(settings.hoverShowIntegralValuesInHexadecimal, true);
+            assert.strictEqual(settings.hoverShowTypeSizeAndAlignment, false);
         } finally {
+            await configuration.update(
+                "hoverShowTypeSizeAndAlignment",
+                originalShowTypeSizeAndAlignment,
+                vscode.ConfigurationTarget.WorkspaceFolder);
             await configuration.update(
                 "hoverShowIntegralValuesInHexadecimal",
                 originalShowIntegralValuesInHexadecimal,
@@ -128,6 +164,32 @@ suite("[Quick info test]", function(): void {
         }
     });
 
+    test("[Toggle type size and alignment command updates hover]", async () => {
+        const configuration: vscode.WorkspaceConfiguration = vscode.workspace.getConfiguration("C_Cpp", fileUri);
+        const originalShowTypeSizeAndAlignment: boolean | undefined =
+            configuration.inspect<boolean>("hoverShowTypeSizeAndAlignment")?.workspaceFolderValue;
+
+        try {
+            await configuration.update("hoverShowTypeSizeAndAlignment", true, vscode.ConfigurationTarget.WorkspaceFolder);
+            await waitForTypeHover(true);
+
+            await vscode.commands.executeCommand("C_Cpp.ToggleTypeSizeAndAlignment");
+            assert.strictEqual(configuration.inspect<boolean>("hoverShowTypeSizeAndAlignment")?.workspaceFolderValue, false);
+            const hiddenHover: string = await waitForTypeHover(false);
+            assert.ok(hiddenHover.includes("struct HoverType"));
+
+            await vscode.commands.executeCommand("C_Cpp.ToggleTypeSizeAndAlignment");
+            assert.strictEqual(configuration.inspect<boolean>("hoverShowTypeSizeAndAlignment")?.workspaceFolderValue, true);
+            const shownHover: string = await waitForTypeHover(true);
+            assert.ok(shownHover.includes("struct HoverType"));
+        } finally {
+            await configuration.update(
+                "hoverShowTypeSizeAndAlignment",
+                originalShowTypeSizeAndAlignment,
+                vscode.ConfigurationTarget.WorkspaceFolder);
+        }
+    });
+
     test("[Folder hexadecimal setting preserves global disabled hover]", async () => {
         const configuration: vscode.WorkspaceConfiguration = vscode.workspace.getConfiguration("C_Cpp", fileUri);
         const originalGlobalHover: string | undefined = configuration.inspect<string>("hover")?.globalValue;