work on tags and comments

Author: zml2008

buildSrc/src/main/kotlin/org/spongepowered/configurate/build/Extensions.kt

@@ -2,9 +2,11 @@ package org.spongepowered.configurate.build
 
 import org.gradle.api.GradleException
 import org.gradle.api.JavaVersion
+import org.gradle.api.Project
 import org.gradle.api.artifacts.Dependency
 import org.gradle.api.artifacts.dsl.DependencyHandler
 import org.gradle.api.artifacts.dsl.RepositoryHandler
+import org.gradle.api.plugins.JavaPlugin
 import org.gradle.api.tasks.javadoc.Javadoc
 import org.gradle.external.javadoc.StandardJavadocDocletOptions
 import org.gradle.kotlin.dsl.maven
@@ -49,3 +51,11 @@ fun Javadoc.applyCommonAttributes() {
         options.linkSource()
     }
 }
+
+fun Project.useAutoValue() {
+    val autoValueVersion = properties["autoValueVersion"]
+    dependencies.apply {
+        add(JavaPlugin.COMPILE_ONLY_CONFIGURATION_NAME, "com.google.auto.value:auto-value-annotations:$autoValueVersion")
+        add(JavaPlugin.ANNOTATION_PROCESSOR_CONFIGURATION_NAME, "com.google.auto.value:auto-value:$autoValueVersion")
+    }
+}

core/build.gradle.kts

@@ -1,12 +1,13 @@
+import org.spongepowered.configurate.build.useAutoValue
+
 plugins {
     id("org.spongepowered.configurate.build.component")
 }
 
+useAutoValue()
 dependencies {
     api("io.leangen.geantyref:geantyref:1.3.11")
     compileOnlyApi("org.checkerframework:checker-qual:3.7.0")
-    compileOnly("com.google.auto.value:auto-value-annotations:1.7.4")
-    annotationProcessor("com.google.auto.value:auto-value:1.7.4")
     testImplementation("com.google.guava:guava:30.0-jre")
 }
 

format/yaml/build.gradle.kts

@@ -1,12 +1,15 @@
 import net.ltgt.gradle.errorprone.errorprone
 import org.spongepowered.configurate.build.core
+import org.spongepowered.configurate.build.useAutoValue
 
 plugins {
     id("org.spongepowered.configurate.build.component")
 }
 
+useAutoValue()
 dependencies {
     api(core())
+    // When updating snakeyaml, check ConfigurateScanner for changes against upstream
     implementation("org.yaml:snakeyaml:1.27")
 }
 

format/yaml/src/main/java/org/spongepowered/configurate/yaml/ConfigurateScanner.java

@@ -238,6 +238,46 @@ final class ConfigurateScanner implements Scanner { // Configurate: rename + pac
      */
     private Map<Integer, SimpleKey> possibleSimpleKeys;
 
+    // Configurate start -- comment capture
+    private boolean captureComments = true;
+    private final StringBuilder comments = new StringBuilder();
+
+    public String popComments() {
+        if (this.comments.length() == 0) {
+            return null;
+        } else {
+            final String ret = this.comments.toString();
+            this.comments.delete(0, Integer.MAX_VALUE);
+            return ret;
+        }
+    }
+
+    private void pushComment(int length) {
+        if (!this.captureComments) {
+            this.reader.forward(length);
+            return;
+        }
+
+        if (this.comments.length() > 0) {
+            this.comments.append(org.spongepowered.configurate.loader.AbstractConfigurationLoader.CONFIGURATE_LINE_SEPARATOR);
+        }
+        final String comment = this.reader.prefixForward(length);
+        if (comment.startsWith(" ")) {
+            this.comments.append(comment, 1, comment.length());
+        } else {
+            this.comments.append(comment);
+        }
+    }
+
+    void setCaptureComments(boolean capture) {
+        this.captureComments = capture;
+        if (!capture && this.comments.length() > 0) {
+            this.comments.delete(0, Integer.MAX_VALUE);
+        }
+    }
+
+    // Configurate end -- comment capture
+
     public ConfigurateScanner(StreamReader reader) { // Configurate: rename
         this.reader = reader;
         this.tokens = new ArrayList<Token>(100);
@@ -1222,11 +1262,12 @@ private void scanToNextToken() {
             // past the comment.
             if (reader.peek() == '#') {
                 ff = 0;
+                reader.forward(); // skip comment character
                 while (Constant.NULL_OR_LINEBR.hasNo(reader.peek(ff))) {
                     ff++;
                 }
                 if (ff > 0) {
-                    reader.forward(ff);
+                    this.pushComment(ff); // Configurate: capture comment
                 }
             }
             // If we scanned a line break, then (depending on flow level),
@@ -1428,9 +1469,14 @@ private void scanDirectiveIgnoredLine(Mark startMark) {
             reader.forward();
         }
         if (reader.peek() == '#') {
+            // Configurate start -- comments
+            reader.forward(); // skip '#'
+            int ff = 0;
             while (Constant.NULL_OR_LINEBR.hasNo(reader.peek())) {
-                reader.forward();
+                ff++;
             }
+            if (ff > 0) pushComment(ff);
+            // Configurate end
         }
         int c = reader.peek();
         String lineBreak = scanLineBreak();
@@ -1743,9 +1789,15 @@ private String scanBlockScalarIgnoredLine(Mark startMark) {
 
         // If a comment occurs, scan to just before the end of line.
         if (reader.peek() == '#') {
+            // Configurate start -- comments
+            reader.forward();
+
+            int ff = 0;
             while (Constant.NULL_OR_LINEBR.hasNo(reader.peek())) {
-                reader.forward();
+                ff++;
             }
+            if (ff > 0) pushComment(ff);
+            // Configurate end
         }
         // If the next character is not a null or line break, an error has
         // occurred.
@@ -2008,7 +2060,7 @@ private Token scanPlain() {
             int c;
             int length = 0;
             // A comment indicates the end of the scalar.
-            if (reader.peek() == '#') {
+            if (reader.peek() == '#') { // Configurate: comment captured in scanToNextToken
                 break;
             }
             while (true) {
@@ -2029,7 +2081,7 @@ private Token scanPlain() {
             endMark = reader.getMark();
             spaces = scanPlainSpaces();
             // System.out.printf("spaces[%s]\n", spaces);
-            if (spaces.length() == 0 || reader.peek() == '#'
+            if (spaces.length() == 0 || reader.peek() == '#' // Configurate: comment captured in next token
                     || (this.flowLevel == 0 && this.reader.getColumn() < indent)) {
                 break;
             }

format/yaml/src/main/java/org/spongepowered/configurate/yaml/Tag.java

@@ -0,0 +1,97 @@
+/*
+ * Configurate
+ * Copyright (C) zml and Configurate contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.spongepowered.configurate.yaml;
+
+import com.google.auto.value.AutoValue;
+
+import java.lang.reflect.Type;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.util.regex.Pattern;
+
+/**
+ * A YAML 1.1/1.2 tag
+ *
+ * @apiNote Design based on §3.2.1.1 of the YAML 1.1 spec
+ */
+@AutoValue
+public abstract class Tag {
+
+    public static Tag.Builder builder() {
+        return new AutoValue_Tag.Builder();
+    }
+
+    // TODO: non-scalar tags, look into tagged unions?
+    Tag() {}
+
+    /**
+     * The canonical tag URI.
+     *
+     * @return tag uri, with `tag:` schema
+     */
+    public abstract URI getUri();
+
+    /**
+     * The native type that maps to this tag.
+     *
+     * @return native type for tag
+     */
+    public abstract Type getNativeType();
+
+    /**
+     * Pattern to test scalar values against when resolving this tag.
+     *
+     * @return match pattern
+     * @apiNote See §3.3.2 of YAML 1.1 spec
+     */
+    public abstract Pattern getTargetPattern();
+
+    /**
+     * Whether this tag is a global tag with a full namespace or a local one.
+     *
+     * @return if this is a global tag
+     */
+    public final boolean isGlobal() {
+        return getUri().getScheme().equals("tag");
+    }
+
+    @AutoValue.Builder
+    public abstract static class Builder {
+
+        public abstract Builder setUri(URI url);
+
+        public final Builder setUri(final String tagUrl) {
+            try {
+                if (tagUrl.startsWith("!")) {
+                    return this.setUri(new URI(tagUrl.substring(1)));
+                } else {
+                    return this.setUri(new URI(tagUrl));
+                }
+            } catch (final URISyntaxException e) {
+                throw new RuntimeException(e);
+            }
+        }
+
+        public abstract Builder setNativeType(Type type);
+
+        public abstract Builder setTargetPattern(Pattern targetPattern);
+
+        public abstract Tag build();
+
+    }
+
+}

format/yaml/src/main/java/org/spongepowered/configurate/yaml/TagRepository.java

@@ -0,0 +1,68 @@
+/*
+ * Configurate
+ * Copyright (C) zml and Configurate contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.spongepowered.configurate.yaml;
+
+import static io.leangen.geantyref.GenericTypeReflector.erase;
+
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.spongepowered.configurate.util.UnmodifiableCollections;
+
+import java.util.List;
+import java.util.Map;
+
+public final class TagRepository {
+
+    private final List<Tag> tags;
+    private final Map<Class<?>, Tag> byErasedType;
+    private final Map<String, Tag> byName;
+
+
+    /**
+     * Create a new tag repository.
+     *
+     * @param tags known tags
+     * @return new tag repository
+     */
+    public static TagRepository of(final List<Tag> tags) {
+        return new TagRepository(UnmodifiableCollections.copyOf(tags));
+    }
+
+    TagRepository(final List<Tag> tags) {
+        this.tags = tags;
+        this.byErasedType = UnmodifiableCollections.buildMap(map -> {
+            for (final Tag tag : this.tags) {
+                map.put(erase(tag.getNativeType()), tag);
+            }
+        });
+        this.byName = UnmodifiableCollections.buildMap(map -> {
+            for (final Tag tag : this.tags) {
+                map.put(tag.getUri().toString(), tag);
+            }
+        });
+    }
+
+    public @Nullable Tag forInput(final String scalar) {
+        for (final Tag tag : this.tags) {
+            if (tag.getTargetPattern().matcher(scalar).matches()) {
+                return tag;
+            }
+        }
+
+        return null;
+    }
+
+}