123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387 |
- package org.aspectj.apache.bcel.classfile;
-
- /* ====================================================================
- * 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 java.io.DataInputStream;
- import java.io.DataOutputStream;
- import java.io.IOException;
-
- import org.aspectj.apache.bcel.Constants;
-
- /**
- * This class represents a chunk of Java byte code contained in a method. It is instantiated by the
- * <em>Attribute.readAttribute()</em> method. A <em>Code</em> attribute contains informations about operand stack, local variables,
- * byte code and the exceptions handled within this method.
- *
- * This attribute has attributes itself, namely <em>LineNumberTable</em> which is used for debugging purposes and
- * <em>LocalVariableTable</em> which contains information about the local variables.
- *
- * @version $Id: Code.java,v 1.9 2009/10/05 17:35:36 aclement Exp $
- * @author <A HREF="mailto:markus.dahm@berlin.de">M. Dahm</A>
- * @see Attribute
- * @see CodeException
- * @see LineNumberTable
- * @see LocalVariableTable
- */
- public final class Code extends Attribute {
- private int maxStack; // Maximum size of stack used by this method
- private int maxLocals; // Number of local variables
- private byte[] code; // Actual byte code
- private CodeException[] exceptionTable;
- private Attribute[] attributes;
- private static final CodeException[] NO_EXCEPTIONS = new CodeException[] {};
-
- /**
- * Initialize from another object. Note that both objects use the same references (shallow copy). Use copy() for a physical
- * copy.
- */
- public Code(Code c) {
- this(c.getNameIndex(), c.getLength(), c.getMaxStack(), c.getMaxLocals(), c.getCode(), c.getExceptionTable(), c
- .getAttributes(), c.getConstantPool());
- }
-
- Code(int name_index, int length, DataInputStream file, ConstantPool constant_pool) throws IOException {
- // Initialize with some default values which will be overwritten later
- this(name_index, length, file.readUnsignedShort(), file.readUnsignedShort(), (byte[]) null, (CodeException[]) null,
- (Attribute[]) null, constant_pool);
-
- int len = file.readInt();
- code = new byte[len]; // Read byte code
- file.readFully(code);
-
- /*
- * Read exception table that contains all regions where an exception handler is active, i.e., a try { ... } catch() block.
- */
- len = file.readUnsignedShort();
- if (len == 0) {
- exceptionTable = NO_EXCEPTIONS;
- } else {
- exceptionTable = new CodeException[len];
- for (int i = 0; i < len; i++) {
- exceptionTable[i] = new CodeException(file);
- }
- }
-
- // Read all attributes, eg: LineNumberTable, LocalVariableTable
- attributes = AttributeUtils.readAttributes(file, constant_pool);
-
- /*
- * Adjust length, because of setAttributes in this(), s.b. length is incorrect, because it didn't take the internal
- * attributes into account yet! Very subtle bug, fixed in 3.1.1.
- */
- this.length = length;
- }
-
- /**
- * @param name_index Index pointing to the name <em>Code</em>
- * @param length Content length in bytes
- * @param max_stack Maximum size of stack
- * @param max_locals Number of local variables
- * @param code Actual byte code
- * @param exception_table Table of handled exceptions
- * @param attributes Attributes of code: LineNumber or LocalVariable
- * @param constant_pool Array of constants
- */
- public Code(int name_index, int length, int max_stack, int max_locals, byte[] code, CodeException[] exception_table,
- Attribute[] attributes, ConstantPool constant_pool) {
- super(Constants.ATTR_CODE, name_index, length, constant_pool);
-
- this.maxStack = max_stack;
- this.maxLocals = max_locals;
-
- setCode(code);
- setExceptionTable(exception_table);
- setAttributes(attributes); // Overwrites length!
- }
-
- /**
- * Called by objects that are traversing the nodes of the tree implicitely defined by the contents of a Java class. I.e., the
- * hierarchy of methods, fields, attributes, etc. spawns a tree of objects.
- *
- * @param v Visitor object
- */
- @Override
- public void accept(ClassVisitor v) {
- v.visitCode(this);
- }
-
- /**
- * Dump code attribute to file stream in binary format.
- *
- * @param file Output file stream
- * @throws IOException
- */
- @Override
- public final void dump(DataOutputStream file) throws IOException {
- super.dump(file);
-
- file.writeShort(maxStack);
- file.writeShort(maxLocals);
- file.writeInt(code.length);
- file.write(code, 0, code.length);
-
- file.writeShort(exceptionTable.length);
- for (CodeException e : exceptionTable) {
- e.dump(file);
- }
-
- file.writeShort(attributes.length);
- for (Attribute attribute : attributes) {
- attribute.dump(file);
- }
- }
-
- /**
- * @return Collection of code attributes.
- * @see Attribute
- */
- public final Attribute[] getAttributes() {
- return attributes;
- }
-
- /**
- * @return LineNumberTable of Code, if it has one
- */
- public LineNumberTable getLineNumberTable() {
- for (Attribute attribute : attributes) {
- if (attribute.tag == Constants.ATTR_LINE_NUMBER_TABLE) {
- return (LineNumberTable) attribute;
- }
- }
- return null;
- }
-
- /**
- * @return LocalVariableTable of Code, if it has one
- */
- public LocalVariableTable getLocalVariableTable() {
- for (Attribute attribute : attributes) {
- if (attribute.tag == Constants.ATTR_LOCAL_VARIABLE_TABLE) {
- return (LocalVariableTable) attribute;
- }
- }
- return null;
- }
-
- /**
- * @return Actual byte code of the method.
- */
- public final byte[] getCode() {
- return code;
- }
-
- /**
- * @return Table of handled exceptions.
- * @see CodeException
- */
- public final CodeException[] getExceptionTable() {
- return exceptionTable;
- }
-
- /**
- * @return Number of local variables.
- */
- public final int getMaxLocals() {
- return maxLocals;
- }
-
- /**
- * @return Maximum size of stack used by this method.
- */
-
- public final int getMaxStack() {
- return maxStack;
- }
-
- /**
- * @return the internal length of this code attribute (minus the first 6 bytes) and excluding all its attributes
- */
- private final int getInternalLength() {
- return 2 /* max_stack */+ 2 /* max_locals */+ 4 /* code length */
- + (code == null ? 0 : code.length) /* byte-code */
- + 2 /* exception-table length */
- + 8 * (exceptionTable == null ? 0 : exceptionTable.length) /* exception table */
- + 2 /* attributes count */;
- }
-
- /**
- * @return the full size of this code attribute, minus its first 6 bytes, including the size of all its contained attributes
- */
- private final int calculateLength() {
- int len = 0;
- if (attributes != null) {
- for (Attribute attribute : attributes) {
- len += attribute.length + 6 /* attribute header size */;
- }
- }
- return len + getInternalLength();
- }
-
- /**
- * @param attributes.
- */
- public final void setAttributes(Attribute[] attributes) {
- this.attributes = attributes;
- length = calculateLength(); // Adjust length
- }
-
- /**
- * @param code byte code
- */
- public final void setCode(byte[] code) {
- this.code = code;
- }
-
- /**
- * @param exception_table exception table
- */
- public final void setExceptionTable(CodeException[] exception_table) {
- this.exceptionTable = exception_table;
- }
-
- /**
- * @param max_locals maximum number of local variables
- */
- public final void setMaxLocals(int max_locals) {
- this.maxLocals = max_locals;
- }
-
- /**
- * @param max_stack maximum stack size
- */
- public final void setMaxStack(int max_stack) {
- this.maxStack = max_stack;
- }
-
- /**
- * @return String representation of code chunk.
- */
- public final String toString(boolean verbose) {
- StringBuilder buf;
-
- buf = new StringBuilder("Code(max_stack = " + maxStack + ", max_locals = " + maxLocals + ", code_length = " + code.length
- + ")\n" + Utility.codeToString(code, cpool, 0, -1, verbose));
-
- if (exceptionTable.length > 0) {
- buf.append("\nException handler(s) = \n" + "From\tTo\tHandler\tType\n");
-
- for (CodeException e : exceptionTable) {
- buf.append(e.toString(cpool, verbose) + "\n");
- }
- }
-
- if (attributes.length > 0) {
- buf.append("\nAttribute(s) = \n");
-
- for (Attribute attribute : attributes) {
- buf.append(attribute.toString() + "\n");
- }
- }
-
- return buf.toString();
- }
-
- /**
- * @return String representation of code chunk.
- */
- @Override
- public final String toString() {
- return toString(true);
- }
-
- // /**
- // * @return deep copy of this attribute
- // */
- // public Attribute copy(ConstantPool constant_pool) {
- // Code c = (Code)clone();
- // c.code = (byte[])code.clone();
- // c.cpool = constant_pool;
- //
- // c.exceptionTable = new CodeException[exceptionTable.length];
- // for(int i=0; i < exceptionTable.length; i++)
- // c.exceptionTable[i] = exceptionTable[i].copy();
- //
- // c.attributes = new Attribute[attributes.length];
- // for(int i=0; i < attributes.length; i++)
- // c.attributes[i] = attributes[i].copy(constant_pool);
- //
- // return c;
- // }
-
- /**
- * Returns the same as toString(true) except that the attribute information isn't included (line numbers). Can be used to check
- * whether two pieces of code are equivalent.
- */
- public String getCodeString() {
- StringBuilder codeString = new StringBuilder();
- codeString.append("Code(max_stack = ").append(maxStack);
- codeString.append(", max_locals = ").append(maxLocals);
- codeString.append(", code_length = ").append(code.length).append(")\n");
- codeString.append(Utility.codeToString(code, cpool, 0, -1, true));
- if (exceptionTable.length > 0) {
- codeString.append("\n").append("Exception entries = ").append(exceptionTable.length).append("\n");
- for (CodeException exc : exceptionTable) {
- int type = exc.getCatchType();
- String name = "finally";
- if (type != 0) {
- name = this.cpool.getConstantString(type, Constants.CONSTANT_Class);
- }
- codeString.append(name).append("[");
- codeString.append(exc.getStartPC()).append(">").append(exc.getEndPC()).append("]\n");
- }
- }
- return codeString.toString();
- }
- }
|