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.annotation.Annotations; 20579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.rop.annotation.Annotation; 21579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.util.AnnotatedOutput; 22579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.util.Hex; 23579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 24579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson/** 25579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Set of annotations, where no annotation type appears more than once. 26579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 27579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonpublic final class AnnotationSetItem extends OffsettedItem { 28579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** the required alignment for instances of this class */ 29579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson private static final int ALIGNMENT = 4; 30579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 31579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** the size of an entry int the set: one {@code uint} */ 32579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson private static final int ENTRY_WRITE_SIZE = 4; 33579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 34579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@code non-null;} the set of annotations */ 35579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson private final Annotations annotations; 36579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 37579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 38579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@code non-null;} set of annotations as individual items in an array. 39579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * <b>Note:</b> The contents have to get sorted by type id before 40579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * writing. 41579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 42579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson private final AnnotationItem[] items; 43579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 44579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 45579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Constructs an instance. 46579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 47579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param annotations {@code non-null;} set of annotations 48579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 49579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public AnnotationSetItem(Annotations annotations) { 50579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson super(ALIGNMENT, writeSize(annotations)); 51579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 52579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson this.annotations = annotations; 53579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson this.items = new AnnotationItem[annotations.size()]; 54579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 55579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson int at = 0; 56579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson for (Annotation a : annotations.getAnnotations()) { 57579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson items[at] = new AnnotationItem(a); 58579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson at++; 59579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 60579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 61579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 62579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 63579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Gets the write size for the given set. 64579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 65579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param annotations {@code non-null;} the set 66579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return {@code > 0;} the write size 67579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 68579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson private static int writeSize(Annotations annotations) { 69579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson // This includes an int size at the start of the list. 70579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 71579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson try { 72579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return (annotations.size() * ENTRY_WRITE_SIZE) + 4; 73579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } catch (NullPointerException ex) { 74579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson // Elucidate the exception. 75579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throw new NullPointerException("list == null"); 76579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 77579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 78579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 79579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 80579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Gets the underlying annotations of this instance 81579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 82579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return {@code non-null;} the annotations 83579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 84579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public Annotations getAnnotations() { 85579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return annotations; 86579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 87579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 88579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 89579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 90579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public int hashCode() { 91579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return annotations.hashCode(); 92579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 93579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 94579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 95579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 96579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson protected int compareTo0(OffsettedItem other) { 97579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson AnnotationSetItem otherSet = (AnnotationSetItem) other; 98579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 99579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return annotations.compareTo(otherSet.annotations); 100579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 101579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 102579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 103579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 104579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public ItemType itemType() { 105579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return ItemType.TYPE_ANNOTATION_SET_ITEM; 106579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 107579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 108579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 109579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 110579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public String toHuman() { 111579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return annotations.toString(); 112579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 113579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 114579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 115579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public void addContents(DexFile file) { 116579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson MixedItemSection byteData = file.getByteData(); 117579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson int size = items.length; 118579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 119579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson for (int i = 0; i < size; i++) { 120579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson items[i] = byteData.intern(items[i]); 121579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 122579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 123579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 124579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 125579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 126579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson protected void place0(Section addedTo, int offset) { 127579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson // Sort the array to be in type id index order. 128579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson AnnotationItem.sortByTypeIdIndex(items); 129579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 130579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 131579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 132579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 133579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson protected void writeTo0(DexFile file, AnnotatedOutput out) { 134579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson boolean annotates = out.annotates(); 135579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson int size = items.length; 136579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 137579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (annotates) { 138579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson out.annotate(0, offsetString() + " annotation set"); 139579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson out.annotate(4, " size: " + Hex.u4(size)); 140579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 141579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 142579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson out.writeInt(size); 143579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 144579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson for (int i = 0; i < size; i++) { 145579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson AnnotationItem item = items[i]; 146579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson int offset = item.getAbsoluteOffset(); 147579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 148579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (annotates) { 149579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson out.annotate(4, " entries[" + Integer.toHexString(i) + "]: " + 150579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson Hex.u4(offset)); 151579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson items[i].annotateTo(out, " "); 152579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 153579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 154579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson out.writeInt(offset); 155579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 156579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 157579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson} 158