feat(documentation/inlay-hints): show type for struct, messages and toCell() calls (#318)

Fixes #180
Fixes #167

Author: i582

package.json

@@ -235,10 +235,15 @@
                         "default": true,
                         "description": "Show method ID hints for contract functions"
                     },
-                    "tact.hints.showExplicitTLBIntType": {
+                    "tact.hints.showExplicitTLbIntType": {
                         "type": "boolean",
                         "default": true,
                         "description": "Show explicit TL-B type hints (as int257) for Int fields"
+                    },
+                    "tact.hints.showToCellSize": {
+                        "type": "boolean",
+                        "default": true,
+                        "description": "Show size in bits for `toCell()` calls"
                     }
                 }
             },

server/src/completion/CompletionContext.ts

@@ -263,7 +263,7 @@ export class CompletionContext {
         if (!type) return false
 
         if (this.contextTy instanceof OptionTy && type instanceof OptionTy) {
-            return this.contextTy.innerTy.name() === type.innerTy.name()
+            return this.contextTy.innerTy.qualifiedName() === type.innerTy.qualifiedName()
         }
 
         if (this.contextTy instanceof MapTy && type instanceof MapTy) {
@@ -276,15 +276,15 @@ export class CompletionContext {
 
         if (type instanceof OptionTy) {
             // Int and Int?
-            return type.innerTy.name() === this.contextTy.name()
+            return type.innerTy.qualifiedName() === this.contextTy.qualifiedName()
         }
 
         if (this.contextTy instanceof OptionTy) {
             // Int? and Int
-            return this.contextTy.innerTy.name() === type.name()
+            return this.contextTy.innerTy.qualifiedName() === type.qualifiedName()
         }
 
-        return this.contextTy.name() === type.name()
+        return this.contextTy.qualifiedName() === type.qualifiedName()
     }
 
     public expression(): boolean {

server/src/documentation/documentation.ts

@@ -18,6 +18,7 @@ import {getDocumentSettings, TactSettings} from "@server/utils/settings"
 import {File} from "@server/psi/File"
 import {Position} from "vscode-languageclient"
 import {asLspPosition} from "@server/utils/position"
+import {FieldsOwnerTy, sizeOfPresentation} from "@server/types/BaseTy"
 
 const CODE_FENCE = "```"
 const DOC_TMPL = `${CODE_FENCE}tact\n{signature}\n${CODE_FENCE}\n{documentation}\n`
@@ -148,14 +149,16 @@ export async function generateDocFor(node: NamedNode, place: SyntaxNode): Promis
             const doc = extractCommentsDoc(node)
             const struct = new Struct(node.node, node.file)
             const body = struct.body()?.text ?? ""
-            return defaultResult(`struct ${node.name()} ${body}`, doc)
+            const sizeDoc = documentationSizeOf(struct)
+            return defaultResult(`struct ${node.name()} ${body}`, doc + sizeDoc)
         }
         case "message": {
             const doc = extractCommentsDoc(node)
             const message = new Message(node.node, node.file)
             const body = message.body()?.text ?? ""
             const value = message.value()
-            return defaultResult(`message${value} ${node.name()} ${body}`, doc)
+            const sizeDoc = documentationSizeOf(message)
+            return defaultResult(`message${value} ${node.name()} ${body}`, doc + sizeDoc)
         }
         case "primitive": {
             const doc = extractCommentsDoc(node)
@@ -399,7 +402,14 @@ function requireFunctionDoc(place: SyntaxNode, file: File, settings: TactSetting
 
     const exitCode = compiler.requireFunctionExitCode(callNode, file, settings.hints.exitCodeFormat)
     if (!exitCode) return ""
-    return `Edit code: **${exitCode.value}**\n\n`
+    return `Exit code: **${exitCode.value}**\n\n`
+}
+
+function documentationSizeOf(struct: Struct): string {
+    const ty = new FieldsOwnerTy(struct.name(), struct)
+    const sizeOf = ty.sizeOf()
+    const sizeOfPres = sizeOfPresentation(sizeOf)
+    return `\n\n**Size**: ${sizeOfPres}`
 }
 
 function defaultResult(signature: string, documentation: string = ""): string {

server/src/e2e/suite/testcases/completion/constants.test

@@ -39,6 +39,7 @@ contract Foo {
     const<caret>
 }
 ------------------------------------------------------------------------
+13 state  generate getter for all contract state
 13 bounced(msg: <type>) {}
 13 const Foo: <type> = <value>
 13 external(msg: <type>) {}

server/src/e2e/suite/testcases/completion/contracts.test

@@ -5,6 +5,7 @@ contract Foo {
     <caret>
 }
 ------------------------------------------------------------------------
+13 state  generate getter for all contract state
 13 bounced(msg: <type>) {}
 13 const Foo: <type> = <value>
 13 external(msg: <type>) {}

server/src/e2e/suite/testcases/completion/traits.test

@@ -99,6 +99,7 @@ trait Child with Parent {
     <caret>
 }
 ------------------------------------------------------------------------
+13 name  generate getter for "name" field
 9  name: String; of Parent
 13 abstract fun name();
 13 bounced(msg: <type>) {}
@@ -133,7 +134,9 @@ trait Child with Parent {
     <caret>
 }
 ------------------------------------------------------------------------
+13 age  generate getter for "age" field
 9  age: Int; of Grand
+13 name  generate getter for "name" field
 9  name: String; of Parent
 13 abstract fun name();
 13 bounced(msg: <type>) {}
@@ -166,7 +169,10 @@ trait Child with Parent {
     <caret>
 }
 ------------------------------------------------------------------------
+13 age  generate getter for "age" field
 9  age: Int; of Parent
+13 name  generate getter for "name" field
+13 name  generate getter for "name" field
 13 abstract fun name();
 13 bounced(msg: <type>) {}
 13 const Foo: <type> = <value>

server/src/e2e/suite/testcases/documentation/require.test

@@ -13,4 +13,4 @@ fun foo() {
 ```tact
 fun require(that: Bool, msg: String)
 ```
-Edit code: **44401**
+Exit code: **44401**