org.checkerframework.checker.guieffect

Class GuiEffectVisitor

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<GuiEffectTypeFactory>

org.checkerframework.checker.guieffect.GuiEffectVisitor

All Implemented Interfaces:

TreeVisitor<Void,Void>

public class GuiEffectVisitor
extends BaseTypeVisitor<GuiEffectTypeFactory>

Require that only UI code invokes code with the UI effect.

Field Summary

Fields

Modifier and Type	Field and Description
protected Stack<MethodTree>	currentMethods
protected boolean	debugSpew
protected Stack<Effect>	effStack

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

atypeFactory, checker, contractsUtils, positions, typeValidator, visitorState

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

elements, root, trees, types

Constructor Summary

Constructors

Constructor and Description
GuiEffectVisitor(BaseTypeChecker checker)

Method Summary

Modifier and Type	Method and Description
protected void	checkMethodInvocability(AnnotatedTypeMirror.AnnotatedExecutableType method, MethodInvocationTree node) Tests whether the method can be invoked using the receiver of the 'node' method invocation, and issues a "method.invocation.invalid" if the invocation is invalid.
protected boolean	checkOverride(MethodTree overriderTree, AnnotatedTypeMirror.AnnotatedDeclaredType enclosingType, AnnotatedTypeMirror.AnnotatedExecutableType overridden, AnnotatedTypeMirror.AnnotatedDeclaredType overriddenType, Void p) Type checks that a method may override another method.
protected GuiEffectTypeFactory	createTypeFactory() Constructs an instance of the appropriate type factory for the implemented type system.
protected Set<? extends AnnotationMirror>	getExceptionParameterLowerBoundAnnotations() Returns a set of AnnotationMirrors that is a lower bound for exception parameters.
boolean	isValidUse(AnnotatedTypeMirror.AnnotatedDeclaredType declarationType, AnnotatedTypeMirror.AnnotatedDeclaredType useType, Tree tree) Tests that the qualifiers present on the useType are valid qualifiers, given the qualifiers on the declaration of the type, declarationType.
Void	visitClass(ClassTree node, Void p)
Void	visitMemberSelect(MemberSelectTree node, Void p)
Void	visitMethod(MethodTree node, Void p) Performs pseudo-assignment check: checks that the method obeys override and subtype rules to all overridden methods.
Void	visitMethodInvocation(MethodInvocationTree node, Void p) Performs a method invocation check.

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

checkAccess, checkAccess, checkArguments, checkArrayInitialization, checkAssignability, checkConditionalPostconditions, checkConditionalPostconditionsConsistency, checkConstructorInvocation, checkContract, checkDefaultConstructor, checkExceptionParameter, checkFlowExprParameters, checkForAnnotatedJdk, checkMethodReferenceAsOverride, checkPostconditions, checkPostconditionsConsistency, checkPreconditions, checkPreconditions, checkPreconditionsConsistency, checkThrownExpression, checkTypeArguments, checkTypecastRedundancy, checkTypecastSafety, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheck, createTypeValidator, enclosingMemberSelect, enclosingStatement, getThrowUpperBoundAnnotations, getTypeFactory, isAccessAllowed, isAssignable, isValidUse, isValidUse, isVectorCopyInto, reportPurityErrors, scan, setRoot, shouldSkipUses, skipContractCheck, skipReceiverSubtypeCheck, testTypevarContainment, typeCheckVectorCopyIntoArgument, validateType, validateTypeOf, visitAnnotation, visitArrayAccess, visitAssignment, visitCatch, visitCompilationUnit, visitCompoundAssignment, visitConditionalExpression, visitEnhancedForLoop, visitIdentifier, visitInstanceOf, visitLambdaExpression, visitMemberReference, 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, 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

Field Detail

debugSpew

protected final boolean debugSpew

effStack

protected final Stack<Effect> effStack

currentMethods

protected final Stack<MethodTree> currentMethods

Constructor Detail

GuiEffectVisitor

public GuiEffectVisitor(BaseTypeChecker checker)

Method Detail

createTypeFactory

protected GuiEffectTypeFactory createTypeFactory()

Description copied from class: BaseTypeVisitor

Constructs an instance of the appropriate type factory for the implemented type system. The default implementation uses the checker naming convention to create the appropriate type factory. If no factory is found, it returns BaseAnnotatedTypeFactory. It reflectively invokes the constructor that accepts this checker and compilation unit tree (in that order) as arguments. Subclasses have to override this method to create the appropriate visitor if they do not follow the checker naming convention.

Overrides:

createTypeFactory in class BaseTypeVisitor<GuiEffectTypeFactory>

Returns:

the appropriate type factory

checkMethodInvocability

protected void checkMethodInvocability(AnnotatedTypeMirror.AnnotatedExecutableType method,
                                       MethodInvocationTree node)

Description copied from class: BaseTypeVisitor

Tests whether the method can be invoked using the receiver of the 'node' method invocation, and issues a "method.invocation.invalid" if the invocation is invalid. This implementation tests whether the receiver in the method invocation is a subtype of the method receiver type. This behavior can be specialized by overriding skipReceiverSubtypeCheck.

Overrides:

checkMethodInvocability in class BaseTypeVisitor<GuiEffectTypeFactory>

Parameters:

method - the type of the invoked method

node - the method invocation node

checkOverride

protected boolean checkOverride(MethodTree overriderTree,
                                AnnotatedTypeMirror.AnnotatedDeclaredType enclosingType,
                                AnnotatedTypeMirror.AnnotatedExecutableType overridden,
                                AnnotatedTypeMirror.AnnotatedDeclaredType overriddenType,
                                Void p)

Description copied from class: BaseTypeVisitor

Type checks that a method may override another method. Uses the OverrideChecker class.

Overrides:

checkOverride in class BaseTypeVisitor<GuiEffectTypeFactory>

Parameters:

overriderTree - Declaration tree of overriding method

enclosingType - Type of overriding class

overridden - Type of overridden method

overriddenType - Type of overridden class

Returns:

true if the override is allowed

getExceptionParameterLowerBoundAnnotations

protected Set<? extends AnnotationMirror> getExceptionParameterLowerBoundAnnotations()

Description copied from class: BaseTypeVisitor

Returns a set of AnnotationMirrors that is a lower bound for exception parameters. Note: by default this method is called by getThrowUpperBoundAnnotations(), so that this annotation is enforced. (Default is top)

Overrides:

getExceptionParameterLowerBoundAnnotations in class BaseTypeVisitor<GuiEffectTypeFactory>

Returns:

Set of annotation mirrors, one per hierarchy, that from a lower bound of annotations that can be written on an exception parameter

isValidUse

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

Description copied from class: BaseTypeVisitor

Tests that the qualifiers present on the useType are valid qualifiers, given the qualifiers on the declaration of the type, declarationType.

The check is shallow, as it does not descend into generic or array types (i.e. only performing the validity check on the raw type or outermost array dimension). BaseTypeVisitor.validateTypeOf(Tree) would call this for each type argument or array dimension separately.

For instance, in the IGJ type system, a @Mutable is an invalid qualifier for String, as String is declared as @Immutable String.

In most cases, useType simply needs to be a subtype of declarationType, but there are exceptions. In IGJ, a variable may be declared @ReadOnly String, even though String is @Immutable String; ReadOnly is not a subtype of Immutable.

Overrides:

isValidUse in class BaseTypeVisitor<GuiEffectTypeFactory>

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

visitMethodInvocation

public Void visitMethodInvocation(MethodInvocationTree node,
                                  Void p)

Description copied from class: BaseTypeVisitor

Performs a method invocation check. An invocation of a method, m, on the receiver, r is valid only if:

• passed arguments are subtypes of corresponding m parameters
• r is a subtype of m receiver type
• if m is generic, passed type arguments are subtypes of m type variables

Specified by:

visitMethodInvocation in interface TreeVisitor<Void,Void>

Overrides:

visitMethodInvocation in class BaseTypeVisitor<GuiEffectTypeFactory>

visitMethod

public Void visitMethod(MethodTree node,
                        Void p)

Description copied from class: BaseTypeVisitor

Performs pseudo-assignment check: checks that the method obeys override and subtype rules to all overridden methods. The override rule specifies that a method, m1, may override a method m2 only if:

• m1 return type is a subtype of m2
• m1 receiver type is a supertype of m2
• m1 parameters are supertypes of corresponding m2 parameters

Also, it issues a "missing.this" error for static method annotated receivers.

Specified by:

visitMethod in interface TreeVisitor<Void,Void>

Overrides:

visitMethod in class BaseTypeVisitor<GuiEffectTypeFactory>

visitMemberSelect

public Void visitMemberSelect(MemberSelectTree node,
                              Void p)

Specified by:

visitMemberSelect in interface TreeVisitor<Void,Void>

Overrides:

visitMemberSelect in class TreeScanner<Void,Void>

visitClass

public Void visitClass(ClassTree node,
                       Void p)

Specified by:

visitClass in interface TreeVisitor<Void,Void>

Overrides:

visitClass in class BaseTypeVisitor<GuiEffectTypeFactory>