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 c18df3cc..a5a38b9e 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/ClassInfo.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/ClassInfo.java @@ -67,6 +67,24 @@ public class ClassInfo extends TreeInfo { public static final int INCLUDE_PRIVATE = Opcodes.ACC_PRIVATE; public static final int INCLUDE_STATIC = Opcodes.ACC_STATIC; public static final int INCLUDE_ALL = ClassInfo.INCLUDE_PRIVATE | ClassInfo.INCLUDE_STATIC; + + /** + * Search type for the findInHierarchy methods, replaces a boolean flag + * which made calling code difficult to read + */ + public static enum SearchType { + + /** + * Include this class when searching in the hierarchy + */ + ALL_CLASSES, + + /** + * Only walk the superclasses when searching the hierarchy + */ + SUPER_CLASSES_ONLY + + } /** *

To all intents and purposes, the "real" class hierarchy and the mixin @@ -88,31 +106,34 @@ public class ClassInfo extends TreeInfo { /** * No traversals are allowed. */ - NONE(null, false), + NONE(null, false, SearchType.SUPER_CLASSES_ONLY), /** * Traversal is allowed at all stages. */ - ALL(null, true), + ALL(null, true, SearchType.ALL_CLASSES), /** * Traversal is allowed at the bottom of the hierarchy but no further. */ - IMMEDIATE(Traversal.NONE, true), + IMMEDIATE(Traversal.NONE, true, SearchType.SUPER_CLASSES_ONLY), /** * Traversal is allowed only on superclasses and not at the bottom of * the hierarchy. */ - SUPER(Traversal.ALL, false); + SUPER(Traversal.ALL, false, SearchType.SUPER_CLASSES_ONLY); private final Traversal next; private final boolean traverse; + + private final SearchType searchType; - private Traversal(Traversal next, boolean traverse) { + private Traversal(Traversal next, boolean traverse, SearchType searchType) { this.next = next != null ? next : this; this.traverse = traverse; + this.searchType = searchType; } public Traversal next() { @@ -122,6 +143,11 @@ public class ClassInfo extends TreeInfo { public boolean canTraverse() { return this.traverse; } + + public SearchType getSearchType() { + return this.searchType; + } + } /** @@ -1130,50 +1156,46 @@ public class ClassInfo extends TreeInfo { * Finds the specified private or protected method in this class's hierarchy * * @param method Method to search for - * @param includeThisClass True to return this class if the method exists - * here, or false to search only superclasses + * @param searchType Search strategy to use * @return the method object or null if the method could not be resolved */ - public Method findMethodInHierarchy(MethodNode method, boolean includeThisClass) { - return this.findMethodInHierarchy(method.name, method.desc, includeThisClass, Traversal.NONE); + public Method findMethodInHierarchy(MethodNode method, SearchType searchType) { + return this.findMethodInHierarchy(method.name, method.desc, searchType, Traversal.NONE); } /** * Finds the specified private or protected method in this class's hierarchy * * @param method Method to search for - * @param includeThisClass True to return this class if the method exists - * here, or false to search only superclasses + * @param searchType Search strategy to use * @param flags search flags * @return the method object or null if the method could not be resolved */ - public Method findMethodInHierarchy(MethodNode method, boolean includeThisClass, int flags) { - return this.findMethodInHierarchy(method.name, method.desc, includeThisClass, Traversal.NONE, flags); + public Method findMethodInHierarchy(MethodNode method, SearchType searchType, int flags) { + return this.findMethodInHierarchy(method.name, method.desc, searchType, Traversal.NONE, flags); } /** * Finds the specified public or protected method in this class's hierarchy * * @param method Method to search for - * @param includeThisClass True to return this class if the method exists - * here, or false to search only superclasses + * @param searchType Search strategy to use * @return the method object or null if the method could not be resolved */ - public Method findMethodInHierarchy(MethodInsnNode method, boolean includeThisClass) { - return this.findMethodInHierarchy(method.name, method.desc, includeThisClass, Traversal.NONE); + public Method findMethodInHierarchy(MethodInsnNode method, SearchType searchType) { + return this.findMethodInHierarchy(method.name, method.desc, searchType, Traversal.NONE); } /** * Finds the specified public or protected method in this class's hierarchy * * @param method Method to search for - * @param includeThisClass True to return this class if the method exists - * here, or false to search only superclasses + * @param searchType Search strategy to use * @param flags search flags * @return the method object or null if the method could not be resolved */ - public Method findMethodInHierarchy(MethodInsnNode method, boolean includeThisClass, int flags) { - return this.findMethodInHierarchy(method.name, method.desc, includeThisClass, Traversal.NONE, flags); + public Method findMethodInHierarchy(MethodInsnNode method, SearchType searchType, int flags) { + return this.findMethodInHierarchy(method.name, method.desc, searchType, Traversal.NONE, flags); } /** @@ -1181,12 +1203,11 @@ public class ClassInfo extends TreeInfo { * * @param name Method name to search for * @param desc Method descriptor - * @param includeThisClass True to return this class if the method exists - * here, or false to search only superclasses + * @param searchType Search strategy to use * @return the method object or null if the method could not be resolved */ - public Method findMethodInHierarchy(String name, String desc, boolean includeThisClass) { - return this.findMethodInHierarchy(name, desc, includeThisClass, Traversal.NONE); + public Method findMethodInHierarchy(String name, String desc, SearchType searchType) { + return this.findMethodInHierarchy(name, desc, searchType, Traversal.NONE); } /** @@ -1194,13 +1215,12 @@ public class ClassInfo extends TreeInfo { * * @param name Method name to search for * @param desc Method descriptor - * @param includeThisClass True to return this class if the method exists - * here, or false to search only superclasses + * @param searchType Search strategy to use * @param traversal Traversal type to allow during this lookup * @return the method object or null if the method could not be resolved */ - public Method findMethodInHierarchy(String name, String desc, boolean includeThisClass, Traversal traversal) { - return this.findMethodInHierarchy(name, desc, includeThisClass, traversal, 0); + public Method findMethodInHierarchy(String name, String desc, SearchType searchType, Traversal traversal) { + return this.findMethodInHierarchy(name, desc, searchType, traversal, 0); } /** @@ -1208,64 +1228,59 @@ public class ClassInfo extends TreeInfo { * * @param name Method name to search for * @param desc Method descriptor - * @param includeThisClass True to return this class if the method exists - * here, or false to search only superclasses + * @param searchType Search strategy to use * @param traversal Traversal type to allow during this lookup * @param flags search flags * @return the method object or null if the method could not be resolved */ - public Method findMethodInHierarchy(String name, String desc, boolean includeThisClass, Traversal traversal, int flags) { - return this.findInHierarchy(name, desc, includeThisClass, traversal, flags, Type.METHOD); + public Method findMethodInHierarchy(String name, String desc, SearchType searchType, Traversal traversal, int flags) { + return this.findInHierarchy(name, desc, searchType, traversal, flags, Type.METHOD); } /** * Finds the specified private or protected field in this class's hierarchy * * @param field Field to search for - * @param includeThisClass True to return this class if the field exists - * here, or false to search only superclasses + * @param searchType Search strategy to use * @return the field object or null if the field could not be resolved */ - public Field findFieldInHierarchy(FieldNode field, boolean includeThisClass) { - return this.findFieldInHierarchy(field.name, field.desc, includeThisClass, Traversal.NONE); + public Field findFieldInHierarchy(FieldNode field, SearchType searchType) { + return this.findFieldInHierarchy(field.name, field.desc, searchType, Traversal.NONE); } /** * Finds the specified private or protected field in this class's hierarchy * * @param field Field to search for - * @param includeThisClass True to return this class if the field exists - * here, or false to search only superclasses + * @param searchType Search strategy to use * @param flags search flags * @return the field object or null if the field could not be resolved */ - public Field findFieldInHierarchy(FieldNode field, boolean includeThisClass, int flags) { - return this.findFieldInHierarchy(field.name, field.desc, includeThisClass, Traversal.NONE, flags); + public Field findFieldInHierarchy(FieldNode field, SearchType searchType, int flags) { + return this.findFieldInHierarchy(field.name, field.desc, searchType, Traversal.NONE, flags); } /** * Finds the specified public or protected field in this class's hierarchy * * @param field Field to search for - * @param includeThisClass True to return this class if the field exists - * here, or false to search only superclasses + * @param searchType Search strategy to use * @return the field object or null if the field could not be resolved */ - public Field findFieldInHierarchy(FieldInsnNode field, boolean includeThisClass) { - return this.findFieldInHierarchy(field.name, field.desc, includeThisClass, Traversal.NONE); + public Field findFieldInHierarchy(FieldInsnNode field, SearchType searchType) { + return this.findFieldInHierarchy(field.name, field.desc, searchType, Traversal.NONE); } /** * Finds the specified public or protected field in this class's hierarchy * * @param field Field to search for - * @param includeThisClass True to return this class if the field exists - * here, or false to search only superclasses + * @param searchType Search strategy to use * @param flags search flags * @return the field object or null if the field could not be resolved */ - public Field findFieldInHierarchy(FieldInsnNode field, boolean includeThisClass, int flags) { - return this.findFieldInHierarchy(field.name, field.desc, includeThisClass, Traversal.NONE, flags); + public Field findFieldInHierarchy(FieldInsnNode field, SearchType searchType, int flags) { + return this.findFieldInHierarchy(field.name, field.desc, searchType, Traversal.NONE, flags); } /** @@ -1273,12 +1288,11 @@ public class ClassInfo extends TreeInfo { * * @param name Field name to search for * @param desc Field descriptor - * @param includeThisClass True to return this class if the field exists - * here, or false to search only superclasses + * @param searchType Search strategy to use * @return the field object or null if the field could not be resolved */ - public Field findFieldInHierarchy(String name, String desc, boolean includeThisClass) { - return this.findFieldInHierarchy(name, desc, includeThisClass, Traversal.NONE); + public Field findFieldInHierarchy(String name, String desc, SearchType searchType) { + return this.findFieldInHierarchy(name, desc, searchType, Traversal.NONE); } /** @@ -1286,13 +1300,12 @@ public class ClassInfo extends TreeInfo { * * @param name Field name to search for * @param desc Field descriptor - * @param includeThisClass True to return this class if the field exists - * here, or false to search only superclasses + * @param searchType Search strategy to use * @param traversal Traversal type to allow during this lookup * @return the field object or null if the field could not be resolved */ - public Field findFieldInHierarchy(String name, String desc, boolean includeThisClass, Traversal traversal) { - return this.findFieldInHierarchy(name, desc, includeThisClass, traversal, 0); + public Field findFieldInHierarchy(String name, String desc, SearchType searchType, Traversal traversal) { + return this.findFieldInHierarchy(name, desc, searchType, traversal, 0); } /** @@ -1300,14 +1313,13 @@ public class ClassInfo extends TreeInfo { * * @param name Field name to search for * @param desc Field descriptor - * @param includeThisClass True to return this class if the field exists - * here, or false to search only superclasses + * @param searchType Search strategy to use * @param traversal Traversal type to allow during this lookup * @param flags search flags * @return the field object or null if the field could not be resolved */ - public Field findFieldInHierarchy(String name, String desc, boolean includeThisClass, Traversal traversal, int flags) { - return this.findInHierarchy(name, desc, includeThisClass, traversal, flags, Type.FIELD); + public Field findFieldInHierarchy(String name, String desc, SearchType searchType, Traversal traversal, int flags) { + return this.findInHierarchy(name, desc, searchType, traversal, flags, Type.FIELD); } /** @@ -1316,16 +1328,15 @@ public class ClassInfo extends TreeInfo { * * @param name Member name to search * @param desc Member descriptor - * @param includeThisClass True to return this class if the field exists - * here, or false to search only superclasses + * @param searchType Search strategy to use * @param traversal Traversal type to allow during this lookup * @param flags Inclusion flags * @param type Type of member to search for (field or method) * @return the discovered member or null if the member could not be resolved */ @SuppressWarnings("unchecked") - private M findInHierarchy(String name, String desc, boolean includeThisClass, Traversal traversal, int flags, Type type) { - if (includeThisClass) { + private M findInHierarchy(String name, String desc, SearchType searchType, Traversal traversal, int flags, Type type) { + if (searchType == SearchType.ALL_CLASSES) { M member = this.findMember(name, desc, flags, type); if (member != null) { return member; @@ -1344,7 +1355,8 @@ public class ClassInfo extends TreeInfo { ClassInfo superClassInfo = this.getSuperClass(); if (superClassInfo != null) { for (ClassInfo superTarget : superClassInfo.getTargets()) { - M member = superTarget.findInHierarchy(name, desc, true, traversal.next(), flags & ~ClassInfo.INCLUDE_PRIVATE, type); + M member = superTarget.findInHierarchy(name, desc, SearchType.ALL_CLASSES, traversal.next(), flags & ~ClassInfo.INCLUDE_PRIVATE, + type); if (member != null) { return member; } @@ -1359,7 +1371,7 @@ public class ClassInfo extends TreeInfo { continue; // throw new RuntimeException(new ClassNotFoundException(implemented)); } - M member = iface.findInHierarchy(name, desc, true, traversal.next(), flags & ~ClassInfo.INCLUDE_PRIVATE, type); + M member = iface.findInHierarchy(name, desc, SearchType.ALL_CLASSES, traversal.next(), flags & ~ClassInfo.INCLUDE_PRIVATE, type); if (member != null) { return this.isInterface ? member : (M)new InterfaceMethod(member); } 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 64d6132c..7ae07fce 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinPreProcessorStandard.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinPreProcessorStandard.java @@ -45,6 +45,7 @@ import org.spongepowered.asm.mixin.gen.Invoker; import org.spongepowered.asm.mixin.gen.throwables.InvalidAccessorException; 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.MixinInfo.MixinClassNode; import org.spongepowered.asm.mixin.transformer.MixinInfo.MixinMethodNode; import org.spongepowered.asm.mixin.transformer.meta.MixinRenamed; @@ -379,7 +380,7 @@ class MixinPreProcessorStandard { return; } - Method parentMethod = this.mixin.getClassInfo().findMethodInHierarchy(mixinMethod, false); + Method parentMethod = this.mixin.getClassInfo().findMethodInHierarchy(mixinMethod, SearchType.SUPER_CLASSES_ONLY); if (parentMethod != null && parentMethod.isRenamed()) { mixinMethod.name = method.renameTo(parentMethod.getName()); } @@ -510,7 +511,8 @@ class MixinPreProcessorStandard { AbstractInsnNode insn = iter.next(); if (insn instanceof MethodInsnNode) { MethodInsnNode methodNode = (MethodInsnNode)insn; - Method method = ClassInfo.forName(methodNode.owner).findMethodInHierarchy(methodNode, true, ClassInfo.INCLUDE_PRIVATE); + Method method = ClassInfo.forName(methodNode.owner).findMethodInHierarchy(methodNode, SearchType.ALL_CLASSES, + ClassInfo.INCLUDE_PRIVATE); if (method != null && method.isRenamed()) { methodNode.name = method.getName(); } 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 c8a27f9a..94d82066 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinTargetContext.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinTargetContext.java @@ -58,6 +58,7 @@ import org.spongepowered.asm.mixin.injection.throwables.InjectionValidationExcep import org.spongepowered.asm.mixin.refmap.IReferenceMapperContext; import org.spongepowered.asm.mixin.refmap.ReferenceMapper; import org.spongepowered.asm.mixin.transformer.ClassInfo.Field; +import org.spongepowered.asm.mixin.transformer.ClassInfo.SearchType; import org.spongepowered.asm.mixin.transformer.ClassInfo.Traversal; import org.spongepowered.asm.mixin.transformer.meta.MixinMerged; import org.spongepowered.asm.mixin.transformer.throwables.InvalidMixinException; @@ -386,7 +387,8 @@ public class MixinTargetContext implements IReferenceMapperContext { private void validateMethod(MethodNode method) { // Any method tagged with @SoftOverride must have an implementation visible from if (ASMHelper.getInvisibleAnnotation(method, SoftOverride.class) != null) { - ClassInfo.Method superMethod = this.targetClassInfo.findMethodInHierarchy(method.name, method.desc, false, Traversal.SUPER); + ClassInfo.Method superMethod = this.targetClassInfo.findMethodInHierarchy(method.name, method.desc, SearchType.SUPER_CLASSES_ONLY, + Traversal.SUPER); if (superMethod == null || !superMethod.isInjected()) { throw new InvalidMixinException(this, "Mixin method " + method.name + method.desc + " is tagged with @SoftOverride but no " + "valid method was found in superclasses of " + this.targetClass.getName()); @@ -658,7 +660,7 @@ public class MixinTargetContext implements IReferenceMapperContext { } ClassInfo.Method superMethod = this.targetClassInfo.findMethodInHierarchy(methodRef.getName(), methodRef.getDesc(), - traversal == Traversal.ALL, traversal); + traversal.getSearchType(), traversal); if (superMethod != null) { if (superMethod.getOwner().isMixin()) { throw new InvalidMixinException(this, "Invalid " + methodRef + " in " + this + " resolved " + superMethod.getOwner() diff --git a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinTransformerModuleInterfaceChecker.java b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinTransformerModuleInterfaceChecker.java index 89c88f0b..a634f22b 100644 --- a/src/main/java/org/spongepowered/asm/mixin/transformer/MixinTransformerModuleInterfaceChecker.java +++ b/src/main/java/org/spongepowered/asm/mixin/transformer/MixinTransformerModuleInterfaceChecker.java @@ -35,6 +35,7 @@ import java.util.Set; import org.apache.commons.io.IOUtils; import org.spongepowered.asm.mixin.transformer.ClassInfo.Method; +import org.spongepowered.asm.mixin.transformer.ClassInfo.SearchType; import org.spongepowered.asm.mixin.transformer.ClassInfo.Traversal; import org.spongepowered.asm.util.PrettyPrinter; import org.spongepowered.asm.util.SignaturePrinter; @@ -118,7 +119,7 @@ public class MixinTransformerModuleInterfaceChecker implements IMixinTransformer implementedMethods.addAll(this.interfaceMethods.removeAll(targetClassInfo)); for (Method method : interfaceMethods) { - Method found = targetClassInfo.findMethodInHierarchy(method.getName(), method.getDesc(), true, Traversal.ALL); + Method found = targetClassInfo.findMethodInHierarchy(method.getName(), method.getDesc(), SearchType.ALL_CLASSES, Traversal.ALL); // If method IS found and IS implemented, then do nothing (don't print an error) if (found != null && !found.isAbstract()) {