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.drools.asm.util;
030:
031: import org.drools.asm.AnnotationVisitor;
032: import org.drools.asm.Attribute;
033: import org.drools.asm.util.attrs.Traceable;
034:
035: /**
036: * An abstract trace visitor.
037: *
038: * @author Eric Bruneton
039: */
040: public abstract class TraceAbstractVisitor extends AbstractVisitor {
041:
042: /**
043: * Constant used in {@link #appendDescriptor appendDescriptor} for internal
044: * type names in bytecode notation.
045: */
046: public final static int INTERNAL_NAME = 0;
047:
048: /**
049: * Constant used in {@link #appendDescriptor appendDescriptor} for field
050: * descriptors, formatted in bytecode notation
051: */
052: public final static int FIELD_DESCRIPTOR = 1;
053:
054: /**
055: * Constant used in {@link #appendDescriptor appendDescriptor} for field
056: * signatures, formatted in bytecode notation
057: */
058: public final static int FIELD_SIGNATURE = 2;
059:
060: /**
061: * Constant used in {@link #appendDescriptor appendDescriptor} for method
062: * descriptors, formatted in bytecode notation
063: */
064: public final static int METHOD_DESCRIPTOR = 3;
065:
066: /**
067: * Constant used in {@link #appendDescriptor appendDescriptor} for method
068: * signatures, formatted in bytecode notation
069: */
070: public final static int METHOD_SIGNATURE = 4;
071:
072: /**
073: * Constant used in {@link #appendDescriptor appendDescriptor} for class
074: * signatures, formatted in bytecode notation
075: */
076: public final static int CLASS_SIGNATURE = 5;
077:
078: /**
079: * Constant used in {@link #appendDescriptor appendDescriptor} for field or
080: * method return value signatures, formatted in default Java notation
081: * (non-bytecode)
082: */
083: public final static int TYPE_DECLARATION = 6;
084:
085: /**
086: * Constant used in {@link #appendDescriptor appendDescriptor} for class
087: * signatures, formatted in default Java notation (non-bytecode)
088: */
089: public final static int CLASS_DECLARATION = 7;
090:
091: /**
092: * Constant used in {@link #appendDescriptor appendDescriptor} for method
093: * parameter signatures, formatted in default Java notation (non-bytecode)
094: */
095: public final static int PARAMETERS_DECLARATION = 8;
096:
097: /**
098: * Tab for class members.
099: */
100: protected String tab = " ";
101:
102: /**
103: * Prints a disassembled view of the given annotation.
104: *
105: * @param desc the class descriptor of the annotation class.
106: * @param visible <tt>true</tt> if the annotation is visible at runtime.
107: * @return a visitor to visit the annotation values.
108: */
109: public AnnotationVisitor visitAnnotation(final String desc,
110: final boolean visible) {
111: this .buf.setLength(0);
112: this .buf.append(this .tab).append('@');
113: appendDescriptor(TraceAbstractVisitor.FIELD_DESCRIPTOR, desc);
114: this .buf.append('(');
115: this .text.add(this .buf.toString());
116: final TraceAnnotationVisitor tav = createTraceAnnotationVisitor();
117: this .text.add(tav.getText());
118: this .text.add(visible ? ")\n" : ") // invisible\n");
119: return tav;
120: }
121:
122: /**
123: * Prints a disassembled view of the given attribute.
124: *
125: * @param attr an attribute.
126: */
127: public void visitAttribute(final Attribute attr) {
128: this .buf.setLength(0);
129: this .buf.append(this .tab).append("ATTRIBUTE ");
130: appendDescriptor(-1, attr.type);
131:
132: if (attr instanceof Traceable) {
133: ((Traceable) attr).trace(this .buf, null);
134: } else {
135: this .buf.append(" : ").append(attr.toString()).append("\n");
136: }
137:
138: this .text.add(this .buf.toString());
139: }
140:
141: /**
142: * Does nothing.
143: */
144: public void visitEnd() {
145: // does nothing
146: }
147:
148: // ------------------------------------------------------------------------
149: // Utility methods
150: // ------------------------------------------------------------------------
151:
152: protected TraceAnnotationVisitor createTraceAnnotationVisitor() {
153: return new TraceAnnotationVisitor();
154: }
155:
156: /**
157: * Appends an internal name, a type descriptor or a type signature to
158: * {@link #buf buf}.
159: *
160: * @param type indicates if desc is an internal name, a field descriptor, a
161: * method descriptor, a class signature, ...
162: * @param desc an internal name, type descriptor, or type signature. May be
163: * <tt>null</tt>.
164: */
165: protected void appendDescriptor(final int type, final String desc) {
166: if (type == TraceAbstractVisitor.CLASS_SIGNATURE
167: || type == TraceAbstractVisitor.FIELD_SIGNATURE
168: || type == TraceAbstractVisitor.METHOD_SIGNATURE) {
169: if (desc != null) {
170: this .buf.append("// signature ").append(desc).append(
171: '\n');
172: }
173: } else {
174: this.buf.append(desc);
175: }
176: }
177:
178: }
|