org.spongepowered.tools.obfuscation.ObfuscationDataProvider Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sponge-mixin Show documentation
Show all versions of sponge-mixin Show documentation
Fabric Mixin is a trait/mixin and bytecode weaving framework for Java using ASM.
The newest version!
/*
* 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.tools.obfuscation;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import org.spongepowered.asm.mixin.injection.selectors.ITargetSelectorRemappable;
import org.spongepowered.asm.mixin.injection.struct.MemberInfo;
import org.spongepowered.asm.obfuscation.mapping.IMapping;
import org.spongepowered.asm.obfuscation.mapping.IMapping.Type;
import org.spongepowered.asm.obfuscation.mapping.common.MappingField;
import org.spongepowered.asm.obfuscation.mapping.common.MappingMethod;
import org.spongepowered.tools.obfuscation.interfaces.IMixinAnnotationProcessor;
import org.spongepowered.tools.obfuscation.interfaces.IObfuscationDataProvider;
import org.spongepowered.tools.obfuscation.mirror.TypeHandle;
/**
* Implementation of obfuscation provider which queries all obfuscation
* environments to return mappings for each source member
*/
public class ObfuscationDataProvider implements IObfuscationDataProvider {
/**
* Annotation processor
*/
private final IMixinAnnotationProcessor ap;
/**
* Available obfuscation environments
*/
private final List environments;
public ObfuscationDataProvider(IMixinAnnotationProcessor ap, List environments) {
this.ap = ap;
this.environments = environments;
}
/* (non-Javadoc)
* @see org.spongepowered.tools.obfuscation.IObfuscationManager
* #getObfEntryRecursive(
* org.spongepowered.asm.mixin.injection.struct.MemberInfo)
*/
@Override
public ObfuscationData getObfEntryRecursive(final ITargetSelectorRemappable targetMember) {
ObfuscationData obfTargetNames = this.getObfClass(targetMember.getOwner());
ObfuscationData obfData = this.getObfEntry(targetMember);
try {
if (obfData.isEmpty()) {
obfData = this.getObfEntryRecursive(targetMember, new HashSet());
}
if (!obfData.isEmpty()) {
return ObfuscationDataProvider.applyParents(obfTargetNames, obfData);
}
} catch (Exception ex) {
ex.printStackTrace();
return this.getObfEntry(targetMember);
}
return obfData;
}
/**
* Depending on the structure of the available obfuscation data, mappings
* for inherited members may only be available on the specific superclass or
* interface in which the member is declared. To resolve these entries we
* recursively evaluate superclasses and interfaces in order to locate
* potential mappings
*
* @param targetMember The member being resolved
* @param visited Set of visited types, to avoid re-entrance or unnecessary
* revisiting of interfaces which are implemented at multiple levels of
* the hierarchy
* @return resolved obfuscation mappings if available
*/
private ObfuscationData getObfEntryRecursive(ITargetSelectorRemappable targetMember, Set visited) {
TypeHandle targetType = this.ap.getTypeProvider().getTypeHandle(targetMember.getOwner());
if (targetType == null || !visited.add(targetType.toString())) {
// Safe to return an empty collection here because if we are revisiting
// a type then we already failed to find a matching entry last time
return new ObfuscationData();
}
ObfuscationData obfData;
TypeHandle superClass = targetType.getSuperclass();
for (TypeHandle iface : targetType.getInterfaces()) {
obfData = this.getObfEntryUsing(targetMember, iface);
if (!obfData.isEmpty()) {
return obfData;
}
obfData = this.getObfEntryRecursive(targetMember.move(iface.getName()), visited);
if (!obfData.isEmpty()) {
return obfData;
}
}
if (superClass != null) {
obfData = this.getObfEntryUsing(targetMember, superClass);
if (!obfData.isEmpty()) {
return obfData;
}
return this.getObfEntryRecursive(targetMember.move(superClass.getName()), visited);
}
return new ObfuscationData();
}
/**
* Returns an obf entry for the specified member relocated into the
* specified target class. This is used by {@link #getObfEntryRecursive} to
* searh for matching obf entries in super classes an interfaces.
*
* @param targetMember target member to search for
* @param targetClass new target class to check, if the supplied argument is
* null then an empty dataset is returned
* @return obfuscation data for the relocated member
*/
private ObfuscationData getObfEntryUsing(ITargetSelectorRemappable targetMember, TypeHandle targetClass) {
return targetClass == null ? new ObfuscationData() : this.getObfEntry(targetMember.move(targetClass.getName()));
}
/* (non-Javadoc)
* @see org.spongepowered.tools.obfuscation.IObfuscationManager
* #getObfEntry(
* org.spongepowered.asm.mixin.injection.struct.MemberInfo)
*/
@Override
@SuppressWarnings("unchecked")
public ObfuscationData getObfEntry(ITargetSelectorRemappable targetMember) {
if (targetMember.isField()) {
return (ObfuscationData)this.getObfField(targetMember);
}
return (ObfuscationData)this.getObfMethod(targetMember.asMethodMapping());
}
@SuppressWarnings("unchecked")
@Override
public ObfuscationData getObfEntry(IMapping mapping) {
if (mapping != null) {
if (mapping.getType() == Type.FIELD) {
return (ObfuscationData)this.getObfField((MappingField)mapping);
} else if (mapping.getType() == Type.METHOD) {
return (ObfuscationData)this.getObfMethod((MappingMethod)mapping);
}
}
return new ObfuscationData();
}
/* (non-Javadoc)
* @see org.spongepowered.tools.obfuscation.IObfuscationManager
* #getObfMethodRecursive(
* org.spongepowered.asm.mixin.injection.struct.MemberInfo)
*/
@Override
public ObfuscationData getObfMethodRecursive(ITargetSelectorRemappable targetMember) {
return this.getObfEntryRecursive(targetMember);
}
/* (non-Javadoc)
* @see org.spongepowered.tools.obfuscation.IObfuscationManager
* #getObfMethod(
* org.spongepowered.asm.mixin.injection.struct.MemberInfo)
*/
@Override
public ObfuscationData getObfMethod(ITargetSelectorRemappable method) {
return this.getRemappedMethod(method, method.isConstructor());
}
@Override
public ObfuscationData getRemappedMethod(ITargetSelectorRemappable method) {
return this.getRemappedMethod(method, true);
}
private ObfuscationData getRemappedMethod(ITargetSelectorRemappable method, boolean remapDescriptor) {
ObfuscationData data = new ObfuscationData();
for (ObfuscationEnvironment env : this.environments) {
MappingMethod obfMethod = env.getObfMethod(method);
if (obfMethod != null) {
data.put(env.getType(), obfMethod);
}
}
if (!data.isEmpty() || !remapDescriptor) {
return data;
}
return this.remapDescriptor(data, method);
}
/* (non-Javadoc)
* @see org.spongepowered.tools.obfuscation.interfaces.IObfuscationProvider
* #getObfMethod(
* org.spongepowered.asm.obfuscation.mapping.common.MappingMethod)
*/
@Override
public ObfuscationData getObfMethod(MappingMethod method) {
return this.getRemappedMethod(method, method.isConstructor());
}
@Override
public ObfuscationData getRemappedMethod(MappingMethod method) {
return this.getRemappedMethod(method, true);
}
private ObfuscationData getRemappedMethod(MappingMethod method, boolean remapDescriptor) {
ObfuscationData data = new ObfuscationData();
for (ObfuscationEnvironment env : this.environments) {
MappingMethod obfMethod = env.getObfMethod(method);
if (obfMethod != null) {
data.put(env.getType(), obfMethod);
}
}
if (!data.isEmpty() || !remapDescriptor) {
return data;
}
return this.remapDescriptor(data, new MemberInfo(method));
}
/**
* Remap a method owner and descriptor only, used for remapping ctors
*
* @param data Output method data collection
* @param method Method to remap
* @return data
*/
public ObfuscationData remapDescriptor(ObfuscationData data, ITargetSelectorRemappable method) {
for (ObfuscationEnvironment env : this.environments) {
ITargetSelectorRemappable obfMethod = env.remapDescriptor(method);
if (obfMethod != null) {
data.put(env.getType(), obfMethod.asMethodMapping());
}
}
return data;
}
/* (non-Javadoc)
* @see org.spongepowered.tools.obfuscation.IObfuscationManager
* #getObfFieldRecursive(
* org.spongepowered.asm.mixin.injection.struct.MemberInfo)
*/
@Override
public ObfuscationData getObfFieldRecursive(ITargetSelectorRemappable targetMember) {
return this.getObfEntryRecursive(targetMember);
}
/* (non-Javadoc)
* @see org.spongepowered.tools.obfuscation.IObfuscationManager
* #getObfField(java.lang.String)
*/
@Override
public ObfuscationData getObfField(ITargetSelectorRemappable field) {
return this.getObfField(field.asFieldMapping());
}
/* (non-Javadoc)
* @see org.spongepowered.tools.obfuscation.IObfuscationManager
* #getObfField(java.lang.String)
*/
@Override
public ObfuscationData getObfField(MappingField field) {
ObfuscationData data = new ObfuscationData();
for (ObfuscationEnvironment env : this.environments) {
MappingField obfField = env.getObfField(field);
if (obfField != null) {
if (obfField.getDesc() == null && field.getDesc() != null) {
obfField = obfField.transform(env.remapDescriptor(field.getDesc()));
}
data.put(env.getType(), obfField);
}
}
return data;
}
/* (non-Javadoc)
* @see org.spongepowered.tools.obfuscation.IObfuscationManager
* #getObfClass(org.spongepowered.tools.obfuscation.TypeHandle)
*/
@Override
public ObfuscationData getObfClass(TypeHandle type) {
return this.getObfClass(type.getName());
}
/* (non-Javadoc)
* @see org.spongepowered.tools.obfuscation.IObfuscationManager
* #getObfClass(java.lang.String)
*/
@Override
public ObfuscationData getObfClass(String className) {
ObfuscationData data = new ObfuscationData(className);
for (ObfuscationEnvironment env : this.environments) {
String obfClass = env.getObfClass(className);
if (obfClass != null) {
data.put(env.getType(), obfClass);
}
}
return data;
}
/**
* Applies the supplied parent names to the supplied
*
* @param parents parent class names
* @param members members to reparent
* @return members for passthrough
*/
@SuppressWarnings("unchecked")
private static ObfuscationData applyParents(ObfuscationData parents, ObfuscationData members) {
for (ObfuscationType type : members) {
String obfClass = parents.get(type);
T obfMember = members.get(type);
members.put(type, (T)MemberInfo.fromMapping((IMapping)obfMember).move(obfClass).asMapping());
}
return members;
}
}