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.rop.cst; 18579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 19579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.util.ExceptionWithContext; 20579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.util.Hex; 21579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.util.MutabilityControl; 22579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 23579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson/** 24579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Standard implementation of {@link ConstantPool}, which directly stores 25579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * an array of {@link Constant} objects and can be made immutable. 26579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 27579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonpublic final class StdConstantPool 28579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson extends MutabilityControl implements ConstantPool { 29579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@code non-null;} array of entries */ 30579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson private final Constant[] entries; 31579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 32579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 33579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Constructs an instance. All indices initially contain {@code null}. 34579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 35579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param size the size of the pool; this corresponds to the 36579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * class file field {@code constant_pool_count}, and is in fact 37579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * always at least one more than the actual size of the constant pool, 38579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * as element {@code 0} is always invalid. 39579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 40579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public StdConstantPool(int size) { 41579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson super(size > 1); 42579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 43579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (size < 1) { 44579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throw new IllegalArgumentException("size < 1"); 45579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 46579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 47579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson entries = new Constant[size]; 48579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 49579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 50579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 51579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public int size() { 52579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return entries.length; 53579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 54579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 55579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 56579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public Constant getOrNull(int n) { 57579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson try { 58579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return entries[n]; 59579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } catch (IndexOutOfBoundsException ex) { 60579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson // Translate the exception. 61579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return throwInvalid(n); 62579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 63579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 64579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 65579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 66579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public Constant get0Ok(int n) { 67579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (n == 0) { 68579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return null; 69579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 70579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 71579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return get(n); 72579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 73579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 74579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 75579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public Constant get(int n) { 76579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson try { 77579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson Constant result = entries[n]; 78579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 79579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (result == null) { 80579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throwInvalid(n); 81579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 82579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 83579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return result; 84579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } catch (IndexOutOfBoundsException ex) { 85579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson // Translate the exception. 86579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return throwInvalid(n); 87579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 88579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 89579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 90579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 91579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Sets the entry at the given index. 92579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 93579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param n {@code >= 1, < size();} which entry 94579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param cst {@code null-ok;} the constant to store 95579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 96579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public void set(int n, Constant cst) { 97579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throwIfImmutable(); 98579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 99579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson boolean cat2 = (cst != null) && cst.isCategory2(); 100579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 101579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (n < 1) { 102579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throw new IllegalArgumentException("n < 1"); 103579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 104579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 105579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (cat2) { 106579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson // Storing a category-2 entry nulls out the next index. 107579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (n == (entries.length - 1)) { 108579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throw new IllegalArgumentException("(n == size - 1) && " + 109579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson "cst.isCategory2()"); 110579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 111579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson entries[n + 1] = null; 112579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 113579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 114579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if ((cst != null) && (entries[n] == null)) { 115579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /* 116579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Overwriting the second half of a category-2 entry nulls out 117579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * the first half. 118579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 119579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson Constant prev = entries[n - 1]; 120579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if ((prev != null) && prev.isCategory2()) { 121579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson entries[n - 1] = null; 122579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 123579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 124579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 125579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson entries[n] = cst; 126579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 127579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 128579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 129579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Throws the right exception for an invalid cpi. 130579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 131579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param idx the bad cpi 132579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return never 133579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @throws ExceptionWithContext always thrown 134579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 135579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson private static Constant throwInvalid(int idx) { 136579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throw new ExceptionWithContext("invalid constant pool index " + 137579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson Hex.u2(idx)); 138579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 139579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson} 140