Add settings for inlay hints feature (#9460)

Author: michelleangela

Extension/package.json

@@ -2211,6 +2211,30 @@
           "description": "%c_cpp.configuration.inactiveRegionBackgroundColor.description%",
           "scope": "resource"
         },
+        "C_Cpp.inlayHints.autoDeclarationTypes.enabled": {
+          "type": "boolean",
+          "default": true,
+          "markdownDescription": "%c_cpp.configuration.inlayHints.autoDeclarationTypes.enabled.markdownDescription%",
+          "scope": "application"
+        },
+        "C_Cpp.inlayHints.parameterNames.enabled": {
+          "type": "boolean",
+          "default": true,
+          "markdownDescription": "%c_cpp.configuration.inlayHints.parameterNames.enabled.markdownDescription%",
+          "scope": "application"
+        },
+        "C_Cpp.inlayHints.parameterNames.suppressWhenArgumentContainsName": {
+          "type": "boolean",
+          "default": true,
+          "markdownDescription": "%c_cpp.configuration.inlayHints.parameterNames.suppressWhenArgumentContainsName.markdownDescription%",
+          "scope": "application"
+        },
+        "C_Cpp.inlayHints.referenceOperator.enabled": {
+          "type": "boolean",
+          "default": true,
+          "markdownDescription": "%c_cpp.configuration.inlayHints.referenceOperator.enabled.markdownDescription%",
+          "scope": "application"
+        },
         "C_Cpp.loggingLevel": {
           "type": "string",
           "enum": [

Extension/package.nls.json

@@ -166,6 +166,10 @@
     "c_cpp.configuration.inactiveRegionOpacity.markdownDescription": { "message": "Controls the opacity of inactive preprocessor blocks. Scales between `0.1` and `1.0`. This setting only applies when inactive region dimming is enabled.", "comment": [ "Markdown text between `` should not be translated or localized (they represent literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered." ] },
     "c_cpp.configuration.inactiveRegionForegroundColor.description": "Controls the font coloring of inactive preprocessor blocks. Input is in the form a hexadecimal color code or a valid Theme Color. If not set, this defaults to the syntax coloring scheme of the editor. This setting only applies when inactive region dimming is enabled.",
     "c_cpp.configuration.inactiveRegionBackgroundColor.description": "Controls the background coloring of inactive preprocessor blocks. Input is in the form a hexadecimal color code or a valid Theme Color. If not set, this defaults to transparent. This setting only applies when inactive region dimming is enabled.",
+    "c_cpp.configuration.inlayHints.autoDeclarationTypes.enabled.markdownDescription": { "message": "Display inlay hints for deduced type when `auto` is used in a declaration:\n```cpp \n\n auto /* int */ index = 0;\n```", "comment": [ "Markdown text between `` and the text inside ``` block is code and should not be localized." ] },
+    "c_cpp.configuration.inlayHints.parameterNames.enabled.markdownDescription": { "message": "Display inlay hints for parameter names:\n```cpp \n\n int a = getArea(/* width: */ x, /* height: */ y);\n```", "comment": [ "Markdown text between `` and the text inside ``` block is code and should not be localized." ] },
+    "c_cpp.configuration.inlayHints.parameterNames.suppressWhenArgumentContainsName.markdownDescription": { "message": "Suppress parameter name hints when the argument text or inline comment contains the parameter name:\n```cpp \n\n int a = getArea(width, /* height: */ y);\n```", "comment": [ "Markdown text between `` and the text inside ``` block is code and should not be localized." ] },
+    "c_cpp.configuration.inlayHints.referenceOperator.enabled.markdownDescription": { "message": "Display the inlay hint reference operator `&` for parameters passed by non-const reference:\n```cpp \n\n swap(/* & first: */ str1, /* & last: */ str2);\n```", "comment": [ "Markdown text between `` and the text inside ``` block is code and should not be localized." ] },
     "c_cpp.configuration.loggingLevel.markdownDescription": { "message": "The verbosity of logging in the Output Panel. The order of levels from least verbose to most verbose is: `None` < `Error` < `Warning` < `Information` < `Debug`.", "comment": [ "Markdown text between `` should not be translated or localized (they represent literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered." ] },
     "c_cpp.configuration.autoAddFileAssociations.markdownDescription": { "message": "Controls whether files are automatically added to `#files.associations#` when they are the target of a navigation operation from a C/C++ file.", "comment": [ "Markdown text between `` should not be translated or localized (they represent literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered." ] },
     "c_cpp.configuration.workspaceParsingPriority.markdownDescription": { "message": "Controls whether parsing of the non-active workspace files uses sleeps to avoid using 100% CPU. The values `highest`/`high`/`medium`/`low` correspond to approximately 100/75/50/25% CPU usage.", "comment": [ "Markdown text between `` should not be translated or localized (they represent literal text) and the capitalization, spacing, and punctuation (including the ``) should not be altered." ] },

Extension/src/LanguageServer/Providers/inlayHintProvider.ts

@@ -5,6 +5,7 @@
 import * as vscode from 'vscode';
 import { DefaultClient, openFileVersions } from '../client';
 import { Position, RequestType } from 'vscode-languageclient';
+import { CppSettings } from '../settings';
 
 interface GetInlayHintsParams {
     uri: string;
@@ -20,7 +21,7 @@ interface CppInlayHint {
     label: string;
     inlayHintKind: InlayHintKind;
     isValueRef: boolean;
-    // hasParamName: boolean;
+    hasParamName: boolean;
 }
 
 interface GetInlayHintsResult {
@@ -83,35 +84,35 @@ export class InlayHintsProvider implements vscode.InlayHintsProvider {
 
     private buildVSCodeHints(cacheEntry: InlayHintsCacheEntry): vscode.InlayHint[] {
         let result: vscode.InlayHint[] = [];
-        const showTypeHintsEnabled: boolean = true; // TODO: get value from settings.
-        const showParamHintsEnabled: boolean = true; // TODO: get value from settings.
-        if (showTypeHintsEnabled) {
+        const settings: CppSettings = new CppSettings();
+        if (settings.inlayHintsAutoDeclarationTypes) {
             result = result.concat(cacheEntry?.TypeHints);
         }
-        if (showParamHintsEnabled) {
-            const resolvedParameterHints: vscode.InlayHint[] = this.resolveParameterHints(cacheEntry.ParameterHints);
-            result = result.concat(resolvedParameterHints);
-        }
+        const resolvedParameterHints: vscode.InlayHint[] = this.resolveParameterHints(cacheEntry.ParameterHints);
+        result = result.concat(resolvedParameterHints);
         return result;
     }
 
     private resolveParameterHints(hints: CppInlayHint[]): vscode.InlayHint[] {
         const resolvedHints: vscode.InlayHint[] = [];
-        const showRefEnabled: boolean = true; // TODO: get from settings
-        const hideParamNameEnabled: boolean = false; // TODO: get from settings
-        for (const h of hints) {
+        const settings: CppSettings = new CppSettings();
+        for (const hint of hints) {
             // Build parameter label based on settings.
-            // TODO: remove label if param includes parameter name or in comments.
-            const paramName: string = (hideParamNameEnabled /* && h.hasParamName*/) ? "" : h.label;
-            let refString: string = "";
-            if (showRefEnabled && h.isValueRef) {
-                refString = (paramName.length > 0) ? "& " : "&";
+            let paramHintLabel: string = "";
+            if (settings.inlayHintsParameterNames) {
+                paramHintLabel = (settings.inlayHintsParameterNamesSuppressName && hint.hasParamName) ? "" : hint.label;
+            }
+            let refOperatorString: string = "";
+            if (settings.inlayHintsReferenceOperator && hint.isValueRef) {
+                refOperatorString = (paramHintLabel.length > 0) ? "& " : "&";
+            }
+            let label: string = "";
+            if (paramHintLabel.length > 0 || refOperatorString.length > 0) {
+                label = refOperatorString +  paramHintLabel + ":";
             }
-            const colonString: string = (paramName.length > 0 || refString.length > 0) ? ":" : "";
-            const label: string = refString + paramName + colonString;
 
             const inlayHint: vscode.InlayHint = new vscode.InlayHint(
-                new vscode.Position(h.position.line, h.position.character),
+                new vscode.Position(hint.position.line, hint.position.character),
                 label,
                 vscode.InlayHintKind.Parameter);
             inlayHint.paddingRight = true;

Extension/src/LanguageServer/client.ts

@@ -719,7 +719,6 @@ export class DefaultClient implements Client {
     private codeFoldingProvider: FoldingRangeProvider | undefined;
     private codeFoldingProviderDisposable: vscode.Disposable | undefined;
     private inlayHintsProvider: InlayHintsProvider | undefined;
-    private inlayHintsProviderDisposable: vscode.Disposable | undefined;
     private semanticTokensProvider: SemanticTokensProvider | undefined;
     private semanticTokensProviderDisposable: vscode.Disposable | undefined;
     private innerConfiguration?: configs.CppProperties;
@@ -908,6 +907,9 @@ export class DefaultClient implements Client {
                         // e.g. prevents empty c_cpp_properties.json from generation.
                         this.registerFileWatcher();
 
+                        this.inlayHintsProvider = new InlayHintsProvider(this);
+
+                        this.disposables.push(vscode.languages.registerInlayHintsProvider(this.documentSelector, this.inlayHintsProvider));
                         this.disposables.push(vscode.languages.registerRenameProvider(this.documentSelector, new RenameProvider(this)));
                         this.disposables.push(vscode.languages.registerReferenceProvider(this.documentSelector, new FindAllReferencesProvider(this)));
                         this.disposables.push(vscode.languages.registerWorkspaceSymbolProvider(new WorkspaceSymbolProvider(this)));
@@ -927,12 +929,6 @@ export class DefaultClient implements Client {
                             this.semanticTokensProvider = new SemanticTokensProvider(this);
                             this.semanticTokensProviderDisposable = vscode.languages.registerDocumentSemanticTokensProvider(this.documentSelector, this.semanticTokensProvider, this.semanticTokensLegend);
                         }
-                        // TODO: enable based on settings.
-                        const isInlayHintsEnabled: boolean = true;
-                        if (isInlayHintsEnabled) {
-                            this.inlayHintsProvider = new InlayHintsProvider(this);
-                            this.inlayHintsProviderDisposable = vscode.languages.registerInlayHintsProvider(this.documentSelector, this.inlayHintsProvider);
-                        }
                         // Listen for messages from the language server.
                         this.registerNotifications();
                     } else {
@@ -1349,7 +1345,8 @@ export class DefaultClient implements Client {
                     autoSaveAfterDelay: settings_filesAutoSaveAfterDelay
                 },
                 editor: {
-                    autoClosingBrackets: settings_editorAutoClosingBrackets
+                    autoClosingBrackets: settings_editorAutoClosingBrackets,
+                    inlayHintsEnabled: workspaceOtherSettings.InlayHintsEnabled
                 },
                 workspace_fallback_encoding: workspaceOtherSettings.filesEncoding,
                 cpp_exclude_files: settings_cppFilesExclude,
@@ -1481,7 +1478,8 @@ export class DefaultClient implements Client {
                 }
             },
             editor: {
-                autoClosingBrackets: otherSettingsFolder.editorAutoClosingBrackets
+                autoClosingBrackets: otherSettingsFolder.editorAutoClosingBrackets,
+                inlayHintsEnabled: otherSettingsWorkspace.InlayHintsEnabled
             },
             files: {
                 encoding: otherSettingsFolder.filesEncoding,
@@ -3140,10 +3138,6 @@ export class DefaultClient implements Client {
             this.semanticTokensProviderDisposable.dispose();
             this.semanticTokensProviderDisposable = undefined;
         }
-        if (this.inlayHintsProviderDisposable) {
-            this.inlayHintsProviderDisposable.dispose();
-            this.inlayHintsProviderDisposable = undefined;
-        }
         this.model.dispose();
     }
 

Extension/src/LanguageServer/settings.ts

@@ -252,6 +252,22 @@ export class CppSettings extends Settings {
     public get codeFolding(): boolean { return super.Section.get<string>("codeFolding") === "Enabled"; }
     public get legacyCompilerArgsBehavior(): boolean | undefined  { return super.Section.get<boolean>("legacyCompilerArgsBehavior"); }
 
+    public get inlayHintsAutoDeclarationTypes(): boolean {
+        return super.Section.get<boolean>("inlayHints.autoDeclarationTypes.enabled") === true;
+    }
+
+    public get inlayHintsParameterNames(): boolean {
+        return super.Section.get<boolean>("inlayHints.parameterNames.enabled") === true;
+    }
+
+    public get inlayHintsParameterNamesSuppressName(): boolean {
+        return super.Section.get<boolean>("inlayHints.parameterNames.suppressWhenArgumentContainsName") === true;
+    }
+
+    public get inlayHintsReferenceOperator(): boolean {
+        return super.Section.get<boolean>("inlayHints.referenceOperator.enabled") === true;
+    }
+
     public get enhancedColorization(): boolean {
         return super.Section.get<string>("enhancedColorization") === "Enabled"
             && super.Section.get<string>("intelliSenseEngine") === "Default"
@@ -788,6 +804,7 @@ export class OtherSettings {
     }
     public get filesExclude(): vscode.WorkspaceConfiguration | undefined { return vscode.workspace.getConfiguration("files", this.resource).get("exclude"); }
     public get filesAutoSaveAfterDelay(): boolean { return vscode.workspace.getConfiguration("files").get("autoSave") === "afterDelay"; }
+    public get InlayHintsEnabled(): boolean { return vscode.workspace.getConfiguration("editor.inlayHints").get<string>("enabled") !== "off"; }
     public get searchExclude(): vscode.WorkspaceConfiguration | undefined { return vscode.workspace.getConfiguration("search", this.resource).get("exclude"); }
     public get settingsEditor(): string | undefined { return vscode.workspace.getConfiguration("workbench.settings").get<string>("editor"); }