/**
* ASM: a very small and fast Java bytecode manipulation framework
* Copyright (c) 2000,2002,2003 INRIA, France Telecom
* 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. Neither the name of the copyright holders nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS 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 COPYRIGHT OWNER OR 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.
*/
package oracle.toplink.libraries.asm.attrs;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import oracle.toplink.libraries.asm.Attribute;
import oracle.toplink.libraries.asm.ByteVector;
import oracle.toplink.libraries.asm.ClassReader;
import oracle.toplink.libraries.asm.ClassWriter;
import oracle.toplink.libraries.asm.Label;
/**
* The LocalVariableTypeTable attribute is an optional variable-length attribute of a Code
* attribute. It may be used by debuggers to determine the value of a given
* local variable during the execution of a method. If LocalVariableTypeTable attributes
* are present in the attributes table of a given Code attribute, then they may appear in
* any order. There may be no more than one LocalVariableTypeTable attribute per local
* variable in the Code attribute.
*
* The LocalVariableTypeTable attribute differs from the LocalVariableTable attribute in that
* it provides signature information rather than descriptor information. This difference
* is only significant for variables whose type is a generic reference type. Such
* variables will appear in both tables, while variables of other types will appear only
* in LocalVariableTable.
* <p>
* The LocalVariableTypeTable attribute has the following format:
* <pre>
* LocalVariableTypeTable_attribute {
* u2 attribute_name_index;
* u4 attribute_length;
* u2 local_variable_type_table_length;
* {
* u2 start_pc;
* u2 length;
* u2 name_index;
* u2 signature_index;
* u2 index;
* } local_variable_type_table[local_variable_type_table_length];
* }
* </pre>
*
* The items of the LocalVariableTypeTable_attribute structure are as follows:
* <dl>
* <dt>attribute_name_index</dt>
* <dd>The value of the attribute_name_index item must be a valid index
* into the constant_pool table a121. The constant_pool entry at that
* index must be a CONSTANT_Utf8_info (4.5.7) a122 structure
* representing the string "LocalVariableTypeTable" a123.</dd>
*
* <dt>attribute_length</dt>
* <dd>The value of the attribute_length item indicates the length of the
* attribute, excluding the initial six bytes.</dd>
*
* <dt>local_variable_table_length</dt>
* <dd>The value of the local_variable_table_length item indicates the
* number of entries in the local_variable_table array.</dd>
*
* <dt>local_variable_table[]</dd>
* <dd>Each entry in the local_variable_table array indicates a range of code
* array offsets within which a local variable has a value. It also
* indicates the index into the local variable array of the current
* frame at which that local variable can be found. Each entry must
* contain the following five items:</dd>
* <dl>
* <dt>start_pc, length</dt>
* <dd>The given local variable must have a value at indices into the
* code array in the interval [start_pc, start_pc+length), that is,
* between start_pc and start_pc+length exclusive. The value of
* start_pc must be a valid index into the code array of this Code
* attribute and must be the index of the opcode of an
* instructiona124. The value of start_pc+length must either be a
* valid index into the code array of this Code attribute and be
* the index of the opcode of an instruction, or it must be the
* first index beyond the end of that code array a125.</dd>
*
* <dt>name_index, signature_index</dt>
* <dd>The value of the name_index item must be a valid index into
* the constant_pool table a127. The constant_pool entry at that
* index must contain a CONSTANT_Utf8_info structure
* a128 representing a valid unqualified name denoting a local variablea128.
* Careful here - do we want any restrictions at all?</dd>
* <p>
* The value of the signature_index item must be a valid index
* into the constant_pool table. The constant_pool entry at that index
* must contain a CONSTANT_Utf8_info structure
* representing a field type signature encoding the type
* of a local variable in the source program.</dd>
*
* <dt>index</dt>
* <dd>The given local variable must be at index in the local variable
* array of the current frame. If the local variable at index is of
* type double or long, it occupies both index and index+1.</dd>
* </dl>
* </dl>
*
* @author Eugene Kuleshov
*/
public class LocalVariableTypeTableAttribute extends Attribute {
protected List types = new ArrayList();
public LocalVariableTypeTableAttribute() {
super( "LocalVariableTypeTable");
}
public List getTypes() {
return types;
}
protected Label[] getLabels() {
HashSet labels = new HashSet();
for (int i = 0; i < types.size(); i++) {
LocalVariableType t = (LocalVariableType)types.get(i);
labels.add( t.getStart());
labels.add( t.getEnd());
}
return ( Label[]) labels.toArray( new Label[ labels.size()]);
}
protected Attribute read( ClassReader cr, int off, int len, char[] buf, int codeOff, Label[] labels) {
int localVariableTypeTableLength = cr.readUnsignedShort(off);
off += 2;
LocalVariableTypeTableAttribute attr = new LocalVariableTypeTableAttribute();
for( int i = 0; i < localVariableTypeTableLength; i++) {
LocalVariableType t = new LocalVariableType();
int start = cr.readUnsignedShort( off);
int length = cr.readUnsignedShort( off + 2);
t.start = getLabel( labels, start);
t.end = getLabel( labels, start + length);
t.name = cr.readUTF8( off + 4, buf);
t.signature = cr.readUTF8( off + 6, buf);
t.index = cr.readUnsignedShort( off + 8);
off += 10;
types.add(t);
}
return attr;
}
protected ByteVector write( ClassWriter cw, byte[] code, int len, int maxStack, int maxLocals) {
ByteVector bv = new ByteVector();
bv.putShort( types.size());
for( int i = 0; i < types.size(); i++) {
LocalVariableType t = ( LocalVariableType) types.get(i);
int startOffset = t.getStart().getOffset();
bv.putShort( startOffset);
bv.putShort( t.getEnd().getOffset()-startOffset);
bv.putUTF8( t.getName());
bv.putUTF8( t.getSignature());
bv.putShort( t.getIndex());
}
return bv;
}
private Label getLabel( Label[] labels, int offset) {
Label label = labels[ offset];
if( label==null) {
label = new Label();
labels[ offset] = label;
}
return label;
}
public String toString() {
StringBuffer sb = new StringBuffer("LocalVariableTypeTable[");
for (int i = 0; i < types.size(); i++) {
sb.append('\n').append('[').append(types.get(i)).append(']');
}
sb.append("\n]");
return sb.toString();
}
}