Add setting to show inlay hints on the left. (#9506)

Author: sean-mcmanus

Extension/package.json

@@ -2217,6 +2217,12 @@
           "markdownDescription": "%c_cpp.configuration.inlayHints.autoDeclarationTypes.enabled.markdownDescription%",
           "scope": "application"
         },
+        "C_Cpp.inlayHints.autoDeclarationTypes.showOnLeft": {
+            "type": "boolean",
+            "default": false,
+            "markdownDescription": "%c_cpp.configuration.inlayHints.autoDeclarationTypes.showOnLeft.markdownDescription%",
+            "scope": "application"
+        },
         "C_Cpp.inlayHints.parameterNames.enabled": {
           "type": "boolean",
           "default": false,

Extension/package.nls.json

@@ -166,7 +166,8 @@
     "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.autoDeclarationTypes.enabled.markdownDescription": { "message": "Display inlay hints for deduced type when `auto` is used in a declaration:\n```cpp \n\n auto index /* : int */ = 0;\n```", "comment": [ "Markdown text between `` and the text inside ``` block is code and should not be localized." ] },
+    "c_cpp.configuration.inlayHints.autoDeclarationTypes.showOnLeft.markdownDescription": { "message": "Display inlay hints for deduced type when `auto` is used in a declaration on the left of the identifier:\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." ] },

Extension/src/LanguageServer/Providers/inlayHintProvider.ts

@@ -23,6 +23,8 @@ interface CppInlayHint {
     isValueRef: boolean;
     hasParamName: boolean;
     leftPadding: boolean;
+    rightPadding: boolean;
+    identifierLength: number;
 }
 
 interface GetInlayHintsResult {
@@ -124,14 +126,17 @@ export class InlayHintsProvider implements vscode.InlayHintsProvider {
 
     private createCacheEntry(inlayHintsResults: GetInlayHintsResult): InlayHintsCacheEntry {
         const typeHints: vscode.InlayHint[] = [];
+        const settings: CppSettings = new CppSettings();
         for (const h of inlayHintsResults.inlayHints) {
             if (h.inlayHintKind === InlayHintKind.Type) {
+                const showOnLeft: boolean = settings.inlayHintsAutoDeclarationTypesShowOnLeft && h.identifierLength > 0;
                 const inlayHint: vscode.InlayHint = new vscode.InlayHint(
-                    new vscode.Position(h.position.line, h.position.character),
-                    h.label,
+                    new vscode.Position(h.position.line, h.position.character +
+                        (showOnLeft ? 0 : h.identifierLength)),
+                    (showOnLeft ? h.label : ": " + h.label),
                     vscode.InlayHintKind.Type);
-                inlayHint.paddingRight = true;
-                inlayHint.paddingLeft = h.leftPadding;
+                inlayHint.paddingRight = showOnLeft || h.rightPadding;
+                inlayHint.paddingLeft = showOnLeft && h.leftPadding;
                 typeHints.push(inlayHint);
             }
         }

Extension/src/LanguageServer/settings.ts

@@ -256,6 +256,10 @@ export class CppSettings extends Settings {
         return super.Section.get<boolean>("inlayHints.autoDeclarationTypes.enabled") === true;
     }
 
+    public get inlayHintsAutoDeclarationTypesShowOnLeft(): boolean {
+        return super.Section.get<boolean>("inlayHints.autoDeclarationTypes.showOnLeft") === true;
+    }
+
     public get inlayHintsParameterNames(): boolean {
         return super.Section.get<boolean>("inlayHints.parameterNames.enabled") === true;
     }