Class RLCCalledMethodsChecker
- All Implemented Interfaces:
Processor
,OptionConfiguration
CalledMethodsChecker
used as a subchecker in the ResourceLeakChecker, and never independently.
Runs the MustCallChecker as a subchecker in order to share the CFG.-
Nested Class Summary
Nested classes/interfaces inherited from class org.checkerframework.common.accumulation.AccumulationChecker
AccumulationChecker.AliasAnalysis
Nested classes/interfaces inherited from class org.checkerframework.framework.source.SourceChecker
SourceChecker.CheckerMessage
-
Field Summary
Fields inherited from class org.checkerframework.checker.calledmethods.CalledMethodsChecker
COUNT_FRAMEWORK_BUILD_CALLS, DISABLE_BUILDER_FRAMEWORK_SUPPORTS, DISABLE_RETURNS_RECEIVER, USE_VALUE_CHECKER
Fields inherited from class org.checkerframework.common.basetype.BaseTypeChecker
baseTypeCheckerClassArray, ultimateParentChecker
Fields inherited from class org.checkerframework.framework.source.SourceChecker
activeOptions, currentRoot, DETAILS_SEPARATOR, elements, elementsWithSuppressedWarnings, immediateSubcheckers, javacErrored, messager, messagesProperties, messageStore, MSGS_FILE, OPTION_SEPARATOR, parentChecker, subcheckers, supportedOptions, SUPPRESS_ALL_MESSAGE_KEY, SUPPRESS_ALL_PREFIX, suppressWarningsPrefixesOfSubcheckers, treePathCacher, trees, types, UNNEEDED_SUPPRESSION_KEY, upstreamCheckerNames, useAllcheckersPrefix, visitor
Fields inherited from class javax.annotation.processing.AbstractProcessor
processingEnv
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected BaseTypeVisitor
<?> Returns the appropriate visitor that type-checks the compilation unit according to the type system rules.Get the set of exceptions that should be ignored.protected Set
<Class<? extends SourceChecker>> Returns the set of subchecker classes on which this checker depends.protected boolean
Disable the Returns Receiver Checker unless it has been explicitly enabled with theResourceLeakChecker.ENABLE_RETURNS_RECEIVER
option.Methods inherited from class org.checkerframework.checker.calledmethods.CalledMethodsChecker
isEnabled, typeProcessingOver
Methods inherited from class org.checkerframework.common.accumulation.AccumulationChecker
createAliasAnalyses
Methods inherited from class org.checkerframework.common.basetype.BaseTypeChecker
createSourceVisitorPublic, createSupportedLintOptions, getAnnotationProvider, getTypeFactory, getTypeFactoryOfSubcheckerOrNull, getUltimateParentChecker, getVisitor, invokeConstructorFor, processErrorMessageArg, shouldAddShutdownHook, shutdownHook
Methods inherited from class org.checkerframework.framework.source.SourceChecker
expandCFOptions, fullMessageOf, getBooleanOption, getBooleanOption, getElementUtils, getExtraStubFiles, getLintOption, getLintOption, getMessagesProperties, getOption, getOption, getOptionConfiguration, getOptions, getOptionsNoSubcheckers, getParentChecker, getPathToCompilationUnit, getProcessingEnvironment, getProperties, getRelatedClassName, getStandardSuppressWarningsPrefixes, getStringsOption, getStringsOption, getSubchecker, getSubCheckerIndex, getSubcheckers, getSupportedAnnotationTypes, getSupportedLintOptions, getSupportedOptions, getSupportedSourceVersion, getSuppressWarningsPrefixes, getSuppressWarningsPrefixesOfSubcheckers, getTreePathCacher, getTreeUtils, getTypeUtils, getUpstreamCheckerNames, hasOption, hasOptionNoSubcheckers, init, initChecker, instantiateSubcheckers, message, message, messageKeyMatches, printOrStoreMessage, printOrStoreMessage, printStats, printStoredMessages, report, reportError, reportWarning, setLintOption, setParentChecker, setRoot, shouldResolveReflection, shouldSkipDefs, shouldSkipDefs, shouldSkipDefs, shouldSkipFiles, shouldSkipUses, shouldSkipUses, shouldSuppressWarnings, shouldSuppressWarnings, shouldSuppressWarnings, typeProcess, typeProcessingStart, useConservativeDefault, warnUnneededSuppressions, warnUnneededSuppressions
Methods inherited from class org.checkerframework.javacutil.AbstractTypeProcessor
getCompilerLog, process
Methods inherited from class javax.annotation.processing.AbstractProcessor
getCompletions, isInitialized
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.checkerframework.framework.util.OptionConfiguration
getStringsOption, getStringsOption
-
Constructor Details
-
RLCCalledMethodsChecker
public RLCCalledMethodsChecker()Creates a RLCCalledMethodsChecker.
-
-
Method Details
-
createSourceVisitor
Description copied from class:BaseTypeChecker
Returns the appropriate visitor that type-checks the compilation unit according to the type system rules.This implementation uses the checker naming convention to create the appropriate visitor. If no visitor is found, it returns an instance of
BaseTypeVisitor
. It reflectively invokes the constructor that accepts this checker and the 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:
createSourceVisitor
in classBaseTypeChecker
- Returns:
- the type-checking visitor
-
getIgnoredExceptions
Get the set of exceptions that should be ignored. This set comes from theResourceLeakChecker.IGNORED_EXCEPTIONS
option if it was provided, orResourceLeakChecker.DEFAULT_IGNORED_EXCEPTIONS
if not.- Returns:
- the set of exceptions to ignore
-
isReturnsReceiverDisabled
protected boolean isReturnsReceiverDisabled()Disable the Returns Receiver Checker unless it has been explicitly enabled with theResourceLeakChecker.ENABLE_RETURNS_RECEIVER
option.- Overrides:
isReturnsReceiverDisabled
in classCalledMethodsChecker
- Returns:
- whether the -AdisableReturnsReceiver option was specified on the command line
-
getImmediateSubcheckerClasses
Description copied from class:SourceChecker
Returns the set of subchecker classes on which this checker depends. ("Depends" means the checkers that are subcheckers of the current checker rather than a subchecker of some other checker.) Returns an empty set if this checker does not depend on any others.If this checker should run multiple independent checkers and not contain a type system, then subclass
AggregateChecker
.Subclasses should override this method to specify subcheckers. If they do so, they should call the super implementation of this method and add dependencies to the returned set so that checkers required for reflection resolution are included if reflection resolution is requested.
If a checker should be added or not based on a command line option, use
SourceChecker.getOptionsNoSubcheckers()
orSourceChecker.hasOptionNoSubcheckers(String)
to avoid recursively calling this method.Each subchecker of this checker may also depend on other checkers. If this checker and one of its subcheckers both depend on a third checker, that checker will only be instantiated once.
Though each checker is run on a whole compilation unit before the next checker is run, error and warning messages are collected and sorted based on the location in the source file before being printed. (See
SourceChecker.printOrStoreMessage(Diagnostic.Kind, String, Tree, CompilationUnitTree)
.)WARNING: Circular dependencies are not supported. (In other words, if checker A depends on checker B, checker B cannot depend on checker A.) The Checker Framework does not check for circularity. Make sure no circular dependencies are created when overriding this method.
This method is protected so it can be overridden, but it should only be called internally by
SourceChecker
.- Overrides:
getImmediateSubcheckerClasses
in classCalledMethodsChecker
- Returns:
- the subchecker classes on which this checker depends; will be modified by callees
-