Support namespaced hooks and require explicit hook initialization (#152)

Author: Swedz

docs/MI_HOOKS.md

@@ -8,8 +8,9 @@ who may want to make them.
 First you need to register your mod with the hook system. To do so, you must provide a hook registry and a hook
 listener.
 
-To register your mod's hook registry and listener, simply include the `@MIHookEntrypoint` annotation on your classes. Be
-sure to include it on both the registry and the listener.
+To register your mod's hook registry and listener, include the `@MIHookEntrypoint` annotation on your classes. Be sure
+to include it on both the registry and the listener. Also, be sure to call `TesseractMI.init("your_mod_id")` in your
+mod constructor! Otherwise, your machines will not be registered.
 
 ### Hook Registries
 

src/main/java/net/swedz/tesseract/neoforge/Tesseract.java

@@ -11,7 +11,7 @@
 import net.neoforged.neoforge.event.entity.living.LivingEquipmentChangeEvent;
 import net.neoforged.neoforge.event.tick.EntityTickEvent;
 import net.swedz.tesseract.neoforge.compat.ModLoadedHelper;
-import net.swedz.tesseract.neoforge.compat.mi.TesseractMI;
+import net.swedz.tesseract.neoforge.compat.mi.TesseractMILootConditions;
 import net.swedz.tesseract.neoforge.datagen.client.LanguageDatagenProvider;
 import net.swedz.tesseract.neoforge.event.ItemHurtEvent;
 import net.swedz.tesseract.neoforge.item.ArmorTickHandler;
@@ -40,7 +40,7 @@ public Tesseract(IEventBus bus)
 
 		if(ModLoadedHelper.isLoaded("modern_industrialization"))
 		{
-			TesseractMI.init(bus);
+			TesseractMILootConditions.init(bus);
 		}
 
 		bus.addListener(GatherDataEvent.class, (event) ->

src/main/java/net/swedz/tesseract/neoforge/compat/mi/TesseractMI.java

@@ -1,11 +1,30 @@
 package net.swedz.tesseract.neoforge.compat.mi;
 
-import net.neoforged.bus.api.IEventBus;
+import net.swedz.tesseract.neoforge.compat.mi.hook.MIHooks;
+import net.swedz.tesseract.neoforge.compat.mi.hook.context.listener.HatchMIHookContext;
+import net.swedz.tesseract.neoforge.compat.mi.hook.context.listener.MachineCasingsMIHookContext;
+import net.swedz.tesseract.neoforge.compat.mi.hook.context.listener.MachineProcessConditionsMIHookContext;
+import net.swedz.tesseract.neoforge.compat.mi.hook.context.listener.MachineRecipeTypesMIHookContext;
+import net.swedz.tesseract.neoforge.compat.mi.hook.context.listener.MultiblockMachinesMIHookContext;
+import net.swedz.tesseract.neoforge.compat.mi.hook.context.listener.SingleBlockCraftingMachinesMIHookContext;
+import net.swedz.tesseract.neoforge.compat.mi.hook.context.listener.SingleBlockSpecialMachinesMIHookContext;
 
 public final class TesseractMI
 {
-	public static void init(IEventBus bus)
+	public static void init(String modId)
 	{
-		TesseractMILootConditions.init(bus);
+		MIHooks.triggerHookListeners(modId, (hook, listener) ->
+		{
+			listener.machineProcessConditions(new MachineProcessConditionsMIHookContext(hook));
+			
+			listener.machineRecipeTypes(new MachineRecipeTypesMIHookContext(hook));
+			
+			listener.machineCasings(new MachineCasingsMIHookContext(hook));
+			
+			listener.hatches(new HatchMIHookContext(hook));
+			listener.singleBlockSpecialMachines(new SingleBlockSpecialMachinesMIHookContext(hook));
+			listener.singleBlockCraftingMachines(new SingleBlockCraftingMachinesMIHookContext(hook));
+			listener.multiblockMachines(new MultiblockMachinesMIHookContext(hook));
+		});
 	}
 }

src/main/java/net/swedz/tesseract/neoforge/compat/mi/hook/MIHookEfficiency.java

@@ -2,7 +2,7 @@
 
 import net.swedz.tesseract.neoforge.compat.mi.hook.context.machine.EfficiencyMIHookContext;
 
-public interface MIHookEfficiency
+public interface MIHookEfficiency extends MIHookInstance
 {
 	/**
 	 * Gets the priority for the efficiency hook. Higher priorities are run first, and lower priorities are run last.

src/main/java/net/swedz/tesseract/neoforge/compat/mi/hook/MIHookEntrypointLoader.java

@@ -31,17 +31,28 @@ public static void ensureLoaded()
 		}
 	}
 
-	private static <H> boolean registerEntrypoint(
-			ModFileScanData data, Class<?> entrypointClass, Class<H> hookClass, BiConsumer<String, H> register
+	private static <H extends MIHookInstance> boolean registerEntrypoint(
+			ModFileScanData data,
+			ModFileScanData.AnnotationData annotation, Class<?> entrypointClass,
+			Class<H> hookClass,
+			BiConsumer<String, H> register
 	) throws NoSuchMethodException, InvocationTargetException, InstantiationException, IllegalAccessException
 	{
 		if(hookClass.isAssignableFrom(entrypointClass))
 		{
 			Class<? extends H> hookClassReference = entrypointClass.asSubclass(hookClass);
 			H hook = hookClassReference.getConstructor().newInstance();
-			String id = data.getIModInfoData().getFirst().getMods().getFirst().getModId();
-			LOGGER.info("Registered entrypoint for mod {}: {}", id, hookClassReference.getName());
-			register.accept(id, hook);
+			if(!hook.shouldInitialize())
+			{
+				return true;
+			}
+			var modId = hook.modId();
+			if(modId == null)
+			{
+				modId = data.getIModInfoData().getFirst().getMods().getFirst().getModId();
+			}
+			LOGGER.info("Registered entrypoint for mod {}: {}", modId, hookClassReference.getName());
+			register.accept(modId, hook);
 			return true;
 		}
 		return false;
@@ -67,15 +78,15 @@ private static void load()
 
 						boolean registered = false;
 
-						if(registerEntrypoint(data, entrypointClass, MIHookListener.class, MIHooks::registerListener))
+						if(registerEntrypoint(data, annotation, entrypointClass, MIHookListener.class, MIHooks::registerListener))
 						{
 							registered = true;
 						}
-						else if(registerEntrypoint(data, entrypointClass, MIHookRegistry.class, MIHooks::registerRegistry))
+						else if(registerEntrypoint(data, annotation, entrypointClass, MIHookRegistry.class, MIHooks::registerRegistry))
 						{
 							registered = true;
 						}
-						else if(registerEntrypoint(data, entrypointClass, MIHookEfficiency.class, MIHooks::registerEfficiencyListener))
+						else if(registerEntrypoint(data, annotation, entrypointClass, MIHookEfficiency.class, MIHooks::registerEfficiencyListener))
 						{
 							registered = true;
 						}
@@ -87,7 +98,8 @@ else if(registerEntrypoint(data, entrypointClass, MIHookEfficiency.class, MIHook
 					}
 					catch (Throwable ex)
 					{
-						LOGGER.error("Exception constructing entrypoint:", ex);
+						LOGGER.error("Exception constructing entrypoint");
+						throw new RuntimeException(ex);
 					}
 				});
 

src/main/java/net/swedz/tesseract/neoforge/compat/mi/hook/MIHookInstance.java

@@ -0,0 +1,25 @@
+package net.swedz.tesseract.neoforge.compat.mi.hook;
+
+public interface MIHookInstance
+{
+	/**
+	 * Gets the mod ID that should be referenced in the hook. This should only be overridden if you really know what
+	 * you are doing. Things can get messy.
+	 *
+	 * @return the mod ID, or null to automatically inherit the mod's actual ID
+	 */
+	default String modId()
+	{
+		return null;
+	}
+	
+	/**
+	 * Checks whether this hook should initialize or not.
+	 *
+	 * @return true if the hook should initialize, false if it should be ignored
+	 */
+	default boolean shouldInitialize()
+	{
+		return true;
+	}
+}

src/main/java/net/swedz/tesseract/neoforge/compat/mi/hook/MIHookListener.java

@@ -11,7 +11,7 @@
 import net.swedz.tesseract.neoforge.compat.mi.hook.context.listener.SingleBlockSpecialMachinesMIHookContext;
 import net.swedz.tesseract.neoforge.compat.mi.hook.context.listener.ViewerSetupMIHookContext;
 
-public interface MIHookListener
+public interface MIHookListener extends MIHookInstance
 {
 	default void beforeInit()
 	{

src/main/java/net/swedz/tesseract/neoforge/compat/mi/hook/MIHookRegistry.java

@@ -9,7 +9,7 @@
 import net.swedz.tesseract.neoforge.registry.holder.BlockHolder;
 import net.swedz.tesseract.neoforge.registry.holder.ItemHolder;
 
-public interface MIHookRegistry
+public interface MIHookRegistry extends MIHookInstance
 {
 	DeferredRegister.Blocks blockRegistry();
 

src/main/java/net/swedz/tesseract/neoforge/compat/mi/hook/MIHooks.java

@@ -11,6 +11,7 @@
 import java.util.TreeSet;
 import java.util.function.BiConsumer;
 
+@ApiStatus.Internal
 public final class MIHooks
 {
 	private static final Map<String, MIHook>   HOOKS                = Maps.newHashMap();
@@ -62,20 +63,17 @@ static void registerEfficiencyListener(String modId, MIHookEfficiency efficiency
 		EFFICIENCY_LISTENERS.add(efficiencyListener);
 	}
 
-	@ApiStatus.Internal
 	public static Set<String> getModIds()
 	{
 		return HOOKS.keySet();
 	}
 
-	@ApiStatus.Internal
 	private static MIHook getHook(String modId)
 	{
 		MIHookEntrypointLoader.ensureLoaded();
 		return HOOKS.computeIfAbsent(modId, MIHook::new);
 	}
 
-	@ApiStatus.Internal
 	public static MIHookRegistry getRegistry(String modId)
 	{
 		MIHookEntrypointLoader.ensureLoaded();
@@ -86,7 +84,13 @@ public static MIHookRegistry getRegistry(String modId)
 		return getHook(modId).registry();
 	}
 
-	@ApiStatus.Internal
+	public static void triggerHookListeners(String modId, BiConsumer<MIHook, MIHookListener> action)
+	{
+		MIHookEntrypointLoader.ensureLoaded();
+		var hook = getHook(modId);
+		action.accept(hook, hook.listener());
+	}
+	
 	public static void triggerHookListeners(BiConsumer<MIHook, MIHookListener> action)
 	{
 		MIHookEntrypointLoader.ensureLoaded();
@@ -96,7 +100,6 @@ public static void triggerHookListeners(BiConsumer<MIHook, MIHookListener> actio
 		}
 	}
 
-	@ApiStatus.Internal
 	public static void triggerHookEfficiencyListeners(EfficiencyMIHookContext context,
 													  BiConsumer<MIHookEfficiency, EfficiencyMIHookContext> action)
 	{