Expose mixin functionality to mods

Mumfrey
1 parent 44a45235
Showing 15 changed files with 212 additions and 64 deletions
build.gradle
src/client/java/com/mumfrey/liteloader/client/api/LiteLoaderBrandingProvider.java
src/client/java/com/mumfrey/liteloader/client/api/LiteLoaderModInfoDecorator.java
src/main/java/com/mumfrey/liteloader/core/LiteLoader.java
src/main/java/com/mumfrey/liteloader/core/LiteLoaderEnumerator.java
src/main/java/com/mumfrey/liteloader/core/ModInfo.java
src/main/java/com/mumfrey/liteloader/core/api/EnumeratorModuleClassPath.java
src/main/java/com/mumfrey/liteloader/core/api/LoadableModFile.java
src/main/java/com/mumfrey/liteloader/interfaces/Loadable.java
src/main/java/com/mumfrey/liteloader/interfaces/LoadableFile.java
src/main/java/com/mumfrey/liteloader/interfaces/LoadableMod.java
src/main/java/com/mumfrey/liteloader/interfaces/MixinContainer.java
src/main/java/com/mumfrey/liteloader/interfaces/TweakContainer.java
src/main/resources/assets/liteloader/lang/en_US.lang
src/main/resources/assets/liteloader/textures/gui/about.png
@@ -64,7 +64,7 @@ repositories {
 }
 dependencies {
-    compile('org.spongepowered:mixin:0.4.10-SNAPSHOT') {
+    compile('org.spongepowered:mixin:0.4.11-SNAPSHOT') {
         exclude module: 'launchwrapper'
         exclude module: 'guava'
     }
@@ -113,7 +113,7 @@ javadoc {
 afterEvaluate {
     logger.lifecycle '================================================='
     logger.lifecycle '  LiteLoader'
-    logger.lifecycle '  Copyright (C) 2011-2015 Adam Mummery-Smith'
+    logger.lifecycle '  Copyright (C) 2011-2016 Adam Mummery-Smith'
     logger.lifecycle '  Running in {} mode', (project.isReleaseBuild ? "RELEASE" : "SNAPSHOT")
     logger.lifecycle '================================================='
@@ -180,6 +180,14 @@ shadowJar {
     classifier = 'release'
 }
+sourceJar {
+    dependsOn retromapReplacedDebug
+    dependsOn retromapReplacedClient
+    
+    from zipTree(tasks.retromapReplacedDebug.out)
+    from zipTree(tasks.retromapReplacedClient.out)
+}
+
 task javadocJar(type: Jar, dependsOn: javadoc) {
     from javadoc.destinationDir
     classifier = 'javadoc'
@@ -54,7 +54,7 @@ public class LiteLoaderBrandingProvider implements BrandingProvider
     @Override
     public String getCopyrightText()
     {
-        return "Copyright (c) 2012-2014 Adam Mummery-Smith";
+        return "Copyright (c) 2012-2016 Adam Mummery-Smith";
     }
     /* (non-Javadoc)
@@ -74,6 +74,22 @@ public class LiteLoaderModInfoDecorator implements ModInfoDecorator
             });
         }
+        if (mod.hasMixins())
+        {
+            icons.add(new IconAbsoluteClickable(LiteLoaderBrandingProvider.ABOUT_TEXTURE,
+                    I18n.format("gui.mod.providesmixins"), 12, 12, 122, 104, 134, 116)
+            {
+                @Override
+                public void onClicked(Object source, Object container)
+                {
+                    if (container instanceof GuiModListPanel)
+                    {
+                        ((GuiModListPanel)container).displayModHelpMessage(mod, "gui.mod.providesmixins", "gui.mod.help.mixins");
+                    }
+                }
+            });
+        }
+        
         if (mod.usesAPI())
         {
             icons.add(new IconAbsolute(LiteLoaderBrandingProvider.ABOUT_TEXTURE,
@@ -626,7 +626,6 @@ public final class LiteLoader
      * @param modNameOrId
      * @param metaDataKey
      * @param defaultValue
-     * @throws InvalidActivityException Thrown by getMod if init is not complete
      * @throws IllegalArgumentException Thrown by getMod if argument is null
      */
     public String getModMetaData(String modNameOrId, String metaDataKey, String defaultValue) throws IllegalArgumentException
@@ -15,8 +15,8 @@ import java.util.List;
 import java.util.Map;
 import java.util.Set;
-import net.minecraft.launchwrapper.Launch;
-import net.minecraft.launchwrapper.LaunchClassLoader;
+import org.spongepowered.asm.mixin.MixinEnvironment;
+import org.spongepowered.asm.mixin.MixinEnvironment.Phase;
 import com.google.common.base.Throwables;
 import com.mumfrey.liteloader.LiteMod;
@@ -35,6 +35,7 @@ import com.mumfrey.liteloader.interfaces.Injectable;
 import com.mumfrey.liteloader.interfaces.Loadable;
 import com.mumfrey.liteloader.interfaces.LoadableMod;
 import com.mumfrey.liteloader.interfaces.LoaderEnumerator;
+import com.mumfrey.liteloader.interfaces.MixinContainer;
 import com.mumfrey.liteloader.interfaces.TweakContainer;
 import com.mumfrey.liteloader.launch.ClassTransformerManager;
 import com.mumfrey.liteloader.launch.LiteLoaderTweaker;
@@ -43,6 +44,9 @@ import com.mumfrey.liteloader.launch.LoaderProperties;
 import com.mumfrey.liteloader.util.log.LiteLoaderLogger;
 import com.mumfrey.liteloader.util.log.LiteLoaderLogger.Verbosity;
+import net.minecraft.launchwrapper.Launch;
+import net.minecraft.launchwrapper.LaunchClassLoader;
+
 /**
  * The enumerator performs all mod discovery functions for LiteLoader, this
  * includes locating mod files to load as well as searching for mod classes
@@ -571,7 +575,12 @@ public class LiteLoaderEnumerator implements LoaderEnumerator
             if (tweakContainer.hasClassTransformers())
             {
-                this.addClassTransformersFrom(tweakContainer, tweakContainer.getClassTransformerClassNames());
+                this.addClassTransformersFrom(tweakContainer);
+            }
+            
+            if (tweakContainer.hasMixins())
+            {
+                this.addMixinsFrom(tweakContainer);
             }
         }
     }
@@ -618,11 +627,11 @@ public class LiteLoaderEnumerator implements LoaderEnumerator
         }
     }
-    private void addClassTransformersFrom(TweakContainer<File> container, List<String> classTransformerClasses)
+    private void addClassTransformersFrom(TweakContainer<File> container)
     {
         try
         {
-            for (String classTransformerClass : classTransformerClasses)
+            for (String classTransformerClass : container.getClassTransformerClassNames())
             {
                 LiteLoaderLogger.info(Verbosity.REDUCED, "Mod file '%s' provides classTransformer '%s', adding to class loader",
                         container.getName(), classTransformerClass);
@@ -639,6 +648,30 @@ public class LiteLoaderEnumerator implements LoaderEnumerator
         }
     }
+    private void addMixinsFrom(MixinContainer<File> container)
+    {
+        for (String config : container.getMixinConfigs())
+        {
+            if (config.endsWith(".json"))
+            {
+                LiteLoaderLogger.info(Verbosity.REDUCED, "Registering mixin config %s for %s", config, container.getName());
+                MixinEnvironment.getDefaultEnvironment().addConfiguration(config);
+            }
+            else if (config.contains(".json@"))
+            {
+                int pos = config.indexOf(".json@");
+                String phaseName = config.substring(pos + 6);
+                config = config.substring(0, pos + 5);
+                Phase phase = Phase.forName(phaseName);
+                if (phase != null)
+                {
+                    LiteLoaderLogger.info(Verbosity.REDUCED, "Registering mixin config %s for %s", config, container.getName());
+                    MixinEnvironment.getEnvironment(phase).addConfiguration(config);
+                }
+            }
+        }
+    }
+    
     /**
      * @param container
      */
@@ -9,6 +9,7 @@ import com.google.common.collect.ImmutableSet;
 import com.mumfrey.liteloader.LiteMod;
 import com.mumfrey.liteloader.interfaces.Loadable;
 import com.mumfrey.liteloader.interfaces.LoadableMod;
+import com.mumfrey.liteloader.interfaces.MixinContainer;
 import com.mumfrey.liteloader.interfaces.TweakContainer;
 /**
@@ -179,6 +180,14 @@ public abstract class ModInfo&lt;TContainer extends Loadable&lt;?&gt;&gt;
     {
         return (this.container instanceof TweakContainer && ((TweakContainer<?>)this.container).hasEventTransformers());
     }
+    
+    /**
+     * If this has mixins
+     */
+    public boolean hasMixins()
+    {
+        return (this.container instanceof MixinContainer && ((MixinContainer<?>)this.container).hasMixins());
+    }
     /**
      * Get whether this mod uses external (3rd-party) API
@@ -92,7 +92,7 @@ public class EnumeratorModuleClassPath implements EnumeratorModule
                         if (enumerator.registerModContainer(classPathMod))
                         {
                             this.loadableMods.add(classPathMod);
-                            if (classPathMod.hasTweakClass() || classPathMod.hasClassTransformers())
+                            if (classPathMod.requiresPreInitInjection())
                             {
                                 enumerator.registerTweakContainer(classPathMod);
                             }
@@ -187,6 +187,7 @@ public class LoadableModFile extends LoadableFile implements LoadableMod&lt;File&gt;
             this.getMetaValuesInto(this.classTransformerClassNames, "classTransformerClasses", ",");
             this.getMetaValuesInto(this.dependencies, "dependsOn", ",");
             this.getMetaValuesInto(this.requiredAPIs, "requiredAPIs", ",");
+            this.getMetaValuesInto(this.mixinConfigs, "mixinConfigs", ",");
         }
         catch (ClassCastException ex)
         {
@@ -91,4 +91,10 @@ public interface Loadable&lt;L&gt; extends Comparable&lt;L&gt;
      * File instance, otherwise returns null.
      */
     public abstract File toFile();
+    
+    /**
+     * Get whether this container requires early injection, eg. it contains a
+     * tweaker, transformer or mixins
+     */
+    public abstract boolean requiresPreInitInjection();
 }
@@ -5,7 +5,6 @@ import java.io.IOException;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.nio.charset.Charset;
-import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.List;
@@ -30,6 +29,19 @@ import net.minecraft.launchwrapper.LaunchClassLoader;
 public class LoadableFile extends File implements TweakContainer<File>
 {
+    public static final String MFATT_MODTYPE = "ModType";
+    public static final String MFATT_TWEAK_CLASS = "TweakClass";
+    public static final String MFATT_CLASS_PATH = "Class-Path";
+    public static final String MFATT_TWEAK_ORDER = "TweakOrder";
+    public static final String MFATT_IMPLEMENTATION_TITLE = "Implementation-Title";
+    public static final String MFATT_TWEAK_NAME = "TweakName";
+    public static final String MFATT_IMPLEMENTATION_VERSION = "Implementation-Version";
+    public static final String MFATT_TWEAK_VERSION = "TweakVersion";
+    public static final String MFATT_IMPLEMENTATION_VENDOR = "Implementation-Vendor";
+    public static final String MFATT_TWEAK_AUTHOR = "TweakAuthor";
+    public static final String MFATT_MIXIN_CONFIGS = "MixinConfigs";
+    public static final String MFATT_INJECTION_STRATEGY = "TweakInjectionStrategy";
+
     private static final Pattern versionPattern = Pattern.compile("([0-9]+\\.)+[0-9]+([_A-Z0-9]+)?");
     private static final long serialVersionUID = 1L;
@@ -75,6 +87,11 @@ public class LoadableFile extends File implements TweakContainer&lt;File&gt;
     protected boolean hasEventTransformers;
     /**
+     * Mixin config resource names
+     */
+    protected Set<String> mixinConfigs = new HashSet<String>();
+
+    /**
      * Create a new tweak container wrapping the specified file
      */
     public LoadableFile(File parent)
@@ -145,12 +162,24 @@ public class LoadableFile extends File implements TweakContainer&lt;File&gt;
             if (jar.getManifest() != null)
             {
                 LiteLoaderLogger.info("Inspecting jar metadata in '%s'", this.getName());
-                Attributes manifestAttributes = jar.getManifest().getMainAttributes();
-
-                String modSystemList = manifestAttributes.getValue("ModType");
-                if (modSystemList != null)
+                Attributes mfAttributes = jar.getManifest().getMainAttributes();
+
+                String mfAttmodSystemList     = mfAttributes.getValue(LoadableFile.MFATT_MODTYPE);
+                String mfAttTweakClass        = mfAttributes.getValue(LoadableFile.MFATT_TWEAK_CLASS);
+                String mfAttClassPath         = mfAttributes.getValue(LoadableFile.MFATT_CLASS_PATH);
+                String mfAttTweakOrder        = mfAttributes.getValue(LoadableFile.MFATT_TWEAK_ORDER);
+                String mfAttDisplayName       = mfAttributes.getValue(LoadableFile.MFATT_IMPLEMENTATION_TITLE);
+                String mfAttTweakName         = mfAttributes.getValue(LoadableFile.MFATT_TWEAK_NAME);
+                String mfAttVersion           = mfAttributes.getValue(LoadableFile.MFATT_IMPLEMENTATION_VERSION);
+                String mfAttTweakVersion      = mfAttributes.getValue(LoadableFile.MFATT_TWEAK_VERSION);
+                String mfAttAuthor            = mfAttributes.getValue(LoadableFile.MFATT_IMPLEMENTATION_VENDOR);
+                String mfAttTweakAuthor       = mfAttributes.getValue(LoadableFile.MFATT_TWEAK_AUTHOR);
+                String mfAttMixinConfigs      = mfAttributes.getValue(LoadableFile.MFATT_MIXIN_CONFIGS);
+                String mfAttInjectionStrategy = mfAttributes.getValue(LoadableFile.MFATT_INJECTION_STRATEGY);
+                
+                if (mfAttmodSystemList != null)
                 {
-                    for (String modSystem : modSystemList.split(","))
+                    for (String modSystem : mfAttmodSystemList.split(","))
                     {
                         modSystem = modSystem.trim();
                         if (modSystem.length() > 0)
@@ -160,57 +189,37 @@ public class LoadableFile extends File implements TweakContainer&lt;File&gt;
                     }
                 }
-                this.tweakClassName = manifestAttributes.getValue("TweakClass");
-                if (this.tweakClassName != null)
+                this.tweakClassName = mfAttTweakClass;
+                if (this.tweakClassName != null && mfAttClassPath != null)
                 {
-                    String classPath = manifestAttributes.getValue("Class-Path");
-                    if (classPath != null)
-                    {
-                        this.classPathEntries = classPath.split(" ");
-                    }
+                    this.classPathEntries = mfAttClassPath.split(" ");
                 }
-                if (manifestAttributes.getValue("TweakOrder") != null)
+                if (mfAttTweakOrder != null)
                 {
-                    Integer tweakOrder = Ints.tryParse(manifestAttributes.getValue("TweakOrder"));
+                    Integer tweakOrder = Ints.tryParse(mfAttTweakOrder);
                     if (tweakOrder != null)
                     {
                         this.tweakPriority = tweakOrder.intValue();
                     }
                 }
-                if (manifestAttributes.getValue("Implementation-Title") != null)
+                if (mfAttDisplayName  != null) this.displayName = mfAttDisplayName;
+                if (mfAttTweakName    != null) this.displayName = mfAttTweakName;
+                if (mfAttVersion      != null) this.version     = mfAttVersion;
+                if (mfAttTweakVersion != null) this.version     = mfAttTweakVersion;
+                if (mfAttAuthor       != null) this.author      = mfAttAuthor;
+                if (mfAttTweakAuthor  != null) this.author      = mfAttTweakAuthor;
+                
+                if (mfAttMixinConfigs != null)
                 {
-                    this.displayName = manifestAttributes.getValue("Implementation-Title");
-                }
-
-                if (manifestAttributes.getValue("TweakName") != null)
-                {
-                    this.displayName = manifestAttributes.getValue("TweakName");
-                }
-
-                if (manifestAttributes.getValue("Implementation-Version") != null)
-                {
-                    this.version = manifestAttributes.getValue("Implementation-Version");
-                }
-
-                if (manifestAttributes.getValue("TweakVersion") != null)
-                {
-                    this.version = manifestAttributes.getValue("TweakVersion");
-                }
-
-                if (manifestAttributes.getValue("Implementation-Vendor") != null)
-                {
-                    this.author = manifestAttributes.getValue("Implementation-Vendor");
-                }
-
-                if (manifestAttributes.getValue("TweakAuthor") != null)
-                {
-                    this.author = manifestAttributes.getValue("TweakAuthor");
+                    for (String config : mfAttMixinConfigs.split(","))
+                    {
+                        this.mixinConfigs.add(config);
+                    }
                 }
-                String tweakInjectionStrategy = manifestAttributes.getValue("TweakInjectionStrategy");
-                this.injectionStrategy = InjectionStrategy.parseStrategy(tweakInjectionStrategy, InjectionStrategy.TOP);
+                this.injectionStrategy = InjectionStrategy.parseStrategy(mfAttInjectionStrategy, InjectionStrategy.TOP);
             }
         }
         catch (Exception ex)
@@ -314,7 +323,19 @@ public class LoadableFile extends File implements TweakContainer&lt;File&gt;
     @Override
     public List<String> getClassTransformerClassNames()
     {
-        return new ArrayList<String>();
+        return Collections.<String>emptyList();
+    }
+    
+    @Override
+    public boolean hasMixins()
+    {
+        return this.mixinConfigs.size() > 0;
+    }
+    
+    @Override
+    public Set<String> getMixinConfigs()
+    {
+        return this.mixinConfigs;
     }
     @Override
@@ -337,6 +358,12 @@ public class LoadableFile extends File implements TweakContainer&lt;File&gt;
     {
         this.forceInjection = forceInjection;
     }
+    
+    @Override
+    public boolean requiresPreInitInjection()
+    {
+        return this.hasTweakClass() || this.hasClassTransformers() || this.hasMixins();
+    }
     @Override
     public boolean isInjected()
@@ -3,8 +3,7 @@ package com.mumfrey.liteloader.interfaces;
 import java.io.File;
 import java.net.MalformedURLException;
 import java.net.URL;
-import java.util.ArrayList;
-import java.util.HashSet;
+import java.util.Collections;
 import java.util.List;
 import java.util.Set;
@@ -287,7 +286,7 @@ public interface LoadableMod&lt;L&gt; extends Loadable&lt;L&gt;, Injectable
         @Override
         public Set<String> getMetaDataKeys()
         {
-            return new HashSet<String>();
+            return Collections.<String>emptySet();
         }
         @Override
@@ -305,7 +304,7 @@ public interface LoadableMod&lt;L&gt; extends Loadable&lt;L&gt;, Injectable
         @Override
         public Set<String> getDependencies()
         {
-            return new HashSet<String>();
+            return Collections.<String>emptySet();
         }
         @Override
@@ -316,13 +315,13 @@ public interface LoadableMod&lt;L&gt; extends Loadable&lt;L&gt;, Injectable
         @Override
         public Set<String> getMissingDependencies()
         {
-            return new HashSet<String>();
+            return Collections.<String>emptySet();
         }
         @Override
         public Set<String> getRequiredAPIs()
         {
-            return new HashSet<String>();
+            return Collections.<String>emptySet();
         }
         @Override
@@ -333,18 +332,24 @@ public interface LoadableMod&lt;L&gt; extends Loadable&lt;L&gt;, Injectable
         @Override
         public Set<String> getMissingAPIs()
         {
-            return new HashSet<String>();
+            return Collections.<String>emptySet();
         }
         @Override
         public List<String> getContainedClassNames()
         {
-            return new ArrayList<String>();
+            return Collections.<String>emptyList();
         }
         @Override
         public void addContainedMod(String modName)
         {
         }
+        
+        @Override
+        public boolean requiresPreInitInjection()
+        {
+            return false;
+        }
     }
 }
+/*
+ * This file is part of Sponge, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) SpongePowered <https://www.spongepowered.org>
+ * Copyright (c) contributors
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.mumfrey.liteloader.interfaces;
+
+import java.util.Set;
+
+public interface MixinContainer<L> extends Loadable<L>, Injectable
+{
+    
+    /**
+     * Get whether this container has any mixins
+     */
+    public abstract boolean hasMixins();
+
+    /**
+     * Get this mod's list of mixin configs
+     */
+    public abstract Set<String> getMixinConfigs();
+
+}
@@ -7,7 +7,7 @@ import java.util.List;
  * 
  * @author Adam Mummery-Smith
  */
-public interface TweakContainer<L> extends Loadable<L>, Injectable
+public interface TweakContainer<L> extends MixinContainer<L>
 {
     /**
      * Get whether this tweak container has a defined tweak class in its
@@ -41,12 +41,14 @@ gui.description.missingapis=Missing APIs: %s
 gui.mod.providestweak=Tweak
 gui.mod.providestransformer=Transformer
 gui.mod.providesevents=Injector
+gui.mod.providesmixins=Mixins
 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. Forge refers to this type of mod as a §lCoreMod  
 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.mod.help.mixins=A mod with mixins uses a safe form of bytecode injection to hook into Minecraft
 gui.settings.title=%s Settings
 gui.saveandclose=Save & Close