feat: Improve display of help

ProVerif · Feb 19, 2024 · 55f0e2f · 55f0e2f
1 parent 76fa9ae
commit 55f0e2f
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 18 deletions.
diff --git a/server/src/hover.ts b/server/src/hover.ts
@@ -1,5 +1,5 @@
 import {
-    Hover, LocationLink,
+    Hover, LocationLink, MarkupContent, MarkupKind,
     ParameterInformation,
     Position,
     SignatureHelp,
@@ -30,43 +30,55 @@ export const getHover = async (identifier: TextDocumentIdentifier, position: Pos
 
 const constructHover = (definitionSymbol: ProverifSymbol, source: ParseTree): Hover | undefined => {
     const range = getRange(source);
-    const contents = getFullName(definitionSymbol);
+    const fullName = getFullName(definitionSymbol);
+    const contents = createProverifMarkupContent(fullName);
 
     return {range, contents};
 };
 
+const createProverifMarkupContent = (proverifCode: string): MarkupContent => {
+    return {
+        kind: MarkupKind.Markdown,
+        value: [
+            '```pv',
+            proverifCode,
+            '```'
+        ].join('\n')
+    };
+};
+
 const getFullName = (definitionSymbol: ProverifSymbol): string => {
-    const declarationPrefix = getDeclarationPrefix(definitionSymbol.declaration)
-    const name = definitionSymbol.node.text
-    const parametersString = getParametersString(definitionSymbol.parameters)
-    const typeSuffix = getTypeSuffix(definitionSymbol.type)
+    const declarationPrefix = getDeclarationPrefix(definitionSymbol.declaration);
+    const name = definitionSymbol.node.text;
+    const parametersString = getParametersString(definitionSymbol.parameters);
+    const typeSuffix = getTypeSuffix(definitionSymbol.type);
 
-    return declarationPrefix + name + parametersString + typeSuffix
+    return declarationPrefix + name + parametersString + typeSuffix;
 };
 
 const getDeclarationPrefix = (declarationType: DeclarationType): string => {
     switch (declarationType) {
         case DeclarationType.Parameter:
         case DeclarationType.DefineParameter:
         case DeclarationType.ExpandParameter:
-            return "";
+            return "(parameter) ";
         default:
             return `${declarationType} `;
     }
 };
 
-const getParametersString = (parameters?: (ProverifSymbolParameter|undefined)[]): string => {
+const getParametersString = (parameters?: (ProverifSymbolParameter | undefined)[]): string => {
     if (!parameters) {
         return "";
     }
 
     const parameterListString = parameters
         .map(parameter => parameter ? parameter.node.text + getTypeSuffix(parameter.type) : "")
-        .join(", ")
+        .join(", ");
 
-    return `(${parameterListString})`
-}
+    return `(${parameterListString})`;
+};
 
 const getTypeSuffix = (type?: ParseTree) => {
-    return type ? ": " + type.text : ""
-}
+    return type ? ": " + type.text : "";
+};
diff --git a/server/src/server.ts b/server/src/server.ts
@@ -89,13 +89,13 @@ connection.onDefinition(async (params) => {
 });
 
 connection.onHover(async (params) => {
-    const hover = await getHover(params.textDocument, params.position, documentManager)
+    const hover = await getHover(params.textDocument, params.position, documentManager);
     if (!hover) {
-        return undefined
+        return undefined;
     }
 
-    return hover
-})
+    return hover;
+});
 
 connection.onDocumentLinks(async params => {
     const parseResult = await documentManager.getParseResult(params.textDocument);