Add RuntimeDepCollector, deprecate RuntimeRoot

Usages of RuntimeDepCollector not yet implemented

Author: Gaming32

runtime-dep/src/main/java/net/raphimc/javadowngrader/runtime/RuntimeRoot.java

@@ -27,6 +27,6 @@
 /**
  * This class is used to get the URI of this package.
  */
-@SuppressWarnings("unused")
+@Deprecated
 public class RuntimeRoot {
 }

src/main/java/net/raphimc/javadowngrader/JavaDowngrader.java

@@ -61,11 +61,26 @@ public class JavaDowngrader {
      *
      * @param classNode     The class to downgrade
      * @param targetVersion The target Java version
+     * @see ClassNode
      */
     public static void downgrade(final ClassNode classNode, final int targetVersion) {
+        downgrade(classNode, targetVersion, RuntimeDepCollector.NULL);
+    }
+
+    /**
+     * Downgrades the given class to the target version
+     *
+     * @param classNode     The class to downgrade
+     * @param targetVersion The target Java version
+     * @param depCollector  The {@link RuntimeDepCollector} to use to collect runtime dependencies. Check the javadoc
+     *                      of {@link RuntimeDepCollector} for more info.
+     * @see ClassNode
+     * @see RuntimeDepCollector
+     */
+    public static void downgrade(final ClassNode classNode, final int targetVersion, final RuntimeDepCollector depCollector) {
         for (DowngradingTransformer transformer : TRANSFORMER) {
             if (transformer.getTargetVersion() >= targetVersion && classNode.version > transformer.getTargetVersion()) {
-                transformer.transform(classNode);
+                transformer.transform(classNode, depCollector);
             }
         }
     }

src/main/java/net/raphimc/javadowngrader/RuntimeDepCollector.java

@@ -0,0 +1,28 @@
+/*
+ * This file is part of JavaDowngrader - https://github.com/RaphiMC/JavaDowngrader
+ * Copyright (C) 2023 RK_01/RaphiMC and contributors
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package net.raphimc.javadowngrader;
+
+import java.util.function.Consumer;
+
+/**
+ * This is called with the internal name of a class to include as a runtime dependency.
+ */
+@FunctionalInterface
+public interface RuntimeDepCollector extends Consumer<String> {
+    RuntimeDepCollector NULL = c -> {};
+}

src/main/java/net/raphimc/javadowngrader/transformer/DowngradingTransformer.java

@@ -17,12 +17,13 @@
  */
 package net.raphimc.javadowngrader.transformer;
 
+import net.raphimc.javadowngrader.RuntimeDepCollector;
 import net.raphimc.javadowngrader.util.Constants;
 import org.objectweb.asm.Handle;
 import org.objectweb.asm.Opcodes;
 import org.objectweb.asm.Type;
 import org.objectweb.asm.commons.ClassRemapper;
-import org.objectweb.asm.commons.SimpleRemapper;
+import org.objectweb.asm.commons.Remapper;
 import org.objectweb.asm.tree.*;
 
 import java.lang.reflect.Field;
@@ -67,6 +68,10 @@ protected void addClassReplacement(final String oldName, final String newName) {
     }
 
     public void transform(final ClassNode classNode) {
+        transform(classNode, RuntimeDepCollector.NULL);
+    }
+
+    public void transform(final ClassNode classNode, final RuntimeDepCollector depCollector) {
         if (classNode.version > this.sourceVersion) {
             throw new IllegalArgumentException("Input class version is higher than supported");
         }
@@ -94,7 +99,9 @@ public void transform(final ClassNode classNode) {
                             replacer = this.methodCallReplacers.get(methodInsn.owner + ';' + methodInsn.name);
                         }
                         if (replacer != null) {
-                            methodNode.instructions.insertBefore(methodInsn, replacer.getReplacement(classNode, methodNode, methodInsn.name, methodInsn.desc));
+                            methodNode.instructions.insertBefore(
+                                methodInsn, replacer.getReplacement(classNode, methodNode, methodInsn.name, methodInsn.desc, depCollector)
+                            );
                             methodNode.instructions.remove(methodInsn);
                         }
                     } else if (insn instanceof InvokeDynamicInsnNode) {
@@ -119,7 +126,9 @@ public void transform(final ClassNode classNode) {
                                     for (int i1 = 0; i1 < argumentTypes.length; i1++) {
                                         bridgeMethod.instructions.add(new VarInsnNode(argumentTypes[i1].getOpcode(Opcodes.ILOAD), i1));
                                     }
-                                    bridgeMethod.instructions.add(replacer.getReplacement(classNode, bridgeMethod, handle.getName(), handle.getDesc()));
+                                    bridgeMethod.instructions.add(replacer.getReplacement(
+                                        classNode, bridgeMethod, handle.getName(), handle.getDesc(), depCollector
+                                    ));
                                     bridgeMethod.instructions.add(new InsnNode(Type.getReturnType(handle.getDesc()).getOpcode(Opcodes.IRETURN)));
                                     classNode.methods.add(bridgeMethod);
 
@@ -134,7 +143,17 @@ public void transform(final ClassNode classNode) {
 
         if (!this.classReplacements.isEmpty()) {
             final ClassNode remappedNode = new ClassNode();
-            final ClassRemapper classRemapper = new ClassRemapper(remappedNode, new SimpleRemapper(this.classReplacements));
+            final ClassRemapper classRemapper = new ClassRemapper(remappedNode, new Remapper() {
+                @Override
+                public String map(String internalName) {
+                    final String newName = classReplacements.get(internalName);
+                    if (newName != null) {
+                        depCollector.accept(newName);
+                        return newName;
+                    }
+                    return internalName;
+                }
+            });
             classNode.accept(classRemapper);
 
             // Modify the class inplace

src/main/java/net/raphimc/javadowngrader/transformer/MethodCallReplacer.java

@@ -17,12 +17,13 @@
  */
 package net.raphimc.javadowngrader.transformer;
 
+import net.raphimc.javadowngrader.RuntimeDepCollector;
 import org.objectweb.asm.tree.ClassNode;
 import org.objectweb.asm.tree.InsnList;
 import org.objectweb.asm.tree.MethodNode;
 
 public interface MethodCallReplacer {
 
-    InsnList getReplacement(final ClassNode classNode, final MethodNode method, String originalName, final String originalDesc);
+    InsnList getReplacement(final ClassNode classNode, final MethodNode method, String originalName, final String originalDesc, final RuntimeDepCollector depCollector);
 
 }

src/main/java/net/raphimc/javadowngrader/transformer/j10/methodcallreplacer/CharacterToStringMCR.java

@@ -17,13 +17,14 @@
  */
 package net.raphimc.javadowngrader.transformer.j10.methodcallreplacer;
 
+import net.raphimc.javadowngrader.RuntimeDepCollector;
 import net.raphimc.javadowngrader.transformer.MethodCallReplacer;
 import org.objectweb.asm.Opcodes;
 import org.objectweb.asm.tree.*;
 
 public class CharacterToStringMCR implements MethodCallReplacer {
     @Override
-    public InsnList getReplacement(ClassNode classNode, MethodNode method, String originalName, String originalDesc) {
+    public InsnList getReplacement(ClassNode classNode, MethodNode method, String originalName, String originalDesc, RuntimeDepCollector depCollector) {
         final InsnList replacement = new InsnList();
 
         // int

src/main/java/net/raphimc/javadowngrader/transformer/j10/methodcallreplacer/FilesReadStringMCR.java

@@ -17,14 +17,15 @@
  */
 package net.raphimc.javadowngrader.transformer.j10.methodcallreplacer;
 
+import net.raphimc.javadowngrader.RuntimeDepCollector;
 import net.raphimc.javadowngrader.transformer.MethodCallReplacer;
 import org.objectweb.asm.Opcodes;
 import org.objectweb.asm.tree.*;
 
 public class FilesReadStringMCR implements MethodCallReplacer {
 
     @Override
-    public InsnList getReplacement(ClassNode classNode, MethodNode methodNode, String originalName, String originalDesc) {
+    public InsnList getReplacement(ClassNode classNode, MethodNode methodNode, String originalName, String originalDesc, RuntimeDepCollector depCollector) {
         final InsnList replacement = new InsnList();
 
         if (originalDesc.equals("(Ljava/nio/file/Path;)Ljava/lang/String;")) {

src/main/java/net/raphimc/javadowngrader/transformer/j10/methodcallreplacer/ListToArrayMCR.java

@@ -17,14 +17,15 @@
  */
 package net.raphimc.javadowngrader.transformer.j10.methodcallreplacer;
 
+import net.raphimc.javadowngrader.RuntimeDepCollector;
 import net.raphimc.javadowngrader.transformer.MethodCallReplacer;
 import org.objectweb.asm.Opcodes;
 import org.objectweb.asm.tree.*;
 
 public class ListToArrayMCR implements MethodCallReplacer {
 
     @Override
-    public InsnList getReplacement(ClassNode classNode, MethodNode methodNode, String originalName, String originalDesc) {
+    public InsnList getReplacement(ClassNode classNode, MethodNode methodNode, String originalName, String originalDesc, RuntimeDepCollector depCollector) {
         final InsnList replacement = new InsnList();
 
         // List IntFunction

src/main/java/net/raphimc/javadowngrader/transformer/j10/methodcallreplacer/OptionalIsEmptyMCR.java

@@ -17,6 +17,7 @@
  */
 package net.raphimc.javadowngrader.transformer.j10.methodcallreplacer;
 
+import net.raphimc.javadowngrader.RuntimeDepCollector;
 import net.raphimc.javadowngrader.transformer.MethodCallReplacer;
 import org.objectweb.asm.Opcodes;
 import org.objectweb.asm.tree.*;
@@ -30,7 +31,7 @@ public OptionalIsEmptyMCR(final String optionalClass) {
     }
 
     @Override
-    public InsnList getReplacement(ClassNode classNode, MethodNode method, String originalName, String originalDesc) {
+    public InsnList getReplacement(ClassNode classNode, MethodNode method, String originalName, String originalDesc, RuntimeDepCollector depCollector) {
         final InsnList replacement = new InsnList();
 
         // Optional

src/main/java/net/raphimc/javadowngrader/transformer/j10/methodcallreplacer/PathOfMCR.java

@@ -17,6 +17,7 @@
  */
 package net.raphimc.javadowngrader.transformer.j10.methodcallreplacer;
 
+import net.raphimc.javadowngrader.RuntimeDepCollector;
 import net.raphimc.javadowngrader.transformer.MethodCallReplacer;
 import org.objectweb.asm.Opcodes;
 import org.objectweb.asm.tree.ClassNode;
@@ -27,7 +28,7 @@
 public class PathOfMCR implements MethodCallReplacer {
 
     @Override
-    public InsnList getReplacement(ClassNode classNode, MethodNode method, String originalName, String originalDesc) {
+    public InsnList getReplacement(ClassNode classNode, MethodNode method, String originalName, String originalDesc, RuntimeDepCollector depCollector) {
         final InsnList result = new InsnList();
         result.add(new MethodInsnNode(Opcodes.INVOKESTATIC, "java/nio/file/Paths", "get", originalDesc));
         return result;