lauchmelder/BloodMagic
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Add API method for registering recipes at proper time

Browse source 
The old access to IBloodMagicRecipeRegistrar still exists, but should not
be used so mods like CraftTweaker can do their thing.

This commit also introduces @BloodMagicPlugin.Inject which will inject the
active API instance into an annotated field with the API interface as it's
type. These fields are populated during pre init.
This commit is contained in:
Nicholas Ignoffo 2018-02-28 17:53:23 -08:00
parent 395f1188e7
commit 91d7f23b4f
7 changed files with 125 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
src/api/java/WayofTime/bloodmagic/api/BloodMagicPlugin.java
View file

@ -13,4 +13,17 @@ import java.lang.annotation.Target;
@Target(ElementType.TYPE)
public @interface BloodMagicPlugin {
/**
* This annotation will inject the active {@link IBloodMagicAPI} into a {@code static} field of the same
* type. Fields with invalid types will be ignored and an error will be logged.
*
* These fields are populated during {@link net.minecraftforge.fml.common.event.FMLPreInitializationEvent}.
*
* {@code public static @BloodMagicPlugin.Inject IBloodMagicAPI API_INSTANCE = null;}
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@interface Inject {
}
}

4
src/api/java/WayofTime/bloodmagic/api/IBloodMagicAPI.java
View file

@ -6,6 +6,10 @@ import javax.annotation.Nonnull;
/**
* The main interface between a plugin and Blood Magic's internals.
*
* This API is intended for <i>compatibility</i> between other mods and Blood Magic. More advanced integration is out of the scope of this API and are considered "addons".
*
* To get an instance of this without actually creating an {@link IBloodMagicPlugin}, use {@link BloodMagicPlugin.Inject}.
*/
public interface IBloodMagicAPI {

15
src/api/java/WayofTime/bloodmagic/api/IBloodMagicPlugin.java
View file

@ -7,9 +7,20 @@ package WayofTime.bloodmagic.api;
public interface IBloodMagicPlugin {
/**
* Register mod content with the API
* Register mod content with the API. Called during {@link net.minecraftforge.fml.common.event.FMLInitializationEvent}.
*
* @param api The active instance of the {@link IBloodMagicAPI}
*/
void register(IBloodMagicAPI api);
default void register(IBloodMagicAPI api) {
// No-op
}
/**
* Register recipes with the API. Called during {@link net.minecraftforge.event.RegistryEvent.Register<net.minecraft.item.crafting.IRecipe>}.
*
* @param recipeRegistrar The active instance of the {@link IBloodMagicRecipeRegistrar}
*/
default void registerRecipes(IBloodMagicRecipeRegistrar recipeRegistrar) {
// No-op
}
}

3
src/main/java/WayofTime/bloodmagic/BloodMagic.java
View file

@ -73,6 +73,7 @@ public class BloodMagic {
configDir = new File(event.getModConfigurationDirectory(), "bloodmagic");
PLUGINS.addAll(PluginUtil.gatherPlugins(event.getAsmData()));
PluginUtil.injectAPIInstances(PluginUtil.gatherInjections(event.getAsmData()));
ModTranquilityHandlers.init();
ModDungeons.init();
@ -84,7 +85,7 @@ public class BloodMagic {
public void init(FMLInitializationEvent event) {
BloodMagicPacketHandler.init();
PluginUtil.registerPlugins(PLUGINS);
PluginUtil.handlePluginStep(PluginUtil.RegistrationStep.PLUGIN_REGISTER);
ModRecipes.init();
ModRituals.initRituals();

12
src/main/java/WayofTime/bloodmagic/api/impl/BloodMagicCorePlugin.java
View file

@ -6,6 +6,7 @@ import WayofTime.bloodmagic.api.BloodMagicPlugin;
import WayofTime.bloodmagic.api.IBloodMagicAPI;
import WayofTime.bloodmagic.api.IBloodMagicPlugin;
import WayofTime.bloodmagic.altar.EnumAltarComponent;
import WayofTime.bloodmagic.api.IBloodMagicRecipeRegistrar;
import WayofTime.bloodmagic.block.BlockBloodRune;
import WayofTime.bloodmagic.block.BlockDecorative;
import WayofTime.bloodmagic.block.enums.BloodRuneType;
@ -78,11 +79,14 @@ public class BloodMagicCorePlugin implements IBloodMagicPlugin {
BlockBloodRune bloodRune = (BlockBloodRune) RegistrarBloodMagicBlocks.BLOOD_RUNE;
for (BloodRuneType runeType : BloodRuneType.values())
api.registerAltarComponent(bloodRune.getDefaultState().withProperty(bloodRune.getProperty(), runeType), EnumAltarComponent.BLOODRUNE.name());
}
RegistrarBloodMagicRecipes.registerAltarRecipes(api.getRecipeRegistrar());
RegistrarBloodMagicRecipes.registerAlchemyTableRecipes(api.getRecipeRegistrar());
RegistrarBloodMagicRecipes.registerTartaricForgeRecipes(api.getRecipeRegistrar());
RegistrarBloodMagicRecipes.registerAlchemyArrayRecipes(api.getRecipeRegistrar());
@Override
public void registerRecipes(IBloodMagicRecipeRegistrar recipeRegistrar) {
RegistrarBloodMagicRecipes.registerAltarRecipes((BloodMagicRecipeRegistrar) recipeRegistrar);
RegistrarBloodMagicRecipes.registerAlchemyTableRecipes((BloodMagicRecipeRegistrar) recipeRegistrar);
RegistrarBloodMagicRecipes.registerTartaricForgeRecipes((BloodMagicRecipeRegistrar) recipeRegistrar);
RegistrarBloodMagicRecipes.registerAlchemyArrayRecipes((BloodMagicRecipeRegistrar) recipeRegistrar);
}
private static void handleConfigValues(BloodMagicAPI api) {

3
src/main/java/WayofTime/bloodmagic/core/RegistrarBloodMagicRecipes.java
View file

@ -12,6 +12,7 @@ import WayofTime.bloodmagic.item.alchemy.ItemCuttingFluid;
import WayofTime.bloodmagic.item.alchemy.ItemLivingArmourPointsUpgrade;
import WayofTime.bloodmagic.item.soul.ItemSoulGem;
import WayofTime.bloodmagic.item.types.ComponentTypes;
import WayofTime.bloodmagic.util.PluginUtil;
import com.google.common.collect.Sets;
import net.minecraft.init.Blocks;
import net.minecraft.init.Items;
@ -51,6 +52,8 @@ public class RegistrarBloodMagicRecipes {
OreDictionary.registerOre("dustIron", ComponentTypes.SAND_IRON.getStack());
OreDictionary.registerOre("dustGold", ComponentTypes.SAND_GOLD.getStack());
OreDictionary.registerOre("dustCoal", ComponentTypes.SAND_COAL.getStack());
PluginUtil.handlePluginStep(PluginUtil.RegistrationStep.RECIPE_REGISTER);
}
public static void registerAltarRecipes(BloodMagicRecipeRegistrar registrar) {

93
src/main/java/WayofTime/bloodmagic/util/PluginUtil.java
View file

@ -1,17 +1,23 @@
package WayofTime.bloodmagic.util;
import WayofTime.bloodmagic.BloodMagic;
import WayofTime.bloodmagic.api.BloodMagicPlugin;
import WayofTime.bloodmagic.api.IBloodMagicAPI;
import WayofTime.bloodmagic.api.IBloodMagicPlugin;
import WayofTime.bloodmagic.api.impl.BloodMagicAPI;
import WayofTime.bloodmagic.api.impl.BloodMagicCorePlugin;
import com.google.common.base.Stopwatch;
import com.google.common.collect.Lists;
import net.minecraftforge.common.util.EnumHelper;
import net.minecraftforge.fml.common.discovery.ASMDataTable;
import org.apache.commons.lang3.tuple.Pair;
import javax.annotation.Nonnull;
import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
import java.util.List;
import java.util.Set;
import java.util.function.Consumer;
public class PluginUtil {
@ -20,7 +26,7 @@ public class PluginUtil {
public static List<Pair<IBloodMagicPlugin, BloodMagicPlugin>> gatherPlugins(ASMDataTable dataTable) {
Stopwatch stopwatch = Stopwatch.createStarted();
List<Pair<IBloodMagicPlugin, BloodMagicPlugin>> discoveredAnnotations = Lists.newArrayList();
Set<ASMDataTable.ASMData> discoveredPlugins = dataTable.getAll(BloodMagicPlugin.class.getCanonicalName());
Set<ASMDataTable.ASMData> discoveredPlugins = dataTable.getAll(BloodMagicPlugin.class.getName());
for (ASMDataTable.ASMData data : discoveredPlugins) {
try {
@ -47,20 +53,85 @@ public class PluginUtil {
return discoveredAnnotations;
}
public static void registerPlugins(List<Pair<IBloodMagicPlugin, BloodMagicPlugin>> plugins) {
Stopwatch total = Stopwatch.createStarted();
int errors = 0;
for (Pair<IBloodMagicPlugin, BloodMagicPlugin> plugin : plugins) {
Stopwatch per = Stopwatch.createStarted();
@Nonnull
public static List<Field> gatherInjections(ASMDataTable dataTable) {
Stopwatch stopwatch = Stopwatch.createStarted();
List<Field> injectees = Lists.newArrayList();
Set<ASMDataTable.ASMData> discoveredInjectees = dataTable.getAll(BloodMagicPlugin.Inject.class.getName());
for (ASMDataTable.ASMData data : discoveredInjectees) {
try {
plugin.getLeft().register(BloodMagicAPI.INSTANCE);
Class<?> asmClass = Class.forName(data.getClassName());
Field toInject = asmClass.getDeclaredField(data.getObjectName());
if (toInject.getType() != IBloodMagicAPI.class) {
BMLog.API.error("Mod requested API injection on field {}.{} which is an invalid type.", data.getClassName(), data.getObjectName());
continue;
}
BMLog.API.info("Discovered injection request at {}.{}", data.getClassName(), data.getObjectName());
injectees.add(toInject);
} catch (Exception e) {
errors++;
BMLog.DEFAULT.error("Error loading plugin at {}: {}: {}", plugin.getLeft().getClass(), e.getClass().getSimpleName(), e.getMessage());
e.printStackTrace();
}
BMLog.API.info("Registered plugin at {} in {}", plugin.getLeft().getClass(), per.stop());
}
BMLog.API.info("Registered {} plugins with {} errors in {}", plugins.size() - errors, errors, total.stop());
BMLog.API.info("Discovered {} potential API injection(s) in {}", injectees.size(), stopwatch.stop());
return injectees;
}
public static void handlePluginStep(RegistrationStep step) {
Stopwatch total = Stopwatch.createStarted();
int errors = 0;
for (Pair<IBloodMagicPlugin, BloodMagicPlugin> plugin : BloodMagic.PLUGINS) {
Stopwatch per = Stopwatch.createStarted();
try {
step.getConsumer().accept(plugin);
} catch (Exception e) {
errors++;
BMLog.DEFAULT.error("Error handling plugin step {} at {}: {}: {}", step, plugin.getLeft().getClass(), e.getClass().getSimpleName(), e.getMessage());
}
BMLog.API.info("Handled plugin step {} at {} in {}", step, plugin.getLeft().getClass(), per.stop());
}
BMLog.API.info("Handled {} plugin(s) at step {} with {} errors in {}", BloodMagic.PLUGINS.size() - errors, step, errors, total.stop());
}
public static void injectAPIInstances(List<Field> injectees) {
Stopwatch total = Stopwatch.createStarted();
int errors = 0;
for (Field injectee : injectees) {
Stopwatch per = Stopwatch.createStarted();
if (!Modifier.isStatic(injectee.getModifiers()))
continue;
try {
EnumHelper.setFailsafeFieldValue(injectee, null, BloodMagicAPI.INSTANCE);
} catch (Exception e) {
errors++;
BMLog.DEFAULT.error("Error injecting API instance at {}.{}", injectee.getDeclaringClass().getCanonicalName(), injectee.getName());
}
BMLog.API.info("Injected API instance at {}.{} in {}", injectee.getDeclaringClass().getCanonicalName(), injectee.getName(), per.stop());
}
BMLog.API.info("Injected API {} times with {} errors in {}", injectees.size() - errors, errors, total.stop());
}
public enum RegistrationStep {
PLUGIN_REGISTER(p -> p.getLeft().register(BloodMagicAPI.INSTANCE)),
RECIPE_REGISTER(p -> p.getLeft().registerRecipes(BloodMagicAPI.INSTANCE.getRecipeRegistrar()))
;
private final Consumer<Pair<IBloodMagicPlugin, BloodMagicPlugin>> consumer;
RegistrationStep(Consumer<Pair<IBloodMagicPlugin, BloodMagicPlugin>> consumer) {
this.consumer = consumer;
}
@Nonnull
public Consumer<Pair<IBloodMagicPlugin, BloodMagicPlugin>> getConsumer() {
return consumer;
}
}
}