Package org.checkerframework.framework.flow

Class CFAnalysis

java.lang.Object

org.checkerframework.dataflow.analysis.AbstractAnalysis<V,S,T>

org.checkerframework.dataflow.analysis.ForwardAnalysisImpl<V,S,T>

org.checkerframework.framework.flow.CFAbstractAnalysis<CFValue,CFStore,CFTransfer>

org.checkerframework.framework.flow.CFAnalysis

All Implemented Interfaces:

Analysis<CFValue,CFStore,CFTransfer>, ForwardAnalysis<CFValue,CFStore,CFTransfer>

Direct Known Subclasses:

CalledMethodsAnalysis

public class CFAnalysis
extends CFAbstractAnalysis<CFValue,CFStore,CFTransfer>

The default org.checkerframework.dataflow analysis used in the Checker Framework.

Nested Class Summary

Nested classes/interfaces inherited from class org.checkerframework.framework.flow.CFAbstractAnalysis

CFAbstractAnalysis.FieldInitialValue<V extends CFAbstractValue<V>>

Nested classes/interfaces inherited from class org.checkerframework.dataflow.analysis.AbstractAnalysis

AbstractAnalysis.Worklist

Nested classes/interfaces inherited from interface org.checkerframework.dataflow.analysis.Analysis

Analysis.BeforeOrAfter, Analysis.Direction

Field Summary

Fields inherited from class org.checkerframework.framework.flow.CFAbstractAnalysis

atypeFactory, checker, dependentTypesHelper, env, fieldValues, qualHierarchy, typeHierarchy, types

Fields inherited from class org.checkerframework.dataflow.analysis.ForwardAnalysisImpl

blockCount, elseStores, maxCountBeforeWidening, storesAtReturnStatements, thenStores

Fields inherited from class org.checkerframework.dataflow.analysis.AbstractAnalysis

cfg, currentInput, currentNode, currentTree, direction, finalLocalValues, inputs, isRunning, nodeValues, transferFunction, worklist

Constructor Summary

Constructors

Constructor	Description
CFAnalysis(BaseTypeChecker checker, GenericAnnotatedTypeFactory<CFValue,CFStore,CFTransfer,CFAnalysis> factory)	Creates a new CFAnalysis.

Method Summary

Modifier and Type	Method	Description
CFValue	createAbstractValue(AnnotationMirrorSet annotations, TypeMirror underlyingType)	Returns an abstract value containing the given annotations and underlyingType.
CFStore	createCopiedStore(CFStore s)	Returns an identical copy of the store s.
CFStore	createEmptyStore(boolean sequentialSemantics)	Returns an empty store of the appropriate type.

Methods inherited from class org.checkerframework.framework.flow.CFAbstractAnalysis

createAbstractValue, createSingleAnnotationValue, createTransferFunction, defaultCreateAbstractValue, getEnv, getFieldInitialValues, getTypeFactory, getTypeHierarchy, getTypes, performAnalysis

Methods inherited from class org.checkerframework.dataflow.analysis.ForwardAnalysisImpl

addStoreBefore, callTransferFunction, getInput, getInputBefore, getReturnStatementStores, getStoreBefore, initFields, initInitialInputs, performAnalysis, performAnalysisBlock, propagateStoresTo, runAnalysisFor

Methods inherited from class org.checkerframework.dataflow.analysis.AbstractAnalysis

addToWorklist, getContainingClass, getContainingMethod, getCurrentTree, getDirection, getExceptionalExitStore, getNodesForTree, getNodeValues, getRegularExitStore, getResult, getTransferFunction, getValue, getValue, init, isIgnoredExceptionType, isRunning, readFromStore, setCurrentNode, setCurrentTree, updateNodeValues

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.checkerframework.dataflow.analysis.Analysis

getDirection, getExceptionalExitStore, getRegularExitStore, getResult, getTransferFunction, getValue, getValue, isRunning

Constructor Details

CFAnalysis

public CFAnalysis(BaseTypeChecker checker,
 GenericAnnotatedTypeFactory<CFValue,CFStore,CFTransfer,CFAnalysis> factory)

Creates a new CFAnalysis.

Parameters:

checker - the checker

factory - the factory

Method Details

createEmptyStore

public CFStore createEmptyStore(boolean sequentialSemantics)

Description copied from class: CFAbstractAnalysis

Returns an empty store of the appropriate type.

Specified by:

createEmptyStore in class CFAbstractAnalysis<CFValue,CFStore,CFTransfer>

Returns:

an empty store of the appropriate type

createCopiedStore

public CFStore createCopiedStore(CFStore s)

Description copied from class: CFAbstractAnalysis

Returns an identical copy of the store s.

Specified by:

createCopiedStore in class CFAbstractAnalysis<CFValue,CFStore,CFTransfer>

Returns:

an identical copy of the store s

createAbstractValue

public CFValue createAbstractValue(AnnotationMirrorSet annotations,
 TypeMirror underlyingType)

Description copied from class: CFAbstractAnalysis

Returns an abstract value containing the given annotations and underlyingType. Returns null if the annotation set has missing annotations.

Specified by:

createAbstractValue in class CFAbstractAnalysis<CFValue,CFStore,CFTransfer>

Parameters:

annotations - the annotations for the result annotated type

underlyingType - the unannotated type for the result annotated type

Returns:

an abstract value containing the given annotations and underlyingType