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).

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	IDENTIFIER_PATTERN Matches an identifier.
protected static String	IDENTIFIER_REGEX Regular expression for an identifier.
protected static Pattern	INT_PATTERN Matches integer literals.
protected static Pattern	LONG_PATTERN Matches long literals.
protected static Pattern	PARAMETER_PATTERN Matches a parameter.
protected static String	PARAMETER_REGEX Regular expression for a formal parameter use.
protected static Pattern	PARENTHESES_PATTERN Matches an expression contained in matching start and end parentheses.
protected static Pattern	STRING_PATTERN Matches string literals.
protected static String	STRING_REGEX Regular expression for a string literal.
protected static Pattern	UNANCHORED_PARAMETER_PATTERN 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

IDENTIFIER_REGEX

protected static final String IDENTIFIER_REGEX

Regular expression for an identifier. Permits '$' in the name, though that character never appears in Java source code.

See Also:

Constant Field Values

PARAMETER_REGEX

protected static final String PARAMETER_REGEX

Regular expression for a formal parameter use.

See Also:

Constant Field Values

STRING_REGEX

protected static final String STRING_REGEX

Regular expression for a string literal.

See Also:

Constant Field Values

UNANCHORED_PARAMETER_PATTERN

protected static final Pattern UNANCHORED_PARAMETER_PATTERN

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

PARAMETER_PATTERN

protected static final Pattern PARAMETER_PATTERN

Matches a parameter.

IDENTIFIER_PATTERN

protected static final Pattern IDENTIFIER_PATTERN

Matches an identifier.

INT_PATTERN

protected static final Pattern INT_PATTERN

Matches integer literals.

LONG_PATTERN

protected static final Pattern LONG_PATTERN

Matches long literals.

STRING_PATTERN

protected static final Pattern STRING_PATTERN

Matches string literals.

PARENTHESES_PATTERN

protected static final Pattern PARENTHESES_PATTERN

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