1579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson/* 2579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Copyright (C) 2007 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.Constant; 20579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.util.AnnotatedOutput; 21579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 22579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport java.util.Collection; 23579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 24579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson/** 25579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * A section of a {@code .dex} file which consists of a sequence of 26579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@link Item} objects. Each of the items must have the same size in 27579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * the output. 28579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 29579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonpublic abstract class UniformItemSection extends Section { 30579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 31579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Constructs an instance. The file offset is initially unknown. 32579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 33579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param name {@code null-ok;} the name of this instance, for annotation 34579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * purposes 35579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param file {@code non-null;} file that this instance is part of 36579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param alignment {@code > 0;} alignment requirement for the final output; 37579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * must be a power of 2 38579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 39579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public UniformItemSection(String name, DexFile file, int alignment) { 40579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson super(name, file, alignment); 41579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 42579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 43579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 44579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 45579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public final int writeSize() { 46579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson Collection<? extends Item> items = items(); 47579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson int sz = items.size(); 48579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 49579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (sz == 0) { 50579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return 0; 51579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 52579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 53579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson // Since each item has to be the same size, we can pick any. 54579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return sz * items.iterator().next().writeSize(); 55579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 56579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 57579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 58579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Gets the item corresponding to the given {@link Constant}. This 59579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * will throw an exception if the constant is not found, including 60579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * if this instance isn't the sort that maps constants to {@link 61579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * IndexedItem} instances. 62579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 63579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param cst {@code non-null;} constant to look for 64579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return {@code non-null;} the corresponding item found in this instance 65579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 66579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public abstract IndexedItem get(Constant cst); 67579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 68579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 69579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 70579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson protected final void prepare0() { 71579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson DexFile file = getFile(); 72579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 73579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson orderItems(); 74579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 75579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson for (Item one : items()) { 76579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson one.addContents(file); 77579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 78579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 79579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 80579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 81579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 82579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson protected final void writeTo0(AnnotatedOutput out) { 83579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson DexFile file = getFile(); 84579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson int alignment = getAlignment(); 85579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 86579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson for (Item one : items()) { 87579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson one.writeTo(file, out); 88579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson out.alignTo(alignment); 89579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 90579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 91579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 92579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 93579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 94579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public final int getAbsoluteItemOffset(Item item) { 95579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /* 96579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Since all items must be the same size, we can use the size 97579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * of the one we're given to calculate its offset. 98579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 99579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson IndexedItem ii = (IndexedItem) item; 100579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson int relativeOffset = ii.getIndex() * ii.writeSize(); 101579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 102579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return getAbsoluteOffset(relativeOffset); 103579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 104579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 105579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 106579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Alters or picks the order for items in this instance if desired, 107579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * so that subsequent calls to {@link #items} will yield a 108579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * so-ordered collection. If the items in this instance are indexed, 109579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * then this method should also assign indices. 110579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 111579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson protected abstract void orderItems(); 112579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson} 113