com.oracle.svm.core.option

Class SubstrateOptionsParser

java.lang.Object

com.oracle.svm.core.option.SubstrateOptionsParser

public class SubstrateOptionsParser
extends Object

This class contains methods for parsing options and matching them against OptionDescriptors.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubstrateOptionsParser.BooleanOptionFormat Constants denoting supported boolean option formats.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HOSTED_OPTION_PREFIX
static int	PRINT_OPTION_INDENTATION
static int	PRINT_OPTION_WIDTH
static int	PRINT_OPTION_WRAP_WIDTH
static String	RUNTIME_OPTION_PREFIX

Constructor Summary

Constructors

Constructor and Description
SubstrateOptionsParser()

Method Summary

Modifier and Type	Method and Description
static String	commandArgument(org.graalvm.compiler.options.OptionKey<?> option, String value) Returns a string to be used on command line to set the option to a desirable value.
static String	commandArgument(org.graalvm.compiler.options.OptionKey<?> option, String value, String apiOptionName) Returns a string to be used on command line to set the option to a desirable value.
static double	parseDouble(String v) Parses the provide string to a double number, avoiding the JDK dependencies (which pull in a lot of classes, including the regular expression library).
static boolean	parseHostedOption(String optionPrefix, org.graalvm.collections.EconomicMap<String,org.graalvm.compiler.options.OptionDescriptor> options, org.graalvm.collections.EconomicMap<org.graalvm.compiler.options.OptionKey<?>,Object> valuesMap, SubstrateOptionsParser.BooleanOptionFormat booleanOptionFormat, Set<String> errors, String arg, PrintStream out) Parses a option at image build time.
static long	parseLong(String v)
static void	printOption(Consumer<String> println, String option, String description, int indentation, int optionWidth, int wrapWidth)

Methods inherited from class java.lang.Object

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

Field Detail

HOSTED_OPTION_PREFIX

public static final String HOSTED_OPTION_PREFIX

See Also:

Constant Field Values

RUNTIME_OPTION_PREFIX

public static final String RUNTIME_OPTION_PREFIX

See Also:

Constant Field Values

PRINT_OPTION_INDENTATION

public static final int PRINT_OPTION_INDENTATION

See Also:

Constant Field Values

PRINT_OPTION_WIDTH

public static final int PRINT_OPTION_WIDTH

See Also:

Constant Field Values

PRINT_OPTION_WRAP_WIDTH

public static final int PRINT_OPTION_WRAP_WIDTH

See Also:

Constant Field Values

Constructor Detail

SubstrateOptionsParser

public SubstrateOptionsParser()

Method Detail

parseHostedOption

public static boolean parseHostedOption(String optionPrefix,
                                        org.graalvm.collections.EconomicMap<String,org.graalvm.compiler.options.OptionDescriptor> options,
                                        org.graalvm.collections.EconomicMap<org.graalvm.compiler.options.OptionKey<?>,Object> valuesMap,
                                        SubstrateOptionsParser.BooleanOptionFormat booleanOptionFormat,
                                        Set<String> errors,
                                        String arg,
                                        PrintStream out)

Parses a option at image build time. When the PrintFlags option is found prints all options and interrupts compilation.

Parameters:

optionPrefix - prefix used before option name

options - all possible options

valuesMap - all current option values

booleanOptionFormat - help expected for boolean options

errors - a set that contains all error messages

arg - the argument currently processed

Returns:

true if arg.startsWith(optionPrefix)

printOption

public static void printOption(Consumer<String> println,
                               String option,
                               String description,
                               int indentation,
                               int optionWidth,
                               int wrapWidth)

parseLong

public static long parseLong(String v)

parseDouble

public static double parseDouble(String v)

Parses the provide string to a double number, avoiding the JDK dependencies (which pull in a lot of classes, including the regular expression library). Only simple numbers are supported, without fancy exponent styles.

commandArgument

public static String commandArgument(org.graalvm.compiler.options.OptionKey<?> option,
                                     String value)

Returns a string to be used on command line to set the option to a desirable value. If the option has one or more APIOption annotations, preference is given to a matching APIOption syntax.

Parameters:

option - for which the command line argument is created

Returns:

recommendation for setting a option value (e.g., for option 'Name' and value 'file' it returns "-H:Name=file")

commandArgument

public static String commandArgument(org.graalvm.compiler.options.OptionKey<?> option,
                                     String value,
                                     String apiOptionName)

Returns a string to be used on command line to set the option to a desirable value. If the option has one or more APIOption annotations, preference is given to a matching APIOption syntax.

Parameters:

option - for which the command line argument is created

apiOptionName - name of the API option (in case there are multiple)

Returns:

recommendation for setting a option value (e.g., for option 'Name' and value 'file' it returns "-H:Name=file")