Sub Entry Validators/Containers

src/main/java/ch/njol/skript/test/runner/StructTestEntryContainer.java

@@ -8,8 +8,6 @@
 import ch.njol.skript.lang.Trigger;
 import ch.njol.skript.lang.TriggerItem;
 import org.bukkit.event.Event;
-import org.bukkit.event.HandlerList;
-import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.skriptlang.skript.lang.entry.EntryContainer;
 import org.skriptlang.skript.lang.entry.EntryValidator;
@@ -20,13 +18,6 @@
 
 public class StructTestEntryContainer extends Structure {
 
-	public static class TestEvent extends Event {
-		@Override
-		public @NotNull HandlerList getHandlers() {
-			throw new IllegalStateException();
-		}
-	}
-
 	static {
 		if (TestMode.ENABLED)
 			Skript.registerStructure(StructTestEntryContainer.class,
@@ -55,7 +46,7 @@ public boolean load() {
 		List<TriggerItem> triggerItems = ScriptLoader.loadItems(section);
 		Script script = getParser().getCurrentScript();
 		Trigger trigger = new Trigger(script, "entry container test", null, triggerItems);
-		trigger.execute(new TestEvent());
+		trigger.execute(new SkriptTestEvent());
 		return true;
 	}
 

src/main/java/ch/njol/skript/test/runner/StructTestSubValidators.java

@@ -0,0 +1,73 @@
+package ch.njol.skript.test.runner;
+
+import ch.njol.skript.ScriptLoader;
+import ch.njol.skript.Skript;
+import ch.njol.skript.config.SectionNode;
+import ch.njol.skript.lang.Literal;
+import ch.njol.skript.lang.SkriptParser.ParseResult;
+import ch.njol.skript.lang.Trigger;
+import ch.njol.skript.lang.TriggerItem;
+import org.bukkit.event.Event;
+import org.jetbrains.annotations.Nullable;
+import org.skriptlang.skript.lang.entry.ContainerEntryData;
+import org.skriptlang.skript.lang.entry.EntryContainer;
+import org.skriptlang.skript.lang.entry.EntryValidator;
+import org.skriptlang.skript.lang.script.Script;
+import org.skriptlang.skript.lang.structure.Structure;
+
+import java.util.List;
+
+public class StructTestSubValidators extends Structure {
+
+	static {
+		if (TestMode.ENABLED)
+			Skript.registerStructure(StructTestSubValidators.class,
+				EntryValidator.builder()
+					.addEntryData(new ContainerEntryData("sub validator 1", false,
+						EntryValidator.builder()
+							.addSection("sub section", false)
+					))
+					.addEntryData(new ContainerEntryData("sub validator 2", false,
+						EntryValidator.builder()
+							.addEntryData(new ContainerEntryData("sub sub validator", false,
+								EntryValidator.builder()
+									.addSection("sub sub section", false)
+							))
+					))
+				.build(),
+				"test sub validators"
+			);
+	}
+
+	private EntryContainer entryContainer;
+
+	@Override
+	public boolean init(Literal<?>[] args, int matchedPattern, ParseResult parseResult, @Nullable EntryContainer entryContainer) {
+		this.entryContainer = entryContainer;
+		return true;
+	}
+
+	@Override
+	public boolean load() {
+		EntryContainer subEntry1 = entryContainer.get("sub validator 1", EntryContainer.class, false);
+		SectionNode section1 = subEntry1.get("sub section", SectionNode.class, false);
+		EntryContainer subEntry2 = entryContainer.get("sub validator 2", EntryContainer.class, false);
+		EntryContainer subSubEntry = subEntry2.get("sub sub validator", EntryContainer.class, false);
+		SectionNode section2 = subSubEntry.get("sub sub section", SectionNode.class, false);
+
+		List<TriggerItem> items1 = ScriptLoader.loadItems(section1);
+		List<TriggerItem> items2 = ScriptLoader.loadItems(section2);
+		Script script = getParser().getCurrentScript();
+		Trigger trigger1 = new Trigger(script, "sub section", null, items1);
+		Trigger trigger2 = new Trigger(script, "sub sub section", null, items2);
+		trigger1.execute(new SkriptTestEvent());
+		trigger2.execute(new SkriptTestEvent());
+		return true;
+	}
+
+	@Override
+	public String toString(@Nullable Event event, boolean debug) {
+		return "test sub entry validators";
+	}
+
+}

src/main/java/org/skriptlang/skript/lang/entry/ContainerEntryData.java

@@ -0,0 +1,59 @@
+package org.skriptlang.skript.lang.entry;
+
+import ch.njol.skript.ScriptLoader;
+import ch.njol.skript.config.Node;
+import ch.njol.skript.config.SectionNode;
+import org.jetbrains.annotations.Nullable;
+import org.skriptlang.skript.lang.entry.EntryValidator.EntryValidatorBuilder;
+import org.skriptlang.skript.lang.structure.Structure;
+
+/**
+ * Virtually the same as {@link EntryValidator}.
+ * Allows an {@link EntryValidator} used within a {@link Structure} to contain embedded {@link EntryValidator}s.
+ */
+public class ContainerEntryData extends EntryData<EntryContainer> {
+
+	private final EntryValidator entryValidator;
+	private EntryContainer entryContainer;
+
+	public ContainerEntryData(String key, boolean optional, EntryValidator entryValidator) {
+		super(key, null, optional);
+		this.entryValidator = entryValidator;
+	}
+
+	public ContainerEntryData(String key, boolean optional, EntryValidatorBuilder validatorBuilder) {
+		super(key, null, optional);
+		this.entryValidator = validatorBuilder.build();
+	}
+
+	/**
+	 * Since this will and should never be the main {@link EntryValidator} when used for a {@link Structure}
+	 * We need to validate it when the main {@link EntryValidator} is being validated.
+	 * @param sectionNode
+	 * @return
+	 */
+	public boolean validate(SectionNode sectionNode) {
+		EntryContainer container = entryValidator.validate(sectionNode);
+		entryContainer = container;
+		return container != null;
+	}
+
+	@Override
+	public @Nullable EntryContainer getValue(Node node) {
+		return entryContainer;
+	}
+
+	@Override
+	public boolean canCreateWith(Node node) {
+		if (!(node instanceof SectionNode))
+			return false;
+		String key = node.getKey();
+		if (key == null)
+			return false;
+		key = ScriptLoader.replaceOptions(key);
+		if (!getKey().equalsIgnoreCase(key))
+			return false;
+		return validate((SectionNode) node);
+	}
+
+}

src/main/java/org/skriptlang/skript/lang/entry/EntryData.java

@@ -28,8 +28,7 @@
 public abstract class EntryData<T> {
 
 	private final String key;
-	@Nullable
-	private final T defaultValue;
+	private final @Nullable T defaultValue;
 	private final boolean optional;
 
 	public EntryData(String key, @Nullable T defaultValue, boolean optional) {
@@ -49,8 +48,7 @@ public String getKey() {
 	 * @return The default value of this entry node to be used if {@link #getValue(Node)} is null,
 	 *  or if the user does not include an entry for this entry data within their {@link SectionNode}.
 	 */
-	@Nullable
-	public T getDefaultValue() {
+	public @Nullable T getDefaultValue() {
 		return defaultValue;
 	}
 
@@ -66,8 +64,7 @@ public boolean isOptional() {
 	 * @param node The node to obtain a value from.
 	 * @return The value obtained from the provided node.
 	 */
-	@Nullable
-	public abstract T getValue(Node node);
+	public abstract @Nullable T getValue(Node node);
 
 	/**
 	 * A method to be implemented by all entry data classes that determines whether

src/main/java/org/skriptlang/skript/lang/entry/EntryValidator.java

@@ -38,8 +38,7 @@ public static EntryValidatorBuilder builder() {
 
 	private final List<EntryData<?>> entryData;
 
-	@Nullable
-	private final Predicate<Node> unexpectedNodeTester;
+	private final @Nullable Predicate<Node> unexpectedNodeTester;
 
 	private final Function<String, String> unexpectedEntryMessage, missingRequiredEntryMessage;
 
@@ -71,8 +70,7 @@ public List<EntryData<?>> getEntryData() {
 	 *         The returned map uses the matched entry data's key as a key and uses a pair containing the entry data and matching node
 	 *         Will return null if the provided node couldn't be validated.
 	 */
-	@Nullable
-	public EntryContainer validate(SectionNode sectionNode) {
+	public @Nullable EntryContainer validate(SectionNode sectionNode) {
 		List<EntryData<?>> entries = new ArrayList<>(entryData);
 		Map<String, Node> handledNodes = new HashMap<>();
 		List<Node> unhandledNodes = new ArrayList<>();
@@ -132,11 +130,9 @@ private EntryValidatorBuilder() { }
 		private final List<EntryData<?>> entryData = new ArrayList<>();
 		private String entrySeparator = DEFAULT_ENTRY_SEPARATOR;
 
-		@Nullable
-		private Predicate<Node> unexpectedNodeTester;
+		private @Nullable Predicate<Node> unexpectedNodeTester;
 
-		@Nullable
-		private Function<String, String> unexpectedEntryMessage, missingRequiredEntryMessage;
+		private @Nullable Function<String, String> unexpectedEntryMessage, missingRequiredEntryMessage;
 
 		/**
 		 * Updates the separator to be used when creating KeyValue entries. Please note

src/main/java/org/skriptlang/skript/lang/entry/KeyValueEntryData.java

@@ -26,8 +26,7 @@ public KeyValueEntryData(String key, @Nullable T defaultValue, boolean optional)
 	 * @return The value obtained from the provided {@link SimpleNode}.
 	 */
 	@Override
-	@Nullable
-	public final T getValue(Node node) {
+	public final @Nullable T getValue(Node node) {
 		assert node instanceof SimpleNode;
 		String key = node.getKey();
 		if (key == null)
@@ -40,8 +39,7 @@ public final T getValue(Node node) {
 	 * @param value The String value to parse.
 	 * @return The parsed value.
 	 */
-	@Nullable
-	protected abstract T getValue(String value);
+	protected abstract @Nullable T getValue(String value);
 
 	/**
 	 * @return The String acting as a separator between the key and the value.

src/main/java/org/skriptlang/skript/lang/entry/util/VariableStringEntryData.java

@@ -1,12 +1,9 @@
 package org.skriptlang.skript.lang.entry.util;
 
 import ch.njol.skript.lang.VariableString;
-import ch.njol.skript.lang.parser.ParserInstance;
-import org.skriptlang.skript.lang.entry.KeyValueEntryData;
 import ch.njol.skript.util.StringMode;
-import ch.njol.util.Kleenean;
-import org.bukkit.event.Event;
 import org.jetbrains.annotations.Nullable;
+import org.skriptlang.skript.lang.entry.KeyValueEntryData;
 
 /**
  * A type of {@link KeyValueEntryData} designed to parse its value as a {@link VariableString}.
@@ -40,8 +37,7 @@ public VariableStringEntryData(
 	}
 
 	@Override
-	@Nullable
-	protected VariableString getValue(String value) {
+	protected @Nullable VariableString getValue(String value) {
 		// Double up quotations outside of expressions
 		if (stringMode != StringMode.VARIABLE_NAME)
 			value = VariableString.quote(value);

src/test/skript/junit/StructTestSubValidators.sk

@@ -0,0 +1,14 @@
+options:
+	test: "org.skriptlang.skript.test.tests.syntaxes.events.StructTestSubValidators"
+
+test "StructTestSubValidators" when running JUnit:
+	ensure junit test {@test} completes "sub section" and "sub sub section"
+
+test sub validators:
+	sub validator 1:
+		sub section:
+			complete objective "sub section" for {@test}
+	sub validator 2:
+		sub sub validator:
+			sub sub section:
+				complete objective "sub sub section" for {@test}