Package org.jf.dexlib2.writer

Class DexWriter<StringKey extends CharSequence,StringRef extends StringReference,TypeKey extends CharSequence,TypeRef extends TypeReference,ProtoRefKey extends MethodProtoReference,FieldRefKey extends FieldReference,MethodRefKey extends MethodReference,ClassKey extends Comparable<? super ClassKey>,CallSiteKey extends CallSiteReference,MethodHandleKey extends MethodHandleReference,AnnotationKey extends Annotation,AnnotationSetKey,TypeListKey,FieldKey,MethodKey,EncodedArrayKey,EncodedValue,AnnotationElement extends AnnotationElement,StringSectionType extends StringSection<StringKey,StringRef>,TypeSectionType extends TypeSection<StringKey,TypeKey,TypeRef>,ProtoSectionType extends ProtoSection<StringKey,TypeKey,ProtoRefKey,TypeListKey>,FieldSectionType extends FieldSection<StringKey,TypeKey,FieldRefKey,FieldKey>,MethodSectionType extends MethodSection<StringKey,TypeKey,ProtoRefKey,MethodRefKey,MethodKey>,ClassSectionType extends ClassSection<StringKey,TypeKey,TypeListKey,ClassKey,FieldKey,MethodKey,AnnotationSetKey,EncodedArrayKey>,CallSiteSectionType extends CallSiteSection<CallSiteKey,EncodedArrayKey>,MethodHandleSectionType extends MethodHandleSection<MethodHandleKey,FieldRefKey,MethodRefKey>,TypeListSectionType extends TypeListSection<TypeKey,TypeListKey>,AnnotationSectionType extends AnnotationSection<StringKey,TypeKey,AnnotationKey,AnnotationElement,EncodedValue>,AnnotationSetSectionType extends AnnotationSetSection<AnnotationKey,AnnotationSetKey>,EncodedArraySectionType extends EncodedArraySection<EncodedArrayKey,EncodedValue>>

java.lang.Object

org.jf.dexlib2.writer.DexWriter<StringKey,StringRef,TypeKey,TypeRef,ProtoRefKey,FieldRefKey,MethodRefKey,ClassKey,CallSiteKey,MethodHandleKey,AnnotationKey,AnnotationSetKey,TypeListKey,FieldKey,MethodKey,EncodedArrayKey,EncodedValue,AnnotationElement,StringSectionType,TypeSectionType,ProtoSectionType,FieldSectionType,MethodSectionType,ClassSectionType,CallSiteSectionType,MethodHandleSectionType,TypeListSectionType,AnnotationSectionType,AnnotationSetSectionType,EncodedArraySectionType>

Direct Known Subclasses:

DexBuilder, DexPool

public abstract class DexWriter<StringKey extends CharSequence,StringRef extends StringReference,TypeKey extends CharSequence,TypeRef extends TypeReference,ProtoRefKey extends MethodProtoReference,FieldRefKey extends FieldReference,MethodRefKey extends MethodReference,ClassKey extends Comparable<? super ClassKey>,CallSiteKey extends CallSiteReference,MethodHandleKey extends MethodHandleReference,AnnotationKey extends Annotation,AnnotationSetKey,TypeListKey,FieldKey,MethodKey,EncodedArrayKey,EncodedValue,AnnotationElement extends AnnotationElement,StringSectionType extends StringSection<StringKey,StringRef>,TypeSectionType extends TypeSection<StringKey,TypeKey,TypeRef>,ProtoSectionType extends ProtoSection<StringKey,TypeKey,ProtoRefKey,TypeListKey>,FieldSectionType extends FieldSection<StringKey,TypeKey,FieldRefKey,FieldKey>,MethodSectionType extends MethodSection<StringKey,TypeKey,ProtoRefKey,MethodRefKey,MethodKey>,ClassSectionType extends ClassSection<StringKey,TypeKey,TypeListKey,ClassKey,FieldKey,MethodKey,AnnotationSetKey,EncodedArrayKey>,CallSiteSectionType extends CallSiteSection<CallSiteKey,EncodedArrayKey>,MethodHandleSectionType extends MethodHandleSection<MethodHandleKey,FieldRefKey,MethodRefKey>,TypeListSectionType extends TypeListSection<TypeKey,TypeListKey>,AnnotationSectionType extends AnnotationSection<StringKey,TypeKey,AnnotationKey,AnnotationElement,EncodedValue>,AnnotationSetSectionType extends AnnotationSetSection<AnnotationKey,AnnotationSetKey>,EncodedArraySectionType extends EncodedArraySection<EncodedArrayKey,EncodedValue>>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	DexWriter.CodeItemOffset<MethodKey>
protected class	DexWriter.InternalEncodedValueWriter
private static class	DexWriter.RestrictionsWriter
class	DexWriter.SectionProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected int	annotationDirectorySectionOffset
final AnnotationSectionType	annotationSection
protected int	annotationSectionOffset
protected int	annotationSetRefSectionOffset
final AnnotationSetSectionType	annotationSetSection
protected int	annotationSetSectionOffset
private Comparator<Map.Entry<? extends CallSiteKey,Integer>>	callSiteComparator
final CallSiteSectionType	callSiteSection
protected int	callSiteSectionOffset
protected int	classDataSectionOffset
protected int	classIndexSectionOffset
final ClassSectionType	classSection
protected int	codeSectionOffset
protected int	debugSectionOffset
final EncodedArraySectionType	encodedArraySection
protected int	encodedArraySectionOffset
final FieldSectionType	fieldSection
protected int	fieldSectionOffset
protected boolean	hasHiddenApiRestrictions
protected int	hiddenApiRestrictionsOffset
protected int	mapSectionOffset
static final int	MAX_POOL_SIZE
final MethodHandleSectionType	methodHandleSection
protected int	methodHandleSectionOffset
final MethodSectionType	methodSection
protected int	methodSectionOffset
static final int	NO_INDEX
static final int	NO_OFFSET
protected int	numAnnotationDirectoryItems
protected int	numAnnotationSetRefItems
protected int	numClassDataItems
protected int	numCodeItemItems
protected int	numDebugInfoItems
protected final Opcodes	opcodes
private final IndexSection<?>[]	overflowableSections
final ProtoSectionType	protoSection
protected int	protoSectionOffset
protected int	stringDataSectionOffset
protected int	stringIndexSectionOffset
final StringSectionType	stringSection
private static Comparator<Map.Entry>	toStringKeyComparator
final TypeListSectionType	typeListSection
protected int	typeListSectionOffset
final TypeSectionType	typeSection
protected int	typeSectionOffset

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DexWriter(Opcodes opcodes)

Method Summary

Modifier and Type	Method	Description
private int	calcNumItems()
private static <T extends Comparable<? super T>> Comparator<Map.Entry<? extends T,?>>	comparableKeyComparator()
private void	fixInstructions(MutableMethodImplementation methodImplementation)
private int	getDataSectionOffset()
List<String>	getFieldReferences()
List<String>	getMethodReferences()
protected abstract DexWriter<StringKey,StringRef,TypeKey,TypeRef,ProtoRefKey,FieldRefKey,MethodRefKey,ClassKey,CallSiteKey,MethodHandleKey,AnnotationKey,AnnotationSetKey,TypeListKey,FieldKey,MethodKey,EncodedArrayKey,EncodedValue,AnnotationElement,StringSectionType,TypeSectionType,ProtoSectionType,FieldSectionType,MethodSectionType,ClassSectionType,CallSiteSectionType,MethodHandleSectionType,TypeListSectionType,AnnotationSectionType,AnnotationSetSectionType,EncodedArraySectionType>.SectionProvider	getSectionProvider()
List<String>	getTypeReferences()
boolean	hasOverflowed()	Checks whether any of the size-sensitive constant pools have overflowed and have more than 64Ki entries.
boolean	hasOverflowed(int maxPoolSize)	Checks whether any of the size-sensitive constant pools have more than the supplied maximum number of entries.
private static DexDataWriter	outputAt(DexDataStore dataStore, int filePosition)
private boolean	shouldCreateEmptyAnnotationSet()
private boolean	shouldWriteHiddenApiRestrictions()
private void	updateChecksum(DexDataStore dataStore)
private void	updateSignature(DexDataStore dataStore)
private void	writeAnnotationDirectories(DexDataWriter writer)
private void	writeAnnotations(DexDataWriter writer)
private void	writeAnnotationSetRefs(DexDataWriter writer)
private void	writeAnnotationSets(DexDataWriter writer)
private void	writeCallSites(DexDataWriter writer)
private int	writeClass(DexDataWriter indexWriter, DexDataWriter offsetWriter, int nextIndex, Map.Entry<? extends ClassKey,Integer> entry)	Writes out the class_def_item and class_data_item for the given class.
private void	writeClasses(DexDataStore dataStore, DexDataWriter indexWriter, DexDataWriter offsetWriter)
private int	writeCodeItem(DexDataWriter writer, ByteArrayOutputStream ehBuf, MethodKey methodKey, List<? extends TryBlock<? extends ExceptionHandler>> tryBlocks, Iterable<? extends Instruction> instructions, int debugItemOffset)
private void	writeDebugAndCodeItems(DexDataWriter offsetWriter, DeferredOutputStream temp)
private int	writeDebugItem(DexDataWriter writer, DebugWriter<StringKey,TypeKey> debugWriter, Iterable<? extends StringKey> parameterNames, Iterable<? extends DebugItem> debugItems)
private void	writeEncodedArrays(DexDataWriter writer)
private void	writeEncodedFields(DexDataWriter writer, Collection<? extends FieldKey> fields)
private void	writeEncodedMethods(DexDataWriter writer, Collection<? extends MethodKey> methods)
protected abstract void	writeEncodedValue(DexWriter<StringKey,StringRef,TypeKey,TypeRef,ProtoRefKey,FieldRefKey,MethodRefKey,ClassKey,CallSiteKey,MethodHandleKey,AnnotationKey,AnnotationSetKey,TypeListKey,FieldKey,MethodKey,EncodedArrayKey,EncodedValue,AnnotationElement,StringSectionType,TypeSectionType,ProtoSectionType,FieldSectionType,MethodSectionType,ClassSectionType,CallSiteSectionType,MethodHandleSectionType,TypeListSectionType,AnnotationSectionType,AnnotationSetSectionType,EncodedArraySectionType>.InternalEncodedValueWriter writer, EncodedValue encodedValue)
private void	writeFields(DexDataWriter writer)
private void	writeHeader(DexDataWriter writer, int dataOffset, int fileSize)
private void	writeMapItem(DexDataWriter writer)
private void	writeMapItem(DexDataWriter writer, int type, int size, int offset)
private void	writeMethodHandles(DexDataWriter writer)
private void	writeMethods(DexDataWriter writer)
private void	writeProtos(DexDataWriter writer)
private void	writeSectionInfo(DexDataWriter writer, int numItems, int offset)
private void	writeStrings(DexDataWriter indexWriter, DexDataWriter offsetWriter)
void	writeTo(DexDataStore dest)
void	writeTo(DexDataStore dest, DeferredOutputStreamFactory tempFactory)
private void	writeTypeLists(DexDataWriter writer)
private void	writeTypes(DexDataWriter writer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NO_INDEX

public static final int NO_INDEX

See Also:

• Constant Field Values

NO_OFFSET

public static final int NO_OFFSET

See Also:

• Constant Field Values

MAX_POOL_SIZE

public static final int MAX_POOL_SIZE

See Also:

• Constant Field Values

opcodes

protected final Opcodes opcodes

stringIndexSectionOffset

protected int stringIndexSectionOffset

typeSectionOffset

protected int typeSectionOffset

protoSectionOffset

protected int protoSectionOffset

fieldSectionOffset

protected int fieldSectionOffset

methodSectionOffset

protected int methodSectionOffset

classIndexSectionOffset

protected int classIndexSectionOffset

callSiteSectionOffset

protected int callSiteSectionOffset

methodHandleSectionOffset

protected int methodHandleSectionOffset

stringDataSectionOffset

protected int stringDataSectionOffset

classDataSectionOffset

protected int classDataSectionOffset

typeListSectionOffset

protected int typeListSectionOffset

encodedArraySectionOffset

protected int encodedArraySectionOffset

annotationSectionOffset

protected int annotationSectionOffset

annotationSetSectionOffset

protected int annotationSetSectionOffset

annotationSetRefSectionOffset

protected int annotationSetRefSectionOffset

annotationDirectorySectionOffset

protected int annotationDirectorySectionOffset

debugSectionOffset

protected int debugSectionOffset

codeSectionOffset

protected int codeSectionOffset

hiddenApiRestrictionsOffset

protected int hiddenApiRestrictionsOffset

mapSectionOffset

protected int mapSectionOffset

hasHiddenApiRestrictions

protected boolean hasHiddenApiRestrictions

numAnnotationSetRefItems

protected int numAnnotationSetRefItems

numAnnotationDirectoryItems

protected int numAnnotationDirectoryItems

numDebugInfoItems

protected int numDebugInfoItems

numCodeItemItems

protected int numCodeItemItems

numClassDataItems

protected int numClassDataItems

stringSection

public final StringSectionType extends StringSection<StringKey,StringRef> stringSection

typeSection

public final TypeSectionType extends TypeSection<StringKey,TypeKey,TypeRef> typeSection

protoSection

public final ProtoSectionType extends ProtoSection<StringKey,TypeKey,ProtoRefKey,TypeListKey> protoSection

fieldSection

public final FieldSectionType extends FieldSection<StringKey,TypeKey,FieldRefKey,FieldKey> fieldSection

methodSection

public final MethodSectionType extends MethodSection<StringKey,TypeKey,ProtoRefKey,MethodRefKey,MethodKey> methodSection

classSection

public final ClassSectionType extends ClassSection<StringKey,TypeKey,TypeListKey,ClassKey,FieldKey,MethodKey,AnnotationSetKey,EncodedArrayKey> classSection

callSiteSection

public final CallSiteSectionType extends CallSiteSection<CallSiteKey,EncodedArrayKey> callSiteSection

methodHandleSection

public final MethodHandleSectionType extends MethodHandleSection<MethodHandleKey,FieldRefKey,MethodRefKey> methodHandleSection

typeListSection

public final TypeListSectionType extends TypeListSection<TypeKey,TypeListKey> typeListSection

annotationSection

public final AnnotationSectionType extends AnnotationSection<StringKey,TypeKey,AnnotationKey,AnnotationElement,EncodedValue> annotationSection

annotationSetSection

public final AnnotationSetSectionType extends AnnotationSetSection<AnnotationKey,AnnotationSetKey> annotationSetSection

encodedArraySection

public final EncodedArraySectionType extends EncodedArraySection<EncodedArrayKey,EncodedValue> encodedArraySection

overflowableSections

private final IndexSection<?>[] overflowableSections

callSiteComparator

private Comparator<Map.Entry<? extends CallSiteKey extends CallSiteReference,Integer>> callSiteComparator

toStringKeyComparator

private static Comparator<Map.Entry> toStringKeyComparator

Constructor Details

DexWriter

protected DexWriter(Opcodes opcodes)

Method Details

getSectionProvider

@Nonnull
protected abstract DexWriter<StringKey,StringRef,TypeKey,TypeRef,ProtoRefKey,FieldRefKey,MethodRefKey,ClassKey,CallSiteKey,MethodHandleKey,AnnotationKey,AnnotationSetKey,TypeListKey,FieldKey,MethodKey,EncodedArrayKey,EncodedValue,AnnotationElement,StringSectionType,TypeSectionType,ProtoSectionType,FieldSectionType,MethodSectionType,ClassSectionType,CallSiteSectionType,MethodHandleSectionType,TypeListSectionType,AnnotationSectionType,AnnotationSetSectionType,EncodedArraySectionType>.SectionProvider getSectionProvider()

writeEncodedValue

protected abstract void writeEncodedValue(@Nonnull
 DexWriter<StringKey,StringRef,TypeKey,TypeRef,ProtoRefKey,FieldRefKey,MethodRefKey,ClassKey,CallSiteKey,MethodHandleKey,AnnotationKey,AnnotationSetKey,TypeListKey,FieldKey,MethodKey,EncodedArrayKey,EncodedValue,AnnotationElement,StringSectionType,TypeSectionType,ProtoSectionType,FieldSectionType,MethodSectionType,ClassSectionType,CallSiteSectionType,MethodHandleSectionType,TypeListSectionType,AnnotationSectionType,AnnotationSetSectionType,EncodedArraySectionType>.InternalEncodedValueWriter writer,
 @Nonnull
 EncodedValue encodedValue)
                                   throws IOException

Throws:

IOException

comparableKeyComparator

private static <T extends Comparable<? super T>>
Comparator<Map.Entry<? extends T,?>> comparableKeyComparator()

getDataSectionOffset

private int getDataSectionOffset()

getMethodReferences

@Nonnull
public List<String> getMethodReferences()

getFieldReferences

@Nonnull
public List<String> getFieldReferences()

getTypeReferences

@Nonnull
public List<String> getTypeReferences()

hasOverflowed

public boolean hasOverflowed()

Checks whether any of the size-sensitive constant pools have overflowed and have more than 64Ki entries. Note that even if this returns true, it may still be possible to successfully write the dex file, if the overflowed items are not referenced anywhere that uses a 16-bit index.

Returns:

true if any of the size-sensitive constant pools have overflowed

hasOverflowed

public boolean hasOverflowed(int maxPoolSize)

Checks whether any of the size-sensitive constant pools have more than the supplied maximum number of entries.

Parameters:

maxPoolSize - the maximum number of entries allowed in any of the size-sensitive constant pools

Returns:

true if any of the size-sensitive constant pools have overflowed the supplied size limit

writeTo

public void writeTo(@Nonnull
 DexDataStore dest)
             throws IOException

Throws:

IOException

writeTo

public void writeTo(@Nonnull
 DexDataStore dest,
 @Nonnull
 DeferredOutputStreamFactory tempFactory)
             throws IOException

Throws:

IOException

updateSignature

private void updateSignature(@Nonnull
 DexDataStore dataStore)
                      throws IOException

Throws:

IOException

updateChecksum

private void updateChecksum(@Nonnull
 DexDataStore dataStore)
                     throws IOException

Throws:

IOException

outputAt

private static DexDataWriter outputAt(DexDataStore dataStore,
 int filePosition)
                               throws IOException

Throws:

IOException

writeStrings

private void writeStrings(@Nonnull
 DexDataWriter indexWriter,
 @Nonnull
 DexDataWriter offsetWriter)
                   throws IOException

Throws:

IOException

writeTypes

private void writeTypes(@Nonnull
 DexDataWriter writer)
                 throws IOException

Throws:

IOException

writeProtos

private void writeProtos(@Nonnull
 DexDataWriter writer)
                  throws IOException

Throws:

IOException

writeFields

private void writeFields(@Nonnull
 DexDataWriter writer)
                  throws IOException

Throws:

IOException

writeMethods

private void writeMethods(@Nonnull
 DexDataWriter writer)
                   throws IOException

Throws:

IOException

writeClasses

private void writeClasses(@Nonnull
 DexDataStore dataStore,
 @Nonnull
 DexDataWriter indexWriter,
 @Nonnull
 DexDataWriter offsetWriter)
                   throws IOException

Throws:

IOException

shouldWriteHiddenApiRestrictions

private boolean shouldWriteHiddenApiRestrictions()

writeClass

private int writeClass(@Nonnull
 DexDataWriter indexWriter,
 @Nonnull
 DexDataWriter offsetWriter,
 int nextIndex,
 @Nullable
 Map.Entry<? extends ClassKey,Integer> entry)
                throws IOException

Writes out the class_def_item and class_data_item for the given class. This will recursively write out any unwritten superclass/interface before writing the class itself, as per the dex specification.

Returns:

the index for the next class to be written

Throws:

IOException

writeCallSites

private void writeCallSites(DexDataWriter writer)
                     throws IOException

Throws:

IOException

writeMethodHandles

private void writeMethodHandles(DexDataWriter writer)
                         throws IOException

Throws:

IOException

writeEncodedFields

private void writeEncodedFields(@Nonnull
 DexDataWriter writer,
 @Nonnull
 Collection<? extends FieldKey> fields)
                         throws IOException

Throws:

IOException

writeEncodedMethods

private void writeEncodedMethods(@Nonnull
 DexDataWriter writer,
 @Nonnull
 Collection<? extends MethodKey> methods)
                          throws IOException

Throws:

IOException

writeTypeLists

private void writeTypeLists(@Nonnull
 DexDataWriter writer)
                     throws IOException

Throws:

IOException

writeEncodedArrays

private void writeEncodedArrays(@Nonnull
 DexDataWriter writer)
                         throws IOException

Throws:

IOException

writeAnnotations

private void writeAnnotations(@Nonnull
 DexDataWriter writer)
                       throws IOException

Throws:

IOException

writeAnnotationSets

private void writeAnnotationSets(@Nonnull
 DexDataWriter writer)
                          throws IOException

Throws:

IOException

writeAnnotationSetRefs

private void writeAnnotationSetRefs(@Nonnull
 DexDataWriter writer)
                             throws IOException

Throws:

IOException

writeAnnotationDirectories

private void writeAnnotationDirectories(@Nonnull
 DexDataWriter writer)
                                 throws IOException

Throws:

IOException

writeDebugAndCodeItems

private void writeDebugAndCodeItems(@Nonnull
 DexDataWriter offsetWriter,
 @Nonnull
 DeferredOutputStream temp)
                             throws IOException

Throws:

IOException

fixInstructions

private void fixInstructions(@Nonnull
 MutableMethodImplementation methodImplementation)

writeDebugItem

private int writeDebugItem(@Nonnull
 DexDataWriter writer,
 @Nonnull
 DebugWriter<StringKey,TypeKey> debugWriter,
 @Nullable
 Iterable<? extends StringKey> parameterNames,
 @Nullable
 Iterable<? extends DebugItem> debugItems)
                    throws IOException

Throws:

IOException

writeCodeItem

private int writeCodeItem(@Nonnull
 DexDataWriter writer,
 @Nonnull
 ByteArrayOutputStream ehBuf,
 @Nonnull
 MethodKey methodKey,
 @Nonnull
 List<? extends TryBlock<? extends ExceptionHandler>> tryBlocks,
 @Nullable
 Iterable<? extends Instruction> instructions,
 int debugItemOffset)
                   throws IOException

Throws:

IOException

calcNumItems

private int calcNumItems()

writeMapItem

private void writeMapItem(@Nonnull
 DexDataWriter writer)
                   throws IOException

Throws:

IOException

writeMapItem

private void writeMapItem(@Nonnull
 DexDataWriter writer,
 int type,
 int size,
 int offset)
                   throws IOException

Throws:

IOException

writeHeader

private void writeHeader(@Nonnull
 DexDataWriter writer,
 int dataOffset,
 int fileSize)
                  throws IOException

Throws:

IOException

writeSectionInfo

private void writeSectionInfo(DexDataWriter writer,
 int numItems,
 int offset)
                       throws IOException

Throws:

IOException

shouldCreateEmptyAnnotationSet

private boolean shouldCreateEmptyAnnotationSet()