org.checkerframework.checker.index.upperbound

Class UpperBoundAnnotatedTypeFactory

java.lang.Object

org.checkerframework.framework.type.AnnotatedTypeFactory

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

org.checkerframework.common.basetype.BaseAnnotatedTypeFactory

org.checkerframework.checker.index.upperbound.UpperBoundAnnotatedTypeFactory

All Implemented Interfaces:

org.checkerframework.javacutil.AnnotationProvider

public class UpperBoundAnnotatedTypeFactory
extends org.checkerframework.common.basetype.BaseAnnotatedTypeFactory

Implements the introduction rules for the Upper Bound Checker.

Rules implemented by this class:

• 1. Math.min has unusual semantics that combines annotations for the UBC.
• 2. The return type of Random.nextInt depends on the argument, but is not equal to it, so a polymorhpic qualifier is insufficient.
• 3. Unary negation on a NegativeIndexFor (from the SearchIndex Checker) results in a LTLengthOf for the same arrays.
• 4. Right shifting by a constant between 0 and 30 preserves the type of the left side expression.
• 5. If either argument to a bitwise and expression is non-negative, the and expression retains that argument's upperbound type. If both are non-negative, the result of the expression is the GLB of the two.
• 6. if numerator ≥ 0, then numerator % divisor ≤ numerator
• 7. if divisor ≥ 0, then numerator % divisor < divisor
• 8. If the numerator is an array length access of an array with non-zero length, and the divisor is greater than one, glb the result with an LTL of the array.
• 9. if numeratorTree is a + b and divisor greater than 1, and a and b are less than the length of some sequence, then (a + b) / divisor is less than the length of that sequence.
• 10. Special handling for Math.random: Math.random() * array.length is LTL array.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	UpperBoundAnnotatedTypeFactory.UpperBoundQualifierHierarchy The qualifier hierarchy for the upperbound type system.
protected class	UpperBoundAnnotatedTypeFactory.UpperBoundTreeAnnotator

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

org.checkerframework.framework.type.GenericAnnotatedTypeFactory.ScanState

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

org.checkerframework.framework.type.AnnotatedTypeFactory.InheritedFromClassAnnotator

Field Summary

Fields

Modifier and Type	Field and Description
AnnotationMirror	BOTTOM
AnnotationMirror	POLY
AnnotationMirror	UNKNOWN

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

analysis, cfgVisualizer, defaults, dependentTypesHelper, emptyStore, FLOW_BY_DEFAULT, 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, processingEnv, qualHierarchy, reflectionResolver, root, shouldCache, trees, typeArgumentInference, typeFormatter, typeHierarchy, types, typeVarSubstitutor, uid, visitorState

Constructor Summary

Constructors

Constructor and Description
UpperBoundAnnotatedTypeFactory(org.checkerframework.common.basetype.BaseTypeChecker checker)

Method Summary

Modifier and Type	Method and Description
void	addComputedTypeAnnotations(Element element, org.checkerframework.framework.type.AnnotatedTypeMirror type)
void	addComputedTypeAnnotations(Tree tree, org.checkerframework.framework.type.AnnotatedTypeMirror type, boolean iUseFlow)
AnnotationMirror	convertUBQualifierToAnnotation(UBQualifier qualifier)
protected org.checkerframework.framework.util.dependenttypes.DependentTypesHelper	createDependentTypesHelper()
org.checkerframework.framework.type.QualifierHierarchy	createQualifierHierarchy(org.checkerframework.framework.util.MultiGraphQualifierHierarchy.MultiGraphFactory factory)
protected Set<Class<? extends Annotation>>	createSupportedTypeQualifiers()
org.checkerframework.framework.type.treeannotator.TreeAnnotator	createTreeAnnotator()
protected org.checkerframework.framework.type.typeannotator.TypeAnnotator	createTypeAnnotator()
LessThanAnnotatedTypeFactory	getLessThanAnnotatedTypeFactory() Returns the LessThan Checker's annotated type factory.
boolean	hasLowerBoundTypeByClass(org.checkerframework.dataflow.cfg.node.Node node, Class<? extends Annotation> classOfType) Returns true iff the given node has the passed Lower Bound qualifier according to the LBC.
boolean	isMathMin(Tree methodTree)
boolean	isRandomNextInt(Tree methodTree)
AnnotationMirror	sameLenAnnotationFromTree(Tree tree) Queries the SameLen Checker to return the type that the SameLen Checker associates with the given tree.

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

createFlowAnalysis

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

addCheckedCodeDefaults, addCheckedStandardDefaults, addComputedTypeAnnotations, addDefaultAnnotations, addTypeNameImplicit, addUncheckedCodeDefaults, addUncheckedStandardDefaults, analyze, applyInferredAnnotations, checkAndPerformFlowAnalysis, checkForDefaultQualifierInHierarchy, constructorFromUse, createAndInitQualifierDefaults, createCFGVisualizer, createFlowTransferFunction, createQualifierDefaults, createQualifierPolymorphism, fromNewClass, getAnnotatedTypeLhs, getAnnotatedTypeLhsNoTypeVarDefault, getAnnotatedTypeRhsUnaryAssign, getAnnotatedTypeVarargsArray, getAnnotationFromJavaExpressionString, getAnnotationFromReceiver, getAnnotationMirrorFromJavaExpressionString, getCFGVisualizer, getDependentTypesHelper, getEmptyStore, getFinalLocalValues, getFirstNodeOfKindForTree, getInferredValueFor, getMethodReturnType, getMethodReturnType, getNodesForTree, 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, aliasedAnnotation, annotateInheritedFromClass, annotateInheritedFromClass, checkInvalidOptionsInferSignatures, createAnnotatedTypeFormatter, createAnnotationClassLoader, createAnnotationFormatter, createQualifierHierarchy, createQualifierHierarchy, createQualifierHierarchyFactory, createTypeArgumentInference, createTypeHierarchy, createTypeVariableSubstitutor, declarationFromElement, fromElement, fromElement, fromElement, getAnnotatedNullType, getAnnotatedType, 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, getEnclosingMethod, getEnclosingType, getFieldInvariantAnnotationTree, getFieldInvariantDeclarationAnnotations, getFieldInvariants, getFnInterfaceFromTree, getFnInterfaceFromTree, getImplicitReceiverType, getNarrowedPrimitive, getPath, getProcessingEnv, getQualifierHierarchy, getReceiverType, getSelfType, getStringType, getSupportedTypeQualifiers, getTreeUtils, getTypeArgumentInference, getTypeHierarchy, getTypeVarSubstitutor, getUnboxedType, getUninferredWildcardType, getVisitorState, getWholeProgramInference, initializeReflectionResolution, isAnyEnclosingThisDeref, isFromByteCode, isFromStubFile, isMostEnclosingThisDeref, isSupportedQualifier, isWithinConstructor, methodFromUse, parseStubFiles, postAsMemberOf, postProcessClassTree, postTypeVarSubstitution, setPathHack, toAnnotatedType, toString, type, widenToUpperBound

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN

public final AnnotationMirror UNKNOWN

BOTTOM

public final AnnotationMirror BOTTOM

POLY

public final AnnotationMirror POLY

Constructor Detail

UpperBoundAnnotatedTypeFactory

public UpperBoundAnnotatedTypeFactory(org.checkerframework.common.basetype.BaseTypeChecker checker)

Method Detail

createSupportedTypeQualifiers

protected Set<Class<? extends Annotation>> createSupportedTypeQualifiers()

Overrides:

createSupportedTypeQualifiers in class org.checkerframework.framework.type.AnnotatedTypeFactory

getLessThanAnnotatedTypeFactory

public LessThanAnnotatedTypeFactory getLessThanAnnotatedTypeFactory()

Returns the LessThan Checker's annotated type factory.

addComputedTypeAnnotations

public void addComputedTypeAnnotations(Element element,
                                       org.checkerframework.framework.type.AnnotatedTypeMirror type)

Overrides:

addComputedTypeAnnotations in class org.checkerframework.framework.type.GenericAnnotatedTypeFactory<org.checkerframework.framework.flow.CFValue,org.checkerframework.framework.flow.CFStore,org.checkerframework.framework.flow.CFTransfer,org.checkerframework.framework.flow.CFAnalysis>

addComputedTypeAnnotations

public void addComputedTypeAnnotations(Tree tree,
                                       org.checkerframework.framework.type.AnnotatedTypeMirror type,
                                       boolean iUseFlow)

Overrides:

addComputedTypeAnnotations in class org.checkerframework.framework.type.GenericAnnotatedTypeFactory<org.checkerframework.framework.flow.CFValue,org.checkerframework.framework.flow.CFStore,org.checkerframework.framework.flow.CFTransfer,org.checkerframework.framework.flow.CFAnalysis>

createTypeAnnotator

protected org.checkerframework.framework.type.typeannotator.TypeAnnotator createTypeAnnotator()

Overrides:

createTypeAnnotator in class org.checkerframework.framework.type.GenericAnnotatedTypeFactory<org.checkerframework.framework.flow.CFValue,org.checkerframework.framework.flow.CFStore,org.checkerframework.framework.flow.CFTransfer,org.checkerframework.framework.flow.CFAnalysis>

createDependentTypesHelper

protected org.checkerframework.framework.util.dependenttypes.DependentTypesHelper createDependentTypesHelper()

Overrides:

createDependentTypesHelper in class org.checkerframework.framework.type.GenericAnnotatedTypeFactory<org.checkerframework.framework.flow.CFValue,org.checkerframework.framework.flow.CFStore,org.checkerframework.framework.flow.CFTransfer,org.checkerframework.framework.flow.CFAnalysis>

sameLenAnnotationFromTree

public AnnotationMirror sameLenAnnotationFromTree(Tree tree)

Queries the SameLen Checker to return the type that the SameLen Checker associates with the given tree.

isMathMin

public boolean isMathMin(Tree methodTree)

isRandomNextInt

public boolean isRandomNextInt(Tree methodTree)

hasLowerBoundTypeByClass

public boolean hasLowerBoundTypeByClass(org.checkerframework.dataflow.cfg.node.Node node,
                                        Class<? extends Annotation> classOfType)

Returns true iff the given node has the passed Lower Bound qualifier according to the LBC. The last argument should be Positive.class, NonNegative.class, or GTENegativeOne.class.

createQualifierHierarchy

public org.checkerframework.framework.type.QualifierHierarchy createQualifierHierarchy(org.checkerframework.framework.util.MultiGraphQualifierHierarchy.MultiGraphFactory factory)

Overrides:

createQualifierHierarchy in class org.checkerframework.framework.type.AnnotatedTypeFactory

createTreeAnnotator

public org.checkerframework.framework.type.treeannotator.TreeAnnotator createTreeAnnotator()

Overrides:

createTreeAnnotator in class org.checkerframework.framework.type.GenericAnnotatedTypeFactory<org.checkerframework.framework.flow.CFValue,org.checkerframework.framework.flow.CFStore,org.checkerframework.framework.flow.CFTransfer,org.checkerframework.framework.flow.CFAnalysis>

convertUBQualifierToAnnotation

public AnnotationMirror convertUBQualifierToAnnotation(UBQualifier qualifier)