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.dex.DexOptions; 20579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 21579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonimport java.util.ArrayList; 22579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 23579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson/** 24579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Destination for {@link DalvInsn} instances being output. This class 25579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * receives and collects instructions in two pieces — a primary 26579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * list and a suffix (generally consisting of adjunct data referred to 27579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * by the primary list, such as switch case tables) — which it 28579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * merges and emits back out in the form of a {@link DalvInsnList} 29579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * instance. 30579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 31579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilsonpublic final class OutputCollector { 32579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 33579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@code non-null;} the associated finisher (which holds the instruction 34579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * list in-progress) 35579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 36579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson private final OutputFinisher finisher; 37579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 38579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 39579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@code null-ok;} suffix for the output, or {@code null} if the suffix 40579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * has been appended to the main output (by {@link #appendSuffixToOutput}) 41579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 42579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson private ArrayList<DalvInsn> suffix; 43579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 44579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 45579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Constructs an instance. 46579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 47579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param dexOptions {@code non-null;} options for dex output 48579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param initialCapacity {@code >= 0;} initial capacity of the output list 49579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param suffixInitialCapacity {@code >= 0;} initial capacity of the output 50579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * suffix 51579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param regCount {@code >= 0;} register count for the method 52579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 53579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public OutputCollector(DexOptions dexOptions, int initialCapacity, int suffixInitialCapacity, 54579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson int regCount) { 55579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson this.finisher = new OutputFinisher(dexOptions, initialCapacity, regCount); 56579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson this.suffix = new ArrayList<DalvInsn>(suffixInitialCapacity); 57579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 58579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 59579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 60579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Adds an instruction to the output. 61579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 62579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param insn {@code non-null;} the instruction to add 63579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 64579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public void add(DalvInsn insn) { 65579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson finisher.add(insn); 66579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 67579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 68579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 69579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Reverses a branch which is buried a given number of instructions 70579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * backward in the output. It is illegal to call this unless the 71579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * indicated instruction really is a reversible branch. 72579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 73579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param which how many instructions back to find the branch; 74579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@code 0} is the most recently added instruction, 75579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * {@code 1} is the instruction before that, etc. 76579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param newTarget {@code non-null;} the new target for the reversed branch 77579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 78579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public void reverseBranch(int which, CodeAddress newTarget) { 79579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson finisher.reverseBranch(which, newTarget); 80579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 81579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 82579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 83579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Adds an instruction to the output suffix. 84579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 85579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @param insn {@code non-null;} the instruction to add 86579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 87579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public void addSuffix(DalvInsn insn) { 88579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson suffix.add(insn); 89579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 90579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 91579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 92579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Gets the results of all the calls on this instance, in the form of 93579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * an {@link OutputFinisher}. 94579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * 95579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @return {@code non-null;} the output finisher 96579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * @throws UnsupportedOperationException if this method has 97579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * already been called 98579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 99579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson public OutputFinisher getFinisher() { 100579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson if (suffix == null) { 101579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson throw new UnsupportedOperationException("already processed"); 102579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 103579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 104579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson appendSuffixToOutput(); 105579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson return finisher; 106579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 107579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 108579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson /** 109579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * Helper for {@link #getFinisher}, which appends the suffix to 110579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson * the primary output. 111579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson */ 112579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson private void appendSuffixToOutput() { 113579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson int size = suffix.size(); 114579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 115579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson for (int i = 0; i < size; i++) { 116579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson finisher.add(suffix.get(i)); 117579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 118579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson 119579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson suffix = null; 120579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson } 121579d7739c53a2707ad711a2d2cae46d7d782f06Jesse Wilson} 122