Syntax Info Improvements (SkriptLang#8355)

Author: APickledWalrus

src/main/java/ch/njol/skript/lang/SkriptEventInfo.java

@@ -16,6 +16,7 @@
 import java.util.Collection;
 import java.util.List;
 import java.util.Locale;
+import java.util.SequencedCollection;
 
 /**
  * @deprecated Use {@link BukkitSyntaxInfos.Event} ({@link BukkitSyntaxInfos.Event#builder(Class, String)} instead.
@@ -294,13 +295,13 @@ public String id() {
 		}
 
 		@Override
-		public Collection<String> since() {
+		public SequencedCollection<String> since() {
 			String[] since = getSince();
 			return since != null ? List.of(since) : List.of();
 		}
 
 		@Override
-		public Collection<String> description() {
+		public SequencedCollection<String> description() {
 			String[] description = getDescription();
 			return description != null ? List.of(description) : List.of();
 		}

src/main/java/ch/njol/skript/lang/SyntaxElementInfo.java

@@ -15,8 +15,8 @@
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Modifier;
 import java.util.Arrays;
-import java.util.Collection;
 import java.util.List;
+import java.util.SequencedCollection;
 
 /**
  * @param <E> the syntax element this info is for
@@ -139,7 +139,7 @@ public E instance() {
 
 	@Override
 	@ApiStatus.Internal
-	public @Unmodifiable Collection<String> patterns() {
+	public @Unmodifiable SequencedCollection<String> patterns() {
 		if (source != null)
 			return source.patterns();
 		return List.of(getPatterns());

src/main/java/org/skriptlang/skript/addon/AddonModule.java

@@ -14,17 +14,16 @@
  * The <code>load</code> phase should be used for loading components more specific to the module, such as syntax.
  * @see SkriptAddon#loadModules(AddonModule...)
  */
-@FunctionalInterface
 public interface AddonModule {
 
 	/**
 	 * Constructs an origin from an addon and module name.
 	 * @param addon The addon providing the module.
-	 * @param moduleName The name of the providing module.
+	 * @param module The module to construct this origin from.
 	 * @return An origin from the provided information.
 	 */
-	static ModuleOrigin origin(SkriptAddon addon, String moduleName) {
-		return new AddonModuleImpl.ModuleOriginImpl(addon, moduleName);
+	static ModuleOrigin origin(SkriptAddon addon, AddonModule module) {
+		return new AddonModuleImpl.ModuleOriginImpl(addon, module.name());
 	}
 
 	/**
@@ -39,6 +38,17 @@ sealed interface ModuleOrigin extends AddonOrigin permits AddonModuleImpl.Module
 
 	}
 
+	/**
+	 * Allow addons to specify whether they can load or not.
+	 * Called prior to {@link #init(SkriptAddon)}
+	 *
+	 * @param addon The addon this module belongs to.
+	 * @return Whether this module can load.
+	 */
+	default boolean canLoad(SkriptAddon addon) {
+		return true;
+	}
+
 	/**
 	 * Used for loading the components of this module that are needed first or by other modules (e.g. class infos).
 	 * <b>This method will always be called before {@link #load(SkriptAddon)}</b>.
@@ -55,14 +65,8 @@ default void init(SkriptAddon addon) { }
 	void load(SkriptAddon addon);
 
 	/**
-	 * Allow addons to specify whether they can load or not.
-	 * Called prior to {@link #init(SkriptAddon)}
-	 *
-	 * @param addon The addon this module belongs to.
-	 * @return Whether this module can load.
+	 * @return The name of this module.
 	 */
-	default boolean canLoad(SkriptAddon addon) {
-		return true;
-	}
+	String name();
 
 }

src/main/java/org/skriptlang/skript/addon/AddonModuleImpl.java

@@ -4,6 +4,13 @@
 
 class AddonModuleImpl {
 
-	public record ModuleOriginImpl(SkriptAddon addon, String moduleName) implements ModuleOrigin { }
+	public record ModuleOriginImpl(SkriptAddon addon, String moduleName) implements ModuleOrigin {
+
+		public ModuleOriginImpl(SkriptAddon addon, String moduleName) {
+			this.addon = addon.unmodifiableView();
+			this.moduleName = moduleName;
+		}
+
+	}
 
 }

src/main/java/org/skriptlang/skript/bukkit/brewing/BrewingModule.java

@@ -41,4 +41,9 @@ private void register(SyntaxRegistry registry, Consumer<SyntaxRegistry>... consu
 		Arrays.stream(consumers).forEach(consumer -> consumer.accept(registry));
 	}
 
+	@Override
+	public String name() {
+		return "brewing";
+	}
+
 }

src/main/java/org/skriptlang/skript/bukkit/damagesource/DamageSourceModule.java

@@ -61,4 +61,9 @@ public void load(SkriptAddon addon) {
 		}
 	}
 
+	@Override
+	public String name() {
+		return "damage source";
+	}
+
 }

src/main/java/org/skriptlang/skript/bukkit/entity/EntityModule.java

@@ -18,4 +18,9 @@ public void load(SkriptAddon addon) {
 		}
 	}
 
+	@Override
+	public String name() {
+		return "entity";
+	}
+
 }

src/main/java/org/skriptlang/skript/bukkit/interactions/InteractionModule.java

@@ -48,4 +48,9 @@ public enum InteractionType {
 		return interact;
 	}
 
+	@Override
+	public String name() {
+		return "interaction";
+	}
+
 }

src/main/java/org/skriptlang/skript/bukkit/itemcomponents/ItemComponentModule.java

@@ -52,4 +52,9 @@ public void load(SkriptAddon addon) {
 		ExprItemCompCopy.register(addon.syntaxRegistry());
 	}
 
+	@Override
+	public String name() {
+		return "item component";
+	}
+
 }

src/main/java/org/skriptlang/skript/bukkit/itemcomponents/equippable/EquippableModule.java

@@ -101,4 +101,9 @@ private void register(SyntaxRegistry registry, Consumer<SyntaxRegistry>... consu
 		Arrays.stream(consumers).forEach(consumer -> consumer.accept(registry));
 	}
 
+	@Override
+	public String name() {
+		return "equippable component";
+	}
+
 }