1f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 2f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Copyright (C) 2007 The Android Open Source Project 3f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 4f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 5f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * you may not use this file except in compliance with the License. 6f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * You may obtain a copy of the License at 7f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 8f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 9f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 10f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 11f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 12f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * See the License for the specific language governing permissions and 14f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * limitations under the License. 15f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 16f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 17f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectpackage com.android.dx.dex.file; 18f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 19fe107fb6e3f308ac5174ebdc5a794ee880c741d9Jesse Wilsonimport com.android.dex.Leb128; 20f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport com.android.dx.rop.code.AccessFlags; 21f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport com.android.dx.rop.cst.CstFieldRef; 22333201833d506a3accdeac6ceb7caba8d4b95797Jesse Wilsonimport com.android.dx.rop.cst.CstString; 23f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport com.android.dx.util.AnnotatedOutput; 24f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport com.android.dx.util.Hex; 25f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport java.io.PrintWriter; 26f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 27f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/** 28f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Representation of a field of a class, of any sort. 29f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 30f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectpublic final class EncodedField extends EncodedMember 31f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project implements Comparable<EncodedField> { 3299409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project /** {@code non-null;} constant for the field */ 33f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project private final CstFieldRef field; 34f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 35f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 36f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Constructs an instance. 37de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * 3899409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param field {@code non-null;} constant for the field 39f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @param accessFlags access flags 40f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 41f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public EncodedField(CstFieldRef field, int accessFlags) { 42f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project super(accessFlags); 43f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 44f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project if (field == null) { 45f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project throw new NullPointerException("field == null"); 46f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 47f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 48f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /* 49f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * TODO: Maybe check accessFlags, at least for 50f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * easily-checked stuff? 51f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 52f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 53f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project this.field = field; 54f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 55f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 56f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** {@inheritDoc} */ 57f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public int hashCode() { 58f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return field.hashCode(); 59f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 60f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 61f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** {@inheritDoc} */ 62f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public boolean equals(Object other) { 63f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project if (! (other instanceof EncodedField)) { 64f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return false; 65f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 66f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 67f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return compareTo((EncodedField) other) == 0; 68f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 69f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 70f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 71f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * {@inheritDoc} 72de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * 73f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * <p><b>Note:</b> This compares the method constants only, 74f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * ignoring any associated code, because it should never be the 75f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * case that two different items with the same method constant 76f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * ever appear in the same list (or same file, even).</p> 77f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 78f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public int compareTo(EncodedField other) { 79f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return field.compareTo(other.field); 80f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 81f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 82f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** {@inheritDoc} */ 83f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project @Override 84f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public String toString() { 85f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project StringBuffer sb = new StringBuffer(100); 86f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 87f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project sb.append(getClass().getName()); 88f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project sb.append('{'); 89f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project sb.append(Hex.u2(getAccessFlags())); 90f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project sb.append(' '); 91f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project sb.append(field); 92f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project sb.append('}'); 93f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return sb.toString(); 94f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 95f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 96f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** {@inheritDoc} */ 97f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project @Override 98f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void addContents(DexFile file) { 99f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project FieldIdsSection fieldIds = file.getFieldIds(); 100f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project fieldIds.intern(field); 101f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 102f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 103f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** {@inheritDoc} */ 104f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project @Override 105333201833d506a3accdeac6ceb7caba8d4b95797Jesse Wilson public CstString getName() { 106f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return field.getNat().getName(); 107f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 108f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 109f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** {@inheritDoc} */ 110f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public String toHuman() { 111f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return field.toHuman(); 112f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 113f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 114f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** {@inheritDoc} */ 115f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project @Override 116f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void debugPrint(PrintWriter out, boolean verbose) { 117f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project // TODO: Maybe put something better here? 118f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project out.println(toString()); 119f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 120f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 121f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 122f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Gets the constant for the field. 123de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro * 12499409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @return {@code non-null;} the constant 125f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 126f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public CstFieldRef getRef() { 127f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return field; 128f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 129f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 130f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** {@inheritDoc} */ 131f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project @Override 132de75089fb7216d19e9c22cce4dc62a49513477d3Carl Shapiro public int encode(DexFile file, AnnotatedOutput out, 133f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project int lastIndex, int dumpSeq) { 134f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project int fieldIdx = file.getFieldIds().indexOf(field); 135f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project int diff = fieldIdx - lastIndex; 136f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project int accessFlags = getAccessFlags(); 137f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 138f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project if (out.annotates()) { 139f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project out.annotate(0, String.format(" [%x] %s", dumpSeq, 140f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project field.toHuman())); 141fe107fb6e3f308ac5174ebdc5a794ee880c741d9Jesse Wilson out.annotate(Leb128.unsignedLeb128Size(diff), 142f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project " field_idx: " + Hex.u4(fieldIdx)); 143fe107fb6e3f308ac5174ebdc5a794ee880c741d9Jesse Wilson out.annotate(Leb128.unsignedLeb128Size(accessFlags), 144f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project " access_flags: " + 145f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project AccessFlags.fieldString(accessFlags)); 146f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 147f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 148dfc5e8e159e7df3efa47d553b7725be22839665dJesse Wilson out.writeUleb128(diff); 149dfc5e8e159e7df3efa47d553b7725be22839665dJesse Wilson out.writeUleb128(accessFlags); 150f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 151f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return fieldIdx; 152f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 153f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project} 154