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.dex.code; 18579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 19579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.rop.code.RegisterSpecList; 20579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.rop.code.SourcePosition; 21579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport com.android.dx.rop.cst.Constant; 22579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 23579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson/** 24579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Instruction which has a single constant argument in addition 25579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * to all the normal instruction information. 26579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 27579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonpublic final class CstInsn extends FixedSizeInsn { 28579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@code non-null;} the constant argument for this instruction */ 29579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson private final Constant constant; 30579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 31579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 32579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@code >= -1;} the constant pool index for {@link #constant}, or 33579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@code -1} if not yet set 34579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 35579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson private int index; 36579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 37579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 38579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@code >= -1;} the constant pool index for the class reference in 39579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@link #constant} if any, or {@code -1} if not yet set 40579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 41579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson private int classIndex; 42579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 43579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 44579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Constructs an instance. The output address of this instance is 45579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * initially unknown ({@code -1}) as is the constant pool index. 46579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 47579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param opcode the opcode; one of the constants from {@link Dops} 48579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param position {@code non-null;} source position 49579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param registers {@code non-null;} register list, including a 50579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * result register if appropriate (that is, registers may be either 51579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * ins or outs) 52579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param constant {@code non-null;} constant argument 53579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 54579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public CstInsn(Dop opcode, SourcePosition position, 55579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson RegisterSpecList registers, Constant constant) { 56579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson super(opcode, position, registers); 57579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 58579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (constant == null) { 59579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throw new NullPointerException("constant == null"); 60579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 61579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 62579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson this.constant = constant; 63579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson this.index = -1; 64579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson this.classIndex = -1; 65579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 66579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 67579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 68579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 69579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public DalvInsn withOpcode(Dop opcode) { 70579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson CstInsn result = 71579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson new CstInsn(opcode, getPosition(), getRegisters(), constant); 72579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 73579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (index >= 0) { 74579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson result.setIndex(index); 75579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 76579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 77579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (classIndex >= 0) { 78579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson result.setClassIndex(classIndex); 79579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 80579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 81579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return result; 82579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 83579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 84579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 85579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 86579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public DalvInsn withRegisters(RegisterSpecList registers) { 87579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson CstInsn result = 88579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson new CstInsn(getOpcode(), getPosition(), registers, constant); 89579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 90579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (index >= 0) { 91579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson result.setIndex(index); 92579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 93579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 94579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (classIndex >= 0) { 95579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson result.setClassIndex(classIndex); 96579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 97579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 98579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return result; 99579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 100579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 101579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 102579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Gets the constant argument. 103579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 104579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return {@code non-null;} the constant argument 105579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 106579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public Constant getConstant() { 107579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return constant; 108579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 109579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 110579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 111579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Gets the constant's index. It is only valid to call this after 112579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@link #setIndex} has been called. 113579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 114579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return {@code >= 0;} the constant pool index 115579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 116579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public int getIndex() { 117579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (index < 0) { 118579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throw new RuntimeException("index not yet set for " + constant); 119579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 120579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 121579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return index; 122579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 123579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 124579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 125579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Returns whether the constant's index has been set for this instance. 126579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 127579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @see #setIndex 128579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 129579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return {@code true} iff the index has been set 130579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 131579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public boolean hasIndex() { 132579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return (index >= 0); 133579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 134579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 135579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 136579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Sets the constant's index. It is only valid to call this method once 137579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * per instance. 138579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 139579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param index {@code >= 0;} the constant pool index 140579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 141579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public void setIndex(int index) { 142579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (index < 0) { 143579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throw new IllegalArgumentException("index < 0"); 144579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 145579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 146579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (this.index >= 0) { 147579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throw new RuntimeException("index already set"); 148579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 149579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 150579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson this.index = index; 151579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 152579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 153579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 154579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Gets the constant's class index. It is only valid to call this after 155579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@link #setClassIndex} has been called. 156579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 157579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return {@code >= 0;} the constant's class's constant pool index 158579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 159579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public int getClassIndex() { 160579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (classIndex < 0) { 161579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throw new RuntimeException("class index not yet set"); 162579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 163579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 164579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return classIndex; 165579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 166579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 167579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 168579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Returns whether the constant's class index has been set for this 169579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * instance. 170579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 171579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @see #setClassIndex 172579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 173579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return {@code true} iff the index has been set 174579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 175579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public boolean hasClassIndex() { 176579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return (classIndex >= 0); 177579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 178579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 179579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 180579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Sets the constant's class index. This is the constant pool index 181579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * for the class referred to by this instance's constant. Only 182579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * reference constants have a class, so it is only on instances 183579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * with reference constants that this method should ever be 184579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * called. It is only valid to call this method once per instance. 185579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 186579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param index {@code >= 0;} the constant's class's constant pool index 187579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 188579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public void setClassIndex(int index) { 189579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (index < 0) { 190579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throw new IllegalArgumentException("index < 0"); 191579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 192579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 193579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (this.classIndex >= 0) { 194579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throw new RuntimeException("class index already set"); 195579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 196579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 197579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson this.classIndex = index; 198579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 199579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 200579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** {@inheritDoc} */ 201579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson @Override 202579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson protected String argString() { 203579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return constant.toHuman(); 204579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 205579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson} 206