propagate event injection through to the mod list, and provide help screens for …

…tweak/transformer/event icons

propagate event injection through to the mod list, and provide help screens for …
…tweak/transformer/event icons
Mumfrey
1 parent 53506bde
Showing 13 changed files with 219 additions and 28 deletions
java/client/com/mumfrey/liteloader/client/api/LiteLoaderModInfoDecorator.java
java/client/com/mumfrey/liteloader/client/gui/modlist/GuiModInfoPanel.java
java/client/com/mumfrey/liteloader/client/gui/modlist/GuiModListPanel.java
java/client/com/mumfrey/liteloader/client/gui/modlist/ModListEntry.java
java/common/com/mumfrey/liteloader/core/LiteLoaderVersion.java
java/common/com/mumfrey/liteloader/core/ModInfo.java
java/common/com/mumfrey/liteloader/interfaces/LoadableFile.java
java/common/com/mumfrey/liteloader/interfaces/TweakContainer.java
java/common/com/mumfrey/liteloader/transformers/event/Event.java
java/common/com/mumfrey/liteloader/transformers/event/json/ModEventInjectionTransformer.java
java/common/com/mumfrey/liteloader/transformers/event/json/ModEvents.java
resources/assets/liteloader/lang/en_US.lang
resources/assets/liteloader/textures/gui/about.png
@@ -6,6 +6,7 @@ import net.minecraft.client.resources.I18n;
 import com.mumfrey.liteloader.api.ModInfoDecorator;
 import com.mumfrey.liteloader.client.gui.GuiLiteLoaderPanel;
+import com.mumfrey.liteloader.client.gui.modlist.GuiModListPanel;
 import com.mumfrey.liteloader.client.util.render.IconAbsolute;
 import com.mumfrey.liteloader.client.util.render.IconAbsoluteClickable;
 import com.mumfrey.liteloader.core.ModInfo;
@@ -26,12 +27,44 @@ public class LiteLoaderModInfoDecorator implements ModInfoDecorator
 	{
 		if (mod.hasTweakClass())
 		{
-			icons.add(new IconAbsolute(LiteLoaderBrandingProvider.ABOUT_TEXTURE, I18n.format("gui.mod.providestweak"), 12, 12, 158, 80, 170, 92));
+			icons.add(new IconAbsoluteClickable(LiteLoaderBrandingProvider.ABOUT_TEXTURE, I18n.format("gui.mod.providestweak"), 12, 12, 158, 80, 170, 92){
+				@Override
+				public void onClicked(Object source, Object container)
+				{
+					if (container instanceof GuiModListPanel)
+					{
+						((GuiModListPanel)container).displayModHelpMessage(mod, "gui.mod.providestweak", "gui.mod.help.tweak");
+					}
+				}
+			});
+		}
+		
+		if (mod.hasEventTransformers())
+		{
+			icons.add(new IconAbsoluteClickable(LiteLoaderBrandingProvider.ABOUT_TEXTURE, I18n.format("gui.mod.providesevents"), 12, 12, 170, 92, 182, 104){
+				@Override
+				public void onClicked(Object source, Object container)
+				{
+					if (container instanceof GuiModListPanel)
+					{
+						((GuiModListPanel)container).displayModHelpMessage(mod, "gui.mod.providesevents", "gui.mod.help.events");
+					}
+				}
+			});
 		}
 		if (mod.hasClassTransformers())
 		{
-			icons.add(new IconAbsolute(LiteLoaderBrandingProvider.ABOUT_TEXTURE, I18n.format("gui.mod.providestransformer"), 12, 12, 170, 80, 182, 92));
+			icons.add(new IconAbsoluteClickable(LiteLoaderBrandingProvider.ABOUT_TEXTURE, I18n.format("gui.mod.providestransformer"), 12, 12, 170, 80, 182, 92){
+				@Override
+				public void onClicked(Object source, Object container)
+				{
+					if (container instanceof GuiModListPanel)
+					{
+						((GuiModListPanel)container).displayModHelpMessage(mod, "gui.mod.providestransformer", "gui.mod.help.transformer");
+					}
+				}
+			});
 		}
 		if (mod.usesAPI())
 package com.mumfrey.liteloader.client.gui.modlist;
+import static com.mumfrey.liteloader.gl.GL.*;
 import static com.mumfrey.liteloader.gl.GLClippingPlanes.*;
+import net.minecraft.client.Minecraft;
 import net.minecraft.client.gui.FontRenderer;
 import net.minecraft.client.gui.Gui;
 import net.minecraft.client.resources.I18n;
 import com.google.common.base.Strings;
+import com.mumfrey.liteloader.client.api.LiteLoaderBrandingProvider;
 import com.mumfrey.liteloader.client.gui.GuiSimpleScrollBar;
+import com.mumfrey.liteloader.client.util.render.IconAbsolute;
 import com.mumfrey.liteloader.core.ModInfo;
+import com.mumfrey.liteloader.util.render.IconTextured;
 public class GuiModInfoPanel extends Gui
 {
@@ -16,6 +21,8 @@ public class GuiModInfoPanel extends Gui
 	private static final int DIVIDER_COLOUR     = GuiModListPanel.GREY;
 	private static final int DESCRIPTION_COLOUR = GuiModListPanel.WHITE;
+	private static final IconAbsolute infoIcon = new IconAbsolute(LiteLoaderBrandingProvider.ABOUT_TEXTURE, "Info", 12, 12, 146, 92, 158, 104);
+	
 	private final ModListEntry owner;
 	private final FontRenderer fontRenderer;
@@ -27,6 +34,10 @@ public class GuiModInfoPanel extends Gui
 	private GuiSimpleScrollBar scrollBar = new GuiSimpleScrollBar();
 	private boolean mouseOverPanel, mouseOverScrollBar;
+	
+	private boolean showHelp;
+	
+	private String helpTitle, helpText;
 	public GuiModInfoPanel(ModListEntry owner, FontRenderer fontRenderer, int brandColour, ModInfo<?> modInfo)
 	{
@@ -57,18 +68,48 @@ public class GuiModInfoPanel extends Gui
 		drawRect(xPosition + 5, yPos, xPosition + width, yPos + 1, GuiModInfoPanel.DIVIDER_COLOUR); yPos += 4; // divider
 		drawRect(xPosition + 5, bottom - 1, xPosition + width, bottom, GuiModInfoPanel.DIVIDER_COLOUR); // divider
+		glEnableClipping(-1, -1, yPos, bottom - 3);
+		
 		int scrollHeight = bottom - yPos - 3;
-		int totalHeight = this.fontRenderer.splitStringWidth(this.modInfo.getDescription(), width - 11);
+		int contentHeight = this.drawContent(xPosition, width, yPos);
-		this.scrollBar.setMaxValue(totalHeight - scrollHeight);
-		this.scrollBar.drawScrollBar(mouseX, mouseY, partialTicks, xPosition + width - 5, yPos, 5, scrollHeight, totalHeight);
+		this.scrollBar.setMaxValue(contentHeight - scrollHeight);
+		this.scrollBar.drawScrollBar(mouseX, mouseY, partialTicks, xPosition + width - 5, yPos, 5, scrollHeight, contentHeight);
 		this.mouseOverScrollBar = this.isMouseOver(mouseX, mouseY, xPosition + width - 5, yPos, 5, scrollHeight);
+	}
-		glEnableClipping(-1, -1, yPos, bottom - 3);
-		this.fontRenderer.drawSplitString(this.modInfo.getDescription(), xPosition + 5, yPos - this.scrollBar.getValue(), width - 11, GuiModInfoPanel.DESCRIPTION_COLOUR);
+	private int drawContent(int xPosition, int width, int yPos)
+	{
+		yPos -= this.scrollBar.getValue();
+		
+		if (this.showHelp)
+		{
+			this.drawIcon(xPosition + 3, yPos, GuiModInfoPanel.infoIcon); yPos += 2;
+			this.fontRenderer.drawString(this.helpTitle, xPosition + 17, yPos, this.brandColour); yPos += 12;
+			return this.drawText(xPosition + 17, width - 24, yPos, this.helpText, GuiModInfoPanel.DESCRIPTION_COLOUR) + 15;
+		}
+		
+		return this.drawText(xPosition + 5, width - 11, yPos, this.modInfo.getDescription(), GuiModInfoPanel.DESCRIPTION_COLOUR);
 	}
+	protected void drawIcon(int xPosition, int yPosition, IconTextured icon)
+	{
+		glColor4f(1.0F, 1.0F, 1.0F, 1.0F);
+		Minecraft.getMinecraft().getTextureManager().bindTexture(icon.getTextureResource());
+		
+		glEnableBlend();
+		this.drawTexturedModalRect(xPosition, yPosition, icon.getUPos(), icon.getVPos(), icon.getIconWidth(), icon.getIconHeight());
+		glDisableBlend();
+	}
+
+	private int drawText(int xPosition, int width, int yPos, String text, int colour)
+	{
+		int totalHeight = this.fontRenderer.splitStringWidth(text, width);
+		this.fontRenderer.drawSplitString(text, xPosition, yPos, width, colour);
+		return totalHeight;
+	}
+
 	private boolean isMouseOver(int mouseX, int mouseY, int x, int y, int width, int height)
 	{
 		return mouseX > x && mouseX < x + width && mouseY > y && mouseY < y + height;
@@ -97,4 +138,17 @@ public class GuiModInfoPanel extends Gui
 		return false;
 	}
+	
+	public void displayHelpMessage(String title, String text)
+	{
+		this.showHelp = true;
+		this.helpTitle = I18n.format(title);
+		this.helpText = I18n.format(text);
+		this.scrollBar.setValue(0);
+	}
+
+	public void clearHelpMessage()
+	{
+		this.showHelp = false;
+	}
 }
@@ -252,4 +252,14 @@ public class GuiModListPanel extends Gui
 			this.mouseOverIcon.onClicked(source, this);
 		}
 	}
+
+	public void mousePressed(int mouseX, int mouseY, int mouseButton)
+	{
+		this.owner.clearHelpMessage();
+	}
+
+	public void displayModHelpMessage(ModInfo<?> mod, String title, String text)
+	{
+		this.owner.displayHelpMessage(title, text);
+	}
 }
@@ -149,6 +149,11 @@ public class ModListEntry
 		{
 			this.modList.selectMod(this);
+			if (this.getListPanel().isMouseOver())
+			{
+				this.getListPanel().mousePressed(mouseX, mouseY, mouseButton);
+			}
+			
 			if (this.getListPanel().isMouseOverIcon())
 			{
 				this.getListPanel().iconClick(this.modList.getParentScreen());
@@ -221,6 +226,16 @@ public class ModListEntry
 		}
 	}
+	protected void displayHelpMessage(String title, String text)
+	{
+		this.infoPanel.displayHelpMessage(title, text);
+	}
+
+	public void clearHelpMessage()
+	{
+		this.infoPanel.clearHelpMessage();
+	}
+
 	public String getKey()
 	{
 		return (this.isErrored ? "0000" : "") + this.modInfo.getIdentifier() + Integer.toHexString(this.hashCode());
@@ -37,7 +37,7 @@ public enum LiteLoaderVersion
 	MC_1_7_10_R1(28, 1404673785, "1.7.10", "1.7.10_01", "1.7.10"),
 	MC_1_7_10_R2(29, 1405369406, "1.7.10", "1.7.10_02", "1.7.10"),
 	MC_1_7_10_R3(30, 1407687918, "1.7.10", "1.7.10_03", "1.7.10", "1.7.10_03"),
-	MC_1_7_10_R4(31, 1412718533, "1.7.10", "1.7.10_04", "1.7.10", "1.7.10_03", "1.7.10_04"),
+	MC_1_7_10_R4(31, 1414368553, "1.7.10", "1.7.10_04", "1.7.10", "1.7.10_03", "1.7.10_04"),
 	MC_1_8_0_R0(32, 0,           "1.8",    "1.8.0",     "1.8", "1.8.0");
 	/**
@@ -172,6 +172,14 @@ public abstract class ModInfo&lt;TContainer extends Loadable&lt;?&gt;&gt;
 	}
 	/**
+	 * If this has JSON event transformers
+	 */
+	public boolean hasEventTransformers()
+	{
+		return (this.container instanceof TweakContainer && ((TweakContainer<?>)this.container).hasEventTransformers());
+	}
+	
+	/**
 	 * Get whether this mod uses external (3rd-party) API
 	 */
 	public boolean usesAPI()
@@ -71,6 +71,8 @@ public class LoadableFile extends File implements TweakContainer&lt;File&gt;
 	protected String author = "Unknown";
+	protected boolean hasEventTransformers;
+
 	/**
 	 * Create a new tweak container wrapping the specified file
 	 */
@@ -297,6 +299,17 @@ public class LoadableFile extends File implements TweakContainer&lt;File&gt;
 	{
 		return new ArrayList<String>();
 	}
+	
+	@Override
+	public boolean hasEventTransformers()
+	{
+		return this.hasEventTransformers;
+	}
+	
+	public void onEventsInjected()
+	{
+		this.hasEventTransformers = true;
+	}
 	public boolean isInjectionForced()
 	{
@@ -38,4 +38,9 @@ public interface TweakContainer&lt;L&gt; extends Loadable&lt;L&gt;, Injectable
 	 * Get class transformers defined in the metadata
 	 */
 	public abstract List<String> getClassTransformerClassNames();
+	
+	/**
+	 * True if this container defines event transformers via JSON
+	 */
+	public abstract boolean hasEventTransformers();
 }
 \ No newline at end of file
@@ -98,12 +98,15 @@ public class Event implements Comparable&lt;Event&gt;
 	private int injectionCount = 0;
+	protected boolean verbose;
+	
 	protected Event(String name, boolean cancellable, int priority)
 	{
 		this.name = name.toLowerCase();
 		this.priority = priority;
 		this.order = Event.eventOrder++;
 		this.cancellable = cancellable;
+		this.verbose = true;
 		if (Event.events.contains(this))
 		{
@@ -191,6 +194,23 @@ public class Event implements Comparable&lt;Event&gt;
 	{
 		return this.priority;
 	}
+	
+	/**
+	 * Set whether to log at INFO or DEBUG
+	 */
+	public Event setVerbose(boolean verbose)
+	{
+		this.verbose = verbose;
+		return this;
+	}
+	
+	/**
+	 * Get whether to log at INFO or DEBUG
+	 */
+	public boolean isVerbose()
+	{
+		return this.verbose;
+	}
 	/**
 	 * Get whether this event is currently attached to a method
 package com.mumfrey.liteloader.transformers.event.json;
-import java.util.Map.Entry;
-
 import com.mumfrey.liteloader.transformers.ClassTransformer;
 import com.mumfrey.liteloader.transformers.ObfProvider;
 import com.mumfrey.liteloader.transformers.event.Event;
 import com.mumfrey.liteloader.transformers.event.EventInjectionTransformer;
 import com.mumfrey.liteloader.transformers.event.InjectionPoint;
 import com.mumfrey.liteloader.transformers.event.MethodInfo;
+import com.mumfrey.liteloader.transformers.event.json.ModEvents.ModEventDefinition;
 import com.mumfrey.liteloader.util.log.LiteLoaderLogger;
 /**
@@ -20,12 +19,9 @@ public class ModEventInjectionTransformer extends EventInjectionTransformer
 	@Override
 	protected void addEvents()
 	{
-		for (Entry<String, String> eventsDefinition : ModEvents.getEvents().entrySet())
+		for (ModEventDefinition eventsDefinition : ModEvents.getEvents().values())
 		{
-			String identifier = eventsDefinition.getKey();
-			String json = eventsDefinition.getValue();
-			
-			this.addEvents(identifier, json);
+			this.addEvents(eventsDefinition);
 		}
 	}
@@ -33,41 +29,42 @@ public class ModEventInjectionTransformer extends EventInjectionTransformer
 	 * @param identifier
 	 * @param json
 	 */
-	private void addEvents(String identifier, String json)
+	private void addEvents(ModEventDefinition def)
 	{
 		JsonEvents events = null;
 		try
 		{
-			LiteLoaderLogger.info("Parsing events for mod with id %s", identifier);
-			events = JsonEvents.parse(json);
+			LiteLoaderLogger.info("Parsing events for mod with id %s", def.getIdentifier());
+			events = JsonEvents.parse(def.getJson());
 			events.register(this);
+			def.onEventsInjected();
 		}
 		catch (InvalidEventJsonException ex)
 		{
 			LiteLoaderLogger.debug(ClassTransformer.HORIZONTAL_RULE);
 			LiteLoaderLogger.debug(ex.getMessage());
 			LiteLoaderLogger.debug(ClassTransformer.HORIZONTAL_RULE);
-			LiteLoaderLogger.debug(json);
+			LiteLoaderLogger.debug(def.getJson());
 			LiteLoaderLogger.debug(ClassTransformer.HORIZONTAL_RULE);
-			LiteLoaderLogger.severe(ex, "Invalid JSON event declarations for mod with id %s", identifier);
+			LiteLoaderLogger.severe(ex, "Invalid JSON event declarations for mod with id %s", def.getIdentifier());
 		}
 		catch (Throwable ex)
 		{
-			LiteLoaderLogger.severe(ex, "Error whilst parsing event declarations for mod with id %s", identifier);
+			LiteLoaderLogger.severe(ex, "Error whilst parsing event declarations for mod with id %s", def.getIdentifier());
 		}
 		try
 		{
 			if (events != null)
 			{
-				LiteLoaderLogger.info("Registering events for mod with id %s", identifier);
+				LiteLoaderLogger.info("Registering events for mod with id %s", def.getIdentifier());
 				events.register(this);
 			}
 		}
 		catch (Throwable ex)
 		{
-			LiteLoaderLogger.severe(ex, "Error whilst parsing event declarations for mod with id %s", identifier);
+			LiteLoaderLogger.severe(ex, "Error whilst parsing event declarations for mod with id %s", def.getIdentifier());
 		}
 	}
@@ -16,9 +16,40 @@ import com.mumfrey.liteloader.util.log.LiteLoaderLogger;
 public class ModEvents implements EnumerationObserver
 {
+	public static class ModEventDefinition
+	{
+		private final LoadableModFile file;
+		
+		private final String identifier;
+		
+		private final String json;
+
+		public ModEventDefinition(LoadableModFile file, String json)
+		{
+			this.file = file;
+			this.identifier = file.getIdentifier();
+			this.json = json;
+		}
+		
+		public String getIdentifier()
+		{
+			return this.identifier;
+		}
+		
+		public String getJson()
+		{
+			return this.json;
+		}
+
+		public void onEventsInjected()
+		{
+			this.file.onEventsInjected();
+		}
+	}
+	
 	private static final String DEFINITION_FILENAME = "events.json";
-	private static Map<String, String> events = new HashMap<String, String>();
+	private static Map<String, ModEventDefinition> events = new HashMap<String, ModEventDefinition>();
 	@Override
 	public void onRegisterEnabledContainer(LoaderEnumerator enumerator, LoadableMod<?> container)
@@ -32,7 +63,7 @@ public class ModEvents implements EnumerationObserver
 			if (json == null) return;
 			LiteLoaderLogger.info("Registering %s for mod with id %s", ModEvents.DEFINITION_FILENAME, file.getIdentifier());
-			ModEvents.events.put(file.getIdentifier(), json);
+			ModEvents.events.put(file.getIdentifier(), new ModEventDefinition(file, json));
 		}
 	}
@@ -51,7 +82,7 @@ public class ModEvents implements EnumerationObserver
 	{
 	}
-	static Map<String, String> getEvents()
+	static Map<String, ModEventDefinition> getEvents()
 	{
 		return events;
 	}
@@ -38,11 +38,16 @@ gui.status.startuperror=Startup errors detected
 gui.description.missingdeps=Missing dependencies: %s
 gui.description.missingapis=Missing APIs: %s
-gui.mod.providestweak=Provides Tweak
-gui.mod.providestransformer=Provides Transformer
+gui.mod.providestweak=Tweak
+gui.mod.providestransformer=Transformer
+gui.mod.providesevents=Injector
 gui.mod.usingapi=Uses additional API
 gui.mod.startuperror=%d startup error(s)
+gui.mod.help.tweak=A tweaker is a special type of mod. Tweakers have almost unlimited control of the game and are usually mods which alter the game engine fundamentally, for example APIs or performance-enhancement mods like Optifine. Because they have the greatest amount of control, they are also the most likely to cause instability when not compatible with each other, if you are experiencing crashes or serious problems, you should always try disabling tweak mods first.
+gui.mod.help.transformer=A transformer mod uses bytecode injection to hook extra functionality within the game which LiteLoader does not normally provide. Because transformers access functionality outside of LiteLoader's core, it is possible for them to have unforseen side-effects when combined with other mods. If you are experiencing crashes or other unexpected behaviour, you should disable transformer mods before regular mods to determine whether they are the source of the issue. 
+gui.mod.help.events=An injector mod uses a restricted form of bytecode injection which makes it somewhat safer than a full transformer mod, but can still cause instability under some circumstances. If you are experiencing crashes or other issues, then you should disable injector mods before regular mods to determine whether they are the source of the issue.
+
 gui.settings.title=%s Settings
 gui.saveandclose=Save & Close