Package org.checkerframework.checker.rlccalledmethods

Class RLCCalledMethodsVisitor

java.lang.Object

com.sun.source.util.TreeScanner<Void,Void>

com.sun.source.util.TreePathScanner<Void,Void>

org.checkerframework.framework.source.SourceVisitor<Void,Void>

org.checkerframework.common.basetype.BaseTypeVisitor<AccumulationAnnotatedTypeFactory>

org.checkerframework.common.accumulation.AccumulationVisitor

org.checkerframework.checker.calledmethods.CalledMethodsVisitor

org.checkerframework.checker.rlccalledmethods.RLCCalledMethodsVisitor

All Implemented Interfaces:

TreeVisitor<Void,Void>

public class RLCCalledMethodsVisitor
extends CalledMethodsVisitor

The visitor for the Resource Leak Checker. Responsible for checking that the rules for Owning fields are satisfied, and for checking that CreatesMustCallFor overrides are valid.

Nested Class Summary

Nested classes/interfaces inherited from class org.checkerframework.common.basetype.BaseTypeVisitor

BaseTypeVisitor.OverrideChecker

Field Summary

Fields inherited from class org.checkerframework.common.basetype.BaseTypeVisitor

assumePureGetters, atypeFactory, checker, DETERMINISTIC, IMPURE, methodTree, positions, PURE, qualHierarchy, showchecks, SIDE_EFFECT_FREE, TARGET, targetValueElement, typeHierarchy, typeValidator, unusedWhenElement, warnRedundantAnnotations

Fields inherited from class org.checkerframework.framework.source.SourceVisitor

elements, root, trees, treesWithSuppressWarnings, types

Constructor Summary

Constructors

Constructor	Description
RLCCalledMethodsVisitor(BaseTypeChecker checker)	Create the visitor.

Method Summary

Modifier and Type	Method	Description
protected RLCCalledMethodsAnnotatedTypeFactory	createTypeFactory()	Constructs an instance of the appropriate type factory for the implemented type system.
static List<String>	getCreatesMustCallForValues(ExecutableElement elt, MustCallAnnotatedTypeFactory mcAtf, RLCCalledMethodsAnnotatedTypeFactory atypeFactory)	Returns all the CreatesMustCallFor.value() elements/arguments of all @CreatesMustCallFor annotations on the given element.
protected boolean	isWpiEnabledForRLC()	Checks if WPI is enabled for the Resource Leak Checker inference.
void	processMethodTree(String className, MethodTree tree)	Type-check methodTree.
protected boolean	shouldPerformContractInference()	Should Whole Program Inference attempt to infer contract annotations? Typically, the answer is "yes" whenever WPI is enabled, but this method exists to allow subclasses to customize that behavior.
Void	visitVariable(VariableTree tree, Void p)

Methods inherited from class org.checkerframework.checker.calledmethods.CalledMethodsVisitor

checkExceptionalPostcondition, reportMethodInvocabilityError, visitAnnotation, visitMethodInvocation

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

checkAccess, checkAccessAllowed, checkArguments, checkArrayInitialization, checkConditionalPostcondition, checkConstructorInvocation, checkConstructorResult, checkContract, checkDefaultConstructor, checkExceptionParameter, checkExplicitAnnotationsOnIntersectionBounds, checkExtendsAndImplements, checkExtendsOrImplements, checkFieldInvariantDeclarations, checkMethodInvocability, checkMethodReferenceAsOverride, checkOverride, checkOverride, checkPostcondition, checkPreconditions, checkPurityAnnotations, checkQualifierParameter, checkSuperConstructorCall, checkThisConstructorCall, checkThisOrSuperConstructorCall, checkThrownExpression, checkTypeArguments, checkTypecastRedundancy, checkTypecastSafety, checkVarargs, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheckEndDiagnostic, commonAssignmentCheckEndDiagnostic, commonAssignmentCheckStartDiagnostic, contractExpressionAndType, createOverrideChecker, createTypeFactoryPublic, createTypeValidator, enclosingMemberSelect, enclosingStatement, getExceptionParameterLowerBoundAnnotations, getThrowUpperBoundAnnotations, getTypeFactory, isTypeCastSafe, isValidUse, isValidUse, isValidUse, processClassTree, reportPurityErrors, scan, setRoot, shouldSkipUses, shouldWarnAboutIrrelevantJavaTypes, skipReceiverSubtypeCheck, testAnnotationInsertion, testJointJavacJavaParserVisitor, testTypevarContainment, typeCheckVectorCopyIntoArgument, validateType, validateTypeOf, visitAnnotatedType, visitAnnotatedType, visitAssignment, visitCatch, visitClass, visitCompilationUnit, visitCompoundAssignment, visitConditionalExpression, visitEnhancedForLoop, visitIdentifier, visitInstanceOf, visitLambdaExpression, visitMemberReference, visitMethod, visitNewArray, visitNewClass, visitReturn, visitSwitchExpression17, visitThrow, visitTypeCast, visitTypeParameter, visitUnary, warnAboutIrrelevantJavaTypes, warnInvalidPolymorphicQualifier, warnInvalidPolymorphicQualifier, warnRedundantAnnotations

Methods inherited from class org.checkerframework.framework.source.SourceVisitor

visit

Methods inherited from class com.sun.source.util.TreePathScanner

getCurrentPath, scan

Methods inherited from class com.sun.source.util.TreeScanner

reduce, scan, visitAnyPattern, visitArrayAccess, visitArrayType, visitAssert, visitBinary, visitBindingPattern, visitBlock, visitBreak, visitCase, visitConstantCaseLabel, visitContinue, visitDeconstructionPattern, visitDefaultCaseLabel, visitDoWhileLoop, visitEmptyStatement, visitErroneous, visitExports, visitExpressionStatement, visitForLoop, visitIf, visitImport, visitIntersectionType, visitLabeledStatement, visitLiteral, visitMemberSelect, visitModifiers, visitModule, visitOpens, visitOther, visitPackage, visitParameterizedType, visitParenthesized, visitPatternCaseLabel, visitPrimitiveType, visitProvides, visitRequires, visitStringTemplate, visitSwitch, visitSwitchExpression, visitSynchronized, visitTry, visitUnionType, visitUses, visitWhileLoop, visitWildcard, visitYield

Methods inherited from class java.lang.Object

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

Constructor Details

RLCCalledMethodsVisitor

public RLCCalledMethodsVisitor(BaseTypeChecker checker)

Create the visitor.

Parameters:

checker - the type-checker associated with this visitor

Method Details

createTypeFactory

protected RLCCalledMethodsAnnotatedTypeFactory createTypeFactory()

Description copied from class: BaseTypeVisitor

Constructs an instance of the appropriate type factory for the implemented type system.

The default implementation uses the checker naming convention to create the appropriate type factory. If no factory is found, it returns BaseAnnotatedTypeFactory. It reflectively invokes the constructor that accepts this checker and compilation unit tree (in that order) as arguments.

Subclasses have to override this method to create the appropriate visitor if they do not follow the checker naming convention.

Overrides:

createTypeFactory in class BaseTypeVisitor<AccumulationAnnotatedTypeFactory>

Returns:

the appropriate type factory

processMethodTree

public void processMethodTree(String className,
 MethodTree tree)

Description copied from class: BaseTypeVisitor

Type-check methodTree. Subclasses should override this method instead of BaseTypeVisitor.visitMethod(MethodTree, Void).

Overrides:

processMethodTree in class CalledMethodsVisitor

Parameters:

className - the class that contains the method, for diagnostics only

tree - the method to type-check

shouldPerformContractInference

protected boolean shouldPerformContractInference()

Description copied from class: BaseTypeVisitor

Should Whole Program Inference attempt to infer contract annotations? Typically, the answer is "yes" whenever WPI is enabled, but this method exists to allow subclasses to customize that behavior.

Overrides:

shouldPerformContractInference in class BaseTypeVisitor<AccumulationAnnotatedTypeFactory>

Returns:

true if contract inference should be performed, false if it should be disabled (even when WPI is enabled)

getCreatesMustCallForValues

public static List<String> getCreatesMustCallForValues(ExecutableElement elt,
 MustCallAnnotatedTypeFactory mcAtf,
 RLCCalledMethodsAnnotatedTypeFactory atypeFactory)

Returns all the CreatesMustCallFor.value() elements/arguments of all @CreatesMustCallFor annotations on the given element.

Does no viewpoint-adaptation, unlike CreatesMustCallForToJavaExpression.getCreatesMustCallForExpressionsAtInvocation(org.checkerframework.dataflow.cfg.node.MethodInvocationNode, org.checkerframework.framework.type.GenericAnnotatedTypeFactory<?, ?, ?, ?>, org.checkerframework.checker.mustcall.CreatesMustCallForElementSupplier) which does.

Parameters:

elt - an executable element

mcAtf - a MustCallAnnotatedTypeFactory, to source the value element

atypeFactory - a RLCCalledMethodsAnnotatedTypeFactory

Returns:

the literal strings present in the @CreatesMustCallFor annotation(s) of that element, substituting the default "this" for empty annotations. This method returns the empty list iff there are no @CreatesMustCallFor annotations on elt. The returned list is always modifiable if it is non-empty.

visitVariable

public Void visitVariable(VariableTree tree,
 Void p)

Specified by:

visitVariable in interface TreeVisitor<Void,Void>

Overrides:

visitVariable in class BaseTypeVisitor<AccumulationAnnotatedTypeFactory>

isWpiEnabledForRLC

protected boolean isWpiEnabledForRLC()

Checks if WPI is enabled for the Resource Leak Checker inference. See ResourceLeakChecker.ENABLE_WPI_FOR_RLC.

Returns:

returns true if WPI is enabled for the Resource Leak Checker