Expose a way to use generated mixin mappings

Author: LexManos

renamer-gradle/src/main/java/net/minecraftforge/renamer/gradle/MergeMappings.java

@@ -53,6 +53,10 @@ protected void exec() throws IOException {
 			// I am specifically forcing this to be a single file to go along with other tasks
 			// And because ConfigurableFileCollections use a set which is unordered and order matters
 			var file = cfg.getSingleFile();
+			// Sometimes we get files that don't exist, from Mixin bullshit
+			if (!file.exists())
+				continue;
+
 			var current = IMappingFile.load(file);
 			if (map == null)
 				map = current;

renamer-gradle/src/main/java/net/minecraftforge/renamer/gradle/MixinConfig.java

@@ -72,6 +72,38 @@ default MixinSourceSetConfig source(SourceSet source, String name) {
      */
 	MixinSourceSetConfig source(SourceSet source, String name, Action<? super MixinSourceSetConfig> action);
 
+	/**
+	 * <pre>Adds The following to the specified ForgeGradle run config:
+	 *   Args:
+	 *     {@code "--mixin-config [config]"} - Tells Mixin to load specific configs, this is not needed if you specify hem in your Manifest file
+	 *   System Properties:
+	 *     {@code "mixin.env.remapRefMap: true"} - Tells Mixin to remap refmaps when loading
+	 *     {@code "mixin.env.refMapremappingFile: [map file]"} - The mapping file used to generate the refmap
+	 *
+	 * @param runConfig
+	 * </pre>
+	 */
 	void run(Object runConfig);
+
+	/**
+	 * <pre>Configures a Jar task with Mixin related values.
+	 * Specifically it adds a Manifest entry called {@code MixinConfigs} with a comma separated list of config files.
+	 * It also forces the inclusion of any refMap files for registered sourcesets
+	 *
+	 * @param provider The jar task provider
+	 * </pre>
+	 */
 	void jar(TaskProvider<Jar> provider);
+
+	/**
+	 * Gets the task that merges all generated extra mappings merged together.
+	 */
+	TaskProvider<MergeMappings> getGeneratedMappings();
+
+	/**
+	 * Gets the task that converts a mapping file into the format needed by the Annotation Processor
+	 * This can be used to customize what mappings are applied.
+	 * Defaults to converting {@link RenamerExtension#getMappings()} to {@code `tsrg`}
+	 */
+	TaskProvider<ConvertMappings> getMappings();
 }

renamer-gradle/src/main/java/net/minecraftforge/renamer/gradle/MixinConfigImpl.java

@@ -24,11 +24,15 @@ abstract class MixinConfigImpl implements MixinConfig {
 	private static final Logger LOGGER = LogManager.getLogger(MixinConfig.class);
 	private final RenamerExtensionImpl ext;
 	private final Map<String, MixinSourceSetConfigImpl> sourceSets = new HashMap<>();
+	private final TaskProvider<ConvertMappings> formatMappings;
+	private final TaskProvider<MergeMappings> generatedMappings;
 
 	@Inject
 	public MixinConfigImpl(RenamerExtensionImpl ext) {
 		this.ext = ext;
 		this.getMappingTypes().convention(List.of("tsrg"));
+    	this.formatMappings = ext.convert("formatMixinMappings", null, "tsrg", task -> task.map(ext.mappings));
+    	this.generatedMappings = ext.merge("mergeMixinMappings", task -> task.map(this.formatMappings));
 
 		/*
 		 * Mixin Magic:
@@ -62,6 +66,16 @@ public MixinConfigImpl(RenamerExtensionImpl ext) {
 		 */
 	}
 
+	@Override
+	public TaskProvider<MergeMappings> getGeneratedMappings() {
+		return this.generatedMappings;
+	}
+
+	@Override
+	public TaskProvider<ConvertMappings> getMappings() {
+		return this.formatMappings;
+	}
+
 	@Override
 	public MixinSourceSetConfig source(SourceSet source, String name, Action<? super MixinSourceSetConfig> action) {
 		if (this.sourceSets.containsKey(source.getName()))
@@ -85,7 +99,7 @@ public void run(Object runConfig) {
 			return ret;
 		}));
 		//InvokerHelper.invokeMethod(runConfig, "systemProperty", new String[]{"mixin.env.disableRefMap", "true"});
-		InvokerHelper.invokeMethod(runConfig, "systemProperties", this.ext.mixinMappings.flatMap(task -> task.getOutput()).map(
+		InvokerHelper.invokeMethod(runConfig, "systemProperties", this.generatedMappings.flatMap(task -> task.getOutput()).map(
 			file -> Map.of(
 				"mixin.env.remapRefMap", "true",
 				"mixin.env.refMapRemappingFile", file.getAsFile().getAbsolutePath()

renamer-gradle/src/main/java/net/minecraftforge/renamer/gradle/MixinSourceSetConfigImpl.java

@@ -52,7 +52,7 @@ public MixinSourceSetConfigImpl(RenamerExtensionImpl ext, MixinConfigImpl main,
 		sourceExt.set("refMapFile", refMapFile);
 
 		compile.configure(task -> {
-			var mappings = ext.mixinMappings.flatMap(ConvertMappings::getOutput);
+			var mappings = main.getMappings().flatMap(ConvertMappings::getOutput);
 			task.getInputs().files(mappings);
 			// These are generated by the AP
 			var extra = task.getExtensions().getExtraProperties();
@@ -63,6 +63,9 @@ public MixinSourceSetConfigImpl(RenamerExtensionImpl ext, MixinConfigImpl main,
 				project.getObjects().newInstance(CompilerArgs.class, MixinSourceSetConfigImpl.this, task, mappings)
 			);
 		});
+
+		// Add our output mappings to the merge task
+		main.getGeneratedMappings().configure(task -> task.map(mappingFile));
 	}
 
 	abstract static class CompilerArgs implements CommandLineArgumentProvider {

renamer-gradle/src/main/java/net/minecraftforge/renamer/gradle/RenameJar.java

@@ -56,19 +56,13 @@ public abstract class RenameJar extends ToolExecBase<RenamerProblems> implements
     protected abstract @Inject DependencyFactory getDependencyFactory();
 
     @Inject
-    public RenameJar() {
+    public RenameJar(RenamerExtensionImpl renamer) {
         super(Tools.RENAMER);
         // We don't want the default runs to log to the main task output
         this.getStandardOutputLogLevel().convention(LogLevel.INFO);
 
         // As a reminder, this is overridden by manually calling one of the #mappings methods
-        this.getMap().convention(getProviders().provider(() -> {
-            // TODO [Renamer] This assumes there's only ever one registered renamer, but i don't care for now
-            var renamer = (RenamerExtensionImpl) getProject().getExtensions().findByType(RenamerExtension.class);
-            if (renamer == null) return null;
-
-            return renamer.mappings;
-        }));
+        this.getMap().convention(getProviders().provider(() -> renamer.mappings));
 
         this.getOutput().convention(
             getObjects().fileProperty().fileProvider(getProviders().zip(this.getInput().getLocationOnly(), this.getArchiveClassifier().orElse(""), (input, classifier) -> {

renamer-gradle/src/main/java/net/minecraftforge/renamer/gradle/RenamerExtension.java

@@ -7,6 +7,7 @@
 import org.codehaus.groovy.runtime.StringGroovyMethods;
 import org.gradle.api.Action;
 import org.gradle.api.artifacts.Dependency;
+import org.gradle.api.file.ConfigurableFileCollection;
 import org.gradle.api.file.FileCollection;
 import org.gradle.api.provider.Provider;
 import org.gradle.api.provider.ProviderConvertible;
@@ -36,6 +37,8 @@ default void mappings(ProviderConvertible<?> dependency) {
 
     void setMappings(FileCollection files);
 
+    ConfigurableFileCollection getMappings();
+
     default TaskProvider<RenameJar> classes(AbstractArchiveTask input) {
         return this.classes(input, it -> it.from(input));
     }

renamer-gradle/src/main/java/net/minecraftforge/renamer/gradle/RenamerExtensionImpl.java

@@ -27,8 +27,7 @@ abstract class RenamerExtensionImpl implements RenamerExtensionInternal {
     final ConfigurableFileCollection mappings = getObjects().fileCollection();
 	private int dependencyCount = 0;
 	boolean defaultMixinBehavior = true;
-	MixinConfigImpl mixin = null;
-	TaskProvider<ConvertMappings> mixinMappings = null;
+	private MixinConfigImpl mixin = null;
 
     protected abstract @Inject Project getProject();
 
@@ -67,11 +66,17 @@ public void setMappings(FileCollection files) {
         this.mappings.setFrom(files);
     }
 
+    @Override
+    public ConfigurableFileCollection getMappings() {
+    	return this.mappings;
+    }
+
     private static final String ASSEMBLE = "assemble";
     @Override
     public TaskProvider<RenameJar> classes(String name, Action<? super RenameJar> action) {
     	var tasks = getProject().getTasks();
-        var ret = tasks.register(name, RenameJar.class, action);
+        var ret = tasks.register(name, RenameJar.class, this);
+        ret.configure(action);
 
         // Make the assemble task build our file, like the normal java plugin does
         if (tasks.getNames().contains(ASSEMBLE))
@@ -121,7 +126,8 @@ public Provider<Dependency> dependency(String notation, Action<? super RenameJar
     	self.setTransitive(false);
     	var deps = this.getProject().getConfigurations().detachedConfiguration(dep);
     	var libraries = deps.minus(self);
-    	var rename = this.getProject().getTasks().register("_rename_dep_" + this.dependencyCount++, RenameJar.class, task -> {
+    	var rename = this.getProject().getTasks().register("_rename_dep_" + this.dependencyCount++, RenameJar.class, this);
+    	rename.configure(task -> {
     		task.getMap().setFrom(this.mappings);
     		task.getInput().set(self.getSingleFile());
     		task.getLibraries().setFrom(libraries);
@@ -134,7 +140,6 @@ public Provider<Dependency> dependency(String notation, Action<? super RenameJar
     public MixinConfig getMixin() {
     	if (this.mixin == null) {
         	this.mixin = this.getObjects().newInstance(MixinConfigImpl.class, this);
-        	this.mixinMappings = this.convert("mixinMappings", null, "tsrg", task -> task.map(this.mappings));
         	this.getProject().afterEvaluate(this::mixinDefaultActions);
     	}
     	return this.mixin;

renamer-gradle/src/main/java/net/minecraftforge/renamer/gradle/Util.java

@@ -37,6 +37,8 @@ static Configuration toConfiguration(Project project, Provider<?> input) {
     	ret.getDependencies().addLater(input.map(value -> {
     		if (value instanceof Dependency dep)
     			return dep;
+    		if (value instanceof File file)
+    			return deps.create(project.files(file));
     		return deps.create(value);
     	}));
     	return ret;