001: /***
002: * ASM: a very small and fast Java bytecode manipulation framework
003: * Copyright (c) 2000-2005 INRIA, France Telecom
004: * All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: * 1. Redistributions of source code must retain the above copyright
010: * notice, this list of conditions and the following disclaimer.
011: * 2. Redistributions in binary form must reproduce the above copyright
012: * notice, this list of conditions and the following disclaimer in the
013: * documentation and/or other materials provided with the distribution.
014: * 3. Neither the name of the copyright holders nor the names of its
015: * contributors may be used to endorse or promote products derived from
016: * this software without specific prior written permission.
017: *
018: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
019: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
020: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
021: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
022: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
023: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
024: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
025: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
026: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
027: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
028: * THE POSSIBILITY OF SUCH DAMAGE.
029: */package org.objectweb.asm.util;
030:
031: import java.io.PrintWriter;
032: import java.util.ArrayList;
033: import java.util.List;
034:
035: import org.objectweb.asm.Attribute;
036:
037: /**
038: * An abstract visitor.
039: *
040: * @author Eric Bruneton
041: */
042: public abstract class AbstractVisitor {
043:
044: /**
045: * The names of the Java Virtual Machine opcodes.
046: */
047: public final static String[] OPCODES;
048: /**
049: * Types for <code>operand</code> parameter of the
050: * {@link org.objectweb.asm.MethodVisitor#visitIntInsn} method when
051: * <code>opcode</code> is <code>NEWARRAY</code>.
052: */
053: public final static String[] TYPES;
054:
055: static {
056: String s = "NOP,ACONST_NULL,ICONST_M1,ICONST_0,ICONST_1,ICONST_2,"
057: + "ICONST_3,ICONST_4,ICONST_5,LCONST_0,LCONST_1,FCONST_0,"
058: + "FCONST_1,FCONST_2,DCONST_0,DCONST_1,BIPUSH,SIPUSH,LDC,,,"
059: + "ILOAD,LLOAD,FLOAD,DLOAD,ALOAD,,,,,,,,,,,,,,,,,,,,,IALOAD,"
060: + "LALOAD,FALOAD,DALOAD,AALOAD,BALOAD,CALOAD,SALOAD,ISTORE,"
061: + "LSTORE,FSTORE,DSTORE,ASTORE,,,,,,,,,,,,,,,,,,,,,IASTORE,"
062: + "LASTORE,FASTORE,DASTORE,AASTORE,BASTORE,CASTORE,SASTORE,POP,"
063: + "POP2,DUP,DUP_X1,DUP_X2,DUP2,DUP2_X1,DUP2_X2,SWAP,IADD,LADD,"
064: + "FADD,DADD,ISUB,LSUB,FSUB,DSUB,IMUL,LMUL,FMUL,DMUL,IDIV,LDIV,"
065: + "FDIV,DDIV,IREM,LREM,FREM,DREM,INEG,LNEG,FNEG,DNEG,ISHL,LSHL,"
066: + "ISHR,LSHR,IUSHR,LUSHR,IAND,LAND,IOR,LOR,IXOR,LXOR,IINC,I2L,"
067: + "I2F,I2D,L2I,L2F,L2D,F2I,F2L,F2D,D2I,D2L,D2F,I2B,I2C,I2S,LCMP,"
068: + "FCMPL,FCMPG,DCMPL,DCMPG,IFEQ,IFNE,IFLT,IFGE,IFGT,IFLE,"
069: + "IF_ICMPEQ,IF_ICMPNE,IF_ICMPLT,IF_ICMPGE,IF_ICMPGT,IF_ICMPLE,"
070: + "IF_ACMPEQ,IF_ACMPNE,GOTO,JSR,RET,TABLESWITCH,LOOKUPSWITCH,"
071: + "IRETURN,LRETURN,FRETURN,DRETURN,ARETURN,RETURN,GETSTATIC,"
072: + "PUTSTATIC,GETFIELD,PUTFIELD,INVOKEVIRTUAL,INVOKESPECIAL,"
073: + "INVOKESTATIC,INVOKEINTERFACE,,NEW,NEWARRAY,ANEWARRAY,"
074: + "ARRAYLENGTH,ATHROW,CHECKCAST,INSTANCEOF,MONITORENTER,"
075: + "MONITOREXIT,,MULTIANEWARRAY,IFNULL,IFNONNULL,";
076: OPCODES = new String[200];
077: int i = 0;
078: int j = 0;
079: int l;
080: while ((l = s.indexOf(',', j)) > 0) {
081: OPCODES[i++] = j + 1 == l ? null : s.substring(j, l);
082: j = l + 1;
083: }
084:
085: s = "T_BOOLEAN,T_CHAR,T_FLOAT,T_DOUBLE,T_BYTE,T_SHORT,T_INT,T_LONG,";
086: TYPES = new String[12];
087: j = 0;
088: i = 4;
089: while ((l = s.indexOf(',', j)) > 0) {
090: TYPES[i++] = s.substring(j, l);
091: j = l + 1;
092: }
093: }
094:
095: /**
096: * The text to be printed. Since the code of methods is not necessarily
097: * visited in sequential order, one method after the other, but can be
098: * interlaced (some instructions from method one, then some instructions
099: * from method two, then some instructions from method one again...), it is
100: * not possible to print the visited instructions directly to a sequential
101: * stream. A class is therefore printed in a two steps process: a string
102: * tree is constructed during the visit, and printed to a sequential stream
103: * at the end of the visit. This string tree is stored in this field, as a
104: * string list that can contain other string lists, which can themselves
105: * contain other string lists, and so on.
106: */
107: public final List text;
108:
109: /**
110: * A buffer that can be used to create strings.
111: */
112: protected final StringBuffer buf;
113:
114: /**
115: * Constructs a new {@link AbstractVisitor}.
116: */
117: protected AbstractVisitor() {
118: this .text = new ArrayList();
119: this .buf = new StringBuffer();
120: }
121:
122: /**
123: * Returns the text printed by this visitor.
124: *
125: * @return the text printed by this visitor.
126: */
127: public List getText() {
128: return text;
129: }
130:
131: /**
132: * Appends a quoted string to a given buffer.
133: *
134: * @param buf the buffer where the string must be added.
135: * @param s the string to be added.
136: */
137: public static void appendString(final StringBuffer buf,
138: final String s) {
139: buf.append("\"");
140: for (int i = 0; i < s.length(); ++i) {
141: char c = s.charAt(i);
142: if (c == '\n') {
143: buf.append("\\n");
144: } else if (c == '\r') {
145: buf.append("\\r");
146: } else if (c == '\\') {
147: buf.append("\\\\");
148: } else if (c == '"') {
149: buf.append("\\\"");
150: } else if (c < 0x20 || c > 0x7f) {
151: buf.append("\\u");
152: if (c < 0x10) {
153: buf.append("000");
154: } else if (c < 0x100) {
155: buf.append("00");
156: } else if (c < 0x1000) {
157: buf.append("0");
158: }
159: buf.append(Integer.toString(c, 16));
160: } else {
161: buf.append(c);
162: }
163: }
164: buf.append("\"");
165: }
166:
167: /**
168: * Prints the given string tree.
169: *
170: * @param pw the writer to be used to print the tree.
171: * @param l a string tree, i.e., a string list that can contain other string
172: * lists, and so on recursively.
173: */
174: void printList(final PrintWriter pw, final List l) {
175: for (int i = 0; i < l.size(); ++i) {
176: Object o = l.get(i);
177: if (o instanceof List) {
178: printList(pw, (List) o);
179: } else {
180: pw.print(o.toString());
181: }
182: }
183: }
184:
185: /**
186: * Returns the default {@link ASMifiable} prototypes.
187: *
188: * @return the default {@link ASMifiable} prototypes.
189: */
190: public static Attribute[] getDefaultAttributes() {
191: return new Attribute[0];
192: }
193: }
|