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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HOSTED_OPTION_PREFIX
static String	RUNTIME_OPTION_PREFIX

Constructor Summary

Constructors

Constructor and Description
SubstrateOptionsParser()

Method Summary

Modifier and Type	Method and Description
static void	collectOptions(ServiceLoader<org.graalvm.compiler.options.OptionDescriptors> optionDescriptors, Consumer<org.graalvm.compiler.options.OptionDescriptor> optionDescriptorConsumer)
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)
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, com.oracle.svm.common.option.CommonOptionParser.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

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,
                                        com.oracle.svm.common.option.CommonOptionParser.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)

collectOptions

public static void collectOptions(ServiceLoader<org.graalvm.compiler.options.OptionDescriptors> optionDescriptors,
                                  Consumer<org.graalvm.compiler.options.OptionDescriptor> optionDescriptorConsumer)

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)

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")