chore: remove builtin library xtext dependency

8 files changed, 369 insertions, 4 deletions

diff --git a/language-model/build.gradle b/language-model/build.gradle
index d01f8dfc..46ae839b 100644
--- a/language-model/build.gradle
+++ b/language-model/build.gradle
@@ -1,9 +1,11 @@
 apply plugin: 'java-library'
+apply plugin: 'java-test-fixtures'
 apply from: "${rootDir}/gradle/java-common.gradle"
 apply from: "${rootDir}/gradle/mwe2.gradle"
 
 dependencies {
         api "org.eclipse.emf:org.eclipse.emf.ecore:${ecoreVersion}"
+        api "org.eclipse.emf:org.eclipse.emf.ecore.xmi:${ecoreXmiVersion}"
         mwe2 "org.eclipse.emf:org.eclipse.emf.codegen.ecore:${ecoreCodegenVersion}"
         mwe2 "org.eclipse.emf:org.eclipse.emf.mwe.utils:${mweVersion}"
         mwe2 "org.eclipse.emf:org.eclipse.emf.mwe2.lib:${mwe2Version}"
diff --git a/language-model/plugin.xml b/language-model/plugin.xml
index 1e1a246e..4ca005a8 100644
--- a/language-model/plugin.xml
+++ b/language-model/plugin.xml
@@ -14,4 +14,11 @@
             genModel="src/main/resources/model/problem.genmodel"/>
    </extension>
 
+   <extension point="org.eclipse.emf.ecore.extension_parser">
+      <!-- @generated problem -->
+      <parser
+            type="problem_xmi"
+            class="tools.refinery.language.model.problem.util.ProblemResourceFactoryImpl"/>
+   </extension>
+
 </plugin>
diff --git a/language-model/src/main/java/tools/refinery/language/model/ProblemEMFSetup.java b/language-model/src/main/java/tools/refinery/language/model/ProblemEMFSetup.java
new file mode 100644
index 00000000..9383098b
--- /dev/null
+++ b/language-model/src/main/java/tools/refinery/language/model/ProblemEMFSetup.java
@@ -0,0 +1,34 @@
+package tools.refinery.language.model;
+
+import org.eclipse.emf.ecore.EPackage;
+import org.eclipse.emf.ecore.resource.Resource;
+
+import tools.refinery.language.model.problem.ProblemPackage;
+import tools.refinery.language.model.problem.impl.ProblemFactoryImpl;
+
+public class ProblemEMFSetup {
+        public static final String XMI_RESOURCE_EXTENSION = "problem_xmi";
+
+        private ProblemEMFSetup() {
+                throw new IllegalStateException("This is a static utility class and should not be instantiated directly");
+        }
+
+        // Here we can't rely on java.util.HashMap#putIfAbsent, because
+        // org.eclipse.emf.ecore.impl.EPackageRegistryImpl#containsKey is overridden
+        // without also overriding putIfAbsent. We must make sure to call the
+        // overridden containsKey implementation.
+        @SuppressWarnings("squid:S3824")
+        public static void doEMFRegistration() {
+                if (!EPackage.Registry.INSTANCE.containsKey(ProblemPackage.eNS_URI)) {
+                        EPackage.Registry.INSTANCE.put(ProblemPackage.eNS_URI, ProblemPackage.eINSTANCE);
+                }
+
+                // This Resource.Factory is not actually used once
+                // tools.refinery.language.ProblemStandaloneSetup.createInjectorAndDoEMFRegistration()
+                // is called, because if will be replaced by
+                // tools.refinery.language.resource.ProblemXmiResourceFactory, which implements
+                // org.eclipse.xtext.resource.IResourceFactory as required by Xtext.
+                Resource.Factory.Registry.INSTANCE.getExtensionToFactoryMap().putIfAbsent(XMI_RESOURCE_EXTENSION,
+                                new ProblemFactoryImpl());
+        }
+}
diff --git a/language-model/src/main/java/tools/refinery/language/model/ProblemUtil.java b/language-model/src/main/java/tools/refinery/language/model/ProblemUtil.java
new file mode 100644
index 00000000..b6b199f8
--- /dev/null
+++ b/language-model/src/main/java/tools/refinery/language/model/ProblemUtil.java
@@ -0,0 +1,102 @@
+package tools.refinery.language.model;
+
+import java.util.ArrayDeque;
+import java.util.Collection;
+import java.util.Deque;
+import java.util.HashSet;
+import java.util.Optional;
+import java.util.Set;
+
+import org.eclipse.emf.common.util.URI;
+import org.eclipse.emf.ecore.EObject;
+import org.eclipse.emf.ecore.resource.Resource;
+
+import tools.refinery.language.model.problem.ClassDeclaration;
+import tools.refinery.language.model.problem.Node;
+import tools.refinery.language.model.problem.Problem;
+import tools.refinery.language.model.problem.ProblemPackage;
+import tools.refinery.language.model.problem.ReferenceDeclaration;
+import tools.refinery.language.model.problem.Relation;
+import tools.refinery.language.model.problem.Variable;
+
+public final class ProblemUtil {
+        public static final String BUILTIN_LIBRARY_NAME = "builtin";
+
+        public static final URI BUILTIN_LIBRARY_URI = getLibraryUri(BUILTIN_LIBRARY_NAME);
+
+        public static final String NODE_CLASS_NAME = "node";
+
+        private ProblemUtil() {
+                throw new IllegalStateException("This is a static utility class and should not be instantiated directly");
+        }
+
+        public static boolean isSingletonVariable(Variable variable) {
+                return variable.eContainingFeature() == ProblemPackage.Literals.VARIABLE_OR_NODE_ARGUMENT__SINGLETON_VARIABLE;
+        }
+
+        public static boolean isUniqueNode(Node node) {
+                var containingFeature = node.eContainingFeature();
+                return containingFeature == ProblemPackage.Literals.UNIQUE_DECLARATION__NODES
+                                || containingFeature == ProblemPackage.Literals.ENUM_DECLARATION__LITERALS;
+        }
+
+        public static boolean isNewNode(Node node) {
+                return node.eContainingFeature() == ProblemPackage.Literals.CLASS_DECLARATION__NEW_NODE;
+        }
+
+        public static Optional<Problem> getBuiltInLibrary(EObject context) {
+                return Optional.ofNullable(context.eResource()).map(Resource::getResourceSet)
+                                .map(resourceSet -> resourceSet.getResource(BUILTIN_LIBRARY_URI, true)).map(Resource::getContents)
+                                .filter(contents -> !contents.isEmpty()).map(contents -> contents.get(0))
+                                .filter(Problem.class::isInstance).map(Problem.class::cast);
+        }
+
+        public static boolean isBuiltIn(EObject eObject) {
+                if (eObject != null) {
+                        var eResource = eObject.eResource();
+                        if (eResource != null) {
+                                return BUILTIN_LIBRARY_URI.equals(eResource.getURI());
+                        }
+                }
+                return false;
+        }
+
+        public static Optional<ClassDeclaration> getNodeClassDeclaration(EObject context) {
+                return getBuiltInLibrary(context).flatMap(problem -> problem.getStatements().stream()
+                                .filter(ClassDeclaration.class::isInstance).map(ClassDeclaration.class::cast)
+                                .filter(declaration -> NODE_CLASS_NAME.equals(declaration.getName())).findFirst());
+        }
+
+        public static Collection<ClassDeclaration> getSuperclassesAndSelf(ClassDeclaration classDeclaration) {
+                Set<ClassDeclaration> found = new HashSet<>();
+                getNodeClassDeclaration(classDeclaration).ifPresent(found::add);
+                Deque<ClassDeclaration> queue = new ArrayDeque<>();
+                queue.addLast(classDeclaration);
+                while (!queue.isEmpty()) {
+                        ClassDeclaration current = queue.removeFirst();
+                        if (!found.contains(current)) {
+                                found.add(current);
+                                for (Relation superType : current.getSuperTypes()) {
+                                        if (superType instanceof ClassDeclaration superDeclaration) {
+                                                queue.addLast(superDeclaration);
+                                        }
+                                }
+                        }
+                }
+                return found;
+        }
+
+        public static Collection<ReferenceDeclaration> getAllReferenceDeclarations(ClassDeclaration classDeclaration) {
+                Set<ReferenceDeclaration> referenceDeclarations = new HashSet<>();
+                for (ClassDeclaration superclass : getSuperclassesAndSelf(classDeclaration)) {
+                        referenceDeclarations.addAll(superclass.getReferenceDeclarations());
+                }
+                return referenceDeclarations;
+        }
+
+        private static URI getLibraryUri(String libraryName) {
+                return URI.createURI(ProblemUtil.class.getClassLoader()
+                                .getResource("model/" + libraryName + "." + ProblemEMFSetup.XMI_RESOURCE_EXTENSION)
+                                .toString());
+        }
+}
diff --git a/language-model/src/main/resources/model/builtin.problem_xmi b/language-model/src/main/resources/model/builtin.problem_xmi
new file mode 100644
index 00000000..9255ab66
--- /dev/null
+++ b/language-model/src/main/resources/model/builtin.problem_xmi
@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<problem:Problem
+    xmi:version="2.0"
+    xmlns:xmi="http://www.omg.org/XMI"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:problem="https://refinery.tools/emf/2021/Problem"
+    xsi:schemaLocation="https://refinery.tools/emf/2021/Problem problem.ecore"
+    name="builtin">
+  <statements
+      xsi:type="problem:ClassDeclaration"
+      name="node"
+      abstract="true">
+    <referenceDeclarations
+        name="equals"
+        referenceType="//@statements.0"
+        opposite="//@statements.0/@referenceDeclarations.0">
+      <multiplicity
+          xsi:type="problem:UnboundedMultiplicity"/>
+    </referenceDeclarations>
+  </statements>
+  <statements
+      xsi:type="problem:PredicateDefinition"
+      name="exists">
+    <parameters
+        name="node"
+        parameterType="//@statements.0"/>
+  </statements>
+  <statements
+      xsi:type="problem:ClassDeclaration"
+      name="domain"
+      abstract="true"
+      superTypes="//@statements.0"/>
+  <statements
+      xsi:type="problem:ClassDeclaration"
+      name="data"
+      abstract="true"
+      superTypes="//@statements.0"/>
+  <statements
+      xsi:type="problem:EnumDeclaration"
+      name="bool">
+    <literals
+        name="false"/>
+    <literals
+        name="true"/>
+  </statements>
+  <statements
+      xsi:type="problem:ClassDeclaration"
+      name="real"
+      superTypes="//@statements.3">
+    <newNode
+        name="new"/>
+  </statements>
+  <statements
+      xsi:type="problem:ClassDeclaration"
+      name="int"
+      superTypes="//@statements.3">
+    <newNode
+        name="new"/>
+  </statements>
+  <statements
+      xsi:type="problem:ClassDeclaration"
+      name="string"
+      superTypes="//@statements.3">
+    <newNode
+        name="new"/>
+  </statements>
+</problem:Problem>
diff --git a/language-model/src/main/resources/model/problem.ecore b/language-model/src/main/resources/model/problem.ecore
index a62590ac..e86f0afd 100644
--- a/language-model/src/main/resources/model/problem.ecore
+++ b/language-model/src/main/resources/model/problem.ecore
@@ -1,7 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <ecore:EPackage xmi:version="2.0" xmlns:xmi="http://www.omg.org/XMI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xmlns:ecore="http://www.eclipse.org/emf/2002/Ecore" name="problem" nsURI="https://refinery.tools/emf/2021/Problem"
-    nsPrefix="problem">
+    xmlns:ecore="http://www.eclipse.org/emf/2002/Ecore" name="problem" nsURI="https://refinery.tools/emf/2021/Problem" nsPrefix="problem">
   <eClassifiers xsi:type="ecore:EClass" name="Problem" eSuperTypes="#//NamedElement">
     <eStructuralFeatures xsi:type="ecore:EReference" name="nodes" upperBound="-1"
         eType="#//Node" containment="true"/>
diff --git a/language-model/src/main/resources/model/problem.genmodel b/language-model/src/main/resources/model/problem.genmodel
index e529977f..057b4917 100644
--- a/language-model/src/main/resources/model/problem.genmodel
+++ b/language-model/src/main/resources/model/problem.genmodel
@@ -8,8 +8,8 @@
     copyrightFields="false" operationReflection="true" importOrganizing="true">
   <foreignModel>problem.ecore</foreignModel>
   <testsDirectory xsi:nil="true"/>
-  <genPackages prefix="Problem" basePackage="tools.refinery.language.model"
-      disposableProviderFactory="true" ecorePackage="problem.ecore#/">
+  <genPackages prefix="Problem" basePackage="tools.refinery.language.model" resource="XMI"
+      disposableProviderFactory="true" fileExtensions="problem_xmi" ecorePackage="problem.ecore#/">
     <genEnums typeSafeEnumCompatible="false" ecoreEnum="problem.ecore#//LogicValue">
       <genEnumLiterals ecoreEnumLiteral="problem.ecore#//LogicValue/TRUE"/>
       <genEnumLiterals ecoreEnumLiteral="problem.ecore#//LogicValue/FALSE"/>
diff --git a/language-model/src/testFixtures/java/tools/refinery/language/model/tests/ProblemTestUtil.java b/language-model/src/testFixtures/java/tools/refinery/language/model/tests/ProblemTestUtil.java
new file mode 100644
index 00000000..b412ed1f
--- /dev/null
+++ b/language-model/src/testFixtures/java/tools/refinery/language/model/tests/ProblemTestUtil.java
@@ -0,0 +1,154 @@
+package tools.refinery.language.model.tests;
+
+import java.util.List;
+import java.util.stream.Stream;
+
+import org.eclipse.emf.ecore.resource.Resource.Diagnostic;
+import org.eclipse.emf.ecore.util.EcoreUtil;
+
+import tools.refinery.language.model.ProblemUtil;
+import tools.refinery.language.model.problem.Argument;
+import tools.refinery.language.model.problem.Assertion;
+import tools.refinery.language.model.problem.AssertionArgument;
+import tools.refinery.language.model.problem.Atom;
+import tools.refinery.language.model.problem.ClassDeclaration;
+import tools.refinery.language.model.problem.Conjunction;
+import tools.refinery.language.model.problem.EnumDeclaration;
+import tools.refinery.language.model.problem.Literal;
+import tools.refinery.language.model.problem.NamedElement;
+import tools.refinery.language.model.problem.NegativeLiteral;
+import tools.refinery.language.model.problem.Node;
+import tools.refinery.language.model.problem.NodeAssertionArgument;
+import tools.refinery.language.model.problem.NodeValueAssertion;
+import tools.refinery.language.model.problem.Parameter;
+import tools.refinery.language.model.problem.PredicateDefinition;
+import tools.refinery.language.model.problem.Problem;
+import tools.refinery.language.model.problem.ReferenceDeclaration;
+import tools.refinery.language.model.problem.Relation;
+import tools.refinery.language.model.problem.Statement;
+import tools.refinery.language.model.problem.UniqueDeclaration;
+import tools.refinery.language.model.problem.Variable;
+import tools.refinery.language.model.problem.VariableOrNode;
+import tools.refinery.language.model.problem.VariableOrNodeArgument;
+
+public class ProblemTestUtil {
+        public Problem builtin(Problem problem) {
+                return ProblemUtil.getBuiltInLibrary(problem).get();
+        }
+
+        public List<Diagnostic> errors(Problem problem) {
+                EcoreUtil.resolveAll(problem);
+                return problem.eResource().getErrors();
+        }
+
+        public List<String> nodeNames(Problem problem) {
+                return problem.getNodes().stream().map(node -> node.getName()).toList();
+        }
+
+        public PredicateDefinition pred(Problem problem, String name) {
+                return namedStatementOfType(problem, PredicateDefinition.class, name);
+        }
+
+        public Parameter param(PredicateDefinition definition, int i) {
+                return definition.getParameters().get(i);
+        }
+
+        public Conjunction conj(PredicateDefinition definition, int i) {
+                return definition.getBodies().get(i);
+        }
+
+        public Literal lit(Conjunction conjunction, int i) {
+                return conjunction.getLiterals().get(i);
+        }
+
+        public Atom negated(Literal literal) {
+                return ((NegativeLiteral) literal).getAtom();
+        }
+
+        public Relation relation(Literal literal) {
+                return ((Atom) literal).getRelation();
+        }
+
+        public Argument arg(Atom atom, int i) {
+                return atom.getArguments().get(i);
+        }
+
+        public Argument arg(Literal literal, int i) {
+                return arg((Atom) literal, i);
+        }
+
+        public VariableOrNode variableOrNode(Argument argument) {
+                return ((VariableOrNodeArgument) argument).getVariableOrNode();
+        }
+
+        public Variable variable(Argument argument) {
+                return (Variable) variableOrNode(argument);
+        }
+
+        public Node node(Argument argument) {
+                return (Node) variableOrNode(argument);
+        }
+
+        public Assertion assertion(Problem problem, int i) {
+                return nthStatementOfType(problem, Assertion.class, i);
+        }
+
+        public AssertionArgument arg(Assertion assertion, int i) {
+                return assertion.getArguments().get(i);
+        }
+
+        public Node node(AssertionArgument argument) {
+                return ((NodeAssertionArgument) argument).getNode();
+        }
+
+        public Node node(Problem problem, String name) {
+                return named(problem.getNodes(), name);
+        }
+
+        public Node uniqueNode(Problem problem, String name) {
+                var uniqueNodes = statementsOfType(problem, UniqueDeclaration.class)
+                                .flatMap(declaration -> declaration.getNodes().stream());
+                return named(uniqueNodes, name);
+        }
+
+        public NodeValueAssertion nodeValueAssertion(Problem problem, int i) {
+                return nthStatementOfType(problem, NodeValueAssertion.class, i);
+        }
+
+        public ClassDeclaration findClass(Problem problem, String name) {
+                return namedStatementOfType(problem, ClassDeclaration.class, name);
+        }
+
+        public ReferenceDeclaration reference(ClassDeclaration declaration, String name) {
+                return named(declaration.getReferenceDeclarations(), name);
+        }
+
+        public EnumDeclaration findEnum(Problem problem, String name) {
+                return namedStatementOfType(problem, EnumDeclaration.class, name);
+        }
+
+        public Node literal(EnumDeclaration declaration, String name) {
+                return named(declaration.getLiterals(), name);
+        }
+
+        private <T extends NamedElement> T named(Stream<? extends T> stream, String name) {
+                return stream.filter(statement -> name.equals(statement.getName())).findAny().get();
+        }
+
+        private <T extends NamedElement> T named(List<? extends T> list, String name) {
+                return named(list.stream(), name);
+        }
+
+        private <T extends Statement> Stream<T> statementsOfType(Problem problem, Class<? extends T> type) {
+                return problem.getStatements().stream().filter(type::isInstance).map(type::cast);
+        }
+
+        private <T extends Statement & NamedElement> T namedStatementOfType(Problem problem, Class<? extends T> type,
+                        String name) {
+                return named(statementsOfType(problem, type), name);
+        }
+
+        private <T extends Statement> T nthStatementOfType(Problem problem, Class<? extends T> type, int n) {
+                return statementsOfType(problem, type).skip(n).findFirst().get();
+        }
+}