feat: scoping for type arguments (#585)

Closes partially #540 ### Summary of Changes Implement scoping rules for the `typeParameter` property of a type argument. --------- Co-authored-by: megalinter-bot <129584137+megalinter-bot@users.noreply.github.com>
Safe-DS · Sep 30, 2023 · 3da8dd0 · 3da8dd0
1 parent ed0aa97
commit 3da8dd0
Show file tree

Hide file tree

Showing 11 changed files with 180 additions and 0 deletions.
diff --git a/src/language/scoping/safe-ds-scope-computation.ts b/src/language/scoping/safe-ds-scope-computation.ts
@@ -17,6 +17,7 @@ import {
     isSdsTypeParameterList,
     SdsClass,
     SdsEnum,
+    SdsEnumVariant,
     SdsTypeParameter,
 } from '../generated/ast.js';
 
@@ -26,6 +27,8 @@ export class SafeDsScopeComputation extends DefaultScopeComputation {
             this.processSdsClass(node, document, scopes);
         } else if (isSdsEnum(node)) {
             this.processSdsEnum(node, document, scopes);
+        } else if (isSdsEnumVariant(node)) {
+            this.processSdsEnumVariant(node, document, scopes);
         } else if (isSdsTypeParameter(node)) {
             this.processSdsTypeParameter(node, document, scopes);
         } else {
@@ -68,6 +71,19 @@ export class SafeDsScopeComputation extends DefaultScopeComputation {
         }
     }
 
+    private processSdsEnumVariant(node: SdsEnumVariant, document: LangiumDocument, scopes: PrecomputedScopes): void {
+        const name = this.nameProvider.getName(node);
+        if (!name) {
+            /* c8 ignore next 2 */
+            return;
+        }
+
+        const description = this.descriptions.createDescription(node, name, document);
+
+        this.addToScopesIfKeyIsDefined(scopes, node.parameterList, description);
+        this.addToScopesIfKeyIsDefined(scopes, node.constraintList, description);
+    }
+
     private processSdsTypeParameter(
         node: SdsTypeParameter,
         document: LangiumDocument,

diff --git a/src/language/scoping/safe-ds-scope-provider.ts b/src/language/scoping/safe-ds-scope-provider.ts
@@ -13,6 +13,7 @@ import {
     isSdsCallable,
     isSdsClass,
     isSdsEnum,
+    isSdsEnumVariant,
     isSdsLambda,
     isSdsMemberAccess,
     isSdsMemberType,
@@ -23,6 +24,7 @@ import {
     isSdsReference,
     isSdsSegment,
     isSdsStatement,
+    isSdsTypeArgument,
     isSdsYield,
     SdsDeclaration,
     SdsExpression,
@@ -33,6 +35,7 @@ import {
     SdsReference,
     SdsStatement,
     SdsType,
+    SdsTypeArgument,
     SdsYield,
 } from '../generated/ast.js';
 import {
@@ -42,6 +45,7 @@ import {
     parametersOrEmpty,
     resultsOrEmpty,
     statementsOrEmpty,
+    typeParametersOrEmpty,
 } from '../helpers/shortcuts.js';
 import { isContainedIn } from '../helpers/ast.js';
 import { isStatic } from '../helpers/checks.js';
@@ -62,6 +66,8 @@ export class SafeDsScopeProvider extends DefaultScopeProvider {
             } else {
                 return this.getScopeForDirectReferenceTarget(node);
             }
+        } else if (isSdsTypeArgument(node) && context.property === 'typeParameter') {
+            return this.getScopeForTypeArgumentTypeParameter(node);
         } else if (isSdsYield(node) && context.property === 'result') {
             return this.getScopeForYieldResult(node);
         } else {
@@ -291,6 +297,25 @@ export class SafeDsScopeProvider extends DefaultScopeProvider {
         }
     }
 
+    private getScopeForTypeArgumentTypeParameter(node: SdsTypeArgument): Scope {
+        const containingNamedType = getContainerOfType(node, isSdsNamedType);
+        if (!containingNamedType) {
+            /* c8 ignore next 2 */
+            return EMPTY_SCOPE;
+        }
+
+        const namedTypeDeclaration = containingNamedType.declaration.ref;
+        if (isSdsClass(namedTypeDeclaration)) {
+            const typeParameters = typeParametersOrEmpty(namedTypeDeclaration.typeParameterList);
+            return this.createScopeForNodes(typeParameters);
+        } else if (isSdsEnumVariant(namedTypeDeclaration)) {
+            const typeParameters = typeParametersOrEmpty(namedTypeDeclaration.typeParameterList);
+            return this.createScopeForNodes(typeParameters);
+        } else {
+            return EMPTY_SCOPE;
+        }
+    }
+
     private getScopeForYieldResult(node: SdsYield): Scope {
         const containingSegment = getContainerOfType(node, isSdsSegment);
         if (!containingSegment) {

diff --git a/tests/resources/scoping/named types/to enum variant in global enum/main.sdstest b/tests/resources/scoping/named types/to enum variant in global enum/main.sdstest
@@ -3,6 +3,11 @@ package test.scoping.namedTypes.toEnumVariantInGlobalEnum
 enum BeforeEnum {
     // $TEST$ target before
     »BeforeVariant«
+
+    Variant1
+
+    // $TEST$ unresolved
+    Variant2(a: »Variant1«)
 }
 
 class BeforeVariant

diff --git a/tests/resources/scoping/named types/to enum variant in nested enum/main.sdstest b/tests/resources/scoping/named types/to enum variant in nested enum/main.sdstest
@@ -4,6 +4,11 @@ class BeforeClass {
     enum BeforeEnum {
         // $TEST$ target before
         »BeforeVariant«
+
+        Variant1
+
+        // $TEST$ unresolved
+        Variant2(a: »Variant1«)
     }
 }
 

diff --git a/tests/resources/scoping/type arguments/to something other than type parameter/main.sdstest b/tests/resources/scoping/type arguments/to something other than type parameter/main.sdstest
@@ -0,0 +1,8 @@
+package test.scoping.typeArguments.toSomethingOtherThanTypeParameter
+
+// $TEST$ unresolved
+segment mySegment(p: MyClass<»notAtypeParameter« = Int>) {}
+
+class MyClass<T>
+
+fun notAtypeParameter()
diff --git a/...coping/type arguments/to type parameter in containing named type declaration/main.sdstest b/...coping/type arguments/to type parameter in containing named type declaration/main.sdstest
@@ -0,0 +1,66 @@
+package test.scoping.typeArguments.toTypeParameterInContainingNamedTypeDeclaration
+
+// $TEST$ target outerClass
+class MyClass<»T«>(
+    // $TEST$ references outerClass
+    p: MyClass<»T« = Int>,
+
+// $TEST$ references outerClass
+) sub MyClass<»T« = Int> where {
+
+    // $TEST$ references outerClass
+    T sub MyClass<»T« = Int>,
+} {
+    // $TEST$ references outerClass
+    attr a: MyClass<»T« = Int>
+
+    fun f<T>(
+        // $TEST$ references outerClass
+        p: MyClass<»T« = Int>,
+    ) -> (
+        // $TEST$ references outerClass
+        r: MyClass<»T« = Int>,
+    ) where {
+        // $TEST$ references outerClass
+        T sub MyClass<»T« = Int>,
+    }
+
+    enum MyEnum {
+        // $TEST$ target variant
+        MyEnumVariant<»T«>(
+            // $TEST$ references outerClass
+            p1: MyClass<»T« = Int>,
+
+            // $TEST$ references variant
+            p3: MyEnumVariant<»T« = Int>,
+        ) where {
+            // $TEST$ references outerClass
+            T sub MyClass<»T« = Int>,
+
+            // $TEST$ references variant
+            T sub MyEnumVariant<»T« = Int>,
+        }
+    }
+
+    // $TEST$ target innerClass
+    class MyClass<»T«>(
+        // $TEST$ references innerClass
+        p: MyClass<»T« = Int>,
+
+    // $TEST$ references innerClass
+    ) sub MyClass<»T« = Int> {
+        // $TEST$ references innerClass
+        attr a: MyClass<»T« = Int>
+
+        fun f<T>(
+            // $TEST$ references innerClass
+            p: MyClass<»T« = Int>,
+        ) -> (
+            // $TEST$ references innerClass
+            r: MyClass<»T« = Int>,
+        ) where {
+            // $TEST$ references innerClass
+            T sub MyClass<»T« = Int>,
+        }
+    }
+}
diff --git a/...rces/scoping/type arguments/to type parameter in enum variant in global enum/main.sdstest b/...rces/scoping/type arguments/to type parameter in enum variant in global enum/main.sdstest
@@ -0,0 +1,11 @@
+package test.scoping.typeArguments.toTypeParameterInEnumVariantInGlobalEnum
+
+enum MyEnum {
+    // $TEST$ target t
+    MyEnumVariant<»T«>
+}
+
+segment mySegment(
+    // $TEST$ references t
+    p: MyEnum.MyEnumVariant<»T« = Int>
+) {}
diff --git a/...rces/scoping/type arguments/to type parameter in enum variant in nested enum/main.sdstest b/...rces/scoping/type arguments/to type parameter in enum variant in nested enum/main.sdstest
@@ -0,0 +1,13 @@
+package test.scoping.typeArguments.toTypeParameterInEnumVariantInNestedEnum
+
+class MyClass<T> {
+    enum MyEnum {
+        // $TEST$ target t
+        MyEnumVariant<»T«>
+    }
+}
+
+segment mySegment(
+    // $TEST$ references t
+    p: MyClass.MyEnum.MyEnumVariant<»T« = Int>
+) {}
diff --git a/tests/resources/scoping/type arguments/to type parameter in global class/main.sdstest b/tests/resources/scoping/type arguments/to type parameter in global class/main.sdstest
@@ -0,0 +1,9 @@
+package test.scoping.typeArguments.toTypeParameterInGlobalClass
+
+// $TEST$ target t
+class MyClass<»T«>
+
+segment mySegment(
+    // $TEST$ references t
+    p: MyClass<»T« = Int>
+) {}
diff --git a/tests/resources/scoping/type arguments/to type parameter in nested class/main.sdstest b/tests/resources/scoping/type arguments/to type parameter in nested class/main.sdstest
@@ -0,0 +1,11 @@
+package test.scoping.typeArguments.toTypeParameterInNestedClass
+
+class MyClass<T> {
+    // $TEST$ target t
+    class MyNestedClass<»T«>
+}
+
+segment mySegment(
+    // $TEST$ references t
+    p: MyClass.MyNestedClass<»T« = Int>
+) {}
diff --git a/tests/resources/scoping/type arguments/to unresolved/main.sdstest b/tests/resources/scoping/type arguments/to unresolved/main.sdstest
@@ -0,0 +1,11 @@
+package test.scoping.typeArguments.toUnresolved
+
+segment mySegment(
+    // $TEST$ unresolved
+    p1: MyClass<»unresolved« = Int>,
+
+    // $TEST$ unresolved
+    p2: unresolved<»T« = Int>,
+) {}
+
+class MyClass<T>