1917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul/* 2917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Copyright (C) 2008 The Android Open Source Project 3917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 4917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Licensed under the Apache License, Version 2.0 (the "License"); 5917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * you may not use this file except in compliance with the License. 6917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * You may obtain a copy of the License at 7917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 8917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * http://www.apache.org/licenses/LICENSE-2.0 9917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 10917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Unless required by applicable law or agreed to in writing, software 11917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * distributed under the License is distributed on an "AS IS" BASIS, 12917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * See the License for the specific language governing permissions and 14917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * limitations under the License. 15917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 16917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 17917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulpackage com.android.dexgen.dex.file; 18917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 19917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulimport com.android.dexgen.rop.annotation.Annotations; 20917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulimport com.android.dexgen.rop.cst.CstMethodRef; 21917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulimport com.android.dexgen.util.AnnotatedOutput; 22917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulimport com.android.dexgen.util.Hex; 23917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulimport com.android.dexgen.util.ToHuman; 24917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 25917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul/** 26917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Association of a method and its annotations. 27917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 28917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgulpublic final class MethodAnnotationStruct 29917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul implements ToHuman, Comparable<MethodAnnotationStruct> { 30917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@code non-null;} the method in question */ 31917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul private final CstMethodRef method; 32917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 33917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@code non-null;} the associated annotations */ 34917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul private AnnotationSetItem annotations; 35917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 36917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 37917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Constructs an instance. 38917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 39917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @param method {@code non-null;} the method in question 40917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @param annotations {@code non-null;} the associated annotations 41917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 42917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public MethodAnnotationStruct(CstMethodRef method, 43917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul AnnotationSetItem annotations) { 44917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul if (method == null) { 45917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul throw new NullPointerException("method == null"); 46917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 47917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 48917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul if (annotations == null) { 49917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul throw new NullPointerException("annotations == null"); 50917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 51917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 52917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul this.method = method; 53917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul this.annotations = annotations; 54917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 55917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 56917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@inheritDoc} */ 57917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public int hashCode() { 58917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return method.hashCode(); 59917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 60917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 61917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@inheritDoc} */ 62917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public boolean equals(Object other) { 63917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul if (! (other instanceof MethodAnnotationStruct)) { 64917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return false; 65917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 66917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 67917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return method.equals(((MethodAnnotationStruct) other).method); 68917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 69917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 70917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@inheritDoc} */ 71917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public int compareTo(MethodAnnotationStruct other) { 72917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return method.compareTo(other.method); 73917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 74917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 75917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@inheritDoc} */ 76917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public void addContents(DexFile file) { 77917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul MethodIdsSection methodIds = file.getMethodIds(); 78917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul MixedItemSection wordData = file.getWordData(); 79917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 80917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul methodIds.intern(method); 81917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul annotations = wordData.intern(annotations); 82917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 83917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 84917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@inheritDoc} */ 85917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public void writeTo(DexFile file, AnnotatedOutput out) { 86917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul int methodIdx = file.getMethodIds().indexOf(method); 87917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul int annotationsOff = annotations.getAbsoluteOffset(); 88917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 89917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul if (out.annotates()) { 90917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul out.annotate(0, " " + method.toHuman()); 91917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul out.annotate(4, " method_idx: " + Hex.u4(methodIdx)); 92917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul out.annotate(4, " annotations_off: " + 93917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul Hex.u4(annotationsOff)); 94917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 95917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 96917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul out.writeInt(methodIdx); 97917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul out.writeInt(annotationsOff); 98917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 99917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 100917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** {@inheritDoc} */ 101917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public String toHuman() { 102917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return method.toHuman() + ": " + annotations; 103917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 104917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 105917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 106917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Gets the method this item is for. 107917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 108917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @return {@code non-null;} the method 109917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 110917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public CstMethodRef getMethod() { 111917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return method; 112917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 113917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul 114917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul /** 115917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * Gets the associated annotations. 116917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * 117917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul * @return {@code non-null;} the annotations 118917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul */ 119917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul public Annotations getAnnotations() { 120917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul return annotations.getAnnotations(); 121917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul } 122917cb222329ee8c035c3ffaf947e4265761b9367Piotr Gurgul} 123