zaaarf/lillero-processor
1
0
Fork 0
mirror of https://github.com/zaaarf/lillero-processor.git synced 2024-11-14 17:59:20 +01:00
Code Issues Projects Releases Packages Wiki Activity

feat: anonymous and inner class handling, implemented united @Find

Browse source
This commit is contained in:
zaaarf 2023-03-18 19:30:31 +01:00
parent c446cca43e
commit 0e1e1bd3a4
No known key found for this signature in database
GPG key ID: 82240E075E31FA4C
4 changed files with 193 additions and 133 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
src/main/java/ftbsc/lll/exceptions/NotAProxyException.java Normal file
View file

@ -0,0 +1,21 @@
package ftbsc.lll.exceptions;
import ftbsc.lll.processor.annotations.Find;
import ftbsc.lll.proxies.FieldProxy;
import ftbsc.lll.proxies.MethodProxy;
/**
* Thrown when a method is annotated with {@link Find} but does not
* return a {@link MethodProxy} or a {@link FieldProxy}
*/
public class NotAProxyException extends RuntimeException {
/**
* Constructs a exception for the specified method.
* @param parent the FQN of the class containing the method
* @param method the name of the method wrongly annotated
*/
public NotAProxyException(String parent, String method) {
super(String.format("Annotated method %s::%s does not return a proxy!", parent, method));
}
}

82
src/main/java/ftbsc/lll/processor/LilleroProcessor.java
View file

@ -4,7 +4,9 @@ import com.squareup.javapoet.*;
import ftbsc.lll.IInjector; import ftbsc.lll.IInjector;
import ftbsc.lll.exceptions.AmbiguousDefinitionException; import ftbsc.lll.exceptions.AmbiguousDefinitionException;
import ftbsc.lll.exceptions.InvalidResourceException; import ftbsc.lll.exceptions.InvalidResourceException;
import ftbsc.lll.exceptions.NotAProxyException;
import ftbsc.lll.processor.annotations.*; import ftbsc.lll.processor.annotations.*;
import ftbsc.lll.processor.tools.ArrayContainer;
import ftbsc.lll.processor.tools.obfuscation.ObfuscationMapper; import ftbsc.lll.processor.tools.obfuscation.ObfuscationMapper;
import ftbsc.lll.proxies.FieldProxy; import ftbsc.lll.proxies.FieldProxy;
import ftbsc.lll.proxies.MethodProxy; import ftbsc.lll.proxies.MethodProxy;
@ -154,8 +156,13 @@ public class LilleroProcessor extends AbstractProcessor {
//find class information //find class information
Patch patchAnn = cl.getAnnotation(Patch.class); Patch patchAnn = cl.getAnnotation(Patch.class);
String targetClassFQN = String targetClassFQN =
findClassName(getClassFullyQualifiedName(patchAnn, Patch::value), this.mapper) findClassName(
.replace('/', '.'); getClassFullyQualifiedName(
patchAnn,
Patch::value,
getInnerName(patchAnn, Patch::innerClass, Patch::anonymousClassCounter)
), this.mapper
).replace('/', '.');
//find package information //find package information
Element packageElement = cl.getEnclosingElement(); Element packageElement = cl.getEnclosingElement();
@ -300,73 +307,58 @@ public class LilleroProcessor extends AbstractProcessor {
} }
/** /**
* Finds any method annotated with {@link FindMethod} or {@link FindField} within the given * Finds any method annotated with {@link Find} within the given class, generates
* class, and builds the {@link MethodSpec} necessary for building it. * the {@link MethodSpec} necessary for building it.
* @param cl the class to search * @param cl the class to search
* @return a {@link List} of method specs * @return a {@link List} of method specs
* @since 0.2.0 * @since 0.2.0
*/ */
private List<MethodSpec> generateRequestedProxies(TypeElement cl, ObfuscationMapper mapper) { private List<MethodSpec> generateRequestedProxies(TypeElement cl, ObfuscationMapper mapper) {
List<MethodSpec> generated = new ArrayList<>(); List<MethodSpec> generated = new ArrayList<>();
findAnnotatedMethods(cl, FindMethod.class) findAnnotatedMethods(cl, Find.class)
.stream() .stream()
.filter(m -> !m.getModifiers().contains(Modifier.STATIC)) //skip static stuff as we can't override it .filter(m -> !m.getModifiers().contains(Modifier.STATIC)) //skip static stuff as we can't override it
.filter(m -> !m.getModifiers().contains(Modifier.FINAL)) //in case someone is trying to be funny .filter(m -> !m.getModifiers().contains(Modifier.FINAL)) //in case someone is trying to be funny
.forEach(m -> { .forEach(m -> {
ExecutableElement targetMethod = (ExecutableElement) findMemberFromStub(m, processingEnv); boolean isMethod = isMethodProxyStub(m);
Element target = findMemberFromStub(m, processingEnv);
MethodSpec.Builder b = MethodSpec.overriding(m); MethodSpec.Builder b = MethodSpec.overriding(m);
String targetParentFQN = findClassName(((TypeElement) targetMethod.getEnclosingElement()).getQualifiedName().toString(), mapper); String targetParentFQN = findClassName(((TypeElement) target.getEnclosingElement()).getQualifiedName().toString(), mapper);
String methodDescriptor = isMethod ? descriptorFromExecutableElement((ExecutableElement) target) : null;
b.addStatement("$T bd = $T.builder($S)", b.addStatement("$T bd = $T.builder($S)",
MethodProxy.Builder.class, MethodProxy.Builder.class,
MethodProxy.class, MethodProxy.class,
findMemberName(targetParentFQN, targetMethod.getSimpleName().toString(), descriptorFromExecutableElement(targetMethod), mapper) findMemberName(targetParentFQN, target.getSimpleName().toString(), methodDescriptor, mapper)
); );
b.addStatement("bd.setParent($S)", targetParentFQN); b.addStatement("bd.setParent($S)", targetParentFQN);
for(Modifier mod : targetMethod.getModifiers()) for(Modifier mod : target.getModifiers())
b.addStatement("bd.addModifier($L)", mapModifier(mod)); b.addStatement("bd.addModifier($L)", mapModifier(mod));
if(isMethod) {
ExecutableElement targetMethod = (ExecutableElement) target;
for(VariableElement p : targetMethod.getParameters()) { for(VariableElement p : targetMethod.getParameters()) {
if(p.asType().getKind().isPrimitive()) ArrayContainer param = new ArrayContainer(p.asType());
b.addStatement("bd.addParameter($T.class)", p.asType()); b.addStatement(
else b.addStatement("bd.addParameter($S, $L)", getInnermostComponentType(p.asType()), getArrayLevel(p.asType())); "bd.addParameter($S, $L)",
} param.innermostComponent,
param.arrayLevel
if(targetMethod.getReturnType().getKind().isPrimitive())
b.addStatement("bd.setReturnType($T.class)", targetMethod.getReturnType());
else b.addStatement("bd.setReturnType($S, $L)", getInnermostComponentType(targetMethod.getReturnType()), getArrayLevel(targetMethod.getReturnType()));
b.addStatement("return bd.build()");
generated.add(b.build());
});
findAnnotatedMethods(cl, FindField.class)
.stream()
.filter(m -> !m.getModifiers().contains(Modifier.STATIC))
.filter(m -> !m.getModifiers().contains(Modifier.FINAL))
.forEach(m -> {
VariableElement targetField = (VariableElement) findMemberFromStub(m, processingEnv);
MethodSpec.Builder b = MethodSpec.overriding(m);
String targetParentFQN = findClassName(((TypeElement) targetField.getEnclosingElement()).getQualifiedName().toString(), mapper);
b.addStatement("$T bd = $T.builder($S)",
FieldProxy.Builder.class,
FieldProxy.class,
findMemberName(targetParentFQN, targetField.getSimpleName().toString(), null, mapper)
); );
}
b.addStatement("bd.setParent($S)", ((TypeElement) targetField.getEnclosingElement()).getQualifiedName().toString()); ArrayContainer ret = new ArrayContainer(targetMethod.getReturnType());
b.addStatement(
for(Modifier mod : targetField.getModifiers()) "bd.setReturnType($S, $L)",
b.addStatement("bd.addModifier($L)", mapModifier(mod)); ret.innermostComponent,
ret.arrayLevel
if(targetField.asType().getKind().isPrimitive()) );
b.addStatement("bd.setType($T.class)", targetField.asType()); } else {
else b.addStatement("bd.setType($S, $L)", getInnermostComponentType(targetField.asType()), getArrayLevel(targetField.asType())); ArrayContainer arr = new ArrayContainer(target.asType());
b.addStatement("bd.setType($S, $L)", arr.innermostComponent, arr.arrayLevel);
}
b.addStatement("return bd.build()"); b.addStatement("return bd.build()");

165
src/main/java/ftbsc/lll/processor/tools/ASTUtils.java
View file

@ -3,12 +3,14 @@ package ftbsc.lll.processor.tools;
import com.squareup.javapoet.*; import com.squareup.javapoet.*;
import ftbsc.lll.exceptions.AmbiguousDefinitionException; import ftbsc.lll.exceptions.AmbiguousDefinitionException;
import ftbsc.lll.exceptions.MappingNotFoundException; import ftbsc.lll.exceptions.MappingNotFoundException;
import ftbsc.lll.exceptions.NotAProxyException;
import ftbsc.lll.exceptions.TargetNotFoundException; import ftbsc.lll.exceptions.TargetNotFoundException;
import ftbsc.lll.processor.annotations.FindField; import ftbsc.lll.processor.annotations.Find;
import ftbsc.lll.processor.annotations.FindMethod;
import ftbsc.lll.processor.annotations.Patch; import ftbsc.lll.processor.annotations.Patch;
import ftbsc.lll.processor.annotations.Target; import ftbsc.lll.processor.annotations.Target;
import ftbsc.lll.processor.tools.obfuscation.ObfuscationMapper; import ftbsc.lll.processor.tools.obfuscation.ObfuscationMapper;
import ftbsc.lll.proxies.FieldProxy;
import ftbsc.lll.proxies.MethodProxy;
import javax.annotation.processing.ProcessingEnvironment; import javax.annotation.processing.ProcessingEnvironment;
import javax.lang.model.element.*; import javax.lang.model.element.*;
@ -81,47 +83,46 @@ public class ASTUtils {
} }
} }
/**
* Calculates the array nesting level for a {@link TypeMirror}.
* @param t the type mirror to get it for
* @return the array nesting level
* @since 0.3.0
*/
public static int getArrayLevel(TypeMirror t) {
int arrayLevel = 0;
while(t.getKind() == TypeKind.ARRAY) {
t = ((ArrayType) t).getComponentType();
arrayLevel++;
}
return arrayLevel;
}
/**
* Calculates the array nesting level for a {@link TypeMirror}.
* @param t the type mirror to get it for
* @return the array nesting level
* @since 0.3.0
*/
public static TypeMirror getInnermostComponentType(TypeMirror t) {
while(t.getKind() == TypeKind.ARRAY)
t = ((ArrayType) t).getComponentType();
return t;
}
/** /**
* Safely extracts a {@link Class} from an annotation and gets its fully qualified name. * Safely extracts a {@link Class} from an annotation and gets its fully qualified name.
* @param ann the annotation containing the class * @param ann the annotation containing the class
* @param fun the annotation function returning the class * @param parentFunction the annotation function returning the class
* @param innerName a string containing the inner class name or anonymous class number, may be null
* @param <T> the type of the annotation carrying the information * @param <T> the type of the annotation carrying the information
* @return the fully qualified name of the given class * @return the fully qualified name of the given class
* @since 0.3.0 * @since 0.3.0
*/ */
public static <T extends Annotation> String getClassFullyQualifiedName(T ann, Function<T, Class<?>> fun) { public static <T extends Annotation> String getClassFullyQualifiedName(T ann, Function<T, Class<?>> parentFunction, String innerName) {
String fqn;
try { try {
return fun.apply(ann).getCanonicalName(); fqn = parentFunction.apply(ann).getCanonicalName();
} catch(MirroredTypeException e) { } catch(MirroredTypeException e) {
return e.getTypeMirror().toString(); fqn = e.getTypeMirror().toString();
} }
if(innerName != null)
fqn = String.format("%s$%s", fqn, innerName);
return fqn;
}
/**
* Extracts
* @param ann the annotation containing the class
* @param innerClassFunction the annotation function returning the inner class name
* @param anonymousCounterFunction the annotation function returning the anonymous class counter
* @param <T> the type of the annotation carrying the information
* @return the fully qualified name of the given class
* @since 0.3.0
*/
public static <T extends Annotation> String getInnerName(T ann, Function<T, String> innerClassFunction, Function<T, Integer> anonymousCounterFunction) {
String inner = null;
if(!innerClassFunction.apply(ann).equals(""))
inner = innerClassFunction.apply(ann);
if(anonymousCounterFunction.apply(ann) != 0) {
if(inner != null)
throw new AmbiguousDefinitionException(String.format("Unclear inner class, is it %s or %d?", inner, anonymousCounterFunction.apply(ann)));
else inner = anonymousCounterFunction.apply(ann).toString();
}
return inner;
} }
/** /**
@ -166,18 +167,27 @@ public class ASTUtils {
* Finds the class name and maps it to the correct format. * Finds the class name and maps it to the correct format.
* @param patchAnn the {@link Patch} annotation containing target class info * @param patchAnn the {@link Patch} annotation containing target class info
* @param finderAnn an annotation containing metadata about the target, may be null * @param finderAnn an annotation containing metadata about the target, may be null
* @param parentFun the function to get the parent from the finderAnn
* @return the fully qualified class name * @return the fully qualified class name
* @since 0.3.0 * @since 0.3.0
*/ */
private static <T extends Annotation> String findClassName(Patch patchAnn, T finderAnn, Function<T, Class<?>> parentFun) { private static String findClassName(Patch patchAnn, Find finderAnn) {
String fullyQualifiedName; String fullyQualifiedName;
if(finderAnn != null) { if(finderAnn != null) {
fullyQualifiedName = getClassFullyQualifiedName(finderAnn, parentFun); fullyQualifiedName =
getClassFullyQualifiedName(
finderAnn,
Find::parent,
getInnerName(finderAnn, Find::parentInnerClass, Find::parentAnonymousClassCounter)
);
if(!fullyQualifiedName.equals("java.lang.Object")) if(!fullyQualifiedName.equals("java.lang.Object"))
return findClassName(fullyQualifiedName, null); return findClassName(fullyQualifiedName, null);
} }
fullyQualifiedName = getClassFullyQualifiedName(patchAnn, Patch::value); fullyQualifiedName =
getClassFullyQualifiedName(
patchAnn,
Patch::value,
getInnerName(patchAnn, Patch::innerClass, Patch::anonymousClassCounter)
);
return findClassName(fullyQualifiedName, null); return findClassName(fullyQualifiedName, null);
} }
@ -199,32 +209,32 @@ public class ASTUtils {
} }
/** /**
* Finds a method given name, container and descriptor. * Finds a member given the name, the container class and (if it's a method) the descriptor.
* @param parentFQN the fully qualified name of the parent class of the method * @param parentFQN the fully qualified name of the parent class
* @param name the name to search for * @param name the name to search for
* @param descr the descriptor to search for * @param descr the descriptor to search for, or null if it's not a method
* @param strict whether the search should be strict (see {@link Target#strict()} for more info) * @param strict whether the search should be strict (see {@link Target#strict()} for more info),
* only applies to method searches
* @param field whether the member being searched is a field
* @param env the {@link ProcessingEnvironment} to perform the operation in * @param env the {@link ProcessingEnvironment} to perform the operation in
* @return the desired method, if it exists * @return the desired member, if it exists
* @throws AmbiguousDefinitionException if it finds more than one candidate * @throws AmbiguousDefinitionException if it finds more than one candidate
* @throws TargetNotFoundException if it finds no valid candidate * @throws TargetNotFoundException if it finds no valid candidate
* @since 0.3.0 * @since 0.3.0
*/ */
private static ExecutableElement findMethod(String parentFQN, String name, String descr, boolean strict, ProcessingEnvironment env) { private static Element findMember(String parentFQN, String name, String descr, boolean strict, boolean field, ProcessingEnvironment env) {
TypeElement parent = env.getElementUtils().getTypeElement(parentFQN); TypeElement parent = env.getElementUtils().getTypeElement(parentFQN);
if(parent == null) if(parent == null)
throw new AmbiguousDefinitionException(String.format("Could not find parent class %s!", parentFQN)); throw new AmbiguousDefinitionException(String.format("Could not find parent class %s!", parentFQN));
//try to find by name //try to find by name
List<ExecutableElement> candidates = parent.getEnclosedElements() List<Element> candidates = parent.getEnclosedElements()
.stream() .stream()
.filter(e -> e instanceof ExecutableElement) .filter(e -> (field && e instanceof VariableElement) || e instanceof ExecutableElement)
.map(e -> (ExecutableElement) e)
.filter(e -> e.getSimpleName().contentEquals(name)) .filter(e -> e.getSimpleName().contentEquals(name))
.collect(Collectors.toList()); .collect(Collectors.toList());
if(candidates.size() == 0) if(candidates.size() == 0)
throw new TargetNotFoundException(String.format("%s %s", name, descr)); throw new TargetNotFoundException(String.format("%s %s", name, descr));
if(candidates.size() == 1 && !strict) if(candidates.size() == 1 && (!strict || field))
return candidates.get(0); return candidates.get(0);
if(descr == null) { if(descr == null) {
throw new AmbiguousDefinitionException( throw new AmbiguousDefinitionException(
@ -232,6 +242,7 @@ public class ASTUtils {
); );
} else { } else {
candidates = candidates.stream() candidates = candidates.stream()
.map(e -> (ExecutableElement) e)
.filter(strict .filter(strict
? c -> descr.equals(descriptorFromExecutableElement(c)) ? c -> descr.equals(descriptorFromExecutableElement(c))
: c -> descr.split("\\)")[0].equalsIgnoreCase(descriptorFromExecutableElement(c).split("\\)")[0]) : c -> descr.split("\\)")[0].equalsIgnoreCase(descriptorFromExecutableElement(c).split("\\)")[0])
@ -248,7 +259,7 @@ public class ASTUtils {
/** /**
* Finds the real class member (field or method) corresponding to a stub annotated with * Finds the real class member (field or method) corresponding to a stub annotated with
* {@link Target} or {@link FindMethod} or {@link FindField}. * {@link Target} or {@link Find}.
* @param stub the {@link ExecutableElement} for the stub * @param stub the {@link ExecutableElement} for the stub
* @param env the {@link ProcessingEnvironment} to perform the operation in * @param env the {@link ProcessingEnvironment} to perform the operation in
* @return the {@link Element} corresponding to the method or field * @return the {@link Element} corresponding to the method or field
@ -259,44 +270,42 @@ public class ASTUtils {
public static Element findMemberFromStub(ExecutableElement stub, ProcessingEnvironment env) { public static Element findMemberFromStub(ExecutableElement stub, ProcessingEnvironment env) {
//the parent always has a @Patch annotation //the parent always has a @Patch annotation
Patch patchAnn = stub.getEnclosingElement().getAnnotation(Patch.class); Patch patchAnn = stub.getEnclosingElement().getAnnotation(Patch.class);
//there should ever only be one of these //there should ever only be one of these two
Target targetAnn = stub.getAnnotation(Target.class); //if this is null strict mode is always disabled Target targetAnn = stub.getAnnotation(Target.class); //if this is null strict mode is always disabled
FindMethod findMethodAnn = stub.getAnnotation(FindMethod.class); //this may be null, it means no fallback info Find findAnn = stub.getAnnotation(Find.class); //this may be null, it means no fallback info
FindField findFieldAnn = stub.getAnnotation(FindField.class); String parentFQN = findClassName(patchAnn, findAnn);
String parentFQN, memberName;
if(findFieldAnn == null) { //methods
parentFQN = findClassName(patchAnn, findMethodAnn, FindMethod::parent);
String methodDescriptor = String methodDescriptor =
findMethodAnn != null findAnn != null
? methodDescriptorFromParams(findMethodAnn, FindMethod::params, env.getElementUtils()) ? methodDescriptorFromParams(findAnn, Find::params, env.getElementUtils())
: descriptorFromExecutableElement(stub); : descriptorFromExecutableElement(stub);
memberName = String memberName =
findMethodAnn != null && !findMethodAnn.name().equals("") findAnn != null && !findAnn.name().equals("")
? findMethodAnn.name() ? findAnn.name()
: stub.getSimpleName().toString(); : stub.getSimpleName().toString();
return findMethod( return findMember(
parentFQN, parentFQN,
memberName, memberName,
methodDescriptor, methodDescriptor,
targetAnn != null && targetAnn.strict(), targetAnn != null && targetAnn.strict(),
!isMethodProxyStub(stub),
env env
); );
} else { //fields }
parentFQN = findClassName(patchAnn, findFieldAnn, FindField::parent);
memberName = findFieldAnn.name().equals("") /**
? stub.getSimpleName().toString() * Utility method for finding out what type of proxy a method is.
: findFieldAnn.name(); * It will fail if the return type is not a known type of proxy.
TypeElement parent = env.getElementUtils().getTypeElement(parentFQN); * @param m the annotated {@link ExecutableElement}
List<VariableElement> candidates = * @return whether it returns a {@link MethodProxy} or a {@link FieldProxy}
parent.getEnclosedElements() * @throws NotAProxyException if it's neither
.stream() * @since 0.4.0
.filter(f -> f instanceof VariableElement) */
.filter(f -> f.getSimpleName().contentEquals(memberName)) public static boolean isMethodProxyStub(ExecutableElement m) {
.map(f -> (VariableElement) f) String returnTypeFQN = m.getReturnType().toString();
.collect(Collectors.toList()); if(returnTypeFQN.equals("ftbsc.lll.proxies.FieldProxy"))
if(candidates.size() == 0) return false;
throw new TargetNotFoundException(stub.getSimpleName().toString()); else if(returnTypeFQN.equals("ftbsc.lll.proxies.MethodProxy"))
else return candidates.get(0); //there can only ever be one return true;
} else throw new NotAProxyException(m.getEnclosingElement().getSimpleName().toString(), m.getSimpleName().toString());
} }
} }

38
src/main/java/ftbsc/lll/processor/tools/ArrayContainer.java Normal file
View file

@ -0,0 +1,38 @@
package ftbsc.lll.processor.tools;
import javax.lang.model.type.ArrayType;
import javax.lang.model.type.TypeKind;
import javax.lang.model.type.TypeMirror;
/**
* Utility class that extrapolates information from a {@link TypeMirror},
* making it considerably easier to get informations about an
* array.
* @since 0.4.0
*/
public class ArrayContainer {
/**
* The nesting level of the array - a type who is not an array will have 0.
*/
public final int arrayLevel;
/**
* The innermost component of the array, corresponding to the type of the base
* component.
*/
public final TypeMirror innermostComponent;
/**
* Creates a new {@link ArrayContainer} from a {@link TypeMirror}.
* @param t the {@link TypeMirror} representing the type.
*/
public ArrayContainer(TypeMirror t) {
int arrayLevel = 0;
while(t.getKind() == TypeKind.ARRAY) {
t = ((ArrayType) t).getComponentType();
arrayLevel++;
}
this.arrayLevel = arrayLevel;
this.innermostComponent = t;
}
}