org.checkerframework.checker.regex

Class RegexVisitor

java.lang.Object

com.sun.source.util.TreeScanner<R,P>

com.sun.source.util.TreePathScanner<R,P>

org.checkerframework.framework.source.SourceVisitor<Void,Void>

org.checkerframework.common.basetype.BaseTypeVisitor<RegexAnnotatedTypeFactory>

org.checkerframework.checker.regex.RegexVisitor

All Implemented Interfaces:

TreeVisitor<Void,Void>

public class RegexVisitor
extends BaseTypeVisitor<RegexAnnotatedTypeFactory>

A type-checking visitor for the Regex type system.

This visitor does the following:

1. Allows any String to be passed to Pattern.compile if the Pattern.LITERAL flag is passed.
2. Checks compound String concatenation to ensure correct usage of Regex Strings.
3. Checks calls to MatchResult.start, MatchResult.end and MatchResult.group to ensure that a valid group number is passed.

See Also:

RegexChecker

Nested Class Summary

Nested classes/interfaces inherited from class org.checkerframework.common.basetype.BaseTypeVisitor

BaseTypeVisitor.OverrideChecker

Field Summary

Fields inherited from class org.checkerframework.common.basetype.BaseTypeVisitor

atypeFactory, checker, contractsUtils, positions, TARGET, targetValueElement, typeValidator, visitorState

Fields inherited from class org.checkerframework.framework.source.SourceVisitor

elements, root, trees, treesWithSuppressWarnings, types

Constructor Summary

Constructors

Constructor and Description
RegexVisitor(BaseTypeChecker checker)

Method Summary

Modifier and Type	Method and Description
boolean	isValidUse(AnnotatedTypeMirror.AnnotatedDeclaredType declarationType, AnnotatedTypeMirror.AnnotatedDeclaredType useType, Tree tree) Case 2: Check String compound concatenation for valid Regex use.
boolean	isValidUse(AnnotatedTypeMirror.AnnotatedPrimitiveType type, Tree tree) Tests that the qualifiers present on the primitive type are valid.
Void	visitMethodInvocation(MethodInvocationTree node, Void p) Case 1: Don't require a Regex annotation on the String argument to Pattern.compile if the Pattern.LITERAL flag is passed.

Methods inherited from class org.checkerframework.common.basetype.BaseTypeVisitor

checkAccess, checkArguments, checkArrayInitialization, checkConditionalPostcondition, checkConstructorInvocation, checkConstructorResult, checkContract, checkDefaultConstructor, checkExceptionParameter, checkExtendsImplements, checkFieldInvariantDeclarations, checkForAnnotatedJdk, checkMethodInvocability, checkMethodReferenceAsOverride, checkOverride, checkOverride, checkPostcondition, checkPreconditions, checkSuperConstructorCall, checkThisConstructorCall, checkThisOrSuperConstructorCall, checkThrownExpression, checkTypeArguments, checkTypecastRedundancy, checkTypecastSafety, checkVarargs, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheckEndDiagnostic, commonAssignmentCheckStartDiagnostic, createOverrideChecker, createTypeFactory, createTypeValidator, enclosingMemberSelect, enclosingStatement, getExceptionParameterLowerBoundAnnotations, getThrowUpperBoundAnnotations, getTypeFactory, isAccessAllowed, isValidUse, processClassTree, reportPurityErrors, scan, setRoot, shouldSkipUses, skipReceiverSubtypeCheck, testTypevarContainment, typeCheckVectorCopyIntoArgument, validateType, validateTypeOf, visitAnnotation, visitArrayAccess, visitAssignment, visitCatch, visitClass, visitCompilationUnit, visitCompoundAssignment, visitConditionalExpression, visitEnhancedForLoop, visitIdentifier, visitInstanceOf, visitLambdaExpression, visitMemberReference, visitMethod, visitNewArray, visitNewClass, visitParameterizedType, visitReturn, visitThrow, visitTypeCast, visitTypeParameter, visitUnary, visitVariable

Methods inherited from class org.checkerframework.framework.source.SourceVisitor

visit

Methods inherited from class com.sun.source.util.TreePathScanner

getCurrentPath, scan

Methods inherited from class com.sun.source.util.TreeScanner

reduce, scan, visitAnnotatedType, visitArrayType, visitAssert, visitBinary, visitBlock, visitBreak, visitCase, visitContinue, visitDoWhileLoop, visitEmptyStatement, visitErroneous, visitExpressionStatement, visitForLoop, visitIf, visitImport, visitIntersectionType, visitLabeledStatement, visitLiteral, visitMemberSelect, visitModifiers, visitOther, visitParenthesized, visitPrimitiveType, visitSwitch, visitSynchronized, visitTry, visitUnionType, visitWhileLoop, visitWildcard

Methods inherited from class java.lang.Object

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

Constructor Detail

RegexVisitor

public RegexVisitor(BaseTypeChecker checker)

Method Detail

visitMethodInvocation

public Void visitMethodInvocation(MethodInvocationTree node,
                                  Void p)

Case 1: Don't require a Regex annotation on the String argument to Pattern.compile if the Pattern.LITERAL flag is passed.

Specified by:

visitMethodInvocation in interface TreeVisitor<Void,Void>

Overrides:

visitMethodInvocation in class BaseTypeVisitor<RegexAnnotatedTypeFactory>

isValidUse

public boolean isValidUse(AnnotatedTypeMirror.AnnotatedDeclaredType declarationType,
                          AnnotatedTypeMirror.AnnotatedDeclaredType useType,
                          Tree tree)

Case 2: Check String compound concatenation for valid Regex use.

Overrides:

isValidUse in class BaseTypeVisitor<RegexAnnotatedTypeFactory>

Parameters:

declarationType - the type of the class (TypeElement)

useType - the use of the class (instance type)

tree - the tree where the type is used

Returns:

true if the useType is a valid use of elemType

isValidUse

public boolean isValidUse(AnnotatedTypeMirror.AnnotatedPrimitiveType type,
                          Tree tree)

Description copied from class: BaseTypeVisitor

Tests that the qualifiers present on the primitive type are valid.

The default implementation always returns true. Subclasses should override this method to limit what annotations are allowed on primitive types.

Overrides:

isValidUse in class BaseTypeVisitor<RegexAnnotatedTypeFactory>

Parameters:

type - the use of the primitive type

tree - the tree where the type is used

Returns:

true if the type is a valid use of the primitive type