Package org.checkerframework.common.value

Class ValueChecker

java.lang.Object
javax.annotation.processing.AbstractProcessor
org.checkerframework.javacutil.AbstractTypeProcessor
org.checkerframework.framework.source.SourceChecker
org.checkerframework.common.basetype.BaseTypeChecker
org.checkerframework.common.value.ValueChecker
All Implemented Interfaces:
Processor, OptionConfiguration
@SupportedOptions({"reportEvalWarns","ignoreRangeOverflow","nonNullStringsConcatenation"}) public class ValueChecker extends BaseTypeChecker
The Constant Value Checker is a constant propagation analysis: for each variable, it determines whether that variable's value can be known at compile time.

The Constant Value Checker has no dependencies, but it does trust org.checkerframework.checker.index.qual.Positive annotations from the Index Checker. This means that if the Value Checker is run on code containing Positive annotations, then the Index Checker also needs to be run to guarantee soundness.

See the Checker Framework Manual:
Constant Value Checker

  • Field Details

    • REPORT_EVAL_WARNS

      public static final String REPORT_EVAL_WARNS
      Command-line option to warn the user if a @StaticallyExecutable method can't load and run at compile time.
      See Also:

    • IGNORE_RANGE_OVERFLOW

      public static final String IGNORE_RANGE_OVERFLOW
      Command-line option to ignore the possibility of overflow for range annotations.
      See Also:

    • NON_NULL_STRINGS_CONCATENATION

      public static final String NON_NULL_STRINGS_CONCATENATION
      Command-line option that assumes most expressions in String concatenations can be null.
      See Also:

  • Constructor Details

    • ValueChecker

      public ValueChecker()

  • Method Details

    • createSourceVisitor

      protected BaseTypeVisitor<?> 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 class BaseTypeChecker
      Returns:
      the type-checking visitor

    • getImmediateSubcheckerClasses

      protected LinkedHashSet<Class<? extends BaseTypeChecker>> getImmediateSubcheckerClasses()
      Description copied from class: BaseTypeChecker
      Returns the set of subchecker classes on which this checker depends. Returns an empty set if this checker does not depend on any others.

      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 BaseTypeChecker.printOrStoreMessage(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, but other clients do modify the list.

      Overrides:
      getImmediateSubcheckerClasses in class BaseTypeChecker
      Returns:
      the subchecker classes on which this checker depends; will be modified by callees

    • shouldResolveReflection

      public boolean shouldResolveReflection()
      Description copied from class: BaseTypeChecker
      Returns whether or not reflection should be resolved.
      Overrides:
      shouldResolveReflection in class BaseTypeChecker
      Returns:
      true if reflection should be resolved

    • typeProcessingOver

      public void typeProcessingOver()
      Description copied from class: AbstractTypeProcessor
      A method to be called once all the classes are processed.

      Subclasses may override this method to do any aggregate analysis (e.g. generate report, persistence) or resource deallocation.

      Method AbstractTypeProcessor.getCompilerLog() can be used to access the number of compiler errors.

      Overrides:
      typeProcessingOver in class BaseTypeChecker