diff --git a/build.gradle b/build.gradle index ce4d425a..e6da64db 100644 --- a/build.gradle +++ b/build.gradle @@ -1,17 +1,19 @@ // Gradle repositories and dependencies buildscript { repositories { - jcenter() + gradlePluginPortal() } dependencies { - classpath 'nl.javadude.gradle.plugins:license-gradle-plugin:0.11.0' - classpath 'com.github.jengelman.gradle.plugins:shadow:6.1.0' + classpath 'gradle.plugin.com.hierynomus.gradle.plugins:license-gradle-plugin:0.16.1' + classpath 'gradle.plugin.com.github.jengelman.gradle.plugins:shadow:7.0.0' } } +import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar + // Apply plugin apply plugin: 'java' -apply plugin: 'license' +apply plugin: 'com.github.hierynomus.license' apply plugin: 'checkstyle' apply plugin: 'maven-publish' apply plugin: 'eclipse' @@ -56,8 +58,8 @@ repositories { url = 'https://libraries.minecraft.net/' } maven { - name = 'fabric' - url = 'http://maven.fabricmc.net/' + name = 'Fabric' + url = 'https://maven.fabricmc.net/' } maven { // For modlauncher @@ -69,25 +71,45 @@ repositories { configurations { thinJar stagingJar + + exampleImplementation .extendsFrom implementation + fernflowerImplementation .extendsFrom implementation + launchwrapperImplementation .extendsFrom implementation + agentImplementation .extendsFrom implementation + modlauncherImplementation .extendsFrom implementation + modlauncher9Implementation .extendsFrom modlauncherImplementation + modularityImplementation .extendsFrom modlauncher9Implementation } -// Include annotation processor sourceSet sourceSets { - legacy + legacy { + ext.languageVersion = 8 + ext.compatibility = '1.6' + } main { compileClasspath += legacy.output + ext.languageVersion = 8 + ext.compatibility = '1.6' } ap { compileClasspath += main.output + ext.languageVersion = 8 + ext.compatibility = '1.6' } fernflower { compileClasspath += main.output + ext.languageVersion = 8 + ext.compatibility = '1.6' } agent { compileClasspath += main.output + ext.languageVersion = 8 + ext.compatibility = '1.6' } bridge { compileClasspath += main.output + ext.languageVersion = 8 + ext.compatibility = '1.8' } example { compileClasspath += main.output @@ -95,22 +117,46 @@ sourceSets { } launchwrapper { compileClasspath += main.output + ext.languageVersion = 8 + ext.compatibility = '1.8' } modlauncher { compileClasspath += main.output + ext.languageVersion = 8 + ext.compatibility = '1.8' + } + modlauncher4 { + compileClasspath += main.output + compileClasspath += modlauncher.output + ext.languageVersion = 8 + ext.compatibility = '1.8' + } + modlauncher9 { + compileClasspath += main.output + compileClasspath += modlauncher.output + } + modularity { + java.srcDirs += [ + sourceSets.legacy.java.srcDirs, + sourceSets.main.java.srcDirs, + sourceSets.ap.java.srcDirs, + sourceSets.agent.java.srcDirs, + sourceSets.modlauncher.java.srcDirs, + sourceSets.modlauncher9.java.srcDirs + ] } } // Project dependencies dependencies { def guava = 'com.google.guava:guava:21.0' // from mc1.12 onwards - def log4j2 = 'org.apache.logging.log4j:log4j-core:2.0-beta9' + def log4j2 = 'org.apache.logging.log4j:log4j-core:2.11.2' - compile guava - compile log4j2 - compile 'com.google.code.gson:gson:2.2.4' + implementation guava + implementation log4j2 + implementation 'com.google.code.gson:gson:2.2.4' if (Float.parseFloat(asmVersion) < 6) { - compile "org.ow2.asm:asm-debug-all:$asmVersion" + implementation "org.ow2.asm:asm-debug-all:$asmVersion" } implementation "org.ow2.asm:asm-tree:$asmVersion" implementation "org.ow2.asm:asm-commons:$asmVersion" @@ -119,51 +165,61 @@ dependencies { thinJar "org.ow2.asm:asm-tree:$asmVersion" thinJar "org.ow2.asm:asm-util:$asmVersion" - // Tests -// testCompile 'junit:junit:4.11' -// testCompile 'org.hamcrest:hamcrest-library:1.3' -// testCompile 'org.mockito:mockito-core:1.9.0' - // Annotation Processor - apCompile "org.ow2.asm:asm-tree:$asmVersion" - apCompile guava - - // AP extension example - exampleCompile configurations.compile - exampleImplementation configurations.implementation + apImplementation "org.ow2.asm:asm-tree:$asmVersion" + apImplementation guava // Fernflower decompiler - fernflowerCompile configurations.compile - fernflowerImplementation configurations.implementation - fernflowerCompile 'org.jetbrains:intellij-fernflower:1.0.0.9' + fernflowerImplementation 'org.jetbrains.java.decompiler:fernflower:sponge-SNAPSHOT' // LegacyLauncher service - launchwrapperCompile configurations.compile - launchwrapperImplementation configurations.implementation - launchwrapperCompile ('net.minecraft:launchwrapper:1.11') { + launchwrapperImplementation ('net.minecraft:launchwrapper:1.11') { exclude module: 'lwjgl' + exclude module: 'asm-debug-all' + exclude module: 'jopt-simple' } - - modlauncherCompile configurations.compile - modlauncherImplementation configurations.implementation - modlauncherCompile 'net.sf.jopt-simple:jopt-simple:5.0.4' - modlauncherCompile "org.ow2.asm:asm-tree:$modlauncherAsmVersion" - modlauncherCompile "org.ow2.asm:asm-commons:$modlauncherAsmVersion" - modlauncherCompile "org.ow2.asm:asm-util:$modlauncherAsmVersion" - modlauncherCompile ("cpw.mods:modlauncher:$modlauncherVersion") { - exclude module: 'log4j-core' - } - modlauncherCompile 'cpw.mods:grossjava9hacks:1.3.+' - - // agent - agentCompile configurations.compile - agentImplementation configurations.implementation - - // asm bridge - bridgeCompile log4j2 - bridgeCompile "org.ow2.asm:asm-commons:$legacyForgeAsmVersion" - legacyCompile "org.ow2.asm:asm-tree:$asmVersion" + modlauncherImplementation 'net.sf.jopt-simple:jopt-simple:5.0.4' + modlauncherImplementation ("cpw.mods:modlauncher:$legacyModlauncherVersion") { + exclude module: 'asm' + exclude module: 'asm-analysis' + exclude module: 'asm-commons' + exclude module: 'asm-tree' + exclude module: 'log4j-api' + exclude module: 'log4j-core' + exclude module: 'jopt-simple' + } + + modlauncher4Implementation ("cpw.mods:modlauncher:$legacyModlauncherVersion") { + exclude module: 'asm' + exclude module: 'asm-analysis' + exclude module: 'asm-commons' + exclude module: 'asm-tree' + exclude module: 'log4j-api' + exclude module: 'log4j-core' + exclude module: 'jopt-simple' + } + + modlauncher9Implementation ("cpw.mods:modlauncher:$modlauncherVersion") { + exclude module: 'log4j-api' + exclude module: 'log4j-core' + exclude module: 'jopt-simple' + } + modlauncher9Implementation 'cpw.mods:securejarhandler:0.9.+' + + // asm bridge + bridgeImplementation log4j2 + bridgeImplementation "org.ow2.asm:asm-commons:$legacyForgeAsmVersion" + + legacyImplementation "org.ow2.asm:asm-tree:$asmVersion" +} + +compileModularityJava { + doFirst { + options.compilerArgs = [ + '--module-path', classpath.asPath + ] + } } javadoc { @@ -187,21 +243,21 @@ javadoc { } } -// Eclipse -eclipse.classpath.plusConfigurations += [ - configurations.fernflowerCompile, - configurations.launchwrapperCompile, - configurations.modlauncherCompile, - configurations.bridgeCompile -] +eclipse { + classpath { + containers 'org.eclipse.buildship.core.gradleclasspathcontainer' + file.whenMerged { + // Can't include old modlauncher because it causes issues with modules + entries.removeAll { it.kind == 'lib' && it.path =~ ~/modlauncher-$legacyModlauncherVersion/ } + entries.removeAll { it.kind == 'src' && it.path =~ ~/modlauncher4/ } -// IntelliJ -idea.module.scopes.COMPILE.plus += [ - configurations.fernflowerCompile, - configurations.launchwrapperCompile, - configurations.modlauncherCompile, - configurations.bridgeCompile -] + // Mark everything else as a module + entries.findAll { it.kind == "con" && it.path =~ /gradleclasspathcontainer$/ }.each { + it.entryAttributes['module'] = 'true' + } + } + } +} // Filter, process, and include resources processResources { @@ -235,6 +291,7 @@ checkstyle { ] configFile = file("checkstyle.xml") toolVersion = '8.43' + sourceSets -= project.sourceSets['modularity'] } // Source compiler configuration @@ -242,23 +299,30 @@ tasks.withType(JavaCompile) { options.compilerArgs += ['-Xlint:all', '-Xlint:-path', '-proc:none'] options.deprecation = true options.encoding = 'utf8' - if (JavaVersion.current().isJava9Compatible()) { - options.release = 8 - } } +project.sourceSets.each { set -> { + if (set.ext.has("languageVersion")) { + project.tasks[set.compileJavaTaskName].javaCompiler = javaToolchains.compilerFor { + languageVersion = JavaLanguageVersion.of(set.ext.languageVersion) + } + } + if (set.ext.has("compatibility")) { + project.tasks[set.compileJavaTaskName].sourceCompatibility = set.ext.compatibility + project.tasks[set.compileJavaTaskName].targetCompatibility = set.ext.compatibility + } +}} + if (JavaVersion.current().isJava8Compatible()) { tasks.withType(Javadoc) { // disable the crazy super-strict doclint tool in Java 8 - options.addStringOption('Xdoclint:none', '-quiet') + options.addStringOption('Xdoclint:syntax', '-quiet') } } -task stagingJar(type: com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar) { - sourceSets.each { - if (it.name != 'example') { - from it.output - } +task stagingJar(type: ShadowJar) { + sourceSets.findAll { !(it.name =~ /example|modularity/) }.each { + from it.output } configurations = [project.configurations.stagingJar] @@ -312,8 +376,6 @@ build.dependsOn(thinJar) // generate shadow jar so we can use the AP standalone shadowJar { from sourceSets.ap.output - exclude 'META-INF/*.DSA' - exclude 'META-INF/*.RSA' classifier = 'processor' } build.dependsOn(shadowJar) @@ -352,11 +414,12 @@ task timestamp(type: Jar, dependsOn: build) { } task sourceJar(type: Jar) { - sourceSets.each { + sourceSets.findAll { it.name != 'modularity' }.each { from it.java from it.resources } classifier = "sources" + duplicatesStrategy = DuplicatesStrategy.EXCLUDE } task javadocJar(type: Jar, dependsOn: javadoc) { diff --git a/gradle.properties b/gradle.properties index a947e287..6f2485d9 100644 --- a/gradle.properties +++ b/gradle.properties @@ -5,9 +5,10 @@ description=Mixin (Fabric fork) url=https://fabricmc.net organization=FabricMC buildVersion=0.9.4 -upstreamMixinVersion=0.8.3 +upstreamMixinVersion=0.8.4 buildType=RELEASE asmVersion=9.1 legacyForgeAsmVersion=5.0.3 -modlauncherAsmVersion=7.2 -modlauncherVersion=7.0.0 \ No newline at end of file +modlauncherAsmVersion=9.1 +modlauncherVersion=9.0.7 +legacyModlauncherVersion=7.0.0 \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index 28ff446a..f8bda6ea 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,5 +1,6 @@ +#Sun Dec 14 16:44:28 EST 2014 distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.1-bin.zip zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.0.2-bin.zip diff --git a/src/agent/java/org/spongepowered/tools/agent/MixinAgentClassLoader.java b/src/agent/java/org/spongepowered/tools/agent/MixinAgentClassLoader.java index 2fd768cb..297a5c1b 100644 --- a/src/agent/java/org/spongepowered/tools/agent/MixinAgentClassLoader.java +++ b/src/agent/java/org/spongepowered/tools/agent/MixinAgentClassLoader.java @@ -68,7 +68,7 @@ class MixinAgentClassLoader extends ClassLoader { Class clazz = this.defineClass(name, bytes, 0, bytes.length); // apparently the class needs to be instantiated at least once // to be including in list returned by allClasses() method in jdi api - clazz.newInstance(); + clazz.getDeclaredConstructor().newInstance(); this.mixins.put(clazz, bytes); } catch (Throwable e) { MixinAgentClassLoader.logger.catching(e); diff --git a/src/ap/java/org/spongepowered/tools/obfuscation/MixinObfuscationProcessor.java b/src/ap/java/org/spongepowered/tools/obfuscation/MixinObfuscationProcessor.java index 44192441..30efc09e 100644 --- a/src/ap/java/org/spongepowered/tools/obfuscation/MixinObfuscationProcessor.java +++ b/src/ap/java/org/spongepowered/tools/obfuscation/MixinObfuscationProcessor.java @@ -80,13 +80,7 @@ abstract class MixinObfuscationProcessor extends AbstractProcessor { @Override public SourceVersion getSupportedSourceVersion() { - try { - return SourceVersion.valueOf("RELEASE_8"); - } catch (IllegalArgumentException ex) { - // Java 8 not supported - } - - return super.getSupportedSourceVersion(); + return SourceVersion.latestSupported(); } @Override diff --git a/src/ap/java/org/spongepowered/tools/obfuscation/TargetMap.java b/src/ap/java/org/spongepowered/tools/obfuscation/TargetMap.java index 05c05df2..1cd2fbad 100644 --- a/src/ap/java/org/spongepowered/tools/obfuscation/TargetMap.java +++ b/src/ap/java/org/spongepowered/tools/obfuscation/TargetMap.java @@ -86,7 +86,7 @@ public final class TargetMap extends HashMap> * * @param mixin mixin to add targets for */ - public void registerTargets(AnnotatedMixin mixin) { + void registerTargets(AnnotatedMixin mixin) { this.registerTargets(mixin.getTargets(), mixin.getHandle()); } @@ -96,7 +96,7 @@ public final class TargetMap extends HashMap> * @param targets List of targets * @param mixin Mixin class */ - public void registerTargets(List targets, TypeHandle mixin) { + void registerTargets(List targets, TypeHandle mixin) { for (TypeHandle target : targets) { this.addMixin(target, mixin); } @@ -108,7 +108,7 @@ public final class TargetMap extends HashMap> * @param target Target class * @param mixin Mixin class */ - public void addMixin(TypeHandle target, TypeHandle mixin) { + void addMixin(TypeHandle target, TypeHandle mixin) { this.addMixin(target.getReference(), mixin.getReference()); } @@ -118,7 +118,7 @@ public final class TargetMap extends HashMap> * @param target Target class * @param mixin Mixin class */ - public void addMixin(String target, String mixin) { + void addMixin(String target, String mixin) { this.addMixin(new TypeReference(target), new TypeReference(mixin)); } @@ -128,7 +128,7 @@ public final class TargetMap extends HashMap> * @param target Target class * @param mixin Mixin class */ - public void addMixin(TypeReference target, TypeReference mixin) { + void addMixin(TypeReference target, TypeReference mixin) { Set mixins = this.getMixinsFor(target); mixins.add(mixin); } @@ -139,7 +139,7 @@ public final class TargetMap extends HashMap> * @param target Target class * @return Collection of mixins registered as targetting the specified class */ - public Collection getMixinsTargeting(TypeElement target) { + Collection getMixinsTargeting(TypeElement target) { return this.getMixinsTargeting(new TypeHandle(target)); } @@ -149,7 +149,7 @@ public final class TargetMap extends HashMap> * @param target Target class * @return Collection of mixins registered as targetting the specified class */ - public Collection getMixinsTargeting(TypeHandle target) { + Collection getMixinsTargeting(TypeHandle target) { return this.getMixinsTargeting(target.getReference()); } @@ -159,7 +159,7 @@ public final class TargetMap extends HashMap> * @param target Target class * @return Collection of mixins registered as targetting the specified class */ - public Collection getMixinsTargeting(TypeReference target) { + Collection getMixinsTargeting(TypeReference target) { return Collections.unmodifiableCollection(this.getMixinsFor(target)); } diff --git a/src/ap/java/org/spongepowered/tools/obfuscation/interfaces/IMixinValidator.java b/src/ap/java/org/spongepowered/tools/obfuscation/interfaces/IMixinValidator.java index b266c2cc..6a4b5424 100644 --- a/src/ap/java/org/spongepowered/tools/obfuscation/interfaces/IMixinValidator.java +++ b/src/ap/java/org/spongepowered/tools/obfuscation/interfaces/IMixinValidator.java @@ -57,4 +57,5 @@ public interface IMixinValidator { * @return False to halt processing of further validators */ public abstract boolean validate(ValidationPass pass, TypeElement mixin, AnnotationHandle annotation, Collection targets); + } diff --git a/src/launchwrapper/java/org/spongepowered/asm/launch/platform/MixinPlatformAgentFMLLegacy.java b/src/launchwrapper/java/org/spongepowered/asm/launch/platform/MixinPlatformAgentFMLLegacy.java index 56a34f45..bc557700 100644 --- a/src/launchwrapper/java/org/spongepowered/asm/launch/platform/MixinPlatformAgentFMLLegacy.java +++ b/src/launchwrapper/java/org/spongepowered/asm/launch/platform/MixinPlatformAgentFMLLegacy.java @@ -138,6 +138,7 @@ public class MixinPlatformAgentFMLLegacy extends MixinPlatformAgentAbstract impl */ private boolean initInjectionState; + @SuppressWarnings("deprecation") @Override public AcceptResult accept(MixinPlatformManager manager, IContainerHandle handle) { if (this.getCoreModManagerClass() == null) { @@ -521,6 +522,7 @@ public class MixinPlatformAgentFMLLegacy extends MixinPlatformAgentAbstract impl private final IConsumer delegate; + @SuppressWarnings("deprecation") MixinAppender(IConsumer delegate) { super("MixinLogWatcherAppender", null, null); this.delegate = delegate; diff --git a/src/launchwrapper/java/org/spongepowered/asm/service/mojang/LegacyTransformerHandle.java b/src/launchwrapper/java/org/spongepowered/asm/service/mojang/LegacyTransformerHandle.java index 519ccec3..d5213def 100644 --- a/src/launchwrapper/java/org/spongepowered/asm/service/mojang/LegacyTransformerHandle.java +++ b/src/launchwrapper/java/org/spongepowered/asm/service/mojang/LegacyTransformerHandle.java @@ -24,9 +24,11 @@ */ package org.spongepowered.asm.service.mojang; -import javax.annotation.Resource; +import java.lang.annotation.Annotation; +import org.spongepowered.asm.service.IClassProvider; import org.spongepowered.asm.service.ILegacyClassTransformer; +import org.spongepowered.asm.service.MixinService; import net.minecraft.launchwrapper.IClassTransformer; @@ -57,9 +59,16 @@ class LegacyTransformerHandle implements ILegacyClassTransformer { * @see org.spongepowered.asm.service.ILegacyClassTransformer * #isDelegationExcluded() */ + @SuppressWarnings("unchecked") @Override public boolean isDelegationExcluded() { - return this.transformer.getClass().getAnnotation(Resource.class) != null; + try { + IClassProvider classProvider = MixinService.getService().getClassProvider(); + Class clResource = (Class)classProvider.findClass("javax.annotation.Resource"); + return this.transformer.getClass().getAnnotation(clResource) != null; + } catch (ClassNotFoundException ex) { + return false; + } } /* (non-Javadoc) diff --git a/src/main/java/org/spongepowered/asm/launch/MixinBootstrap.java b/src/main/java/org/spongepowered/asm/launch/MixinBootstrap.java index 4f671910..fac2d0a0 100644 --- a/src/main/java/org/spongepowered/asm/launch/MixinBootstrap.java +++ b/src/main/java/org/spongepowered/asm/launch/MixinBootstrap.java @@ -66,7 +66,7 @@ public abstract class MixinBootstrap { /** * Subsystem version */ - public static final String VERSION = "0.8.3"; + public static final String VERSION = "0.8.4"; /** * Transformer factory diff --git a/src/main/java/org/spongepowered/asm/launch/platform/MainAttributes.java b/src/main/java/org/spongepowered/asm/launch/platform/MainAttributes.java index 17980cf7..1ccd5763 100644 --- a/src/main/java/org/spongepowered/asm/launch/platform/MainAttributes.java +++ b/src/main/java/org/spongepowered/asm/launch/platform/MainAttributes.java @@ -24,18 +24,25 @@ */ package org.spongepowered.asm.launch.platform; +import java.io.BufferedInputStream; import java.io.File; import java.io.IOException; import java.io.InputStream; import java.net.URI; +import java.nio.file.FileSystemNotFoundException; +import java.nio.file.InvalidPathException; +import java.nio.file.Path; +import java.nio.file.Paths; import java.util.HashMap; import java.util.Map; import java.util.jar.Attributes; +import java.util.jar.Attributes.Name; import java.util.jar.JarFile; import java.util.jar.Manifest; +import org.spongepowered.asm.util.JavaVersion; + import com.google.common.io.ByteSource; -import com.google.common.io.Files; /** * "Main" attribute cache for a URI container, mainly to avoid constantly @@ -54,8 +61,8 @@ public final class MainAttributes { this.attributes = new Attributes(); } - private MainAttributes(File jar) { - this.attributes = MainAttributes.getAttributes(jar); + private MainAttributes(URI codeSource) { + this.attributes = MainAttributes.getAttributes(codeSource); } /** @@ -72,20 +79,42 @@ public final class MainAttributes { return null; } - private static Attributes getAttributes(File codeSource) { + /** + * Retrieve the value of attribute with the specified name, or null if not + * present + * + * @param name attribute name + * @return attribute value or null if not present + */ + public final String get(Name name) { + if (this.attributes != null) { + return this.attributes.getValue(name); + } + return null; + } + + private static Attributes getAttributes(URI codeSource) { if (codeSource == null) { return null; } - if (codeSource.isFile()) { - Attributes attributes = MainAttributes.getJarAttributes(codeSource); - if (attributes != null) { - return attributes; + if ("file".equals(codeSource.getScheme())) { + File file = new File(codeSource); + + if (file.isFile()) { + Attributes attributes = MainAttributes.getJarAttributes(file); + if (attributes != null) { + return attributes; + } + } else if (file.isDirectory()) { + Attributes attributes = MainAttributes.getDirAttributes(file); + if (attributes != null) { + return attributes; + } } - } - - if (codeSource.isDirectory()) { - Attributes attributes = MainAttributes.getDirAttributes(codeSource); + } else if (JavaVersion.current() >= JavaVersion.JAVA_7) { + // Can try getting the resource using nio if we are on Java 7 or later + Attributes attributes = MainAttributes.getNioAttributes(codeSource); if (attributes != null) { return attributes; } @@ -119,7 +148,7 @@ public final class MainAttributes { private static Attributes getDirAttributes(File dir) { File manifestFile = new File(dir, JarFile.MANIFEST_NAME); if (manifestFile.isFile()) { - ByteSource source = Files.asByteSource(manifestFile); + ByteSource source = com.google.common.io.Files.asByteSource(manifestFile); InputStream inputStream = null; try { inputStream = source.openBufferedStream(); @@ -140,7 +169,35 @@ public final class MainAttributes { return null; } - + + private static Attributes getNioAttributes(URI uri) { + try { + Path manifestPath = Paths.get(uri).resolve(JarFile.MANIFEST_NAME); + BufferedInputStream inputStream = null; + try { + inputStream = new BufferedInputStream(java.nio.file.Files.newInputStream(manifestPath)); + Manifest manifest = new Manifest(inputStream); + return manifest.getMainAttributes(); + } catch (IOException ex) { + // be quiet checkstyle + } finally { + try { + if (inputStream != null) { + inputStream.close(); + } + } catch (IOException e) { + // ignore + } + } + } catch (FileSystemNotFoundException ex) { + // No FS available? + ex.printStackTrace(); + } catch (InvalidPathException ex) { + ex.printStackTrace(); + } + + return null; + } /** * Create a MainAttributes instance for the supplied jar file @@ -161,7 +218,7 @@ public final class MainAttributes { public static MainAttributes of(URI uri) { MainAttributes attributes = MainAttributes.instances.get(uri); if (attributes == null) { - attributes = new MainAttributes(new File(uri)); + attributes = new MainAttributes(uri); MainAttributes.instances.put(uri, attributes); } return attributes; diff --git a/src/main/java/org/spongepowered/asm/launch/platform/container/ContainerHandleURI.java b/src/main/java/org/spongepowered/asm/launch/platform/container/ContainerHandleURI.java index 8abb6194..40dd3ba1 100644 --- a/src/main/java/org/spongepowered/asm/launch/platform/container/ContainerHandleURI.java +++ b/src/main/java/org/spongepowered/asm/launch/platform/container/ContainerHandleURI.java @@ -42,11 +42,6 @@ public class ContainerHandleURI implements IContainerHandle { */ private final URI uri; - /** - * File containing this tweaker - */ - private final File file; - /** * "Main" manifest attributes from the container */ @@ -54,7 +49,6 @@ public class ContainerHandleURI implements IContainerHandle { public ContainerHandleURI(URI uri) { this.uri = uri; - this.file = this.uri != null ? new File(this.uri) : null; this.attributes = MainAttributes.of(uri); } @@ -68,8 +62,9 @@ public class ContainerHandleURI implements IContainerHandle { /** * Get the container file */ + @Deprecated public File getFile() { - return this.file; + return this.uri != null && "file".equals(this.uri.getScheme()) ? new File(this.uri) : null; } /* (non-Javadoc) diff --git a/src/main/java/org/spongepowered/asm/launch/platform/container/ContainerHandleVirtual.java b/src/main/java/org/spongepowered/asm/launch/platform/container/ContainerHandleVirtual.java index 3b624a1a..0e7129bc 100644 --- a/src/main/java/org/spongepowered/asm/launch/platform/container/ContainerHandleVirtual.java +++ b/src/main/java/org/spongepowered/asm/launch/platform/container/ContainerHandleVirtual.java @@ -62,6 +62,13 @@ public class ContainerHandleVirtual implements IContainerHandle { this.name = name; } + /** + * Get the name of this container + */ + public String getName() { + return this.name; + } + /** * Set a virtual attribute on this virtual container * diff --git a/src/main/java/org/spongepowered/asm/mixin/MixinEnvironment.java b/src/main/java/org/spongepowered/asm/mixin/MixinEnvironment.java index 0f5fe8c7..5af148cf 100644 --- a/src/main/java/org/spongepowered/asm/mixin/MixinEnvironment.java +++ b/src/main/java/org/spongepowered/asm/mixin/MixinEnvironment.java @@ -603,7 +603,7 @@ public final class MixinEnvironment implements ITokenProvider { @Override boolean isSupported() { - return JavaVersion.current() >= 1.7; + return JavaVersion.current() >= JavaVersion.JAVA_7; } }, @@ -615,7 +615,7 @@ public final class MixinEnvironment implements ITokenProvider { @Override boolean isSupported() { - return JavaVersion.current() >= 1.8; + return JavaVersion.current() >= JavaVersion.JAVA_8; } }, @@ -628,7 +628,7 @@ public final class MixinEnvironment implements ITokenProvider { @Override boolean isSupported() { - return JavaVersion.current() >= 9.0; + return JavaVersion.current() >= JavaVersion.JAVA_8 && ASM.isAtLeastVersion(6); } }, @@ -641,7 +641,7 @@ public final class MixinEnvironment implements ITokenProvider { @Override boolean isSupported() { - return JavaVersion.current() >= 10.0; + return JavaVersion.current() >= JavaVersion.JAVA_10 && ASM.isAtLeastVersion(6, 1); } }, @@ -654,7 +654,105 @@ public final class MixinEnvironment implements ITokenProvider { @Override boolean isSupported() { - return JavaVersion.current() >= 11.0; + return JavaVersion.current() >= JavaVersion.JAVA_11 && ASM.isAtLeastVersion(7); + } + + }, + + /** + * Java 12 or above is required + */ + JAVA_12(12, Opcodes.V12, LanguageFeatures.METHODS_IN_INTERFACES | LanguageFeatures.PRIVATE_SYNTHETIC_METHODS_IN_INTERFACES + | LanguageFeatures.PRIVATE_METHODS_IN_INTERFACES | LanguageFeatures.NESTING | LanguageFeatures.DYNAMIC_CONSTANTS) { + + @Override + boolean isSupported() { + return JavaVersion.current() >= JavaVersion.JAVA_12 && ASM.isAtLeastVersion(7); + } + + }, + + /** + * Java 13 or above is required + */ + JAVA_13(13, Opcodes.V13, LanguageFeatures.METHODS_IN_INTERFACES | LanguageFeatures.PRIVATE_SYNTHETIC_METHODS_IN_INTERFACES + | LanguageFeatures.PRIVATE_METHODS_IN_INTERFACES | LanguageFeatures.NESTING | LanguageFeatures.DYNAMIC_CONSTANTS) { + + @Override + boolean isSupported() { + return JavaVersion.current() >= JavaVersion.JAVA_13 && ASM.isAtLeastVersion(7); + } + + }, + + /** + * Java 14 or above is required. Records are a preview feature in this + * release. + */ + JAVA_14(14, Opcodes.V14, LanguageFeatures.METHODS_IN_INTERFACES | LanguageFeatures.PRIVATE_SYNTHETIC_METHODS_IN_INTERFACES + | LanguageFeatures.PRIVATE_METHODS_IN_INTERFACES | LanguageFeatures.NESTING | LanguageFeatures.DYNAMIC_CONSTANTS + | LanguageFeatures.RECORDS) { + + @Override + boolean isSupported() { + return JavaVersion.current() >= JavaVersion.JAVA_14 && ASM.isAtLeastVersion(8); + } + + }, + + /** + * Java 15 or above is required. Records and sealed classes are preview + * features in this release. + */ + JAVA_15(15, Opcodes.V15, LanguageFeatures.METHODS_IN_INTERFACES | LanguageFeatures.PRIVATE_SYNTHETIC_METHODS_IN_INTERFACES + | LanguageFeatures.PRIVATE_METHODS_IN_INTERFACES | LanguageFeatures.NESTING | LanguageFeatures.DYNAMIC_CONSTANTS + | LanguageFeatures.RECORDS | LanguageFeatures.SEALED_CLASSES) { + + @Override + boolean isSupported() { + return JavaVersion.current() >= JavaVersion.JAVA_15 && ASM.isAtLeastVersion(9); + } + + }, + + /** + * Java 16 or above is required + */ + JAVA_16(16, Opcodes.V16, LanguageFeatures.METHODS_IN_INTERFACES | LanguageFeatures.PRIVATE_SYNTHETIC_METHODS_IN_INTERFACES + | LanguageFeatures.PRIVATE_METHODS_IN_INTERFACES | LanguageFeatures.NESTING | LanguageFeatures.DYNAMIC_CONSTANTS + | LanguageFeatures.RECORDS | LanguageFeatures.SEALED_CLASSES) { + + @Override + boolean isSupported() { + return JavaVersion.current() >= JavaVersion.JAVA_16 && ASM.isAtLeastVersion(9); + } + + }, + + /** + * Java 17 or above is required + */ + JAVA_17(17, Opcodes.V17, LanguageFeatures.METHODS_IN_INTERFACES | LanguageFeatures.PRIVATE_SYNTHETIC_METHODS_IN_INTERFACES + | LanguageFeatures.PRIVATE_METHODS_IN_INTERFACES | LanguageFeatures.NESTING | LanguageFeatures.DYNAMIC_CONSTANTS + | LanguageFeatures.RECORDS | LanguageFeatures.SEALED_CLASSES) { + + @Override + boolean isSupported() { + return JavaVersion.current() >= JavaVersion.JAVA_17 && ASM.isAtLeastVersion(9, 1); + } + + }, + + /** + * Java 18 or above is required + */ + JAVA_18(18, Opcodes.V18, LanguageFeatures.METHODS_IN_INTERFACES | LanguageFeatures.PRIVATE_SYNTHETIC_METHODS_IN_INTERFACES + | LanguageFeatures.PRIVATE_METHODS_IN_INTERFACES | LanguageFeatures.NESTING | LanguageFeatures.DYNAMIC_CONSTANTS + | LanguageFeatures.RECORDS | LanguageFeatures.SEALED_CLASSES) { + + @Override + boolean isSupported() { + return JavaVersion.current() >= JavaVersion.JAVA_18 && ASM.isAtLeastVersion(9, 2); } }, @@ -762,7 +860,7 @@ public final class MixinEnvironment implements ITokenProvider { * PR #500 which demonstrates that the nature of compatibility levels * in mixin are not understood that well.

*/ - public static CompatibilityLevel MAX_SUPPORTED = CompatibilityLevel.JAVA_11; + public static CompatibilityLevel MAX_SUPPORTED = CompatibilityLevel.JAVA_13; private final int ver; @@ -1114,7 +1212,7 @@ public final class MixinEnvironment implements ITokenProvider { printer.kv("Internal Version", version); printer.kv("Java Version", "%s (supports compatibility %s)", JavaVersion.current(), CompatibilityLevel.getSupportedVersions()); printer.kv("Default Compatibility Level", MixinEnvironment.getCompatibilityLevel()); - printer.kv("Detected ASM API Version", ASM.getApiVersionString()); + printer.kv("Detected ASM Version", ASM.getVersionString()); printer.kv("Detected ASM Supports Java", ASM.getClassVersionString()).hr(); printer.kv("Service Name", serviceName); printer.kv("Mixin Service Class", this.service.getClass().getName()); @@ -1525,7 +1623,11 @@ public final class MixinEnvironment implements ITokenProvider { return MixinEnvironment.compatibility; } - private static CompatibilityLevel getMinCompatibilityLevel() { + /** + * Get the minimum (default) compatibility level supported by the current + * service + */ + public static CompatibilityLevel getMinCompatibilityLevel() { CompatibilityLevel minLevel = MixinService.getService().getMinCompatibilityLevel(); return minLevel == null ? CompatibilityLevel.DEFAULT : minLevel; } @@ -1547,7 +1649,10 @@ public final class MixinEnvironment implements ITokenProvider { CompatibilityLevel currentLevel = MixinEnvironment.getCompatibilityLevel(); if (level != currentLevel && level.isAtLeast(currentLevel)) { if (!level.isSupported()) { - throw new IllegalArgumentException("The requested compatibility level " + level + " could not be set. Level is not supported"); + throw new IllegalArgumentException(String.format( + "The requested compatibility level %s could not be set. Level is not supported by the active JRE or ASM version (Java %s, %s)", + level, JavaVersion.current(), ASM.getVersionString() + )); } IMixinService service = MixinService.getService(); diff --git a/src/main/java/org/spongepowered/asm/mixin/extensibility/IActivityContext.java b/src/main/java/org/spongepowered/asm/mixin/extensibility/IActivityContext.java new file mode 100644 index 00000000..1fa1219b --- /dev/null +++ b/src/main/java/org/spongepowered/asm/mixin/extensibility/IActivityContext.java @@ -0,0 +1,101 @@ +/* + * This file is part of Mixin, licensed under the MIT License (MIT). + * + * Copyright (c) SpongePowered + * Copyright (c) contributors + * + * 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 org.spongepowered.asm.mixin.extensibility; + +public interface IActivityContext { + + public interface IActivity { + + /** + * End this activity (and any descendants) and begin the next activity + * using the same activity handle + * + * @param descriptionFormat New activity description format + * @param args New activity description args + */ + void next(String descriptionFormat, Object... args); + + /** + * End this activity (and any descendants) and begin the next activity + * using the same activity handle + * + * @param description New activity description + */ + void next(String description); + + /** + * End this activity and remove it (and any descendants) + */ + void end(); + + /** + * Append text to the activity description + * + * @param textFormat Format for text to append + * @param args Format args + */ + void append(String textFormat, Object...args); + + /** + * Append text to the activity description + * + * @param text Text to append + */ + void append(String text); + + } + + /** + * Convert this activity stack to a string representation using the + * specified glue string + * + * @param glue glue string + * @return string representation of this activity stack + */ + public abstract String toString(String glue); + + /** + * Begin a new activity (push it onto this activity stack) + * + * @param descriptionFormat Activity description format + * @param args format args + * @return new activity handle + */ + public abstract IActivity begin(String descriptionFormat, Object... args); + + /** + * Begin a new activity (push it onto this activity stack) + * + * @param description Activity description + * @return new activity handle + */ + public abstract IActivity begin(String description); + + /** + * Clear the activity stack + */ + public abstract void clear(); + +} diff --git a/src/main/java/org/spongepowered/asm/mixin/extensibility/IMixinConfig.java b/src/main/java/org/spongepowered/asm/mixin/extensibility/IMixinConfig.java index 0e39783c..611d6371 100644 --- a/src/main/java/org/spongepowered/asm/mixin/extensibility/IMixinConfig.java +++ b/src/main/java/org/spongepowered/asm/mixin/extensibility/IMixinConfig.java @@ -88,5 +88,33 @@ public interface IMixinConfig { * @return target classes of mixins in this config */ public abstract Set getTargets(); + + /** + * Decorate this config with arbitrary metadata for debugging or + * compatibility purposes + * + * @param key meta key + * @param value meta value + * @param value type + * @throws IllegalArgumentException if the specified key exists already + */ + public abstract void decorate(String key, V value); + + /** + * Get whether this node is decorated with the specified key + * + * @param key meta key + * @return true if the specified decoration exists + */ + public abstract boolean hasDecoration(String key); + + /** + * Get the specified decoration + * + * @param key meta key + * @param value type + * @return decoration value or null if absent + */ + public abstract V getDecoration(String key); } diff --git a/src/main/java/org/spongepowered/asm/mixin/injection/ModifyArg.java b/src/main/java/org/spongepowered/asm/mixin/injection/ModifyArg.java index 048b8238..8d5fcc76 100644 --- a/src/main/java/org/spongepowered/asm/mixin/injection/ModifyArg.java +++ b/src/main/java/org/spongepowered/asm/mixin/injection/ModifyArg.java @@ -42,17 +42,17 @@ import org.spongepowered.asm.util.ConstraintParser.Constraint; * method invocation within the target method(s). To affect multiple arguments * of an invocation all at once, use {@link ModifyArgs} instead. * - *

Use this injector when a method contains an method invocation and you wish - * to change a single value being passed to that method. If you need to - * alter an argument received by a target method, use {@link - * ModifyVariable} instead.

+ *

Use this injector when a (target) method contains an method invocation + * (the subject) and you wish to change a single value being passed to + * that subject method. If you need to alter an argument received by a + * target method, use {@link ModifyVariable} instead.

* *

Consider the following method:

* *
private void targetMethod() {
  *    Entity someEntity = this.obtainEntity();
  *    float x = 1.0F, y = 3.0F, z = 0.1F;
- *    someEntity.setLocation(x, y, z, true);
+ *    someEntity.setLocation(x, y, z, true); // subject
  *}
*
* @@ -71,7 +71,7 @@ import org.spongepowered.asm.util.ConstraintParser.Constraint; *

The callback consumes the original value of y and returns the * adjusted value.

* - *

@ModifyArg can also consume all of the target method's + *

@ModifyArg can also consume all of the subject method's * arguments if required, to provide additional context for the callback. In * this case the arguments of the callback should match the target method:

* @@ -80,6 +80,9 @@ import org.spongepowered.asm.util.ConstraintParser.Constraint; * private float adjustYCoord(float x, float y, float z, boolean interpolate) { *
    return (x == 0 && y == 0) ? 0 : y;
* } + * + *

Note that @ModifyArg cannot capture the arguments + * of the target method like some other injectors can */ @Target({ ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) diff --git a/src/main/java/org/spongepowered/asm/mixin/injection/ModifyArgs.java b/src/main/java/org/spongepowered/asm/mixin/injection/ModifyArgs.java index bb702003..2430d835 100644 --- a/src/main/java/org/spongepowered/asm/mixin/injection/ModifyArgs.java +++ b/src/main/java/org/spongepowered/asm/mixin/injection/ModifyArgs.java @@ -49,7 +49,8 @@ import org.spongepowered.asm.util.ConstraintParser.Constraint; *

This injector works by creating an argument bundle in the form of * {@link Args} which is passed to your handler method. You can manipulate the * method arguments via the bundle in your handler method. The bundle is then - * unpacked and the original method is called with the modified arguments.

+ * unpacked and the original subject method is called with the modified + * arguments.

* *

Since the argument bundle is created for every invocation of the target * method, and primitive types must undergo boxing and unboxing, this injector @@ -66,7 +67,7 @@ import org.spongepowered.asm.util.ConstraintParser.Constraint; * * *

Methods decorated with this injector should return void and - * return either:

+ * consume either:

* *
    *
  • A single argument of type {@link Args}
  • diff --git a/src/main/java/org/spongepowered/asm/mixin/injection/callback/CallbackInjector.java b/src/main/java/org/spongepowered/asm/mixin/injection/callback/CallbackInjector.java index 79188adf..3f060bdf 100644 --- a/src/main/java/org/spongepowered/asm/mixin/injection/callback/CallbackInjector.java +++ b/src/main/java/org/spongepowered/asm/mixin/injection/callback/CallbackInjector.java @@ -454,7 +454,7 @@ public class CallbackInjector extends Injector { @Override protected void preInject(Target target, InjectionNode node) { - if (this.localCapture.isCaptureLocals() || this.localCapture.isPrintLocals()) { + if ((this.localCapture.isCaptureLocals() || this.localCapture.isPrintLocals()) && !node.hasDecoration(CallbackInjector.LOCALS_KEY)) { LocalVariableNode[] locals = Locals.getLocalsAt(this.classNode, target.method, node.getCurrentTarget()); for (int j = 0; j < locals.length; j++) { if (locals[j] != null && locals[j].desc != null && locals[j].desc.startsWith("Lorg/spongepowered/asm/mixin/injection/callback/")) { diff --git a/src/main/java/org/spongepowered/asm/mixin/injection/code/InsnListReadOnly.java b/src/main/java/org/spongepowered/asm/mixin/injection/code/InsnListReadOnly.java index 70c86574..f1e647ef 100644 --- a/src/main/java/org/spongepowered/asm/mixin/injection/code/InsnListReadOnly.java +++ b/src/main/java/org/spongepowered/asm/mixin/injection/code/InsnListReadOnly.java @@ -34,7 +34,7 @@ import org.objectweb.asm.tree.InsnList; * instances so that custom InjectionPoint implementations cannot modify the * insn list whilst inspecting it. */ -class InsnListReadOnly extends InsnList { +public class InsnListReadOnly extends InsnList { private InsnList insnList; diff --git a/src/main/java/org/spongepowered/asm/mixin/injection/modify/BeforeLoadLocal.java b/src/main/java/org/spongepowered/asm/mixin/injection/modify/BeforeLoadLocal.java index 609fb55c..c9f81688 100644 --- a/src/main/java/org/spongepowered/asm/mixin/injection/modify/BeforeLoadLocal.java +++ b/src/main/java/org/spongepowered/asm/mixin/injection/modify/BeforeLoadLocal.java @@ -131,8 +131,8 @@ public class BeforeLoadLocal extends LocalVariableInjectionPoint { this.varNode = node; } - void check(Target target, Collection nodes, AbstractInsnNode insn) { - Context context = new Context(BeforeLoadLocal.this.returnType, BeforeLoadLocal.this.discriminator.isArgsOnly(), target, insn); + void check(InjectionInfo info, Target target, Collection nodes, AbstractInsnNode insn) { + Context context = new Context(info, BeforeLoadLocal.this.returnType, BeforeLoadLocal.this.discriminator.isArgsOnly(), target, insn); int local = SearchState.INVALID_IMPLICIT; try { @@ -207,13 +207,13 @@ public class BeforeLoadLocal extends LocalVariableInjectionPoint { while (iter.hasNext()) { AbstractInsnNode insn = iter.next(); if (state.isPendingCheck()) { - state.check(target, nodes, insn); + state.check(info, target, nodes, insn); } else if (insn instanceof VarInsnNode && insn.getOpcode() == this.opcode && (this.ordinal == -1 || !state.success())) { state.register((VarInsnNode)insn); if (this.opcodeAfter) { state.setPendingCheck(); } else { - state.check(target, nodes, insn); + state.check(info, target, nodes, insn); } } } diff --git a/src/main/java/org/spongepowered/asm/mixin/injection/modify/LocalVariableDiscriminator.java b/src/main/java/org/spongepowered/asm/mixin/injection/modify/LocalVariableDiscriminator.java index 544e5184..a084e302 100644 --- a/src/main/java/org/spongepowered/asm/mixin/injection/modify/LocalVariableDiscriminator.java +++ b/src/main/java/org/spongepowered/asm/mixin/injection/modify/LocalVariableDiscriminator.java @@ -36,6 +36,7 @@ import org.objectweb.asm.tree.AbstractInsnNode; import org.objectweb.asm.tree.AnnotationNode; import org.objectweb.asm.tree.LocalVariableNode; import org.spongepowered.asm.mixin.injection.modify.LocalVariableDiscriminator.Context.Local; +import org.spongepowered.asm.mixin.injection.struct.InjectionInfo; import org.spongepowered.asm.mixin.injection.struct.Target; import org.spongepowered.asm.util.Bytecode; import org.spongepowered.asm.util.Annotations; @@ -65,17 +66,17 @@ public class LocalVariableDiscriminator { /** * Ordinal value of this local variable type */ - int ord = 0; + private int ord = -1; /** * Local variable name */ - String name; + final String name; /** * Local variable type */ - Type type; + final Type type; public Local(String name, Type type) { this.name = name; @@ -87,8 +88,24 @@ public class LocalVariableDiscriminator { return String.format("Local[ordinal=%d, name=%s, type=%s]", this.ord, this.name, this.type); } + void setOrdinal(int ordinal) { + if (this.ord > -1 && this.ord != ordinal) { + throw new IllegalStateException("Attempted to reset ordinal for computed local"); + } + this.ord = ordinal; + } + + int getOrdinal() { + return this.ord; + } + } + /** + * Injection info + */ + final InjectionInfo info; + /** * Target method for this context */ @@ -121,7 +138,8 @@ public class LocalVariableDiscriminator { */ private final boolean isStatic; - public Context(Type returnType, boolean argsOnly, Target target, AbstractInsnNode node) { + public Context(InjectionInfo info, Type returnType, boolean argsOnly, Target target, AbstractInsnNode node) { + this.info = info; this.isStatic = Bytecode.isStatic(target.method); this.returnType = returnType; this.target = target; @@ -166,7 +184,7 @@ public class LocalVariableDiscriminator { if (this.locals[l] != null) { ordinal = ordinalMap.get(this.locals[l].type); ordinalMap.put(this.locals[l].type, ordinal = Integer.valueOf(ordinal == null ? 0 : ordinal.intValue() + 1)); - this.locals[l].ord = ordinal.intValue(); + this.locals[l].setOrdinal(ordinal.intValue()); } } } @@ -189,7 +207,7 @@ public class LocalVariableDiscriminator { if (local != null) { Type localType = local.type; String localName = local.name; - int ordinal = local.ord; + int ordinal = local.getOrdinal(); String candidate = this.returnType.equals(localType) ? "YES" : "-"; printer.add("[%3d] [%3d] %30s %-50s %s", l, ordinal, SignaturePrinter.getTypeName(localType, false), localName, candidate); } else if (l > 0) { @@ -366,7 +384,7 @@ public class LocalVariableDiscriminator { continue; } if (this.ordinal > -1) { - if (this.ordinal == local.ord) { + if (this.ordinal == local.getOrdinal()) { return index; } continue; diff --git a/src/main/java/org/spongepowered/asm/mixin/injection/modify/ModifyVariableInjector.java b/src/main/java/org/spongepowered/asm/mixin/injection/modify/ModifyVariableInjector.java index 147d9076..a517814d 100644 --- a/src/main/java/org/spongepowered/asm/mixin/injection/modify/ModifyVariableInjector.java +++ b/src/main/java/org/spongepowered/asm/mixin/injection/modify/ModifyVariableInjector.java @@ -67,8 +67,8 @@ public class ModifyVariableInjector extends Injector { */ final InsnList insns = new InsnList(); - public Context(Type returnType, boolean argsOnly, Target target, AbstractInsnNode node) { - super(returnType, argsOnly, target, node); + public Context(InjectionInfo info, Type returnType, boolean argsOnly, Target target, AbstractInsnNode node) { + super(info, returnType, argsOnly, target, node); } } @@ -93,11 +93,6 @@ public class ModifyVariableInjector extends Injector { abstract boolean find(InjectionInfo info, InsnList insns, Collection nodes, Target target); } - - /** - * Decorator key for Context decoration - */ - private static final String LOCALS_CONTEXT_KEY = "localcontext"; /** * True to consider only method args @@ -142,10 +137,27 @@ public class ModifyVariableInjector extends Injector { } } + /** + * Generate a key which uniquely identifies the combination of return type, + * frame type and target injection node so that injectors targetting the + * same instruction still get unique contexts. + * + * @param target Target method + * @param node Target node + * @return Key for storing/retrieving the injector context decoration + */ + protected String getTargetNodeKey(Target target, InjectionNode node) { + return String.format("localcontext(%s,%s,#%s)", this.returnType, this.discriminator.isArgsOnly() ? "argsOnly" : "fullFrame", node.getId()); + } + @Override protected void preInject(Target target, InjectionNode node) { - Context context = new Context(this.returnType, this.discriminator.isArgsOnly(), target, node.getCurrentTarget()); - node.decorate(ModifyVariableInjector.LOCALS_CONTEXT_KEY, context); + String key = this.getTargetNodeKey(target, node); + if (node.hasDecoration(key)) { + return; // already have a suitable context + } + Context context = new Context(this.info, this.returnType, this.discriminator.isArgsOnly(), target, node.getCurrentTarget()); + node.decorate(key, context); } /** @@ -157,13 +169,22 @@ public class ModifyVariableInjector extends Injector { throw new InvalidInjectionException(this.info, "Variable modifier target for " + this + " was removed by another injector"); } - Context context = node.getDecoration(ModifyVariableInjector.LOCALS_CONTEXT_KEY); + Context context = node.getDecoration(this.getTargetNodeKey(target, node)); if (context == null) { throw new InjectionError(String.format( "%s injector target is missing CONTEXT decoration for %s. PreInjection failure or illegal internal state change", this.annotationType, this.info)); } + // If the context is being reused (because two identical injectors are targetting this node) + // then the insns SHOULD have been drained by the previous insertBefore. If the list hasn't + // been cleared for some reason then something probably went wrong during the previous inject + if (context.insns.size() > 0) { + throw new InjectionError(String.format( + "%s injector target has contaminated CONTEXT decoration for %s. Check for previous errors.", + this.annotationType, this.info)); + } + if (this.discriminator.printLVT()) { this.printLocals(target, context); } diff --git a/src/main/java/org/spongepowered/asm/mixin/injection/selectors/dynamic/DescriptorResolver.java b/src/main/java/org/spongepowered/asm/mixin/injection/selectors/dynamic/DescriptorResolver.java index cd8ff753..1a6f6f60 100644 --- a/src/main/java/org/spongepowered/asm/mixin/injection/selectors/dynamic/DescriptorResolver.java +++ b/src/main/java/org/spongepowered/asm/mixin/injection/selectors/dynamic/DescriptorResolver.java @@ -265,7 +265,7 @@ public final class DescriptorResolver { } public static IResolvedDescriptor resolve(IAnnotationHandle desc, ISelectorContext context) { - return new Descriptor(Collections.emptySet(), desc, context); + return new Descriptor(Collections.emptySet(), desc, context); } /** diff --git a/src/main/java/org/spongepowered/asm/mixin/injection/throwables/InvalidInjectionException.java b/src/main/java/org/spongepowered/asm/mixin/injection/throwables/InvalidInjectionException.java index 5131e261..6ec84bff 100644 --- a/src/main/java/org/spongepowered/asm/mixin/injection/throwables/InvalidInjectionException.java +++ b/src/main/java/org/spongepowered/asm/mixin/injection/throwables/InvalidInjectionException.java @@ -24,9 +24,9 @@ */ package org.spongepowered.asm.mixin.injection.throwables; -import org.spongepowered.asm.mixin.injection.struct.InjectionInfo; +import org.spongepowered.asm.mixin.extensibility.IActivityContext; +import org.spongepowered.asm.mixin.injection.selectors.ISelectorContext; import org.spongepowered.asm.mixin.refmap.IMixinContext; -import org.spongepowered.asm.mixin.transformer.ActivityStack; import org.spongepowered.asm.mixin.transformer.throwables.InvalidMixinException; /** @@ -37,70 +37,70 @@ public class InvalidInjectionException extends InvalidMixinException { private static final long serialVersionUID = 2L; - private final InjectionInfo info; + private final ISelectorContext selectorContext; public InvalidInjectionException(IMixinContext context, String message) { super(context, message); - this.info = null; + this.selectorContext = null; } - public InvalidInjectionException(IMixinContext context, String message, ActivityStack activityContext) { + public InvalidInjectionException(IMixinContext context, String message, IActivityContext activityContext) { super(context, message, activityContext); - this.info = null; + this.selectorContext = null; } - public InvalidInjectionException(InjectionInfo info, String message) { - super(info.getMixin(), message); - this.info = info; + public InvalidInjectionException(ISelectorContext selectorContext, String message) { + super(selectorContext.getMixin(), message); + this.selectorContext = selectorContext; } - public InvalidInjectionException(InjectionInfo info, String message, ActivityStack activityContext) { - super(info.getMixin(), message, activityContext); - this.info = info; + public InvalidInjectionException(ISelectorContext selectorContext, String message, IActivityContext activityContext) { + super(selectorContext.getMixin(), message, activityContext); + this.selectorContext = selectorContext; } public InvalidInjectionException(IMixinContext context, Throwable cause) { super(context, cause); - this.info = null; + this.selectorContext = null; } - public InvalidInjectionException(IMixinContext context, Throwable cause, ActivityStack activityContext) { + public InvalidInjectionException(IMixinContext context, Throwable cause, IActivityContext activityContext) { super(context, cause, activityContext); - this.info = null; + this.selectorContext = null; } - public InvalidInjectionException(InjectionInfo info, Throwable cause) { - super(info.getMixin(), cause); - this.info = info; + public InvalidInjectionException(ISelectorContext selectorContext, Throwable cause) { + super(selectorContext.getMixin(), cause); + this.selectorContext = selectorContext; } - public InvalidInjectionException(InjectionInfo info, Throwable cause, ActivityStack activityContext) { - super(info.getMixin(), cause, activityContext); - this.info = info; + public InvalidInjectionException(ISelectorContext selectorContext, Throwable cause, IActivityContext activityContext) { + super(selectorContext.getMixin(), cause, activityContext); + this.selectorContext = selectorContext; } public InvalidInjectionException(IMixinContext context, String message, Throwable cause) { super(context, message, cause); - this.info = null; + this.selectorContext = null; } - public InvalidInjectionException(IMixinContext context, String message, Throwable cause, ActivityStack activityContext) { + public InvalidInjectionException(IMixinContext context, String message, Throwable cause, IActivityContext activityContext) { super(context, message, cause, activityContext); - this.info = null; + this.selectorContext = null; } - public InvalidInjectionException(InjectionInfo info, String message, Throwable cause) { - super(info.getMixin(), message, cause); - this.info = info; + public InvalidInjectionException(ISelectorContext selectorContext, String message, Throwable cause) { + super(selectorContext.getMixin(), message, cause); + this.selectorContext = selectorContext; } - public InvalidInjectionException(InjectionInfo info, String message, Throwable cause, ActivityStack activityContext) { - super(info.getMixin(), message, cause, activityContext); - this.info = info; + public InvalidInjectionException(ISelectorContext selectorContext, String message, Throwable cause, IActivityContext activityContext) { + super(selectorContext.getMixin(), message, cause, activityContext); + this.selectorContext = selectorContext; } - public InjectionInfo getInjectionInfo() { - return this.info; + public ISelectorContext getContext() { + return this.selectorContext; } } diff --git a/src/main/java/org/spongepowered/asm/mixin/throwables/ClassMetadataNotFoundException.java b/src/main/java/org/spongepowered/asm/mixin/throwables/ClassMetadataNotFoundException.java index c9eaf10a..3296d708 100644 --- a/src/main/java/org/spongepowered/asm/mixin/throwables/ClassMetadataNotFoundException.java +++ b/src/main/java/org/spongepowered/asm/mixin/throwables/ClassMetadataNotFoundException.java @@ -24,7 +24,7 @@ */ package org.spongepowered.asm.mixin.throwables; -import org.spongepowered.asm.mixin.transformer.ActivityStack; +import org.spongepowered.asm.mixin.extensibility.IActivityContext; import org.spongepowered.asm.mixin.transformer.ClassInfo; /** @@ -42,7 +42,7 @@ public class ClassMetadataNotFoundException extends MixinException { super(message); } - public ClassMetadataNotFoundException(String message, ActivityStack context) { + public ClassMetadataNotFoundException(String message, IActivityContext context) { super(message, context); } @@ -50,7 +50,7 @@ public class ClassMetadataNotFoundException extends MixinException { super(cause); } - public ClassMetadataNotFoundException(Throwable cause, ActivityStack context) { + public ClassMetadataNotFoundException(Throwable cause, IActivityContext context) { super(cause, context); } @@ -58,7 +58,7 @@ public class ClassMetadataNotFoundException extends MixinException { super(message, cause); } - public ClassMetadataNotFoundException(String message, Throwable cause, ActivityStack context) { + public ClassMetadataNotFoundException(String message, Throwable cause, IActivityContext context) { super(message, cause, context); } diff --git a/src/main/java/org/spongepowered/asm/mixin/throwables/MixinException.java b/src/main/java/org/spongepowered/asm/mixin/throwables/MixinException.java index 085bb4f3..46ced9ea 100644 --- a/src/main/java/org/spongepowered/asm/mixin/throwables/MixinException.java +++ b/src/main/java/org/spongepowered/asm/mixin/throwables/MixinException.java @@ -24,6 +24,7 @@ */ package org.spongepowered.asm.mixin.throwables; +import org.spongepowered.asm.mixin.extensibility.IActivityContext; import org.spongepowered.asm.mixin.transformer.ActivityStack; /** @@ -39,7 +40,7 @@ public class MixinException extends RuntimeException { super(message); } - public MixinException(String message, ActivityStack context) { + public MixinException(String message, IActivityContext context) { super(message); this.activityDescriptor = context != null ? context.toString() : null; } @@ -48,7 +49,7 @@ public class MixinException extends RuntimeException { super(cause); } - public MixinException(Throwable cause, ActivityStack context) { + public MixinException(Throwable cause, IActivityContext context) { super(cause); this.activityDescriptor = context != null ? context.toString() : null; } @@ -57,7 +58,7 @@ public class MixinException extends RuntimeException { super(message, cause); } - public MixinException(String message, Throwable cause, ActivityStack context) { + public MixinException(String message, Throwable cause, IActivityContext context) { super(message, cause); this.activityDescriptor = context != null ? context.toString() : null; } @@ -67,7 +68,7 @@ public class MixinException extends RuntimeException { * * @param upstreamContext Upstream activity stack to decorate */ - public void prepend(ActivityStack upstreamContext) { + public void prepend(IActivityContext upstreamContext) { String strContext = upstreamContext.toString(); this.activityDescriptor = this.activityDescriptor != null ? strContext + ActivityStack.GLUE_STRING + this.activityDescriptor : ActivityStack.GLUE_STRING + strContext; diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/ActivityStack.java b/src/main/java/org/spongepowered/asm/mixin/transformer/ActivityStack.java index 4239b66a..f2418f93 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/ActivityStack.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/ActivityStack.java @@ -24,17 +24,19 @@ */ package org.spongepowered.asm.mixin.transformer; +import org.spongepowered.asm.mixin.extensibility.IActivityContext; + /** * Tracker for processors which want to express their activity stack on crash in * a user-readable way. */ -public class ActivityStack { +public class ActivityStack implements IActivityContext { /** * An activity node in the activity stack (yes it's actually a doubly-linked * list). */ - public class Activity { + public class Activity implements IActivity { /** * Description of this activity @@ -56,6 +58,7 @@ public class ActivityStack { * * @param text Text to append */ + @Override public void append(String text) { this.description = this.description != null ? this.description + text : text; } @@ -66,6 +69,7 @@ public class ActivityStack { * @param textFormat Format for text to append * @param args Format args */ + @Override public void append(String textFormat, Object...args) { this.append(String.format(textFormat, args)); } @@ -73,6 +77,7 @@ public class ActivityStack { /** * End this activity and remove it (and any descendants) */ + @Override public void end() { // Cannot end head or ended activity if (this.last != null) { @@ -87,6 +92,7 @@ public class ActivityStack { * * @param description New activity description */ + @Override public void next(String description) { if (this.next != null) { this.next.end(); @@ -101,6 +107,7 @@ public class ActivityStack { * @param descriptionFormat New activity description format * @param args New activity description args */ + @Override public void next(String descriptionFormat, Object... args) { if (descriptionFormat == null) { descriptionFormat = "null"; @@ -133,6 +140,7 @@ public class ActivityStack { /** * Clear the activity stack */ + @Override public void clear() { this.tail = this.head; this.head.next = null; @@ -144,7 +152,8 @@ public class ActivityStack { * @param description Activity description * @return new activity handle */ - public Activity begin(String description) { + @Override + public IActivity begin(String description) { return this.tail = new Activity(this.tail, description != null ? description : "null"); } @@ -155,7 +164,8 @@ public class ActivityStack { * @param args format args * @return new activity handle */ - public Activity begin(String descriptionFormat, Object... args) { + @Override + public IActivity begin(String descriptionFormat, Object... args) { if (descriptionFormat == null) { descriptionFormat = "null"; } @@ -182,6 +192,7 @@ public class ActivityStack { * @param glue glue string * @return string representation of this activity stack */ + @Override public String toString(String glue) { if (this.head.description == null && this.head.next == null) { return "Unknown"; diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/ClassInfo.java b/src/main/java/org/spongepowered/asm/mixin/transformer/ClassInfo.java index 6c771cf6..c1442755 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/ClassInfo.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/ClassInfo.java @@ -29,6 +29,7 @@ import java.util.Collections; import java.util.HashMap; import java.util.HashSet; import java.util.Iterator; +import java.util.LinkedHashSet; import java.util.List; import java.util.Map; import java.util.Set; @@ -42,6 +43,7 @@ import org.objectweb.asm.tree.ClassNode; import org.objectweb.asm.tree.FieldInsnNode; import org.objectweb.asm.tree.FieldNode; import org.objectweb.asm.tree.FrameNode; +import org.objectweb.asm.tree.InnerClassNode; import org.objectweb.asm.tree.MethodInsnNode; import org.objectweb.asm.tree.MethodNode; import org.spongepowered.asm.mixin.Final; @@ -56,12 +58,15 @@ import org.spongepowered.asm.mixin.transformer.ClassInfo.Member.Type; import org.spongepowered.asm.mixin.transformer.MixinInfo.MixinClassNode; import org.spongepowered.asm.service.MixinService; import org.spongepowered.asm.util.Annotations; +import org.spongepowered.asm.util.Bytecode; import org.spongepowered.asm.util.ClassSignature; import org.spongepowered.asm.util.LanguageFeatures; import org.spongepowered.asm.util.Locals; +import org.spongepowered.asm.util.asm.ClassNodeAdapter; import org.spongepowered.asm.util.perf.Profiler; import org.spongepowered.asm.util.perf.Profiler.Section; +import com.google.common.base.Strings; import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableSet; @@ -236,11 +241,11 @@ public final class ClassInfo { this.size = size; } - FrameData(int index, FrameNode frameNode) { + FrameData(int index, FrameNode frameNode, int initialFrameSize) { this.index = index; this.type = frameNode.type; this.locals = frameNode.local != null ? frameNode.local.size() : 0; - this.size = Locals.computeFrameSize(frameNode); + this.size = Locals.computeFrameSize(frameNode, initialFrameSize); } /* (non-Javadoc) @@ -522,7 +527,7 @@ public final class ClassInfo { for (Iterator iter = method.instructions.iterator(); iter.hasNext();) { AbstractInsnNode insn = iter.next(); if (insn instanceof FrameNode) { - frames.add(new FrameData(method.instructions.indexOf(insn), (FrameNode)insn)); + frames.add(new FrameData(method.instructions.indexOf(insn), (FrameNode)insn, Bytecode.getFirstNonArgLocalIndex(method))); } } return frames; @@ -689,6 +694,11 @@ public final class ClassInfo { * Outer class name */ private final String outerName; + + /** + * True if this in an inner class + */ + private final boolean isInner; /** * True either if this is not an inner class or if it is an inner class but @@ -768,6 +778,16 @@ public final class ClassInfo { * Mixins which have been applied this class */ private Set appliedMixins; + + /** + * Declared nest host + */ + private String nestHost; + + /** + * Declared nest members + */ + private Set nestMembers; /** * Private constructor used to initialise the ClassInfo for {@link Object} @@ -776,6 +796,7 @@ public final class ClassInfo { this.name = ClassInfo.JAVA_LANG_OBJECT; this.superName = null; this.outerName = null; + this.isInner = false; this.isProbablyStatic = true; this.initialisers = ImmutableSet.of( new Method("", "()V") @@ -818,7 +839,6 @@ public final class ClassInfo { this.fields = new HashSet(); this.isInterface = ((classNode.access & Opcodes.ACC_INTERFACE) != 0); this.interfaces = new HashSet(); - this.access = classNode.access; this.isMixin = classNode instanceof MixinClassNode; this.mixin = this.isMixin ? ((MixinClassNode)classNode).getMixin() : null; this.mixins = this.isMixin ? Collections.emptySet() : new HashSet(); @@ -837,7 +857,7 @@ public final class ClassInfo { isProbablyStatic = false; if (outerName == null) { outerName = field.desc; - if (outerName != null && outerName.startsWith("L")) { + if (outerName != null && outerName.startsWith("L") && outerName.endsWith(";")) { outerName = outerName.substring(1, outerName.length() - 1); } } @@ -848,9 +868,32 @@ public final class ClassInfo { } this.isProbablyStatic = isProbablyStatic; - this.outerName = outerName; this.methodMapper = new MethodMapper(MixinEnvironment.getCurrentEnvironment(), this); this.signature = ClassSignature.ofLazy(classNode); + + int access = classNode.access; + boolean isInner = outerName != null; + + for (InnerClassNode innerClass : classNode.innerClasses) { + if (this.name.equals(innerClass.name)) { + access = innerClass.access; + isInner = true; + outerName = innerClass.outerName; + } + } + + this.access = access; + this.isInner = isInner; + this.outerName = outerName; + + if (MixinEnvironment.getCompatibilityLevel().supports(LanguageFeatures.NESTING)) { + this.nestHost = ClassNodeAdapter.getNestHostClass(classNode); + List nestMembers = ClassNodeAdapter.getNestMembers(classNode); + if (nestMembers != null) { + this.nestMembers = new LinkedHashSet(); + this.nestMembers.addAll(nestMembers); + } + } } finally { timer.end(); } @@ -927,6 +970,42 @@ public final class ClassInfo { public boolean isPublic() { return (this.access & Opcodes.ACC_PUBLIC) != 0; } + + /** + * Get whether this class is really public (only valid for inner classes + * which may be "public" themselves but aren't actually visible because + * their enclosing type is package-private for example. + */ + public boolean isReallyPublic() { + boolean isPublic = this.isPublic(); + if (!this.isInner || !isPublic) { + return isPublic; + } + + ClassInfo outer = this; + while (outer != null && outer.outerName != null) { + outer = ClassInfo.forName(outer.outerName); + if (outer != null && !outer.isPublic()) { + return false; + } + } + + return true; + } + + /** + * Get whether this class has ACC_PROTECTED (only valid for inner classes) + */ + public boolean isProtected() { + return (this.access & Opcodes.ACC_PROTECTED) != 0; + } + + /** + * Get whether this class has ACC_PRIVATE (only valid for inner classes) + */ + public boolean isPrivate() { + return (this.access & Opcodes.ACC_PRIVATE) != 0; + } /** * Get whether this class has ACC_ABSTRACT @@ -953,7 +1032,7 @@ public final class ClassInfo { * Get whether this class is an inner class */ public boolean isInner() { - return this.outerName != null; + return this.isInner; } /** @@ -1058,7 +1137,36 @@ public final class ClassInfo { public ClassSignature getSignature() { return this.signature.wake(); } - + + /** + * Return the nest host declared in the class + */ + public String getNestHost() { + return this.nestHost; + } + + /** + * Get nest members declared in the class + */ + public Set getNestMembers() { + return this.nestMembers != null ? Collections.unmodifiableSet(this.nestMembers) : Collections.emptySet(); + } + + /** + * Resolve the nest host for inner classes of this class. If the class + * itself has a nest host, the host is returned so that members can be added + * to it. If the class itself is a nest host (already has nest + * members) or is neither a nest host or member (eg. per the specification + * is already a nest host with itself as the sole member) then this method + * simply returns this ClassInfo. + */ + public ClassInfo resolveNestHost() { + if (!Strings.isNullOrEmpty(this.nestHost)) { + return ClassInfo.forName(this.nestHost); + } + return this; + } + /** * Class targets */ @@ -2045,6 +2153,9 @@ public final class ClassInfo { * @return common superclass info */ private static ClassInfo getCommonSuperClass(ClassInfo type1, ClassInfo type2) { + if (type1 == null || type2 == null) { + return ClassInfo.OBJECT; + } return ClassInfo.getCommonSuperClass(type1, type2, false); } diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/DefaultExtensions.java b/src/main/java/org/spongepowered/asm/mixin/transformer/DefaultExtensions.java index 1589715c..cc4031d1 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/DefaultExtensions.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/DefaultExtensions.java @@ -41,7 +41,8 @@ final class DefaultExtensions { private DefaultExtensions() { } - static void create(final MixinEnvironment environment, final Extensions extensions, final SyntheticClassRegistry registry) { + static void create(final MixinEnvironment environment, final Extensions extensions, final SyntheticClassRegistry registry, + final MixinCoprocessorNestHost nestHostCoprocessor) { IConsumer registryDelegate = new IConsumer() { @Override public void accept(ISyntheticClassInfo item) { @@ -50,7 +51,7 @@ final class DefaultExtensions { }; extensions.add(new ArgsClassGenerator(registryDelegate)); - extensions.add(new InnerClassGenerator(registryDelegate)); + extensions.add(new InnerClassGenerator(registryDelegate, nestHostCoprocessor)); extensions.add(new ExtensionClassExporter(environment)); extensions.add(new ExtensionCheckClass()); diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/InnerClassGenerator.java b/src/main/java/org/spongepowered/asm/mixin/transformer/InnerClassGenerator.java index f8731f70..21104a88 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/InnerClassGenerator.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/InnerClassGenerator.java @@ -45,6 +45,9 @@ import org.spongepowered.asm.service.MixinService; import org.spongepowered.asm.util.IConsumer; import org.spongepowered.asm.util.asm.ASM; +import com.google.common.collect.BiMap; +import com.google.common.collect.HashBiMap; + /** * Class generator which creates unique copies of inner classes within mixins * which are specialised to the target class. @@ -63,48 +66,48 @@ final class InnerClassGenerator implements IClassGenerator { private final IMixinInfo mixin; /** - * Class name (internal name) + * Target class info */ - private final String name; + private final ClassInfo targetClassInfo; /** * Original class name */ private final String originalName; + /** + * Class name (internal name) + */ + private final String name; + /** * Mixin which owns this inner class */ private final MixinInfo owner; - /** - * Mixin target context - */ - private final MixinTargetContext target; - /** * Name of the owner mixin (class ref) */ private final String ownerName; /** - * Name of the target class (class ref) + * Name of the new nest host based on the target class */ - private final String targetName; + private final String nestHostName; /** * Number of times this inner class has been generated */ private int loadCounter; - InnerClassInfo(IMixinInfo mixin, String name, String originalName, MixinInfo owner, MixinTargetContext target) { + InnerClassInfo(IMixinInfo mixin, ClassInfo targetClass, ClassInfo nestHost, String originalName, String name, MixinInfo owner) { this.mixin = mixin; - this.name = name; + this.targetClassInfo = targetClass; this.originalName = originalName; + this.name = name; this.owner = owner; this.ownerName = owner.getClassRef(); - this.target = target; - this.targetName = target.getTargetClassRef(); + this.nestHostName = nestHost.getName(); } @Override @@ -135,16 +138,20 @@ final class InnerClassGenerator implements IClassGenerator { return this.owner; } - MixinTargetContext getTarget() { - return this.target; - } - String getOwnerName() { return this.ownerName; } String getTargetName() { - return this.targetName; + return this.targetClassInfo.getName(); + } + + ClassInfo getTargetClass() { + return this.targetClassInfo; + } + + String getNestHostName() { + return this.nestHostName; } void accept(final ClassVisitor classVisitor) throws ClassNotFoundException, IOException { @@ -176,7 +183,7 @@ final class InnerClassGenerator implements IClassGenerator { if (this.originalName.equals(key)) { return this.name; } else if (this.ownerName.equals(key)) { - return this.targetName; + return this.targetClassInfo.getName(); } return key; } @@ -199,11 +206,22 @@ final class InnerClassGenerator implements IClassGenerator { private final InnerClassInfo info; - public InnerClassAdapter(ClassVisitor cv, InnerClassInfo info) { + InnerClassAdapter(ClassVisitor cv, InnerClassInfo info) { super(ASM.API_VERSION, cv, info); this.info = info; } + /* (non-Javadoc) + * @see org.objectweb.asm.commons.ClassRemapper + * #visitNestHost(java.lang.String) + */ + @Override + public void visitNestHost(String nestHost) { + // Discard the original nest host and use the resolved nest host + // from the target class + this.cv.visitNestHost(this.info.getNestHostName()); + } + /* (non-Javadoc) * @see org.objectweb.asm.ClassVisitor * #visitSource(java.lang.String, java.lang.String) @@ -254,14 +272,21 @@ final class InnerClassGenerator implements IClassGenerator { * Mapping of generated class names to the respective inner class info */ private final Map innerClasses = new HashMap(); + + /** + * Coprocessor which handles merging nest members into nest hosts which may + * or may not be mixin targets themselves + */ + private final MixinCoprocessorNestHost nestHostCoprocessor; /** * Ctor * * @param registry sythetic class registry */ - public InnerClassGenerator(IConsumer registry) { + public InnerClassGenerator(IConsumer registry, MixinCoprocessorNestHost nestHostCoprocessor) { this.registry = registry; + this.nestHostCoprocessor = nestHostCoprocessor; } /* (non-Javadoc) @@ -274,26 +299,48 @@ final class InnerClassGenerator implements IClassGenerator { } /** + * Register a mixin inner class against the specified target + * * @param owner Mixin which owns the original inner class - * @param originalName Original inner class name - * @param context Target class - * @return new name + * @param targetClass Target class name + * @param innerClassName Original inner class name */ - public String registerInnerClass(MixinInfo owner, String originalName, MixinTargetContext context) { - String id = String.format("%s%s", originalName, context); - String ref = this.innerClassNames.get(id); - if (ref == null) { - ref = InnerClassGenerator.getUniqueReference(originalName, context); - InnerClassInfo info = new InnerClassInfo(owner, ref, originalName, owner, context); - this.innerClassNames.put(id, ref); - this.innerClasses.put(ref, info); - this.registry.accept(info); - InnerClassGenerator.logger.debug("Inner class {} in {} on {} gets unique name {}", originalName, owner.getClassRef(), - context.getTargetClassRef(), ref); + void registerInnerClass(MixinInfo owner, ClassInfo targetClass, String innerClassName) { + String coordinate = String.format("%s:%s:%s", owner, innerClassName, targetClass.getName()); + String uniqueName = this.innerClassNames.get(coordinate); + if (uniqueName != null) { + return; } - return ref; + uniqueName = InnerClassGenerator.getUniqueReference(innerClassName, targetClass); + ClassInfo nestHost = targetClass.resolveNestHost(); + InnerClassInfo info = new InnerClassInfo(owner, targetClass, nestHost, innerClassName, uniqueName, owner); + this.innerClassNames.put(coordinate, uniqueName); + this.innerClasses.put(uniqueName, info); + this.registry.accept(info); + InnerClassGenerator.logger.debug("Inner class {} in {} on {} gets unique name {}", + innerClassName, owner.getClassRef(), targetClass, uniqueName); + this.nestHostCoprocessor.registerNestMember(nestHost.getClassName(), uniqueName); } - + + /** + * Get a BiMap of inner classes for the specified mixin+target combination + * so that references to the inner class can be remapped during application + * + * @param owner Mixin which owns the original inner class + * @param targetName Target class name + * @return BiMap of original (mixin) inner class names to conformed class + * names + */ + BiMap getInnerClasses(MixinInfo owner, String targetName) { + BiMap innerClasses = HashBiMap.create(); + for (InnerClassInfo innerClass : this.innerClasses.values()) { + if (innerClass.getMixin() == owner && targetName.equals(innerClass.getTargetName())) { + innerClasses.put(innerClass.getOriginalName(), innerClass.getName()); + } + } + return innerClasses; + } + /* (non-Javadoc) * @see org.spongepowered.asm.mixin.transformer.ext.IClassGenerator * #generate(java.lang.String, org.objectweb.asm.tree.ClassNode) @@ -334,15 +381,15 @@ final class InnerClassGenerator implements IClassGenerator { * multiple mixins, each remapped class gets a unique name. * * @param originalName Original inner class name - * @param context Target context + * @param targetClass Target class * @return unique class name */ - private static String getUniqueReference(String originalName, MixinTargetContext context) { + private static String getUniqueReference(String originalName, ClassInfo targetClass) { String name = originalName.substring(originalName.lastIndexOf('$') + 1); if (name.matches("^[0-9]+$")) { name = "Anonymous"; } - return String.format("%s$%s$%s", context.getTargetClassRef(), name, UUID.randomUUID().toString().replace("-", "")); + return String.format("%s$%s$%s", targetClass, name, UUID.randomUUID().toString().replace("-", "")); } } diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinApplicatorInterface.java b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinApplicatorInterface.java index 4304a651..4e3c6d4d 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinApplicatorInterface.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinApplicatorInterface.java @@ -109,7 +109,7 @@ class MixinApplicatorInterface extends MixinApplicatorStandard { } } } catch (InvalidInjectionException ex) { - String description = ex.getInjectionInfo() != null ? ex.getInjectionInfo().toString() : "Injection"; + String description = ex.getContext() != null ? ex.getContext().toString() : "Injection"; throw new InvalidInterfaceMixinException(mixin, description + " is not supported in interface mixin"); } } diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinApplicatorStandard.java b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinApplicatorStandard.java index dd2ef0e1..b28f4613 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinApplicatorStandard.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinApplicatorStandard.java @@ -41,6 +41,7 @@ import org.spongepowered.asm.mixin.Intrinsic; import org.spongepowered.asm.mixin.MixinEnvironment; import org.spongepowered.asm.mixin.MixinEnvironment.Option; import org.spongepowered.asm.mixin.Overwrite; +import org.spongepowered.asm.mixin.extensibility.IActivityContext.IActivity; import org.spongepowered.asm.mixin.gen.Accessor; import org.spongepowered.asm.mixin.gen.Invoker; import org.spongepowered.asm.mixin.injection.Inject; @@ -50,7 +51,6 @@ import org.spongepowered.asm.mixin.injection.ModifyConstant; import org.spongepowered.asm.mixin.injection.ModifyVariable; import org.spongepowered.asm.mixin.injection.Redirect; import org.spongepowered.asm.mixin.throwables.MixinError; -import org.spongepowered.asm.mixin.transformer.ActivityStack.Activity; import org.spongepowered.asm.mixin.transformer.ClassInfo.Field; import org.spongepowered.asm.mixin.transformer.ext.extensions.ExtensionClassExporter; import org.spongepowered.asm.mixin.transformer.meta.MixinMerged; @@ -64,7 +64,6 @@ import org.spongepowered.asm.util.Bytecode; import org.spongepowered.asm.util.Bytecode.DelegateInitialiser; import org.spongepowered.asm.util.Constants; import org.spongepowered.asm.util.ConstraintParser; -import org.spongepowered.asm.util.LanguageFeatures; import org.spongepowered.asm.util.ConstraintParser.Constraint; import org.spongepowered.asm.util.perf.Profiler; import org.spongepowered.asm.util.perf.Profiler.Section; @@ -95,6 +94,7 @@ class MixinApplicatorStandard { * Passes the mixin applicator applies to each mixin */ enum ApplicatorPass { + /** * Main pass, mix in methods, fields, interfaces etc */ @@ -109,12 +109,14 @@ class MixinApplicatorStandard { * Apply injectors from previous pass */ INJECT + } /** * Strategy for injecting initialiser insns */ enum InitialiserInjectionMode { + /** * Default mode, attempts to place initialisers after all other * competing initialisers in the target ctor @@ -126,12 +128,14 @@ class MixinApplicatorStandard { * invocation */ SAFE + } /** * Internal struct for representing a range */ class Range { + /** * Start of the range */ @@ -196,6 +200,7 @@ class MixinApplicatorStandard { public String toString() { return String.format("Range[%d-%d,%d,valid=%s)", this.start, this.end, this.marker, this.isValid()); } + } /** @@ -302,8 +307,8 @@ class MixinApplicatorStandard { this.activities.clear(); try { - Activity activity = this.activities.begin("PreApply Phase"); - Activity preApplyActivity = this.activities.begin("Mixin"); + IActivity activity = this.activities.begin("PreApply Phase"); + IActivity preApplyActivity = this.activities.begin("Mixin"); for (MixinTargetContext context : mixinContexts) { preApplyActivity.next(context.toString()); (current = context).preApply(this.targetName, this.targetClass); @@ -313,7 +318,7 @@ class MixinApplicatorStandard { for (ApplicatorPass pass : ApplicatorPass.values()) { activity.next("%s Applicator Phase", pass); Section timer = this.profiler.begin("pass", pass.name().toLowerCase(Locale.ROOT)); - Activity applyActivity = this.activities.begin("Mixin"); + IActivity applyActivity = this.activities.begin("Mixin"); for (Iterator iter = mixinContexts.iterator(); iter.hasNext();) { current = iter.next(); applyActivity.next(current.toString()); @@ -332,7 +337,7 @@ class MixinApplicatorStandard { } activity.next("PostApply Phase"); - Activity postApplyActivity = this.activities.begin("Mixin"); + IActivity postApplyActivity = this.activities.begin("Mixin"); for (Iterator iter = mixinContexts.iterator(); iter.hasNext();) { current = iter.next(); postApplyActivity.next(current.toString()); @@ -365,7 +370,7 @@ class MixinApplicatorStandard { * @param mixin Mixin to apply */ protected final void applyMixin(MixinTargetContext mixin, ApplicatorPass pass) { - Activity activity = this.activities.begin("Apply"); + IActivity activity = this.activities.begin("Apply"); switch (pass) { case MAIN: activity.next("Apply Signature"); @@ -382,8 +387,6 @@ class MixinApplicatorStandard { this.applyMethods(mixin); activity.next("Apply Initialisers"); this.applyInitialisers(mixin); - activity.next("Apply Nesting"); - this.applyNesting(mixin); break; case PREINJECT: @@ -505,7 +508,7 @@ class MixinApplicatorStandard { * @param mixin mixin target context */ protected void applyMethods(MixinTargetContext mixin) { - Activity activity = this.activities.begin("?"); + IActivity activity = this.activities.begin("?"); for (MethodNode shadow : mixin.getShadowMethods()) { activity.next("@Shadow %s:%s", shadow.desc, shadow.name); this.applyShadowMethod(mixin, shadow); @@ -535,7 +538,7 @@ class MixinApplicatorStandard { this.mergeMethod(mixin, mixinMethod); } else if (Constants.CLINIT.equals(mixinMethod.name)) { // Class initialiser insns get appended - Activity activity = this.activities.begin("Merge CLINIT insns"); + IActivity activity = this.activities.begin("Merge CLINIT insns"); this.appendInsns(mixin, mixinMethod); activity.end(); } @@ -1030,30 +1033,6 @@ class MixinApplicatorStandard { private static String fieldKey(FieldInsnNode fieldNode) { return String.format("%s:%s", fieldNode.desc, fieldNode.name); } - - /** - * Apply nesting attributes from the mixin to the target. - * - *

    NOT YET SUPPORTED!

    - */ - protected void applyNesting(MixinTargetContext mixin) { - - String nestHostClass = mixin.getNestHostClass(); - List nestMembers = mixin.getNestMembers(); - if ((nestHostClass == null && nestMembers == null) || (nestMembers != null && nestMembers.size() == 0)) { - return; - } - - if (!MixinEnvironment.getCompatibilityLevel().supports(LanguageFeatures.NESTING)) { - // Shouldn't get here because we should error out during the initial scan, but you never know - throw new InvalidMixinException(mixin, - String.format("%s contains nesting information but the current compatibility level does not support class nesting attributes", - mixin)); - } - - // TODO Nesting not done yet, just log an error for now that we're not applying these attributes - this.logger.error("NESTING not supported in this version of Mixin. {} nesting attributes will not be applied to the target", mixin); - } /** * Scan for injector methods and injection points diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinConfig.java b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinConfig.java index 65ace691..d7b2ce18 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinConfig.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinConfig.java @@ -53,6 +53,7 @@ import org.spongepowered.asm.mixin.refmap.IClassReferenceMapper; import org.spongepowered.asm.mixin.refmap.IReferenceMapper; import org.spongepowered.asm.mixin.refmap.ReferenceMapper; import org.spongepowered.asm.mixin.refmap.RemappingReferenceMapper; +import org.spongepowered.asm.mixin.transformer.ext.Extensions; import org.spongepowered.asm.mixin.transformer.throwables.InvalidMixinException; import org.spongepowered.asm.service.IMixinService; import org.spongepowered.asm.service.MixinService; @@ -384,6 +385,11 @@ final class MixinConfig implements Comparable, IMixinConfig { */ private transient int warnedClassVersion = 0; + /** + * Service decorations on this config + */ + private transient Map decorations; + /** * Spawn via GSON, no public ctor for you */ @@ -531,14 +537,20 @@ final class MixinConfig implements Comparable, IMixinConfig { throw new MixinInitialisationError(String.format("Mixin config %s requires compatibility level %s which is prohibited by %s", this.name, this.compatibilityLevel, currentLevel)); } - + + CompatibilityLevel minCompatibilityLevel = MixinEnvironment.getMinCompatibilityLevel(); + if (this.compatibilityLevel.isLessThan(minCompatibilityLevel)) { + this.logger.log(this.verboseLogging ? Level.INFO : Level.DEBUG, + "Compatibility level {} specified by {} is lower than the default level supported by the current mixin service ({}).", + this.compatibilityLevel, this, minCompatibilityLevel); + } + // Required level is higher than highest version we support, this possibly // means that a shaded mixin dependency has been usurped by an old version, // or the mixin author is trying to elevate the compatibility level beyond // the versions currently supported if (CompatibilityLevel.MAX_SUPPORTED.isLessThan(this.compatibilityLevel)) { - Level logLevel = this.verboseLogging ? Level.WARN : Level.DEBUG; - this.logger.log(logLevel, + this.logger.log(this.verboseLogging ? Level.WARN : Level.DEBUG, "Compatibility level {} specified by {} is higher than the maximum level supported by this version of mixin ({}).", this.compatibilityLevel, this, CompatibilityLevel.MAX_SUPPORTED); } @@ -757,20 +769,20 @@ final class MixinConfig implements Comparable, IMixinConfig { * either the hasMixinsFor() or getMixinsFor() methods. *

    */ - void prepare() { + void prepare(Extensions extensions) { if (this.prepared) { return; } this.prepared = true; - this.prepareMixins("mixins", this.mixinClasses, false); + this.prepareMixins("mixins", this.mixinClasses, false, extensions); switch (this.env.getSide()) { case CLIENT: - this.prepareMixins("client", this.mixinClassesClient, false); + this.prepareMixins("client", this.mixinClassesClient, false, extensions); break; case SERVER: - this.prepareMixins("server", this.mixinClassesServer, false); + this.prepareMixins("server", this.mixinClassesServer, false, extensions); break; case UNKNOWN: //$FALL-THROUGH$ @@ -780,10 +792,10 @@ final class MixinConfig implements Comparable, IMixinConfig { } } - void postInitialise() { + void postInitialise(Extensions extensions) { if (this.plugin != null) { List pluginMixins = this.plugin.getMixins(); - this.prepareMixins("companion plugin", pluginMixins, true); + this.prepareMixins("companion plugin", pluginMixins, true, extensions); } for (Iterator iter = this.mixins.iterator(); iter.hasNext();) { @@ -815,7 +827,7 @@ final class MixinConfig implements Comparable, IMixinConfig { } } - private void prepareMixins(String collectionName, List mixinClasses, boolean ignorePlugin) { + private void prepareMixins(String collectionName, List mixinClasses, boolean ignorePlugin, Extensions extensions) { if (mixinClasses == null) { return; } @@ -838,7 +850,7 @@ final class MixinConfig implements Comparable, IMixinConfig { MixinInfo mixin = null; try { - this.pendingMixins.add(mixin = new MixinInfo(this.service, this, mixinClass, this.plugin, ignorePlugin)); + this.pendingMixins.add(mixin = new MixinInfo(this.service, this, mixinClass, this.plugin, ignorePlugin, extensions)); MixinConfig.globalMixinList.add(fqMixinClass); } catch (InvalidMixinException ex) { if (this.required) { @@ -1114,6 +1126,50 @@ final class MixinConfig implements Comparable, IMixinConfig { return Collections.unmodifiableSet(this.unhandledTargets); } + /** + * Decorate this config with arbitrary metadata for debugging or + * compatibility purposes + * + * @param key meta key + * @param value meta value + * @param value type + * @throws IllegalArgumentException if the specified key exists already + */ + @Override + public void decorate(String key, V value) { + if (this.decorations == null) { + this.decorations = new HashMap(); + } + if (this.decorations.containsKey(key)) { + throw new IllegalArgumentException(String.format("Decoration with key '%s' already exists on config %s", key, this)); + } + this.decorations.put(key, value); + } + + /** + * Get whether this node is decorated with the specified key + * + * @param key meta key + * @return true if the specified decoration exists + */ + @Override + public boolean hasDecoration(String key) { + return this.decorations != null && this.decorations.get(key) != null; + } + + /** + * Get the specified decoration + * + * @param key meta key + * @param value type + * @return decoration value or null if absent + */ + @Override + @SuppressWarnings("unchecked") + public V getDecoration(String key) { + return (V) (this.decorations == null ? null : this.decorations.get(key)); + } + /** * Get the logging level for this config */ diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinCoprocessor.java b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinCoprocessor.java new file mode 100644 index 00000000..98926464 --- /dev/null +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinCoprocessor.java @@ -0,0 +1,171 @@ +/* + * This file is part of Mixin, licensed under the MIT License (MIT). + * + * Copyright (c) SpongePowered + * Copyright (c) contributors + * + * 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 org.spongepowered.asm.mixin.transformer; + +import org.objectweb.asm.tree.ClassNode; +import org.spongepowered.asm.mixin.transformer.MixinConfig.IListener; + +/** + * Coprocessors are parts of the mixin pipeline which aren't involved in + * applying mixins but handle other transformation tasks required by + * mixins. + * + *

    Such tasks as {@link MixinCoprocessorAccessor making accessor mixins + * loadable (and transforming the accessors therein)}, {@link + * MixinCoprocessorSyntheticInner exposing synthetic inner classes to all + * consumers} and {@link MixinCoprocessorNestHost applying nest member + * attributes to nest hosts which may themselves not be mixin targets} are + * handled by different coprocessors.

    + * + *

    These classes were previously encapsulated in a single companion class + * called MixinPostProcessor, but the mixture of responsibilities of + * that class made its role unclear and slightly schizophrenic.

    + */ +abstract class MixinCoprocessor implements IListener { + + /** + * The result of a specific coprocessor's action on a supplied class, + * effectively a tuple of transformed and passthrough + * which combines the normal transformed flag (which is returned to + * the service so it knows whether the supplied class was altered or not) + * and a second flag which indicates whether the class is eligible for + * processing by the mixin pipeline: Results with passthrough set + * will not be processed further by the mixin processor. + */ + enum ProcessResult { + + /** + * This coprocessor does not take any action for the specified class + */ + NONE(false, false), + + /** + * This coprocessor acted on the supplied bytecode, but does not change + * the flow of the main mixin processor pipeline + */ + TRANSFORMED(false, true), + + /** + * This coprocessor did not transform the supplied bytecode, and mixins + * should not be applied to this class + */ + PASSTHROUGH_NONE(true, false), + + /** + * This coprocessor acted on the supplied bytecode, and mixins should + * not be applied to this class + */ + PASSTHROUGH_TRANSFORMED(true, true); + + private boolean passthrough; + + private boolean transformed; + + private ProcessResult(boolean passthrough, boolean transformed) { + this.passthrough = passthrough; + this.transformed = transformed; + } + + boolean isPassthrough() { + return this.passthrough; + } + + boolean isTransformed() { + return this.transformed; + } + + /** + * Combine this result with the supplied result + */ + ProcessResult with(ProcessResult other) { + if (other == this) { + return this; + } + return ProcessResult.of(this.passthrough || other.passthrough, this.transformed || other.transformed); + } + + /** + * Return a result which represents the supplied tuple of attributes + */ + static ProcessResult of(boolean passthrough, boolean transformed) { + if (passthrough) { + return transformed ? ProcessResult.PASSTHROUGH_TRANSFORMED : ProcessResult.PASSTHROUGH_NONE; + } + return transformed ? ProcessResult.TRANSFORMED : ProcessResult.NONE; + } + + } + + /** + * Coprocessor name, for debugging only + */ + abstract String getName(); + + /* (non-Javadoc) + * @see org.spongepowered.asm.mixin.transformer.MixinConfig.IListener + * #onPrepare(org.spongepowered.asm.mixin.transformer.MixinInfo) + */ + @Override + public void onPrepare(MixinInfo mixin) { + } + + /* (non-Javadoc) + * @see org.spongepowered.asm.mixin.transformer.MixinConfig.IListener + * #onInit(org.spongepowered.asm.mixin.transformer.MixinInfo) + */ + @Override + public void onInit(MixinInfo mixin) { + } + + /** + * Process the supplied class. If the class is transformed, or should be + * passed through (rather than treated as a mixin target) then this is + * indicated by the return value + * + * @param className Name of the target class + * @param classNode Classnode of the target class + * @return result indicating whether the class was transformed, and whether + * or not to passthrough instead of apply mixins + */ + ProcessResult process(String className, ClassNode classNode) { + return ProcessResult.NONE; + } + + /** + * Perform postprocessing actions on the supplied class. This is called for + * all classes. For passthrough classes and classes which are not mixin + * targets this is called immediately after {@link process} is completed for + * all coprocessors. For mixin targets this is called after mixins are + * applied. + * + * @param className Name of the target class + * @param classNode Classnode of the target class + * @return true if the coprocessor applied any transformations + */ + boolean postProcess(String className, ClassNode classNode) { + return false; + } + +} diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinPostProcessor.java b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinCoprocessorAccessor.java similarity index 63% rename from src/main/java/org/spongepowered/asm/mixin/transformer/MixinPostProcessor.java rename to src/main/java/org/spongepowered/asm/mixin/transformer/MixinCoprocessorAccessor.java index 68fcee4d..967d0380 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinPostProcessor.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinCoprocessorAccessor.java @@ -25,15 +25,12 @@ package org.spongepowered.asm.mixin.transformer; import java.util.HashMap; -import java.util.HashSet; import java.util.Map; -import java.util.Set; import org.objectweb.asm.Opcodes; import org.objectweb.asm.Type; import org.objectweb.asm.tree.AnnotationNode; import org.objectweb.asm.tree.ClassNode; -import org.objectweb.asm.tree.FieldNode; import org.objectweb.asm.tree.InsnNode; import org.objectweb.asm.tree.MethodInsnNode; import org.objectweb.asm.tree.MethodNode; @@ -47,126 +44,55 @@ import org.spongepowered.asm.mixin.transformer.meta.MixinProxy; import org.spongepowered.asm.mixin.transformer.throwables.MixinTransformerError; import org.spongepowered.asm.util.Annotations; import org.spongepowered.asm.util.Bytecode; -import org.spongepowered.asm.util.Bytecode.Visibility; import org.spongepowered.asm.util.LanguageFeatures; +import org.spongepowered.asm.util.Bytecode.Visibility; /** - * Performs post-processing tasks required for certain classes which pass - * through the mixin transformer, such as transforming synthetic inner classes - * and populating accessor methods in accessor mixins. + * This coprocessor handles transformations to accessor mixins themselves as + * they are classloaded. Besides ensuring that the interface is public, its + * primary responsibility is to transform the decorated accessor methods into + * proxies for the target members. */ -class MixinPostProcessor implements MixinConfig.IListener { +class MixinCoprocessorAccessor extends MixinCoprocessor { /** * Transformer session ID */ - private final String sessionId; - - /** - * Synthetic inner classes in mixins - */ - private final Set syntheticInnerClasses = new HashSet(); - + protected final String sessionId; + /** * Accessor mixins */ private final Map accessorMixins = new HashMap(); - /** - * Loadable classes within mixin packages - */ - private final Set loadable = new HashSet(); - - MixinPostProcessor(String sessionId) { + MixinCoprocessorAccessor(String sessionId) { this.sessionId = sessionId; } - + @Override - public void onInit(MixinInfo mixin) { - for (String innerClass : mixin.getSyntheticInnerClasses()) { - this.registerSyntheticInner(innerClass.replace('/', '.')); - } + String getName() { + return "accessor"; } @Override public void onPrepare(MixinInfo mixin) { - String className = mixin.getClassName(); - - if (mixin.isLoadable()) { - this.registerLoadable(className); - } - if (mixin.isAccessor()) { this.registerAccessor(mixin); } } - void registerSyntheticInner(String className) { - this.syntheticInnerClasses.add(className); - } - - void registerLoadable(String className) { - this.loadable.add(className); - } - void registerAccessor(MixinInfo mixin) { - this.registerLoadable(mixin.getClassName()); this.accessorMixins.put(mixin.getClassName(), mixin); } - /** - * Get whether the specified class can be piped through the postprocessor - * rather than being classloaded normally - * - * @param className Class name to check - * @return True if the specified class name has been registered for post- - * processing - */ - boolean canProcess(String className) { - return this.syntheticInnerClasses.contains(className) || this.loadable.contains(className); - } - - public boolean processClass(String name, ClassNode classNode) { - - if (this.syntheticInnerClasses.contains(name)) { - this.processSyntheticInner(classNode); - return true; - } - - if (this.accessorMixins.containsKey(name)) { - MixinInfo mixin = this.accessorMixins.get(name); - return this.processAccessor(classNode, mixin); - } - - return false; - } - - /** - * "Pass through" a synthetic inner class. Transforms package-private - * members in the class into public so that they are accessible from their - * new home in the target class - */ - private void processSyntheticInner(ClassNode classNode) { - classNode.access |= Opcodes.ACC_PUBLIC; - - for (FieldNode field : classNode.fields) { - if ((field.access & (Opcodes.ACC_PRIVATE | Opcodes.ACC_PROTECTED)) == 0) { - field.access |= Opcodes.ACC_PUBLIC; - } - } - - for (MethodNode method : classNode.methods) { - if ((method.access & (Opcodes.ACC_PRIVATE | Opcodes.ACC_PROTECTED)) == 0) { - method.access |= Opcodes.ACC_PUBLIC; - } - } - } - - private boolean processAccessor(ClassNode classNode, MixinInfo mixin) { - if (!MixinEnvironment.getCompatibilityLevel().supports(LanguageFeatures.METHODS_IN_INTERFACES)) { - return false; + @Override + ProcessResult process(String className, ClassNode classNode) { + if (!MixinEnvironment.getCompatibilityLevel().supports(LanguageFeatures.METHODS_IN_INTERFACES) + || !this.accessorMixins.containsKey(className)) { + return ProcessResult.NONE; } + MixinInfo mixin = this.accessorMixins.get(className); boolean transformed = false; MixinClassNode mixinClassNode = mixin.getClassNode(0); ClassInfo targetClass = mixin.getTargets().get(0); @@ -185,7 +111,7 @@ class MixinPostProcessor implements MixinConfig.IListener { AnnotationNode invoker = methodNode.getVisibleAnnotation(Invoker.class); if (accessor != null || invoker != null) { Method method = this.getAccessorMethod(mixin, methodNode, targetClass); - MixinPostProcessor.createProxy(methodNode, targetClass, method); + MixinCoprocessorAccessor.createProxy(methodNode, targetClass, method); Annotations.setVisible(methodNode, MixinProxy.class, "sessionId", this.sessionId); classNode.methods.add(methodNode); transformed = true; @@ -193,11 +119,11 @@ class MixinPostProcessor implements MixinConfig.IListener { } if (!transformed) { - return false; + return ProcessResult.NONE; } Bytecode.replace(mixinClassNode, classNode); - return true; + return ProcessResult.PASSTHROUGH_TRANSFORMED; } private Method getAccessorMethod(MixinInfo mixin, MethodNode methodNode, ClassInfo targetClass) throws MixinTransformerError { diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinCoprocessorNestHost.java b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinCoprocessorNestHost.java new file mode 100644 index 00000000..59244639 --- /dev/null +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinCoprocessorNestHost.java @@ -0,0 +1,108 @@ +/* + * This file is part of Mixin, licensed under the MIT License (MIT). + * + * Copyright (c) SpongePowered + * Copyright (c) contributors + * + * 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 org.spongepowered.asm.mixin.transformer; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.HashSet; +import java.util.LinkedHashSet; +import java.util.List; +import java.util.Map; +import java.util.Set; + +import org.objectweb.asm.tree.ClassNode; +import org.spongepowered.asm.mixin.MixinEnvironment; +import org.spongepowered.asm.mixin.transformer.throwables.MixinTransformerError; +import org.spongepowered.asm.util.LanguageFeatures; +import org.spongepowered.asm.util.asm.ClassNodeAdapter; + +/** + * In Java 11 and above, access control semantics for inner members are reified + * in the concept of nesting, where an "outermost" class becomes a "nest host" + * for all nested classes. Since a mixin can be applied to an inner class, the + * process of adding any inner classes of mixins to the nest is not as simple as + * having the target class become the nest host. Thus the nest host of conformed + * inner classes is resolved during the prepare phase so that any + * classes which need to have their nests expanded can be processed accordingly. + * + *

    This coprocessor therefore processes all classes regardless of whether + * they are mixin targets or not, in order to add any additional nest members + * where a mixin targets the class, or one of its existing nest members.

    + */ +class MixinCoprocessorNestHost extends MixinCoprocessor { + + /** + * Classes which are nest hosts with new members injected by mixins + */ + private final Map> nestHosts = new HashMap>(); + + MixinCoprocessorNestHost() { + } + + void registerNestMember(String hostName, String memberName) { + Set nestMembers = this.nestHosts.get(hostName); + if (nestMembers == null) { + this.nestHosts.put(hostName, nestMembers = new HashSet()); + } + nestMembers.add(memberName); + } + + @Override + String getName() { + return "nesthost"; + } + + @Override + boolean postProcess(String className, ClassNode classNode) { + if (!this.nestHosts.containsKey(className)) { + return false; + } + + Set newMembers = this.nestHosts.get(className); + if (!MixinEnvironment.getCompatibilityLevel().supports(LanguageFeatures.NESTING) || newMembers.isEmpty()) { + return false; + } + + String nestHost = ClassNodeAdapter.getNestHostClass(classNode); + if (nestHost != null) { + throw new MixinTransformerError(String.format("Nest host candidate %s is a nest member", classNode.name)); + } + + List nestMembers = ClassNodeAdapter.getNestMembers(classNode); + if (nestMembers == null) { + // If there are currently no nest members, just set the ones we have + nestMembers = new ArrayList(newMembers); + } else { + // Otherwise add all the new members + LinkedHashSet combinedMembers = new LinkedHashSet(nestMembers); + combinedMembers.addAll(newMembers); + nestMembers.clear(); + nestMembers.addAll(combinedMembers); + } + ClassNodeAdapter.setNestMembers(classNode, nestMembers); + return true; + } + +} diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinCoprocessorPassthrough.java b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinCoprocessorPassthrough.java new file mode 100644 index 00000000..a970320a --- /dev/null +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinCoprocessorPassthrough.java @@ -0,0 +1,67 @@ +/* + * This file is part of Mixin, licensed under the MIT License (MIT). + * + * Copyright (c) SpongePowered + * Copyright (c) contributors + * + * 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 org.spongepowered.asm.mixin.transformer; + +import java.util.HashSet; +import java.util.Set; + +import org.objectweb.asm.tree.ClassNode; + +/** + * Passthrough coprocessor which simply keeps track of classes which are + * loadable. + */ +class MixinCoprocessorPassthrough extends MixinCoprocessor { + + /** + * Loadable classes within mixin packages + */ + private final Set loadable = new HashSet(); + + MixinCoprocessorPassthrough() { + } + + @Override + String getName() { + return "passthrough"; + } + + @Override + public void onPrepare(MixinInfo mixin) { + if (mixin.isLoadable()) { + this.registerLoadable(mixin.getClassName()); + } + } + + void registerLoadable(String className) { + this.loadable.add(className); + } + + @Override + ProcessResult process(String className, ClassNode classNode) { + return this.loadable.contains(className) ? ProcessResult.PASSTHROUGH_NONE : ProcessResult.NONE; + } + +} diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinCoprocessorSyntheticInner.java b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinCoprocessorSyntheticInner.java new file mode 100644 index 00000000..8291dc12 --- /dev/null +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinCoprocessorSyntheticInner.java @@ -0,0 +1,99 @@ +/* + * This file is part of Mixin, licensed under the MIT License (MIT). + * + * Copyright (c) SpongePowered + * Copyright (c) contributors + * + * 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 org.spongepowered.asm.mixin.transformer; + +import java.util.HashSet; +import java.util.Set; + +import org.objectweb.asm.Opcodes; +import org.objectweb.asm.tree.ClassNode; +import org.objectweb.asm.tree.FieldNode; +import org.objectweb.asm.tree.MethodNode; + +/** + * Coprocessor which handles synthetic inner classes in mixins. Since synthetic + * inner classes are usually just switch tables, it is reasonably safe to share + * them amongst all mixin targets. Therefore the class is simply transformed so + * that all members are public. + * + *

    Nest based-access control could potentially be used where a mixin has a + * single target, and Java 11 or higher is in use, but at the moment it's more + * straightforward to just make everything public.

    + */ +class MixinCoprocessorSyntheticInner extends MixinCoprocessor { + + /** + * Synthetic inner classes in mixins + */ + private final Set syntheticInnerClasses = new HashSet(); + + MixinCoprocessorSyntheticInner() { + } + + @Override + String getName() { + return "syntheticinner"; + } + + @Override + public void onInit(MixinInfo mixin) { + for (String innerClass : mixin.getSyntheticInnerClasses()) { + this.registerSyntheticInner(innerClass.replace('/', '.')); + } + } + + void registerSyntheticInner(String className) { + this.syntheticInnerClasses.add(className); + } + + /** + * "Pass through" a synthetic inner class. Transforms package-private + * members in the class into public so that they are accessible from their + * new home in the target class + */ + @Override + ProcessResult process(String className, ClassNode classNode) { + if (!this.syntheticInnerClasses.contains(className)) { + return ProcessResult.NONE; + } + + classNode.access |= Opcodes.ACC_PUBLIC; + + for (FieldNode field : classNode.fields) { + if ((field.access & (Opcodes.ACC_PRIVATE | Opcodes.ACC_PROTECTED)) == 0) { + field.access |= Opcodes.ACC_PUBLIC; + } + } + + for (MethodNode method : classNode.methods) { + if ((method.access & (Opcodes.ACC_PRIVATE | Opcodes.ACC_PROTECTED)) == 0) { + method.access |= Opcodes.ACC_PUBLIC; + } + } + + return ProcessResult.PASSTHROUGH_TRANSFORMED; + } + +} diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinCoprocessors.java b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinCoprocessors.java new file mode 100644 index 00000000..8bae4fa5 --- /dev/null +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinCoprocessors.java @@ -0,0 +1,89 @@ +/* + * This file is part of Mixin, licensed under the MIT License (MIT). + * + * Copyright (c) SpongePowered + * Copyright (c) contributors + * + * 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 org.spongepowered.asm.mixin.transformer; + +import java.util.ArrayList; + +import org.objectweb.asm.tree.ClassNode; +import org.spongepowered.asm.mixin.MixinEnvironment; +import org.spongepowered.asm.mixin.transformer.MixinCoprocessor.ProcessResult; +import org.spongepowered.asm.util.perf.Profiler; +import org.spongepowered.asm.util.perf.Profiler.Section; + +/** + * Convenience list of coprocessors + */ +class MixinCoprocessors extends ArrayList { + + private static final long serialVersionUID = 1L; + + /** + * Profiler + */ + private final Profiler profiler; + + MixinCoprocessors() { + this.profiler = MixinEnvironment.getProfiler(); + } + + /** + * Process the supplied class using all registered coprocessors. If the + * class is transformed, or should be passed through (rather than treated as + * a mixin target) then this is indicated by the return value. + * + * @param className Name of the target class + * @param classNode Classnode of the target class + * @return result indicating whether the class was transformed, and whether + * or not to passthrough instead of apply mixins + */ + ProcessResult process(String className, ClassNode classNode) { + Section timer = this.profiler.begin("coprocessor"); + ProcessResult result = ProcessResult.NONE; + for (MixinCoprocessor coprocessor : this) { + result = coprocessor.process(className, classNode).with(result); + } + timer.end(); + return result; + } + + /** + * Perform postprocessing actions on the supplied class using all registered + * coprocessors. + * + * @param className Name of the target class + * @param classNode Classnode of the target class + * @return true if the coprocessor applied any transformations + */ + boolean postProcess(String className, ClassNode classNode) { + Section timer = this.profiler.begin("coprocessor"); + boolean transformed = false; + for (MixinCoprocessor coprocessor : this) { + transformed |= coprocessor.postProcess(className, classNode); + } + timer.end(); + return transformed; + } + +} diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinInfo.java b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinInfo.java index 518a6486..80c3c008 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinInfo.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinInfo.java @@ -62,6 +62,7 @@ import org.spongepowered.asm.mixin.extensibility.IMixinInfo; import org.spongepowered.asm.mixin.injection.Surrogate; import org.spongepowered.asm.mixin.injection.struct.InjectionInfo; import org.spongepowered.asm.mixin.transformer.ClassInfo.Method; +import org.spongepowered.asm.mixin.transformer.ext.Extensions; import org.spongepowered.asm.mixin.transformer.throwables.InvalidMixinException; import org.spongepowered.asm.mixin.transformer.throwables.MixinReloadException; import org.spongepowered.asm.mixin.transformer.throwables.MixinTargetAlreadyLoadedException; @@ -319,7 +320,7 @@ class MixinInfo implements Comparable, IMixinInfo { void validate(SubType type, List targetClasses) { MixinClassNode classNode = this.getValidationClassNode(); - MixinPreProcessorStandard preProcessor = type.createPreProcessor(classNode).prepare(); + MixinPreProcessorStandard preProcessor = type.createPreProcessor(classNode).prepare(MixinInfo.this.getExtensions()); for (ClassInfo target : targetClasses) { preProcessor.conform(target); } @@ -439,7 +440,7 @@ class MixinInfo implements Comparable, IMixinInfo { } protected void validateChanges(SubType type, List targetClasses) { - type.createPreProcessor(this.validationClassNode).prepare(); + type.createPreProcessor(this.validationClassNode).prepare(MixinInfo.this.getExtensions()); } } @@ -817,6 +818,11 @@ class MixinInfo implements Comparable, IMixinInfo { * Strict target checks enabled */ private final transient boolean strict; + + /** + * Transformer extensions manager + */ + private final transient Extensions extensions; /** * Holds state that currently is not fully initialised or validated @@ -837,7 +843,7 @@ class MixinInfo implements Comparable, IMixinInfo { * @param ignorePlugin true to prevent the plugin from filtering targets of * this mixin */ - MixinInfo(IMixinService service, MixinConfig parent, String name, PluginHandle plugin, boolean ignorePlugin) { + MixinInfo(IMixinService service, MixinConfig parent, String name, PluginHandle plugin, boolean ignorePlugin, Extensions extensions) { this.service = service; this.parent = parent; this.name = name; @@ -845,6 +851,7 @@ class MixinInfo implements Comparable, IMixinInfo { this.plugin = plugin; this.phase = parent.getEnvironment().getPhase(); this.strict = parent.getEnvironment().getOption(Option.DEBUG_TARGETS); + this.extensions = extensions; // Read the class bytes and transform try { @@ -1018,7 +1025,7 @@ class MixinInfo implements Comparable, IMixinInfo { return null; } this.type.validateTarget(target.name, targetInfo); - if (target.isPrivate && targetInfo.isPublic() && !this.isVirtual()) { + if (target.isPrivate && targetInfo.isReallyPublic() && !this.isVirtual()) { this.handleTargetError(String.format("@Mixin target %s is public in %s and should be specified in value", target.name, this), true); } return targetInfo; @@ -1262,6 +1269,13 @@ class MixinInfo implements Comparable, IMixinInfo { Set getInterfaces() { return this.getState().getInterfaces(); } + + /** + * Get transformer extensions + */ + Extensions getExtensions() { + return this.extensions; + } /** * Get a new mixin target context object for the specified target @@ -1272,7 +1286,7 @@ class MixinInfo implements Comparable, IMixinInfo { MixinTargetContext createContextFor(TargetClassContext target) { MixinClassNode classNode = this.getClassNode(ClassReader.EXPAND_FRAMES); Section preTimer = this.profiler.begin("pre"); - MixinTargetContext context = this.type.createPreProcessor(classNode).prepare().createContextFor(target); + MixinTargetContext context = this.type.createPreProcessor(classNode).prepare(this.extensions).createContextFor(target); preTimer.end(); return context; } @@ -1337,7 +1351,7 @@ class MixinInfo implements Comparable, IMixinInfo { /** * Called immediately before the mixin is applied to targetClass */ - public void preApply(String transformedName, ClassNode targetClass) { + public void preApply(String transformedName, ClassNode targetClass) throws Exception { if (this.plugin.isAvailable()) { Section pluginTimer = this.profiler.begin("plugin"); try { @@ -1351,7 +1365,7 @@ class MixinInfo implements Comparable, IMixinInfo { /** * Called immediately after the mixin is applied to targetClass */ - public void postApply(String transformedName, ClassNode targetClass) { + public void postApply(String transformedName, ClassNode targetClass) throws Exception { if (this.plugin.isAvailable()) { Section pluginTimer = this.profiler.begin("plugin"); try { diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinPreProcessorStandard.java b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinPreProcessorStandard.java index d24bce2d..015e303d 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinPreProcessorStandard.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinPreProcessorStandard.java @@ -40,19 +40,20 @@ import org.spongepowered.asm.mixin.MixinEnvironment.Option; import org.spongepowered.asm.mixin.Overwrite; import org.spongepowered.asm.mixin.Shadow; import org.spongepowered.asm.mixin.Unique; +import org.spongepowered.asm.mixin.extensibility.IActivityContext.IActivity; import org.spongepowered.asm.mixin.gen.Accessor; import org.spongepowered.asm.mixin.gen.Invoker; import org.spongepowered.asm.mixin.gen.throwables.InvalidAccessorException; import org.spongepowered.asm.mixin.struct.MemberRef; import org.spongepowered.asm.mixin.throwables.ClassMetadataNotFoundException; import org.spongepowered.asm.mixin.throwables.MixinException; -import org.spongepowered.asm.mixin.transformer.ActivityStack.Activity; import org.spongepowered.asm.mixin.transformer.ClassInfo.Field; import org.spongepowered.asm.mixin.transformer.ClassInfo.Method; import org.spongepowered.asm.mixin.transformer.ClassInfo.SearchType; import org.spongepowered.asm.mixin.transformer.ClassInfo.TypeLookup; import org.spongepowered.asm.mixin.transformer.MixinInfo.MixinClassNode; import org.spongepowered.asm.mixin.transformer.MixinInfo.MixinMethodNode; +import org.spongepowered.asm.mixin.transformer.ext.Extensions; import org.spongepowered.asm.mixin.transformer.meta.MixinRenamed; import org.spongepowered.asm.mixin.transformer.throwables.InvalidMixinException; import org.spongepowered.asm.mixin.transformer.throwables.MixinPreProcessorException; @@ -163,7 +164,7 @@ class MixinPreProcessorStandard { * * @return Prepared classnode */ - final MixinPreProcessorStandard prepare() { + final MixinPreProcessorStandard prepare(Extensions extensions) { if (this.prepared) { return this; } @@ -173,17 +174,19 @@ class MixinPreProcessorStandard { this.activities.clear(); Section prepareTimer = this.profiler.begin("prepare"); try { - - Activity activity = this.activities.begin("Prepare method"); + IActivity activity = this.activities.begin("Prepare inner classes"); + this.prepareInnerClasses(extensions); + + activity.next("Prepare method"); for (MixinMethodNode mixinMethod : this.classNode.mixinMethods) { Method method = this.mixin.getClassInfo().findMethod(mixinMethod); - Activity methodActivity = this.activities.begin(mixinMethod.toString()); + IActivity methodActivity = this.activities.begin(mixinMethod.toString()); this.prepareMethod(mixinMethod, method); methodActivity.end(); } activity.next("Prepare field"); for (FieldNode mixinField : this.classNode.fields) { - Activity fieldActivity = this.activities.begin(String.format("%s:%s", mixinField.name, mixinField.desc)); + IActivity fieldActivity = this.activities.begin(String.format("%s:%s", mixinField.name, mixinField.desc)); this.prepareField(mixinField); fieldActivity.end(); } @@ -197,6 +200,16 @@ class MixinPreProcessorStandard { return this; } + protected void prepareInnerClasses(Extensions extensions) { + InnerClassGenerator icg = extensions.getGenerator(InnerClassGenerator.class); + for (String targetClassName : this.mixin.getDeclaredTargetClasses()) { + ClassInfo targetClassInfo = ClassInfo.forName(targetClassName); + for (String innerClass : this.mixin.getInnerClasses()) { + icg.registerInnerClass(this.mixin, targetClassInfo, innerClass); + } + } + } + protected void prepareMethod(MixinMethodNode mixinMethod, Method method) { this.prepareShadow(mixinMethod, method); this.prepareSoftImplements(mixinMethod, method); @@ -239,7 +252,7 @@ class MixinPreProcessorStandard { for (MixinMethodNode mixinMethod : this.classNode.mixinMethods) { if (mixinMethod.isInjector()) { Method method = this.mixin.getClassInfo().findMethod(mixinMethod, ClassInfo.INCLUDE_ALL); - Activity methodActivity = this.activities.begin("Conform injector %s", mixinMethod); + IActivity methodActivity = this.activities.begin("Conform injector %s", mixinMethod); this.conformInjector(target, mixinMethod, method); methodActivity.end(); } @@ -282,7 +295,7 @@ class MixinPreProcessorStandard { try { // Perform context-sensitive attachment phase Section timer = this.profiler.begin("methods"); - Activity activity = this.activities.begin("Attach method"); + IActivity activity = this.activities.begin("Attach method"); this.attachMethods(context); timer = timer.next("fields"); activity.next("Attach field"); @@ -304,7 +317,7 @@ class MixinPreProcessorStandard { } protected void attachMethods(MixinTargetContext context) { - Activity methodActivity = this.activities.begin("?"); + IActivity methodActivity = this.activities.begin("?"); for (Iterator iter = this.classNode.mixinMethods.iterator(); iter.hasNext();) { MixinMethodNode mixinMethod = iter.next(); methodActivity.next(mixinMethod.toString()); @@ -579,7 +592,7 @@ class MixinPreProcessorStandard { } protected void attachFields(MixinTargetContext context) { - Activity fieldActivity = this.activities.begin("?"); + IActivity fieldActivity = this.activities.begin("?"); for (Iterator iter = this.classNode.getFields().iterator(); iter.hasNext();) { FieldNode mixinField = iter.next(); fieldActivity.next("%s:%s", mixinField.name, mixinField.desc); @@ -710,12 +723,12 @@ class MixinPreProcessorStandard { * accesses in the mixin */ protected void transform(MixinTargetContext context) { - Activity methodActivity = this.activities.begin("method"); + IActivity methodActivity = this.activities.begin("method"); for (MethodNode mixinMethod : this.classNode.methods) { methodActivity.next("Method %s", mixinMethod); for (Iterator iter = mixinMethod.instructions.iterator(); iter.hasNext();) { AbstractInsnNode insn = iter.next(); - Activity activity = this.activities.begin(Bytecode.getOpcodeName(insn)); + IActivity activity = this.activities.begin(Bytecode.getOpcodeName(insn)); if (insn instanceof MethodInsnNode) { this.transformMethod((MethodInsnNode)insn); } else if (insn instanceof FieldInsnNode) { @@ -730,7 +743,7 @@ class MixinPreProcessorStandard { } protected void transformInvokeDynamic(InvokeDynamicInsnNode invokeDynamicNode) { - Activity activity = this.activities.begin("%s%s", invokeDynamicNode.name, invokeDynamicNode.desc); + IActivity activity = this.activities.begin("%s::%s%s", invokeDynamicNode.owner, invokeDynamicNode.name, invokeDynamicNode.desc); Section metaTimer = this.profiler.begin("meta"); MemberRef.Handle ref = new MemberRef.Handle(invokeDynamicNode.bsm); @@ -760,7 +773,7 @@ class MixinPreProcessorStandard { } protected void transformMemberReference(MemberRef ref) { - Activity activity = this.activities.begin("%s::%s%s", ref.getOwner(), ref.getName(), ref.getDesc()); + IActivity activity = this.activities.begin("%s::%s:%s", ref.getOwner(), ref.getName(), ref.getDesc()); Section metaTimer = this.profiler.begin("meta"); ClassInfo owner = ClassInfo.forDescriptor(ref.getOwner(), TypeLookup.DECLARED_TYPE); diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinProcessor.java b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinProcessor.java index 8dc8fea7..7c0d717d 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinProcessor.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinProcessor.java @@ -49,10 +49,10 @@ import org.spongepowered.asm.mixin.throwables.MixinApplyError; import org.spongepowered.asm.mixin.throwables.MixinException; import org.spongepowered.asm.mixin.throwables.MixinPrepareError; import org.spongepowered.asm.mixin.transformer.MixinConfig.IListener; +import org.spongepowered.asm.mixin.transformer.MixinCoprocessor.ProcessResult; import org.spongepowered.asm.mixin.transformer.MixinInfo.Variant; import org.spongepowered.asm.mixin.transformer.ext.Extensions; import org.spongepowered.asm.mixin.transformer.ext.IHotSwap; -import org.spongepowered.asm.mixin.transformer.ext.extensions.ExtensionCheckClass.ValidationFailedException; import org.spongepowered.asm.mixin.transformer.ext.extensions.ExtensionClassExporter; import org.spongepowered.asm.mixin.transformer.meta.MixinMerged; import org.spongepowered.asm.mixin.transformer.throwables.IllegalClassLoadError; @@ -185,7 +185,7 @@ class MixinProcessor { /** * Postprocessor for passthrough */ - private final MixinPostProcessor postProcessor; + private final MixinCoprocessors coprocessors = new MixinCoprocessors(); /** * Profiler @@ -220,12 +220,16 @@ class MixinProcessor { /** * ctor */ - MixinProcessor(MixinEnvironment environment, Extensions extensions, IHotSwap hotSwapper) { + MixinProcessor(MixinEnvironment environment, Extensions extensions, IHotSwap hotSwapper, MixinCoprocessorNestHost nestHostCoprocessor) { this.lock = this.service.getReEntranceLock(); this.extensions = extensions; this.hotSwapper = hotSwapper; - this.postProcessor = new MixinPostProcessor(this.sessionId); + + this.coprocessors.add(new MixinCoprocessorPassthrough()); + this.coprocessors.add(new MixinCoprocessorSyntheticInner()); + this.coprocessors.add(new MixinCoprocessorAccessor(this.sessionId)); + this.coprocessors.add(nestHostCoprocessor); this.profiler = MixinEnvironment.getProfiler(); this.auditTrail = this.service.getAuditTrail(); @@ -292,18 +296,21 @@ class MixinProcessor { } } - boolean success = false; + boolean transformed = false; try { - if (this.postProcessor.canProcess(name)) { + ProcessResult result = this.coprocessors.process(name, targetClassNode); + transformed |= result.isTransformed(); + + if (result.isPassthrough()) { + for (MixinCoprocessor coprocessor : this.coprocessors) { + transformed |= coprocessor.postProcess(name, targetClassNode); + } if (this.auditTrail != null) { this.auditTrail.onPostProcess(name); } - Section postTimer = this.profiler.begin("postprocessor"); - success = this.postProcessor.processClass(name, targetClassNode); - postTimer.end(); this.extensions.export(environment, name, false, targetClassNode); - return success; + return transformed; } MixinConfig packageOwnedByConfig = null; @@ -322,7 +329,7 @@ class MixinProcessor { // AMS - Temp passthrough for injection points and dynamic selectors. Moving to service in 0.9 ClassInfo targetInfo = ClassInfo.fromClassNode(targetClassNode); if (targetInfo.hasSuperClass(InjectionPoint.class) || targetInfo.hasSuperClass(ITargetSelectorDynamic.class)) { - return false; + return transformed; } throw new IllegalClassLoadError(this.getInvalidClassError(name, targetClassNode, packageOwnedByConfig)); @@ -353,18 +360,31 @@ class MixinProcessor { } try { - // Tree for target class - Section timer = this.profiler.begin("read"); - TargetClassContext context = new TargetClassContext(environment, this.extensions, this.sessionId, - name, targetClassNode, mixins); - timer.end(); - this.applyMixins(environment, context); + TargetClassContext context = new TargetClassContext(environment, this.extensions, this.sessionId, name, targetClassNode, mixins); + context.applyMixins(); + + transformed |= this.coprocessors.postProcess(name, targetClassNode); + + if (context.isExported()) { + this.extensions.export(environment, context.getClassName(), context.isExportForced(), context.getClassNode()); + } + + for (InvalidMixinException suppressed : context.getSuppressedExceptions()) { + this.handleMixinApplyError(context.getClassName(), suppressed, environment); + } + this.transformedCount++; - success = true; + transformed = true; } catch (InvalidMixinException th) { this.dumpClassOnFailure(name, targetClassNode, environment); this.handleMixinApplyError(name, th, environment); } + } else { + // No mixins, but still need to run postProcess stage of coprocessors + if (this.coprocessors.postProcess(name, targetClassNode)) { + transformed = true; + this.extensions.export(environment, name, false, targetClassNode); + } } } catch (MixinTransformerError er) { throw er; @@ -375,7 +395,7 @@ class MixinProcessor { this.lock.pop(); mixinTimer.end(); } - return success; + return transformed; } private String getInvalidClassError(String name, ClassNode targetClassNode, MixinConfig ownedByConfig) { @@ -440,7 +460,7 @@ class MixinProcessor { this.selectConfigs(environment); this.extensions.select(environment); - int totalMixins = this.prepareConfigs(environment); + int totalMixins = this.prepareConfigs(environment, this.extensions); this.currentEnvironment = environment; this.transformedCount = 0; @@ -493,12 +513,14 @@ class MixinProcessor { * @param environment Environment * @return total number of mixins initialised */ - private int prepareConfigs(MixinEnvironment environment) { + private int prepareConfigs(MixinEnvironment environment, Extensions extensions) { int totalMixins = 0; final IHotSwap hotSwapper = this.hotSwapper; for (MixinConfig config : this.pendingConfigs) { - config.addListener(this.postProcessor); + for (MixinCoprocessor coprocessor : this.coprocessors) { + config.addListener(coprocessor); + } if (hotSwapper != null) { config.addListener(new IListener() { @Override @@ -515,7 +537,7 @@ class MixinProcessor { for (MixinConfig config : this.pendingConfigs) { try { MixinProcessor.logger.log(this.verboseLoggingLevel, "Preparing {} ({})", config, config.getDeclaredMixinCount()); - config.prepare(); + config.prepare(extensions); totalMixins += config.getMixinCount(); } catch (InvalidMixinException ex) { this.handleMixinPrepareError(config, ex, environment); @@ -543,7 +565,7 @@ class MixinProcessor { for (MixinConfig config : this.pendingConfigs) { try { - config.postInitialise(); + config.postInitialise(this.extensions); } catch (InvalidMixinException ex) { this.handleMixinPrepareError(config, ex, environment); } catch (Exception ex) { @@ -559,37 +581,6 @@ class MixinProcessor { return totalMixins; } - /** - * Apply mixins for specified target class to the class described by the - * supplied byte array. - * - * @param environment current environment - * @param context target class context - */ - private void applyMixins(MixinEnvironment environment, TargetClassContext context) { - Section timer = this.profiler.begin("preapply"); - this.extensions.preApply(context); - timer = timer.next("apply"); - context.applyMixins(); - timer = timer.next("postapply"); - boolean export = false; - try { - this.extensions.postApply(context); - export = true; - } catch (ValidationFailedException ex) { - MixinProcessor.logger.info(ex.getMessage()); - // If verify is enabled and failed, write out the bytecode to allow us to inspect it - export |= context.isExportForced() || environment.getOption(Option.DEBUG_EXPORT); - } - timer.end(); - if (export) { - this.extensions.export(this.currentEnvironment, context.getClassName(), context.isExportForced(), context.getClassNode()); - } - for (InvalidMixinException suppressed : context.getSuppressedExceptions()) { - this.handleMixinApplyError(context.getClassName(), suppressed, environment); - } - } - private void handleMixinPrepareError(MixinConfig config, InvalidMixinException ex, MixinEnvironment environment) throws MixinPrepareError { this.handleMixinError(config.getName(), ex, environment, ErrorPhase.PREPARE); } @@ -654,7 +645,7 @@ class MixinProcessor { try { MixinProcessor.logger.info("Instancing error handler class {}", handlerClassName); Class handlerClass = this.service.getClassProvider().findClass(handlerClassName, true); - IMixinErrorHandler handler = (IMixinErrorHandler)handlerClass.newInstance(); + IMixinErrorHandler handler = (IMixinErrorHandler)handlerClass.getDeclaredConstructor().newInstance(); if (handler != null) { handlers.add(handler); } diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinTargetContext.java b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinTargetContext.java index 96767c46..2f6fb4f7 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinTargetContext.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinTargetContext.java @@ -49,6 +49,7 @@ import org.spongepowered.asm.mixin.MixinEnvironment.CompatibilityLevel; import org.spongepowered.asm.mixin.MixinEnvironment.Option; import org.spongepowered.asm.mixin.Overwrite; import org.spongepowered.asm.mixin.SoftOverride; +import org.spongepowered.asm.mixin.extensibility.IActivityContext.IActivity; import org.spongepowered.asm.mixin.extensibility.IMixinInfo; import org.spongepowered.asm.mixin.gen.AccessorInfo; import org.spongepowered.asm.mixin.injection.Inject; @@ -62,7 +63,6 @@ import org.spongepowered.asm.mixin.refmap.IReferenceMapper; import org.spongepowered.asm.mixin.struct.MemberRef; import org.spongepowered.asm.mixin.struct.SourceMap.File; import org.spongepowered.asm.mixin.throwables.ClassMetadataNotFoundException; -import org.spongepowered.asm.mixin.transformer.ActivityStack.Activity; import org.spongepowered.asm.mixin.transformer.ClassInfo.Field; import org.spongepowered.asm.mixin.transformer.ClassInfo.Method; import org.spongepowered.asm.mixin.transformer.ClassInfo.SearchType; @@ -82,7 +82,6 @@ import org.spongepowered.asm.util.asm.ASM; import org.spongepowered.asm.util.asm.ClassNodeAdapter; import com.google.common.collect.BiMap; -import com.google.common.collect.HashBiMap; /** * This object keeps track of data for applying a mixin to a specific target @@ -132,7 +131,7 @@ public class MixinTargetContext extends ClassContext implements IMixinContext { /** * */ - private final BiMap innerClasses = HashBiMap.create(); + private final BiMap innerClasses; /** * Shadow method list @@ -203,10 +202,8 @@ public class MixinTargetContext extends ClassContext implements IMixinContext { this.sessionId = context.getSessionId(); this.requireVersion(classNode.version); - InnerClassGenerator icg = context.getExtensions().getGenerator(InnerClassGenerator.class); - for (String innerClass : this.mixin.getInnerClasses()) { - this.innerClasses.put(innerClass, icg.registerInnerClass(this.mixin, innerClass, this)); - } + InnerClassGenerator icg = context.getExtensions().getGenerator(InnerClassGenerator.class); + this.innerClasses = icg.getInnerClasses(this.mixin, this.getTargetClassRef()); } /** @@ -445,7 +442,7 @@ public class MixinTargetContext extends ClassContext implements IMixinContext { this.activities.clear(); try { - Activity activity = this.activities.begin("Validate"); + IActivity activity = this.activities.begin("Validate"); this.validateMethod(method); activity.next("Transform Descriptor"); this.transformDescriptor(method); @@ -460,7 +457,7 @@ public class MixinTargetContext extends ClassContext implements IMixinContext { AbstractInsnNode lastInsn = null; for (Iterator iter = method.instructions.iterator(); iter.hasNext();) { AbstractInsnNode insn = iter.next(); - Activity insnActivity = this.activities.begin(Bytecode.getOpcodeName(insn) + " "); + IActivity insnActivity = this.activities.begin(Bytecode.getOpcodeName(insn) + " "); if (insn instanceof MethodInsnNode) { MethodInsnNode methodNode = (MethodInsnNode)insn; @@ -537,7 +534,7 @@ public class MixinTargetContext extends ClassContext implements IMixinContext { return; } - Activity localVarActivity = this.activities.begin("?"); + IActivity localVarActivity = this.activities.begin("?"); for (LocalVariableNode local : method.localVariables) { if (local == null || local.desc == null) { continue; @@ -947,7 +944,7 @@ public class MixinTargetContext extends ClassContext implements IMixinContext { } private String transformSingleDescriptor(String desc, boolean isObject) { - Activity descriptorActivity = this.activities.begin("desc=%s", desc); + IActivity descriptorActivity = this.activities.begin("desc=%s", desc); boolean isArray = false; String type = desc; while (type.startsWith("[") || type.startsWith("L")) { @@ -1217,6 +1214,13 @@ public class MixinTargetContext extends ClassContext implements IMixinContext { List getNestMembers() { return ClassNodeAdapter.getNestMembers(this.classNode); } + + /** + * Get the map of inner classes to remapped inner classes + */ + BiMap getInnerClasses() { + return this.innerClasses; + } /* (non-Javadoc) * @see org.spongepowered.asm.mixin.transformer.IReferenceMapperContext @@ -1233,7 +1237,7 @@ public class MixinTargetContext extends ClassContext implements IMixinContext { * @param transformedName Target class's transformed name * @param targetClass Target class */ - void preApply(String transformedName, ClassNode targetClass) { + void preApply(String transformedName, ClassNode targetClass) throws Exception { this.mixin.preApply(transformedName, targetClass); } @@ -1247,7 +1251,7 @@ public class MixinTargetContext extends ClassContext implements IMixinContext { this.activities.clear(); try { - Activity activity = this.activities.begin("Validating Injector Groups"); + IActivity activity = this.activities.begin("Validating Injector Groups"); this.injectorGroups.validateAll(); activity.next("Plugin Post-Application"); this.mixin.postApply(transformedName, targetClass); @@ -1300,10 +1304,10 @@ public class MixinTargetContext extends ClassContext implements IMixinContext { try { this.injectors.clear(); - Activity prepareActivity = this.activities.begin("?"); + IActivity prepareActivity = this.activities.begin("?"); for (MethodNode method : this.mergedMethods) { prepareActivity.next("%s%s", method.name, method.desc); - Activity methodActivity = this.activities.begin("Parse"); + IActivity methodActivity = this.activities.begin("Parse"); InjectionInfo injectInfo = InjectionInfo.parse(this, method); if (injectInfo == null) { continue; @@ -1337,22 +1341,22 @@ public class MixinTargetContext extends ClassContext implements IMixinContext { this.activities.clear(); try { - Activity applyActivity = this.activities.begin("PreInject"); - Activity preInjectActivity = this.activities.begin("?"); + IActivity applyActivity = this.activities.begin("PreInject"); + IActivity preInjectActivity = this.activities.begin("?"); for (InjectionInfo injectInfo : this.injectors) { preInjectActivity.next(injectInfo.toString()); injectInfo.preInject(); } applyActivity.next("Inject"); - Activity injectActivity = this.activities.begin("?"); + IActivity injectActivity = this.activities.begin("?"); for (InjectionInfo injectInfo : this.injectors) { injectActivity.next(injectInfo.toString()); injectInfo.inject(); } applyActivity.next("PostInject"); - Activity postInjectActivity = this.activities.begin("?"); + IActivity postInjectActivity = this.activities.begin("?"); for (InjectionInfo injectInfo : this.injectors) { postInjectActivity.next(injectInfo.toString()); injectInfo.postInject(); @@ -1378,22 +1382,22 @@ public class MixinTargetContext extends ClassContext implements IMixinContext { List methods = new ArrayList(); try { - Activity accessorActivity = this.activities.begin("Locate"); - Activity locateActivity = this.activities.begin("?"); + IActivity accessorActivity = this.activities.begin("Locate"); + IActivity locateActivity = this.activities.begin("?"); for (AccessorInfo accessor : this.accessors) { locateActivity.next(accessor.toString()); accessor.locate(); } accessorActivity.next("Validate"); - Activity validateActivity = this.activities.begin("?"); + IActivity validateActivity = this.activities.begin("?"); for (AccessorInfo accessor : this.accessors) { validateActivity.next(accessor.toString()); accessor.validate(); } accessorActivity.next("Generate"); - Activity generateActivity = this.activities.begin("?"); + IActivity generateActivity = this.activities.begin("?"); for (AccessorInfo accessor : this.accessors) { generateActivity.next(accessor.toString()); MethodNode generated = accessor.generate(); diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinTransformer.java b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinTransformer.java index f65908ea..c6bde16d 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinTransformer.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinTransformer.java @@ -76,6 +76,12 @@ final class MixinTransformer extends TreeTransformer implements IMixinTransforme * Hotswap agent, if available */ private final IHotSwap hotSwapper; + + /** + * Coprocessor which handles merging nest members into nest hosts which may + * or may not be mixin targets themselves + */ + private final MixinCoprocessorNestHost nestHostCoprocessor; /** * Mixin processor which actually manages application of mixins @@ -102,11 +108,12 @@ final class MixinTransformer extends TreeTransformer implements IMixinTransforme this.extensions = new Extensions(this.syntheticClassRegistry); this.hotSwapper = this.initHotSwapper(environment); + this.nestHostCoprocessor = new MixinCoprocessorNestHost(); - this.processor = new MixinProcessor(environment, this.extensions, this.hotSwapper); + this.processor = new MixinProcessor(environment, this.extensions, this.hotSwapper, this.nestHostCoprocessor); this.generator = new MixinClassGenerator(environment, this.extensions); - DefaultExtensions.create(environment, this.extensions, this.syntheticClassRegistry); + DefaultExtensions.create(environment, this.extensions, this.syntheticClassRegistry, this.nestHostCoprocessor); } private IHotSwap initHotSwapper(MixinEnvironment environment) { diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/PluginHandle.java b/src/main/java/org/spongepowered/asm/mixin/transformer/PluginHandle.java index 3a8ef03b..47356e73 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/PluginHandle.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/PluginHandle.java @@ -135,7 +135,7 @@ class PluginHandle { /** * Called immediately before the mixin is applied to targetClass */ - public void preApply(String targetClassName, ClassNode targetClass, String mixinClassName, MixinInfo mixinInfo) { + public void preApply(String targetClassName, ClassNode targetClass, String mixinClassName, MixinInfo mixinInfo) throws Exception { if (this.plugin == null) { return; } @@ -166,7 +166,7 @@ class PluginHandle { /** * Called immediately after the mixin is applied to targetClass */ - public void postApply(String targetClassName, ClassNode targetClass, String mixinClassName, MixinInfo mixinInfo) { + public void postApply(String targetClassName, ClassNode targetClass, String mixinClassName, MixinInfo mixinInfo) throws Exception { if (this.plugin == null) { return; } diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/TargetClassContext.java b/src/main/java/org/spongepowered/asm/mixin/transformer/TargetClassContext.java index be9ea134..a1a6965d 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/TargetClassContext.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/TargetClassContext.java @@ -46,10 +46,13 @@ import org.spongepowered.asm.mixin.injection.struct.Target; import org.spongepowered.asm.mixin.struct.SourceMap; import org.spongepowered.asm.mixin.transformer.ext.Extensions; import org.spongepowered.asm.mixin.transformer.ext.ITargetClassContext; +import org.spongepowered.asm.mixin.transformer.ext.extensions.ExtensionCheckClass.ValidationFailedException; import org.spongepowered.asm.mixin.transformer.throwables.InvalidMixinException; import org.spongepowered.asm.util.Annotations; import org.spongepowered.asm.util.Bytecode; import org.spongepowered.asm.util.ClassSignature; +import org.spongepowered.asm.util.perf.Profiler; +import org.spongepowered.asm.util.perf.Profiler.Section; /** * Struct for containing target class information during mixin application @@ -70,6 +73,11 @@ final class TargetClassContext extends ClassContext implements ITargetClassConte * Mixin transformer extensions */ private final Extensions extensions; + + /** + * Profiler + */ + private final Profiler profiler; /** * Transformer session ID @@ -130,15 +138,22 @@ final class TargetClassContext extends ClassContext implements ITargetClassConte */ private boolean applied; + /** + * True if this class is eligible for export. That is, it was successfully + * applied or if validation failed and export is enabled. + */ + private boolean export; + /** * True if this class is decorated with an {@link Debug} annotation which * instructs an export */ private boolean forceExport; - + TargetClassContext(MixinEnvironment env, Extensions extensions, String sessionId, String name, ClassNode classNode, SortedSet mixins) { this.env = env; this.extensions = extensions; + this.profiler = MixinEnvironment.getProfiler(); this.sessionId = sessionId; this.className = name; this.classNode = classNode; @@ -158,6 +173,10 @@ final class TargetClassContext extends ClassContext implements ITargetClassConte return this.applied; } + boolean isExported() { + return this.export; + } + boolean isExportForced() { return this.forceExport; } @@ -331,22 +350,55 @@ final class TargetClassContext extends ClassContext implements ITargetClassConte } return target; } - + /** - * Apply mixins to this class + * Apply mixins for this target class */ void applyMixins() { if (this.applied) { throw new IllegalStateException("Mixins already applied to target class " + this.className); } this.applied = true; - + Section timer = this.profiler.begin("preapply"); + this.preApply(); + timer = timer.next("apply"); + this.apply(); + timer = timer.next("postapply"); + this.postApply(); + timer.end(); + } + + /** + * Run extensions before apply + */ + private void preApply() { + this.extensions.preApply(this); + } + + /** + * Apply mixins to this class + */ + private void apply() { MixinApplicatorStandard applicator = this.createApplicator(); applicator.apply(this.mixins); this.applySignature(); this.upgradeMethods(); this.checkMerges(); } + + /** + * Run extensions after apply + */ + private void postApply() { + try { + this.extensions.postApply(this); + this.export = true; + } catch (ValidationFailedException ex) { + MixinProcessor.logger.info(ex.getMessage()); + // If verify is enabled and failed, write out the bytecode to allow us to inspect it + this.export |= this.forceExport || this.env.getOption(Option.DEBUG_EXPORT); + } + } private MixinApplicatorStandard createApplicator() { if (this.classInfo.isInterface()) { diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/throwables/InvalidMixinException.java b/src/main/java/org/spongepowered/asm/mixin/transformer/throwables/InvalidMixinException.java index ab996e9c..ddb3a533 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/throwables/InvalidMixinException.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/throwables/InvalidMixinException.java @@ -24,10 +24,10 @@ */ package org.spongepowered.asm.mixin.transformer.throwables; +import org.spongepowered.asm.mixin.extensibility.IActivityContext; import org.spongepowered.asm.mixin.extensibility.IMixinInfo; import org.spongepowered.asm.mixin.refmap.IMixinContext; import org.spongepowered.asm.mixin.throwables.MixinException; -import org.spongepowered.asm.mixin.transformer.ActivityStack; /** * Thrown by the mixin validator when a mixin fails a pre-flight check @@ -43,7 +43,7 @@ public class InvalidMixinException extends MixinException { this.mixin = mixin; } - public InvalidMixinException(IMixinInfo mixin, String message, ActivityStack activityContext) { + public InvalidMixinException(IMixinInfo mixin, String message, IActivityContext activityContext) { super(message, activityContext); this.mixin = mixin; } @@ -52,7 +52,7 @@ public class InvalidMixinException extends MixinException { this(context.getMixin(), message); } - public InvalidMixinException(IMixinContext context, String message, ActivityStack activityContext) { + public InvalidMixinException(IMixinContext context, String message, IActivityContext activityContext) { this(context.getMixin(), message, activityContext); } @@ -61,7 +61,7 @@ public class InvalidMixinException extends MixinException { this.mixin = mixin; } - public InvalidMixinException(IMixinInfo mixin, Throwable cause, ActivityStack activityContext) { + public InvalidMixinException(IMixinInfo mixin, Throwable cause, IActivityContext activityContext) { super(cause, activityContext); this.mixin = mixin; } @@ -70,7 +70,7 @@ public class InvalidMixinException extends MixinException { this(context.getMixin(), cause); } - public InvalidMixinException(IMixinContext context, Throwable cause, ActivityStack activityContext) { + public InvalidMixinException(IMixinContext context, Throwable cause, IActivityContext activityContext) { this(context.getMixin(), cause, activityContext); } @@ -79,7 +79,7 @@ public class InvalidMixinException extends MixinException { this.mixin = mixin; } - public InvalidMixinException(IMixinInfo mixin, String message, Throwable cause, ActivityStack activityContext) { + public InvalidMixinException(IMixinInfo mixin, String message, Throwable cause, IActivityContext activityContext) { super(message, cause, activityContext); this.mixin = mixin; } @@ -89,7 +89,7 @@ public class InvalidMixinException extends MixinException { this.mixin = context.getMixin(); } - public InvalidMixinException(IMixinContext context, String message, Throwable cause, ActivityStack activityContext) { + public InvalidMixinException(IMixinContext context, String message, Throwable cause, IActivityContext activityContext) { super(message, cause, activityContext); this.mixin = context.getMixin(); } diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/throwables/MixinApplicatorException.java b/src/main/java/org/spongepowered/asm/mixin/transformer/throwables/MixinApplicatorException.java index 98e5f0ae..925583d0 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/throwables/MixinApplicatorException.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/throwables/MixinApplicatorException.java @@ -24,6 +24,7 @@ */ package org.spongepowered.asm.mixin.transformer.throwables; +import org.spongepowered.asm.mixin.extensibility.IActivityContext; import org.spongepowered.asm.mixin.extensibility.IMixinInfo; import org.spongepowered.asm.mixin.refmap.IMixinContext; import org.spongepowered.asm.mixin.transformer.ActivityStack; @@ -39,7 +40,7 @@ public class MixinApplicatorException extends InvalidMixinException { super(context, message, (ActivityStack)null); } - public MixinApplicatorException(IMixinInfo context, String message, ActivityStack activityContext) { + public MixinApplicatorException(IMixinInfo context, String message, IActivityContext activityContext) { super(context, message, activityContext); } @@ -47,7 +48,7 @@ public class MixinApplicatorException extends InvalidMixinException { super(context, message, (ActivityStack)null); } - public MixinApplicatorException(IMixinContext context, String message, ActivityStack activityContext) { + public MixinApplicatorException(IMixinContext context, String message, IActivityContext activityContext) { super(context, message, activityContext); } @@ -55,7 +56,7 @@ public class MixinApplicatorException extends InvalidMixinException { super(mixin, message, cause, (ActivityStack)null); } - public MixinApplicatorException(IMixinInfo mixin, String message, Throwable cause, ActivityStack activityContext) { + public MixinApplicatorException(IMixinInfo mixin, String message, Throwable cause, IActivityContext activityContext) { super(mixin, message, cause, activityContext); } @@ -63,7 +64,7 @@ public class MixinApplicatorException extends InvalidMixinException { super(mixin, message, cause, (ActivityStack)null); } - public MixinApplicatorException(IMixinContext mixin, String message, Throwable cause, ActivityStack activityContext) { + public MixinApplicatorException(IMixinContext mixin, String message, Throwable cause, IActivityContext activityContext) { super(mixin, message, cause, activityContext); } @@ -71,7 +72,7 @@ public class MixinApplicatorException extends InvalidMixinException { super(mixin, cause, (ActivityStack)null); } - public MixinApplicatorException(IMixinInfo mixin, Throwable cause, ActivityStack activityContext) { + public MixinApplicatorException(IMixinInfo mixin, Throwable cause, IActivityContext activityContext) { super(mixin, cause, activityContext); } @@ -79,7 +80,7 @@ public class MixinApplicatorException extends InvalidMixinException { super(mixin, cause, (ActivityStack)null); } - public MixinApplicatorException(IMixinContext mixin, Throwable cause, ActivityStack activityContext) { + public MixinApplicatorException(IMixinContext mixin, Throwable cause, IActivityContext activityContext) { super(mixin, cause, activityContext); } diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/throwables/MixinPreProcessorException.java b/src/main/java/org/spongepowered/asm/mixin/transformer/throwables/MixinPreProcessorException.java index 04aa972d..cdcc2eda 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/throwables/MixinPreProcessorException.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/throwables/MixinPreProcessorException.java @@ -24,8 +24,8 @@ */ package org.spongepowered.asm.mixin.transformer.throwables; +import org.spongepowered.asm.mixin.extensibility.IActivityContext; import org.spongepowered.asm.mixin.throwables.MixinException; -import org.spongepowered.asm.mixin.transformer.ActivityStack; /** * Exception indicating a problem during pre-processing @@ -34,11 +34,11 @@ public class MixinPreProcessorException extends MixinException { private static final long serialVersionUID = 1L; - public MixinPreProcessorException(String message, ActivityStack context) { + public MixinPreProcessorException(String message, IActivityContext context) { super(message, context); } - public MixinPreProcessorException(String message, Throwable cause, ActivityStack context) { + public MixinPreProcessorException(String message, Throwable cause, IActivityContext context) { super(message, cause, context); } diff --git a/src/main/java/org/spongepowered/asm/util/JavaVersion.java b/src/main/java/org/spongepowered/asm/util/JavaVersion.java index 83731a81..1197d121 100644 --- a/src/main/java/org/spongepowered/asm/util/JavaVersion.java +++ b/src/main/java/org/spongepowered/asm/util/JavaVersion.java @@ -32,6 +32,71 @@ import java.util.regex.Pattern; */ public abstract class JavaVersion { + /** + * Version number for Java 6 + */ + public static final double JAVA_6 = 1.6; + + /** + * Version number for Java 7 + */ + public static final double JAVA_7 = 1.7; + + /** + * Version number for Java 8 + */ + public static final double JAVA_8 = 1.8; + + /** + * Version number for Java 9 + */ + public static final double JAVA_9 = 9.0; + + /** + * Version number for Java 10 + */ + public static final double JAVA_10 = 10.0; + + /** + * Version number for Java 11 + */ + public static final double JAVA_11 = 11.0; + + /** + * Version number for Java 12 + */ + public static final double JAVA_12 = 12.0; + + /** + * Version number for Java 13 + */ + public static final double JAVA_13 = 13.0; + + /** + * Version number for Java 14 + */ + public static final double JAVA_14 = 14.0; + + /** + * Version number for Java 15 + */ + public static final double JAVA_15 = 15.0; + + /** + * Version number for Java 16 + */ + public static final double JAVA_16 = 16.0; + + /** + * Version number for Java 17 + */ + public static final double JAVA_17 = 17.0; + + /** + * Version number for Java 18 + */ + public static final double JAVA_18 = 18.0; + private static double current = 0.0; private JavaVersion() {} diff --git a/src/main/java/org/spongepowered/asm/util/LanguageFeatures.java b/src/main/java/org/spongepowered/asm/util/LanguageFeatures.java index ca39785c..4044d865 100644 --- a/src/main/java/org/spongepowered/asm/util/LanguageFeatures.java +++ b/src/main/java/org/spongepowered/asm/util/LanguageFeatures.java @@ -69,6 +69,16 @@ public final class LanguageFeatures { */ public static final int DYNAMIC_CONSTANTS = 16; + /** + * Record types + */ + public static final int RECORDS = 32; + + /** + * Sealed classes (permitted subclasses) + */ + public static final int SEALED_CLASSES = 64; + /** * Utility class */ diff --git a/src/main/java/org/spongepowered/asm/util/Locals.java b/src/main/java/org/spongepowered/asm/util/Locals.java index 116fc122..3de97708 100644 --- a/src/main/java/org/spongepowered/asm/util/Locals.java +++ b/src/main/java/org/spongepowered/asm/util/Locals.java @@ -25,6 +25,7 @@ package org.spongepowered.asm.util; import java.util.ArrayList; +import java.util.Collections; import java.util.HashMap; import java.util.Iterator; import java.util.List; @@ -68,6 +69,192 @@ public final class Locals { } + /** + * A local variable entry which is "dead" (has been removed from the known + * frame) but is being retained in the computed frame as a ghost so that we + * can decide whether we want to include it in the final frame or not. + * + *

    Zombie nodes are currently only persisted for 1 instruction, so in the + * cases where there is a frame node followed directly by the candidate insn + * the zombies will be returned as valid results, but otherwise culled.

    + */ + static class ZombieLocalVariableNode extends LocalVariableNode { + + static final char CHOP = 'C'; + static final char TRIM = 'X'; + + /** + * Progenitor of this zombie, to allow "resurrection" (am I stretching + * this metaphor too far?) + */ + final LocalVariableNode ancestor; + + final char type; + + /** + * Number of instructions the zombie has "lived" for, incremented by the + * state machine loop + */ + int lifetime; + + /** + * Number of frames which have elapsed for this zombie, incremented by + * the state machine loop when a frame node is encountered + */ + int frames; + + ZombieLocalVariableNode(LocalVariableNode ancestor, char type) { + super(ancestor.name, ancestor.desc, ancestor.signature, ancestor.start, ancestor.end, ancestor.index); + this.ancestor = ancestor; + this.type = type; + } + + boolean checkResurrect(Settings settings) { + int insnThreshold = this.type == ZombieLocalVariableNode.CHOP ? settings.choppedInsnThreshold : settings.trimmedInsnThreshold; + if (insnThreshold > -1 && this.lifetime > insnThreshold) { + return false; + } + int frameThreshold = this.type == ZombieLocalVariableNode.CHOP ? settings.choppedFrameThreshold : settings.trimmedFrameThreshold; + return frameThreshold == -1 || this.frames <= frameThreshold; + } + + static ZombieLocalVariableNode of(LocalVariableNode ancestor, char type) { + if (ancestor instanceof ZombieLocalVariableNode) { + return (ZombieLocalVariableNode)ancestor; + } + return ancestor != null ? new ZombieLocalVariableNode(ancestor, type) : null; + } + + @Override + public String toString() { + return String.format("Z(%s,%-2d)", this.type, this.lifetime); + } + + } + + /** + * Settings for getLocalsAt containing the tunable options for the + * algorithm. This exists for two purposes: Firstly, wrapping tunables up in + * a single object for convenience, but secondly providing some level of + * forward compatibility for platforms that which to provide backward + * compatibility to their own consumers. The {@link #flagsCustom} + * field is* provided as a way of encoding arbitrary options that downstream + * projects may wish to use to tune their own implementations. The {@link + * #flags} field is reserved for mixin internal flags to be added at a later + * date. + */ + public static class Settings { + + /** + * When an incoming frame contains TOP entries, these are nearly always + * bogus. If we previously knew the local in that slot, resurrect it. + * Only resurrects TRIM zombies. + */ + public static int RESURRECT_FOR_BOGUS_TOP = 0x01; + + /** + * When a LOAD grows the frame, resurrect any zombies in the exposed + * portion of the frame, based on the thresholds configured. + */ + public static int RESURRECT_EXPOSED_ON_LOAD = 0x02; + + /** + * When a STORE grows the frame, resurrect any zombies in the exposed + * portion of the frame, based on the thresholds configured. + */ + public static int RESURRECT_EXPOSED_ON_STORE = 0x04; + + /** + * Default flags + */ + public static int DEFAULT_FLAGS = Settings.RESURRECT_FOR_BOGUS_TOP | Settings.RESURRECT_EXPOSED_ON_LOAD | Settings.RESURRECT_EXPOSED_ON_STORE; + + /** + * Default settings. CHOP zombies can be resurrected for 1 frame, TRIM + * zombies can be resurrected forever + */ + public static Settings DEFAULT = new Settings(Settings.DEFAULT_FLAGS, 0, -1, 1, -1, -1); + + /** + * Reserved flags for Mixin + */ + final int flags; + + /** + * Platform-specific flags + */ + final int flagsCustom; + + /** + * Number of instructions that a CHOPped local is eligible for + * resurrection, -1 to ignore, 0 for none + */ + final int choppedInsnThreshold; + + /** + * Number of frames that a CHOPped local is eligible for resurrection, + * -1 to ignore, 0 for none + */ + final int choppedFrameThreshold; + + /** + * Number of instructions that a TRIMmed local is eligible for + * resurrection, -1 to ignore, 0 for none + */ + final int trimmedInsnThreshold; + + /** + * Number of frames that a TRIMmed local is eligible for resurrection, + * -1 to ignore, 0 for none + */ + final int trimmedFrameThreshold; + + /** + * @param flags Mixin flags + * @param flagsCustom Platform-specific flags + * @param insnThreshold Number of instructions that a local (regardless + * of death reason) is eligible for resurrection, -1 to ignore, + * 0 for none + * @param frameThreshold Number of frames that a local (regardless of + * death reason) is eligible for resurrection,-1 to ignore, 0 for + * none + */ + public Settings(int flags, int flagsCustom, int insnThreshold, int frameThreshold) { + this(flags, flagsCustom, insnThreshold, frameThreshold, insnThreshold, frameThreshold); + } + + /** + * @param flags Mixin flags + * @param flagsCustom Platform-specific flags + * @param choppedInsnThreshold Number of instructions that a CHOPped + * local is eligible for resurrection, -1 to ignore, 0 for none + * @param choppedFrameThreshold Number of frames that a CHOPped local is + * eligible for resurrection,-1 to ignore, 0 for none + * @param trimmedInsnThreshold Number of instructions that a TRIMmed# + * local is eligible for resurrection, -1 to ignore, 0 for none + * @param trimmedFrameThreshold Number of frames that a TRIMmed local is + * eligible for resurrection, -1 to ignore, 0 for none + */ + public Settings(int flags, int flagsCustom, int choppedInsnThreshold, int choppedFrameThreshold, int trimmedInsnThreshold, + int trimmedFrameThreshold) { + this.flags = flags; + this.flagsCustom = flagsCustom; + this.choppedInsnThreshold = choppedInsnThreshold; + this.choppedFrameThreshold = choppedFrameThreshold; + this.trimmedInsnThreshold = trimmedInsnThreshold; + this.trimmedFrameThreshold = trimmedFrameThreshold; + } + + boolean hasFlags(int flags) { + return (this.flags & flags) == flags; + } + + boolean hasCustomFlags(int flagsCustom) { + return (this.flagsCustom & flagsCustom) == flagsCustom; + } + + } + /** * Frame type names just for the purposes of debug printing */ @@ -145,6 +332,53 @@ public final class Locals { * specified location */ public static LocalVariableNode[] getLocalsAt(ClassNode classNode, MethodNode method, AbstractInsnNode node) { + return Locals.getLocalsAt(classNode, method, node, Settings.DEFAULT); + } + + /** + *

    Attempts to identify available locals at an arbitrary point in the + * bytecode specified by node.

    + * + *

    This method builds an approximate view of the locals available at an + * arbitrary point in the bytecode by examining the following features in + * the bytecode:

    + *
      + *
    • Any available stack map frames
    • + *
    • STORE opcodes
    • + *
    • The local variable table
    • + *
    + * + *

    Inference proceeds by walking the bytecode from the start of the + * method looking for stack frames and STORE opcodes. When either of these + * is encountered, an attempt is made to cross-reference the values in the + * stack map or STORE opcode with the value in the local variable table + * which covers the code range. Stack map frames overwrite the entire + * simulated local variable table with their own value types, STORE opcodes + * overwrite only the local slot to which they pertain. Values in the + * simulated locals array are spaced according to their size (unlike the + * representation in FrameNode) and this TOP, NULL and UNINTITIALIZED_THIS + * opcodes will be represented as null values in the simulated frame.

    + * + *

    This code does not currently simulate the prescribed JVM behaviour + * where overwriting the second slot of a DOUBLE or LONG actually + * invalidates the DOUBLE or LONG stored in the previous location, so we + * have to hope (for now) that this behaviour isn't emitted by the compiler + * or any upstream transformers. I may have to re-think this strategy if + * this situation is encountered in the wild.

    + * + * @param classNode ClassNode containing the method, used to initialise the + * implicit "this" reference in simple methods with no stack frames + * @param method MethodNode to explore + * @param node Node indicating the position at which to determine the locals + * state. The locals will be enumerated UP TO the specified node, so + * bear in mind that if the specified node is itself a STORE opcode, + * then we will be looking at the state of the locals PRIOR to its + * invocation + * @param settings Tunable settings for the state machine + * @return A sparse array containing a view (hopefully) of the locals at the + * specified location + */ + public static LocalVariableNode[] getLocalsAt(ClassNode classNode, MethodNode method, AbstractInsnNode node, Settings settings) { for (int i = 0; i < 3 && (node instanceof LabelNode || node instanceof LineNumberNode); i++) { AbstractInsnNode nextNode = Locals.nextNode(method.instructions, node); if (nextNode instanceof FrameNode) { // Do not ffwd over frames @@ -177,7 +411,7 @@ public final class Locals { local += argType.getSize(); } - int initialFrameSize = local; + final int initialFrameSize = local; int frameSize = local; int frameIndex = -1; int lastFrameSize = local; @@ -186,6 +420,18 @@ public final class Locals { for (Iterator iter = method.instructions.iterator(); iter.hasNext();) { AbstractInsnNode insn = iter.next(); + + // Tick the zombies + for (int l = 0; l < frame.length; l++) { + if (frame[l] instanceof ZombieLocalVariableNode) { + ZombieLocalVariableNode zombie = (ZombieLocalVariableNode)frame[l]; + zombie.lifetime++; + if (insn instanceof FrameNode) { + zombie.frames++; + } + } + } + if (storeInsn != null) { LocalVariableNode storedLocal = Locals.getLocalVariableAt(classNode, method, insn, storeInsn.var); frame[storeInsn.var] = storedLocal; @@ -194,6 +440,9 @@ public final class Locals { && Type.getType(storedLocal.desc).getSize() == 2) { frame[storeInsn.var + 1] = null; // TOP knownFrameSize = Math.max(knownFrameSize, storeInsn.var + 2); + if (settings.hasFlags(Settings.RESURRECT_EXPOSED_ON_STORE)) { + Locals.resurrect(frame, knownFrameSize, settings); + } } storeInsn = null; } @@ -205,21 +454,21 @@ public final class Locals { break handleFrame; } - int frameNodeSize = Locals.computeFrameSize(frameNode); + int frameNodeSize = Locals.computeFrameSize(frameNode, initialFrameSize); FrameData frameData = frameIndex < frames.size() ? frames.get(frameIndex) : null; if (frameData != null) { if (frameData.type == Opcodes.F_FULL) { - knownFrameSize = lastFrameSize = frameSize = Math.min(frameNodeSize, frameData.size); + knownFrameSize = lastFrameSize = frameSize = Math.max(initialFrameSize, Math.min(frameNodeSize, frameData.size)); } else { - frameSize = Locals.getAdjustedFrameSize(frameSize, frameData); + frameSize = Locals.getAdjustedFrameSize(frameSize, frameData, initialFrameSize); } } else { - frameSize = Locals.getAdjustedFrameSize(frameSize, frameNode); + frameSize = Locals.getAdjustedFrameSize(frameSize, frameNode, initialFrameSize); } // Sanity check - if (frameSize < 0) { + if (frameSize < initialFrameSize) { throw new IllegalStateException(String.format("Locals entered an invalid state evaluating %s::%s%s at instruction %d (%s). " + "Initial frame size is %d, calculated a frame size of %d with %s", classNode.name, method.name, method.desc, method.instructions.indexOf(insn), Bytecode.describeNode(insn, false), initialFrameSize, frameSize, frameData)); @@ -228,7 +477,7 @@ public final class Locals { if ((frameData == null && (frameNode.type == Opcodes.F_CHOP || frameNode.type == Opcodes.F_NEW)) || (frameData != null && frameData.type == Opcodes.F_CHOP)) { for (int framePos = frameSize; framePos < frame.length; framePos++) { - frame[framePos] = null; + frame[framePos] = ZombieLocalVariableNode.of(frame[framePos], ZombieLocalVariableNode.CHOP); } knownFrameSize = lastFrameSize = frameSize; break handleFrame; @@ -249,7 +498,14 @@ public final class Locals { boolean is32bitValue = localType == Opcodes.INTEGER || localType == Opcodes.FLOAT; boolean is64bitValue = localType == Opcodes.DOUBLE || localType == Opcodes.LONG; if (localType == Opcodes.TOP) { - // Do nothing, explicit TOP entries are pretty much always bogus, and real ones are handled below + // Explicit TOP entries are pretty much always bogus, but depending on our resurrection + // strategy we may want to resurrect eligible zombies here. Real TOP entries are handled below + if (frame[framePos] instanceof ZombieLocalVariableNode && settings.hasFlags(Settings.RESURRECT_FOR_BOGUS_TOP)) { + ZombieLocalVariableNode zombie = (ZombieLocalVariableNode)frame[framePos]; + if (zombie.type == ZombieLocalVariableNode.TRIM) { + frame[framePos] = zombie.ancestor; + } + } } else if (isMarkerType) { frame[framePos] = null; } else if (is32bitValue || is64bitValue) { @@ -268,7 +524,7 @@ public final class Locals { if (framePos < knownFrameSize) { frame[framePos] = Locals.getLocalVariableAt(classNode, method, insn, framePos); } else { - frame[framePos] = null; + frame[framePos] = ZombieLocalVariableNode.of(frame[framePos], ZombieLocalVariableNode.TRIM); } } } else if (localType instanceof LabelNode) { @@ -279,17 +535,20 @@ public final class Locals { } } } else if (insn instanceof VarInsnNode) { - VarInsnNode varNode = (VarInsnNode) insn; + VarInsnNode varInsn = (VarInsnNode)insn; boolean isLoad = insn.getOpcode() >= Opcodes.ILOAD && insn.getOpcode() <= Opcodes.SALOAD; if (isLoad) { - frame[varNode.var] = Locals.getLocalVariableAt(classNode, method, insn, varNode.var); - int varSize = frame[varNode.var].desc != null ? Type.getType(frame[varNode.var].desc).getSize() : 1; - knownFrameSize = Math.max(knownFrameSize, varNode.var + varSize); + frame[varInsn.var] = Locals.getLocalVariableAt(classNode, method, insn, varInsn.var); + int varSize = frame[varInsn.var].desc != null ? Type.getType(frame[varInsn.var].desc).getSize() : 1; + knownFrameSize = Math.max(knownFrameSize, varInsn.var + varSize); + if (settings.hasFlags(Settings.RESURRECT_EXPOSED_ON_LOAD)) { + Locals.resurrect(frame, knownFrameSize, settings); + } } else { // Update the LVT for the opcode AFTER this one, since we always want to know // the frame state BEFORE the *current* instruction to match the contract of // injection points - storeInsn = varNode; + storeInsn = varInsn; } } @@ -297,10 +556,18 @@ public final class Locals { break; } } - + // Null out any "unknown" or mixin-provided locals for (int l = 0; l < frame.length; l++) { - if (frame[l] != null && frame[l].desc == null || frame[l] instanceof SyntheticLocalVariableNode) { + if (frame[l] instanceof ZombieLocalVariableNode) { + ZombieLocalVariableNode zombie = (ZombieLocalVariableNode)frame[l]; + // preserve zombies where the frame node which culled them was immediately prior to + // the matched instruction, or *was itself* the matched instruction, the returned + // frame will contain the original node (the zombie ancestor) + frame[l] = (zombie.lifetime > 1) ? null : zombie.ancestor; + } + + if ((frame[l] != null && frame[l].desc == null) || frame[l] instanceof SyntheticLocalVariableNode) { frame[l] = null; } } @@ -308,6 +575,25 @@ public final class Locals { return frame; } + /** + * Walks the supplied frame up to the specified knownFrameSize + * and resurrects any zombies that meet the required criteria + * + * @param frame Frame to walk + * @param knownFrameSize Known frame size in which to resurrect + * @param settings Resurrection settings + */ + private static void resurrect(LocalVariableNode[] frame, int knownFrameSize, Settings settings) { + for (int l = 0; l < knownFrameSize && l < frame.length; l++) { + if (frame[l] instanceof ZombieLocalVariableNode) { + ZombieLocalVariableNode zombie = (ZombieLocalVariableNode)frame[l]; + if (zombie.checkResurrect(settings)) { + frame[l] = zombie.ancestor; + } + } + } + } + /** * Attempts to locate the appropriate entry in the local variable table for * the specified local variable index at the location specified by node. @@ -380,7 +666,7 @@ public final class Locals { if (method.localVariables.isEmpty()) { return Locals.getGeneratedLocalVariableTable(classNode, method); } - return method.localVariables; + return Collections.unmodifiableList(method.localVariables); } /** @@ -399,7 +685,7 @@ public final class Locals { localVars = Locals.generateLocalVariableTable(classNode, method); Locals.calculatedLocalVariables.put(methodId, localVars); - return localVars; + return Collections.unmodifiableList(localVars); } /** @@ -548,10 +834,11 @@ public final class Locals { * * @param currentSize current frame size * @param frameNode frame entry + * @param initialFrameSize Method initial frame size * @return new frame size */ - private static int getAdjustedFrameSize(int currentSize, FrameNode frameNode) { - return Locals.getAdjustedFrameSize(currentSize, frameNode.type, Locals.computeFrameSize(frameNode)); + private static int getAdjustedFrameSize(int currentSize, FrameNode frameNode, int initialFrameSize) { + return Locals.getAdjustedFrameSize(currentSize, frameNode.type, Locals.computeFrameSize(frameNode, initialFrameSize), initialFrameSize); } /** @@ -561,10 +848,11 @@ public final class Locals { * * @param currentSize current frame size * @param frameData frame entry + * @param initialFrameSize Method initial frame size * @return new frame size */ - private static int getAdjustedFrameSize(int currentSize, FrameData frameData) { - return Locals.getAdjustedFrameSize(currentSize, frameData.type, frameData.size); + private static int getAdjustedFrameSize(int currentSize, FrameData frameData, int initialFrameSize) { + return Locals.getAdjustedFrameSize(currentSize, frameData.type, frameData.size, initialFrameSize); } /** @@ -575,17 +863,18 @@ public final class Locals { * @param currentSize current frame size * @param type frame entry type * @param size frame entry size + * @param initialFrameSize Method initial frame size * @return new frame size */ - private static int getAdjustedFrameSize(int currentSize, int type, int size) { + private static int getAdjustedFrameSize(int currentSize, int type, int size, int initialFrameSize) { switch (type) { case Opcodes.F_NEW: case Opcodes.F_FULL: - return size; + return Math.max(initialFrameSize, size); case Opcodes.F_APPEND: return currentSize + size; case Opcodes.F_CHOP: - return currentSize - size; + return Math.max(initialFrameSize, currentSize - size); case Opcodes.F_SAME: case Opcodes.F_SAME1: return currentSize; @@ -599,11 +888,12 @@ public final class Locals { * supplied frame node * * @param frameNode frame node with locals to compute + * @param initialFrameSize Method initial frame size * @return size of frame node locals */ - public static int computeFrameSize(FrameNode frameNode) { + public static int computeFrameSize(FrameNode frameNode, int initialFrameSize) { if (frameNode.local == null) { - return 0; + return initialFrameSize; } int size = 0; for (Object local : frameNode.local) { @@ -613,7 +903,7 @@ public final class Locals { size++; } } - return size; + return Math.max(initialFrameSize, size); } /** diff --git a/src/main/java/org/spongepowered/asm/util/SignaturePrinter.java b/src/main/java/org/spongepowered/asm/util/SignaturePrinter.java index 303a8513..8e64ae98 100644 --- a/src/main/java/org/spongepowered/asm/util/SignaturePrinter.java +++ b/src/main/java/org/spongepowered/asm/util/SignaturePrinter.java @@ -125,10 +125,6 @@ public class SignaturePrinter { this.returnType = returnType; this.argTypes = argTypes; this.argNames = argNames; - if (this.argTypes.length > this.argNames.length) { - throw new IllegalArgumentException(String.format("Types array length must not exceed names array length! (names=%d, types=%d)", - this.argNames.length, this.argTypes.length)); - } } /** @@ -225,7 +221,8 @@ public class SignaturePrinter { } } try { - String name = typesOnly ? null : Strings.isNullOrEmpty(this.argNames[var]) ? "unnamed" + var : this.argNames[var]; + String name = typesOnly ? null : var < this.argNames.length && !Strings.isNullOrEmpty(this.argNames[var]) + ? this.argNames[var] : "unnamed" + var; this.appendType(sb, this.argTypes[var], name); } catch (Exception ex) { // System.err.printf("\n\n>>> argTypes=%d, argNames=%d\n\n", this.argTypes.length, this.argNames.length); diff --git a/src/main/java/org/spongepowered/asm/util/VersionNumber.java b/src/main/java/org/spongepowered/asm/util/VersionNumber.java index 9cd9e4e1..d764dd36 100644 --- a/src/main/java/org/spongepowered/asm/util/VersionNumber.java +++ b/src/main/java/org/spongepowered/asm/util/VersionNumber.java @@ -83,6 +83,41 @@ public final class VersionNumber implements Comparable, Serializa this.suffix = suffix != null ? suffix : ""; } + /** + * Get the major version from this version number + */ + public short getMajor() { + return (short)(this.value >> 48); + } + + /** + * Get the minor version from this version number + */ + public short getMinor() { + return (short)(this.value >> 32 & Short.MAX_VALUE); + } + + /** + * Get the patch from this version number + */ + public short getPatch() { + return (short)(this.value >> 16 & Short.MAX_VALUE); + } + + /** + * Get the revision from this version number + */ + public short getRevision() { + return (short)(this.value & Short.MAX_VALUE); + } + + /** + * Get the suffix from this version + */ + public String getSuffix() { + return this.suffix; + } + /* (non-Javadoc) * @see java.lang.Object#toString() */ diff --git a/src/main/java/org/spongepowered/asm/util/asm/ASM.java b/src/main/java/org/spongepowered/asm/util/asm/ASM.java index 87d38f6d..56026180 100644 --- a/src/main/java/org/spongepowered/asm/util/asm/ASM.java +++ b/src/main/java/org/spongepowered/asm/util/asm/ASM.java @@ -25,8 +25,11 @@ package org.spongepowered.asm.util.asm; import java.lang.reflect.Field; +import java.util.jar.Attributes; import org.objectweb.asm.Opcodes; +import org.spongepowered.asm.launch.platform.MainAttributes; +import org.spongepowered.asm.util.VersionNumber; /** * Utility methods for determining ASM version and other version-specific @@ -36,6 +39,11 @@ public final class ASM { private static int majorVersion = 5; private static int minorVersion = 0; + + // Implementation versions, only available from ASM + private static int implMinorVersion = 0; + private static int patchVersion = 0; + private static String maxVersion = "FALLBACK"; private static int maxClassVersion = Opcodes.V1_6; @@ -60,6 +68,32 @@ public final class ASM { return ASM.majorVersion >= majorVersion; } + /** + * Get whether the current ASM API is at least the specified version + * (including minor version when it's relevant) + * + * @param majorVersion major version to check for (eg. 6) + * @param minorVersion minor version to check for + */ + public static boolean isAtLeastVersion(int majorVersion, int minorVersion) { + return ASM.majorVersion >= majorVersion && (ASM.majorVersion > majorVersion || ASM.implMinorVersion >= minorVersion); + } + + /** + * Get whether the current ASM API is at least the specified version + * (including minor version and patch version when it's relevant) + * + * @param majorVersion major version to check for (eg. 6) + * @param minorVersion minor version to check for + * @param patchVersion patch version to check for + */ + public static boolean isAtLeastVersion(int majorVersion, int minorVersion, int patchVersion) { + if (ASM.majorVersion == majorVersion) { + return ASM.implMinorVersion >= minorVersion && (ASM.implMinorVersion > minorVersion || ASM.patchVersion >= patchVersion); + } + return ASM.majorVersion > majorVersion; + } + /** * Get the major API version */ @@ -75,12 +109,22 @@ public final class ASM { } /** - * Get the ASM API version as a string (mostly for debugging and the banner) + * Get the ASM API version as a string (mostly for debugging) * * @return ASM API version as string */ public static String getApiVersionString() { - return String.format("ASM %d.%d (%s)", ASM.majorVersion, ASM.minorVersion, ASM.maxVersion); + return String.format("%d.%d", ASM.majorVersion, ASM.minorVersion); + } + + /** + * Get the ASM version as a string (mostly for debugging and the banner) + * + * @return ASM library version as string + */ + public static String getVersionString() { + return String.format("ASM %d.%d%s (%s)", + ASM.majorVersion, ASM.implMinorVersion, ASM.patchVersion > 0 ? "." + ASM.patchVersion : "", ASM.maxVersion); } /** @@ -115,7 +159,9 @@ public final class ASM { private static int detectVersion() { int apiVersion = Opcodes.ASM4; - + + VersionNumber packageVersion = ASM.getPackageVersion(Opcodes.class); + for (Field field : Opcodes.class.getDeclaredFields()) { if (field.getType() != Integer.TYPE) { continue; @@ -135,7 +181,12 @@ public final class ASM { if (!experimental) { apiVersion = version; ASM.majorVersion = major; - ASM.minorVersion = minor; + ASM.minorVersion = ASM.implMinorVersion = minor; + + if (packageVersion.getMajor() == major && minor == 0) { + ASM.implMinorVersion = packageVersion.getMinor(); + ASM.patchVersion = packageVersion.getPatch(); + } } } } else if (name.matches("V([0-9_]+)")) { @@ -158,4 +209,18 @@ public final class ASM { return apiVersion; } + private static VersionNumber getPackageVersion(Class clazz) { + String implVersion = clazz.getPackage().getImplementationVersion(); + if (implVersion != null) { + return VersionNumber.parse(implVersion); + } + + try { + MainAttributes manifest = MainAttributes.of(clazz.getProtectionDomain().getCodeSource().getLocation().toURI()); + return VersionNumber.parse(manifest.get(Attributes.Name.IMPLEMENTATION_VERSION)); + } catch (Exception ex) { + return VersionNumber.NONE; + } + } + } diff --git a/src/main/java/org/spongepowered/asm/util/asm/ClassNodeAdapter.java b/src/main/java/org/spongepowered/asm/util/asm/ClassNodeAdapter.java index 6f99bf48..cb0d3446 100644 --- a/src/main/java/org/spongepowered/asm/util/asm/ClassNodeAdapter.java +++ b/src/main/java/org/spongepowered/asm/util/asm/ClassNodeAdapter.java @@ -110,6 +110,7 @@ public final class ClassNodeAdapter { public static void setNestMembers(ClassNode classNode, List nestMembers) { if (ASM.isAtLeastVersion(7)) { classNode.nestMembers = nestMembers; + return; } if (ClassNodeAdapter.fdNestMembers == null || ClassNodeAdapter.notSupported) { diff --git a/src/modlauncher/java/org/spongepowered/asm/launch/IClassProcessor.java b/src/modlauncher/java/org/spongepowered/asm/launch/IClassProcessor.java index 5aaf07ac..bb1febde 100644 --- a/src/modlauncher/java/org/spongepowered/asm/launch/IClassProcessor.java +++ b/src/modlauncher/java/org/spongepowered/asm/launch/IClassProcessor.java @@ -62,4 +62,21 @@ public interface IClassProcessor { */ public abstract boolean processClass(Phase phase, ClassNode classNode, Type classType, String reason); + /** + * Returns whether this generator can generate the specified class + * + * @param classType Class to generate + * @return true if this generator can generate the class + */ + public abstract boolean generatesClass(Type classType); + + /** + * Generate the specified class + * + * @param classType Class to generate + * @param classNode ClassNode to populate with the new class data + * @return true if the class was generated + */ + public abstract boolean generateClass(Type classType, ClassNode classNode); + } diff --git a/src/modlauncher/java/org/spongepowered/asm/launch/MixinLaunchPlugin.java b/src/modlauncher/java/org/spongepowered/asm/launch/MixinLaunchPluginLegacy.java similarity index 82% rename from src/modlauncher/java/org/spongepowered/asm/launch/MixinLaunchPlugin.java rename to src/modlauncher/java/org/spongepowered/asm/launch/MixinLaunchPluginLegacy.java index 857468cc..9cbbce1c 100644 --- a/src/modlauncher/java/org/spongepowered/asm/launch/MixinLaunchPlugin.java +++ b/src/modlauncher/java/org/spongepowered/asm/launch/MixinLaunchPluginLegacy.java @@ -30,7 +30,6 @@ import java.nio.file.Path; import java.util.ArrayList; import java.util.EnumSet; import java.util.List; -import java.util.Map.Entry; import java.util.function.Consumer; import org.objectweb.asm.ClassReader; @@ -52,7 +51,7 @@ import cpw.mods.modlauncher.serviceapi.ILaunchPluginService; /** * Mixin launch plugin */ -public class MixinLaunchPlugin implements ILaunchPluginService, IClassBytecodeProvider { +public class MixinLaunchPluginLegacy implements ILaunchPluginService, IClassBytecodeProvider { /** * Name used for ModLauncher mixin service components @@ -80,7 +79,7 @@ public class MixinLaunchPlugin implements ILaunchPluginService, IClassBytecodePr */ @Override public String name() { - return MixinLaunchPlugin.NAME; + return MixinLaunchPluginLegacy.NAME; } @Override @@ -99,7 +98,7 @@ public class MixinLaunchPlugin implements ILaunchPluginService, IClassBytecodePr */ @Override public EnumSet handlesClass(Type classType, boolean isEmpty, final String reason) { - if (MixinLaunchPlugin.NAME.equals(reason)) { + if (MixinLaunchPluginLegacy.NAME.equals(reason)) { return Phases.NONE; } @@ -128,8 +127,8 @@ public class MixinLaunchPlugin implements ILaunchPluginService, IClassBytecodePr boolean processed = false; synchronized (this.processors) { - for (IClassProcessor postProcessor : this.processors) { - processed |= postProcessor.processClass(phase, classNode, classType, reason); + for (IClassProcessor processor : this.processors) { + processed |= processor.processClass(phase, classNode, classType, reason); } } @@ -177,8 +176,9 @@ public class MixinLaunchPlugin implements ILaunchPluginService, IClassBytecodePr this.service.getPrimaryContainer().addResource(name, resource); } + @SuppressWarnings("rawtypes") @Override - public void addResources(List> resources) { + public void addResources(List resources) { this.service.getPrimaryContainer().addResources(resources); } @@ -190,8 +190,12 @@ public class MixinLaunchPlugin implements ILaunchPluginService, IClassBytecodePr return null; } - @Override + // ModLauncher 4-8 public void initializeLaunch(ITransformerLoader transformerLoader, Path[] specialPaths) { + this.initializeLaunch(transformerLoader); + } + + protected void initializeLaunch(ITransformerLoader transformerLoader) { this.transformerLoader = transformerLoader; MixinBootstrap.doInit(CommandLineOptions.of(this.commandLineMixins)); MixinBootstrap.inject(); @@ -209,12 +213,15 @@ public class MixinLaunchPlugin implements ILaunchPluginService, IClassBytecodePr throw new IllegalArgumentException("ModLauncher service does not currently support retrieval of untransformed bytecode"); } + String canonicalName = name.replace('/', '.'); + String internalName = name.replace('.', '/'); + byte[] classBytes; try { - classBytes = this.transformerLoader.buildTransformedClassNodeFor(name); + classBytes = this.transformerLoader.buildTransformedClassNodeFor(canonicalName); } catch (ClassNotFoundException ex) { - URL url = Thread.currentThread().getContextClassLoader().getResource(name.replace('.', '/') + ".class"); + URL url = Thread.currentThread().getContextClassLoader().getResource(internalName + ".class"); if (url == null) { throw ex; } @@ -225,14 +232,28 @@ public class MixinLaunchPlugin implements ILaunchPluginService, IClassBytecodePr } } - if (classBytes == null) { - throw new ClassNotFoundException(name.replace('/', '.')); + if (classBytes != null && classBytes.length != 0) { + ClassNode classNode = new ClassNode(); + ClassReader classReader = new MixinClassReader(classBytes, canonicalName); + classReader.accept(classNode, ClassReader.EXPAND_FRAMES); + return classNode; } - - ClassNode classNode = new ClassNode(); - ClassReader classReader = new MixinClassReader(classBytes, name); - classReader.accept(classNode, ClassReader.EXPAND_FRAMES); - return classNode; + + Type classType = Type.getObjectType(internalName); + synchronized (this.processors) { + for (IClassProcessor processor : this.processors) { + if (!processor.generatesClass(classType)) { + continue; + } + + ClassNode classNode = new ClassNode(); + if (processor.generateClass(classType, classNode)) { + return classNode; + } + } + } + + throw new ClassNotFoundException(canonicalName); } } diff --git a/src/modlauncher/java/org/spongepowered/asm/launch/MixinTransformationService.java b/src/modlauncher/java/org/spongepowered/asm/launch/MixinTransformationServiceAbstract.java similarity index 74% rename from src/modlauncher/java/org/spongepowered/asm/launch/MixinTransformationService.java rename to src/modlauncher/java/org/spongepowered/asm/launch/MixinTransformationServiceAbstract.java index 432bb515..9fd8eff2 100644 --- a/src/modlauncher/java/org/spongepowered/asm/launch/MixinTransformationService.java +++ b/src/modlauncher/java/org/spongepowered/asm/launch/MixinTransformationServiceAbstract.java @@ -24,8 +24,11 @@ */ package org.spongepowered.asm.launch; +import java.nio.file.Path; import java.util.ArrayList; +import java.util.Collections; import java.util.List; +import java.util.Map; import java.util.Optional; import java.util.Set; import java.util.function.BiFunction; @@ -41,17 +44,18 @@ import joptsimple.ArgumentAcceptingOptionSpec; import joptsimple.OptionSpecBuilder; /** - * Service for handling transforms mixin under ModLauncher + * Service for handling transforms mixin under ModLauncher, now abstract to + * support both Modlauncher 9 and previous versions of Modlauncher */ -public class MixinTransformationService implements ITransformationService { +public abstract class MixinTransformationServiceAbstract implements ITransformationService { private ArgumentAcceptingOptionSpec mixinsArgument; private List commandLineMixins = new ArrayList(); - private MixinLaunchPlugin plugin; + private MixinLaunchPluginLegacy plugin; @Override public String name() { - return MixinLaunchPlugin.NAME; + return MixinLaunchPluginLegacy.NAME; } @Override @@ -71,24 +75,34 @@ public class MixinTransformationService implements ITransformationService { @Override public void initialize(IEnvironment environment) { - Optional plugin = environment.findLaunchPlugin(MixinLaunchPlugin.NAME); + Optional plugin = environment.findLaunchPlugin(MixinLaunchPluginLegacy.NAME); if (!plugin.isPresent()) { throw new MixinInitialisationError("Mixin Launch Plugin Service could not be located"); } ILaunchPluginService launchPlugin = plugin.get(); - if (!(launchPlugin instanceof MixinLaunchPlugin)) { + if (!(launchPlugin instanceof MixinLaunchPluginLegacy)) { throw new MixinInitialisationError("Mixin Launch Plugin Service is present but not compatible"); } - this.plugin = (MixinLaunchPlugin)launchPlugin; + this.plugin = (MixinLaunchPluginLegacy)launchPlugin; MixinBootstrap.start(); this.plugin.init(environment, this.commandLineMixins); } - @Override - public void beginScanning(IEnvironment environment) { + /** + * This is "overridden" from Modlauncher 4-8 since it would normally call + * beginScanning which returned void. Since we can't + * override the old method, and omitting it would lead to an Abstract Method + * Error in ML 8, we instead override this method to avoid calling + * the now-removed beginScanning. + * + * @param environment Scanning env + * @return discovered containers + */ + public List> runScan(IEnvironment environment) { + return Collections.emptyList(); } - + @SuppressWarnings("rawtypes") @Override public List transformers() { diff --git a/src/modlauncher/java/org/spongepowered/asm/launch/platform/container/ContainerHandleModLauncher.java b/src/modlauncher/java/org/spongepowered/asm/launch/platform/container/ContainerHandleModLauncher.java index 1d5b0a3f..03463e43 100644 --- a/src/modlauncher/java/org/spongepowered/asm/launch/platform/container/ContainerHandleModLauncher.java +++ b/src/modlauncher/java/org/spongepowered/asm/launch/platform/container/ContainerHandleModLauncher.java @@ -28,15 +28,18 @@ import java.nio.file.Path; import java.util.List; import java.util.Map.Entry; +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; + /** * ModLauncher root container */ public class ContainerHandleModLauncher extends ContainerHandleVirtual { /** - * Container handle for resources offered by ModLauncher + * Container handle for nio resources offered by ModLauncher */ - public class Resource extends ContainerHandleURI { + class Resource extends ContainerHandleURI { private String name; private Path path; @@ -61,6 +64,11 @@ public class ContainerHandleModLauncher extends ContainerHandleVirtual { } } + + /** + * Logger + */ + protected static final Logger logger = LogManager.getLogger("mixin"); public ContainerHandleModLauncher(String name) { super(name); @@ -76,20 +84,43 @@ public class ContainerHandleModLauncher extends ContainerHandleVirtual { this.add(new Resource(name, path)); } + /** + * Add a resource to to this container + * + * @param entry Resource entry + */ + public void addResource(Entry entry) { + this.add(new Resource(entry.getKey(), entry.getValue())); + } + + /** + * Add a resource to to this container + * + * @param resource Resource + */ + @SuppressWarnings("unchecked") + public void addResource(Object resource) { + if (resource instanceof Entry) { + this.addResource((Entry)resource); + } else { + ContainerHandleModLauncher.logger.error("Unrecognised resource type {} passed to {}", resource.getClass(), this); + } + } + /** * Add a collection of resources to this container * * @param resources Resources to add */ - public void addResources(List> resources) { - for (Entry resource : resources) { - this.addResource(resource.getKey(), resource.getValue()); + public void addResources(List resources) { + for (Object resource : resources) { + this.addResource(resource); } } - + @Override public String toString() { - return String.format("ModLauncher Root Container(%x)", this.hashCode()); + return String.format("ModLauncher Root Container(%s:%x)", this.getName(), this.hashCode()); } } diff --git a/src/modlauncher/java/org/spongepowered/asm/service/modlauncher/MixinServiceModLauncher.java b/src/modlauncher/java/org/spongepowered/asm/service/modlauncher/MixinServiceModLauncher.java index 80791f9e..d7b433b2 100644 --- a/src/modlauncher/java/org/spongepowered/asm/service/modlauncher/MixinServiceModLauncher.java +++ b/src/modlauncher/java/org/spongepowered/asm/service/modlauncher/MixinServiceModLauncher.java @@ -25,6 +25,7 @@ package org.spongepowered.asm.service.modlauncher; import java.io.InputStream; +import java.lang.reflect.Constructor; import java.util.Collection; import org.spongepowered.asm.launch.IClassProcessor; @@ -54,7 +55,20 @@ public class MixinServiceModLauncher extends MixinServiceAbstract { /** * Specification version to check for at startup */ - private static final String MODLAUNCHER_SPECIFICATION_VERSION = "4.0"; + private static final String MODLAUNCHER_4_SPECIFICATION_VERSION = "4.0"; + + /** + * Specification version for ModLauncher versions >= 9.0.4, yes this is + * not a typo, the specification version (API version) is out of step with + * the artefact version in a few previous cases (ML6 has specification + * version 5.0 for example, and ML7 and ML8 both had specification version + * 7.0). + */ + private static final String MODLAUNCHER_9_SPECIFICATION_VERSION = "8.0"; + + private static final String CONTAINER_PACKAGE = MixinServiceAbstract.LAUNCH_PACKAGE + "platform.container."; + private static final String MODLAUNCHER_4_ROOT_CONTAINER_CLASS = MixinServiceModLauncher.CONTAINER_PACKAGE + "ContainerHandleModLauncher"; + private static final String MODLAUNCHER_9_ROOT_CONTAINER_CLASS = MixinServiceModLauncher.CONTAINER_PACKAGE + "ContainerHandleModLauncherEx"; /** * Class provider, either uses hacky internals or provided service @@ -94,7 +108,22 @@ public class MixinServiceModLauncher extends MixinServiceAbstract { /** * Root container */ - private ContainerHandleModLauncher rootContainer = new ContainerHandleModLauncher(this.getName()); + private ContainerHandleModLauncher rootContainer; + + /** + * Minimum compatibility level + */ + private CompatibilityLevel minCompatibilityLevel = CompatibilityLevel.JAVA_8; + + public MixinServiceModLauncher() { + final Package pkg = ITransformationService.class.getPackage(); + if (pkg.isCompatibleWith(MixinServiceModLauncher.MODLAUNCHER_9_SPECIFICATION_VERSION)) { + this.createRootContainer(MixinServiceModLauncher.MODLAUNCHER_9_ROOT_CONTAINER_CLASS); + this.minCompatibilityLevel = CompatibilityLevel.JAVA_16; + } else { + this.createRootContainer(MixinServiceModLauncher.MODLAUNCHER_4_ROOT_CONTAINER_CLASS); + } + } /** * Begin init @@ -109,6 +138,16 @@ public class MixinServiceModLauncher extends MixinServiceAbstract { this.bytecodeProvider = bytecodeProvider; } + private void createRootContainer(String rootContainerClassName) { + try { + Class clRootContainer = this.getClassProvider().findClass(rootContainerClassName); + Constructor ctor = clRootContainer.getDeclaredConstructor(String.class); + this.rootContainer = (ContainerHandleModLauncher)ctor.newInstance(this.getName()); + } catch (ReflectiveOperationException ex) { + ex.printStackTrace(); + } + } + /** * Lifecycle event */ @@ -146,7 +185,7 @@ public class MixinServiceModLauncher extends MixinServiceAbstract { */ @Override public CompatibilityLevel getMinCompatibilityLevel() { - return CompatibilityLevel.JAVA_8; + return this.minCompatibilityLevel; } /* (non-Javadoc) @@ -157,7 +196,7 @@ public class MixinServiceModLauncher extends MixinServiceAbstract { try { Launcher.INSTANCE.hashCode(); final Package pkg = ITransformationService.class.getPackage(); - if (!pkg.isCompatibleWith(MixinServiceModLauncher.MODLAUNCHER_SPECIFICATION_VERSION)) { + if (!pkg.isCompatibleWith(MixinServiceModLauncher.MODLAUNCHER_4_SPECIFICATION_VERSION)) { return false; } } catch (Throwable th) { diff --git a/src/modlauncher/java/org/spongepowered/asm/service/modlauncher/MixinTransformationHandler.java b/src/modlauncher/java/org/spongepowered/asm/service/modlauncher/MixinTransformationHandler.java index 303e1c7e..40966aeb 100644 --- a/src/modlauncher/java/org/spongepowered/asm/service/modlauncher/MixinTransformationHandler.java +++ b/src/modlauncher/java/org/spongepowered/asm/service/modlauncher/MixinTransformationHandler.java @@ -29,12 +29,11 @@ import java.util.EnumSet; import org.objectweb.asm.Type; import org.objectweb.asm.tree.ClassNode; import org.spongepowered.asm.launch.IClassProcessor; -import org.spongepowered.asm.launch.MixinLaunchPlugin; +import org.spongepowered.asm.launch.MixinLaunchPluginLegacy; import org.spongepowered.asm.launch.Phases; import org.spongepowered.asm.mixin.MixinEnvironment; import org.spongepowered.asm.mixin.transformer.IMixinTransformer; import org.spongepowered.asm.mixin.transformer.IMixinTransformerFactory; -import org.spongepowered.asm.service.ISyntheticClassInfo; import org.spongepowered.asm.service.ISyntheticClassRegistry; import com.google.common.base.Preconditions; @@ -83,8 +82,16 @@ public class MixinTransformationHandler implements IClassProcessor { return null; } - ISyntheticClassInfo syntheticClass = this.registry.findSyntheticClass(classType.getClassName()); - return syntheticClass != null ? Phases.AFTER_ONLY : null; + return this.generatesClass(classType) ? Phases.AFTER_ONLY : null; + } + + /* (non-Javadoc) + * @see org.spongepowered.asm.launch.IClassProcessor#generatesClass( + * org.objectweb.asm.Type) + */ + @Override + public boolean generatesClass(Type classType) { + return this.registry.findSyntheticClass(classType.getClassName()) != null; } /* (non-Javadoc) @@ -108,21 +115,29 @@ public class MixinTransformationHandler implements IClassProcessor { } // Don't transform when the reason is mixin (side-loading in progress) - if (MixinLaunchPlugin.NAME.equals(reason)) { + if (MixinLaunchPluginLegacy.NAME.equals(reason)) { return false; } - MixinEnvironment environment = MixinEnvironment.getCurrentEnvironment(); - ISyntheticClassInfo syntheticClass = this.registry.findSyntheticClass(classType.getClassName()); - if (syntheticClass != null) { - return this.transformer.generateClass(environment, classType.getClassName(), classNode); + if (this.generatesClass(classType)) { + return this.generateClass(classType, classNode); } + MixinEnvironment environment = MixinEnvironment.getCurrentEnvironment(); if (ITransformerActivity.COMPUTING_FRAMES_REASON.equals(reason)) { return this.transformer.computeFramesForClass(environment, classType.getClassName(), classNode); } return this.transformer.transformClass(environment, classType.getClassName(), classNode); } + + /* (non-Javadoc) + * @see org.spongepowered.asm.launch.IClassProcessor#generateClass( + * org.objectweb.asm.Type, org.objectweb.asm.tree.ClassNode) + */ + @Override + public boolean generateClass(Type classType, ClassNode classNode) { + return this.transformer.generateClass(MixinEnvironment.getCurrentEnvironment(), classType.getClassName(), classNode); + } } diff --git a/src/modlauncher/java/org/spongepowered/asm/service/modlauncher/ModLauncherClassProvider.java b/src/modlauncher/java/org/spongepowered/asm/service/modlauncher/ModLauncherClassProvider.java index c3c6f346..f0c9bda2 100644 --- a/src/modlauncher/java/org/spongepowered/asm/service/modlauncher/ModLauncherClassProvider.java +++ b/src/modlauncher/java/org/spongepowered/asm/service/modlauncher/ModLauncherClassProvider.java @@ -24,11 +24,11 @@ */ package org.spongepowered.asm.service.modlauncher; +import java.lang.reflect.Method; import java.net.URL; import org.spongepowered.asm.service.IClassProvider; -import cpw.mods.gross.Java9ClassLoaderUtil; import cpw.mods.modlauncher.Launcher; /** @@ -36,6 +36,9 @@ import cpw.mods.modlauncher.Launcher; */ class ModLauncherClassProvider implements IClassProvider { + private static final String GET_SYSTEM_CLASS_PATH_METHOD = "getSystemClassPathURLs"; + private static final String JAVA9_CLASS_LOADER_UTIL_CLASS = "cpw.mods.gross.Java9ClassLoaderUtil"; + ModLauncherClassProvider() { } @@ -45,7 +48,14 @@ class ModLauncherClassProvider implements IClassProvider { @Override @Deprecated public URL[] getClassPath() { - return Java9ClassLoaderUtil.getSystemClassPathURLs(); + try { + Class clJava9ClassLoaderUtil = this.findClass(ModLauncherClassProvider.JAVA9_CLASS_LOADER_UTIL_CLASS); + Method mdGetSystemClassPathURLs = clJava9ClassLoaderUtil.getDeclaredMethod(ModLauncherClassProvider.GET_SYSTEM_CLASS_PATH_METHOD); + return (URL[])mdGetSystemClassPathURLs.invoke(null); + } catch (ReflectiveOperationException ex) { + // Probably Modlauncher 9+ + return new URL[0]; + } } /* (non-Javadoc) diff --git a/src/modlauncher/java/org/spongepowered/asm/service/modlauncher/ModLauncherClassTracker.java b/src/modlauncher/java/org/spongepowered/asm/service/modlauncher/ModLauncherClassTracker.java index ae41ff16..6da3c55e 100644 --- a/src/modlauncher/java/org/spongepowered/asm/service/modlauncher/ModLauncherClassTracker.java +++ b/src/modlauncher/java/org/spongepowered/asm/service/modlauncher/ModLauncherClassTracker.java @@ -112,5 +112,23 @@ public class ModLauncherClassTracker implements IClassProcessor, IClassTracker { return false; } + + /* (non-Javadoc) + * @see org.spongepowered.asm.launch.IClassProcessor#generatesClass( + * org.objectweb.asm.Type) + */ + @Override + public boolean generatesClass(Type classType) { + return false; + } + + /* (non-Javadoc) + * @see org.spongepowered.asm.launch.IClassProcessor#generateClass( + * org.objectweb.asm.Type, org.objectweb.asm.tree.ClassNode) + */ + @Override + public boolean generateClass(Type classType, ClassNode classNode) { + return false; + } } diff --git a/src/modlauncher/resources/META-INF/services/cpw.mods.modlauncher.api.ITransformationService b/src/modlauncher/resources/META-INF/services/cpw.mods.modlauncher.api.ITransformationService deleted file mode 100644 index 43d16497..00000000 --- a/src/modlauncher/resources/META-INF/services/cpw.mods.modlauncher.api.ITransformationService +++ /dev/null @@ -1 +0,0 @@ -org.spongepowered.asm.launch.MixinTransformationService \ No newline at end of file diff --git a/src/modlauncher/resources/META-INF/services/cpw.mods.modlauncher.serviceapi.ILaunchPluginService b/src/modlauncher/resources/META-INF/services/cpw.mods.modlauncher.serviceapi.ILaunchPluginService deleted file mode 100644 index dee143bf..00000000 --- a/src/modlauncher/resources/META-INF/services/cpw.mods.modlauncher.serviceapi.ILaunchPluginService +++ /dev/null @@ -1 +0,0 @@ -org.spongepowered.asm.launch.MixinLaunchPlugin \ No newline at end of file diff --git a/src/modlauncher4/java/org/spongepowered/asm/launch/MixinTransformationServiceLegacy.java b/src/modlauncher4/java/org/spongepowered/asm/launch/MixinTransformationServiceLegacy.java new file mode 100644 index 00000000..f628b99a --- /dev/null +++ b/src/modlauncher4/java/org/spongepowered/asm/launch/MixinTransformationServiceLegacy.java @@ -0,0 +1,35 @@ +/* + * This file is part of Mixin, licensed under the MIT License (MIT). + * + * Copyright (c) SpongePowered + * Copyright (c) contributors + * + * 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 org.spongepowered.asm.launch; + +import cpw.mods.modlauncher.api.IEnvironment; + +public class MixinTransformationServiceLegacy extends MixinTransformationServiceAbstract { + + @Override + public void beginScanning(IEnvironment environment) { + } + +} diff --git a/src/modlauncher4/resources/META-INF/services/cpw.mods.modlauncher.api.ITransformationService b/src/modlauncher4/resources/META-INF/services/cpw.mods.modlauncher.api.ITransformationService new file mode 100644 index 00000000..bc0fcd3d --- /dev/null +++ b/src/modlauncher4/resources/META-INF/services/cpw.mods.modlauncher.api.ITransformationService @@ -0,0 +1 @@ +org.spongepowered.asm.launch.MixinTransformationServiceLegacy \ No newline at end of file diff --git a/src/modlauncher4/resources/META-INF/services/cpw.mods.modlauncher.serviceapi.ILaunchPluginService b/src/modlauncher4/resources/META-INF/services/cpw.mods.modlauncher.serviceapi.ILaunchPluginService new file mode 100644 index 00000000..ab235d1b --- /dev/null +++ b/src/modlauncher4/resources/META-INF/services/cpw.mods.modlauncher.serviceapi.ILaunchPluginService @@ -0,0 +1 @@ +org.spongepowered.asm.launch.MixinLaunchPluginLegacy \ No newline at end of file diff --git a/src/modlauncher/resources/META-INF/services/org.spongepowered.asm.service.IGlobalPropertyService b/src/modlauncher4/resources/META-INF/services/org.spongepowered.asm.service.IGlobalPropertyService similarity index 100% rename from src/modlauncher/resources/META-INF/services/org.spongepowered.asm.service.IGlobalPropertyService rename to src/modlauncher4/resources/META-INF/services/org.spongepowered.asm.service.IGlobalPropertyService diff --git a/src/modlauncher/resources/META-INF/services/org.spongepowered.asm.service.IMixinService b/src/modlauncher4/resources/META-INF/services/org.spongepowered.asm.service.IMixinService similarity index 100% rename from src/modlauncher/resources/META-INF/services/org.spongepowered.asm.service.IMixinService rename to src/modlauncher4/resources/META-INF/services/org.spongepowered.asm.service.IMixinService diff --git a/src/modlauncher/resources/META-INF/services/org.spongepowered.asm.service.IMixinServiceBootstrap b/src/modlauncher4/resources/META-INF/services/org.spongepowered.asm.service.IMixinServiceBootstrap similarity index 100% rename from src/modlauncher/resources/META-INF/services/org.spongepowered.asm.service.IMixinServiceBootstrap rename to src/modlauncher4/resources/META-INF/services/org.spongepowered.asm.service.IMixinServiceBootstrap diff --git a/src/modlauncher9/java/org/spongepowered/asm/launch/MixinLaunchPlugin.java b/src/modlauncher9/java/org/spongepowered/asm/launch/MixinLaunchPlugin.java new file mode 100644 index 00000000..efa8531d --- /dev/null +++ b/src/modlauncher9/java/org/spongepowered/asm/launch/MixinLaunchPlugin.java @@ -0,0 +1,37 @@ +/* + * This file is part of Mixin, licensed under the MIT License (MIT). + * + * Copyright (c) SpongePowered + * Copyright (c) contributors + * + * 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 org.spongepowered.asm.launch; + +import cpw.mods.modlauncher.api.NamedPath; + +public class MixinLaunchPlugin extends MixinLaunchPluginLegacy { + + // ModLauncher 9+ + @Override + public void initializeLaunch(ITransformerLoader transformerLoader, NamedPath[] specialPaths) { + this.initializeLaunch(transformerLoader); + } + +} diff --git a/src/modlauncher9/java/org/spongepowered/asm/launch/MixinTransformationService.java b/src/modlauncher9/java/org/spongepowered/asm/launch/MixinTransformationService.java new file mode 100644 index 00000000..caa2cd8b --- /dev/null +++ b/src/modlauncher9/java/org/spongepowered/asm/launch/MixinTransformationService.java @@ -0,0 +1,34 @@ +/* + * This file is part of Mixin, licensed under the MIT License (MIT). + * + * Copyright (c) SpongePowered + * Copyright (c) contributors + * + * 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 org.spongepowered.asm.launch; + +/** + * Service for handling transforms mixin under ModLauncher, now just a concrete + * class which extends the abstract base class used for pre-9 versions of + * ModLauncher + */ +public class MixinTransformationService extends MixinTransformationServiceAbstract { + +} diff --git a/src/modlauncher9/java/org/spongepowered/asm/launch/platform/container/ContainerHandleModLauncherEx.java b/src/modlauncher9/java/org/spongepowered/asm/launch/platform/container/ContainerHandleModLauncherEx.java new file mode 100644 index 00000000..a6553ef5 --- /dev/null +++ b/src/modlauncher9/java/org/spongepowered/asm/launch/platform/container/ContainerHandleModLauncherEx.java @@ -0,0 +1,76 @@ +/* + * This file is part of Mixin, licensed under the MIT License (MIT). + * + * Copyright (c) SpongePowered + * Copyright (c) contributors + * + * 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 org.spongepowered.asm.launch.platform.container; + +import java.nio.file.Path; + +import cpw.mods.jarhandling.SecureJar; + +/** + * ModLauncher root container for ModLauncher 9+ + */ +public class ContainerHandleModLauncherEx extends ContainerHandleModLauncher { + + /** + * Container handle for secure jar resources offered by ModLauncher + */ + static class SecureJarResource extends ContainerHandleURI { + + private SecureJar jar; + + public SecureJarResource(SecureJar resource) { + super(resource.getPrimaryPath().toUri()); + this.jar = resource; + } + + public String getName() { + return this.jar.name(); + } + + public Path getPath() { + return this.jar.getPrimaryPath(); + } + + @Override + public String toString() { + return String.format("SecureJarResource(%s)", this.getName()); + } + + } + + public ContainerHandleModLauncherEx(String name) { + super(name); + } + + @Override + public void addResource(Object resource) { + if (resource instanceof SecureJar) { + this.add(new SecureJarResource((SecureJar)resource)); + } else { + super.addResource(resource); + } + } + +} diff --git a/src/modularity/java/module-info.java b/src/modularity/java/module-info.java new file mode 100644 index 00000000..678435b6 --- /dev/null +++ b/src/modularity/java/module-info.java @@ -0,0 +1,139 @@ +/* + * This file is part of Mixin, licensed under the MIT License (MIT). + * + * Copyright (c) SpongePowered + * Copyright (c) contributors + * + * 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. + */ + +/** + * Mixin module declaration + */ +@SuppressWarnings("module") // Suppress the warnings about gson and gson below +module org.spongepowered.mixin { + + // + // Actual modules we depend on + // + requires transitive cpw.mods.modlauncher; + requires cpw.mods.securejarhandler; + requires transitive java.compiler; + requires transitive java.instrument; + requires transitive org.apache.logging.log4j; + requires org.apache.logging.log4j.core; + requires transitive org.objectweb.asm; + requires transitive org.objectweb.asm.commons; + requires transitive org.objectweb.asm.tree; + requires transitive org.objectweb.asm.tree.analysis; + requires transitive org.objectweb.asm.util; + + // + // Automatic modules we depend on + // + requires jopt.simple; + requires guava; + requires gson; + + // + // Exports + // + exports org.spongepowered.asm.launch; + exports org.spongepowered.asm.launch.platform; + exports org.spongepowered.asm.launch.platform.container; + exports org.spongepowered.asm.lib; + exports org.spongepowered.asm.lib.tree; + exports org.spongepowered.asm.mixin; + exports org.spongepowered.asm.mixin.connect; + exports org.spongepowered.asm.mixin.extensibility; + exports org.spongepowered.asm.mixin.gen; + exports org.spongepowered.asm.mixin.gen.throwables; + exports org.spongepowered.asm.mixin.injection; + exports org.spongepowered.asm.mixin.injection.callback; + exports org.spongepowered.asm.mixin.injection.code; + exports org.spongepowered.asm.mixin.injection.invoke.arg; + exports org.spongepowered.asm.mixin.injection.points; + exports org.spongepowered.asm.mixin.injection.selectors; + exports org.spongepowered.asm.mixin.injection.selectors.dynamic; + exports org.spongepowered.asm.mixin.injection.selectors.throwables; + exports org.spongepowered.asm.mixin.injection.struct; + exports org.spongepowered.asm.mixin.injection.throwables; + exports org.spongepowered.asm.mixin.refmap; + exports org.spongepowered.asm.mixin.throwables; + exports org.spongepowered.asm.mixin.transformer.ext; + exports org.spongepowered.asm.mixin.transformer.throwables; + exports org.spongepowered.asm.obfuscation; + exports org.spongepowered.asm.obfuscation.mapping; + exports org.spongepowered.asm.obfuscation.mapping.common; + exports org.spongepowered.asm.obfuscation.mapping.mcp; + exports org.spongepowered.asm.service; + exports org.spongepowered.asm.service.modlauncher; + exports org.spongepowered.asm.util; + exports org.spongepowered.asm.util.asm; + exports org.spongepowered.asm.util.perf; + exports org.spongepowered.tools.agent; + exports org.spongepowered.tools.obfuscation; + exports org.spongepowered.tools.obfuscation.ext; + exports org.spongepowered.tools.obfuscation.fg3; + exports org.spongepowered.tools.obfuscation.interfaces; + exports org.spongepowered.tools.obfuscation.mapping; + exports org.spongepowered.tools.obfuscation.mapping.common; + exports org.spongepowered.tools.obfuscation.mapping.fg3; + exports org.spongepowered.tools.obfuscation.mapping.mcp; + exports org.spongepowered.tools.obfuscation.mcp; + exports org.spongepowered.tools.obfuscation.mirror; + exports org.spongepowered.tools.obfuscation.service; + + // one of these won't exist, the SuppressWarnings above stops the compiler complaining + opens org.spongepowered.asm.mixin.transformer + to com.google.gson, gson; + + // + // Service wiring + // + uses org.spongepowered.asm.service.IMixinServiceBootstrap; + provides org.spongepowered.asm.service.IMixinServiceBootstrap + with org.spongepowered.asm.service.modlauncher.MixinServiceModLauncherBootstrap; + + uses org.spongepowered.asm.service.IMixinService; + provides org.spongepowered.asm.service.IMixinService + with org.spongepowered.asm.service.modlauncher.MixinServiceModLauncher; + + uses org.spongepowered.asm.service.IGlobalPropertyService; + provides org.spongepowered.asm.service.IGlobalPropertyService + with org.spongepowered.asm.service.modlauncher.Blackboard; + + uses cpw.mods.modlauncher.api.ITransformationService; + provides cpw.mods.modlauncher.api.ITransformationService + with org.spongepowered.asm.launch.MixinTransformationService; + + uses cpw.mods.modlauncher.serviceapi.ILaunchPluginService; + provides cpw.mods.modlauncher.serviceapi.ILaunchPluginService + with org.spongepowered.asm.launch.MixinLaunchPlugin; + + uses javax.annotation.processing.Processor; + provides javax.annotation.processing.Processor + with org.spongepowered.tools.obfuscation.MixinObfuscationProcessorInjection, + org.spongepowered.tools.obfuscation.MixinObfuscationProcessorTargets; + + uses org.spongepowered.tools.obfuscation.service.IObfuscationService; + provides org.spongepowered.tools.obfuscation.service.IObfuscationService + with org.spongepowered.tools.obfuscation.mcp.ObfuscationServiceMCP, + org.spongepowered.tools.obfuscation.fg3.ObfuscationServiceFG3; +}