Package org.checkerframework.checker.signedness

Class SignednessAnnotatedTypeFactory

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.signedness.SignednessAnnotatedTypeFactory

All Implemented Interfaces:

AnnotationProvider

public class SignednessAnnotatedTypeFactory
extends BaseAnnotatedTypeFactory

The type factory for the Signedness Checker.

See the Checker Framework Manual:

Signedness 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.CapturedTypeVarSubstitutor, AnnotatedTypeFactory.ParameterizedExecutableType

Field Summary

Fields

Modifier and Type	Field	Description
protected final AnnotationMirror	POLY_SIGNED	The @PolySigned annotation.
protected final AnnotationMirror	SIGNED	The @Signed annotation.
protected final AnnotationMirror	SIGNED_POSITIVE	The @SignedPositive annotation.
protected final AnnotationMirror	SIGNEDNESS_BOTTOM	The @SignednessBottom annotation.
protected final AnnotationMirror	SIGNEDNESS_GLB	The @SignednessGlb annotation.
protected final AnnotationMirror	UNSIGNED	The @Unsigned annotation.

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

analysis, arraysAreRelevant, cfgVisualizer, contractsUtils, defaults, dependentTypesHelper, emptyStore, exceptionalExitStores, flowByDefault, flowResult, flowResultAnalysisCaches, formalParameterPattern, hasOrIsSubchecker, initializationStaticStore, initializationStore, poly, regularExitStores, relevantJavaTypes, returnStatementStores, scannedClasses, shouldClearSubcheckerSharedCFGs, sideEffectsUnrefineAliases, subcheckerSharedCFG, transfer, treeAnnotator, typeAnnotator

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

ajavaTypes, annotatedForValueElement, capturedTypeVarSubstitutor, checker, currentFileAjavaTypes, elements, ensuresQualifierExpressionElement, ensuresQualifierIfExpressionElement, ensuresQualifierIfListTM, ensuresQualifierIfListValueElement, ensuresQualifierIfResultElement, ensuresQualifierIfTM, ensuresQualifierListTM, ensuresQualifierListValueElement, ensuresQualifierTM, fieldInvariantFieldElement, fieldInvariantQualifierElement, fromExpressionTreeCache, fromMemberTreeCache, fromTypeTreeCache, hasQualifierParameterValueElement, ignoreRawTypeArguments, loader, methodValClassNameElement, methodValMethodNameElement, methodValParamsElement, noQualifierParameterValueElement, objectGetClass, processingEnv, qualHierarchy, qualifierUpperBounds, reflectionResolver, requiresQualifierExpressionElement, requiresQualifierListTM, requiresQualifierListValueElement, requiresQualifierTM, shouldCache, stubTypes, trees, typeArgumentInference, typeFormatter, typeHierarchy, typeInformationPresenter, types, typeVarSubstitutor, uid, viewpointAdapter

Constructor Summary

Constructors

Constructor	Description
SignednessAnnotatedTypeFactory(BaseTypeChecker checker)	Create a SignednessAnnotatedTypeFactory.

Method Summary

Modifier and Type	Method	Description
protected void	adaptGetClassReturnTypeToReceiver(AnnotatedTypeMirror.AnnotatedExecutableType getClassType, AnnotatedTypeMirror receiverType, ExpressionTree tree)	Java special-cases the return type of getClass().
protected void	addAnnotationsFromDefaultForType(@Nullable Element element, AnnotatedTypeMirror type)	Adds default qualifiers based on the underlying type of type to type.
protected void	addComputedTypeAnnotations(Tree tree, AnnotatedTypeMirror type)	Changes annotations on a type obtained from a Tree.
AnnotationMirrorSet	annotationsForIrrelevantJavaType(TypeMirror tm)	Returns the annotations that should appear on the given irrelevant Java type.
protected QualifierPolymorphism	createQualifierPolymorphism()	Creates the QualifierPolymorphism instance which supports the QualifierPolymorphism mechanism.
protected TreeAnnotator	createTreeAnnotator()	Returns a TreeAnnotator that adds annotations to a type based on the contents of a tree.
AnnotationMirrorSet	getNarrowedAnnotations(AnnotationMirrorSet annos, TypeKind typeKind, TypeKind narrowedTypeKind)	Returns annotations applicable to type narrowedTypeKind, that are copied or adapted from annos.
AnnotationMirrorSet	getWidenedAnnotations(AnnotationMirrorSet annos, TypeKind typeKind, TypeKind widenedTypeKind)	Returns annotations applicable to type widenedTypeKind, that are copied or adapted from annos.
boolean	maybeIntegral(AnnotatedTypeMirror type)	Returns true if type's underlying type might be integral: it is a number, char, or a supertype of them.

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

createFlowAnalysis

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

addCheckedCodeDefaults, addCheckedStandardDefaults, addComputedTypeAnnotations, addComputedTypeAnnotations, addComputedTypeAnnotationsWithoutFlow, addDefaultAnnotations, addSharedCFGForTree, addUncheckedStandardDefaults, analyze, applyInferredAnnotations, applyQualifierParameterDefaults, applyQualifierParameterDefaults, checkAndPerformFlowAnalysis, checkForDefaultQualifierInHierarchy, constructorFromUse, constructorFromUsePreSubstitution, createAndInitQualifierDefaults, createCFGVisualizer, createContractsFromMethod, createDefaultForTypeAnnotator, createDefaultForUseTypeAnnotator, createDependentTypesHelper, createFlowTransferFunction, createQualifierDefaults, createRequiresOrEnsuresQualifier, createTypeAnnotator, getAnnotatedTypeBefore, getAnnotatedTypeLhs, getAnnotatedTypeLhsNoTypeVarDefault, getAnnotatedTypeRhsUnaryAssign, getAnnotatedTypeVarargsArray, getAnnotationFromJavaExpression, getAnnotationFromJavaExpressionString, getAnnotationMirrorFromJavaExpressionString, getAnnotationsFromJavaExpression, getCFGVisualizer, getContractExpressions, getContractsFromMethod, getDefaultAnnotations, getDefaultForTypeAnnotator, getDefaultValueAnnotatedType, getDependentTypesHelper, getEmptyStore, getEnsuresQualifierIfResult, getExceptionalExitStore, getExplicitNewClassAnnos, getExplicitNewClassClassTypeArgs, getExpressionAndOffsetFromJavaExpressionString, getFinalLocalValues, getFirstNodeOfKindForTree, getInferredValueFor, getMethodReturnType, getNodesForTree, getQualifierPolymorphism, getRegularExitStore, getReturnStatementStores, getSharedCFGForTree, getShouldDefaultTypeVarLocals, getSortedQualifierNames, getStoreAfter, getStoreAfter, getStoreAfter, getStoreBefore, getStoreBefore, getStoreBefore, getSupportedMonotonicTypeQualifiers, getTypeFactoryOfSubchecker, getTypeFactoryOfSubcheckerOrNull, getUseFlow, handleCFGViz, irrelevantExtraMessage, isComputingAnnotatedTypeMirrorOfLhs, isIgnoredExceptionType, isNotFullyInitializedReceiver, isRelevant, isRelevant, isRelevantImpl, methodFromUse, methodFromUsePreSubstitution, parseJavaExpressionString, performFlowAnalysis, postAnalyze, postAsMemberOf, postDirectSuperTypes, postInit, preProcessClassTree, setRoot, typeVariablesFromUse

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

addAliasedDeclAnnotation, addAliasedDeclAnnotation, addAliasedTypeAnnotation, addAliasedTypeAnnotation, addAliasedTypeAnnotation, addAliasedTypeAnnotation, addAnnotationFromFieldInvariant, addInheritedAnnotation, applyCaptureConversion, applyCaptureConversion, applyUnboxing, areSameByClass, binaryTreeArgTypes, binaryTreeArgTypes, canonicalAnnotation, compoundAssignmentTreeArgTypes, constructorFromUse, constructorFromUseWithoutTypeArgInference, containsCapturedTypes, containsSameByClass, createAnnotatedTypeFormatter, createAnnotationClassLoader, createAnnotationFormatter, createQualifierHierarchy, createQualifierUpperBounds, createSupportedTypeQualifiers, createTypeArgumentInference, createTypeHierarchy, createTypeInformationPresenter, createTypeVariableSubstitutor, createViewpointAdapter, declarationFromElement, doesAnnotatedForApplyToThisChecker, fromElement, fromElement, fromElement, getAnnotatedNullType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedType, getAnnotatedTypeFormatter, getAnnotatedTypeFromTypeTree, getAnnotationByClass, getAnnotationFormatter, getAnnotationMirror, getAnnotationOrTypeDeclarationBound, getAnnotationWithMetaAnnotation, getBoxedType, getBundledTypeQualifiers, getCacheSize, getChecker, getCheckerNames, getContractExpressions, getContractListValues, getDeclAnnotation, getDeclAnnotationNoAliases, getDeclAnnotations, getDeclAnnotationWithMetaAnnotation, getDefaultTypeDeclarationBounds, getDummyAssignedTo, getElementUtils, getEnclosingClassOrMethod, getEnclosingSubType, getEnclosingType, getEnumConstructorQualifiers, getExpressionAndOffset, getFieldInvariantAnnotationTree, getFieldInvariantDeclarationAnnotations, getFieldInvariants, getFnInterfaceFromTree, getFunctionTypeFromTree, getFunctionTypeFromTree, getImplicitReceiverType, getIterableElementType, getIterableElementType, getMethodReturnType, getNarrowedPrimitive, getPath, getProcessingEnv, getQualifierHierarchy, getQualifierParameterHierarchies, getQualifierParameterHierarchies, getQualifierUpperBounds, getReceiverType, getResultingTypeOfConstructorMemberReference, getRoot, getSelfType, getStringType, getSupportedTypeQualifierNames, getSupportedTypeQualifiers, getTreeUtils, getTypeArgumentInference, getTypeDeclarationBounds, getTypeHierarchy, getTypeOfExtendsImplements, getTypeVarSubstitutor, getUnboxedType, getVisitorTreePath, getWidenedType, getWidenedType, hasExplicitNoQualifierParameterInHierarchy, hasExplicitQualifierParameterInHierarchy, hasQualifierParameterInHierarchy, hasQualifierParameterInHierarchy, initializeAtm, initializeReflectionResolution, isDeterministic, isFromByteCode, isFromStubFile, isImmutable, isSideEffectFree, isSupportedQualifier, isSupportedQualifier, isSupportedQualifier, isWithinConstructor, mergeAnnotationFileAnnosIntoType, methodFromUse, methodFromUse, methodFromUse, methodFromUseWithoutTypeArgInference, methodFromUseWithoutTypeArgInference, negateConstant, order, parseAnnotationFiles, postProcessClassTree, replaceAnnotations, replaceAnnotations, setPathForArtificialTree, setVisitorTreePath, shouldWarnIfStubRedundantWithBytecode, toAnnotatedType, toString, type

Methods inherited from class java.lang.Object

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

Field Details

SIGNED

protected final AnnotationMirror SIGNED

The @Signed annotation.

UNSIGNED

protected final AnnotationMirror UNSIGNED

The @Unsigned annotation.

SIGNEDNESS_GLB

protected final AnnotationMirror SIGNEDNESS_GLB

The @SignednessGlb annotation. Do not use @SignedPositive; use this instead.

SIGNED_POSITIVE

protected final AnnotationMirror SIGNED_POSITIVE

The @SignedPositive annotation.

SIGNEDNESS_BOTTOM

protected final AnnotationMirror SIGNEDNESS_BOTTOM

The @SignednessBottom annotation.

POLY_SIGNED

protected final AnnotationMirror POLY_SIGNED

The @PolySigned annotation.

Constructor Details

SignednessAnnotatedTypeFactory

public SignednessAnnotatedTypeFactory(BaseTypeChecker checker)

Create a SignednessAnnotatedTypeFactory.

Parameters:

checker - the type-checker associated with this type factory

Method Details

addComputedTypeAnnotations

protected void addComputedTypeAnnotations(Tree tree,
 AnnotatedTypeMirror type)

Description copied from class: GenericAnnotatedTypeFactory

Changes annotations on a type obtained from a Tree. By default, this method does nothing. GenericAnnotatedTypeFactory uses this method to implement defaulting and inference (flow-sensitive type refinement). Its subclasses usually override it only to customize default annotations.

Subclasses that override this method should also override AnnotatedTypeFactory.addComputedTypeAnnotations(Element, AnnotatedTypeMirror).

This method adds defaults and flow-sensitive type refinements.

Overrides:

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

Parameters:

tree - an AST node

type - the type obtained from tree

See Also:

• GenericAnnotatedTypeFactory.addComputedTypeAnnotationsWithoutFlow(Tree, AnnotatedTypeMirror)

getWidenedAnnotations

public AnnotationMirrorSet getWidenedAnnotations(AnnotationMirrorSet annos,
 TypeKind typeKind,
 TypeKind widenedTypeKind)

Description copied from class: AnnotatedTypeFactory

Returns annotations applicable to type widenedTypeKind, that are copied or adapted from annos.

Overrides:

getWidenedAnnotations in class AnnotatedTypeFactory

Parameters:

annos - annotations to widen, from a primitive or boxed primitive

typeKind - primitive type to widen

widenedTypeKind - target for the returned annotations; a primitive type that is wider than typeKind (in the sense of JLS 5.1.2)

Returns:

result of converting annos from typeKind to widenedTypeKind

getNarrowedAnnotations

public AnnotationMirrorSet getNarrowedAnnotations(AnnotationMirrorSet annos,
 TypeKind typeKind,
 TypeKind narrowedTypeKind)

Description copied from class: AnnotatedTypeFactory

Returns annotations applicable to type narrowedTypeKind, that are copied or adapted from annos.

Overrides:

getNarrowedAnnotations in class AnnotatedTypeFactory

Parameters:

annos - annotations to narrow, from a primitive or boxed primitive

typeKind - primitive type to narrow

narrowedTypeKind - target for the returned annotations; a primitive type that is narrower than typeKind (in the sense of JLS 5.1.3).

Returns:

result of converting annos from typeKind to narrowedTypeKind

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

annotationsForIrrelevantJavaType

public AnnotationMirrorSet annotationsForIrrelevantJavaType(TypeMirror tm)

Description copied from class: GenericAnnotatedTypeFactory

Returns the annotations that should appear on the given irrelevant Java type. If the type is relevant, this method's behavior is undefined.

Overrides:

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

Parameters:

tm - an irrelevant Java type

Returns:

the annotations that should appear on the given irrelevant Java type

maybeIntegral

public boolean maybeIntegral(AnnotatedTypeMirror type)

Returns true if type's underlying type might be integral: it is a number, char, or a supertype of them.

Parameters:

type - a type

Returns:

true if type's underlying type might be integral

adaptGetClassReturnTypeToReceiver

protected void adaptGetClassReturnTypeToReceiver(AnnotatedTypeMirror.AnnotatedExecutableType getClassType,
 AnnotatedTypeMirror receiverType,
 ExpressionTree tree)

Description copied from class: AnnotatedTypeFactory

Java special-cases the return type of getClass(). Though the method has a return type of Class<?>, the compiler special cases this return-type and changes the bound of the type argument to the erasure of the receiver type. For example:

• x.getClass() has the type Class< ? extends erasure_of_x >
• someInteger.getClass() has the type Class< ? extends Integer >

Overrides:

adaptGetClassReturnTypeToReceiver in class AnnotatedTypeFactory

Parameters:

getClassType - this must be a type representing a call to Object.getClass otherwise a runtime exception will be thrown. It is modified by side effect.

receiverType - the receiver type of the method invocation (not the declared receiver type)

tree - getClass method invocation tree

addAnnotationsFromDefaultForType

protected void addAnnotationsFromDefaultForType(@Nullable Element element,
 AnnotatedTypeMirror type)

Description copied from class: GenericAnnotatedTypeFactory

Adds default qualifiers based on the underlying type of type to type. If element is a local variable, or if the type already has an annotation from the relevant type hierarchy, then the defaults are not added.

(This uses both the DefaultQualifierForUseTypeAnnotator and DefaultForTypeAnnotator.)

Overrides:

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

Parameters:

element - possibly null element whose type is type

type - the type to which defaults are added

createQualifierPolymorphism

protected QualifierPolymorphism createQualifierPolymorphism()

Description copied from class: GenericAnnotatedTypeFactory

Creates the QualifierPolymorphism instance which supports the QualifierPolymorphism mechanism.

Overrides:

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

Returns:

the QualifierPolymorphism instance to use