org.codehaus.groovy.classgen

public Class FinalVariableAnalyzer

Class Inheritance

java.lang.Object
org.codehaus.groovy.ast.CodeVisitorSupport
org.codehaus.groovy.ast.ClassCodeVisitorSupport
org.codehaus.groovy.classgen.FinalVariableAnalyzer

Imports

org.codehaus.groovy.ast.ClassCodeVisitorSupport, .Parameter, .Variable, org.codehaus.groovy.ast.expr.ArgumentListExpression, .BinaryExpression, .ClosureExpression, .DeclarationExpression, .EmptyExpression, .Expression, .PostfixExpression, .PrefixExpression, .TupleExpression, .VariableExpression, org.codehaus.groovy.ast.stmt.BlockStatement, .BreakStatement, .CaseStatement, .CatchStatement, .ContinueStatement, .EmptyStatement, .IfStatement, .ReturnStatement, .Statement, .SwitchStatement, .ThrowStatement, .TryCatchStatement, org.codehaus.groovy.control.SourceUnit, org.codehaus.groovy.runtime.DefaultGroovyMethods, org.codehaus.groovy.transform.stc.StaticTypeCheckingSupport, java.lang.reflect.Modifier, java.util.ArrayList, .Deque, .HashMap, .HashSet, .Iterator, .LinkedList, .List, .Map, .Set

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	FinalVariableAnalyzer.StateMap
public static interface	FinalVariableAnalyzer.VariableNotFinalCallback
private static enum	FinalVariableAnalyzer.VariableState

Field Summary

Modifier and Type	Field and Description
private final Deque<Map<Variable, FinalVariableAnalyzer.VariableState>>	assignmentTracker
private final FinalVariableAnalyzer.VariableNotFinalCallback	callback
private Set<Variable>	declaredFinalVariables
private boolean	inArgumentList
private boolean	inAssignmentRHS
private final SourceUnit	sourceUnit

Constructor Summary

Access	Constructor and Description
public	FinalVariableAnalyzer(final SourceUnit sourceUnit)
public	FinalVariableAnalyzer(final SourceUnit sourceUnit, final FinalVariableAnalyzer.VariableNotFinalCallback callback)

Method Summary

Modifier and Type	Method and Description
private void	checkPrePostfixOperation(final Expression variable, final Expression originalExpression)
private void	cleanLocalVars(Map<Variable, FinalVariableAnalyzer.VariableState> origState, Map<Variable, FinalVariableAnalyzer.VariableState> state)
private boolean	Returns: true if the block falls through, i.e. no break/return fallsThrough(Statement statement)
private void	fixVar(Variable var)
protected SourceUnit	getSourceUnit() Implements abstract org.codehaus.groovy.ast.ClassCodeVisitorSupport.getSourceUnit.
private Map<Variable, FinalVariableAnalyzer.VariableState>	getState()
private static Variable	getTarget(Variable v)
public boolean	isEffectivelyFinal(Variable v)
private Map<Variable, FinalVariableAnalyzer.VariableState>	popState()
private Map<Variable, FinalVariableAnalyzer.VariableState>	pushState()
private void	recordAssignment(Variable var, boolean isDeclaration, boolean uninitialized, boolean forceVariable, Expression expression)
private void	recordAssignments(BinaryExpression expression, boolean isDeclaration, Expression leftExpression, Expression rightExpression)
private void	recordFinalVars(Expression leftExpression)
private boolean	Returns: true if the block's last statement is a return or throw returningBlock(Statement block)
public void	visitArgumentlistExpression(ArgumentListExpression ale) Overrides org.codehaus.groovy.ast.CodeVisitorSupport.visitArgumentlistExpression. Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitArgumentlistExpression.
public void	visitBinaryExpression(final BinaryExpression expression) Overrides org.codehaus.groovy.ast.CodeVisitorSupport.visitBinaryExpression. Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitBinaryExpression.
public void	visitBlockStatement(final BlockStatement block) Overrides org.codehaus.groovy.ast.ClassCodeVisitorSupport.visitBlockStatement. Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitBlockStatement.
private void	visitCatchFinally(Map<Variable, FinalVariableAnalyzer.VariableState> initialVarState, List<Map<Variable, FinalVariableAnalyzer.VariableState>> afterTryCatchStates, CatchStatement catchStatement, Statement finallyStatement)
public void	visitClosureExpression(final ClosureExpression expression) Overrides org.codehaus.groovy.ast.CodeVisitorSupport.visitClosureExpression. Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitClosureExpression.
public void	visitIfElse(final IfStatement ifElse) Overrides org.codehaus.groovy.ast.ClassCodeVisitorSupport.visitIfElse. Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitIfElse.
public void	visitPostfixExpression(final PostfixExpression expression) Overrides org.codehaus.groovy.ast.CodeVisitorSupport.visitPostfixExpression. Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitPostfixExpression.
public void	visitPrefixExpression(final PrefixExpression expression) Overrides org.codehaus.groovy.ast.CodeVisitorSupport.visitPrefixExpression. Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitPrefixExpression.
public void	visitSwitch(SwitchStatement switchS) Overrides org.codehaus.groovy.ast.ClassCodeVisitorSupport.visitSwitch. Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitSwitch.
public void	visitTryCatchFinally(final TryCatchStatement statement) Overrides org.codehaus.groovy.ast.ClassCodeVisitorSupport.visitTryCatchFinally. Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitTryCatchFinally.
public void	visitVariableExpression(final VariableExpression expression) Overrides org.codehaus.groovy.ast.CodeVisitorSupport.visitVariableExpression. Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitVariableExpression.

Field Detail

assignmentTracker	back to summary
private final Deque<Map<Variable, FinalVariableAnalyzer.VariableState>> assignmentTracker

callback	back to summary
private final FinalVariableAnalyzer.VariableNotFinalCallback callback

declaredFinalVariables	back to summary
private Set<Variable> declaredFinalVariables

inArgumentList	back to summary
private boolean inArgumentList

inAssignmentRHS	back to summary
private boolean inAssignmentRHS

sourceUnit	back to summary
private final SourceUnit sourceUnit

Constructor Detail

FinalVariableAnalyzer	back to summary
public FinalVariableAnalyzer(final SourceUnit sourceUnit)

FinalVariableAnalyzer	back to summary
public FinalVariableAnalyzer(final SourceUnit sourceUnit, final FinalVariableAnalyzer.VariableNotFinalCallback callback)

Method Detail

checkPrePostfixOperation	back to summary
private void checkPrePostfixOperation(final Expression variable, final Expression originalExpression)

cleanLocalVars	back to summary
private void cleanLocalVars(Map<Variable, FinalVariableAnalyzer.VariableState> origState, Map<Variable, FinalVariableAnalyzer.VariableState> state)

fallsThrough	back to summary
private boolean fallsThrough(Statement statement) Returns:boolean true if the block falls through, i.e. no break/return

fixVar	back to summary
private void fixVar(Variable var)

getSourceUnit	back to summary
protected SourceUnit getSourceUnit() Implements abstract org.codehaus.groovy.ast.ClassCodeVisitorSupport.getSourceUnit. Annotations @Override

getSourceUnit

back to summary

protected SourceUnit getSourceUnit()

Implements abstract org.codehaus.groovy.ast.ClassCodeVisitorSupport.getSourceUnit.

Annotations

@Override

getState	back to summary
private Map<Variable, FinalVariableAnalyzer.VariableState> getState()

getTarget	back to summary
private static Variable getTarget(Variable v)

isEffectivelyFinal	back to summary
public boolean isEffectivelyFinal(Variable v)

popState	back to summary
private Map<Variable, FinalVariableAnalyzer.VariableState> popState()

pushState	back to summary
private Map<Variable, FinalVariableAnalyzer.VariableState> pushState()

recordAssignment	back to summary
private void recordAssignment(Variable var, boolean isDeclaration, boolean uninitialized, boolean forceVariable, Expression expression)

recordAssignments	back to summary
private void recordAssignments(BinaryExpression expression, boolean isDeclaration, Expression leftExpression, Expression rightExpression)

recordFinalVars	back to summary
private void recordFinalVars(Expression leftExpression)

returningBlock	back to summary
private boolean returningBlock(Statement block) Returns:boolean true if the block's last statement is a return or throw

visitArgumentlistExpression	back to summary
public void visitArgumentlistExpression(ArgumentListExpression ale) Overrides org.codehaus.groovy.ast.CodeVisitorSupport.visitArgumentlistExpression. Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitArgumentlistExpression. Annotations @Override

visitArgumentlistExpression

back to summary

public void visitArgumentlistExpression(ArgumentListExpression ale)

Overrides org.codehaus.groovy.ast.CodeVisitorSupport.visitArgumentlistExpression.

Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitArgumentlistExpression.

Annotations

@Override

visitBinaryExpression	back to summary
public void visitBinaryExpression(final BinaryExpression expression) Overrides org.codehaus.groovy.ast.CodeVisitorSupport.visitBinaryExpression. Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitBinaryExpression. Annotations @Override

visitBinaryExpression

back to summary

public void visitBinaryExpression(final BinaryExpression expression)

Overrides org.codehaus.groovy.ast.CodeVisitorSupport.visitBinaryExpression.

Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitBinaryExpression.

Annotations

@Override

visitBlockStatement	back to summary
public void visitBlockStatement(final BlockStatement block) Overrides org.codehaus.groovy.ast.ClassCodeVisitorSupport.visitBlockStatement. Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitBlockStatement. Annotations @Override

visitBlockStatement

back to summary

public void visitBlockStatement(final BlockStatement block)

Overrides org.codehaus.groovy.ast.ClassCodeVisitorSupport.visitBlockStatement.

Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitBlockStatement.

Annotations

@Override

visitCatchFinally	back to summary
private void visitCatchFinally(Map<Variable, FinalVariableAnalyzer.VariableState> initialVarState, List<Map<Variable, FinalVariableAnalyzer.VariableState>> afterTryCatchStates, CatchStatement catchStatement, Statement finallyStatement)

visitClosureExpression	back to summary
public void visitClosureExpression(final ClosureExpression expression) Overrides org.codehaus.groovy.ast.CodeVisitorSupport.visitClosureExpression. Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitClosureExpression. Annotations @Override

visitClosureExpression

back to summary

public void visitClosureExpression(final ClosureExpression expression)

Overrides org.codehaus.groovy.ast.CodeVisitorSupport.visitClosureExpression.

Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitClosureExpression.

Annotations

@Override

visitIfElse	back to summary
public void visitIfElse(final IfStatement ifElse) Overrides org.codehaus.groovy.ast.ClassCodeVisitorSupport.visitIfElse. Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitIfElse. Annotations @Override

visitIfElse

back to summary

public void visitIfElse(final IfStatement ifElse)

Overrides org.codehaus.groovy.ast.ClassCodeVisitorSupport.visitIfElse.

Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitIfElse.

Annotations

@Override

visitPostfixExpression	back to summary
public void visitPostfixExpression(final PostfixExpression expression) Overrides org.codehaus.groovy.ast.CodeVisitorSupport.visitPostfixExpression. Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitPostfixExpression. Annotations @Override

visitPostfixExpression

back to summary

public void visitPostfixExpression(final PostfixExpression expression)

Overrides org.codehaus.groovy.ast.CodeVisitorSupport.visitPostfixExpression.

Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitPostfixExpression.

Annotations

@Override

visitPrefixExpression	back to summary
public void visitPrefixExpression(final PrefixExpression expression) Overrides org.codehaus.groovy.ast.CodeVisitorSupport.visitPrefixExpression. Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitPrefixExpression. Annotations @Override

visitPrefixExpression

back to summary

public void visitPrefixExpression(final PrefixExpression expression)

Overrides org.codehaus.groovy.ast.CodeVisitorSupport.visitPrefixExpression.

Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitPrefixExpression.

Annotations

@Override

visitSwitch	back to summary
public void visitSwitch(SwitchStatement switchS) Overrides org.codehaus.groovy.ast.ClassCodeVisitorSupport.visitSwitch. Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitSwitch. Annotations @Override

visitSwitch

back to summary

public void visitSwitch(SwitchStatement switchS)

Overrides org.codehaus.groovy.ast.ClassCodeVisitorSupport.visitSwitch.

Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitSwitch.

Annotations

@Override

visitTryCatchFinally	back to summary
public void visitTryCatchFinally(final TryCatchStatement statement) Overrides org.codehaus.groovy.ast.ClassCodeVisitorSupport.visitTryCatchFinally. Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitTryCatchFinally. Annotations @Override

visitTryCatchFinally

back to summary

public void visitTryCatchFinally(final TryCatchStatement statement)

Overrides org.codehaus.groovy.ast.ClassCodeVisitorSupport.visitTryCatchFinally.

Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitTryCatchFinally.

Annotations

@Override

visitVariableExpression	back to summary
public void visitVariableExpression(final VariableExpression expression) Overrides org.codehaus.groovy.ast.CodeVisitorSupport.visitVariableExpression. Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitVariableExpression. Annotations @Override

visitVariableExpression

back to summary

public void visitVariableExpression(final VariableExpression expression)

Overrides org.codehaus.groovy.ast.CodeVisitorSupport.visitVariableExpression.

Implements org.codehaus.groovy.ast.GroovyCodeVisitor.visitVariableExpression.

Annotations

@Override

org.codehaus.groovy.classgen back to summary

private Class FinalVariableAnalyzer.StateMap

Class Inheritance

extends HashMap<Variable, FinalVariableAnalyzer.VariableState>

java.lang.Object
java.util.AbstractMap
java.util.HashMap
org.codehaus.groovy.classgen.FinalVariableAnalyzer.StateMap

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides java.util.HashMap.serialVersionUID.

Constructor Summary

Access	Constructor and Description
private	StateMap()

Method Summary

Modifier and Type	Method and Description
public FinalVariableAnalyzer.VariableState	get(final Object the key whose associated value is to be returned key) Overrides java.util.HashMap.get. Implements java.util.Map.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key.
public FinalVariableAnalyzer.VariableState	put(final Variable key with which the specified value is to be associated key, final FinalVariableAnalyzer.VariableState value to be associated with the specified key value) Overrides java.util.HashMap.put. Implements java.util.Map.put. Associates the specified value with the specified key in this map.

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides java.util.HashMap.serialVersionUID.

Constructor Detail

StateMap	back to summary
private StateMap()

Method Detail

get back to summary

get	back to summary
public FinalVariableAnalyzer.VariableState get(final Object key) Overrides java.util.HashMap.get. Implements java.util.Map.get. Doc from java.util.HashMap.get. Returns the value to which the specified key is mapped, or `null` if this map contains no mapping for the key. More formally, if this map contains a mapping from a key `k` to a value `v` such that `(key==null ? k==null : key.equals(k))`, then this method returns `v`; otherwise it returns `null`. (There can be at most one such mapping.) A return value of `null` does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to `null`. The `containsKey` operation may be used to distinguish these two cases. Parameters key:Object Doc from java.util.Map.get. the key whose associated value is to be returned Returns:FinalVariableAnalyzer.VariableState Doc from java.util.Map.get. the value to which the specified key is mapped, or `null` if this map contains no mapping for the key Annotations @Override

public FinalVariableAnalyzer.VariableState get(final Object key)

Overrides java.util.HashMap.get.

Implements java.util.Map.get.

Doc from java.util.HashMap.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that (key==null ? k==null : key.equals(k)), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

A return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Parameters

key:Object

Doc from java.util.Map.get.

the key whose associated value is to be returned

Returns:FinalVariableAnalyzer.VariableState

Doc from java.util.Map.get.

the value to which the specified key is mapped, or null if this map contains no mapping for the key

Annotations

@Override

put back to summary

put	back to summary
public FinalVariableAnalyzer.VariableState put(final Variable key, final FinalVariableAnalyzer.VariableState value) Overrides java.util.HashMap.put. Implements java.util.Map.put. Doc from java.util.HashMap.put. Associates the specified value with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced. Parameters key:Variable key with which the specified value is to be associated value:FinalVariableAnalyzer.VariableState value to be associated with the specified key Returns:FinalVariableAnalyzer.VariableState the previous value associated with `key`, or `null` if there was no mapping for `key`. (A `null` return can also indicate that the map previously associated `null` with `key`.) Annotations @Override

public FinalVariableAnalyzer.VariableState put(final Variable key, final FinalVariableAnalyzer.VariableState value)

Overrides java.util.HashMap.put.

Implements java.util.Map.put.

Doc from java.util.HashMap.put.

Associates the specified value with the specified key in this map. If the map previously contained a mapping for the key, the old value is replaced.

Parameters

key:Variable: key with which the specified value is to be associated
value:FinalVariableAnalyzer.VariableState: value to be associated with the specified key

Returns:FinalVariableAnalyzer.VariableState

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key.)

Annotations

@Override

org.codehaus.groovy.classgen back to summary

public Interface FinalVariableAnalyzer.VariableNotFinalCallback

Method Summary

Modifier and Type	Method and Description
public void	variableNotAlwaysInitialized(VariableExpression the variable detected as potentially uninitialized var) Callback used whenever a variable is declared as final, but can remain in an uninitialized state
public void	variableNotFinal(Variable the variable detected as not final var, Expression the expression responsible for the contract to be broken bexp) Callback called whenever an assignment transforms an effectively final variable into a non final variable (aka, breaks the "final" modifier contract)

Method Detail

variableNotAlwaysInitialized	back to summary
public void variableNotAlwaysInitialized(VariableExpression var) Callback used whenever a variable is declared as final, but can remain in an uninitialized state Parameters var:VariableExpression the variable detected as potentially uninitialized

variableNotAlwaysInitialized

back to summary

public void variableNotAlwaysInitialized(VariableExpression var)

Callback used whenever a variable is declared as final, but can remain in an uninitialized state

Parameters

var:VariableExpression: the variable detected as potentially uninitialized

variableNotFinal	back to summary
public void variableNotFinal(Variable var, Expression bexp) Callback called whenever an assignment transforms an effectively final variable into a non final variable (aka, breaks the "final" modifier contract) Parameters var:Variable the variable detected as not final bexp:Expression the expression responsible for the contract to be broken

variableNotFinal

back to summary

public void variableNotFinal(Variable var, Expression bexp)

Callback called whenever an assignment transforms an effectively final variable into a non final variable (aka, breaks the "final" modifier contract)

Parameters

var:Variable: the variable detected as not final
bexp:Expression: the expression responsible for the contract to be broken

org.codehaus.groovy.classgen back to summary

private final Enum FinalVariableAnalyzer.VariableState

Class Inheritance

extends Enum<FinalVariableAnalyzer.VariableState>

java.lang.Object
java.lang.Enum
org.codehaus.groovy.classgen.FinalVariableAnalyzer.VariableState

Field Summary

Modifier and Type	Field and Description
public static final FinalVariableAnalyzer.VariableState	is_ambiguous
public static final FinalVariableAnalyzer.VariableState	is_final
public static final FinalVariableAnalyzer.VariableState	is_uninitialized
public static final FinalVariableAnalyzer.VariableState	is_var
private final boolean	isFinal

Constructor Summary

Access	Constructor and Description
private	VariableState(final boolean isFinal)

Method Summary

Modifier and Type	Method and Description
public FinalVariableAnalyzer.VariableState	getNext()
public boolean	isFinal()
public static FinalVariableAnalyzer.VariableState	valueOf(String name)
public static FinalVariableAnalyzer.VariableState[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

is_ambiguous	back to summary
public static final FinalVariableAnalyzer.VariableState is_ambiguous

is_final	back to summary
public static final FinalVariableAnalyzer.VariableState is_final

is_uninitialized	back to summary
public static final FinalVariableAnalyzer.VariableState is_uninitialized

is_var	back to summary
public static final FinalVariableAnalyzer.VariableState is_var

isFinal	back to summary
private final boolean isFinal

Constructor Detail

VariableState	back to summary
private VariableState(final boolean isFinal)

Method Detail

getNext	back to summary
public FinalVariableAnalyzer.VariableState getNext()

isFinal	back to summary
public boolean isFinal()

valueOf	back to summary
public static FinalVariableAnalyzer.VariableState valueOf(String name)

values	back to summary
public static FinalVariableAnalyzer.VariableState[] values()