123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268 |
- package org.aspectj.apache.bcel.verifier.statics;
-
- /* ====================================================================
- * The Apache Software License, Version 1.1
- *
- * Copyright (c) 2001 The Apache Software Foundation. All rights
- * reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright
- * notice, this list of conditions and the following disclaimer in
- * the documentation and/or other materials provided with the
- * distribution.
- *
- * 3. The end-user documentation included with the redistribution,
- * if any, must include the following acknowledgment:
- * "This product includes software developed by the
- * Apache Software Foundation (https://www.apache.org/)."
- * Alternately, this acknowledgment may appear in the software itself,
- * if and wherever such third-party acknowledgments normally appear.
- *
- * 4. The names "Apache" and "Apache Software Foundation" and
- * "Apache BCEL" must not be used to endorse or promote products
- * derived from this software without prior written permission. For
- * written permission, please contact apache@apache.org.
- *
- * 5. Products derived from this software may not be called "Apache",
- * "Apache BCEL", nor may "Apache" appear in their name, without
- * prior written permission of the Apache Software Foundation.
- *
- * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
- * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
- * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
- * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
- * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
- * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
- * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
- * SUCH DAMAGE.
- * ====================================================================
- *
- * This software consists of voluntary contributions made by many
- * individuals on behalf of the Apache Software Foundation. For more
- * information on the Apache Software Foundation, please see
- * <https://www.apache.org/>.
- */
-
- import org.aspectj.apache.bcel.classfile.AnnotationDefault;
- import org.aspectj.apache.bcel.classfile.Code;
- import org.aspectj.apache.bcel.classfile.CodeException;
- import org.aspectj.apache.bcel.classfile.ConstantClass;
- import org.aspectj.apache.bcel.classfile.ConstantDouble;
- import org.aspectj.apache.bcel.classfile.ConstantFieldref;
- import org.aspectj.apache.bcel.classfile.ConstantFloat;
- import org.aspectj.apache.bcel.classfile.ConstantInteger;
- import org.aspectj.apache.bcel.classfile.ConstantInterfaceMethodref;
- import org.aspectj.apache.bcel.classfile.ConstantLong;
- import org.aspectj.apache.bcel.classfile.ConstantMethodref;
- import org.aspectj.apache.bcel.classfile.ConstantNameAndType;
- import org.aspectj.apache.bcel.classfile.ConstantPool;
- import org.aspectj.apache.bcel.classfile.ConstantString;
- import org.aspectj.apache.bcel.classfile.ConstantUtf8;
- import org.aspectj.apache.bcel.classfile.ConstantValue;
- import org.aspectj.apache.bcel.classfile.Deprecated;
- import org.aspectj.apache.bcel.classfile.ExceptionTable;
- import org.aspectj.apache.bcel.classfile.Field;
- import org.aspectj.apache.bcel.classfile.InnerClass;
- import org.aspectj.apache.bcel.classfile.InnerClasses;
- import org.aspectj.apache.bcel.classfile.JavaClass;
- import org.aspectj.apache.bcel.classfile.LineNumber;
- import org.aspectj.apache.bcel.classfile.LineNumberTable;
- import org.aspectj.apache.bcel.classfile.LocalVariable;
- import org.aspectj.apache.bcel.classfile.LocalVariableTable;
- import org.aspectj.apache.bcel.classfile.LocalVariableTypeTable;
- import org.aspectj.apache.bcel.classfile.Method;
- import org.aspectj.apache.bcel.classfile.Node;
- import org.aspectj.apache.bcel.classfile.Signature;
- import org.aspectj.apache.bcel.classfile.SourceFile;
- import org.aspectj.apache.bcel.classfile.StackMap;
- import org.aspectj.apache.bcel.classfile.Synthetic;
- import org.aspectj.apache.bcel.classfile.Unknown;
- import org.aspectj.apache.bcel.classfile.annotation.RuntimeInvisAnnos;
- import org.aspectj.apache.bcel.classfile.annotation.RuntimeInvisParamAnnos;
- import org.aspectj.apache.bcel.classfile.annotation.RuntimeVisAnnos;
- import org.aspectj.apache.bcel.classfile.annotation.RuntimeVisParamAnnos;
- import org.aspectj.apache.bcel.verifier.exc.AssertionViolatedException;
-
- /**
- * BCEL's Node classes (those from the classfile API that <B>accept()</B> Visitor
- * instances) have <B>toString()</B> methods that were not designed to be robust,
- * this gap is closed by this class.
- * When performing class file verification, it may be useful to output which
- * entity (e.g. a <B>Code</B> instance) is not satisfying the verifier's
- * constraints, but in this case it could be possible for the <B>toString()</B>
- * method to throw a RuntimeException.
- * A (new StringRepresentation(Node n)).toString() never throws any exception.
- * Note that this class also serves as a placeholder for more sophisticated message
- * handling in future versions of JustIce.
- *
- * @version $Id: StringRepresentation.java,v 1.4 2009/09/15 19:40:22 aclement Exp $
- * @author <A HREF="https://www.inf.fu-berlin.de/~ehaase"/>Enver Haase</A>
- */
- public class StringRepresentation extends org.aspectj.apache.bcel.verifier.EmptyClassVisitor{
- /** The string representation, created by a visitXXX() method, output by toString(). */
- private String tostring;
- /** The node we ask for its string representation. Not really needed; only for debug output. */
- private Node n;
- /**
- * Creates a new StringRepresentation object which is the representation of n.
- *
- * @see #toString()
- */
- public StringRepresentation(Node n){
- this.n = n;
- n.accept(this); // assign a string representation to field 'tostring' if we know n's class.
- }
- /**
- * Returns the String representation.
- */
- public String toString(){
- // The run-time check below is needed because we don't want to omit inheritance
- // of "EmptyVisitor" and provide a thousand empty methods.
- // However, in terms of performance this would be a better idea.
- // If some new "Node" is defined in BCEL (such as some concrete "Attribute"), we
- // want to know that this class has also to be adapted.
- if (tostring == null) throw new AssertionViolatedException("Please adapt '"+getClass()+"' to deal with objects of class '"+n.getClass()+"'.");
- return tostring;
- }
- /**
- * Returns the String representation of the Node object obj;
- * this is obj.toString() if it does not throw any RuntimeException,
- * or else it is a string derived only from obj's class name.
- */
- private String toString(Node obj){
- String ret;
- try{
- ret = obj.toString();
- }
- catch(RuntimeException e){
- String s = obj.getClass().getName();
- s = s.substring(s.lastIndexOf(".")+1);
- ret = "<<"+s+">>";
- }
- catch(ClassFormatError e){ /* BCEL can be harsh e.g. trying to convert the "signature" of a ReturnaddressType LocalVariable (shouldn't occur, but people do crazy things) */
- String s = obj.getClass().getName();
- s = s.substring(s.lastIndexOf(".")+1);
- ret = "<<"+s+">>";
- }
- return ret;
- }
- ////////////////////////////////
- // Visitor methods start here //
- ////////////////////////////////
- // We don't of course need to call some default implementation:
- // e.g. we could also simply output "Code" instead of a possibly
- // lengthy Code attribute's toString().
- public void visitCode(Code obj){
- //tostring = toString(obj);
- tostring = "<CODE>"; // We don't need real code outputs.
- }
- public void visitCodeException(CodeException obj){
- tostring = toString(obj);
- }
- public void visitConstantClass(ConstantClass obj){
- tostring = toString(obj);
- }
- public void visitConstantDouble(ConstantDouble obj){
- tostring = toString(obj);
- }
- public void visitConstantFieldref(ConstantFieldref obj){
- tostring = toString(obj);
- }
- public void visitConstantFloat(ConstantFloat obj){
- tostring = toString(obj);
- }
- public void visitConstantInteger(ConstantInteger obj){
- tostring = toString(obj);
- }
- public void visitConstantInterfaceMethodref(ConstantInterfaceMethodref obj){
- tostring = toString(obj);
- }
- public void visitConstantLong(ConstantLong obj){
- tostring = toString(obj);
- }
- public void visitConstantMethodref(ConstantMethodref obj){
- tostring = toString(obj);
- }
- public void visitConstantNameAndType(ConstantNameAndType obj){
- tostring = toString(obj);
- }
- public void visitConstantPool(ConstantPool obj){
- tostring = toString(obj);
- }
- public void visitConstantString(ConstantString obj){
- tostring = toString(obj);
- }
- public void visitConstantUtf8(ConstantUtf8 obj){
- tostring = toString(obj);
- }
- public void visitConstantValue(ConstantValue obj){
- tostring = toString(obj);
- }
- public void visitDeprecated(Deprecated obj){
- tostring = toString(obj);
- }
- public void visitExceptionTable(ExceptionTable obj){
- tostring = toString(obj);
- }
- public void visitField(Field obj){
- tostring = toString(obj);
- }
- public void visitInnerClass(InnerClass obj){
- tostring = toString(obj);
- }
- public void visitInnerClasses(InnerClasses obj){
- tostring = toString(obj);
- }
- public void visitJavaClass(JavaClass obj){
- tostring = toString(obj);
- }
- public void visitLineNumber(LineNumber obj){
- tostring = toString(obj);
- }
- public void visitLineNumberTable(LineNumberTable obj){
- tostring = "<LineNumberTable: "+toString(obj)+">";
- }
- public void visitLocalVariable(LocalVariable obj){
- tostring = toString(obj);
- }
- public void visitLocalVariableTable(LocalVariableTable obj){
- tostring = "<LocalVariableTable: "+toString(obj)+">";
- }
- public void visitMethod(Method obj){
- tostring = toString(obj);
- }
- public void visitSignature(Signature obj){
- tostring = toString(obj);
- }
- public void visitSourceFile(SourceFile obj){
- tostring = toString(obj);
- }
- public void visitStackMap(StackMap obj){
- tostring = toString(obj);
- }
- public void visitSynthetic(Synthetic obj){
- tostring = toString(obj);
- }
- public void visitUnknown(Unknown obj){
- tostring = toString(obj);
- }
-
- public void visitRuntimeVisibleAnnotations(RuntimeVisAnnos obj) {tostring = toString(obj);}
- public void visitRuntimeInvisibleAnnotations(RuntimeInvisAnnos obj) {tostring = toString(obj);}
- public void visitRuntimeVisibleParameterAnnotations(RuntimeVisParamAnnos obj) {tostring = toString(obj);}
- public void visitRuntimeInvisibleParameterAnnotations(RuntimeInvisParamAnnos obj) {tostring = toString(obj);}
- public void visitAnnotationDefault(AnnotationDefault obj) {tostring = toString(obj);}
- public void visitLocalVariableTypeTable(LocalVariableTypeTable obj) {tostring = toString(obj);}
-
- }
|