2020-12-24 20:58:30 +00:00
|
|
|
/*
|
|
|
|
* This file is part of fabric-loom, licensed under the MIT License (MIT).
|
|
|
|
*
|
2021-07-10 20:50:53 +00:00
|
|
|
* Copyright (c) 2016-2021 FabricMC
|
2020-12-24 20:58:30 +00:00
|
|
|
*
|
|
|
|
* 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 net.fabricmc.loom.task;
|
|
|
|
|
2021-03-25 19:03:35 +00:00
|
|
|
import java.io.File;
|
|
|
|
|
2021-01-31 00:09:40 +00:00
|
|
|
import com.google.common.base.Preconditions;
|
2020-12-24 20:58:30 +00:00
|
|
|
import org.gradle.api.Project;
|
|
|
|
import org.gradle.api.tasks.TaskContainer;
|
2021-12-04 14:39:12 +00:00
|
|
|
import org.gradle.api.tasks.TaskProvider;
|
2020-12-24 20:58:30 +00:00
|
|
|
|
|
|
|
import net.fabricmc.loom.LoomGradleExtension;
|
|
|
|
import net.fabricmc.loom.api.decompilers.LoomDecompiler;
|
2021-01-29 18:04:39 +00:00
|
|
|
import net.fabricmc.loom.configuration.ide.RunConfigSettings;
|
2021-06-14 17:39:03 +00:00
|
|
|
import net.fabricmc.loom.configuration.providers.mappings.MappingsProviderImpl;
|
2021-07-26 19:08:03 +00:00
|
|
|
import net.fabricmc.loom.util.Constants;
|
2020-12-24 20:58:30 +00:00
|
|
|
|
|
|
|
public final class LoomTasks {
|
|
|
|
private LoomTasks() {
|
|
|
|
}
|
|
|
|
|
|
|
|
public static void registerTasks(Project project) {
|
|
|
|
TaskContainer tasks = project.getTasks();
|
2021-12-17 15:37:00 +00:00
|
|
|
LoomGradleExtension extension = LoomGradleExtension.get(project);
|
2020-12-24 20:58:30 +00:00
|
|
|
|
|
|
|
tasks.register("migrateMappings", MigrateMappingsTask.class, t -> {
|
|
|
|
t.setDescription("Migrates mappings to a new version.");
|
2021-01-29 18:04:39 +00:00
|
|
|
t.getOutputs().upToDateWhen(o -> false);
|
2020-12-24 20:58:30 +00:00
|
|
|
});
|
|
|
|
|
|
|
|
tasks.register("remapJar", RemapJarTask.class, t -> {
|
|
|
|
t.setDescription("Remaps the built project jar to intermediary mappings.");
|
2021-07-26 19:08:03 +00:00
|
|
|
t.setGroup(Constants.TaskGroup.FABRIC);
|
2020-12-24 20:58:30 +00:00
|
|
|
});
|
|
|
|
|
2021-12-17 15:37:00 +00:00
|
|
|
TaskProvider<ExtractNativesTask> extractNatives = tasks.register("extractNatives", ExtractNativesTask.class);
|
|
|
|
tasks.register("downloadAssets", DownloadAssetsTask.class, t -> {
|
|
|
|
t.dependsOn(extractNatives);
|
|
|
|
t.setDescription("Downloads required assets for Fabric.");
|
|
|
|
});
|
2020-12-24 20:58:30 +00:00
|
|
|
tasks.register("remapSourcesJar", RemapSourcesJarTask.class, t -> t.setDescription("Remaps the project sources jar to intermediary names."));
|
|
|
|
|
2021-12-04 14:39:12 +00:00
|
|
|
TaskProvider<ValidateAccessWidenerTask> validateAccessWidener = tasks.register("validateAccessWidener", ValidateAccessWidenerTask.class, t -> {
|
|
|
|
t.setDescription("Validate all the rules in the access widener against the Minecraft jar");
|
|
|
|
t.setGroup("verification");
|
|
|
|
});
|
|
|
|
|
|
|
|
tasks.named("check").configure(task -> task.dependsOn(validateAccessWidener));
|
2021-10-23 14:04:22 +00:00
|
|
|
|
2020-12-24 20:58:30 +00:00
|
|
|
registerIDETasks(tasks);
|
2021-01-29 18:04:39 +00:00
|
|
|
registerRunTasks(tasks, project);
|
2020-12-24 20:58:30 +00:00
|
|
|
registerDecompileTasks(tasks, project);
|
|
|
|
}
|
|
|
|
|
|
|
|
private static void registerIDETasks(TaskContainer tasks) {
|
|
|
|
tasks.register("genIdeaWorkspace", GenIdeaProjectTask.class, t -> {
|
|
|
|
t.setDescription("Generates an IntelliJ IDEA workspace from this project.");
|
|
|
|
t.dependsOn("idea", "downloadAssets");
|
2021-07-26 19:08:03 +00:00
|
|
|
t.setGroup(Constants.TaskGroup.IDE);
|
2020-12-24 20:58:30 +00:00
|
|
|
});
|
|
|
|
|
|
|
|
tasks.register("genEclipseRuns", GenEclipseRunsTask.class, t -> {
|
|
|
|
t.setDescription("Generates Eclipse run configurations for this project.");
|
|
|
|
t.dependsOn("downloadAssets");
|
2021-07-26 19:08:03 +00:00
|
|
|
t.setGroup(Constants.TaskGroup.IDE);
|
2020-12-24 20:58:30 +00:00
|
|
|
});
|
|
|
|
|
|
|
|
tasks.register("cleanEclipseRuns", CleanEclipseRunsTask.class, t -> {
|
|
|
|
t.setDescription("Removes Eclipse run configurations for this project.");
|
2021-07-26 19:08:03 +00:00
|
|
|
t.setGroup(Constants.TaskGroup.IDE);
|
2020-12-24 20:58:30 +00:00
|
|
|
});
|
|
|
|
|
|
|
|
tasks.register("vscode", GenVsCodeProjectTask.class, t -> {
|
|
|
|
t.setDescription("Generates VSCode launch configurations.");
|
|
|
|
t.dependsOn("downloadAssets");
|
2021-07-26 19:08:03 +00:00
|
|
|
t.setGroup(Constants.TaskGroup.IDE);
|
2020-12-24 20:58:30 +00:00
|
|
|
});
|
|
|
|
}
|
|
|
|
|
2021-01-29 18:04:39 +00:00
|
|
|
private static void registerRunTasks(TaskContainer tasks, Project project) {
|
2021-07-13 23:03:21 +00:00
|
|
|
LoomGradleExtension extension = LoomGradleExtension.get(project);
|
2020-12-24 20:58:30 +00:00
|
|
|
|
2021-02-11 18:18:07 +00:00
|
|
|
Preconditions.checkArgument(extension.getRunConfigs().size() == 0, "Run configurations must not be registered before loom");
|
2021-01-29 18:04:39 +00:00
|
|
|
|
2021-02-11 18:18:07 +00:00
|
|
|
extension.getRunConfigs().whenObjectAdded(config -> {
|
2021-01-31 00:09:40 +00:00
|
|
|
String configName = config.getName();
|
|
|
|
String taskName = "run" + configName.substring(0, 1).toUpperCase() + configName.substring(1);
|
|
|
|
|
|
|
|
tasks.register(taskName, RunGameTask.class, config).configure(t -> {
|
|
|
|
t.setDescription("Starts the '" + config.getConfigName() + "' run configuration");
|
|
|
|
|
|
|
|
if (config.getEnvironment().equals("client")) {
|
|
|
|
t.dependsOn("downloadAssets");
|
|
|
|
}
|
|
|
|
});
|
2020-12-24 20:58:30 +00:00
|
|
|
});
|
2021-01-31 00:09:40 +00:00
|
|
|
|
2021-02-11 18:18:07 +00:00
|
|
|
extension.getRunConfigs().create("client", RunConfigSettings::client);
|
|
|
|
extension.getRunConfigs().create("server", RunConfigSettings::server);
|
2020-12-24 20:58:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
private static void registerDecompileTasks(TaskContainer tasks, Project project) {
|
2021-07-13 23:03:21 +00:00
|
|
|
LoomGradleExtension extension = LoomGradleExtension.get(project);
|
2020-12-24 20:58:30 +00:00
|
|
|
|
2021-01-29 18:04:39 +00:00
|
|
|
project.afterEvaluate(p -> {
|
2021-06-14 17:39:03 +00:00
|
|
|
MappingsProviderImpl mappingsProvider = extension.getMappingsProvider();
|
2021-07-13 07:52:42 +00:00
|
|
|
|
2021-07-12 23:05:24 +00:00
|
|
|
if (mappingsProvider.mappedProvider == null) {
|
|
|
|
// If this is ever null something has gone badly wrong,
|
|
|
|
// for some reason for another this afterEvaluate still gets called when something has gone badly
|
|
|
|
// wrong, returning here seems to produce nicer errors.
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2021-11-01 13:43:03 +00:00
|
|
|
File mappedJar = mappingsProvider.mappedProvider.getMappedJar();
|
2021-03-25 19:03:35 +00:00
|
|
|
|
|
|
|
if (mappingsProvider.hasUnpickDefinitions()) {
|
|
|
|
File outputJar = mappingsProvider.mappedProvider.getUnpickedJar();
|
|
|
|
|
|
|
|
tasks.register("unpickJar", UnpickJarTask.class, unpickJarTask -> {
|
2021-10-11 12:47:16 +00:00
|
|
|
unpickJarTask.getUnpickDefinitions().set(mappingsProvider.getUnpickDefinitionsFile());
|
|
|
|
unpickJarTask.getInputJar().set(mappingsProvider.mappedProvider.getMappedJar());
|
|
|
|
unpickJarTask.getOutputJar().set(outputJar);
|
2021-03-25 19:03:35 +00:00
|
|
|
});
|
|
|
|
|
2021-11-01 13:43:03 +00:00
|
|
|
mappedJar = outputJar;
|
2021-03-25 19:03:35 +00:00
|
|
|
}
|
|
|
|
|
2021-11-01 13:43:03 +00:00
|
|
|
final File inputJar = mappedJar;
|
|
|
|
|
2021-07-26 19:08:03 +00:00
|
|
|
extension.getGameDecompilers().finalizeValue();
|
|
|
|
|
|
|
|
for (LoomDecompiler decompiler : extension.getGameDecompilers().get()) {
|
2021-11-01 13:43:03 +00:00
|
|
|
String taskName = "genSourcesWith" + decompiler.name();
|
|
|
|
// Decompiler will be passed to the constructor of GenerateSourcesTask
|
|
|
|
tasks.register(taskName, GenerateSourcesTask.class, decompiler).configure(task -> {
|
|
|
|
task.setDescription("Decompile minecraft using %s.".formatted(decompiler.name()));
|
|
|
|
task.setGroup(Constants.TaskGroup.FABRIC);
|
|
|
|
task.getInputJar().set(inputJar);
|
|
|
|
|
|
|
|
if (mappingsProvider.hasUnpickDefinitions()) {
|
2021-12-04 14:39:12 +00:00
|
|
|
task.dependsOn(tasks.named("unpickJar"));
|
2021-11-01 13:43:03 +00:00
|
|
|
}
|
2021-12-04 14:39:12 +00:00
|
|
|
|
|
|
|
task.dependsOn(tasks.named("validateAccessWidener"));
|
2021-11-01 13:43:03 +00:00
|
|
|
});
|
2020-12-24 20:58:30 +00:00
|
|
|
}
|
2021-11-01 13:43:03 +00:00
|
|
|
|
|
|
|
tasks.register("genSources", task -> {
|
|
|
|
task.setDescription("Decompile minecraft using the default decompiler.");
|
|
|
|
task.setGroup(Constants.TaskGroup.FABRIC);
|
|
|
|
|
2021-12-04 14:39:12 +00:00
|
|
|
task.dependsOn(project.getTasks().named("genSourcesWithCfr"));
|
2021-11-01 13:43:03 +00:00
|
|
|
});
|
2020-12-24 20:58:30 +00:00
|
|
|
});
|
|
|
|
}
|
|
|
|
}
|