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<java.lang.Void,java.lang.Void>

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

org.checkerframework.checker.guieffect.GuiEffectVisitor

All Implemented Interfaces:

com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

public class GuiEffectVisitor
extends BaseTypeVisitor<GuiEffectTypeFactory>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	GuiEffectVisitor.GuiEffectOverrideChecker

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

BaseTypeVisitor.OverrideChecker

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayDeque<com.sun.source.tree.MethodTree>	currentMethods
protected boolean	debugSpew
protected java.util.ArrayDeque<Effect>	effStack

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
GuiEffectVisitor(BaseTypeChecker checker)

Method Summary

Modifier and Type	Method and Description
protected void	checkConstructorResult(AnnotatedTypeMirror.AnnotatedExecutableType constructorType, javax.lang.model.element.ExecutableElement constructorElement) Issue a warning if the result type of the constructor is not top.
protected void	checkExtendsImplements(com.sun.source.tree.ClassTree classTree) If "@B class Y extends @A X {}", then enforce that @B must be a subtype of @A.
protected void	checkMethodInvocability(AnnotatedTypeMirror.AnnotatedExecutableType method, com.sun.source.tree.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 BaseTypeVisitor.OverrideChecker	createOverrideChecker(com.sun.source.tree.Tree overriderTree, AnnotatedTypeMirror.AnnotatedExecutableType overrider, AnnotatedTypeMirror overridingType, AnnotatedTypeMirror overridingReturnType, AnnotatedTypeMirror.AnnotatedExecutableType overridden, AnnotatedTypeMirror.AnnotatedDeclaredType overriddenType, AnnotatedTypeMirror overriddenReturnType) Create an OverrideChecker.
protected GuiEffectTypeFactory	createTypeFactory() Constructs an instance of the appropriate type factory for the implemented type system.
protected java.util.Set<? extends javax.lang.model.element.AnnotationMirror>	getExceptionParameterLowerBoundAnnotations() Returns a set of AnnotationMirrors that is a lower bound for exception parameters.
boolean	isValidUse(AnnotatedTypeMirror.AnnotatedDeclaredType declarationType, AnnotatedTypeMirror.AnnotatedDeclaredType useType, com.sun.source.tree.Tree tree) Tests that the qualifiers present on the useType are valid qualifiers, given the qualifiers on the declaration of the type, declarationType.
java.lang.Void	visitLambdaExpression(com.sun.source.tree.LambdaExpressionTree node, java.lang.Void p)
java.lang.Void	visitMethod(com.sun.source.tree.MethodTree node, java.lang.Void p) Performs pseudo-assignment check: checks that the method obeys override and subtype rules to all overridden methods.
java.lang.Void	visitMethodInvocation(com.sun.source.tree.MethodInvocationTree node, java.lang.Void p) Performs a method invocation check.
java.lang.Void	visitNewClass(com.sun.source.tree.NewClassTree node, java.lang.Void p) Performs a new class invocation check.

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

checkAccess, checkArguments, checkArrayInitialization, checkConditionalPostcondition, checkConstructorInvocation, checkContract, checkDefaultConstructor, checkExceptionParameter, checkFieldInvariantDeclarations, checkForAnnotatedJdk, checkMethodReferenceAsOverride, checkOverride, checkOverride, checkPostcondition, checkPreconditions, checkSuperConstructorCall, checkThisConstructorCall, checkThisOrSuperConstructorCall, checkThrownExpression, checkTypeArguments, checkTypecastRedundancy, checkTypecastSafety, checkVarargs, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheckEndDiagnostic, commonAssignmentCheckStartDiagnostic, createTypeValidator, enclosingMemberSelect, enclosingStatement, getThrowUpperBoundAnnotations, getTypeFactory, isAccessAllowed, isTypeCastSafe, isValidUse, isValidUse, processClassTree, reportPurityErrors, scan, setRoot, shouldSkipUses, skipReceiverSubtypeCheck, testTypevarContainment, typeCheckVectorCopyIntoArgument, validateType, validateTypeOf, visitAnnotation, visitArrayAccess, visitAssignment, visitCatch, visitClass, visitCompilationUnit, visitCompoundAssignment, visitConditionalExpression, visitEnhancedForLoop, visitIdentifier, visitInstanceOf, visitMemberReference, visitNewArray, 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, visitExports, visitExpressionStatement, visitForLoop, visitIf, visitImport, visitIntersectionType, visitLabeledStatement, visitLiteral, visitMemberSelect, visitModifiers, visitModule, visitOpens, visitOther, visitPackage, visitParameterizedType, visitParenthesized, visitPrimitiveType, visitProvides, visitRequires, visitSwitch, visitSynchronized, visitTry, visitUnionType, visitUses, 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 java.util.ArrayDeque<Effect> effStack

currentMethods

protected final java.util.ArrayDeque<com.sun.source.tree.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,
                                       com.sun.source.tree.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

createOverrideChecker

protected BaseTypeVisitor.OverrideChecker createOverrideChecker(com.sun.source.tree.Tree overriderTree,
                                                                AnnotatedTypeMirror.AnnotatedExecutableType overrider,
                                                                AnnotatedTypeMirror overridingType,
                                                                AnnotatedTypeMirror overridingReturnType,
                                                                AnnotatedTypeMirror.AnnotatedExecutableType overridden,
                                                                AnnotatedTypeMirror.AnnotatedDeclaredType overriddenType,
                                                                AnnotatedTypeMirror overriddenReturnType)

Description copied from class: BaseTypeVisitor

Create an OverrideChecker.

This exists so that subclasses can subclass OverrideChecker and use their subclass instead of using OverrideChecker itself.

Overrides:

createOverrideChecker in class BaseTypeVisitor<GuiEffectTypeFactory>

getExceptionParameterLowerBoundAnnotations

protected java.util.Set<? extends javax.lang.model.element.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 BaseTypeVisitor.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,
                          com.sun.source.tree.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.

In most cases, useType simply needs to be a subtype of declarationType. If a type system makes exceptions to this rule, its implementation should override this method.

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

visitLambdaExpression

public java.lang.Void visitLambdaExpression(com.sun.source.tree.LambdaExpressionTree node,
                                            java.lang.Void p)

Specified by:

visitLambdaExpression in interface com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitLambdaExpression in class BaseTypeVisitor<GuiEffectTypeFactory>

checkExtendsImplements

protected void checkExtendsImplements(com.sun.source.tree.ClassTree classTree)

Description copied from class: BaseTypeVisitor

If "@B class Y extends @A X {}", then enforce that @B must be a subtype of @A.

Also validate the types of the extends and implements clauses.

Overrides:

checkExtendsImplements in class BaseTypeVisitor<GuiEffectTypeFactory>

Parameters:

classTree - class tree to check

checkConstructorResult

protected void checkConstructorResult(AnnotatedTypeMirror.AnnotatedExecutableType constructorType,
                                      javax.lang.model.element.ExecutableElement constructorElement)

Description copied from class: BaseTypeVisitor

Issue a warning if the result type of the constructor is not top. If it is a supertype of the class, then a type.invalid.conflicting.annos error will also be issued by BaseTypeVisitor.isValidUse(AnnotatedTypeMirror.AnnotatedDeclaredType,AnnotatedTypeMirror.AnnotatedDeclaredType,Tree).

Overrides:

checkConstructorResult in class BaseTypeVisitor<GuiEffectTypeFactory>

Parameters:

constructorType - AnnotatedExecutableType for the constructor

constructorElement - element that declares the constructor

visitMethodInvocation

public java.lang.Void visitMethodInvocation(com.sun.source.tree.MethodInvocationTree node,
                                            java.lang.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 com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitMethodInvocation in class BaseTypeVisitor<GuiEffectTypeFactory>

visitMethod

public java.lang.Void visitMethod(com.sun.source.tree.MethodTree node,
                                  java.lang.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 com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitMethod in class BaseTypeVisitor<GuiEffectTypeFactory>

visitNewClass

public java.lang.Void visitNewClass(com.sun.source.tree.NewClassTree node,
                                    java.lang.Void p)

Description copied from class: BaseTypeVisitor

Performs a new class invocation check.

An invocation of a constructor, c, is valid only if:

• passed arguments are subtypes of corresponding c parameters
• if c is generic, passed type arguments are subtypes of c type variables

Specified by:

visitNewClass in interface com.sun.source.tree.TreeVisitor<java.lang.Void,java.lang.Void>

Overrides:

visitNewClass in class BaseTypeVisitor<GuiEffectTypeFactory>