1f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/* 2f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Copyright (C) 2008 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 19f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport com.android.dx.rop.cst.CstType; 20f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport com.android.dx.rop.cst.CstUtf8; 21f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport com.android.dx.rop.type.Prototype; 22f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport com.android.dx.rop.type.StdTypeList; 23f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport com.android.dx.rop.type.Type; 24f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport com.android.dx.util.AnnotatedOutput; 25f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectimport com.android.dx.util.Hex; 26f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 27f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project/** 28f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Representation of a method prototype reference inside a Dalvik file. 29f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 30f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Projectpublic final class ProtoIdItem extends IndexedItem { 31f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** size of instances when written out to a file, in bytes */ 32f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public static final int WRITE_SIZE = 12; 33f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 3499409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project /** {@code non-null;} the wrapped prototype */ 35f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project private final Prototype prototype; 36f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 3799409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project /** {@code non-null;} the short-form of the prototype */ 38f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project private final CstUtf8 shortForm; 39f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 40f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 4199409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * {@code null-ok;} the list of parameter types or {@code null} if this 42f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * prototype has no parameters 43f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 44f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project private TypeListItem parameterTypes; 45f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 46f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 47f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Constructs an instance. 48f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 4999409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param prototype {@code non-null;} the constant for the prototype 50f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 51f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public ProtoIdItem(Prototype prototype) { 52f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project if (prototype == null) { 53f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project throw new NullPointerException("prototype == null"); 54f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 55f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 56f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project this.prototype = prototype; 57f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project this.shortForm = makeShortForm(prototype); 58f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 59f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project StdTypeList parameters = prototype.getParameterTypes(); 60f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project this.parameterTypes = (parameters.size() == 0) ? null 61f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project : new TypeListItem(parameters); 62f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 63f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 64f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 65f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Creates the short-form of the given prototype. 66f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 6799409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param prototype {@code non-null;} the prototype 6899409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @return {@code non-null;} the short form 69f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 70f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project private static CstUtf8 makeShortForm(Prototype prototype) { 71f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project StdTypeList parameters = prototype.getParameterTypes(); 72f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project int size = parameters.size(); 73f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project StringBuilder sb = new StringBuilder(size + 1); 74f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 75f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project sb.append(shortFormCharFor(prototype.getReturnType())); 76f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 77f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project for (int i = 0; i < size; i++) { 78f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project sb.append(shortFormCharFor(parameters.getType(i))); 79f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 80f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 81f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return new CstUtf8(sb.toString()); 82f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 83f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 84f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** 85f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * Gets the short-form character for the given type. 86f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * 8799409883d9c4c0ffb49b070ce307bb33a9dfe9f1The Android Open Source Project * @param type {@code non-null;} the type 88f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project * @return the corresponding short-form character 89f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project */ 90f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project private static char shortFormCharFor(Type type) { 91f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project char descriptorChar = type.getDescriptor().charAt(0); 92f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 93f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project if (descriptorChar == '[') { 94f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return 'L'; 95f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 96f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 97f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return descriptorChar; 98f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 99f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 100f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** {@inheritDoc} */ 101f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project @Override 102f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public ItemType itemType() { 103f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return ItemType.TYPE_PROTO_ID_ITEM; 104f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 105f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 106f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** {@inheritDoc} */ 107f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project @Override 108f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public int writeSize() { 109f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project return WRITE_SIZE; 110f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 111f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 112f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** {@inheritDoc} */ 113f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project @Override 114f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void addContents(DexFile file) { 115f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project StringIdsSection stringIds = file.getStringIds(); 116f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project TypeIdsSection typeIds = file.getTypeIds(); 117f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project MixedItemSection typeLists = file.getTypeLists(); 118f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 119f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project typeIds.intern(prototype.getReturnType()); 120f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project stringIds.intern(shortForm); 121f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 122f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project if (parameterTypes != null) { 123f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project parameterTypes = typeLists.intern(parameterTypes); 124f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 125f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 126f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 127f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project /** {@inheritDoc} */ 128f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project @Override 129f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project public void writeTo(DexFile file, AnnotatedOutput out) { 130f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project int shortyIdx = file.getStringIds().indexOf(shortForm); 131f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project int returnIdx = file.getTypeIds().indexOf(prototype.getReturnType()); 132f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project int paramsOff = OffsettedItem.getAbsoluteOffsetOr0(parameterTypes); 133f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 134f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project if (out.annotates()) { 135f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project StringBuilder sb = new StringBuilder(); 136f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project sb.append(prototype.getReturnType().toHuman()); 137f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project sb.append(" proto("); 138f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 139f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project StdTypeList params = prototype.getParameterTypes(); 140f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project int size = params.size(); 141f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 142f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project for (int i = 0; i < size; i++) { 143f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project if (i != 0) { 144f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project sb.append(", "); 145f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 146f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project sb.append(params.getType(i).toHuman()); 147f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 148f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 149f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project sb.append(")"); 150f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project out.annotate(0, indexString() + ' ' + sb.toString()); 151f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project out.annotate(4, " shorty_idx: " + Hex.u4(shortyIdx) + 152f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project " // " + shortForm.toQuoted()); 153f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project out.annotate(4, " return_type_idx: " + Hex.u4(returnIdx) + 154f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project " // " + prototype.getReturnType().toHuman()); 155f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project out.annotate(4, " parameters_off: " + Hex.u4(paramsOff)); 156f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 157f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project 158f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project out.writeInt(shortyIdx); 159f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project out.writeInt(returnIdx); 160f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project out.writeInt(paramsOff); 161f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project } 162f6c387128427e121477c1b32ad35cdcaa5101ba3The Android Open Source Project} 163