1579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson/* 2579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Copyright (C) 2008 The Android Open Source Project 3579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 4579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Licensed under the Apache License, Version 2.0 (the "License"); 5579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * you may not use this file except in compliance with the License. 6579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * You may obtain a copy of the License at 7579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 8579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * http://www.apache.org/licenses/LICENSE-2.0 9579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 10579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Unless required by applicable law or agreed to in writing, software 11579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * distributed under the License is distributed on an "AS IS" BASIS, 12579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * See the License for the specific language governing permissions and 14579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * limitations under the License. 15579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 16579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 17579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonpackage com.android.dx.dex.file; 18579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 19579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.rop.cst.CstArray; 20579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.util.ByteArrayAnnotatedOutput; 21579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.util.AnnotatedOutput; 22579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 23579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson/** 24579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Encoded array of constant values. 25579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 26579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonpublic final class EncodedArrayItem extends OffsettedItem { 27579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** the required alignment for instances of this class */ 28579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson private static final int ALIGNMENT = 1; 29579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 30579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@code non-null;} the array to represent */ 31579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson private final CstArray array; 32579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 33579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 34579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@code null-ok;} encoded form, ready for writing to a file; set during 35579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@link #place0} 36579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 37579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson private byte[] encodedForm; 38579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 39579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 40579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Constructs an instance. 41579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 42579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param array {@code non-null;} array to represent 43579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 44579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public EncodedArrayItem(CstArray array) { 45579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /* 46579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * The write size isn't known up-front because (the variable-lengthed) 47579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * leb128 type is used to represent some things. 48579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 49579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson super(ALIGNMENT, -1); 50579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 51579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (array == null) { 52579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throw new NullPointerException("array == null"); 53579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 54579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 55579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson this.array = array; 56579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson this.encodedForm = null; 57579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 58579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 59579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 60579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 61579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public ItemType itemType() { 62579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return ItemType.TYPE_ENCODED_ARRAY_ITEM; 63579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 64579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 65579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 66579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 67579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public int hashCode() { 68579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return array.hashCode(); 69579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 70579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 71579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 72579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 73579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson protected int compareTo0(OffsettedItem other) { 74579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson EncodedArrayItem otherArray = (EncodedArrayItem) other; 75579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 76579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return array.compareTo(otherArray.array); 77579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 78579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 79579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 80579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 81579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public String toHuman() { 82579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return array.toHuman(); 83579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 84579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 85579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 86579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public void addContents(DexFile file) { 87579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson ValueEncoder.addContents(file, array); 88579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 89579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 90579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 91579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 92579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson protected void place0(Section addedTo, int offset) { 93579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson // Encode the data and note the size. 94579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 95579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson ByteArrayAnnotatedOutput out = new ByteArrayAnnotatedOutput(); 96579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson ValueEncoder encoder = new ValueEncoder(addedTo.getFile(), out); 97579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 98579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson encoder.writeArray(array, false); 99579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson encodedForm = out.toByteArray(); 100579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson setWriteSize(encodedForm.length); 101579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 102579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 103579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 104579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 105579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson protected void writeTo0(DexFile file, AnnotatedOutput out) { 106579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson boolean annotates = out.annotates(); 107579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 108579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (annotates) { 109579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson out.annotate(0, offsetString() + " encoded array"); 110579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 111579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /* 112579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * The output is to be annotated, so redo the work previously 113579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * done by place0(), except this time annotations will actually 114579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * get emitted. 115579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 116579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson ValueEncoder encoder = new ValueEncoder(file, out); 117579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson encoder.writeArray(array, true); 118579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } else { 119579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson out.write(encodedForm); 120579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 121579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 122579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson} 123