child module support

Author: sovdeeth

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

@@ -14,28 +14,27 @@
  * 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 moduleNames The names of the providing modules. The most specific module name should be first.
 	 * @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, String... moduleNames) {
+		return new AddonModuleImpl.ModuleOriginImpl(addon, moduleNames);
 	}
 
 	/**
-	 * An origin to be used for something provided by a module of an addon.
+	 * An origin to be used for something provided by one or more modules of an addon.
 	 */
-	sealed interface ModuleOrigin extends AddonOrigin permits AddonModuleImpl.ModuleOriginImpl {
+	sealed interface ModuleOrigin extends AddonOrigin permits AddonModuleImpl.ModuleOriginImpl, ChildAddonModule.ChildModuleOriginImpl {
 
 		/**
-		 * @return The name of the module represented by this origin.
+		 * @return The names of the modules represented by this origin.
 		 */
-		String moduleName();
+		String[] moduleNames();
 
 	}
 
@@ -65,4 +64,16 @@ default boolean canLoad(SkriptAddon addon) {
 		return true;
 	}
 
+	/**
+	 * @return A name representing this module to be using in the {@link ModuleOrigin}. e.g. "discord", "nbt", "particles"...
+	 */
+	String name();
+
+	/**
+	 * @return An origin representing this module.
+	 */
+	default ModuleOrigin origin(SkriptAddon addon) {
+		return AddonModule.origin(addon, name());
+	}
+
 }

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

@@ -4,6 +4,6 @@
 
 class AddonModuleImpl {
 
-	public record ModuleOriginImpl(SkriptAddon addon, String moduleName) implements ModuleOrigin { }
+	public record ModuleOriginImpl(SkriptAddon addon, String... moduleNames) implements ModuleOrigin { }
 
 }

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

@@ -0,0 +1,112 @@
+package org.skriptlang.skript.addon;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * A child module is intended to be created by another {@link AddonModule} as a way to further organize elements.
+ * It behaves the same way as a normal module, but allows accessing the parent module if needed.
+ */
+public abstract class ChildAddonModule implements AddonModule {
+
+	private final AddonModule parentModule;
+
+	/**
+	 * Constructs an origin from an addon and module name.
+	 * @param addon The addon providing the module.
+	 * @param moduleName The name of the providing module.
+	 * @return An origin from the provided information.
+	 */
+	static ModuleOrigin origin(SkriptAddon addon, AddonModule parentModule, String moduleName) {
+		return new ChildModuleOriginImpl(addon, parentModule, moduleName);
+	}
+
+	/**
+	 * An origin to be used for something provided by a child module of an addon.
+	 */
+	static final class ChildModuleOriginImpl implements ModuleOrigin {
+
+		SkriptAddon addon;
+		AddonModule parentModule;
+		String[] moduleNames;
+
+		/**
+		 * Constructs a child module origin.
+		 * @param addon The addon providing the module. Ideally, this is the same as the parent module's addon.
+		 * @param parentModule The parent module that created this child module.
+		 * @param moduleName The name of the providing module.
+		 */
+		public ChildModuleOriginImpl(SkriptAddon addon, AddonModule parentModule, String moduleName) {
+			this.addon = addon;
+			this.parentModule = parentModule;
+
+			List<String> names = new ArrayList<>(List.of(moduleName));
+			names.addAll(List.of(parentModule.origin(addon).moduleNames()));
+			moduleNames = names.toArray(new String[0]);
+		}
+
+		@Override
+		public String[] moduleNames() {
+			return moduleNames;
+		}
+
+		@Override
+		public SkriptAddon addon() {
+			return addon;
+		}
+
+	}
+
+	protected ChildAddonModule(AddonModule parentModule) {
+		this.parentModule = parentModule;
+	}
+
+	@Override
+	public void init(SkriptAddon addon) {
+		init(addon, parentModule);
+	}
+
+	/**
+	 * 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, AddonModule)}</b>.
+	 * @param addon The addon this module belongs to.
+	 * @param parentModule The parent module that created this child module.
+	 * @see #load(SkriptAddon)
+	 */
+	protected abstract void init(SkriptAddon addon, AddonModule parentModule);
+
+	@Override
+	public void load(SkriptAddon addon) {
+		load(addon, parentModule);
+	}
+
+	/**
+	 * Used for loading the components (e.g. syntax) of this module.
+	 * @param addon The addon this module belongs to.
+	 * @param parentModule The parent module that created this child module.
+	 * @see #init(SkriptAddon, AddonModule)
+	 */
+	protected abstract void load(SkriptAddon addon, AddonModule parentModule);
+
+	@Override
+	public boolean canLoad(SkriptAddon addon) {
+		return canLoad(addon, parentModule);
+	}
+
+	/**
+	 * Allow addons to specify whether they can load or not.
+	 * Called prior to {@link #init(SkriptAddon)}
+	 *
+	 * @param addon The addon this module belongs to.
+	 * @param parentModule The parent module that created this child module.
+	 * @return Whether this module can load.
+	 */
+	protected boolean canLoad(SkriptAddon addon, AddonModule parentModule) {
+		return AddonModule.super.canLoad(addon);
+	}
+
+	@Override
+	public ModuleOrigin origin(SkriptAddon addon) {
+		return ChildAddonModule.origin(addon, parentModule, name());
+	}
+}

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

@@ -18,6 +18,11 @@
 
 public class BrewingModule implements AddonModule {
 
+	@Override
+	public String name() {
+		return "brewing";
+	}
+
 	@Override
 	public void load(SkriptAddon addon) {
 		register(addon.syntaxRegistry(),

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

@@ -18,6 +18,11 @@
 
 public class DamageSourceModule implements AddonModule {
 
+	@Override
+	public String name() {
+		return "damage source";
+	}
+
 	@Override
 	public boolean canLoad(SkriptAddon addon) {
 		return Skript.classExists("org.bukkit.damage.DamageSource");

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

@@ -9,6 +9,11 @@
 
 public class EntityModule implements AddonModule {
 
+	@Override
+	public String name() {
+		return "entities";
+	}
+
 	@Override
 	public void load(SkriptAddon addon) {
 		if (Skript.classExists("org.bukkit.entity.Nautilus")) {

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

@@ -12,6 +12,11 @@
 
 public class ItemComponentModule implements AddonModule {
 
+	@Override
+	public String name() {
+		return "item component";
+	}
+
 	@Override
 	public boolean canLoad(SkriptAddon addon) {
 		return Skript.classExists("io.papermc.paper.datacomponent.BuildableDataComponent");

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

@@ -23,6 +23,11 @@
 
 public class EquippableModule implements AddonModule {
 
+	@Override
+	public String name() {
+		return "equippable component";
+	}
+
 	@Override
 	public boolean canLoad(SkriptAddon addon) {
 		return Skript.classExists("io.papermc.paper.datacomponent.item.Equippable");

src/main/java/org/skriptlang/skript/bukkit/potion/PotionModule.java

@@ -36,6 +36,11 @@
 
 public class PotionModule implements AddonModule {
 
+	@Override
+	public String name() {
+		return "potion";
+	}
+
 	@Override
 	public void init(SkriptAddon addon) {
 		// Register ClassInfos

src/main/java/org/skriptlang/skript/common/CommonModule.java

@@ -8,6 +8,12 @@
 import java.io.IOException;
 
 public class CommonModule implements AddonModule {
+
+	@Override
+	public String name() {
+		return "common";
+	}
+
 	@Override
 	public void load(SkriptAddon addon) {
 		try {
@@ -18,4 +24,5 @@ public void load(SkriptAddon addon) {
 
 		addon.loadModules(new PropertiesModule());
 	}
+
 }