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	identifierPattern Matches an identifier
protected static String	identifierRegex Regular expression for an identifier.
protected static Pattern	intPattern Matches integer literals
protected static Pattern	longPattern Matches long literals
protected static Pattern	memberselect Matches a field access.
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 String	parameterRegex Regular expression for a formal parameter use.
protected static Pattern	parenthesesPattern Matches an expression contained in matching start and end parentheses
protected static Pattern	stringPattern Matches string literals
protected static Pattern	superPattern Matches 'super'
protected static Pattern	thisPattern Matches 'this', the self reference.
protected static Pattern	unanchoredParameterPattern Unanchored; can be used to find all formal parameter uses.

Constructor Summary

Constructors

Constructor and Description
FlowExpressionParseUtil()

Method Summary

Modifier and Type	Method and Description
static FlowExpressions.Receiver	internalReprOfVariable(AnnotatedTypeFactory provider, VariableTree tree)
static List<Integer>	parameterIndices(String s)
static FlowExpressions.Receiver	parse(String expression, FlowExpressionParseUtil.FlowExpressionContext context, TreePath localScope, boolean useLocalScope) 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. Permits '$' in the name, though that character never appears in Java source code.

See Also:

Constant Field Values

parameterRegex

protected static final String parameterRegex

Regular expression for a formal parameter use.

See Also:

Constant Field Values

unanchoredParameterPattern

protected static final Pattern unanchoredParameterPattern

Unanchored; can be used to find all formal parameter uses.

parameterPattern

protected static final Pattern parameterPattern

Matches a parameter

thisPattern

protected static final Pattern thisPattern

Matches 'this', the self reference. Does not allow "#0" because people reading the code might assume the numbering starts at 0 and assume that #0 is the first formal parameter.

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. Capturing groups 1 and 2 are the method and arguments.

arrayPattern

protected static final Pattern arrayPattern

Matches an array access. Capturing groups 1 and 2 are the array and index.

memberselect

protected static final Pattern memberselect

Matches a field access. Capturing groups 1 and 2 are the object and field.

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

parenthesesPattern

protected static final Pattern parenthesesPattern

Matches an expression contained in matching start and end parentheses

Constructor Detail

FlowExpressionParseUtil

public FlowExpressionParseUtil()

Method Detail

parse

public static FlowExpressions.Receiver parse(String expression,
                                             FlowExpressionParseUtil.FlowExpressionContext context,
                                             TreePath localScope,
                                             boolean useLocalScope)
                                      throws FlowExpressionParseUtil.FlowExpressionParseException

Parse a string and return its representation as a FlowExpressions.Receiver, or throw an FlowExpressionParseUtil.FlowExpressionParseException.

Parameters:

expression - flow expression to parse

context - information about any receiver and arguments

localScope - path to local scope to use

useLocalScope - whether localScope should be used to resolve identifiers

Throws:

FlowExpressionParseUtil.FlowExpressionParseException

parameterIndices

public static List<Integer> parameterIndices(String s)

Returns:

a list of 1-based indices of all formal parameters that occur in s. Each formal parameter occurs in s as a string like "#1" or "#4". This routine does not do proper parsing; for instance, if "#2" appears within a string in s, then 2 would still be in the result list.

internalReprOfVariable

public static FlowExpressions.Receiver internalReprOfVariable(AnnotatedTypeFactory provider,
                                                              VariableTree tree)
                                                       throws FlowExpressionParseUtil.FlowExpressionParseException

Throws:

FlowExpressionParseUtil.FlowExpressionParseException