public abstract class BaseTypeChecker extends SourceChecker implements BaseTypeContext
SourceChecker that provides a simple SourceVisitor implementation that type-checks assignments,
pseudo-assignments such as parameter passing and method invocation, and method overriding.
Most type-checker annotation processor should extend this class, instead of SourceChecker. Checkers that require annotated types but not subtype checking (e.g. for testing
purposes) should extend SourceChecker. Non-type checkers (e.g. checkers to enforce coding
styles) can extend SourceChecker or AbstractTypeProcessor; the Checker Framework
is not designed for such checkers.
It is a convention that, for a type system Foo, the checker, the visitor, and the annotated type factory are named as FooChecker, FooVisitor, and FooAnnotatedTypeFactory. Some factory methods use this convention to construct the appropriate classes reflectively.
BaseTypeChecker encapsulates a group for factories for various representations/classes
related the type system, mainly:
QualifierHierarchy: to represent the supported qualifiers in addition to their
hierarchy, mainly, subtyping rules
TypeHierarchy: to check subtyping rules between annotated types rather than
qualifiers
AnnotatedTypeFactory: to construct qualified types enriched with implicit
qualifiers according to the type system rules
BaseTypeVisitor: to visit the compiled Java files and check for violations of the
type system rules
Subclasses must specify the set of type qualifiers they support. See AnnotatedTypeFactory.createSupportedTypeQualifiers().
If the specified type qualifiers are meta-annotated with SubtypeOf, this
implementation will automatically construct the type qualifier hierarchy. Otherwise, or if this
behavior must be overridden, the subclass may override the AnnotatedTypeFactory.createQualifierHierarchy() method.
currentRoot, DETAILS_SEPARATOR, elementsWithSuppressedWarnings, errsOnLastExit, messager, messages, MSGS_FILE, parentChecker, SUPPRESS_ALL_KEY, trees, UNNEEDED_SUPPRESSION_KEY, upstreamCheckerNames, visitorprocessingEnv| Constructor and Description |
|---|
BaseTypeChecker() |
| Modifier and Type | Method and Description |
|---|---|
protected BaseTypeVisitor<?> |
createSourceVisitor()
Returns the appropriate visitor that type-checks the compilation unit according to the type
system rules.
|
AnnotationProvider |
getAnnotationProvider() |
BaseTypeChecker |
getChecker() |
BaseTypeContext |
getContext() |
protected LinkedHashSet<Class<? extends BaseTypeChecker>> |
getImmediateSubcheckerClasses()
Returns the set of subchecker classes on which this checker depends.
|
Map<String,String> |
getOptions()
Return all active options for this checker.
|
<T extends BaseTypeChecker> |
getSubchecker(Class<T> checkerClass)
Returns the requested subchecker.
|
Set<String> |
getSupportedLintOptions()
Specify supported lint options for all type-checkers.
|
Set<String> |
getSupportedOptions()
Map the Checker Framework version of
SupportedOptions to the standard annotation
provided version SupportedOptions. |
TreePathCacher |
getTreePathCacher()
Get the shared TreePathCacher instance.
|
GenericAnnotatedTypeFactory<?,?,?,?> |
getTypeFactory() |
<T extends GenericAnnotatedTypeFactory<?,?,?,?>,U extends BaseTypeChecker> |
getTypeFactoryOfSubchecker(Class<U> checkerClass)
Returns the type factory used by a subchecker.
|
BaseTypeVisitor<?> |
getVisitor() |
void |
initChecker()
Initialize the checker.
|
static <T> T |
invokeConstructorFor(String name,
Class<?>[] paramTypes,
Object[] args)
Invokes the constructor belonging to the class named by
name having the given
parameter types on the given arguments. |
protected void |
printMessage(Diagnostic.Kind kind,
String message,
Tree source,
CompilationUnitTree root)
If this is a compound checker or a subchecker of a compound checker, then the message is
stored until all messages from all checkers for the compilation unit are issued.
|
protected Object |
processArg(Object arg)
Process an argument to an error message before it is passed to String.format.
|
protected void |
setRoot(CompilationUnitTree newRoot)
Invoked when the current compilation unit root changes.
|
protected boolean |
shouldAddShutdownHook()
Return true to indicate that method
SourceChecker.shutdownHook() should be added as a shutdownHook
of the JVM. |
boolean |
shouldResolveReflection()
Returns whether or not reflection should be resolved.
|
protected void |
shutdownHook()
Method that gets called exactly once at shutdown time of the JVM.
|
void |
typeProcess(TypeElement element,
TreePath tree)
Type-check the code with Java specifications and then runs the Checker Rule Checking visitor
on the processed source.
|
void |
typeProcessingOver()
A method to be called once all the classes are processed and no error is reported.
|
protected void |
warnUnneededSuppressions()
Issues a warning about any
@SuppressWarnings that isn't used by this checker, but
contains a key that would suppress a warning from this checker. |
addOptions, createSupportedLintOptions, expandCFOptions, formatStackTrace, fullMessageOf, getBooleanOption, getBooleanOption, getElementUtils, getLintOption, getLintOption, getMessages, getOption, getOption, getOptionConfiguration, getProcessingEnvironment, getProperties, getStandardSuppressWarningsKeys, getSupportedAnnotationTypes, getSupportedSourceVersion, getSuppressWarningsKeys, getTreeUtils, getTypeUtils, getUpstreamCheckerNames, hasOption, init, message, printStats, report, setLintOption, setParentChecker, setProcessingEnvironment, setSupportedLintOptions, shouldSkipDefs, shouldSkipDefs, shouldSkipUses, shouldSkipUses, shouldSuppressWarnings, shouldSuppressWarnings, treeToFilePositionString, typeProcessingStart, useUncheckedCodeDefault, warnUnneedSuppressionsprocessgetCompletions, isInitializedclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetElementUtils, getOptionConfiguration, getProcessingEnvironment, getTreeUtils, getTypeUtilspublic void initChecker()
SourceCheckerinitChecker in class SourceCheckerAbstractProcessor.init(ProcessingEnvironment)protected void setRoot(CompilationUnitTree newRoot)
SourceCheckersetRoot in class SourceCheckerprotected LinkedHashSet<Class<? extends BaseTypeChecker>> getImmediateSubcheckerClasses()
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.
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 printMessage(Diagnostic.Kind, String, Tree,
CompilationUnitTree).)
WARNING: Circular dependencies are not supported nor do checkers verify that their dependencies are not circular. Make sure no circular dependencies are created when overriding this method. (In other words, if checker A depends on checker B, checker B cannot depend on checker A.)
This method is protected so it can be overridden, but it should only be called internally by the BaseTypeChecker.
The BaseTypeChecker will not modify the list returned by this method.
public boolean shouldResolveReflection()
protected BaseTypeVisitor<?> createSourceVisitor()
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.
createSourceVisitor in class SourceCheckerpublic Set<String> getSupportedLintOptions()
getSupportedLintOptions in class SourceCheckerSet of the lint options recognized by this checkerpublic static <T> T invokeConstructorFor(String name, Class<?>[] paramTypes, Object[] args)
name having the given
parameter types on the given arguments. Returns null if the class cannot be found.
Otherwise, throws an exception if there is trouble with the constructor invocation.T - the type to which the constructor belongsname - the name of the class to which the constructor belongsparamTypes - the types of the constructor's parametersargs - the arguments on which to invoke the constructorargs, or null if the class does
not existpublic BaseTypeContext getContext()
getContext in class SourceCheckerCFContext used by this checkerpublic BaseTypeChecker getChecker()
getChecker in interface BaseTypeContextgetChecker in interface CFContextgetChecker in class SourceCheckerpublic BaseTypeVisitor<?> getVisitor()
getVisitor in interface BaseTypeContextgetVisitor in interface CFContextgetVisitor in class SourceCheckerpublic GenericAnnotatedTypeFactory<?,?,?,?> getTypeFactory()
getTypeFactory in interface BaseTypeContextpublic AnnotationProvider getAnnotationProvider()
getAnnotationProvider in interface BaseContextgetAnnotationProvider in class SourceCheckerpublic <T extends BaseTypeChecker> T getSubchecker(Class<T> checkerClass)
checkerClass - the class of the subcheckerpublic <T extends GenericAnnotatedTypeFactory<?,?,?,?>,U extends BaseTypeChecker> T getTypeFactoryOfSubchecker(Class<U> checkerClass)
checkerClass - the class of the subcheckerpublic TreePathCacher getTreePathCacher()
public void typeProcess(TypeElement element, TreePath tree)
SourceCheckertypeProcess in class SourceCheckerelement - element of the analyzed classtree - the tree path to the element, with the leaf being a ClassTreeProcessor.process(Set, RoundEnvironment)protected void warnUnneededSuppressions()
@SuppressWarnings that isn't used by this checker, but
contains a key that would suppress a warning from this checker.
Collects needed warning suppressions for all subcheckers.
warnUnneededSuppressions in class SourceCheckerprotected void printMessage(Diagnostic.Kind kind, String message, Tree source, CompilationUnitTree root)
Otherwise, it prints the message.
printMessage in class SourceCheckerpublic void typeProcessingOver()
AbstractTypeProcessorSubclasses may override this method to do any aggregate analysis (e.g. generate report, persistence) or resource deallocation.
If an error (a Java error or a processor error) is reported, this method is not guaranteed to be invoked.
typeProcessingOver in class AbstractTypeProcessorpublic Set<String> getSupportedOptions()
SourceCheckerSupportedOptions to the standard annotation
provided version SupportedOptions.getSupportedOptions in interface ProcessorgetSupportedOptions in interface OptionConfigurationgetSupportedOptions in class SourceCheckerpublic Map<String,String> getOptions()
SourceCheckergetOptions in interface OptionConfigurationgetOptions in class SourceCheckerprotected Object processArg(Object arg)
SourceCheckerprocessArg in class SourceCheckerarg - the argumentprotected boolean shouldAddShutdownHook()
SourceCheckerSourceChecker.shutdownHook() should be added as a shutdownHook
of the JVM.shouldAddShutdownHook in class SourceCheckerprotected void shutdownHook()
SourceCheckershutdownHook in class SourceChecker