Package org.checkerframework.checker.resourceleak

Class ResourceLeakVisitor

java.lang.Object

com.sun.source.util.TreeScanner<R,P>

com.sun.source.util.TreePathScanner<R,P>

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.resourceleak.ResourceLeakVisitor

All Implemented Interfaces:

TreeVisitor<Void,Void>

public class ResourceLeakVisitor
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

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

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

elements, root, trees, treesWithSuppressWarnings, types

Constructor Summary

Constructors

Constructor	Description
ResourceLeakVisitor(BaseTypeChecker checker)	Create the visitor.

Method Summary

Modifier and Type	Method	Description
protected void	checkPostcondition(MethodTree methodTree, AnnotationMirror annotation, JavaExpression expression)	Check that the expression's type is annotated with annotation at the regular exit store.
protected ResourceLeakAnnotatedTypeFactory	createTypeFactory()	Constructs an instance of the appropriate type factory for the implemented type system.
protected boolean	isWpiEnabledForRLC()	Checks if WPI is enabled for the Resource Leak Checker inference.
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	visitMethod(MethodTree tree, Void p)	Checks that the method or constructor obeys override and subtype rules to all overridden methods.
Void	visitVariable(VariableTree tree, Void p)

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

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, checkForPolymorphicQualifiers, checkForPolymorphicQualifiers, checkMethodInvocability, checkMethodReferenceAsOverride, checkOverride, checkOverride, checkPreconditions, checkPurity, checkQualifierParameter, checkSuperConstructorCall, checkThisConstructorCall, checkThisOrSuperConstructorCall, checkThrownExpression, checkTypeArguments, checkTypecastRedundancy, checkTypecastSafety, checkVarargs, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheck, commonAssignmentCheckEndDiagnostic, commonAssignmentCheckEndDiagnostic, commonAssignmentCheckStartDiagnostic, 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, visitNewArray, visitNewClass, visitReturn, visitSwitchExpression17, visitThrow, visitTypeCast, visitTypeParameter, visitUnary, warnAboutIrrelevantJavaTypes, 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, visitArrayAccess, visitArrayType, visitAssert, visitBinary, visitBindingPattern, visitBlock, visitBreak, visitCase, visitContinue, visitDefaultCaseLabel, visitDoWhileLoop, visitEmptyStatement, visitErroneous, visitExports, visitExpressionStatement, visitForLoop, visitGuardedPattern, visitIf, visitImport, visitIntersectionType, visitLabeledStatement, visitLiteral, visitMemberSelect, visitModifiers, visitModule, visitOpens, visitOther, visitPackage, visitParameterizedType, visitParenthesized, visitParenthesizedPattern, visitPrimitiveType, visitProvides, visitRequires, 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

ResourceLeakVisitor

public ResourceLeakVisitor(BaseTypeChecker checker)

Create the visitor.

Parameters:

checker - the type-checker associated with this visitor

Method Details

createTypeFactory

protected ResourceLeakAnnotatedTypeFactory 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

visitMethod

public Void visitMethod(MethodTree tree,
 Void p)

Description copied from class: BaseTypeVisitor

Checks that the method or constructor obeys override and subtype rules to all overridden methods. (Uses the pseudo-assignment logic to do so.)

The override rule specifies that a method, m1, may override a method m2 only if:

• m1 return type is a subtype of m2
• m1 receiver type is a supertype of m2
• m1 parameters are supertypes of corresponding m2 parameters

Also, it issues a "missing.this" error for static method annotated receivers.

Specified by:

visitMethod in interface TreeVisitor<Void,Void>

Overrides:

visitMethod in class CalledMethodsVisitor

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)

checkPostcondition

protected void checkPostcondition(MethodTree methodTree,
 AnnotationMirror annotation,
 JavaExpression expression)

Description copied from class: BaseTypeVisitor

Check that the expression's type is annotated with annotation at the regular exit store.

Overrides:

checkPostcondition in class BaseTypeVisitor<AccumulationAnnotatedTypeFactory>

Parameters:

methodTree - declaration of the method

annotation - expression's type must have this annotation

expression - the expression that must have an annotation

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