mixin: Add support for MixinBooter

This commit adds stubs and custom functionality as required by
MixinBooter to not crash when booting.

Mods which rely on other features only available in MixinBooter's Mixin
fork or which rely on the Mixin version shipped with MixinBooter, may of
course still not function properly. Although we are not currently aware
of any such mod.

Author: Johni0702

mixin/src/main/java/gg/essential/mixincompat/cleanroom/ClassInfoCompat.java

@@ -0,0 +1,23 @@
+package gg.essential.mixincompat.cleanroom;
+
+import gg.essential.CompatMixin;
+import org.spongepowered.asm.mixin.transformer.ClassInfo;
+
+@CompatMixin(ClassInfo.class)
+public class ClassInfoCompat {
+    // Method added in Cleanroom's Mixin fork, and MixinBooter calls it
+    // https://github.com/CleanroomMC/MixinBooter/blob/05fc6c7b4b36a714c90eb4cc2f2364c681da0bc8/src/main/java/zone/rong/mixinbooter/fix/MixinFixer.java#L35
+    // https://github.com/CleanroomMC/MixinBooter-UniMix/blob/9d4b487ed32501137645cdf0da484b076f0bfaf4/src/main/java/org/spongepowered/asm/mixin/transformer/ClassInfo.java#L2239
+    public static void registerCallback(Callback callback) {
+        // It seems like MixinBooter uses these callbacks to replace init-phase mixins targeting Forge's Loader to
+        // make it possible to target ordinary mod classes via mixins.
+        // Given we already add back in the methods which those old mixins call, it should be fine for us to just
+        // allow them to apply as they also would without MixinBooter, and it should just work.
+        // This method can therefore just do nothing.
+    }
+
+    @CompatMixin(target = "org.spongepowered.asm.mixin.transformer.ClassInfo$Callback", createTarget = true)
+    public interface Callback {
+        void onInit(ClassInfo classInfo);
+    }
+}

mixin/src/main/java/gg/essential/mixincompat/cleanroom/GlobalPropertiesKeysCompat.java

@@ -0,0 +1,13 @@
+package gg.essential.mixincompat.cleanroom;
+
+import gg.essential.CompatMixin;
+import org.spongepowered.asm.launch.GlobalProperties;
+
+@CompatMixin(GlobalProperties.Keys.class)
+public class GlobalPropertiesKeysCompat {
+    // Required for MixinBooter to not crash on boot
+    // https://github.com/CleanroomMC/MixinBooter/blob/05fc6c7b4b36a714c90eb4cc2f2364c681da0bc8/src/main/java/zone/rong/mixinbooter/MixinBooterPlugin.java#L87
+    // https://github.com/CleanroomMC/MixinBooter/blob/05fc6c7b4b36a714c90eb4cc2f2364c681da0bc8/src/main/java/zone/rong/mixinbooter/MixinBooterPlugin.java#L198
+    // https://github.com/CleanroomMC/MixinBooter-UniMix/blob/9d4b487ed32501137645cdf0da484b076f0bfaf4/src/main/java/org/spongepowered/asm/launch/GlobalProperties.java#L55
+    public static final GlobalProperties.Keys CLEANROOM_DISABLE_MIXIN_CONFIGS = GlobalProperties.Keys.of("mixin.cleanroom.disablemixinconfigs");
+}

mixin/src/main/java/gg/essential/mixincompat/cleanroom/IMixinProcessor.java

@@ -0,0 +1,16 @@
+package gg.essential.mixincompat.cleanroom;
+
+import gg.essential.CompatMixin;
+import org.spongepowered.asm.mixin.extensibility.IMixinConfig;
+import org.spongepowered.asm.service.IMixinService;
+
+import java.util.List;
+
+// Interface added in Cleanroom's Mixin fork to expose certain internals
+// https://github.com/CleanroomMC/MixinBooter-UniMix/blob/9d4b487ed32501137645cdf0da484b076f0bfaf4/src/main/java/org/spongepowered/asm/mixin/extensibility/IMixinProcessor.java
+@CompatMixin(target = "org.spongepowered.asm.mixin.extensibility.IMixinProcessor", createTarget = true)
+public interface IMixinProcessor {
+    IMixinService getMixinService();
+    List<IMixinConfig> getMixinConfigs();
+    List<IMixinConfig> getPendingMixinConfigs();
+}

mixin/src/main/java/gg/essential/mixincompat/cleanroom/IMixinTransformerCompat.java

@@ -0,0 +1,11 @@
+package gg.essential.mixincompat.cleanroom;
+
+import gg.essential.CompatMixin;
+import org.spongepowered.asm.mixin.transformer.IMixinTransformer;
+
+@CompatMixin(IMixinTransformer.class)
+public interface IMixinTransformerCompat {
+    // Method which exists in Cleanroom's Mixin fork, and MixinBooter crashes if it's missing
+    // https://github.com/CleanroomMC/MixinBooter/blob/05fc6c7b4b36a714c90eb4cc2f2364c681da0bc8/src/main/java/zone/rong/mixinbooter/mixin/LoadControllerMixin.java#L115
+    default IMixinProcessor getProcessor() { throw new UnsupportedOperationException(); }
+}

mixin/src/main/java/gg/essential/mixincompat/cleanroom/MixinConfigCompat.java

@@ -0,0 +1,26 @@
+package gg.essential.mixincompat.cleanroom;
+
+import gg.essential.CompatMixin;
+import gg.essential.CompatShadow;
+import org.spongepowered.asm.launch.GlobalProperties;
+import org.spongepowered.asm.mixin.MixinEnvironment;
+import org.spongepowered.asm.mixin.transformer.Config;
+
+import java.util.Collections;
+import java.util.Set;
+
+@CompatMixin(target = "org.spongepowered.asm.mixin.transformer.MixinConfig")
+public class MixinConfigCompat {
+    // See GlobalPropertiesKeysCompat
+    // https://github.com/CleanroomMC/MixinBooter-UniMix/blob/9d4b487ed32501137645cdf0da484b076f0bfaf4/src/main/java/org/spongepowered/asm/mixin/transformer/MixinConfig.java#L1400
+    static Config create(String configFile, MixinEnvironment outer) {
+        Set<String> disabledMixinConfigs = GlobalProperties.get(GlobalPropertiesKeysCompat.CLEANROOM_DISABLE_MIXIN_CONFIGS, Collections.emptySet());
+        if (disabledMixinConfigs.contains(configFile)) {
+            return null;
+        }
+        return create$original(configFile, outer);
+    }
+
+    @CompatShadow(original = "create")
+    static Config create$original(String configFile, MixinEnvironment outer) { throw new LinkageError(); }
+}

mixin/src/main/java/gg/essential/mixincompat/cleanroom/MixinProcessorCompat.java

@@ -0,0 +1,24 @@
+package gg.essential.mixincompat.cleanroom;
+
+import gg.essential.CompatMixin;
+import gg.essential.CompatShadow;
+import org.spongepowered.asm.mixin.extensibility.IMixinConfig;
+import org.spongepowered.asm.service.IMixinService;
+
+import java.util.Collections;
+import java.util.List;
+
+@CompatMixin(target = "org.spongepowered.asm.mixin.transformer.MixinProcessor")
+public class MixinProcessorCompat implements IMixinProcessor {
+    @CompatShadow
+    private IMixinService service;
+    @CompatShadow
+    private List<IMixinConfig> configs;
+    @CompatShadow
+    private List<IMixinConfig> pendingConfigs;
+
+    // See IMixinTransformerCompat
+    @Override public IMixinService getMixinService() { return service; }
+    @Override public List<IMixinConfig> getMixinConfigs() { return Collections.unmodifiableList(configs); }
+    @Override public List<IMixinConfig> getPendingMixinConfigs() { return Collections.unmodifiableList(pendingConfigs); }
+}

mixin/src/main/java/gg/essential/mixincompat/cleanroom/MixinTransformerCompat.java

@@ -0,0 +1,15 @@
+package gg.essential.mixincompat.cleanroom;
+
+import gg.essential.CompatMixin;
+import gg.essential.CompatShadow;
+
+@CompatMixin(target = "org.spongepowered.asm.mixin.transformer.MixinTransformer")
+public class MixinTransformerCompat {
+    @CompatShadow
+    private MixinProcessorCompat processor;
+
+    // Overrides the interface method added in IMixinTransformerCompat
+    public IMixinProcessor getProcessor() {
+        return processor;
+    }
+}

mixin/src/main/java/gg/essential/mixincompat/cleanroom/ProxyCompat.java

@@ -0,0 +1,17 @@
+package gg.essential.mixincompat.cleanroom;
+
+import gg.essential.CompatAccessTransformer;
+import gg.essential.CompatMixin;
+import gg.essential.CompatShadow;
+import gg.essential.mixincompat.MixinTransformerCompat;
+import org.objectweb.asm.Opcodes;
+import org.spongepowered.asm.mixin.transformer.Proxy;
+
+@CompatMixin(Proxy.class)
+public class ProxyCompat {
+    // This field is public in Cleanroom's Mixin fork, and MixinBooter accesses it as such
+    // https://github.com/CleanroomMC/MixinBooter/blob/05fc6c7b4b36a714c90eb4cc2f2364c681da0bc8/src/main/java/zone/rong/mixinbooter/mixin/LoadControllerMixin.java#L115
+    @CompatShadow
+    @CompatAccessTransformer(add = Opcodes.ACC_PUBLIC, remove = Opcodes.ACC_PRIVATE)
+    private static MixinTransformerCompat transformer;
+}

mixin/src/main/java/gg/essential/mixincompat/cleanroom/package-info.java

@@ -0,0 +1,9 @@
+/**
+ * This package contains patches to make Cleanroom's MixinBooter (which relies Cleanroom's Mixin fork) not crash
+ * (whether it is fully functional is a different question; it at least appears to be mostly functional)
+ * when its custom Mixin fork is replaced by our patched Mixin.
+ *
+ * @link https://github.com/CleanroomMC/MixinBooter/tree/05fc6c7b4b36a714c90eb4cc2f2364c681da0bc8/
+ * @link https://github.com/CleanroomMC/MixinBooter-UniMix/tree/9d4b487ed32501137645cdf0da484b076f0bfaf4/
+ */
+package gg.essential.mixincompat.cleanroom;