refactor(language): no fully qualified self import

Make sure it is impossible to create clashing fully qualified names when
renaming a module by forbidding modules from referring to their own elements
with fully qualified names. Therefore, serializing a solution will not create
clashing fully qualified names (which would prevent serialization from
succeeding).

4 files changed, 96 insertions, 90 deletions

diff --git a/subprojects/language/src/main/java/tools/refinery/language/scoping/NoFullyQualifiedNamesSelectable.java b/subprojects/language/src/main/java/tools/refinery/language/scoping/NoFullyQualifiedNamesSelectable.java
new file mode 100644
index 00000000..f9405fc1
--- /dev/null
+++ b/subprojects/language/src/main/java/tools/refinery/language/scoping/NoFullyQualifiedNamesSelectable.java
@@ -0,0 +1,62 @@
+/*
+ * SPDX-FileCopyrightText: 2024 The Refinery Authors <https://refinery.tools/>
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package tools.refinery.language.scoping;
+
+import com.google.common.base.Predicate;
+import com.google.common.collect.Iterables;
+import org.eclipse.emf.ecore.EClass;
+import org.eclipse.emf.ecore.EObject;
+import org.eclipse.xtext.naming.QualifiedName;
+import org.eclipse.xtext.resource.IEObjectDescription;
+import org.eclipse.xtext.resource.ISelectable;
+import tools.refinery.language.naming.NamingUtil;
+
+import java.util.List;
+
+public class NoFullyQualifiedNamesSelectable implements ISelectable {
+        private final ISelectable delegateSelectable;
+
+        // {@link com.google.common.base.Predicate} required by Xtext API.
+        @SuppressWarnings("squid:S4738")
+        private final Predicate<IEObjectDescription> filter =
+                        eObjectDescription -> !NamingUtil.isFullyQualified(eObjectDescription.getName());
+
+    public NoFullyQualifiedNamesSelectable(ISelectable delegateSelectable) {
+        this.delegateSelectable = delegateSelectable;
+    }
+
+    @Override
+        public boolean isEmpty() {
+                return delegateSelectable.isEmpty();
+        }
+
+        @Override
+        public Iterable<IEObjectDescription> getExportedObjects() {
+                return filter(delegateSelectable.getExportedObjects());
+        }
+
+        @Override
+        public Iterable<IEObjectDescription> getExportedObjects(EClass type, QualifiedName name, boolean ignoreCase) {
+                if (NamingUtil.isFullyQualified(name)) {
+                        return List.of();
+                }
+                return delegateSelectable.getExportedObjects(type, name, ignoreCase);
+        }
+
+        @Override
+        public Iterable<IEObjectDescription> getExportedObjectsByType(EClass type) {
+                return filter(delegateSelectable.getExportedObjectsByType(type));
+        }
+
+        @Override
+        public Iterable<IEObjectDescription> getExportedObjectsByObject(EObject object) {
+                return filter(delegateSelectable.getExportedObjectsByObject(object));
+        }
+
+        private Iterable<IEObjectDescription> filter(Iterable<IEObjectDescription> eObjectDescriptions) {
+                return Iterables.filter(eObjectDescriptions, filter);
+        }
+}
diff --git a/subprojects/language/src/main/java/tools/refinery/language/scoping/ProblemLocalScopeProvider.java b/subprojects/language/src/main/java/tools/refinery/language/scoping/ProblemLocalScopeProvider.java
index 1c0c1d86..0067bf94 100644
--- a/subprojects/language/src/main/java/tools/refinery/language/scoping/ProblemLocalScopeProvider.java
+++ b/subprojects/language/src/main/java/tools/refinery/language/scoping/ProblemLocalScopeProvider.java
@@ -12,7 +12,6 @@ import org.eclipse.emf.ecore.EReference;
 import org.eclipse.emf.ecore.resource.Resource;
 import org.eclipse.xtext.naming.IQualifiedNameProvider;
 import org.eclipse.xtext.naming.QualifiedName;
-import org.eclipse.xtext.resource.IResourceDescription;
 import org.eclipse.xtext.resource.IResourceDescriptionsProvider;
 import org.eclipse.xtext.resource.ISelectable;
 import org.eclipse.xtext.scoping.IScope;
@@ -39,41 +38,31 @@ public class ProblemLocalScopeProvider extends AbstractGlobalScopeDelegatingScop
                 if (resource == null) {
                         return IScope.NULLSCOPE;
                 }
+                var globalScope = getGlobalScope(resource, reference);
                 var localImports = cache.get(CACHE_KEY, resource, () -> computeLocalImports(resource));
-                if (localImports.resourceDescription() == null) {
-                        return IScope.NULLSCOPE;
+                if (localImports == null) {
+                        return globalScope;
                 }
-                var globalScope = getGlobalScope(resource, reference);
                 var type = reference.getEReferenceType();
                 boolean ignoreCase = isIgnoreCase(reference);
-                var scope = ShadowingKeyAwareSelectableBasedScope.createScope(globalScope, localImports.resourceDescription(),
-                                type, ignoreCase);
-                if (localImports.normalizedSelectable() == null) {
-                        return scope;
-                }
-                return ShadowingKeyAwareSelectableBasedScope.createScope(scope, localImports.normalizedSelectable(), type,
-                                ignoreCase);
+                return ShadowingKeyAwareSelectableBasedScope.createScope(globalScope, localImports, type, ignoreCase);
         }
 
-        protected LocalImports computeLocalImports(Resource resource) {
+        protected ISelectable computeLocalImports(Resource resource) {
                 // Force the use of ProblemResourceDescriptionStrategy to include all QualifiedNames of objects.
                 var resourceDescriptions = resourceDescriptionsProvider.getResourceDescriptions(resource.getResourceSet());
                 var resourceDescription = resourceDescriptions.getResourceDescription(resource.getURI());
                 if (resourceDescription == null) {
-                        return new LocalImports(null, null);
+                        return null;
                 }
                 var rootElement = resource.getContents().getFirst();
                 if (rootElement == null) {
-                        return new LocalImports(resourceDescription, null);
+                        return new NoFullyQualifiedNamesSelectable(resourceDescription);
                 }
                 var rootName = delegateQualifiedNameProvider.getFullyQualifiedName(rootElement);
                 if (rootName == null) {
-                        return new LocalImports(resourceDescription, null);
+                        return new NoFullyQualifiedNamesSelectable(resourceDescription);
                 }
-                var normalizedSelectable = new NormalizedSelectable(resourceDescription, rootName, QualifiedName.EMPTY);
-                return new LocalImports(resourceDescription, normalizedSelectable);
-        }
-
-        protected record LocalImports(IResourceDescription resourceDescription, ISelectable normalizedSelectable) {
+                return new NormalizedSelectable(resourceDescription, rootName, QualifiedName.EMPTY);
         }
 }
diff --git a/subprojects/language/src/main/java/tools/refinery/language/scoping/imports/ImportAdapter.java b/subprojects/language/src/main/java/tools/refinery/language/scoping/imports/ImportAdapter.java
index 5a8f7fd7..d7a5304f 100644
--- a/subprojects/language/src/main/java/tools/refinery/language/scoping/imports/ImportAdapter.java
+++ b/subprojects/language/src/main/java/tools/refinery/language/scoping/imports/ImportAdapter.java
@@ -12,7 +12,6 @@ import org.apache.log4j.Logger;
 import org.eclipse.emf.common.notify.Notification;
 import org.eclipse.emf.common.notify.impl.AdapterImpl;
 import org.eclipse.emf.common.util.URI;
-import org.eclipse.emf.ecore.EObject;
 import org.eclipse.emf.ecore.resource.Resource;
 import org.eclipse.emf.ecore.resource.ResourceSet;
 import org.eclipse.emf.ecore.util.EcoreUtil;
@@ -203,28 +202,4 @@ public class ImportAdapter extends AdapterImpl {
         private static ImportAdapter getAdapter(ResourceSet resourceSet) {
         return (ImportAdapter) EcoreUtil.getAdapter(resourceSet.eAdapters(), ImportAdapter.class);
         }
-
-        public static void copySettings(EObject context, ResourceSet newResourceSet) {
-                var resource = context.eResource();
-                if (resource == null) {
-                        return;
-                }
-                var originalResourceSet = resource.getResourceSet();
-                if (originalResourceSet == null) {
-                        return;
-                }
-                copySettings(originalResourceSet, newResourceSet);
-        }
-
-        public static void copySettings(ResourceSet originalResourceSet, ResourceSet newResourceSet) {
-                var originalAdapter = getAdapter(originalResourceSet);
-                if (originalAdapter == null) {
-                        return;
-                }
-                var newAdapter = getOrInstall(newResourceSet);
-                newAdapter.libraries.clear();
-                newAdapter.libraries.addAll(originalAdapter.libraries);
-                newAdapter.libraryPaths.clear();
-                newAdapter.libraryPaths.addAll(originalAdapter.libraryPaths);
-        }
 }
diff --git a/subprojects/language/src/test/java/tools/refinery/language/tests/scoping/NodeScopingTest.java b/subprojects/language/src/test/java/tools/refinery/language/tests/scoping/NodeScopingTest.java
index bc0320a6..0704e026 100644
--- a/subprojects/language/src/test/java/tools/refinery/language/tests/scoping/NodeScopingTest.java
+++ b/subprojects/language/src/test/java/tools/refinery/language/tests/scoping/NodeScopingTest.java
@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2021-2023 The Refinery Authors <https://refinery.tools/>
+ * SPDX-FileCopyrightText: 2021-2024 The Refinery Authors <https://refinery.tools/>
  *
  * SPDX-License-Identifier: EPL-2.0
  */
@@ -68,15 +68,14 @@ class NodeScopingTest {
                 assertThat(problem.assertion(0).arg(0).node(), equalTo(problem.node("b")));
         }
 
-        @ParameterizedTest
-        @MethodSource("atomNodeReferenceSource")
-        void atomNodeInAssertionTest(String qualifiedNamePrefix, boolean namedProblem) {
+        @Test
+        void atomNodeInAssertionTest() {
                 var problem = parse("""
                                 atom a, b.
                                 pred predicate(node x, node y) <-> node(x).
-                                predicate({PARAM}a, {PARAM}a).
-                                ?predicate({PARAM}a, {PARAM}b).
-                                """, qualifiedNamePrefix, namedProblem);
+                                predicate(a, a).
+                                ?predicate(a, b).
+                                """);
                 assertThat(problem.getResourceErrors(), empty());
                 assertThat(problem.nodeNames(), empty());
                 assertThat(problem.assertion(0).arg(0).node(), equalTo(problem.atomNode("a")));
@@ -85,22 +84,17 @@ class NodeScopingTest {
                 assertThat(problem.assertion(1).arg(1).node(), equalTo(problem.atomNode("b")));
         }
 
-        @ParameterizedTest
-        @MethodSource("atomNodeReferenceSource")
-        void atomNodeInPredicateTest(String qualifiedNamePrefix, boolean namedProblem) {
+        @Test
+        void atomNodeInPredicateTest() {
                 var problem = parse("""
                                 atom b.
-                                pred predicate(node a) <-> node({PARAM}b).
-                                """, qualifiedNamePrefix, namedProblem);
+                                pred predicate(node a) <-> node(b).
+                                """);
                 assertThat(problem.getResourceErrors(), empty());
                 assertThat(problem.nodeNames(), empty());
                 assertThat(problem.pred("predicate").conj(0).lit(0).arg(0).node(), equalTo(problem.atomNode("b")));
         }
 
-        static Stream<Arguments> atomNodeReferenceSource() {
-                return Stream.of(Arguments.of("", false), Arguments.of("", true), Arguments.of("test::", true));
-        }
-
         @Disabled("No nodes are present in builtin.problem currently")
         @ParameterizedTest
         @MethodSource("builtInNodeReferencesSource")
@@ -131,37 +125,30 @@ class NodeScopingTest {
                 return Stream.of(Arguments.of("int::new"), Arguments.of("builtin::int::new"));
         }
 
-        @ParameterizedTest
-        @MethodSource("classNewNodeReferencesSource")
-        void classNewNodeTest(String qualifiedName, boolean namedProblem) {
+        @Test
+        void classNewNodeTest() {
                 var problem = parse("""
                                 class Foo.
                                 pred predicate(node x) <-> node(x).
-                                predicate({PARAM}).
-                                """, qualifiedName, namedProblem);
+                                predicate(Foo::new).
+                                """);
                 assertThat(problem.getResourceErrors(), empty());
                 assertThat(problem.nodeNames(), empty());
                 assertThat(problem.assertion(0).arg(0).node(), equalTo(problem.findClass("Foo").get().getNewNode()));
         }
 
-        @ParameterizedTest
-        @MethodSource("classNewNodeReferencesSource")
-        void classNewNodeInPredicateTest(String qualifiedName, boolean namedProblem) {
+        @Test
+        void classNewNodeInPredicateTest() {
                 var problem = parse("""
                                 class Foo.
-                                pred predicate(node x) <-> node({PARAM}).
-                                """, qualifiedName, namedProblem);
+                                pred predicate(node x) <-> node(Foo::new).
+                                """);
                 assertThat(problem.getResourceErrors(), empty());
                 assertThat(problem.nodeNames(), empty());
                 assertThat(problem.pred("predicate").conj(0).lit(0).arg(0).node(),
                                 equalTo(problem.findClass("Foo").get().getNewNode()));
         }
 
-        static Stream<Arguments> classNewNodeReferencesSource() {
-                return Stream.of(Arguments.of("Foo::new", false), Arguments.of("Foo::new", true),
-                                Arguments.of("test::Foo::new", true));
-        }
-
         @Test
         void newNodeIsNotSpecial() {
                 var problem = parse("""
@@ -176,12 +163,12 @@ class NodeScopingTest {
 
         @ParameterizedTest
         @MethodSource("enumLiteralReferencesSource")
-        void enumLiteralTest(String qualifiedName, boolean namedProblem) {
+        void enumLiteralTest(String qualifiedName) {
                 var problem = parse("""
                                 enum Foo { alpha, beta }
                                 pred predicate(Foo a) <-> node(a).
                                 predicate({PARAM}).
-                                """, qualifiedName, namedProblem);
+                                """, qualifiedName);
                 assertThat(problem.getResourceErrors(), empty());
                 assertThat(problem.nodeNames(), empty());
                 assertThat(problem.assertion(0).arg(0).node(), equalTo(problem.findEnum("Foo").literal("alpha")));
@@ -189,11 +176,11 @@ class NodeScopingTest {
 
         @ParameterizedTest
         @MethodSource("enumLiteralReferencesSource")
-        void enumLiteralInPredicateTest(String qualifiedName, boolean namedProblem) {
+        void enumLiteralInPredicateTest(String qualifiedName) {
                 var problem = parse("""
                                 enum Foo { alpha, beta }
                                 pred predicate(Foo a) <-> node({PARAM}).
-                                """, qualifiedName, namedProblem);
+                                """, qualifiedName);
                 assertThat(problem.getResourceErrors(), empty());
                 assertThat(problem.nodeNames(), empty());
                 assertThat(problem.pred("predicate").conj(0).lit(0).arg(0).node(),
@@ -201,9 +188,7 @@ class NodeScopingTest {
         }
 
         static Stream<Arguments> enumLiteralReferencesSource() {
-                return Stream.of(Arguments.of("alpha", false), Arguments.of("alpha", true), Arguments.of("Foo::alpha", false),
-                                Arguments.of("Foo::alpha", true), Arguments.of("test::alpha", true),
-                                Arguments.of("test::Foo::alpha", true));
+                return Stream.of(Arguments.of("alpha"), Arguments.of("Foo::alpha"));
         }
 
         @Disabled("No enum literals are present in builtin.problem currently")
@@ -222,7 +207,7 @@ class NodeScopingTest {
         @Disabled("No enum literals are present in builtin.problem currently")
         @ParameterizedTest
         @MethodSource("builtInEnumLiteralReferencesSource")
-        void bultInEnumLiteralInPredicateTest(String qualifiedName) {
+        void builtInEnumLiteralInPredicateTest(String qualifiedName) {
                 var problem = parse("""
                                 pred predicate() <-> node({PARAM}).
                                 """, qualifiedName);
@@ -237,13 +222,8 @@ class NodeScopingTest {
                                 Arguments.of("builtin::bool::true"));
         }
 
-        private WrappedProblem parse(String text, String parameter, boolean namedProblem) {
-                var problemName = namedProblem ? "problem test.\n" : "";
-                return parseHelper.parse(problemName + text.replace("{PARAM}", parameter));
-        }
-
         private WrappedProblem parse(String text, String parameter) {
-                return parse(text, parameter, false);
+                return parseHelper.parse(text.replace("{PARAM}", parameter));
         }
 
         private WrappedProblem parse(String text) {