feat: custom identifier coloring

3 files changed, 56 insertions, 0 deletions

diff --git a/subprojects/language/src/main/java/tools/refinery/language/ProblemRuntimeModule.java b/subprojects/language/src/main/java/tools/refinery/language/ProblemRuntimeModule.java
index f9a564b0..f7039027 100644
--- a/subprojects/language/src/main/java/tools/refinery/language/ProblemRuntimeModule.java
+++ b/subprojects/language/src/main/java/tools/refinery/language/ProblemRuntimeModule.java
@@ -12,6 +12,7 @@ package tools.refinery.language;
 import com.google.inject.Binder;
 import com.google.inject.name.Names;
 import org.eclipse.xtext.conversion.IValueConverterService;
+import org.eclipse.xtext.documentation.impl.AbstractMultiLineCommentProvider;
 import org.eclipse.xtext.linking.ILinkingService;
 import org.eclipse.xtext.naming.IQualifiedNameConverter;
 import org.eclipse.xtext.naming.IQualifiedNameProvider;
@@ -144,4 +145,11 @@ public class ProblemRuntimeModule extends AbstractProblemRuntimeModule {
         public Class<? extends IDiagnosticConverter> bindIDiagnosticConverter() {
                 return ProblemDiagnosticConverter.class;
         }
+
+        public void configureAbstractMultiLineCommentProvider(Binder binder) {
+                // Only parse documentation tags from Javadoc-style comments.
+                binder.bind(String.class)
+                                .annotatedWith(Names.named(AbstractMultiLineCommentProvider.START_TAG))
+                                .toInstance("/\\*\\*");
+        }
 }
diff --git a/subprojects/language/src/main/java/tools/refinery/language/documentation/DocumentationCommentParser.java b/subprojects/language/src/main/java/tools/refinery/language/documentation/DocumentationCommentParser.java
new file mode 100644
index 00000000..3586abd2
--- /dev/null
+++ b/subprojects/language/src/main/java/tools/refinery/language/documentation/DocumentationCommentParser.java
@@ -0,0 +1,42 @@
+/*
+ * SPDX-FileCopyrightText: 2024 The Refinery Authors <https://refinery.tools/>
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package tools.refinery.language.documentation;
+
+import com.google.inject.Inject;
+import com.google.inject.Singleton;
+import org.eclipse.emf.ecore.EObject;
+import org.eclipse.xtext.documentation.IEObjectDocumentationProvider;
+
+import java.util.Locale;
+import java.util.Map;
+import java.util.regex.Pattern;
+
+@Singleton
+public class DocumentationCommentParser {
+        private static final String PREFIX = "tools.refinery.language.documentation.DocumentationCommentParser.";
+        public static final String COLOR_TAG = PREFIX + "COLOR_TAG";
+
+        private static final Pattern COLOR_PATTERN = Pattern.compile(
+                        "(?m)^@color[ \t]+(\\d|#[\\da-fA-F]{6}|#[\\da-fA-F]{3})");
+
+        @Inject
+        private IEObjectDocumentationProvider documentationProvider;
+
+        public Map<String, String> parseDocumentation(EObject eObject) {
+                var documentation = documentationProvider.getDocumentation(eObject);
+                if (documentation == null) {
+                        return Map.of();
+                }
+                var colorMatch = COLOR_PATTERN.matcher(documentation);
+                if (colorMatch.find()) {
+                        // Use a {@code _} instead of a {@code #} to signify hex codes, because the type hashes have to be valid
+                        // CSS class names.
+                        var color = colorMatch.group(1).toLowerCase(Locale.ROOT).replace("#", "_");
+                        return Map.of(COLOR_TAG, color);
+                }
+                return Map.of();
+        }
+}
diff --git a/subprojects/language/src/main/java/tools/refinery/language/resource/ProblemResourceDescriptionStrategy.java b/subprojects/language/src/main/java/tools/refinery/language/resource/ProblemResourceDescriptionStrategy.java
index 3080a78e..3dcf6b1f 100644
--- a/subprojects/language/src/main/java/tools/refinery/language/resource/ProblemResourceDescriptionStrategy.java
+++ b/subprojects/language/src/main/java/tools/refinery/language/resource/ProblemResourceDescriptionStrategy.java
@@ -18,6 +18,7 @@ import org.eclipse.xtext.resource.EObjectDescription;
 import org.eclipse.xtext.resource.IEObjectDescription;
 import org.eclipse.xtext.resource.impl.DefaultResourceDescriptionStrategy;
 import org.eclipse.xtext.util.IAcceptor;
+import tools.refinery.language.documentation.DocumentationCommentParser;
 import tools.refinery.language.naming.ProblemQualifiedNameProvider;
 import tools.refinery.language.scoping.imports.ImportCollector;
 import tools.refinery.language.model.problem.*;
@@ -56,6 +57,9 @@ public class ProblemResourceDescriptionStrategy extends DefaultResourceDescripti
         @Inject
         private ImportCollector importCollector;
 
+        @Inject
+        private DocumentationCommentParser documentationCommentParser;
+
         @Override
         public boolean createEObjectDescriptions(EObject eObject, IAcceptor<IEObjectDescription> acceptor) {
                 if (!shouldExport(eObject)) {
@@ -154,6 +158,8 @@ public class ProblemResourceDescriptionStrategy extends DefaultResourceDescripti
                 if (eObject instanceof PredicateDefinition predicateDefinition && predicateDefinition.isError()) {
                         builder.put(ERROR_PREDICATE, ERROR_PREDICATE_TRUE);
                 }
+                var documentationMap = documentationCommentParser.parseDocumentation(eObject);
+                builder.putAll(documentationMap);
                 return builder.build();
         }