feat(web): color identifiers and nodes

We use a palette-based coloring strategy, where each class and enum gets a color
from

3 files changed, 99 insertions, 40 deletions

diff --git a/subprojects/language-web/src/main/java/tools/refinery/language/web/semantics/metadata/MetadataCreator.java b/subprojects/language-web/src/main/java/tools/refinery/language/web/semantics/metadata/MetadataCreator.java
index 67ef82ce..f05abc45 100644
--- a/subprojects/language-web/src/main/java/tools/refinery/language/web/semantics/metadata/MetadataCreator.java
+++ b/subprojects/language-web/src/main/java/tools/refinery/language/web/semantics/metadata/MetadataCreator.java
@@ -13,9 +13,7 @@ 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 org.jetbrains.annotations.NotNull;
 import tools.refinery.language.model.problem.*;
-import tools.refinery.language.semantics.NodeNameProvider;
 import tools.refinery.language.semantics.ProblemTrace;
 import tools.refinery.language.semantics.TracedException;
 import tools.refinery.language.utils.ProblemUtil;
@@ -23,14 +21,11 @@ import tools.refinery.store.model.Model;
 import tools.refinery.store.reasoning.ReasoningAdapter;
 import tools.refinery.store.reasoning.literal.Concreteness;
 import tools.refinery.store.reasoning.representation.PartialRelation;
-import tools.refinery.store.reasoning.translator.typehierarchy.TypeHierarchyTranslator;
-import tools.refinery.store.tuple.Tuple;
 
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.Comparator;
 import java.util.List;
-import java.util.function.IntFunction;
 
 public class MetadataCreator {
         @Inject
@@ -43,7 +38,7 @@ public class MetadataCreator {
         private IQualifiedNameConverter qualifiedNameConverter;
 
         @Inject
-        private Provider<NodeNameProvider> nodeNameProviderProvider;
+        private Provider<NodeMetadataFactory> nodeMetadataFactoryProvider;
 
         private ProblemTrace problemTrace;
         private IScope nodeScope;
@@ -63,56 +58,31 @@ public class MetadataCreator {
                 int nodeCount = model.getAdapter(ReasoningAdapter.class).getNodeCount();
                 var nodeTrace = problemTrace.getNodeTrace();
                 var nodes = new NodeMetadata[Math.max(nodeTrace.size(), nodeCount)];
-                var getName = makeGetName(model, concreteness);
+                var nodeMetadataFactory = nodeMetadataFactoryProvider.get();
+                nodeMetadataFactory.initialize(problemTrace, concreteness, model);
                 boolean preserveNewNodes = concreteness == Concreteness.PARTIAL;
                 for (var entry : nodeTrace.keyValuesView()) {
                         var node = entry.getOne();
                         var id = entry.getTwo();
-                        nodes[id] = getNodeMetadata(id, node, preserveNewNodes, getName);
+                        nodes[id] = getNodeMetadata(id, node, preserveNewNodes, nodeMetadataFactory);
                 }
                 for (int i = 0; i < nodes.length; i++) {
                         if (nodes[i] == null) {
-                                var nodeName = getName.apply(i);
-                                nodes[i] = new NodeMetadata(nodeName, nodeName, NodeKind.IMPLICIT);
+                                nodes[i] = nodeMetadataFactory.createFreshlyNamedMetadata(i);
                         }
                 }
                 return List.of(nodes);
         }
 
-        @NotNull
-        private IntFunction<String> makeGetName(Model model, Concreteness concreteness) {
-                var nodeNameProvider = nodeNameProviderProvider.get();
-                nodeNameProvider.setProblem(problemTrace.getProblem());
-                var typeInterpretation = model.getInterpretation(TypeHierarchyTranslator.TYPE_SYMBOL);
-                var existsInterpretation = model.getAdapter(ReasoningAdapter.class).getPartialInterpretation(concreteness,
-                                ReasoningAdapter.EXISTS_SYMBOL);
-                return nodeId -> {
-                        var key = Tuple.of(nodeId);
-                        var inferredType = typeInterpretation.get(key);
-                        if (inferredType == null || inferredType.candidateType() == null) {
-                                return nodeNameProvider.getNextName(null);
-                        }
-                        if (concreteness == Concreteness.CANDIDATE && !existsInterpretation.get(key).may()) {
-                                // Do not increment the node name counter for non-existent nodes in the candidate interpretation.
-                                // While non-existent nodes may appear in the partial interpretation, they are never displayed in the
-                                // candidate interpretation.
-                                return "::" + nodeId;
-                        }
-                        var relation = problemTrace.getRelation(inferredType.candidateType());
-                        return nodeNameProvider.getNextName(relation.getName());
-                };
-        }
-
         private NodeMetadata getNodeMetadata(int nodeId, Node node, boolean preserveNewNodes,
-                                                                                 IntFunction<String> getName) {
+                                                                                 NodeMetadataFactory nodeMetadataFactory) {
                 var kind = getNodeKind(node);
                 if (!preserveNewNodes && kind == NodeKind.NEW) {
-                        var nodeName = getName.apply(nodeId);
-                        return new NodeMetadata(nodeName, nodeName, NodeKind.IMPLICIT);
+                        return nodeMetadataFactory.createFreshlyNamedMetadata(nodeId);
                 }
                 var qualifiedName = getQualifiedName(node);
                 var simpleName = getSimpleName(node, qualifiedName, nodeScope);
-                return new NodeMetadata(qualifiedNameConverter.toString(qualifiedName),
+                return nodeMetadataFactory.doCreateMetadata(nodeId, qualifiedNameConverter.toString(qualifiedName),
                                 qualifiedNameConverter.toString(simpleName), getNodeKind(node));
         }
 
diff --git a/subprojects/language-web/src/main/java/tools/refinery/language/web/semantics/metadata/NodeMetadata.java b/subprojects/language-web/src/main/java/tools/refinery/language/web/semantics/metadata/NodeMetadata.java
index 5da28acf..f3347eac 100644
--- a/subprojects/language-web/src/main/java/tools/refinery/language/web/semantics/metadata/NodeMetadata.java
+++ b/subprojects/language-web/src/main/java/tools/refinery/language/web/semantics/metadata/NodeMetadata.java
@@ -1,9 +1,9 @@
 /*
- * SPDX-FileCopyrightText: 2023 The Refinery Authors <https://refinery.tools/>
+ * SPDX-FileCopyrightText: 2023-2023 The Refinery Authors <https://refinery.tools/>
  *
  * SPDX-License-Identifier: EPL-2.0
  */
 package tools.refinery.language.web.semantics.metadata;
 
-public record NodeMetadata(String name, String simpleName, NodeKind kind) implements Metadata {
+public record NodeMetadata(String name, String simpleName, String typeHash, NodeKind kind) implements Metadata {
 }
diff --git a/subprojects/language-web/src/main/java/tools/refinery/language/web/semantics/metadata/NodeMetadataFactory.java b/subprojects/language-web/src/main/java/tools/refinery/language/web/semantics/metadata/NodeMetadataFactory.java
new file mode 100644
index 00000000..ce0e50c1
--- /dev/null
+++ b/subprojects/language-web/src/main/java/tools/refinery/language/web/semantics/metadata/NodeMetadataFactory.java
@@ -0,0 +1,89 @@
+/*
+ * SPDX-FileCopyrightText: 2024 The Refinery Authors <https://refinery.tools/>
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package tools.refinery.language.web.semantics.metadata;
+
+import com.google.inject.Inject;
+import tools.refinery.language.ide.syntaxcoloring.TypeHashProvider;
+import tools.refinery.language.semantics.NodeNameProvider;
+import tools.refinery.language.semantics.ProblemTrace;
+import tools.refinery.store.model.Interpretation;
+import tools.refinery.store.model.Model;
+import tools.refinery.store.reasoning.ReasoningAdapter;
+import tools.refinery.store.reasoning.interpretation.PartialInterpretation;
+import tools.refinery.store.reasoning.literal.Concreteness;
+import tools.refinery.store.reasoning.representation.PartialRelation;
+import tools.refinery.store.reasoning.translator.typehierarchy.InferredType;
+import tools.refinery.store.reasoning.translator.typehierarchy.TypeHierarchyTranslator;
+import tools.refinery.store.representation.TruthValue;
+import tools.refinery.store.tuple.Tuple;
+
+public class NodeMetadataFactory {
+        @Inject
+        private NodeNameProvider nodeNameProvider;
+
+        @Inject
+        private TypeHashProvider typeHashProvider;
+
+        private ProblemTrace problemTrace;
+        private Concreteness concreteness;
+        private Interpretation<InferredType> typeInterpretation;
+        private PartialInterpretation<TruthValue, Boolean> existsInterpretation;
+
+        public void initialize(ProblemTrace problemTrace, Concreteness concreteness, Model model) {
+                this.problemTrace = problemTrace;
+                this.concreteness = concreteness;
+                typeInterpretation = model.getInterpretation(TypeHierarchyTranslator.TYPE_SYMBOL);
+                existsInterpretation = model.getAdapter(ReasoningAdapter.class).getPartialInterpretation(concreteness,
+                                ReasoningAdapter.EXISTS_SYMBOL);
+                nodeNameProvider.setProblem(problemTrace.getProblem());
+        }
+
+        public NodeMetadata doCreateMetadata(int nodeId, String name, String simpleName, NodeKind kind) {
+                var type = getType(nodeId);
+                return doCreateMetadata(name, simpleName, type, kind);
+        }
+
+        public NodeMetadata createFreshlyNamedMetadata(int nodeId) {
+                var type = getType(nodeId);
+                var name = getName(type, nodeId);
+                return doCreateMetadata(name, name, type, NodeKind.IMPLICIT);
+        }
+
+        private PartialRelation getType(int nodeId) {
+                var inferredType = typeInterpretation.get(Tuple.of(nodeId));
+                if (inferredType == null) {
+                        return null;
+                }
+                return inferredType.candidateType();
+        }
+
+        private String getName(PartialRelation type, int nodeId) {
+                if (concreteness == Concreteness.CANDIDATE && !existsInterpretation.get(Tuple.of(nodeId)).may()) {
+                        // Do not increment the node name counter for non-existent nodes in the candidate interpretation.
+                        // While non-existent nodes may appear in the partial interpretation, they are never displayed in the
+                        // candidate interpretation.
+                        return "::" + nodeId;
+                }
+                if (type == null) {
+                        return nodeNameProvider.getNextName(null);
+                }
+                var relation = problemTrace.getRelation(type);
+                return nodeNameProvider.getNextName(relation.getName());
+        }
+
+        private NodeMetadata doCreateMetadata(String name, String simpleName, PartialRelation type, NodeKind kind) {
+                var typeHash = getTypeHash(type);
+                return new NodeMetadata(name, simpleName, typeHash, kind);
+        }
+
+        private String getTypeHash(PartialRelation type) {
+                if (type == null) {
+                        return null;
+                }
+                var relation = problemTrace.getRelation(type);
+                return typeHashProvider.getTypeHash(relation);
+        }
+}