org.checkerframework.javacutil

Class PluginUtil

java.lang.Object

org.checkerframework.javacutil.PluginUtil

public class PluginUtil
extends 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 String	CHECKER_QUAL_PATH_OPT Option name for specifying an alternative checker-qual.jar location.
static String	JAVAC_PATH_OPT Option name for specifying an alternative javac.jar location.
static 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 String	escapeQuotesAndSlashes(String toEscape)
static String	fileArgToStr(File fileArg)
static List<String>	getBooleanProp(Map<PluginUtil.CheckerProp,Object> props, PluginUtil.CheckerProp prop, String cmdLineArg) If prop is in props, return a 1-element list containing cmdLineArg.
static boolean	getBooleanSystemProperty(String key) Return true if the system property is set to "true".
static boolean	getBooleanSystemProperty(String key, boolean defaultValue) Return its boolean value if the system property is set.
static List<String>	getCmd(@Nullable String executable, @Nullable File javacPath, @Nullable File jdkPath, File srcFofn, String processors, String checkerHome, String javaHome, File classPathFofn, String bootClassPath, Map<PluginUtil.CheckerProp,Object> props, PrintStream out, boolean procOnly, String outputDirectory) Build a javac command.
static List<String>	getCmdArgsOnly(File javacPath, File jdkPath, File srcFofn, String processors, String checkerHome, String javaHome, File classpathFofn, String bootClassPath, Map<PluginUtil.CheckerProp,Object> props, PrintStream out, boolean procOnly, String outputDirectory)
static List<String>	getCmdArgsOnly(File srcFofn, String processors, String checkerHome, String javaHome, File classpathFofn, String bootClassPath, Map<PluginUtil.CheckerProp,Object> props, PrintStream out, boolean procOnly, String outputDirectory)
static String	getJavaCommand(String javaHome, PrintStream out)
static 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 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() Returns the major JRE version.
static @Nullable String	getReleaseValue(ProcessingEnvironment env) Returns the release value passed to the compiler or null if release was not passed.
static List<String>	getStringProp(Map<PluginUtil.CheckerProp,Object> props, PluginUtil.CheckerProp prop, String cmdLineArgStart, String... extras) Returns a list of command-line arguments: one that sets the given property, plus everything in extras.
static boolean	isWindows()
static String	join(CharSequence delimiter, Iterable<?> values) Returns a new String composed of the string representations of the elements joined together with a copy of the specified delimiter.
static <T> String	join(CharSequence delimiter, T[] objs) Returns a new String composed of the string representations of the elements joined together with a copy of the specified delimiter.
static String	joinLines(Iterable<? extends Object> v) Concatenate the string representations of the objects, placing the system-specific line separator between them.
static <T> String	joinLines(T... a) Concatenate the string representations of the objects, placing the system-specific line separator between them.
static List<String>	readFile(File argFile) Return a list of Strings, one per line of the file.
static List<File>	toFiles(List<String> fileNames) Convert a list of strings (file names) to a list of files.
static List<String>	toJavaOpts(List<String> opts)
static String	wrapArg(String classpath)
static void	writeFile(File destination, List<String> contents) Write the strings to the file, one per line.
static void	writeFofn(File destination, File... files) Takes a list of files and writes it as a "File of file names" (i.e.
static void	writeFofn(File destination, List<File> files) Takes a list of files and writes it as a "File of file names" (i.e.
static File	writeTmpCpFile(String prefix, boolean deleteOnExit, String classpath)
static File	writeTmpFile(String prefix, String suffix, boolean deleteOnExit, List<String> args) Write the strings to a temporary file.
static File	writeTmpFofn(String prefix, String suffix, boolean deleteOnExit, List<File> files)
static File	writeTmpSrcFofn(String prefix, boolean deleteOnExit, List<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 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 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 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 List<File> toFiles(List<String> fileNames)

Convert a list of strings (file names) to a list of files.

Parameters:

fileNames - a list of file names

Returns:

a list of File objects

writeFofn

public static void writeFofn(File destination,
                             List<File> files)
                      throws 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:

IOException

writeFofn

public static void writeFofn(File destination,
                             File... files)
                      throws 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:

IOException

writeTmpFofn

public static File writeTmpFofn(String prefix,
                                String suffix,
                                boolean deleteOnExit,
                                List<File> files)
                         throws IOException

Throws:

IOException

writeTmpFile

public static File writeTmpFile(String prefix,
                                String suffix,
                                boolean deleteOnExit,
                                List<String> args)
                         throws IOException

Write the strings to a temporary file.

Parameters:

deleteOnExit - if true, delete the file on program exit

Throws:

IOException

writeFile

public static void writeFile(File destination,
                             List<String> contents)
                      throws IOException

Write the strings to the file, one per line.

Throws:

IOException

readFile

public static List<String> readFile(File argFile)
                             throws IOException

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

Throws:

IOException

join

public static <T> String join(CharSequence delimiter,
                              T[] objs)

Returns a new String composed of the string representations of the elements joined together with a copy of the specified delimiter.

Type Parameters:

T - the type of array elements

Parameters:

delimiter - the delimiter that separates each element

objs - the values whose string representations to join together

Returns:

a new string that concatenates the string representations of the elements

join

public static String join(CharSequence delimiter,
                          Iterable<?> values)

Returns a new String composed of the string representations of the elements joined together with a copy of the specified delimiter.

Parameters:

delimiter - the delimiter that separates each element

values - the values whose string representations to join together

Returns:

a new string that concatenates the string representations of the elements

joinLines

@SafeVarargs
public static <T> String joinLines(T... a)

Concatenate the string representations of the objects, placing the system-specific line separator between them.

Type Parameters:

T - the type of array elements

Parameters:

a - array of values to concatenate

Returns:

the concatenation of the string representations of the values, each on its own line

joinLines

public static String joinLines(Iterable<? extends Object> v)

Concatenate the string representations of the objects, placing the system-specific line separator between them.

Parameters:

v - list of values to concatenate

Returns:

the concatenation of the string representations of the values, each on its own line

getStringProp

public static List<String> getStringProp(Map<PluginUtil.CheckerProp,Object> props,
                                         PluginUtil.CheckerProp prop,
                                         String cmdLineArgStart,
                                         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 List<String> getBooleanProp(Map<PluginUtil.CheckerProp,Object> props,
                                          PluginUtil.CheckerProp prop,
                                          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(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(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 File writeTmpSrcFofn(String prefix,
                                   boolean deleteOnExit,
                                   List<File> files)
                            throws IOException

Throws:

IOException

writeTmpCpFile

public static File writeTmpCpFile(String prefix,
                                  boolean deleteOnExit,
                                  String classpath)
                           throws IOException

Throws:

IOException

isWindows

public static boolean isWindows()

wrapArg

public static String wrapArg(String classpath)

escapeQuotesAndSlashes

public static String escapeQuotesAndSlashes(String toEscape)

getJavaCommand

public static String getJavaCommand(String javaHome,
                                    PrintStream out)

fileArgToStr

public static String fileArgToStr(File fileArg)

getCmd

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

Build a javac command.

toJavaOpts

public static List<String> toJavaOpts(List<String> opts)

getCmdArgsOnly

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

getCmdArgsOnly

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

getJreVersion

public static int getJreVersion()

Returns the major JRE version.

This is different from the version passed to the compiler via --release; use getReleaseValue(ProcessingEnvironment) to get that version.

Extract the major version number from the "java.version" system property. 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 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 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, ...)

getReleaseValue

public static @Nullable String getReleaseValue(ProcessingEnvironment env)

Returns the release value passed to the compiler or null if release was not passed.

Parameters:

env - the ProcessingEnvironment

Returns:

the release value or null if none was passed