org.checkerframework.framework.util

Class FlowExpressionParseUtil

java.lang.Object

org.checkerframework.framework.util.FlowExpressionParseUtil

public class FlowExpressionParseUtil
extends Object

A collection of helper methods to parse a string that represents a restricted Java expression. Such expressions can be found in annotations (e.g., to specify a pre- or postcondition).

Author:

Stefan Heule

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlowExpressionParseUtil.FlowExpressionContext Context used to parse a flow expression.
static class	FlowExpressionParseUtil.FlowExpressionParseException An exception that indicates a parse error.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Pattern	arrayPattern Matches an array access
protected static Pattern	dotPattern Matches a field access
protected static Pattern	identifierPattern Matches an identifier
protected static String	identifierRegex Regular expression for an identifier
protected static Pattern	intPattern Matches integer literals
protected static Pattern	itselfPattern Matches 'itself' - it refers to the variable that is annotated, which is different from 'this'
protected static Pattern	longPattern Matches long literals
protected static Pattern	methodPattern Matches a method call
protected static Pattern	nullPattern Matches the null literal
protected static Pattern	parameterPattern Matches a parameter
protected static Pattern	parametersPattern Finds all parameters
protected static Pattern	selfPattern Matches the self reference.
protected static Pattern	stringPattern Matches string literals
protected static Pattern	superPattern Matches 'super'

Constructor Summary

Constructors

Constructor and Description
FlowExpressionParseUtil()

Method Summary

Modifier and Type	Method and Description
static FlowExpressionParseUtil.FlowExpressionContext	buildFlowExprContextForDeclaration(MethodTree node, Tree classTree, BaseContext checkerContext)
static FlowExpressionParseUtil.FlowExpressionContext	buildFlowExprContextForDeclaration(MethodTree node, TreePath currentPath, BaseContext checkerContext)
static FlowExpressionParseUtil.FlowExpressionContext	buildFlowExprContextForDeclaration(MethodTree node, TypeMirror classType, BaseContext checkerContext)
static FlowExpressionParseUtil.FlowExpressionContext	buildFlowExprContextForUse(MethodInvocationNode n, BaseContext checkerContext)
static FlowExpressionParseUtil.FlowExpressionContext	buildFlowExprContextForUse(ObjectCreationNode n, TreePath currentPath, BaseContext checkerContext)
static FlowExpressionParseUtil.FlowExpressionContext	buildFlowExprContextForViewpointUse(MethodInvocationNode n, TreePath enclosingMethodPath, BaseContext checkerContext) This method is the same as building a flow expression for a MethodInvocationNode except it uses the PARAMETERS list from the enclosing method context.
static FlowExpressionParseUtil.FlowExpressionContext	buildFlowExprContextForViewpointUse(Node node, TreePath pathToInvocation, TreePath enclosingMethodPath, BaseContext checkerContext) Calls the method of the same name but with a first argument type of either MethodInvocationNode or ObjectCreationNode depending on the type of node.
static FlowExpressionParseUtil.FlowExpressionContext	buildFlowExprContextForViewpointUse(ObjectCreationNode n, TreePath currentPath, TreePath enclosingMethodPath, BaseContext checkerContext) This method is the same as building a flow expression for a ObjectCreationNode except it uses the PARAMETERS list from the enclosing method context.
static List<Integer>	parameterIndices(String s)
static FlowExpressions.Receiver	parse(String s, FlowExpressionParseUtil.FlowExpressionContext context, TreePath path) Parse a string and return its representation as a FlowExpressions.Receiver, or throw an FlowExpressionParseUtil.FlowExpressionParseException.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

identifierRegex

protected static final String identifierRegex

Regular expression for an identifier

See Also:

Constant Field Values

parameterPattern

protected static final Pattern parameterPattern

Matches a parameter

parametersPattern

protected static final Pattern parametersPattern

Finds all parameters

selfPattern

protected static final Pattern selfPattern

Matches the self reference. In the future we could allow "#0" as a synonym for "this".

itselfPattern

protected static final Pattern itselfPattern

Matches 'itself' - it refers to the variable that is annotated, which is different from 'this'

superPattern

protected static final Pattern superPattern

Matches 'super'

identifierPattern

protected static final Pattern identifierPattern

Matches an identifier

methodPattern

protected static final Pattern methodPattern

Matches a method call

arrayPattern

protected static final Pattern arrayPattern

Matches an array access

dotPattern

protected static final Pattern dotPattern

Matches a field access

intPattern

protected static final Pattern intPattern

Matches integer literals

longPattern

protected static final Pattern longPattern

Matches long literals

stringPattern

protected static final Pattern stringPattern

Matches string literals

nullPattern

protected static final Pattern nullPattern

Matches the null literal

Constructor Detail

FlowExpressionParseUtil

public FlowExpressionParseUtil()

Method Detail

parse

public static FlowExpressions.Receiver parse(String s,
                                             FlowExpressionParseUtil.FlowExpressionContext context,
                                             TreePath path)
                                      throws FlowExpressionParseUtil.FlowExpressionParseException

Parse a string and return its representation as a FlowExpressions.Receiver, or throw an FlowExpressionParseUtil.FlowExpressionParseException. The expression is assumed to be used in the context of a method. Returns null if 'itself' is passed in as the string to parse and no receiver named 'itself' could be found.

Parameters:

s - The string to parse.

context - information about any receiver and arguments

path - The current tree path.

Throws:

FlowExpressionParseUtil.FlowExpressionParseException

parameterIndices

public static List<Integer> parameterIndices(String s)

Returns:

The list of parameters that occur in s, identified by the number of the parameter (starting at 1).

buildFlowExprContextForDeclaration

public static FlowExpressionParseUtil.FlowExpressionContext buildFlowExprContextForDeclaration(MethodTree node,
                                                                                               Tree classTree,
                                                                                               BaseContext checkerContext)

Returns:

A FlowExpressionParseUtil.FlowExpressionContext for the method node as seen at the method declaration.

buildFlowExprContextForDeclaration

public static FlowExpressionParseUtil.FlowExpressionContext buildFlowExprContextForDeclaration(MethodTree node,
                                                                                               TypeMirror classType,
                                                                                               BaseContext checkerContext)

Returns:

A FlowExpressionParseUtil.FlowExpressionContext for the method node as seen at the method declaration.

buildFlowExprContextForDeclaration

public static FlowExpressionParseUtil.FlowExpressionContext buildFlowExprContextForDeclaration(MethodTree node,
                                                                                               TreePath currentPath,
                                                                                               BaseContext checkerContext)

Returns:

A FlowExpressionParseUtil.FlowExpressionContext for the method node as seen at the method declaration.

buildFlowExprContextForUse

public static FlowExpressionParseUtil.FlowExpressionContext buildFlowExprContextForUse(MethodInvocationNode n,
                                                                                       BaseContext checkerContext)

Returns:

A FlowExpressionParseUtil.FlowExpressionContext for the method n (represented as a Node as seen at the method use (i.e., at a method call site).

buildFlowExprContextForUse

public static FlowExpressionParseUtil.FlowExpressionContext buildFlowExprContextForUse(ObjectCreationNode n,
                                                                                       TreePath currentPath,
                                                                                       BaseContext checkerContext)

Returns:

A FlowExpressionParseUtil.FlowExpressionContext for the constructor n (represented as a Node as seen at the method use (i.e., at a method call site).

buildFlowExprContextForViewpointUse

public static FlowExpressionParseUtil.FlowExpressionContext buildFlowExprContextForViewpointUse(Node node,
                                                                                                TreePath pathToInvocation,
                                                                                                TreePath enclosingMethodPath,
                                                                                                BaseContext checkerContext)

Calls the method of the same name but with a first argument type of either MethodInvocationNode or ObjectCreationNode depending on the type of node.

Throws:

IllegalArgumentException - if node is not a MethodInvocationNode or ObjectCreationNode

buildFlowExprContextForViewpointUse

public static FlowExpressionParseUtil.FlowExpressionContext buildFlowExprContextForViewpointUse(MethodInvocationNode n,
                                                                                                TreePath enclosingMethodPath,
                                                                                                BaseContext checkerContext)

This method is the same as building a flow expression for a MethodInvocationNode except it uses the PARAMETERS list from the enclosing method context. If there is no enclosing method then this method functions exactly like the buildFowExprContextForUse. This is really built for a use in KeyFor and should likely be replaced

buildFlowExprContextForViewpointUse

public static FlowExpressionParseUtil.FlowExpressionContext buildFlowExprContextForViewpointUse(ObjectCreationNode n,
                                                                                                TreePath currentPath,
                                                                                                TreePath enclosingMethodPath,
                                                                                                BaseContext checkerContext)

This method is the same as building a flow expression for a ObjectCreationNode except it uses the PARAMETERS list from the enclosing method context. If there is no enclosing method then this method functions exactly like the buildFowExprContextForUse. This is really built for a use in KeyFor and should likely be replaced