/*
* Copyright 2014, Google Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jf.dexlib2.rewriter;
import org.jf.dexlib2.Opcodes;
import org.jf.dexlib2.iface.*;
import org.jf.dexlib2.iface.debug.DebugItem;
import org.jf.dexlib2.iface.instruction.Instruction;
import org.jf.dexlib2.iface.reference.FieldReference;
import org.jf.dexlib2.iface.reference.MethodReference;
import org.jf.dexlib2.iface.value.EncodedValue;
import javax.annotation.Nonnull;
import java.util.Set;
/**
* Out-of-the box, this class does nothing except make a picture-perfect copy of a dex file.
*
* However, it provides many points where you can hook into this process and selectively modify
* the dex file. For example, If you want to rename all instances (including definitions and references)
* of the class Lorg/blah/MyBlah; to Lorg/blah/YourBlah;
*
* <pre>
* {@code
* DexRewriter rewriter = new DexRewriter(new RewriterModule() {
* public Rewriter<String> getTypeRewriter(Rewriters rewriters) {
* return new Rewriter<String>() {
* public String rewrite(String value) {
* if (value.equals("Lorg/blah/MyBlah;")) {
* return "Lorg/blah/YourBlah;";
* }
* return value;
* }
* };
* }
* });
* DexFile rewrittenDexFile = rewriter.rewriteDexFile(dexFile);
* }
* </pre>
*/
public class DexRewriter implements Rewriters {
private final Rewriter<ClassDef> classDefRewriter;
private final Rewriter<Field> fieldRewriter;
private final Rewriter<Method> methodRewriter;
private final Rewriter<MethodParameter> methodParameterRewriter;
private final Rewriter<MethodImplementation> methodImplementationRewriter;
private final Rewriter<Instruction> instructionRewriter;
private final Rewriter<TryBlock<? extends ExceptionHandler>> tryBlockRewriter;
private final Rewriter<ExceptionHandler> exceptionHandlerRewriter;
private final Rewriter<DebugItem> debugItemRewriter;
private final Rewriter<String> typeRewriter;
private final Rewriter<FieldReference> fieldReferenceRewriter;
private final Rewriter<MethodReference> methodReferenceRewriter;
private final Rewriter<Annotation> annotationRewriter;
private final Rewriter<AnnotationElement> annotationElementRewriter;
private final Rewriter<EncodedValue> encodedValueRewriter;
public DexRewriter(RewriterModule module) {
this.classDefRewriter = module.getClassDefRewriter(this);
this.fieldRewriter = module.getFieldRewriter(this);
this.methodRewriter = module.getMethodRewriter(this);
this.methodParameterRewriter = module.getMethodParameterRewriter(this);
this.methodImplementationRewriter = module.getMethodImplementationRewriter(this);
this.instructionRewriter = module.getInstructionRewriter(this);
this.tryBlockRewriter = module.getTryBlockRewriter(this);
this.exceptionHandlerRewriter = module.getExceptionHandlerRewriter(this);
this.debugItemRewriter = module.getDebugItemRewriter(this);
this.typeRewriter = module.getTypeRewriter(this);
this.fieldReferenceRewriter = module.getFieldReferenceRewriter(this);
this.methodReferenceRewriter = module.getMethodReferenceRewriter(this);
this.annotationRewriter = module.getAnnotationRewriter(this);
this.annotationElementRewriter = module.getAnnotationElementRewriter(this);
this.encodedValueRewriter = module.getEncodedValueRewriter(this);
}
@Nonnull
public DexFile rewriteDexFile(@Nonnull DexFile dexFile) {
return new RewrittenDexFile(dexFile);
}
protected class RewrittenDexFile implements DexFile {
@Nonnull protected final DexFile dexFile;
public RewrittenDexFile(@Nonnull DexFile dexFile) {
this.dexFile = dexFile;
}
@Override @Nonnull public Set<? extends ClassDef> getClasses() {
return RewriterUtils.rewriteSet(getClassDefRewriter(), dexFile.getClasses());
}
@Nonnull @Override public Opcodes getOpcodes() {
return dexFile.getOpcodes();
}
}
@Nonnull @Override public Rewriter<ClassDef> getClassDefRewriter() { return classDefRewriter; }
@Nonnull @Override public Rewriter<Field> getFieldRewriter() { return fieldRewriter; }
@Nonnull @Override public Rewriter<Method> getMethodRewriter() { return methodRewriter; }
@Nonnull @Override public Rewriter<MethodParameter> getMethodParameterRewriter() { return methodParameterRewriter; }
@Nonnull @Override public Rewriter<MethodImplementation> getMethodImplementationRewriter() { return methodImplementationRewriter; }
@Nonnull @Override public Rewriter<Instruction> getInstructionRewriter() { return instructionRewriter; }
@Nonnull @Override public Rewriter<TryBlock<? extends ExceptionHandler>> getTryBlockRewriter() { return tryBlockRewriter; }
@Nonnull @Override public Rewriter<ExceptionHandler> getExceptionHandlerRewriter() { return exceptionHandlerRewriter; }
@Nonnull @Override public Rewriter<DebugItem> getDebugItemRewriter() { return debugItemRewriter; }
@Nonnull @Override public Rewriter<String> getTypeRewriter() { return typeRewriter; }
@Nonnull @Override public Rewriter<FieldReference> getFieldReferenceRewriter() { return fieldReferenceRewriter; }
@Nonnull @Override public Rewriter<MethodReference> getMethodReferenceRewriter() { return methodReferenceRewriter; }
@Nonnull @Override public Rewriter<Annotation> getAnnotationRewriter() { return annotationRewriter; }
@Nonnull @Override public Rewriter<AnnotationElement> getAnnotationElementRewriter() { return annotationElementRewriter; }
@Nonnull @Override public Rewriter<EncodedValue> getEncodedValueRewriter() { return encodedValueRewriter; }
}