org.checkerframework.checker.index.samelen

Class SameLenAnnotatedTypeFactory

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.samelen.SameLenAnnotatedTypeFactory

All Implemented Interfaces:

org.checkerframework.javacutil.AnnotationProvider

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

The SameLen Checker is used to determine whether there are multiple fixed-length sequences (such as arrays or strings) in a program that share the same length. It is part of the Index Checker, and is used as a subchecker by the Index Checker's components.

This annotated type factory refines types in X cases:

• 1. @PolyAll and @PolyLength are refined to @PolySameLen .
• 2. If a variable is declared with a user-written @SameLen annotation, then the type of the new variable is the union of the user-written arrays in the annotation and the arrays listed in the SameLen types of each of those arrays.
• 3. The greatest lower bound of two SameLen annotations is the union of the two sets of arrays.
• 4. The least upper bound of two SameLen annotations is the intersection of the two sets of arrays.
• 5. The type of an expression of the form new T[a.length] is the union of the SameLen type of a and the arrays listed in a's SameLen type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SameLenAnnotatedTypeFactory.SameLenTreeAnnotator SameLen needs a tree annotator in order to properly type the right side of assignments of new arrays that are initialized with the length of another array.

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	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
SameLenAnnotatedTypeFactory(org.checkerframework.common.basetype.BaseTypeChecker checker) Handles case 1.

Method Summary

Modifier and Type	Method and Description
AnnotationMirror	createCombinedSameLen(org.checkerframework.dataflow.analysis.FlowExpressions.Receiver rec1, org.checkerframework.dataflow.analysis.FlowExpressions.Receiver rec2, AnnotationMirror a1, AnnotationMirror a2) Combines the given arrays and annotations into a single SameLen annotation.
AnnotationMirror	createCombinedSameLen(List<org.checkerframework.dataflow.analysis.FlowExpressions.Receiver> receivers, List<AnnotationMirror> annos) For the use of the transfer function; generates a SameLen that includes a and b, as well as everything in sl1 and sl2, if they are SameLen annotations.
org.checkerframework.framework.type.QualifierHierarchy	createQualifierHierarchy(org.checkerframework.framework.util.MultiGraphQualifierHierarchy.MultiGraphFactory factory)
AnnotationMirror	createSameLen(String... val) Creates a @SameLen annotation whose values are the given strings.
protected Set<Class<? extends Annotation>>	createSupportedTypeQualifiers()
org.checkerframework.framework.type.treeannotator.TreeAnnotator	createTreeAnnotator()
org.checkerframework.framework.type.AnnotatedTypeMirror	getAnnotatedTypeLhs(Tree tree) Handles case 2.
AnnotationMirror	getCombinedSameLen(List<String> a1Names, List<String> a2Names) This function finds the union of the values of two annotations.
List<String>	getSameLensFromString(String sequenceExpression, Tree tree, TreePath currentPath) Find all the sequences that are members of the SameLen annotation associated with the sequence named in sequenceExpression along the current path.
static boolean	shouldUseInAnnotation(org.checkerframework.dataflow.analysis.FlowExpressions.Receiver receiver)

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

createFlowAnalysis

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

addCheckedCodeDefaults, addCheckedStandardDefaults, addComputedTypeAnnotations, addComputedTypeAnnotations, addComputedTypeAnnotations, addDefaultAnnotations, addTypeNameImplicit, addUncheckedCodeDefaults, addUncheckedStandardDefaults, analyze, applyInferredAnnotations, checkAndPerformFlowAnalysis, checkForDefaultQualifierInHierarchy, constructorFromUse, createAndInitQualifierDefaults, createCFGVisualizer, createDependentTypesHelper, createFlowTransferFunction, createQualifierDefaults, createQualifierPolymorphism, createTypeAnnotator, fromNewClass, 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

Constructor Detail

SameLenAnnotatedTypeFactory

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

Handles case 1.

Method Detail

createSupportedTypeQualifiers

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

Overrides:

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

createQualifierHierarchy

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

Overrides:

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

getAnnotatedTypeLhs

public org.checkerframework.framework.type.AnnotatedTypeMirror getAnnotatedTypeLhs(Tree tree)

Handles case 2.

Overrides:

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

getCombinedSameLen

public AnnotationMirror getCombinedSameLen(List<String> a1Names,
                                           List<String> a2Names)

This function finds the union of the values of two annotations. Both annotations must have a value field; otherwise the function will fail.

Returns:

the set union of the two value fields

createCombinedSameLen

public AnnotationMirror createCombinedSameLen(org.checkerframework.dataflow.analysis.FlowExpressions.Receiver rec1,
                                              org.checkerframework.dataflow.analysis.FlowExpressions.Receiver rec2,
                                              AnnotationMirror a1,
                                              AnnotationMirror a2)

Combines the given arrays and annotations into a single SameLen annotation. See createCombinedSameLen(List, List).

createCombinedSameLen

public AnnotationMirror createCombinedSameLen(List<org.checkerframework.dataflow.analysis.FlowExpressions.Receiver> receivers,
                                              List<AnnotationMirror> annos)

For the use of the transfer function; generates a SameLen that includes a and b, as well as everything in sl1 and sl2, if they are SameLen annotations.

Parameters:

receivers - a list of receivers representing arrays to be included in the combined annotation

annos - a list of the current annotations of the receivers. Must be the same length as receivers.

Returns:

a combined SameLen annotation

shouldUseInAnnotation

public static boolean shouldUseInAnnotation(org.checkerframework.dataflow.analysis.FlowExpressions.Receiver receiver)

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>

createSameLen

public AnnotationMirror createSameLen(String... val)

Creates a @SameLen annotation whose values are the given strings.

getSameLensFromString

public List<String> getSameLensFromString(String sequenceExpression,
                                          Tree tree,
                                          TreePath currentPath)

Find all the sequences that are members of the SameLen annotation associated with the sequence named in sequenceExpression along the current path.