buildSrc/src/main/java/cc/squirreljme/plugin/multivm/VMCompactLibraryTask.java

   1 // -*- Mode: Java; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // Multi-Phasic Applications: SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the GNU General Public License v3+, or later.
   7 // See license.mkd for licensing and copyright information.
   8 // ---------------------------------------------------------------------------
   9
  10 package cc.squirreljme.plugin.multivm;
  11
  12 import cc.squirreljme.plugin.SquirrelJMEPluginConfiguration;
  13 import java.nio.file.Path;
  14 import java.util.Arrays;
  15 import java.util.Collection;
  16 import java.util.LinkedHashSet;
  17 import java.util.Objects;
  18 import javax.inject.Inject;
  19 import lombok.Getter;
  20 import org.gradle.api.DefaultTask;
  21 import org.gradle.api.Project;
  22 import org.gradle.api.Task;
  23 import org.gradle.api.provider.Provider;
  24 import org.gradle.api.tasks.Internal;
  25 import org.gradle.jvm.tasks.Jar;
  26
  27 /**
  28  * Performs compaction of the library so that it does not have debug
  29  * information and is smaller.
  30  *
  31  * @since 2023/02/01
  32  */
  33 public class VMCompactLibraryTask
  34         extends DefaultTask
  35 {
  36         /** The base JAR. */
  37         @Internal
  38         @Getter
  39         public final Jar baseJar;
  40
  41         /** The source set used. */
  42         @Internal
  43         @Getter
  44         private final String sourceSet;
  45
  46         /**
  47          * Initializes the compacting task.
  48          *
  49          * @param __sourceSet The source set this belongs to.
  50          * @param __baseJar The original source Jar.
  51          * @throws NullPointerException On null arguments.
  52          * @since 2023/02/01
  53          */
  54         @Inject
  55         public VMCompactLibraryTask(String __sourceSet,
  56                 Jar __baseJar)
  57                 throws NullPointerException
  58         {
  59                 if (__sourceSet == null || __baseJar == null)
  60                         throw new NullPointerException("NARG");
  61
  62                 Project project = this.getProject();
  63
  64                 this.baseJar = __baseJar;
  65                 this.sourceSet = __sourceSet;
  66
  67                 // Set details of this task
  68                 this.setGroup("squirreljme");
  69                 this.setDescription(
  70                         "Compacts the library and removes debugging info.");
  71
  72                 // Depends on the base Jar but also depends on all the
  73                 // compactLibs for all dependencies
  74                 this.dependsOn(__baseJar, this.getProject().provider(() ->
  75                         VMHelpers.compactLibTaskDepends(this.getProject(),
  76                                 this.sourceSet)));
  77
  78                 // Only run if the source JAR would run
  79                 this.onlyIf(this::onlyIf);
  80
  81                 // The input of this is the original Jar and any Jars and maps that are
  82                 // needed by ProGuard
  83                 this.getInputs().files(this.inputBaseJarPath(),
  84                         this.getProject().provider(() -> {
  85                                 Collection<Object> result = new LinkedHashSet<>();
  86                                 for (VMCompactLibraryTask compactTask :
  87                                                 VMHelpers.compactLibTaskDepends(this.getProject(),
  88                                                         this.sourceSet))
  89                                 {
  90                                         // If the input Jar changes, we want to update this one
  91                                         result.add(compactTask.inputBaseJarPath());
  92
  93                                         // If the output Jar changes, we want that one as well
  94                                         // since the mappings will be different
  95                                         result.add(compactTask.outputJarPath());
  96                                 }
  97
  98                                 return result;
  99                         }));
 100
 101                 // Inputs are the proguard options, so if this changes we need to
 102                 // do a rebuild!
 103                 this.getInputs().property("squirreljme.proguardOptions",
 104                         this.getProject().provider(() -> Objects.toString(
 105                                 SquirrelJMEPluginConfiguration.configuration(project)
 106                                         .proGuardOptions)));
 107
 108                 // Error code that is used for the prefix
 109                 this.getInputs().property("squirreljme.javaDocErrorCode",
 110                         this.getProject().provider(() -> Objects.toString(
 111                                 SquirrelJMEPluginConfiguration.configuration(project)
 112                                         .javaDocErrorCode)));
 113
 114                 // Also include the built-in plugin options, in case those change as
 115                 // well!
 116                 this.getInputs().property("squirreljme.proguardOptionsDefault",
 117                         this.getProject().provider(() -> Arrays.toString(
 118                                 VMCompactLibraryTaskAction._PARSE_SETTINGS) +
 119                                 Arrays.toString(VMCompactLibraryTaskAction._TEST_SETTINGS)));
 120
 121                 // The output of this JAR is just where it should be placed, this
 122                 // includes the mapping file for incremental mapping
 123                 this.getOutputs().files(this.outputJarPath(), this.outputMapPath());
 124
 125                 // Performs the action of the task
 126                 this.doLast(new VMCompactLibraryTaskAction(__sourceSet));
 127         }
 128
 129         /**
 130          * When should this run?
 131          *
 132          * @param __task The task to check.
 133          * @return If this should run.
 134          * @since 2023/02/01
 135          */
 136         private boolean onlyIf(Task __task)
 137         {
 138                 return this.baseJar.getOnlyIf().isSatisfiedBy(this.baseJar);
 139         }
 140
 141         /**
 142          * Returns the input Jar that will get transformed accordingly.
 143          *
 144          * @return The input Jar that we will be transforming.
 145          * @since 2023/02/05
 146          */
 147         public final Provider<Path> inputBaseJarPath()
 148         {
 149                 return this.getProject().provider(() -> this.baseJar.getOutputs()
 150                         .getFiles().getSingleFile().toPath());
 151         }
 152
 153         /**
 154          * Returns the output path of the archive.
 155          *
 156          * @return The output path.
 157          * @since 2023/02/01
 158          */
 159         public final Provider<Path> outputJarPath()
 160         {
 161                 return this.getProject().provider(() ->
 162                         this.getProject().getBuildDir().toPath()
 163                                 .resolve("squirreljme").resolve("obfuscated")
 164                                 .resolve(this.baseJar.getOutputs().getFiles()
 165                                         .getSingleFile().toPath().getFileName()));
 166         }
 167
 168         /**
 169          * Returns the output path of the mapping file.
 170          *
 171          * @return The output path of the mapping file.
 172          * @since 2023/02/05
 173          */
 174         public final Provider<Path> outputMapPath()
 175         {
 176                 return this.getProject().provider(() ->
 177                         {
 178                                 Path jarOut = this.outputJarPath().get();
 179
 180                                 return jarOut.resolveSibling(
 181                                         VMHelpers.getBaseName(jarOut) + ".map");
 182                         });
 183         }
 184 }