org.checkerframework.framework.util

Class CheckerMain

java.lang.Object

org.checkerframework.framework.util.CheckerMain

Direct Known Subclasses:

CheckerDevelMain

public class CheckerMain
extends Object

This class functions essentially the same as the jsr308-langtools javac script EXCEPT that it adds the appropriate jdk.jar to the bootclasspath and adds checker.jar to the classpath passed to javac.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Pattern	BOOT_CLASS_PATH_REGEX A pattern to catch bootclasspath prepend entries, used to construct one -Xbootclasspath/p: argument
protected static String	CHECKER_BASE_DIR_NAME
protected static String	CHECKER_BASE_PACKAGE All "built-in" Checker Framework checkers, except SubtypingChecker, start with this package file path Framework Checkers, except for SubtypingChecker are excluded from processor shorthand
protected File	checkersJar The paths to the jar containing CheckerMain.class (i.e.
protected static String	FULLY_QUALIFIED_SUBTYPING_CHECKER
protected File	javacJar The path to the jsr308 Langtools Type Annotations Compiler
protected File	jdkJar The path to the annotated jdk jar to use
protected static Pattern	JVM_OPTS_REGEX Matches all -J arguments
protected static String	SUBTYPING_CHECKER_NAME

Constructor Summary

Constructors

Constructor and Description
CheckerMain(File checkersJar, String[] args) Construct all the relevant file locations and java version given the path to this jar and a set of directories in which to search for jars

Method Summary

Modifier and Type	Method and Description
protected void	addMainArgs(List<String> args)
void	addToClasspath(List<String> cpOpts)
void	addToRuntimeBootclasspath(List<String> runtimeBootClasspathOpts)
protected static String	asCheckerFrameworkProcessors(String processorsString, List<String> fullyQualifiedCheckerNames, boolean allowSubcheckers) Takes a processor string of the form NullnessChecker or nullness and returns: org.checkerframework.checker.nullness.NullnessChecker if the latter is found in the fullyQualifiedCheckerNames list.
protected void	assertValidState()
protected List<File>	collectArgLists(List<String> args) Record (but don't remove) the arguments that start with @ and therefore are files that contain javac arguments
protected List<String>	createCompilationBootclasspath(List<String> argsList)
protected List<String>	createCpOpts(List<String> argsList)
protected List<String>	createRuntimeBootclasspath(List<String> argsList)
protected static List<String>	expandArgs(List<File> args) Iterate through the arguments and, for every argument that starts with an @, replace it with the lines contained by that file.
protected static String	extractArg(String argumentName, String alternative, List<String> args) Remove the argument given by argumentName and the subsequent value from the list args if present.
protected static List<String>	extractBootClassPath(List<String> args) Remove all -Xbootclasspath/p: or -J-Xbootclasspath/p: arguments from args and add them to the returned list
protected static List<String>	extractCpOpts(List<String> args) Extract the -cp and -classpath arguments and there immediate predecessors in args.
protected static File	extractFileArg(String argumentName, File alternative, List<String> args) Remove the argument given by argumentName and the subsequent value from the list args if present.
protected static List<String>	extractJvmOpts(List<String> args) Remove all -J arguments from args and add them to the returned list
protected static List<String>	extractOptWPattern(Pattern pattern, boolean allowEmpties, List<String> args) Find all args that match the given pattern and extract their index 1 group.
static String	findPathTo(Class<?> context, boolean directory) Find the jar file or directory containing the .class file from which context was loaded
List<String>	getExecArguments() Invoke the JSR308 Type Annotations Compiler with all relevant jars on it's classpath or boot classpath
int	invokeCompiler() Invoke the JSR308 Type Annotations Compiler with all relevant jars on it's classpath or boot classpath
static void	main(String[] args) Most logic of the CheckerMain main method is delegated to the CheckerMain class.
static boolean	matchesCheckerOrSubcheckerFromList(String processorString, List<String> fullyQualifiedCheckerNames)
static boolean	matchesFullyQualifiedProcessor(String processor, List<String> fullyQualifiedCheckerNames, boolean allowSubcheckers) Takes a processor string of the form "NullnessChecker" or "nullness" and returns true if it is found in the fullyQualifiedCheckerNames list.
protected static String	prepFilePath(String previous, File... files) Construct a file path from files and prepend it to previous (if previous is not null)
protected void	replaceShorthandProcessor(List<String> args) For every "-processor" argument in args, replace its immediate successor argument using asCheckerFrameworkProcessors

Methods inherited from class java.lang.Object

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

Field Detail

jdkJar

protected final File jdkJar

The path to the annotated jdk jar to use

javacJar

protected final File javacJar

The path to the jsr308 Langtools Type Annotations Compiler

checkersJar

protected final File checkersJar

The paths to the jar containing CheckerMain.class (i.e. checker.jar)

BOOT_CLASS_PATH_REGEX

protected static final Pattern BOOT_CLASS_PATH_REGEX

A pattern to catch bootclasspath prepend entries, used to construct one -Xbootclasspath/p: argument

JVM_OPTS_REGEX

protected static final Pattern JVM_OPTS_REGEX

Matches all -J arguments

CHECKER_BASE_PACKAGE

protected static final String CHECKER_BASE_PACKAGE

All "built-in" Checker Framework checkers, except SubtypingChecker, start with this package file path Framework Checkers, except for SubtypingChecker are excluded from processor shorthand

See Also:

Constant Field Values

CHECKER_BASE_DIR_NAME

protected static final String CHECKER_BASE_DIR_NAME

FULLY_QUALIFIED_SUBTYPING_CHECKER

protected static final String FULLY_QUALIFIED_SUBTYPING_CHECKER

SUBTYPING_CHECKER_NAME

protected static final String SUBTYPING_CHECKER_NAME

Constructor Detail

CheckerMain

public CheckerMain(File checkersJar,
                   String[] args)

Construct all the relevant file locations and java version given the path to this jar and a set of directories in which to search for jars

Method Detail

main

public static void main(String[] args)

Most logic of the CheckerMain main method is delegated to the CheckerMain class. This method just determines the relevant parameters to CheckerMain then tells it to invoke the JSR 308 Type Annotations Compiler. Any exception thrown by the Checker Framework escapes to the command line

Parameters:

args - command-line arguments, eventually passed to the JSR 308 Type Annotations compiler

assertValidState

protected void assertValidState()

replaceShorthandProcessor

protected void replaceShorthandProcessor(List<String> args)

For every "-processor" argument in args, replace its immediate successor argument using asCheckerFrameworkProcessors

addToClasspath

public void addToClasspath(List<String> cpOpts)

addToRuntimeBootclasspath

public void addToRuntimeBootclasspath(List<String> runtimeBootClasspathOpts)

createRuntimeBootclasspath

protected List<String> createRuntimeBootclasspath(List<String> argsList)

createCompilationBootclasspath

protected List<String> createCompilationBootclasspath(List<String> argsList)

createCpOpts

protected List<String> createCpOpts(List<String> argsList)

collectArgLists

protected List<File> collectArgLists(List<String> args)

Record (but don't remove) the arguments that start with @ and therefore are files that contain javac arguments

Parameters:

args - A list of command line arguments

Returns:

A List of files representing all arguments that started with @

extractArg

protected static String extractArg(String argumentName,
                                   String alternative,
                                   List<String> args)

Remove the argument given by argumentName and the subsequent value from the list args if present. Return the subsequent value.

Parameters:

argumentName - Argument to extract

alternative - Value to return if argumentName is not found in args

args - The current list of arguments

Returns:

The string that follows argumentName if argumentName is in args or alternative if argumentName is not present in args

extractFileArg

protected static File extractFileArg(String argumentName,
                                     File alternative,
                                     List<String> args)

Remove the argument given by argumentName and the subsequent value from the list args if present. Return the subsequent value wrapped as a File.

Parameters:

argumentName - Argument to extract

alternative - File to return if argumentName is not found in args

args - The current list of arguments

Returns:

The string that follows argumentName wrapped as a File if argumentName is in args or alternative if argumentName is not present in args

prepFilePath

protected static String prepFilePath(String previous,
                                     File... files)

Construct a file path from files and prepend it to previous (if previous is not null)

Parameters:

previous - The previous file path to append to (can be null)

files - The files used to construct a path using File.pathSeparator

Returns:

previous with the conjoined file path appended to it or just the conjoined file path if previous is null

extractOptWPattern

protected static List<String> extractOptWPattern(Pattern pattern,
                                                 boolean allowEmpties,
                                                 List<String> args)

Find all args that match the given pattern and extract their index 1 group. Add all the index 1 groups to the returned list. Remove all matching args from the input args list.

Parameters:

pattern - A pattern with at least one matching group

allowEmpties - Whether or not to add empty group(1) matches to the returned list

args - The arguments to extract from

Returns:

A list of arguments from the first group that matched the pattern for each input args or the empty list if there were none

extractBootClassPath

protected static List<String> extractBootClassPath(List<String> args)

Remove all -Xbootclasspath/p: or -J-Xbootclasspath/p: arguments from args and add them to the returned list

Parameters:

args - The arguments to extract from

Returns:

All non-empty arguments matching BOOT_CLASS_PATH_REGEX or an empty list if there were none

extractJvmOpts

protected static List<String> extractJvmOpts(List<String> args)

Remove all -J arguments from args and add them to the returned list

Parameters:

args - The arguments to extract from

Returns:

All -j arguments (without the -J prefix) or an empty list if there were none

extractCpOpts

protected static List<String> extractCpOpts(List<String> args)

Extract the -cp and -classpath arguments and there immediate predecessors in args. Return a list of the predecessors. If NO -cp or -classpath arguments were present then use the current directory and the CLASSPATH environment variable

Parameters:

args - A list of arguments to extract from

Returns:

The arguments that should be put on the classpath when calling javac.jar

addMainArgs

protected void addMainArgs(List<String> args)

getExecArguments

public List<String> getExecArguments()

Invoke the JSR308 Type Annotations Compiler with all relevant jars on it's classpath or boot classpath

invokeCompiler

public int invokeCompiler()

Invoke the JSR308 Type Annotations Compiler with all relevant jars on it's classpath or boot classpath

expandArgs

protected static List<String> expandArgs(List<File> args)

Iterate through the arguments and, for every argument that starts with an @, replace it with the lines contained by that file.

Parameters:

args - A list of arguments, which may or may not be prefixed with an @

Returns:

A list of args with no @ symbols, where every argument that started with an @ symbol has been replaced with the list of lines of the files content

findPathTo

public static String findPathTo(Class<?> context,
                                boolean directory)
                         throws IllegalStateException

Find the jar file or directory containing the .class file from which context was loaded

Parameters:

context - The class whose .class file we wish to locate

directory - Whether to throw an exception if the file was loaded from a directory

Throws:

IllegalStateException

matchesCheckerOrSubcheckerFromList

public static boolean matchesCheckerOrSubcheckerFromList(String processorString,
                                                         List<String> fullyQualifiedCheckerNames)

asCheckerFrameworkProcessors

protected static String asCheckerFrameworkProcessors(String processorsString,
                                                     List<String> fullyQualifiedCheckerNames,
                                                     boolean allowSubcheckers)

Takes a processor string of the form NullnessChecker or nullness and returns: org.checkerframework.checker.nullness.NullnessChecker if the latter is found in the fullyQualifiedCheckerNames list. Also fully qualifies the subtyping checker. asCheckerFrameworkProcessors will handle processor strings with multiple processors, e.g: NullnessChecker,RegexChecker becomes: org.checkerframework.checker.nullness.NullnessChecker,org.checkerframework.checker.regex.RegexChecker Note, a processor entry only gets replaced if it contains NO "." (i.e. is not qualified by the package name) and can be found under the package org.checkerframework.checker in the checker.jar.

Parameters:

processorsString - A string identifying processors

fullyQualifiedCheckerNames - A list of fully-qualified checker names to match processorsString against.

allowSubcheckers - Whether to match against fully qualified checker names ending with "Subchecker".

Returns:

processorsString where all unqualified references to Checker Framework built-in checkers are replaced with fully-qualified references

matchesFullyQualifiedProcessor

public static boolean matchesFullyQualifiedProcessor(String processor,
                                                     List<String> fullyQualifiedCheckerNames,
                                                     boolean allowSubcheckers)

Takes a processor string of the form "NullnessChecker" or "nullness" and returns true if it is found in the fullyQualifiedCheckerNames list. Does not match the subtyping checker. Does not match multiple processors - a single processor name must be given.

Parameters:

processor - A string identifying one processor.

fullyQualifiedCheckerNames - A list of fully-qualified checker names to match processor against.

allowSubcheckers - Whether to match against fully qualified checker names ending with "Subchecker".