LiteLoader 1.6.4_02 - experimental - changes to Exposable implementation, regist…

…er exposables by reference, renamed annotations, added aggressive option

LiteLoader 1.6.4_02 - experimental - changes to Exposable implementation, regist…
…er exposables by reference, renamed annotations, added aggressive option
Mumfrey
1 parent e38f7f24
Showing 4 changed files with 85 additions and 65 deletions
java/com/mumfrey/liteloader/core/LiteLoader.java
java/com/mumfrey/liteloader/modconfig/ConfigManager.java
java/com/mumfrey/liteloader/modconfig/ExposableConfigWriter.java
java/com/mumfrey/liteloader/ExposeConfig.java → java/com/mumfrey/liteloader/modconfig/ExposableOptions.java
@@ -788,29 +788,18 @@ public final class LiteLoader
 	}
 	/**
-	 * @param modClass
-	 */
-	public void writeConfig(LiteMod mod)
-	{
-		if (mod != null)
-		{
-			this.writeConfig(mod.getClass());
-		}
-	}
-	
-	/**
-	 * @param exposableClass
+	 * @param exposable
 	 */
-	public void writeConfig(Class<? extends Exposable> exposableClass)
+	public void writeConfig(Exposable exposable)
 	{
-		this.configManager.invalidateConfig(exposableClass);
+		this.configManager.invalidateConfig(exposable);
 	}
 	/**
 	 * Register an arbitrary Exposable
 	 * 
 	 * @param exposable Exposable object to register
-	 * @param fileName
+	 * @param fileName Override config file name to use (leave null to use value from ExposableConfig specified value)
 	 */
 	public void registerExposable(Exposable exposable, String fileName)
 	{
@@ -1091,7 +1080,7 @@ public final class LiteLoader
 		}
 		else if (this.minecraft.currentScreen instanceof GuiMainMenu && Keyboard.isKeyDown(Keyboard.KEY_LCONTROL) && Keyboard.isKeyDown(Keyboard.KEY_LSHIFT) && Keyboard.isKeyDown(Keyboard.KEY_TAB))
 		{
-			this.minecraft.displayGuiScreen(new GuiScreenModInfo(this.minecraft, (GuiMainMenu)this.minecraft.currentScreen, this, this.enabledModsList, this.configManager));
+			this.displayModInfoScreen((GuiMainMenu)this.minecraft.currentScreen);
 		}			
 	}
@@ -1224,7 +1213,17 @@ public final class LiteLoader
 	{
 		return this.displayModInfoScreenTab;
 	}
-	
+
+	/**
+	 * Display the "mod info" overlay over the specified main menu GUI
+	 * 
+	 * @param parentScreen
+	 */
+	public void displayModInfoScreen(GuiMainMenu parentScreen)
+	{
+		this.minecraft.displayGuiScreen(new GuiScreenModInfo(this.minecraft, parentScreen, this, this.enabledModsList, this.configManager));
+	}
+
 	private static void logInfo(String string, Object... args)
 	{
 		LiteLoader.logger.info(String.format(string, args));
@@ -11,10 +11,9 @@ import com.google.common.base.Strings;
 import com.google.common.io.Files;
 import com.mumfrey.liteloader.Configurable;
 import com.mumfrey.liteloader.LiteMod;
-import com.mumfrey.liteloader.ExposeConfig;
 /**
- * Registry where we keep the mod config panel classes
+ * Registry where we keep the mod config panel classes and config file writers
  *
  * @author Adam Mummery-Smith
  */
@@ -28,7 +27,7 @@ public class ConfigManager
 	/**
 	 * Mod config writers
 	 */
-	private Map<Class<? extends Exposable>, ExposableConfigWriter> configWriters = new HashMap<Class<? extends Exposable>, ExposableConfigWriter>();
+	private Map<Exposable, ExposableConfigWriter> configWriters = new HashMap<Exposable, ExposableConfigWriter>();
 	/**
 	 * List of config writers, for faster iteration in onTick
@@ -51,18 +50,20 @@ public class ConfigManager
 	/**
 	 * @param exposable
+	 * @param fallbackFileName
+	 * @param ignoreMissingConfigAnnotation
 	 */
-	public void registerExposable(Exposable exposable, String fileName, boolean force)
+	public void registerExposable(Exposable exposable, String fallbackFileName, boolean ignoreMissingConfigAnnotation)
 	{
-		ExposeConfig exposeConfig = exposable.getClass().<ExposeConfig>getAnnotation(ExposeConfig.class);
-		if (exposeConfig != null)
+		ExposableOptions options = exposable.getClass().<ExposableOptions>getAnnotation(ExposableOptions.class);
+		if (options != null)
 		{
-			if (fileName == null) exposeConfig.filename();
-			this.initConfigWriter(exposable, fileName, exposeConfig.strategy());
+			if (fallbackFileName == null) fallbackFileName = options.filename();
+			this.initConfigWriter(exposable, fallbackFileName, options.strategy(), options.aggressive());
 		}
-		else if (force)
+		else if (ignoreMissingConfigAnnotation)
 		{
-			this.initConfigWriter(exposable, fileName, ConfigStrategy.Versioned);
+			this.initConfigWriter(exposable, fallbackFileName, ConfigStrategy.Versioned, false);
 		}
 	}
@@ -73,11 +74,11 @@ public class ConfigManager
 	 * @param fileName
 	 * @param strategy
 	 */
-	private void initConfigWriter(Exposable exposable, String fileName, ConfigStrategy strategy)
+	private void initConfigWriter(Exposable exposable, String fileName, ConfigStrategy strategy, boolean aggressive)
 	{
-		if (this.configWriters.containsKey(exposable.getClass()))
+		if (this.configWriters.containsKey(exposable))
 		{
-			throw new IllegalArgumentException("Cannot register multiple Exposable instances of the same class or the Exposable already registered");
+			return;
 		}
 		if (Strings.isNullOrEmpty(fileName))
@@ -88,27 +89,13 @@ public class ConfigManager
 				fileName = fileName.substring(7);
 		}
-		ExposableConfigWriter configWriter = ExposableConfigWriter.create(exposable, strategy, fileName);
+		ExposableConfigWriter configWriter = ExposableConfigWriter.create(exposable, strategy, fileName, aggressive);
 		if (configWriter != null)
 		{
-			this.configWriters.put(exposable.getClass(), configWriter);
+			this.configWriters.put(exposable, configWriter);
 			this.configWriterList.add(configWriter);
 		}
 	}
-
-	/**
-	 * Initialise the config writer for the specified mod
-	 * 
-	 * @param exposable
-	 */
-	public void initConfig(Exposable exposable)
-	{
-		Class<? extends Exposable> exposableClass = exposable.getClass();
-		if (exposableClass != null && this.configWriters.containsKey(exposableClass))
-		{
-			this.configWriters.get(exposableClass).init();
-		}
-	}
 	/**
 	 * If the specified mod has a versioned config strategy, attempt to copy the config
@@ -179,16 +166,29 @@ public class ConfigManager
 	}
 	/**
+	 * Initialise the config writer for the specified mod
+	 * 
+	 * @param exposable
+	 */
+	public void initConfig(Exposable exposable)
+	{
+		if (this.configWriters.containsKey(exposable))
+		{
+			this.configWriters.get(exposable).init();
+		}
+	}
+
+	/**
 	 * Invalidate the specified mod config, cause it to be written to disk or scheduled for writing
 	 * if it has been written recent
 	 * 
-	 * @param exposableClass
+	 * @param exposable
 	 */
-	public void invalidateConfig(Class<? extends Exposable> exposableClass)
+	public void invalidateConfig(Exposable exposable)
 	{
-		if (exposableClass != null && this.configWriters.containsKey(exposableClass))
+		if (this.configWriters.containsKey(exposable))
 		{
-			this.configWriters.get(exposableClass).invalidate();
+			this.configWriters.get(exposable).invalidate();
 		}
 	}
@@ -38,6 +38,11 @@ public final class ExposableConfigWriter implements InstanceCreator&lt;Exposable&gt;
 	private final boolean versioned;
 	/**
+	 * Disable anti-hammer and always save when requested 
+	 */
+	private final boolean aggressive; 
+
+	/**
 	 * Gson instance
 	 */
 	private final Gson gson;
@@ -56,16 +61,17 @@ public final class ExposableConfigWriter implements InstanceCreator&lt;Exposable&gt;
 	 * It's possible that writes may be requested from different threads, lock object to prevent cross-thread derp
 	 */
 	private Object readWriteLock = new Object();
-
+	
 	/**
 	 * @param exposable
 	 * @param configFile
 	 */
-	private ExposableConfigWriter(Exposable exposable, File configFile, boolean versioned)
+	private ExposableConfigWriter(Exposable exposable, File configFile, boolean versioned, boolean aggressive)
 	{
 		this.exposable = exposable;
 		this.configFile = configFile;
 		this.versioned = versioned;
+		this.aggressive = aggressive;
 		GsonBuilder gsonBuilder = new GsonBuilder();
 		gsonBuilder.setPrettyPrinting();
@@ -93,6 +99,14 @@ public final class ExposableConfigWriter implements InstanceCreator&lt;Exposable&gt;
 	}
 	/**
+	 * Returns true if anti-hammer is disabled for this writer
+	 */
+	public boolean isAggressive()
+	{
+		return this.aggressive;
+	}
+	
+	/**
 	 * Returns true if this writer has been invalidated but not yet been flushed to disk
 	 */
 	boolean isDirty()
@@ -205,11 +219,14 @@ public final class ExposableConfigWriter implements InstanceCreator&lt;Exposable&gt;
 	 */
 	void invalidate()
 	{
-		long sinceLastWrite = System.currentTimeMillis() - this.lastWrite;
-		if (sinceLastWrite < ANTI_HAMMER_DELAY)
+		if (!this.aggressive)
 		{
-			this.dirty = true;
-			return;
+			long sinceLastWrite = System.currentTimeMillis() - this.lastWrite;
+			if (sinceLastWrite < ANTI_HAMMER_DELAY)
+			{
+				this.dirty = true;
+				return;
+			}
 		}
 		this.write();
@@ -220,7 +237,7 @@ public final class ExposableConfigWriter implements InstanceCreator&lt;Exposable&gt;
 	 */
 	void onTick()
 	{
-		if (this.dirty)
+		if (!this.aggressive && this.dirty)
 		{
 			long sinceLastWrite = System.currentTimeMillis() - this.lastWrite;
 			if (sinceLastWrite >= ANTI_HAMMER_DELAY)
@@ -235,7 +252,7 @@ public final class ExposableConfigWriter implements InstanceCreator&lt;Exposable&gt;
 	 */
 	void sync()
 	{
-		if (this.dirty)
+		if (this.dirty || this.aggressive)
 		{
 			this.write();
 		}
@@ -249,13 +266,13 @@ public final class ExposableConfigWriter implements InstanceCreator&lt;Exposable&gt;
 	 * @param fileName
 	 * @return
 	 */
-	static ExposableConfigWriter create(Exposable exposable, ConfigStrategy strategy, String fileName)
+	static ExposableConfigWriter create(Exposable exposable, ConfigStrategy strategy, String fileName, boolean aggressive)
 	{
 		if (!fileName.toLowerCase().endsWith(".json"))
 			fileName = fileName + ".json";
 		File configFile = strategy.getFileForStrategy(fileName);
-		ExposableConfigWriter writer = new ExposableConfigWriter(exposable, configFile, strategy == ConfigStrategy.Versioned);
+		ExposableConfigWriter writer = new ExposableConfigWriter(exposable, configFile, strategy == ConfigStrategy.Versioned, aggressive);
 		return writer;
 	}
-package com.mumfrey.liteloader;
+package com.mumfrey.liteloader.modconfig;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
-import com.mumfrey.liteloader.modconfig.ConfigStrategy;
-
 /**
- * Annotation which can be a applied to mod classes to indicate they should be serialised with Gson
+ * Annotation which can be a applied to mod classes to indicate that members decorated with the Gson
+ * Expose annotation should be serialised with Gson
  *
  * @author Adam Mummery-Smith
  */
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
-public @interface ExposeConfig
+public @interface ExposableOptions
 {
 	/**
 	 * Configuration strategy to use
@@ -25,4 +24,9 @@ public @interface ExposeConfig
 	 * Config file name, if not specified the mod class name is used
 	 */
 	String filename() default "";
+	
+	/**
+	 * Set to true to disable write anti-hammer for config file
+	 */
+	boolean aggressive() default false;
 }