org.checkerframework.javacutil

Class PluginUtil

java.lang.Object

org.checkerframework.javacutil.PluginUtil

public class PluginUtil
extends java.lang.Object

This file contains basic utility functions that should be reused to create a command-line call to CheckerMain.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PluginUtil.CheckerProp

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHECKER_QUAL_PATH_OPT Option name for specifying an alternative checker-qual.jar location.
static java.lang.String	JAVAC_PATH_OPT Option name for specifying an alternative javac.jar location.
static java.lang.String	JDK_PATH_OPT Option name for specifying an alternative jdk.jar location.

Constructor Summary

Constructors

Constructor and Description
PluginUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	escapeQuotesAndSlashes(java.lang.String toEscape)
static java.lang.String	fileArgToStr(java.io.File fileArg)
static java.util.List<java.lang.String>	getBooleanProp(java.util.Map<PluginUtil.CheckerProp,java.lang.Object> props, PluginUtil.CheckerProp prop, java.lang.String cmdLineArg) If prop is in props, return a 1-element list containing cmdLineArg.
static boolean	getBooleanSystemProperty(java.lang.String key) Return true if the system property is set to "true".
static boolean	getBooleanSystemProperty(java.lang.String key, boolean defaultValue) Return its boolean value if the system property is set.
static java.util.List<java.lang.String>	getCmd(java.lang.String executable, java.io.File javacPath, java.io.File jdkPath, java.io.File srcFofn, java.lang.String processors, java.lang.String checkerHome, java.lang.String javaHome, java.io.File classPathFofn, java.lang.String bootClassPath, java.util.Map<PluginUtil.CheckerProp,java.lang.Object> props, java.io.PrintStream out, boolean procOnly, java.lang.String outputDirectory)
static java.util.List<java.lang.String>	getCmdArgsOnly(java.io.File javacPath, java.io.File jdkPath, java.io.File srcFofn, java.lang.String processors, java.lang.String checkerHome, java.lang.String javaHome, java.io.File classpathFofn, java.lang.String bootClassPath, java.util.Map<PluginUtil.CheckerProp,java.lang.Object> props, java.io.PrintStream out, boolean procOnly, java.lang.String outputDirectory)
static java.util.List<java.lang.String>	getCmdArgsOnly(java.io.File srcFofn, java.lang.String processors, java.lang.String checkerHome, java.lang.String javaHome, java.io.File classpathFofn, java.lang.String bootClassPath, java.util.Map<PluginUtil.CheckerProp,java.lang.Object> props, java.io.PrintStream out, boolean procOnly, java.lang.String outputDirectory)
static java.lang.String	getJavaCommand(java.lang.String javaHome, java.io.PrintStream out)
static java.lang.String	getJdkJarName() Determine the version of the JRE that we are currently running and select a jdkX.jar where X is the version of Java that is being run (e.g.
static java.lang.String	getJdkJarPrefix() Determine the version of the JRE that we are currently running and select a jdkX where X is the version of Java that is being run (e.g.
static int	getJreVersion() Extract the major version number from java.version.
static java.util.List<java.lang.String>	getStringProp(java.util.Map<PluginUtil.CheckerProp,java.lang.Object> props, PluginUtil.CheckerProp prop, java.lang.String cmdLineArgStart, java.lang.String... extras) Returns a list of command-line arguments: one that sets the given property, plus everything in extras.
static boolean	isWindows()
static java.lang.String	join(java.lang.String delimiter, java.lang.Iterable<?> values)
static <T> java.lang.String	join(java.lang.String delimiter, T[] objs)
static java.util.List<java.lang.String>	readFile(java.io.File argFile) Return a list of Strings, one per line of the file.
static java.util.List<java.io.File>	toFiles(java.util.List<java.lang.String> fileNames)
static java.util.List<java.lang.String>	toJavaOpts(java.util.List<java.lang.String> opts)
static java.lang.String	wrapArg(java.lang.String classpath)
static void	writeFile(java.io.File destination, java.util.List<java.lang.String> contents) Write the strings to the file, one per line.
static void	writeFofn(java.io.File destination, java.io.File... files) Takes a list of files and writes it as a "File of file names" (i.e.
static void	writeFofn(java.io.File destination, java.util.List<java.io.File> files) Takes a list of files and writes it as a "File of file names" (i.e.
static java.io.File	writeTmpCpFile(java.lang.String prefix, boolean deleteOnExit, java.lang.String classpath)
static java.io.File	writeTmpFile(java.lang.String prefix, java.lang.String suffix, boolean deleteOnExit, java.util.List<java.lang.String> args) Write the strings to a temporary file.
static java.io.File	writeTmpFofn(java.lang.String prefix, java.lang.String suffix, boolean deleteOnExit, java.util.List<java.io.File> files)
static java.io.File	writeTmpSrcFofn(java.lang.String prefix, boolean deleteOnExit, java.util.List<java.io.File> files)

Methods inherited from class java.lang.Object

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

Field Detail

CHECKER_QUAL_PATH_OPT

public static final java.lang.String CHECKER_QUAL_PATH_OPT

Option name for specifying an alternative checker-qual.jar location. The accompanying value MUST be the path to the jar file (NOT the path to its encompassing directory)

See Also:

Constant Field Values

JAVAC_PATH_OPT

public static final java.lang.String JAVAC_PATH_OPT

Option name for specifying an alternative javac.jar location. The accompanying value MUST be the path to the jar file (NOT the path to its encompassing directory)

See Also:

Constant Field Values

JDK_PATH_OPT

public static final java.lang.String JDK_PATH_OPT

Option name for specifying an alternative jdk.jar location. The accompanying value MUST be the path to the jar file (NOT the path to its encompassing directory)

See Also:

Constant Field Values

Constructor Detail

PluginUtil

public PluginUtil()

Method Detail

toFiles

public static java.util.List<java.io.File> toFiles(java.util.List<java.lang.String> fileNames)

writeFofn

public static void writeFofn(java.io.File destination,
                             java.util.List<java.io.File> files)
                      throws java.io.IOException

Takes a list of files and writes it as a "File of file names" (i.e. a file with one filepath on each line) to the destination file, overwriting the destination file if it exists. Note the filepath used is the absolute filepath

Parameters:

destination - the fofn file we are writing. This file will contain newline separated list of absolute file paths.

files - the files to write to the destination file

Throws:

java.io.IOException

writeFofn

public static void writeFofn(java.io.File destination,
                             java.io.File... files)
                      throws java.io.IOException

Takes a list of files and writes it as a "File of file names" (i.e. a file with one filepath on each line) to the destination file, overwriting the destination file if it exists. Note the filepath used is the absolute filepath

Parameters:

destination - the fofn file we are writing. This file will contain newline separated list of absolute file paths.

files - the files to write to the destination file

Throws:

java.io.IOException

writeTmpFofn

public static java.io.File writeTmpFofn(java.lang.String prefix,
                                        java.lang.String suffix,
                                        boolean deleteOnExit,
                                        java.util.List<java.io.File> files)
                                 throws java.io.IOException

Throws:

java.io.IOException

writeTmpFile

public static java.io.File writeTmpFile(java.lang.String prefix,
                                        java.lang.String suffix,
                                        boolean deleteOnExit,
                                        java.util.List<java.lang.String> args)
                                 throws java.io.IOException

Write the strings to a temporary file.

Parameters:

deleteOnExit - if true, delete the file on program exit

Throws:

java.io.IOException

writeFile

public static void writeFile(java.io.File destination,
                             java.util.List<java.lang.String> contents)
                      throws java.io.IOException

Write the strings to the file, one per line.

Throws:

java.io.IOException

readFile

public static java.util.List<java.lang.String> readFile(java.io.File argFile)
                                                 throws java.io.IOException

Return a list of Strings, one per line of the file.

Throws:

java.io.IOException

join

public static <T> java.lang.String join(java.lang.String delimiter,
                                        T[] objs)

join

public static java.lang.String join(java.lang.String delimiter,
                                    java.lang.Iterable<?> values)

getStringProp

public static java.util.List<java.lang.String> getStringProp(java.util.Map<PluginUtil.CheckerProp,java.lang.Object> props,
                                                             PluginUtil.CheckerProp prop,
                                                             java.lang.String cmdLineArgStart,
                                                             java.lang.String... extras)

Returns a list of command-line arguments: one that sets the given property, plus everything in extras. Returns the empty list if prop is not found in props (or is empty there), even if extras is not empty.

Parameters:

prop - the property to look up in props

cmdLineArgStart - the command-line argument that introduces prop

getBooleanProp

public static java.util.List<java.lang.String> getBooleanProp(java.util.Map<PluginUtil.CheckerProp,java.lang.Object> props,
                                                              PluginUtil.CheckerProp prop,
                                                              java.lang.String cmdLineArg)

If prop is in props, return a 1-element list containing cmdLineArg. Otherwise, return a 0-element list.

getBooleanSystemProperty

public static boolean getBooleanSystemProperty(java.lang.String key)

Return true if the system property is set to "true". Return false if the system property is not set or is set to "false". Otherwise, errs.

getBooleanSystemProperty

public static boolean getBooleanSystemProperty(java.lang.String key,
                                               boolean defaultValue)

Return its boolean value if the system property is set. Return defaultValue if the system property is not set. Errs if the system property is set to a non-boolean value.

writeTmpSrcFofn

public static java.io.File writeTmpSrcFofn(java.lang.String prefix,
                                           boolean deleteOnExit,
                                           java.util.List<java.io.File> files)
                                    throws java.io.IOException

Throws:

java.io.IOException

writeTmpCpFile

public static java.io.File writeTmpCpFile(java.lang.String prefix,
                                          boolean deleteOnExit,
                                          java.lang.String classpath)
                                   throws java.io.IOException

Throws:

java.io.IOException

isWindows

public static boolean isWindows()

wrapArg

public static java.lang.String wrapArg(java.lang.String classpath)

escapeQuotesAndSlashes

public static java.lang.String escapeQuotesAndSlashes(java.lang.String toEscape)

getJavaCommand

public static java.lang.String getJavaCommand(java.lang.String javaHome,
                                              java.io.PrintStream out)

fileArgToStr

public static java.lang.String fileArgToStr(java.io.File fileArg)

getCmd

public static java.util.List<java.lang.String> getCmd(java.lang.String executable,
                                                      java.io.File javacPath,
                                                      java.io.File jdkPath,
                                                      java.io.File srcFofn,
                                                      java.lang.String processors,
                                                      java.lang.String checkerHome,
                                                      java.lang.String javaHome,
                                                      java.io.File classPathFofn,
                                                      java.lang.String bootClassPath,
                                                      java.util.Map<PluginUtil.CheckerProp,java.lang.Object> props,
                                                      java.io.PrintStream out,
                                                      boolean procOnly,
                                                      java.lang.String outputDirectory)

toJavaOpts

public static java.util.List<java.lang.String> toJavaOpts(java.util.List<java.lang.String> opts)

getCmdArgsOnly

public static java.util.List<java.lang.String> getCmdArgsOnly(java.io.File srcFofn,
                                                              java.lang.String processors,
                                                              java.lang.String checkerHome,
                                                              java.lang.String javaHome,
                                                              java.io.File classpathFofn,
                                                              java.lang.String bootClassPath,
                                                              java.util.Map<PluginUtil.CheckerProp,java.lang.Object> props,
                                                              java.io.PrintStream out,
                                                              boolean procOnly,
                                                              java.lang.String outputDirectory)

getCmdArgsOnly

public static java.util.List<java.lang.String> getCmdArgsOnly(java.io.File javacPath,
                                                              java.io.File jdkPath,
                                                              java.io.File srcFofn,
                                                              java.lang.String processors,
                                                              java.lang.String checkerHome,
                                                              java.lang.String javaHome,
                                                              java.io.File classpathFofn,
                                                              java.lang.String bootClassPath,
                                                              java.util.Map<PluginUtil.CheckerProp,java.lang.Object> props,
                                                              java.io.PrintStream out,
                                                              boolean procOnly,
                                                              java.lang.String outputDirectory)

getJreVersion

public static int getJreVersion()

Extract the major version number from java.version. Two possible formats are considered. Up to Java 8, from a version string like `1.8.whatever`, this method extracts 8. Since Java 9, from a version string like `11.0.1`, this method extracts 11.

Returns:

The major version number from java.version

getJdkJarPrefix

public static java.lang.String getJdkJarPrefix()

Determine the version of the JRE that we are currently running and select a jdkX where X is the version of Java that is being run (e.g. 8, 9, ...)

Returns:

"jdkX" where X is the version of Java that is being run (e.g. 8, 9, ...)

getJdkJarName

public static java.lang.String getJdkJarName()

Determine the version of the JRE that we are currently running and select a jdkX.jar where X is the version of Java that is being run (e.g. 8, 9, ...)

Returns:

the jdkX.jar where X is the version of Java that is being run (e.g. 8, 9, ...)