1 files changed, 200 insertions, 0 deletions

diff --git a/subprojects/language-semantics/src/main/java/tools/refinery/language/semantics/metadata/MetadataCreator.java b/subprojects/language-semantics/src/main/java/tools/refinery/language/semantics/metadata/MetadataCreator.java
new file mode 100644
index 00000000..cc262129
--- /dev/null
+++ b/subprojects/language-semantics/src/main/java/tools/refinery/language/semantics/metadata/MetadataCreator.java
@@ -0,0 +1,200 @@
+/*
+ * SPDX-FileCopyrightText: 2023 The Refinery Authors <https://refinery.tools/>
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package tools.refinery.language.semantics.metadata;
+
+import com.google.inject.Inject;
+import org.eclipse.emf.ecore.EObject;
+import org.eclipse.xtext.naming.IQualifiedNameConverter;
+import org.eclipse.xtext.naming.IQualifiedNameProvider;
+import org.eclipse.xtext.naming.QualifiedName;
+import org.eclipse.xtext.scoping.IScope;
+import org.eclipse.xtext.scoping.IScopeProvider;
+import tools.refinery.language.model.problem.*;
+import tools.refinery.language.semantics.model.ModelInitializer;
+import tools.refinery.language.semantics.model.TracedException;
+import tools.refinery.language.utils.ProblemUtil;
+import tools.refinery.store.reasoning.representation.PartialRelation;
+
+import java.util.*;
+
+public class MetadataCreator {
+        @Inject
+        private IScopeProvider scopeProvider;
+
+        @Inject
+        private IQualifiedNameProvider qualifiedNameProvider;
+
+        @Inject
+        private IQualifiedNameConverter qualifiedNameConverter;
+
+        private ModelInitializer initializer;
+
+        private IScope nodeScope;
+
+        private IScope relationScope;
+
+        public void setInitializer(ModelInitializer initializer) {
+                if (initializer == null) {
+                        throw new IllegalArgumentException("Initializer was already set");
+                }
+                this.initializer = initializer;
+                var problem = initializer.getProblem();
+                nodeScope = scopeProvider.getScope(problem, ProblemPackage.Literals.NODE_ASSERTION_ARGUMENT__NODE);
+                relationScope = scopeProvider.getScope(problem, ProblemPackage.Literals.ASSERTION__RELATION);
+        }
+
+        public static String unnamedNode(int nodeId) {
+                return "::" + nodeId;
+        }
+
+        public List<NodeMetadata> getNodesMetadata() {
+                return getNodesMetadata(initializer.getNodeCount(), true);
+        }
+
+        public List<NodeMetadata> getNodesMetadata(int nodeCount, boolean preserveNewNodes) {
+                var nodes = new NodeMetadata[Math.max(initializer.getNodeCount(), nodeCount)];
+                for (var entry : initializer.getNodeTrace().keyValuesView()) {
+                        var node = entry.getOne();
+                        var id = entry.getTwo();
+                        nodes[id] = getNodeMetadata(id, node, preserveNewNodes);
+                }
+                for (int i = 0; i < nodes.length; i++) {
+                        if (nodes[i] == null) {
+                                var nodeName = unnamedNode(i);
+                                nodes[i] = new NodeMetadata(nodeName, nodeName, NodeKind.IMPLICIT);
+                        }
+                }
+                return List.of(nodes);
+        }
+
+        private NodeMetadata getNodeMetadata(int nodeId, Node node, boolean preserveNewNodes) {
+                var kind = getNodeKind(node);
+                if (!preserveNewNodes && kind == NodeKind.NEW) {
+                        var nodeName = unnamedNode(nodeId);
+                        return new NodeMetadata(nodeName, nodeName, NodeKind.IMPLICIT);
+                }
+                var qualifiedName = getQualifiedName(node);
+                var simpleName = getSimpleName(node, qualifiedName, nodeScope);
+                return new NodeMetadata(qualifiedNameConverter.toString(qualifiedName),
+                                qualifiedNameConverter.toString(simpleName), getNodeKind(node));
+        }
+
+        private NodeKind getNodeKind(Node node) {
+                if (ProblemUtil.isImplicitNode(node)) {
+                        return NodeKind.IMPLICIT;
+                } else if (ProblemUtil.isIndividualNode(node)) {
+                        return NodeKind.INDIVIDUAL;
+                } else if (ProblemUtil.isNewNode(node)) {
+                        return NodeKind.NEW;
+                } else {
+                        throw new TracedException(node, "Unknown node type");
+                }
+        }
+
+        public List<RelationMetadata> getRelationsMetadata() {
+                var relationTrace = initializer.getRelationTrace();
+                var relations = new ArrayList<RelationMetadata>(relationTrace.size());
+                for (var entry : relationTrace.entrySet()) {
+                        var relation = entry.getKey();
+                        var partialRelation = entry.getValue();
+                        var metadata = getRelationMetadata(relation, partialRelation);
+                        relations.add(metadata);
+                }
+                return Collections.unmodifiableList(relations);
+        }
+
+        private RelationMetadata getRelationMetadata(Relation relation, PartialRelation partialRelation) {
+                var qualifiedName = getQualifiedName(relation);
+                var qualifiedNameString = qualifiedNameConverter.toString(qualifiedName);
+                var simpleName = getSimpleName(relation, qualifiedName, relationScope);
+                var simpleNameString = qualifiedNameConverter.toString(simpleName);
+                var arity = partialRelation.arity();
+                var detail = getRelationDetail(relation, partialRelation);
+                return new RelationMetadata(qualifiedNameString, simpleNameString, arity, detail);
+        }
+
+        private RelationDetail getRelationDetail(Relation relation, PartialRelation partialRelation) {
+                if (ProblemUtil.isBuiltIn(relation) && !ProblemUtil.isError(relation)) {
+                        return getBuiltInDetail();
+                }
+                if (relation instanceof ClassDeclaration classDeclaration) {
+                        return getClassDetail(classDeclaration);
+                } else if (relation instanceof ReferenceDeclaration) {
+                        return getReferenceDetail(partialRelation);
+                } else if (relation instanceof EnumDeclaration) {
+                        return getEnumDetail();
+                } else if (relation instanceof PredicateDefinition predicateDefinition) {
+                        return getPredicateDetail(predicateDefinition);
+                } else {
+                        throw new TracedException(relation, "Unknown relation");
+                }
+        }
+
+        private RelationDetail getBuiltInDetail() {
+                return BuiltInDetail.INSTANCE;
+        }
+
+        private RelationDetail getClassDetail(ClassDeclaration classDeclaration) {
+                return ClassDetail.ofAbstractClass(classDeclaration.isAbstract());
+        }
+
+        private RelationDetail getReferenceDetail(PartialRelation partialRelation) {
+                var metamodel = initializer.getMetamodel();
+                var opposite = metamodel.oppositeReferences().get(partialRelation);
+                if (opposite == null) {
+                        boolean isContainment = metamodel.containmentHierarchy().containsKey(partialRelation);
+                        return ReferenceDetail.ofContainment(isContainment);
+                } else {
+                        boolean isContainer = metamodel.containmentHierarchy().containsKey(opposite);
+                        return new OppositeReferenceDetail(isContainer, opposite.name());
+                }
+        }
+
+        private RelationDetail getEnumDetail() {
+                return ClassDetail.CONCRETE_CLASS;
+        }
+
+        private RelationDetail getPredicateDetail(PredicateDefinition predicate) {
+                return PredicateDetail.ofError(predicate.isError());
+        }
+
+        private QualifiedName getQualifiedName(EObject eObject) {
+                var qualifiedName = qualifiedNameProvider.getFullyQualifiedName(eObject);
+                if (qualifiedName == null) {
+                        throw new TracedException(eObject, "Unknown qualified name");
+                }
+                return qualifiedName;
+        }
+
+        private QualifiedName getSimpleName(EObject eObject, QualifiedName qualifiedName, IScope scope) {
+                var descriptions = scope.getElements(eObject);
+                var names = new HashSet<QualifiedName>();
+                for (var description : descriptions) {
+                        // {@code getQualifiedName()} will refer to the full name for objects that are loaded from the global
+                        // scope, but {@code getName()} returns the qualified name that we set in
+                        // {@code ProblemResourceDescriptionStrategy}.
+                        names.add(description.getName());
+                }
+                var iterator = names.stream().sorted(Comparator.comparingInt(QualifiedName::getSegmentCount)).iterator();
+                while (iterator.hasNext()) {
+                        var simpleName = iterator.next();
+                        if (names.contains(simpleName) && isUnique(scope, simpleName)) {
+                                return simpleName;
+                        }
+                }
+                throw new TracedException(eObject, "Ambiguous qualified name: " +
+                                qualifiedNameConverter.toString(qualifiedName));
+        }
+
+        private boolean isUnique(IScope scope, QualifiedName name) {
+                var iterator = scope.getElements(name).iterator();
+                if (!iterator.hasNext()) {
+                        return false;
+                }
+                iterator.next();
+                return !iterator.hasNext();
+        }
+}