asm-commons 9.6 · org.objectweb.asm.commons.LocalVariablesSorter

Modifier and Type	Field and Description
protected final int	firstLocal The index of the first local variable, after formal parameters.
protected int	nextLocal The index of the next local variable to be created by `newLocal`.
private static final Type	OBJECT_TYPE The type of the java.lang.Object class.
private Object[]	remappedLocalTypes The local variable types after remapping.
private int[]	remappedVariableIndices The mapping from old to new local variable indices.

Access	Constructor and Description
public	LocalVariablesSorter(final int access flags of the adapted method. access, final String the method's descriptor (see `Type`). descriptor, final MethodVisitor the method visitor to which this adapter delegates calls. methodVisitor) Constructs a new `LocalVariablesSorter`.
protected	LocalVariablesSorter(final int the ASM API version implemented by this visitor. Must be one of the `ASM`x values in `Opcodes`. api, final int access flags of the adapted method. access, final String the method's descriptor (see `Type`). descriptor, final MethodVisitor the method visitor to which this adapter delegates calls. methodVisitor) Constructs a new `LocalVariablesSorter`.

Method Summary

Modifier and Type	Method and Description
public int	Returns: the identifier of the newly created local variable. newLocal(final Type the type of the local variable to be created. type) Constructs a new local variable of the given type.
protected int	newLocalMapping(final Type type)
private int	remap(final int varIndex, final Type type)
private void	setFrameLocal(final int local, final Object type)
protected void	setLocalType(final int a local variable identifier, as returned by `newLocal`. local, final Type the type of the value being stored in the local variable. type) Notifies subclasses that a local variable has been added or remapped.
protected void	updateNewLocals(final Object[] the stack map frame types corresponding to the local variables added with `newLocal` (and null for the others). The format of this array is the same as in `MethodVisitor#visitFrame`, except that long and double types use two slots. The types for the current stack map frame must be updated in place in this array. newLocals) Notifies subclasses that a new stack map frame is being visited.
public void	visitFrame(final int the type of this stack map frame. Must be `Opcodes#F_NEW` for expanded frames, or `Opcodes#F_FULL`, `Opcodes#F_APPEND`, `Opcodes#F_CHOP`, `Opcodes#F_SAME` or `Opcodes#F_APPEND`, `Opcodes#F_SAME1` for compressed frames. type, final int the number of local variables in the visited frame. Long and double values count for one variable. numLocal, final Object[] the local variable types in this frame. This array must not be modified. Primitive types are represented by `Opcodes#TOP`, `Opcodes#INTEGER`, `Opcodes#FLOAT`, `Opcodes#LONG`, `Opcodes#DOUBLE`, `Opcodes#NULL` or `Opcodes#UNINITIALIZED_THIS` (long and double are represented by a single element). Reference types are represented by String objects (representing internal names, see `Type#getInternalName()`), and uninitialized types by Label objects (this label designates the NEW instruction that created this uninitialized value). local, final int the number of operand stack elements in the visited frame. Long and double values count for one stack element. numStack, final Object[] the operand stack types in this frame. This array must not be modified. Its content has the same format as the "local" array. stack) Overrides org.objectweb.asm.MethodVisitor.visitFrame. Visits the current state of the local variables and operand stack elements.
public void	visitIincInsn(final int index of the local variable to be incremented. varIndex, final int amount to increment the local variable by. increment) Overrides org.objectweb.asm.MethodVisitor.visitIincInsn. Visits an IINC instruction.
public void	visitLocalVariable(final String the name of a local variable. name, final String the type descriptor of this local variable. descriptor, final String the type signature of this local variable. May be null if the local variable type does not use generic types. signature, final Label the first instruction corresponding to the scope of this local variable (inclusive). start, final Label the last instruction corresponding to the scope of this local variable (exclusive). end, final int the local variable's index. index) Overrides org.objectweb.asm.MethodVisitor.visitLocalVariable. Visits a local variable declaration.
public AnnotationVisitor	visitLocalVariableAnnotation(final int a reference to the annotated type. The sort of this type reference must be `TypeReference#LOCAL_VARIABLE` or `TypeReference#RESOURCE_VARIABLE`. See `TypeReference`. typeRef, final TypePath the path to the annotated type argument, wildcard bound, array element type, or static inner type within 'typeRef'. May be null if the annotation targets 'typeRef' as a whole. typePath, final Label[] the fist instructions corresponding to the continuous ranges that make the scope of this local variable (inclusive). start, final Label[] the last instructions corresponding to the continuous ranges that make the scope of this local variable (exclusive). This array must have the same size as the 'start' array. end, final int[] the local variable's index in each range. This array must have the same size as the 'start' array. index, final String the class descriptor of the annotation class. descriptor, final boolean true if the annotation is visible at runtime. visible) Overrides org.objectweb.asm.MethodVisitor.visitLocalVariableAnnotation. Visits an annotation on a local variable type.
public void	visitMaxs(final int maximum stack size of the method. maxStack, final int maximum number of local variables for the method. maxLocals) Overrides org.objectweb.asm.MethodVisitor.visitMaxs. Visits the maximum stack size and the maximum number of local variables of the method.
public void	visitVarInsn(final int the opcode of the local variable instruction to be visited. This opcode is either ILOAD, LLOAD, FLOAD, DLOAD, ALOAD, ISTORE, LSTORE, FSTORE, DSTORE, ASTORE or RET. opcode, final int the operand of the instruction to be visited. This operand is the index of a local variable. varIndex) Overrides org.objectweb.asm.MethodVisitor.visitVarInsn. Visits a local variable instruction.

firstLocal	back to summary
protected final int firstLocal The index of the first local variable, after formal parameters.

nextLocal	back to summary
protected int nextLocal The index of the next local variable to be created by `newLocal`.

OBJECT_TYPE	back to summary
private static final Type OBJECT_TYPE The type of the java.lang.Object class.

remappedLocalTypes	back to summary
private Object[] remappedLocalTypes The local variable types after remapping. The format of this array is the same as in `MethodVisitor#visitFrame`, except that long and double types use two slots.

remappedVariableIndices	back to summary
private int[] remappedVariableIndices The mapping from old to new local variable indices. A local variable at index i of size 1 is remapped to 'mapping[2i]', while a local variable at index i of size 2 is remapped to 'mapping[2i+1]'.

LocalVariablesSorter	back to summary
public LocalVariablesSorter(final int access, final String descriptor, final MethodVisitor methodVisitor) Constructs a new `LocalVariablesSorter`. Subclasses must not use this constructor. Instead, they must use the `LocalVariablesSorter(int, int, String, MethodVisitor)` version. Parameters access:int access flags of the adapted method. descriptor:String the method's descriptor (see `Type`). methodVisitor:MethodVisitor the method visitor to which this adapter delegates calls. Exceptions IllegalStateException: if a subclass calls this constructor.

LocalVariablesSorter	back to summary
protected LocalVariablesSorter(final int api, final int access, final String descriptor, final MethodVisitor methodVisitor) Constructs a new `LocalVariablesSorter`. Parameters api:int the ASM API version implemented by this visitor. Must be one of the `ASM`x values in `Opcodes`. access:int access flags of the adapted method. descriptor:String the method's descriptor (see `Type`). methodVisitor:MethodVisitor the method visitor to which this adapter delegates calls.

Method Detail

newLocal	back to summary
public int newLocal(final Type type) Constructs a new local variable of the given type. Parameters type:Type the type of the local variable to be created. Returns:int the identifier of the newly created local variable.

newLocal

back to summary

public int newLocal(final Type type)

Constructs a new local variable of the given type.

Parameters

type:Type: the type of the local variable to be created.

Returns:int

the identifier of the newly created local variable.

newLocalMapping	back to summary
protected int newLocalMapping(final Type type)

remap	back to summary
private int remap(final int varIndex, final Type type)

setFrameLocal	back to summary
private void setFrameLocal(final int local, final Object type)

setLocalType back to summary

setLocalType	back to summary
protected void setLocalType(final int local, final Type type) Notifies subclasses that a local variable has been added or remapped. The default implementation of this method does nothing. Parameters local:int a local variable identifier, as returned by `newLocal`. type:Type the type of the value being stored in the local variable.

protected void setLocalType(final int local, final Type type)

Notifies subclasses that a local variable has been added or remapped. The default implementation of this method does nothing.

Parameters

local:int: a local variable identifier, as returned by newLocal.
type:Type: the type of the value being stored in the local variable.

updateNewLocals back to summary

updateNewLocals	back to summary
protected void updateNewLocals(final Object[] newLocals) Notifies subclasses that a new stack map frame is being visited. The array argument contains the stack map frame types corresponding to the local variables added with `newLocal`. This method can update these types in place for the stack map frame being visited. The default implementation of this method does nothing, i.e. a local variable added with `newLocal` will have the same type in all stack map frames. But this behavior is not always the desired one, for instance if a local variable is added in the middle of a try/catch block: the frame for the exception handler should have a TOP type for this new local. Parameters newLocals:Object[] the stack map frame types corresponding to the local variables added with `newLocal` (and null for the others). The format of this array is the same as in `MethodVisitor#visitFrame`, except that long and double types use two slots. The types for the current stack map frame must be updated in place in this array.

protected void updateNewLocals(final Object[] newLocals)

Notifies subclasses that a new stack map frame is being visited. The array argument contains the stack map frame types corresponding to the local variables added with newLocal. This method can update these types in place for the stack map frame being visited. The default implementation of this method does nothing, i.e. a local variable added with newLocal will have the same type in all stack map frames. But this behavior is not always the desired one, for instance if a local variable is added in the middle of a try/catch block: the frame for the exception handler should have a TOP type for this new local.

Parameters

newLocals:Object[]: the stack map frame types corresponding to the local variables added with newLocal (and null for the others). The format of this array is the same as in MethodVisitor#visitFrame, except that long and double types use two slots. The types for the current stack map frame must be updated in place in this array.

visitFrame back to summary

visitFrame	back to summary
public void visitFrame(final int type, final int numLocal, final Object[] local, final int numStack, final Object[] stack) Overrides org.objectweb.asm.MethodVisitor.visitFrame. Doc from org.objectweb.asm.MethodVisitor.visitFrame. Visits the current state of the local variables and operand stack elements. This method must() be called just before* any instruction i that follows an unconditional branch instruction such as GOTO or THROW, that is the target of a jump instruction, or that starts an exception handler block. The visited types must describe the values of the local variables and of the operand stack elements just before i is executed. (*) this is mandatory only for classes whose version is greater than or equal to `Opcodes#V1_6`. The frames of a method must be given either in expanded form, or in compressed form (all frames must use the same format, i.e. you must not mix expanded and compressed frames within a single method): In expanded form, all frames must have the F_NEW type. In compressed form, frames are basically "deltas" from the state of the previous frame: `Opcodes#F_SAME` representing frame with exactly the same locals as the previous frame and with the empty stack. `Opcodes#F_SAME1` representing frame with exactly the same locals as the previous frame and with single value on the stack ( `numStack` is 1 and `stack[0]` contains value for the type of the stack item). `Opcodes#F_APPEND` representing frame with current locals are the same as the locals in the previous frame, except that additional locals are defined (`numLocal` is 1, 2 or 3 and `local` elements contains values representing added types). `Opcodes#F_CHOP` representing frame with current locals are the same as the locals in the previous frame, except that the last 1-3 locals are absent and with the empty stack (`numLocal` is 1, 2 or 3). `Opcodes#F_FULL` representing complete frame data. In both cases the first frame, corresponding to the method's parameters and access flags, is implicit and must not be visited. Also, it is illegal to visit two or more frames for the same code location (i.e., at least one instruction must be visited between two calls to visitFrame). Parameters type:int the type of this stack map frame. Must be `Opcodes#F_NEW` for expanded frames, or `Opcodes#F_FULL`, `Opcodes#F_APPEND`, `Opcodes#F_CHOP`, `Opcodes#F_SAME` or `Opcodes#F_APPEND`, `Opcodes#F_SAME1` for compressed frames. numLocal:int the number of local variables in the visited frame. Long and double values count for one variable. local:Object[] the local variable types in this frame. This array must not be modified. Primitive types are represented by `Opcodes#TOP`, `Opcodes#INTEGER`, `Opcodes#FLOAT`, `Opcodes#LONG`, `Opcodes#DOUBLE`, `Opcodes#NULL` or `Opcodes#UNINITIALIZED_THIS` (long and double are represented by a single element). Reference types are represented by String objects (representing internal names, see `Type#getInternalName()`), and uninitialized types by Label objects (this label designates the NEW instruction that created this uninitialized value). numStack:int the number of operand stack elements in the visited frame. Long and double values count for one stack element. stack:Object[] the operand stack types in this frame. This array must not be modified. Its content has the same format as the "local" array. Annotations @Override

public void visitFrame(final int type, final int numLocal, final Object[] local, final int numStack, final Object[] stack)

Overrides org.objectweb.asm.MethodVisitor.visitFrame.

Doc from org.objectweb.asm.MethodVisitor.visitFrame.

Visits the current state of the local variables and operand stack elements. This method must(*) be called just before any instruction i that follows an unconditional branch instruction such as GOTO or THROW, that is the target of a jump instruction, or that starts an exception handler block. The visited types must describe the values of the local variables and of the operand stack elements just before i is executed.

(*) this is mandatory only for classes whose version is greater than or equal to Opcodes#V1_6.

The frames of a method must be given either in expanded form, or in compressed form (all frames must use the same format, i.e. you must not mix expanded and compressed frames within a single method):

In expanded form, all frames must have the F_NEW type.
In compressed form, frames are basically "deltas" from the state of the previous frame:
- Opcodes#F_SAME representing frame with exactly the same locals as the previous frame and with the empty stack.
- Opcodes#F_SAME1 representing frame with exactly the same locals as the previous frame and with single value on the stack ( numStack is 1 and stack[0] contains value for the type of the stack item).
- Opcodes#F_APPEND representing frame with current locals are the same as the locals in the previous frame, except that additional locals are defined (numLocal is 1, 2 or 3 and local elements contains values representing added types).
- Opcodes#F_CHOP representing frame with current locals are the same as the locals in the previous frame, except that the last 1-3 locals are absent and with the empty stack (numLocal is 1, 2 or 3).
- Opcodes#F_FULL representing complete frame data.

In both cases the first frame, corresponding to the method's parameters and access flags, is implicit and must not be visited. Also, it is illegal to visit two or more frames for the same code location (i.e., at least one instruction must be visited between two calls to visitFrame).

Parameters

type:int: the type of this stack map frame. Must be Opcodes#F_NEW for expanded frames, or Opcodes#F_FULL, Opcodes#F_APPEND, Opcodes#F_CHOP, Opcodes#F_SAME or Opcodes#F_APPEND, Opcodes#F_SAME1 for compressed frames.
numLocal:int: the number of local variables in the visited frame. Long and double values count for one variable.
local:Object[]: the local variable types in this frame. This array must not be modified. Primitive types are represented by Opcodes#TOP, Opcodes#INTEGER, Opcodes#FLOAT, Opcodes#LONG, Opcodes#DOUBLE, Opcodes#NULL or Opcodes#UNINITIALIZED_THIS (long and double are represented by a single element). Reference types are represented by String objects (representing internal names, see Type#getInternalName()), and uninitialized types by Label objects (this label designates the NEW instruction that created this uninitialized value).
numStack:int: the number of operand stack elements in the visited frame. Long and double values count for one stack element.
stack:Object[]: the operand stack types in this frame. This array must not be modified. Its content has the same format as the "local" array.

Annotations

@Override

visitIincInsn	back to summary
public void visitIincInsn(final int varIndex, final int increment) Overrides org.objectweb.asm.MethodVisitor.visitIincInsn. Doc from org.objectweb.asm.MethodVisitor.visitIincInsn. Visits an IINC instruction. Parameters varIndex:int index of the local variable to be incremented. increment:int amount to increment the local variable by. Annotations @Override

visitIincInsn

back to summary

public void visitIincInsn(final int varIndex, final int increment)

Overrides org.objectweb.asm.MethodVisitor.visitIincInsn.

Doc from org.objectweb.asm.MethodVisitor.visitIincInsn.

Visits an IINC instruction.

Parameters

varIndex:int: index of the local variable to be incremented.
increment:int: amount to increment the local variable by.

Annotations

@Override

visitLocalVariable	back to summary
public void visitLocalVariable(final String name, final String descriptor, final String signature, final Label start, final Label end, final int index) Overrides org.objectweb.asm.MethodVisitor.visitLocalVariable. Doc from org.objectweb.asm.MethodVisitor.visitLocalVariable. Visits a local variable declaration. Parameters name:String the name of a local variable. descriptor:String the type descriptor of this local variable. signature:String the type signature of this local variable. May be null if the local variable type does not use generic types. start:Label the first instruction corresponding to the scope of this local variable (inclusive). end:Label the last instruction corresponding to the scope of this local variable (exclusive). index:int the local variable's index. Annotations @Override

visitLocalVariable

back to summary

public void visitLocalVariable(final String name, final String descriptor, final String signature, final Label start, final Label end, final int index)

Overrides org.objectweb.asm.MethodVisitor.visitLocalVariable.

Doc from org.objectweb.asm.MethodVisitor.visitLocalVariable.

Visits a local variable declaration.

Parameters

name:String: the name of a local variable.
descriptor:String: the type descriptor of this local variable.
signature:String: the type signature of this local variable. May be null if the local variable type does not use generic types.
start:Label: the first instruction corresponding to the scope of this local variable (inclusive).
end:Label: the last instruction corresponding to the scope of this local variable (exclusive).
index:int: the local variable's index.

Annotations

@Override

visitLocalVariableAnnotation back to summary

visitLocalVariableAnnotation	back to summary
public AnnotationVisitor visitLocalVariableAnnotation(final int typeRef, final TypePath typePath, final Label[] start, final Label[] end, final int[] index, final String descriptor, final boolean visible) Overrides org.objectweb.asm.MethodVisitor.visitLocalVariableAnnotation. Doc from org.objectweb.asm.MethodVisitor.visitLocalVariableAnnotation. Visits an annotation on a local variable type. Parameters typeRef:int a reference to the annotated type. The sort of this type reference must be `TypeReference#LOCAL_VARIABLE` or `TypeReference#RESOURCE_VARIABLE`. See `TypeReference`. typePath:TypePath the path to the annotated type argument, wildcard bound, array element type, or static inner type within 'typeRef'. May be null if the annotation targets 'typeRef' as a whole. start:Label[] the fist instructions corresponding to the continuous ranges that make the scope of this local variable (inclusive). end:Label[] the last instructions corresponding to the continuous ranges that make the scope of this local variable (exclusive). This array must have the same size as the 'start' array. index:int[] the local variable's index in each range. This array must have the same size as the 'start' array. descriptor:String the class descriptor of the annotation class. visible:boolean true if the annotation is visible at runtime. Returns:AnnotationVisitor a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation. Annotations @Override

public AnnotationVisitor visitLocalVariableAnnotation(final int typeRef, final TypePath typePath, final Label[] start, final Label[] end, final int[] index, final String descriptor, final boolean visible)

Overrides org.objectweb.asm.MethodVisitor.visitLocalVariableAnnotation.

Doc from org.objectweb.asm.MethodVisitor.visitLocalVariableAnnotation.

Visits an annotation on a local variable type.

Parameters

typeRef:int: a reference to the annotated type. The sort of this type reference must be TypeReference#LOCAL_VARIABLE or TypeReference#RESOURCE_VARIABLE. See TypeReference.
typePath:TypePath: the path to the annotated type argument, wildcard bound, array element type, or static inner type within 'typeRef'. May be null if the annotation targets 'typeRef' as a whole.
start:Label[]: the fist instructions corresponding to the continuous ranges that make the scope of this local variable (inclusive).
end:Label[]: the last instructions corresponding to the continuous ranges that make the scope of this local variable (exclusive). This array must have the same size as the 'start' array.
index:int[]: the local variable's index in each range. This array must have the same size as the 'start' array.
descriptor:String: the class descriptor of the annotation class.
visible:boolean: true if the annotation is visible at runtime.

Returns:AnnotationVisitor

a visitor to visit the annotation values, or null if this visitor is not interested in visiting this annotation.

Annotations

@Override

visitMaxs	back to summary
public void visitMaxs(final int maxStack, final int maxLocals) Overrides org.objectweb.asm.MethodVisitor.visitMaxs. Doc from org.objectweb.asm.MethodVisitor.visitMaxs. Visits the maximum stack size and the maximum number of local variables of the method. Parameters maxStack:int maximum stack size of the method. maxLocals:int maximum number of local variables for the method. Annotations @Override

visitMaxs

back to summary

public void visitMaxs(final int maxStack, final int maxLocals)

Overrides org.objectweb.asm.MethodVisitor.visitMaxs.

Doc from org.objectweb.asm.MethodVisitor.visitMaxs.

Visits the maximum stack size and the maximum number of local variables of the method.

Parameters

maxStack:int: maximum stack size of the method.
maxLocals:int: maximum number of local variables for the method.

Annotations

@Override

visitVarInsn	back to summary
public void visitVarInsn(final int opcode, final int varIndex) Overrides org.objectweb.asm.MethodVisitor.visitVarInsn. Doc from org.objectweb.asm.MethodVisitor.visitVarInsn. Visits a local variable instruction. A local variable instruction is an instruction that loads or stores the value of a local variable. Parameters opcode:int the opcode of the local variable instruction to be visited. This opcode is either ILOAD, LLOAD, FLOAD, DLOAD, ALOAD, ISTORE, LSTORE, FSTORE, DSTORE, ASTORE or RET. varIndex:int the operand of the instruction to be visited. This operand is the index of a local variable. Annotations @Override

visitVarInsn

back to summary

public void visitVarInsn(final int opcode, final int varIndex)

Overrides org.objectweb.asm.MethodVisitor.visitVarInsn.

Doc from org.objectweb.asm.MethodVisitor.visitVarInsn.

Visits a local variable instruction. A local variable instruction is an instruction that loads or stores the value of a local variable.

Parameters

opcode:int: the opcode of the local variable instruction to be visited. This opcode is either ILOAD, LLOAD, FLOAD, DLOAD, ALOAD, ISTORE, LSTORE, FSTORE, DSTORE, ASTORE or RET.
varIndex:int: the operand of the instruction to be visited. This operand is the index of a local variable.

Annotations

@Override

public Class LocalVariablesSorter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail