feat: better labels

Safe-DS · Nov 5, 2023 · 841bad1 · 841bad1
1 parent c9690a3
commit 841bad1
Show file tree

Hide file tree

Showing 2 changed files with 80 additions and 11 deletions.
diff --git a/packages/safe-ds-lang/src/language/lsp/safe-ds-signature-help-provider.ts b/packages/safe-ds-lang/src/language/lsp/safe-ds-signature-help-provider.ts
@@ -4,6 +4,7 @@ import {
     findLeafNodeAtOffset,
     findNodesForKeyword,
     getContainerOfType,
+    isNamed,
     type LangiumDocument,
     type MaybePromise,
     type SignatureHelpProvider,
@@ -15,11 +16,12 @@ import type {
     SignatureHelpParams,
 } from 'vscode-languageserver';
 import { createMarkupContent } from '../documentation/safe-ds-comment-provider.js';
-import { isSdsAbstractCall } from '../generated/ast.js';
+import { isSdsAbstractCall, SdsCallable, SdsParameter } from '../generated/ast.js';
 import { getParameters } from '../helpers/nodeProperties.js';
 import { type SafeDsNodeMapper } from '../helpers/safe-ds-node-mapper.js';
 import type { SafeDsServices } from '../safe-ds-module.js';
 import { type SafeDsTypeComputer } from '../typing/safe-ds-type-computer.js';
+import { CallableType, NamedType } from '../typing/model.js';
 
 export class SafeDsSignatureHelpProvider implements SignatureHelpProvider {
     private readonly documentationProvider: DocumentationProvider;
@@ -75,13 +77,8 @@ export class SafeDsSignatureHelpProvider implements SignatureHelpProvider {
         return {
             signatures: [
                 {
-                    label: this.typeComputer.computeType(callable).toString(),
-                    parameters: getParameters(callable).map((parameter) => {
-                        const type = this.typeComputer.computeType(parameter);
-                        return {
-                            label: `${parameter.name}: ${type}`,
-                        };
-                    }),
+                    label: this.getLabel(callable),
+                    parameters: getParameters(callable).map(this.getParameterInformation),
                     documentation: createMarkupContent(this.documentationProvider.getDocumentation(callable)),
                 },
             ],
@@ -90,12 +87,38 @@ export class SafeDsSignatureHelpProvider implements SignatureHelpProvider {
         };
     }
 
+    private getLabel(callable: SdsCallable): string {
+        const type = this.typeComputer.computeType(callable);
+
+        if (type instanceof NamedType) {
+            return `${type.declaration.name}(${getParameters(callable)
+                .map((it) => this.getParameterLabel(it))
+                .join(', ')})`;
+        } else if (type instanceof CallableType && isNamed(callable)) {
+            return `${callable.name}${type}`;
+        } else {
+            return type.toString();
+        }
+    }
+
+    private getParameterInformation = (parameter: SdsParameter) => {
+        return {
+            label: this.getParameterLabel(parameter),
+        };
+    };
+
+    private getParameterLabel = (parameter: SdsParameter) => {
+        const type = this.typeComputer.computeType(parameter);
+        return `${parameter.name}: ${type}`;
+    };
+
     /* c8 ignore start */
     get signatureHelpOptions(): SignatureHelpOptions {
         return {
             triggerCharacters: ['('],
             retriggerCharacters: [','],
         };
     }
+
     /* c8 ignore stop */
 }
diff --git a/packages/safe-ds-lang/tests/language/lsp/safe-ds-signature-help-provider.test.ts b/packages/safe-ds-lang/tests/language/lsp/safe-ds-signature-help-provider.test.ts
@@ -100,7 +100,7 @@ describe('SafeDsSignatureHelpProvider', async () => {
             `,
             expectedSignature: [
                 {
-                    label: '(p: Int) -> ()',
+                    label: 'A(p: Int) -> ()',
                     documentation: {
                         kind: 'markdown',
                         value: 'Lorem ipsum.',
@@ -114,7 +114,34 @@ describe('SafeDsSignatureHelpProvider', async () => {
             ],
         },
         {
-            testName: 'call',
+            testName: 'call (class)',
+            code: `
+                /**
+                 * Lorem ipsum.
+                 */
+                class C(p: Int)
+
+                pipeline myPipeline {
+                    C(»«);
+                }
+            `,
+            expectedSignature: [
+                {
+                    label: 'C(p: Int)',
+                    documentation: {
+                        kind: 'markdown',
+                        value: 'Lorem ipsum.',
+                    },
+                    parameters: [
+                        {
+                            label: 'p: Int',
+                        },
+                    ],
+                },
+            ],
+        },
+        {
+            testName: 'call (function)',
             code: `
                 /**
                  * Lorem ipsum.
@@ -127,7 +154,7 @@ describe('SafeDsSignatureHelpProvider', async () => {
             `,
             expectedSignature: [
                 {
-                    label: '(p: Int) -> ()',
+                    label: 'f(p: Int) -> ()',
                     documentation: {
                         kind: 'markdown',
                         value: 'Lorem ipsum.',
@@ -140,6 +167,25 @@ describe('SafeDsSignatureHelpProvider', async () => {
                 },
             ],
         },
+        {
+            testName: 'call (lambda)',
+            code: `
+                pipeline myPipeline {
+                    ((p: Int) {})(»«);
+                }
+            `,
+            expectedSignature: [
+                {
+                    label: '(p: Int) -> ()',
+                    documentation: undefined,
+                    parameters: [
+                        {
+                            label: 'p: Int',
+                        },
+                    ],
+                },
+            ],
+        },
     ])('should assign the correct signature ($testName)', async ({ code, expectedSignature }) => {
         const actualSignatureHelp = await getActualSignatureHelp(code);
         expect(actualSignatureHelp?.signatures).toStrictEqual(expectedSignature);