org.checkerframework.checker.index.lowerbound

Class LowerBoundAnnotatedTypeFactory

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.lowerbound.LowerBoundAnnotatedTypeFactory

All Implemented Interfaces:

org.checkerframework.javacutil.AnnotationProvider

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

Implements the introduction rules for the Lower Bound Checker.

  The type hierarchy is:

  Top = lbu ("Lower Bound Unknown")
   |
  gte-1 ("Greater than or equal to -1")
   |
  nn  ("NonNegative")
   |
  pos ("Positive")
  

In general, check whether the constant Value Checker can determine the value of a variable; if it can, use that; if not, use more specific rules based on expression type. This class implements the following type rules:

• 1. If the value checker type for any expression is ≥ 1, refine that expression's type to positive.
• 2. If the value checker type for any expression is ≥ 0 and case 1 did not apply, then refine that expression's type to non-negative.
• 3. If the value checker type for any expression is ≥ -1 and cases 1 and 2 did not apply, then refine that expression's type to GTEN1.
• 4. A unary prefix decrement shifts the type "down" in the hierarchy (i.e. --i when i is non-negative implies that i will be GTEN1 afterwards). Should this be 3 rules?
• 5. A unary prefix increment shifts the type "up" in the hierarchy (i.e. ++i when i is non-negative implies that i will be positive afterwards). Should this be 3 rules?
• 6. Unary negation on a NegativeIndexFor from the SearchIndex type system results in a non-negative.
• 7. The result of a call to Math.max is the GLB of its arguments.
• 8. If an array has a MinLen type ≥ 1 and its length is accessed, the length expression is positive.

Nested Class Summary

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, org.checkerframework.framework.type.AnnotatedTypeFactory.ParameterizedMethodType

Field Summary

Fields

Modifier and Type	Field and Description
AnnotationMirror	BOTTOM The bottom annotation.
AnnotationMirror	GTEN1 The canonical @GTENegativeOne annotation.
AnnotationMirror	NN The canonical @NonNegative annotation.
AnnotationMirror	POLY The canonical @PolyLowerBound annotation.
AnnotationMirror	POS The canonical @Positive annotation.
AnnotationMirror	UNKNOWN The canonical @LowerBoundUnknown annotation.

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, processingEnv, qualHierarchy, reflectionResolver, root, shouldCache, trees, typeArgumentInference, typeFormatter, typeHierarchy, types, typeVarSubstitutor, uid, visitorState

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addComputedTypeAnnotations(Element element, org.checkerframework.framework.type.AnnotatedTypeMirror type) Handles cases 1, 2, and 3.
void	addComputedTypeAnnotations(Tree tree, org.checkerframework.framework.type.AnnotatedTypeMirror type, boolean iUseFlow) Handles cases 1, 2, and 3.
protected Set<Class<? extends Annotation>>	createSupportedTypeQualifiers()
org.checkerframework.framework.type.treeannotator.TreeAnnotator	createTreeAnnotator()
LessThanAnnotatedTypeFactory	getLessThanAnnotatedTypeFactory() Returns the LessThan Checker's annotated type factory.
SearchIndexAnnotatedTypeFactory	getSearchIndexAnnotatedTypeFactory() Returns the SearchIndexFor Checker's annotated type factory.
org.checkerframework.common.value.ValueAnnotatedTypeFactory	getValueAnnotatedTypeFactory() Returns the Value Checker's annotated type factory.
boolean	isNonNegative(Tree tree) Checks if the expression is non-negative, i.e.

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, createDependentTypesHelper, createFlowTransferFunction, createQualifierDefaults, createQualifierPolymorphism, createTypeAnnotator, fromNewClass, getAnnotatedTypeLhs, getAnnotatedTypeLhsNoTypeVarDefault, getAnnotatedTypeRhsUnaryAssign, getAnnotatedTypeVarargsArray, getAnnotationFromJavaExpressionString, getAnnotationFromReceiver, getAnnotationMirrorFromJavaExpressionString, getCFGVisualizer, getDependentTypesHelper, getEmptyStore, getFinalLocalValues, getFirstNodeOfKindForTree, getInferredValueFor, getMethodReturnType, getMethodReturnType, getNodesForTree, getQualifierPolymorphism, 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, 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

GTEN1

public final AnnotationMirror GTEN1

The canonical @GTENegativeOne annotation.

NN

public final AnnotationMirror NN

The canonical @NonNegative annotation.

POS

public final AnnotationMirror POS

The canonical @Positive annotation.

BOTTOM

public final AnnotationMirror BOTTOM

The bottom annotation.

UNKNOWN

public final AnnotationMirror UNKNOWN

The canonical @LowerBoundUnknown annotation.

POLY

public final AnnotationMirror POLY

The canonical @PolyLowerBound annotation.

Constructor Detail

LowerBoundAnnotatedTypeFactory

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

Method Detail

createSupportedTypeQualifiers

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

Overrides:

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

addComputedTypeAnnotations

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

Handles cases 1, 2, and 3.

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)

Handles cases 1, 2, and 3.

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>

getValueAnnotatedTypeFactory

public org.checkerframework.common.value.ValueAnnotatedTypeFactory getValueAnnotatedTypeFactory()

Returns the Value Checker's annotated type factory.

getSearchIndexAnnotatedTypeFactory

public SearchIndexAnnotatedTypeFactory getSearchIndexAnnotatedTypeFactory()

Returns the SearchIndexFor Checker's annotated type factory.

getLessThanAnnotatedTypeFactory

public LessThanAnnotatedTypeFactory getLessThanAnnotatedTypeFactory()

Returns the LessThan Checker's annotated type factory.

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>

isNonNegative

public boolean isNonNegative(Tree tree)

Checks if the expression is non-negative, i.e. it has Positive on NonNegative annotation.