Apache Groovy 3.0.20 · org.codehaus.groovy.classgen.asm.CompileStack

Modifier and Type	Class and Description
public static class	CompileStack.BlockRecorder
private static class	CompileStack.ExceptionTableEntry
protected static class	CompileStack.LabelRange
private class	CompileStack.StateStackElement

Field Summary

Modifier and Type	Field and Description
private Label	breakLabel current label for break
private String	className
private boolean	clear state flag
private Label	continueLabel current label for continue
private final WriterController	controller
private Map<String, Label>	currentBlockNamedLabels map containing named labels of current block
private int	currentVariableIndex index of the last variable on stack
private LinkedList<CompileStack.BlockRecorder>	finallyBlocks list containing finally blocks such a block is created by synchronized or finally and must be called for break/continue/return
private boolean	implicitThis stores if implicit or explicit this is used.
private final Deque<Boolean>	implicitThisStack handle different states for the implicit "this"
private boolean	inSpecialConstructorCall
private boolean	lhs stores if on left-hand-side during compilation
private final Deque<Boolean>	lhsStack handle different states for being on the left hand side
private int	localVariableOffset first variable index usable after all parameters of a method
private final Map<String, Label>	namedLoopBreakLabel goals for a "break foo" call in a loop where foo is a label.
private final Map<String, Label>	namedLoopContinueLabel goals for a "continue foo" call in a loop where foo is a label.
private int	nextVariableIndex index for the next variable on stack
private VariableScope	scope current scope
private Map<String, BytecodeVariable>	stackVariables available variables on stack
private final Deque<CompileStack.StateStackElement>	stateStack helper to handle different stack based variables
private Map<String, Label>	superBlockNamedLabels map containing named labels of parenting blocks
private final Deque<BytecodeVariable>	temporaryVariables currently temporary variables in use
private Label	thisEndLabel
private Label	thisStartLabel
private final Deque<CompileStack.ExceptionTableEntry>	typedExceptions
private final Deque<CompileStack.ExceptionTableEntry>	untypedExceptions
private final Deque<BytecodeVariable>	usedVariables overall used variables for a method/constructor
private final List<CompileStack.BlockRecorder>	visitedBlocks

Constructor Summary

Access	Constructor and Description
public	CompileStack(final WriterController controller)

Method Summary

Modifier and Type	Method and Description
public void	addExceptionBlock(final Label start, final Label end, final Label goal, final String sig)
private void	applyBlockRecorder(final Collection<CompileStack.BlockRecorder> blockRecorders)
public void	applyBlockRecorder()
public void	applyFinallyBlocks(final Label label, final boolean isBreakLabel)
public void	clear() Clears the state of the class.
public boolean	Returns: true if a variable is already defined containsVariable(final String the name of the variable of interest name)
public Label	createLocalLabel(final String name) creates a new named label
private void	createReference(final BytecodeVariable reference)
private void	defineMethodVariables(final Parameter[] params, final boolean isInStaticContext)
public int	Returns: the index used for this temporary variable defineTemporaryVariable(final Variable defines type and name var, final boolean defines if the toplevel argument of the stack should be stored store) creates a temporary variable.
public int	Returns: the index used for this temporary variable defineTemporaryVariable(final String defines type and name name, final boolean defines if the top-level argument of the stack should be stored store) creates a temporary variable.
public int	Returns: the index used for this temporary variable defineTemporaryVariable(final String defines the name name, final ClassNode defines the node node, final boolean defines if the top-level argument of the stack should be stored store) creates a temporary variable.
private BytecodeVariable	defineVar(final String name, final ClassNode type, final boolean holder, final boolean useReferenceDirectly)
public BytecodeVariable	defineVariable(final Variable v, final boolean if true the last element of the stack will be used to initialize the new variable. If false null will be used. initFromStack) Defines a new Variable using an AST variable.
public BytecodeVariable	defineVariable(final Variable v, final ClassNode variableType, final boolean initFromStack)
public Label	getBreakLabel()
public Label	getContinueLabel()
public Label	getLabel(final String name) Returns the label for the given name
public Label	getNamedBreakLabel(final String name) Used for `break foo` inside a loop to end the execution of the marked loop.
public Label	getNamedContinueLabel(final String name) Used for `continue foo` inside a loop to continue the execution of the marked loop.
public VariableScope	getScope()
public BytecodeVariable	getVariable(final String variableName)
public BytecodeVariable	Returns: the normal variable or null if not found (and `mustExist` not true) getVariable(final String name of the variable variableName, final boolean throw exception if variable does not exist mustExist) Returns a normal variable.
public boolean	hasBlockRecorder()
public void	init(final VariableScope scope, final Parameter[] parameters) initializes this class for a MethodNode.
private void	initLoopLabels(final String labelName)
public boolean	isImplicitThis()
public boolean	isInSpecialConstructorCall()
public boolean	isLHS()
private void	makeLocalVariablesOffset(final Parameter[] paras, final boolean isInStaticContext)
private void	makeNextVariableID(final ClassNode type, final boolean useReferenceDirectly) Calculates the index of the next free register stores it and sets the current variable index to the old value
public void	pop()
public void	popBlockRecorderVisit(final CompileStack.BlockRecorder finallyBlock)
public void	popImplicitThis()
public void	popLHS()
private void	popState()
public void	pushBlockRecorder(final CompileStack.BlockRecorder recorder)
public void	pushBlockRecorderVisit(final CompileStack.BlockRecorder finallyBlock)
public void	pushBooleanExpression() because a boolean Expression may not be evaluated completely it is important to keep the registers clean
public void	pushImplicitThis(final boolean implicitThis)
private static void	pushInitValue(final ClassNode type, final MethodVisitor mv)
public void	pushInSpecialConstructorCall()
public void	pushLHS(final boolean lhs)
public void	pushLoop(final VariableScope scope, final String labelName) Should be called when descending into a loop that defines also a scope.
public void	pushLoop(final VariableScope el, final List<String> labelNames) Should be called when descending into a loop that defines also a scope.
public void	pushLoop(final String labelName) Should be called when descending into a loop that does not define a scope.
public void	pushLoop(final List<String> labelNames) Should be called when descending into a loop that does not define a scope.
public void	pushState()
public Label	pushSwitch() Creates a new break label and a element for the state stack so pop has to be called later
public void	pushVariableScope(final VariableScope scope) Causes the state-stack to add an element and sets the given scope as new current variable scope.
public void	removeVar(final int tempIndex)
private void	resetVariableIndex(final boolean isStatic)
private void	setEndLabels()
public void	writeExceptionTable(final CompileStack.BlockRecorder block, final Label goal, final String sig)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

breakLabel	back to summary
private Label breakLabel current label for break

className	back to summary
private String className

clear	back to summary
private boolean clear state flag

continueLabel	back to summary
private Label continueLabel current label for continue

controller	back to summary
private final WriterController controller

currentBlockNamedLabels	back to summary
private Map<String, Label> currentBlockNamedLabels map containing named labels of current block

currentVariableIndex	back to summary
private int currentVariableIndex index of the last variable on stack

finallyBlocks	back to summary
private LinkedList<CompileStack.BlockRecorder> finallyBlocks list containing finally blocks such a block is created by synchronized or finally and must be called for break/continue/return

finallyBlocks

back to summary

private LinkedList<CompileStack.BlockRecorder> finallyBlocks

list containing finally blocks

such a block is created by synchronized or finally and must be called for break/continue/return

implicitThis	back to summary
private boolean implicitThis stores if implicit or explicit this is used.

implicitThisStack	back to summary
private final Deque<Boolean> implicitThisStack handle different states for the implicit "this"

inSpecialConstructorCall	back to summary
private boolean inSpecialConstructorCall

lhs	back to summary
private boolean lhs stores if on left-hand-side during compilation

lhsStack	back to summary
private final Deque<Boolean> lhsStack handle different states for being on the left hand side

localVariableOffset	back to summary
private int localVariableOffset first variable index usable after all parameters of a method

namedLoopBreakLabel	back to summary
private final Map<String, Label> namedLoopBreakLabel goals for a "break foo" call in a loop where foo is a label.

namedLoopContinueLabel	back to summary
private final Map<String, Label> namedLoopContinueLabel goals for a "continue foo" call in a loop where foo is a label.

nextVariableIndex	back to summary
private int nextVariableIndex index for the next variable on stack

scope	back to summary
private VariableScope scope current scope

stackVariables	back to summary
private Map<String, BytecodeVariable> stackVariables available variables on stack

stateStack	back to summary
private final Deque<CompileStack.StateStackElement> stateStack helper to handle different stack based variables

superBlockNamedLabels	back to summary
private Map<String, Label> superBlockNamedLabels map containing named labels of parenting blocks

temporaryVariables	back to summary
private final Deque<BytecodeVariable> temporaryVariables currently temporary variables in use

thisEndLabel	back to summary
private Label thisEndLabel

thisStartLabel	back to summary
private Label thisStartLabel

typedExceptions	back to summary
private final Deque<CompileStack.ExceptionTableEntry> typedExceptions

untypedExceptions	back to summary
private final Deque<CompileStack.ExceptionTableEntry> untypedExceptions

usedVariables	back to summary
private final Deque<BytecodeVariable> usedVariables overall used variables for a method/constructor

visitedBlocks	back to summary
private final List<CompileStack.BlockRecorder> visitedBlocks

Constructor Detail

CompileStack	back to summary
public CompileStack(final WriterController controller)

Method Detail

addExceptionBlock	back to summary
public void addExceptionBlock(final Label start, final Label end, final Label goal, final String sig)

applyBlockRecorder	back to summary
private void applyBlockRecorder(final Collection<CompileStack.BlockRecorder> blockRecorders)

applyBlockRecorder	back to summary
public void applyBlockRecorder()

applyFinallyBlocks	back to summary
public void applyFinallyBlocks(final Label label, final boolean isBreakLabel)

clear	back to summary
public void clear() Clears the state of the class. This method should be called after a MethodNode is visited. Note that a call to init will fail if clear is not called before

containsVariable	back to summary
public boolean containsVariable(final String name) Parameters name:String the name of the variable of interest Returns:boolean true if a variable is already defined

createLocalLabel	back to summary
public Label createLocalLabel(final String name) creates a new named label

createReference	back to summary
private void createReference(final BytecodeVariable reference)

defineMethodVariables	back to summary
private void defineMethodVariables(final Parameter[] params, final boolean isInStaticContext)

defineTemporaryVariable	back to summary
public int defineTemporaryVariable(final Variable var, final boolean store) creates a temporary variable. Parameters var:Variable defines type and name store:boolean defines if the toplevel argument of the stack should be stored Returns:int the index used for this temporary variable

defineTemporaryVariable

back to summary

public int defineTemporaryVariable(final Variable var, final boolean store)

creates a temporary variable.

Parameters

var:Variable: defines type and name
store:boolean: defines if the toplevel argument of the stack should be stored

Returns:int

the index used for this temporary variable

defineTemporaryVariable	back to summary
public int defineTemporaryVariable(final String name, final boolean store) creates a temporary variable. Parameters name:String defines type and name store:boolean defines if the top-level argument of the stack should be stored Returns:int the index used for this temporary variable

defineTemporaryVariable

back to summary

public int defineTemporaryVariable(final String name, final boolean store)

creates a temporary variable.

Parameters

name:String: defines type and name
store:boolean: defines if the top-level argument of the stack should be stored

Returns:int

the index used for this temporary variable

defineTemporaryVariable	back to summary
public int defineTemporaryVariable(final String name, final ClassNode node, final boolean store) creates a temporary variable. Parameters name:String defines the name node:ClassNode defines the node store:boolean defines if the top-level argument of the stack should be stored Returns:int the index used for this temporary variable

defineTemporaryVariable

back to summary

public int defineTemporaryVariable(final String name, final ClassNode node, final boolean store)

creates a temporary variable.

Parameters

name:String: defines the name
node:ClassNode: defines the node
store:boolean: defines if the top-level argument of the stack should be stored

Returns:int

the index used for this temporary variable

defineVar	back to summary
private BytecodeVariable defineVar(final String name, final ClassNode type, final boolean holder, final boolean useReferenceDirectly)

defineVariable	back to summary
public BytecodeVariable defineVariable(final Variable v, final boolean initFromStack) Defines a new Variable using an AST variable. Parameters initFromStack:boolean if true the last element of the stack will be used to initialize the new variable. If false null will be used.

defineVariable

back to summary

public BytecodeVariable defineVariable(final Variable v, final boolean initFromStack)

Defines a new Variable using an AST variable.

Parameters

initFromStack:boolean: if true the last element of the stack will be used to initialize the new variable. If false null will be used.

defineVariable	back to summary
public BytecodeVariable defineVariable(final Variable v, final ClassNode variableType, final boolean initFromStack)

getBreakLabel	back to summary
public Label getBreakLabel()

getContinueLabel	back to summary
public Label getContinueLabel()

getLabel	back to summary
public Label getLabel(final String name) Returns the label for the given name

getNamedBreakLabel	back to summary
public Label getNamedBreakLabel(final String name) Used for `break foo` inside a loop to end the execution of the marked loop. This method will return the break label of the loop if there is one found for the name. If not, the current break label is returned.

getNamedContinueLabel	back to summary
public Label getNamedContinueLabel(final String name) Used for `continue foo` inside a loop to continue the execution of the marked loop. This method will return the break label of the loop if there is one found for the name. If not, getLabel is used.

getScope	back to summary
public VariableScope getScope()

getVariable	back to summary
public BytecodeVariable getVariable(final String variableName)

getVariable back to summary

public BytecodeVariable getVariable(final String variableName, final boolean mustExist)

Returns a normal variable.

If mustExist is true and the normal variable doesn't exist, then this method will throw a GroovyBugError. It is not the intention of this method to let this happen! And the exception should not be used for flow control - it is just acting as an assertion. If the exception is thrown then it indicates a bug in the class using CompileStack. This method can also not be used to return a temporary variable. Temporary variables are not normal variables.

Parameters

variableName:String: name of the variable
mustExist:boolean: throw exception if variable does not exist

Returns:BytecodeVariable

the normal variable or null if not found (and mustExist not true)

hasBlockRecorder	back to summary
public boolean hasBlockRecorder()

init	back to summary
public void init(final VariableScope scope, final Parameter[] parameters) initializes this class for a MethodNode. This method will automatically define variables for the method parameters and will create references if needed. The created variables can be accessed by calling getVariable().

initLoopLabels	back to summary
private void initLoopLabels(final String labelName)

isImplicitThis	back to summary
public boolean isImplicitThis()

isInSpecialConstructorCall	back to summary
public boolean isInSpecialConstructorCall()

isLHS	back to summary
public boolean isLHS()

makeLocalVariablesOffset	back to summary
private void makeLocalVariablesOffset(final Parameter[] paras, final boolean isInStaticContext)

makeNextVariableID	back to summary
private void makeNextVariableID(final ClassNode type, final boolean useReferenceDirectly) Calculates the index of the next free register stores it and sets the current variable index to the old value

pop	back to summary
public void pop()

popBlockRecorderVisit	back to summary
public void popBlockRecorderVisit(final CompileStack.BlockRecorder finallyBlock)

popImplicitThis	back to summary
public void popImplicitThis()

popLHS	back to summary
public void popLHS()

popState	back to summary
private void popState()

pushBlockRecorder	back to summary
public void pushBlockRecorder(final CompileStack.BlockRecorder recorder)

pushBlockRecorderVisit	back to summary
public void pushBlockRecorderVisit(final CompileStack.BlockRecorder finallyBlock)

pushBooleanExpression	back to summary
public void pushBooleanExpression() because a boolean Expression may not be evaluated completely it is important to keep the registers clean

pushImplicitThis	back to summary
public void pushImplicitThis(final boolean implicitThis)

pushInitValue	back to summary
private static void pushInitValue(final ClassNode type, final MethodVisitor mv)

pushInSpecialConstructorCall	back to summary
public void pushInSpecialConstructorCall()

pushLHS	back to summary
public void pushLHS(final boolean lhs)

pushLoop	back to summary
public void pushLoop(final VariableScope scope, final String labelName) Should be called when descending into a loop that defines also a scope. Calls pushVariableScope and prepares labels for a loop structure. Creates a element for the state stack so pop has to be called later, TODO: @Deprecate

pushLoop	back to summary
public void pushLoop(final VariableScope el, final List<String> labelNames) Should be called when descending into a loop that defines also a scope. Calls pushVariableScope and prepares labels for a loop structure. Creates a element for the state stack so pop has to be called later

pushLoop	back to summary
public void pushLoop(final String labelName) Should be called when descending into a loop that does not define a scope. Creates a element for the state stack so pop has to be called later, TODO: @Deprecate

pushLoop	back to summary
public void pushLoop(final List<String> labelNames) Should be called when descending into a loop that does not define a scope. Creates a element for the state stack so pop has to be called later

pushState	back to summary
public void pushState()

pushSwitch	back to summary
public Label pushSwitch() Creates a new break label and a element for the state stack so pop has to be called later

pushVariableScope	back to summary
public void pushVariableScope(final VariableScope scope) Causes the state-stack to add an element and sets the given scope as new current variable scope. Creates a element for the state stack so pop has to be called later

removeVar	back to summary
public void removeVar(final int tempIndex)

resetVariableIndex	back to summary
private void resetVariableIndex(final boolean isStatic)

setEndLabels	back to summary
private void setEndLabels()

writeExceptionTable	back to summary
public void writeExceptionTable(final CompileStack.BlockRecorder block, final Label goal, final String sig)

Modifier and Type	Field and Description
public Runnable	excludedStatement
private boolean	isEmpty
public final LinkedList<CompileStack.LabelRange>	ranges

public Class CompileStack

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class CompileStack.BlockRecorder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class CompileStack.ExceptionTableEntry

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

protected Class CompileStack.LabelRange

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

private Class CompileStack.StateStackElement

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Access	Constructor and Description
public	BlockRecorder()
public	BlockRecorder(final Runnable excludedStatement)

Modifier and Type	Method and Description
public void	closeRange(final Label end)
public void	startRange(final Label start)

Modifier and Type	Field and Description
pack-priv Label	end
pack-priv Label	goal
pack-priv String	sig
pack-priv Label	start

Modifier and Type	Field and Description
pack-priv final Label	breakLabel
pack-priv final Label	continueLabel
pack-priv final Map<String, Label>	currentBlockNamedLabels
pack-priv final LinkedList<CompileStack.BlockRecorder>	finallyBlocks
pack-priv final boolean	inSpecialConstructorCall
pack-priv final VariableScope	scope
pack-priv final Map<String, BytecodeVariable>	stackVariables