org.checkerframework.checker.guieffect

Class GuiEffectTypeFactory

java.lang.Object

org.checkerframework.framework.type.AnnotatedTypeFactory

org.checkerframework.framework.type.GenericAnnotatedTypeFactory<CFValue,CFStore,CFTransfer,CFAnalysis>

org.checkerframework.common.basetype.BaseAnnotatedTypeFactory

org.checkerframework.checker.guieffect.GuiEffectTypeFactory

All Implemented Interfaces:

AnnotationProvider

public class GuiEffectTypeFactory
extends BaseAnnotatedTypeFactory

Annotated type factory for the GUI Effect Checker.

Nested Class Summary

Nested classes/interfaces inherited from class org.checkerframework.framework.type.GenericAnnotatedTypeFactory

GenericAnnotatedTypeFactory.ScanState

Nested classes/interfaces inherited from class org.checkerframework.framework.type.AnnotatedTypeFactory

AnnotatedTypeFactory.ParameterizedExecutableType

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	debugSpew
protected Set<TypeElement>	uiAnonClasses Keeps track of all anonymous inner classes with inferred UIEffect.
protected Set<LambdaExpressionTree>	uiLambdas Keeps track of all lambda expressions with inferred UIEffect.

Fields inherited from class org.checkerframework.framework.type.GenericAnnotatedTypeFactory

analysis, cfgVisualizer, defaults, dependentTypesHelper, emptyStore, flowByDefault, flowResult, flowResultAnalysisCaches, initializationStaticStore, initializationStore, methodInvocationStores, poly, regularExitStores, returnStatementStores, scannedClasses, transfer, treeAnnotator, typeAnnotator

Fields inherited from class org.checkerframework.framework.type.AnnotatedTypeFactory

checker, elements, fromExpressionTreeCache, fromMemberTreeCache, fromTypeTreeCache, ignoreUninferredTypeArguments, loader, objectGetClass, processingEnv, qualHierarchy, qualifierUpperBounds, reflectionResolver, root, shouldCache, trees, typeArgumentInference, typeFormatter, typeHierarchy, types, typeVarSubstitutor, uid, visitorState

Constructor Summary

Constructors

Constructor and Description
GuiEffectTypeFactory(BaseTypeChecker checker, boolean spew)

Method Summary

Modifier and Type	Method and Description
void	constrainAnonymousClassToUI(TypeElement classElt) Force the given anonymous inner class to be an @UI instantiation of its base class.
void	constrainLambdaToUI(LambdaExpressionTree lambdaExpressionTree) Force the given lambda expression to have UIEffect.
protected TreeAnnotator	createTreeAnnotator() Returns a TreeAnnotator that adds annotations to a type based on the contents of a tree.
Effect.EffectRange	findInheritedEffectRange(TypeElement declaringType, ExecutableElement overridingMethod)
Effect.EffectRange	findInheritedEffectRange(TypeElement declaringType, ExecutableElement overridingMethod, boolean issueConflictWarning, Tree errorNode)
ExecutableElement	findJavaOverride(ExecutableElement overrider, TypeMirror parentType)
AnnotatedTypeMirror	getAnnotatedType(Tree tree) Returns an AnnotatedTypeMirror representing the annotated type of tree.
Effect	getComputedEffectAtCallsite(MethodInvocationTree node, AnnotatedTypeMirror.AnnotatedDeclaredType callerReceiver, ExecutableElement methodElt) Get the effect of a method call at its callsite, acknowledging polymorphic instantiation using type use annotations.
Effect	getDeclaredEffect(ExecutableElement methodElt) Calling context annotations.
protected Set<? extends AnnotationMirror>	getDefaultTypeDeclarationBounds() Returns the set of qualifiers that are the upper bound for a type use if no other bound is specified for the type.
Effect	getInferedEffectForLambdaExpression(LambdaExpressionTree lambdaTree) Get the inferred effect of a lambda expression based on the type annotations of its functional interface and the effects of the calls in its body.
boolean	isDirectlyMarkedUIThroughInference(Tree tree) Test if this tree corresponds to a lambda expression or new class marked as UI affecting by either constrainLambdaToUI} or constrainAnonymousClassToUI(TypeElement).
boolean	isPolymorphicType(TypeElement cls)
boolean	isUIType(TypeElement cls)

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

createFlowAnalysis

Methods inherited from class org.checkerframework.framework.type.GenericAnnotatedTypeFactory

addAnnotationsFromDefaultQualifierForUse, addCheckedCodeDefaults, addCheckedStandardDefaults, addComputedTypeAnnotations, addComputedTypeAnnotations, addComputedTypeAnnotations, addDefaultAnnotations, addUncheckedCodeDefaults, addUncheckedStandardDefaults, analyze, applyInferredAnnotations, checkAndPerformFlowAnalysis, checkForDefaultQualifierInHierarchy, constructorFromUse, createAndInitQualifierDefaults, createCFGVisualizer, createDefaultForUseTypeAnnotator, createDependentTypesHelper, createFlowTransferFunction, createQualifierDefaults, createQualifierPolymorphism, createTypeAnnotator, fromNewClass, getAnnotatedTypeLhs, getAnnotatedTypeLhsNoTypeVarDefault, getAnnotatedTypeRhsUnaryAssign, getAnnotatedTypeVarargsArray, getAnnotationFromJavaExpressionString, getAnnotationFromReceiver, getAnnotationMirrorFromJavaExpressionString, getCFGVisualizer, getDependentTypesHelper, getEmptyStore, getFinalLocalValues, getFirstNodeOfKindForTree, getInferredValueFor, getMethodReturnType, getMethodReturnType, getNodesForTree, getQualifierPolymorphism, getReceiverAndOffsetFromJavaExpressionString, getReceiverFromJavaExpressionString, getRegularExitStore, getResultingTypeOfConstructorMemberReference, getReturnStatementStores, getShouldDefaultTypeVarLocals, getSortedQualifierNames, getStoreAfter, getStoreAfter, getStoreAfter, getStoreBefore, getStoreBefore, getStoreBefore, getSupportedMonotonicTypeQualifiers, getTypeFactoryOfSubchecker, handleCFGViz, methodFromUse, performFlowAnalysis, postDirectSuperTypes, postInit, preProcessClassTree, setRoot, typeVariablesFromUse

Methods inherited from class org.checkerframework.framework.type.AnnotatedTypeFactory

adaptGetClassReturnTypeToReceiver, addAliasedAnnotation, addAliasedAnnotation, addAliasedAnnotation, addAliasedAnnotation, addAliasedDeclAnnotation, addAnnotationFromFieldInvariant, addInheritedAnnotation, canonicalAnnotation, checkInvalidOptionsInferSignatures, createAnnotatedTypeFormatter, createAnnotationClassLoader, createAnnotationFormatter, createQualifierHierarchy, createQualifierHierarchy, createQualifierHierarchy, createQualifierHierarchyFactory, createQualifierUpperBounds, createSupportedTypeQualifiers, createTypeArgumentInference, createTypeHierarchy, createTypeVariableSubstitutor, declarationFromElement, fromElement, fromElement, fromElement, getAnnotatedNullType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedTypeFormatter, getAnnotatedTypeFromTypeTree, getAnnotationFormatter, getAnnotationMirror, getAnnotationWithMetaAnnotation, getBoxedType, getBundledTypeQualifiersWithoutPolyAll, getBundledTypeQualifiersWithPolyAll, getCacheSize, getContext, getCurrentClassTree, getCurrentClassType, getCurrentMethodReceiver, getDeclAnnotation, getDeclAnnotationNoAliases, getDeclAnnotations, getDeclAnnotationWithMetaAnnotation, getElementUtils, getEnclosingElementForArtificialTree, getEnclosingType, getExpressionAndOffset, getFieldInvariantAnnotationTree, getFieldInvariantDeclarationAnnotations, getFieldInvariants, getFnInterfaceFromTree, getFnInterfaceFromTree, getImplicitReceiverType, getNarrowedPrimitive, getPath, getProcessingEnv, getQualifierHierarchy, getReceiverType, getSelfType, getStringType, getSupportedTypeQualifiers, getTreeUtils, getTypeArgumentInference, getTypeDeclarationBounds, getTypeHierarchy, getTypeOfExtendsImplements, getTypeVarSubstitutor, getUnboxedType, getUninferredWildcardType, getVisitorState, getWholeProgramInference, initializeReflectionResolution, isAnyEnclosingThisDeref, isFromByteCode, isFromStubFile, isMostEnclosingThisDeref, isSupportedQualifier, isWithinConstructor, methodFromUse, negateConstant, parseStubFiles, postAsMemberOf, postProcessClassTree, postTypeVarSubstitution, setEnclosingElementForArtificialTree, toAnnotatedType, toString, type, widenToUpperBound

Methods inherited from class java.lang.Object

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

Field Detail

debugSpew

protected final boolean debugSpew

uiLambdas

protected final Set<LambdaExpressionTree> uiLambdas

Keeps track of all lambda expressions with inferred UIEffect.

constrainLambdaToUI adds lambda expressions to this set, and is called from GuiEffectVisitor whenever a lambda expression calls a @UIEffect method. Afterwards getInferedEffectForLambdaExpression uses this set and the type annotations of the functional interface of the lambda to figure out if it can affect the UI or not.

uiAnonClasses

protected final Set<TypeElement> uiAnonClasses

Keeps track of all anonymous inner classes with inferred UIEffect.

constrainAnonymousClassToUI adds anonymous inner classes to this set, and is called from GuiEffectVisitor whenever an anonymous inner class calls a @UIEffect method. Afterwards isUIType and getAnnotatedType will treat this inner class as if it had been annotated with @UI.

Constructor Detail

GuiEffectTypeFactory

public GuiEffectTypeFactory(BaseTypeChecker checker,
                            boolean spew)

Method Detail

findJavaOverride

public ExecutableElement findJavaOverride(ExecutableElement overrider,
                                          TypeMirror parentType)

isPolymorphicType

public boolean isPolymorphicType(TypeElement cls)

isUIType

public boolean isUIType(TypeElement cls)

getDeclaredEffect

public Effect getDeclaredEffect(ExecutableElement methodElt)

Calling context annotations.

To make anon-inner-classes work, I need to climb the inheritance DAG, until I:

• find the class/interface that declares this calling method (an anon inner class is a separate class that implements an interface)
• check whether *that* declaration specifies @UI on either the type or method

A method has the UI effect when:

1. A method is UI if annotated @UIEffect
2. A method is UI if the enclosing class is annotated @UI or @UIType and the method is not annotated @AlwaysSafe
3. A method is UI if the corresponding method in the super-class/interface is UI, and this method is not annotated @AlwaysSafe, and this method resides in an anonymous inner class (named classes still require a package/class/method annotation to make it UI, only anon inner classes have this inheritance-by-default)
   • A method must be *annotated* UI if the method it overrides is *annotated* UI
   • A method must be *annotated* UI if it overrides a UI method and the enclosing class is not UI
4. It is an error if a method is UI but the same method in a super-type is not UI
5. It is an error if two super-types specify the same method, where one type says it's UI and one says it's not (it's possible to simply enforce the weaker (safe) effect, but this seems more principled, it's easier --- backwards-compatible --- to change our minds about this later)

getComputedEffectAtCallsite

public Effect getComputedEffectAtCallsite(MethodInvocationTree node,
                                          AnnotatedTypeMirror.AnnotatedDeclaredType callerReceiver,
                                          ExecutableElement methodElt)

Get the effect of a method call at its callsite, acknowledging polymorphic instantiation using type use annotations.

Parameters:

node - the method invocation as an AST node

callerReceiver - the type of the receiver object if available. Used to resolve direct calls like "super()"

methodElt - the element of the callee method

Returns:

the computed effect (SafeEffect or UIEffect) for the method call

getInferedEffectForLambdaExpression

public Effect getInferedEffectForLambdaExpression(LambdaExpressionTree lambdaTree)

Get the inferred effect of a lambda expression based on the type annotations of its functional interface and the effects of the calls in its body.

This relies on GuiEffectVisitor to perform the actual inference step and mark lambdas with @PolyUIEffect functional interfaces as being explicitly UI-affecting using the constrainLambdaToUI method.

Parameters:

lambdaTree - a lambda expression's AST node

Returns:

the inferred effect of the lambda

isDirectlyMarkedUIThroughInference

public boolean isDirectlyMarkedUIThroughInference(Tree tree)

Test if this tree corresponds to a lambda expression or new class marked as UI affecting by either constrainLambdaToUI} or constrainAnonymousClassToUI(TypeElement). Only explicit markings due to inference are considered here, for the properly computed type of the expression, use getAnnotatedType(Tree) instead.

Parameters:

tree - the tree to check

Returns:

whether it is a lambda expression or new class marked as UI by inference

getAnnotatedType

public AnnotatedTypeMirror getAnnotatedType(Tree tree)

Description copied from class: AnnotatedTypeFactory

Returns an AnnotatedTypeMirror representing the annotated type of tree.

Overrides:

getAnnotatedType in class AnnotatedTypeFactory

Parameters:

tree - the AST node

Returns:

the annotated type of tree

findInheritedEffectRange

public Effect.EffectRange findInheritedEffectRange(TypeElement declaringType,
                                                   ExecutableElement overridingMethod)

findInheritedEffectRange

public Effect.EffectRange findInheritedEffectRange(TypeElement declaringType,
                                                   ExecutableElement overridingMethod,
                                                   boolean issueConflictWarning,
                                                   Tree errorNode)

getDefaultTypeDeclarationBounds

protected Set<? extends AnnotationMirror> getDefaultTypeDeclarationBounds()

Description copied from class: AnnotatedTypeFactory

Returns the set of qualifiers that are the upper bound for a type use if no other bound is specified for the type.

This implementation returns the top qualifiers by default. Subclass may override to return different qualifiers.

Overrides:

getDefaultTypeDeclarationBounds in class AnnotatedTypeFactory

Returns:

the set of qualifiers that are the upper bound for a type use if no other bound is specified for the type

createTreeAnnotator

protected TreeAnnotator createTreeAnnotator()

Description copied from class: GenericAnnotatedTypeFactory

Returns a TreeAnnotator that adds annotations to a type based on the contents of a tree.

The default tree annotator is a ListTreeAnnotator of the following:

1. PropagationTreeAnnotator: Propagates annotations from subtrees
2. LiteralTreeAnnotator: Adds annotations based on QualifierForLiterals meta-annotations
3. DependentTypesTreeAnnotator: Adapts dependent annotations based on context

Subclasses may override this method to specify additional tree annotators, for example:

 new ListTreeAnnotator(super.createTreeAnnotator(), new KeyLookupTreeAnnotator(this));
 

Overrides:

createTreeAnnotator in class GenericAnnotatedTypeFactory<CFValue,CFStore,CFTransfer,CFAnalysis>

Returns:

a tree annotator

constrainLambdaToUI

public void constrainLambdaToUI(LambdaExpressionTree lambdaExpressionTree)

Force the given lambda expression to have UIEffect.

Used by GuiEffectVisitor to mark as UIEffect all lambdas that perform UIEffect calls inside their bodies.

Parameters:

lambdaExpressionTree - a lambda expression's AST node

constrainAnonymousClassToUI

public void constrainAnonymousClassToUI(TypeElement classElt)

Force the given anonymous inner class to be an @UI instantiation of its base class.

Used by GuiEffectVisitor to mark as @UI all anonymous inner classes which: inherit from a PolyUIType annotated superclass, override a PolyUIEffect method from said superclass, and perform UIEffect calls inside the body of this method.

Parameters:

classElt - the TypeElement corresponding to the anonymous inner class to mark as an @UI instantiation of an UI-polymorphic superclass.