DefaultParser.java
/*
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package org.apache.commons.cli;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.Properties;
import java.util.function.Consumer;
/**
* Default parser.
*
* @since 1.3
*/
public class DefaultParser implements CommandLineParser {
/**
* A nested builder class to create {@code DefaultParser} instances
* using descriptive methods.
*
* Example usage:
* <pre>
* DefaultParser parser = Option.builder()
* .setAllowPartialMatching(false)
* .setStripLeadingAndTrailingQuotes(false)
* .build();
* </pre>
*
* @since 1.5.0
*/
public static final class Builder {
/** Flag indicating if partial matching of long options is supported. */
private boolean allowPartialMatching = true;
/**
* The deprecated option handler.
* <p>
* If you want to serialize this field, use a serialization proxy.
* </p>
*/
private Consumer<Option> deprecatedHandler = CommandLine.Builder.DEPRECATED_HANDLER;
/** Flag indicating if balanced leading and trailing double quotes should be stripped from option arguments. */
private Boolean stripLeadingAndTrailingQuotes;
/**
* Constructs a new {@code Builder} for a {@code DefaultParser} instance.
*
* Both allowPartialMatching and stripLeadingAndTrailingQuotes are true by default,
* mimicking the argument-less constructor.
*/
private Builder() {
}
/**
* Builds an DefaultParser with the values declared by this {@link Builder}.
*
* @return the new {@link DefaultParser}
* @since 1.5.0
*/
public DefaultParser build() {
return new DefaultParser(allowPartialMatching, stripLeadingAndTrailingQuotes, deprecatedHandler);
}
/**
* Sets if partial matching of long options is supported.
*
* By "partial matching" we mean that given the following code:
*
* <pre>
* {
* @code
* final Options options = new Options();
* options.addOption(new Option("d", "debug", false, "Turn on debug."));
* options.addOption(new Option("e", "extract", false, "Turn on extract."));
* options.addOption(new Option("o", "option", true, "Turn on option with argument."));
* }
* </pre>
*
* If "partial matching" is turned on, {@code -de} only matches the {@code "debug"} option. However, with
* "partial matching" disabled, {@code -de} would enable both {@code debug} as well as {@code extract}
*
* @param allowPartialMatching whether to allow partial matching of long options
* @return this builder, to allow method chaining
* @since 1.5.0
*/
public Builder setAllowPartialMatching(final boolean allowPartialMatching) {
this.allowPartialMatching = allowPartialMatching;
return this;
}
/**
* Sets the deprecated option handler.
*
* @param deprecatedHandler the deprecated option handler.
* @return {@code this} instance.
* @since 1.7.0
*/
public Builder setDeprecatedHandler(final Consumer<Option> deprecatedHandler) {
this.deprecatedHandler = deprecatedHandler;
return this;
}
/**
* Sets if balanced leading and trailing double quotes should be stripped from option arguments.
*
* If "stripping of balanced leading and trailing double quotes from option arguments" is true,
* the outermost balanced double quotes of option arguments values will be removed.
* For example, {@code -o '"x"'} getValue() will return {@code x}, instead of {@code "x"}
*
* If "stripping of balanced leading and trailing double quotes from option arguments" is null,
* then quotes will be stripped from option values separated by space from the option, but
* kept in other cases, which is the historic behavior.
*
* @param stripLeadingAndTrailingQuotes whether balanced leading and trailing double quotes should be stripped from option arguments.
* @return this builder, to allow method chaining
* @since 1.5.0
*/
public Builder setStripLeadingAndTrailingQuotes(final Boolean stripLeadingAndTrailingQuotes) {
this.stripLeadingAndTrailingQuotes = stripLeadingAndTrailingQuotes;
return this;
}
}
/**
* Creates a new {@link Builder} to create an {@link DefaultParser} using descriptive
* methods.
*
* @return a new {@link Builder} instance
* @since 1.5.0
*/
public static Builder builder() {
return new Builder();
}
static int indexOfEqual(final String token) {
return token.indexOf(Char.EQUAL);
}
/** The command-line instance. */
protected CommandLine cmd;
/** The current options. */
protected Options options;
/**
* Flag indicating how unrecognized tokens are handled. {@code true} to stop the parsing and add the remaining
* tokens to the args list. {@code false} to throw an exception.
*/
protected boolean stopAtNonOption;
/** The token currently processed. */
protected String currentToken;
/** The last option parsed. */
protected Option currentOption;
/** Flag indicating if tokens should no longer be analyzed and simply added as arguments of the command line. */
protected boolean skipParsing;
/** The required options and groups expected to be found when parsing the command line. */
protected List expectedOpts;
/** Flag indicating if partial matching of long options is supported. */
private final boolean allowPartialMatching;
/** Flag indicating if balanced leading and trailing double quotes should be stripped from option arguments.
* null represents the historic arbitrary behavior */
private final Boolean stripLeadingAndTrailingQuotes;
/**
* The deprecated option handler.
* <p>
* If you want to serialize this field, use a serialization proxy.
* </p>
*/
private final Consumer<Option> deprecatedHandler;
/**
* Creates a new DefaultParser instance with partial matching enabled.
*
* By "partial matching" we mean that given the following code:
*
* <pre>
* {
* @code
* final Options options = new Options();
* options.addOption(new Option("d", "debug", false, "Turn on debug."));
* options.addOption(new Option("e", "extract", false, "Turn on extract."));
* options.addOption(new Option("o", "option", true, "Turn on option with argument."));
* }
* </pre>
*
* with "partial matching" turned on, {@code -de} only matches the {@code "debug"} option. However, with
* "partial matching" disabled, {@code -de} would enable both {@code debug} as well as {@code extract}
* options.
*/
public DefaultParser() {
this.allowPartialMatching = true;
this.stripLeadingAndTrailingQuotes = null;
this.deprecatedHandler = CommandLine.Builder.DEPRECATED_HANDLER;
}
/**
* Create a new DefaultParser instance with the specified partial matching policy.
*
* By "partial matching" we mean that given the following code:
*
* <pre>
* {
* @code
* final Options options = new Options();
* options.addOption(new Option("d", "debug", false, "Turn on debug."));
* options.addOption(new Option("e", "extract", false, "Turn on extract."));
* options.addOption(new Option("o", "option", true, "Turn on option with argument."));
* }
* </pre>
*
* with "partial matching" turned on, {@code -de} only matches the {@code "debug"} option. However, with
* "partial matching" disabled, {@code -de} would enable both {@code debug} as well as {@code extract}
* options.
*
* @param allowPartialMatching if partial matching of long options shall be enabled
*/
public DefaultParser(final boolean allowPartialMatching) {
this.allowPartialMatching = allowPartialMatching;
this.stripLeadingAndTrailingQuotes = null;
this.deprecatedHandler = CommandLine.Builder.DEPRECATED_HANDLER;
}
/**
* Creates a new DefaultParser instance with the specified partial matching and quote
* stripping policy.
*
* @param allowPartialMatching if partial matching of long options shall be enabled
* @param stripLeadingAndTrailingQuotes if balanced outer double quoutes should be stripped
*/
private DefaultParser(final boolean allowPartialMatching, final Boolean stripLeadingAndTrailingQuotes, final Consumer<Option> deprecatedHandler) {
this.allowPartialMatching = allowPartialMatching;
this.stripLeadingAndTrailingQuotes = stripLeadingAndTrailingQuotes;
this.deprecatedHandler = deprecatedHandler;
}
/**
* Throws a {@link MissingArgumentException} if the current option didn't receive the number of arguments expected.
*/
private void checkRequiredArgs() throws ParseException {
if (currentOption != null && currentOption.requiresArg()) {
if (isJavaProperty(currentOption.getKey()) && currentOption.getValuesList().size() == 1) {
return;
}
throw new MissingArgumentException(currentOption);
}
}
/**
* Throws a {@link MissingOptionException} if all of the required options are not present.
*
* @throws MissingOptionException if any of the required Options are not present.
*/
protected void checkRequiredOptions() throws MissingOptionException {
// if there are required options that have not been processed
if (!expectedOpts.isEmpty()) {
throw new MissingOptionException(expectedOpts);
}
}
/**
* Searches for a prefix that is the long name of an option (-Xmx512m)
*
* @param token
*/
private String getLongPrefix(final String token) {
final String t = Util.stripLeadingHyphens(token);
int i;
String opt = null;
for (i = t.length() - 2; i > 1; i--) {
final String prefix = t.substring(0, i);
if (options.hasLongOption(prefix)) {
opt = prefix;
break;
}
}
return opt;
}
/**
* Gets a list of matching option strings for the given token, depending on the selected partial matching policy.
*
* @param token the token (may contain leading dashes)
* @return the list of matching option strings or an empty list if no matching option could be found
*/
private List<String> getMatchingLongOptions(final String token) {
if (allowPartialMatching) {
return options.getMatchingOptions(token);
}
final List<String> matches = new ArrayList<>(1);
if (options.hasLongOption(token)) {
matches.add(options.getOption(token).getLongOpt());
}
return matches;
}
/**
* Breaks {@code token} into its constituent parts using the following algorithm.
*
* <ul>
* <li>ignore the first character ("<b>-</b>")</li>
* <li>for each remaining character check if an {@link Option} exists with that id.</li>
* <li>if an {@link Option} does exist then add that character prepended with "<b>-</b>" to the list of processed
* tokens.</li>
* <li>if the {@link Option} can have an argument value and there are remaining characters in the token then add the
* remaining characters as a token to the list of processed tokens.</li>
* <li>if an {@link Option} does <b>NOT</b> exist <b>AND</b> {@code stopAtNonOption} <b>IS</b> set then add the
* special token "<b>--</b>" followed by the remaining characters and also the remaining tokens directly to the
* processed tokens list.</li>
* <li>if an {@link Option} does <b>NOT</b> exist <b>AND</b> {@code stopAtNonOption} <b>IS NOT</b> set then add
* that character prepended with "<b>-</b>".</li>
* </ul>
*
* @param token The current token to be <b>burst</b> at the first non-Option encountered.
* @throws ParseException if there are any problems encountered while parsing the command line token.
*/
protected void handleConcatenatedOptions(final String token) throws ParseException {
for (int i = 1; i < token.length(); i++) {
final String ch = String.valueOf(token.charAt(i));
if (!options.hasOption(ch)) {
handleUnknownToken(stopAtNonOption && i > 1 ? token.substring(i) : token);
break;
}
handleOption(options.getOption(ch));
if (currentOption != null && token.length() != i + 1) {
// add the trail as an argument of the option
currentOption.processValue(stripLeadingAndTrailingQuotesDefaultOff(token.substring(i + 1)));
break;
}
}
}
/**
* Handles the following tokens:
*
* --L --L=V --L V --l
*
* @param token the command line token to handle
*/
private void handleLongOption(final String token) throws ParseException {
if (indexOfEqual(token) == -1) {
handleLongOptionWithoutEqual(token);
} else {
handleLongOptionWithEqual(token);
}
}
/**
* Handles the following tokens:
*
* --L=V -L=V --l=V -l=V
*
* @param token the command line token to handle
*/
private void handleLongOptionWithEqual(final String token) throws ParseException {
final int pos = indexOfEqual(token);
final String value = token.substring(pos + 1);
final String opt = token.substring(0, pos);
final List<String> matchingOpts = getMatchingLongOptions(opt);
if (matchingOpts.isEmpty()) {
handleUnknownToken(currentToken);
} else if (matchingOpts.size() > 1 && !options.hasLongOption(opt)) {
throw new AmbiguousOptionException(opt, matchingOpts);
} else {
final String key = options.hasLongOption(opt) ? opt : matchingOpts.get(0);
final Option option = options.getOption(key);
if (option.acceptsArg()) {
handleOption(option);
currentOption.processValue(stripLeadingAndTrailingQuotesDefaultOff(value));
currentOption = null;
} else {
handleUnknownToken(currentToken);
}
}
}
/**
* Handles the following tokens:
*
* --L -L --l -l
*
* @param token the command line token to handle
*/
private void handleLongOptionWithoutEqual(final String token) throws ParseException {
final List<String> matchingOpts = getMatchingLongOptions(token);
if (matchingOpts.isEmpty()) {
handleUnknownToken(currentToken);
} else if (matchingOpts.size() > 1 && !options.hasLongOption(token)) {
throw new AmbiguousOptionException(token, matchingOpts);
} else {
final String key = options.hasLongOption(token) ? token : matchingOpts.get(0);
handleOption(options.getOption(key));
}
}
private void handleOption(final Option option) throws ParseException {
// check the previous option before handling the next one
checkRequiredArgs();
final Option copy = (Option) option.clone();
updateRequiredOptions(copy);
cmd.addOption(copy);
currentOption = copy.hasArg() ? copy : null;
}
/**
* Sets the values of Options using the values in {@code properties}.
*
* @param properties The value properties to be processed.
*/
private void handleProperties(final Properties properties) throws ParseException {
if (properties == null) {
return;
}
for (final Enumeration<?> e = properties.propertyNames(); e.hasMoreElements();) {
final String option = e.nextElement().toString();
final Option opt = options.getOption(option);
if (opt == null) {
throw new UnrecognizedOptionException("Default option wasn't defined", option);
}
// if the option is part of a group, check if another option of the group has been selected
final OptionGroup group = options.getOptionGroup(opt);
final boolean selected = group != null && group.isSelected();
if (!cmd.hasOption(option) && !selected) {
// get the value from the properties
final String value = properties.getProperty(option);
if (opt.hasArg()) {
if (Util.isEmpty(opt.getValues())) {
opt.processValue(stripLeadingAndTrailingQuotesDefaultOff(value));
}
} else if (!("yes".equalsIgnoreCase(value) || "true".equalsIgnoreCase(value) || "1".equalsIgnoreCase(value))) {
// if the value is not yes, true or 1 then don't add the option to the CommandLine
continue;
}
handleOption(opt);
currentOption = null;
}
}
}
/**
* Handles the following tokens:
*
* -S -SV -S V -S=V -S1S2 -S1S2 V -SV1=V2
*
* -L -LV -L V -L=V -l
*
* @param hyphenToken the command line token to handle
*/
private void handleShortAndLongOption(final String hyphenToken) throws ParseException {
final String token = Util.stripLeadingHyphens(hyphenToken);
final int pos = indexOfEqual(token);
if (token.length() == 1) {
// -S
if (options.hasShortOption(token)) {
handleOption(options.getOption(token));
} else {
handleUnknownToken(hyphenToken);
}
} else if (pos == -1) {
// no equal sign found (-xxx)
if (options.hasShortOption(token)) {
handleOption(options.getOption(token));
} else if (!getMatchingLongOptions(token).isEmpty()) {
// -L or -l
handleLongOptionWithoutEqual(hyphenToken);
} else {
// look for a long prefix (-Xmx512m)
final String opt = getLongPrefix(token);
if (opt != null && options.getOption(opt).acceptsArg()) {
handleOption(options.getOption(opt));
currentOption.processValue(stripLeadingAndTrailingQuotesDefaultOff(token.substring(opt.length())));
currentOption = null;
} else if (isJavaProperty(token)) {
// -SV1 (-Dflag)
handleOption(options.getOption(token.substring(0, 1)));
currentOption.processValue(stripLeadingAndTrailingQuotesDefaultOff(token.substring(1)));
currentOption = null;
} else {
// -S1S2S3 or -S1S2V
handleConcatenatedOptions(hyphenToken);
}
}
} else {
// equal sign found (-xxx=yyy)
final String opt = token.substring(0, pos);
final String value = token.substring(pos + 1);
if (opt.length() == 1) {
// -S=V
final Option option = options.getOption(opt);
if (option != null && option.acceptsArg()) {
handleOption(option);
currentOption.processValue(value);
currentOption = null;
} else {
handleUnknownToken(hyphenToken);
}
} else if (isJavaProperty(opt)) {
// -SV1=V2 (-Dkey=value)
handleOption(options.getOption(opt.substring(0, 1)));
currentOption.processValue(opt.substring(1));
currentOption.processValue(value);
currentOption = null;
} else {
// -L=V or -l=V
handleLongOptionWithEqual(hyphenToken);
}
}
}
/**
* Handles any command line token.
*
* @param token the command line token to handle
* @throws ParseException
*/
private void handleToken(final String token) throws ParseException {
if (token != null) {
currentToken = token;
if (skipParsing) {
cmd.addArg(token);
} else if ("--".equals(token)) {
skipParsing = true;
} else if (currentOption != null && currentOption.acceptsArg() && isArgument(token)) {
currentOption.processValue(stripLeadingAndTrailingQuotesDefaultOn(token));
} else if (token.startsWith("--")) {
handleLongOption(token);
} else if (token.startsWith("-") && !"-".equals(token)) {
handleShortAndLongOption(token);
} else {
handleUnknownToken(token);
}
if (currentOption != null && !currentOption.acceptsArg()) {
currentOption = null;
}
}
}
/**
* Handles an unknown token. If the token starts with a dash an UnrecognizedOptionException is thrown. Otherwise the
* token is added to the arguments of the command line. If the stopAtNonOption flag is set, this stops the parsing and
* the remaining tokens are added as-is in the arguments of the command line.
*
* @param token the command line token to handle
*/
private void handleUnknownToken(final String token) throws ParseException {
if (token.startsWith("-") && token.length() > 1 && !stopAtNonOption) {
throw new UnrecognizedOptionException("Unrecognized option: " + token, token);
}
cmd.addArg(token);
if (stopAtNonOption) {
skipParsing = true;
}
}
/**
* Tests if the token is a valid argument.
*
* @param token
*/
private boolean isArgument(final String token) {
return !isOption(token) || isNegativeNumber(token);
}
/**
* Tests if the specified token is a Java-like property (-Dkey=value).
*/
private boolean isJavaProperty(final String token) {
final String opt = token.isEmpty() ? null : token.substring(0, 1);
final Option option = options.getOption(opt);
return option != null && (option.getArgs() >= 2 || option.getArgs() == Option.UNLIMITED_VALUES);
}
/**
* Tests if the token looks like a long option.
*
* @param token
*/
private boolean isLongOption(final String token) {
if (token == null || !token.startsWith("-") || token.length() == 1) {
return false;
}
final int pos = indexOfEqual(token);
final String t = pos == -1 ? token : token.substring(0, pos);
if (!getMatchingLongOptions(t).isEmpty()) {
// long or partial long options (--L, -L, --L=V, -L=V, --l, --l=V)
return true;
}
if (getLongPrefix(token) != null && !token.startsWith("--")) {
// -LV
return true;
}
return false;
}
/**
* Tests if the token is a negative number.
*
* @param token
*/
private boolean isNegativeNumber(final String token) {
try {
Double.parseDouble(token);
return true;
} catch (final NumberFormatException e) {
return false;
}
}
/**
* Tests if the token looks like an option.
*
* @param token
*/
private boolean isOption(final String token) {
return isLongOption(token) || isShortOption(token);
}
/**
* Tests if the token looks like a short option.
*
* @param token
*/
private boolean isShortOption(final String token) {
// short options (-S, -SV, -S=V, -SV1=V2, -S1S2)
if (token == null || !token.startsWith("-") || token.length() == 1) {
return false;
}
// remove leading "-" and "=value"
final int pos = indexOfEqual(token);
final String optName = pos == -1 ? token.substring(1) : token.substring(1, pos);
if (options.hasShortOption(optName)) {
return true;
}
// check for several concatenated short options
return !optName.isEmpty() && options.hasShortOption(String.valueOf(optName.charAt(0)));
}
@Override
public CommandLine parse(final Options options, final String[] arguments) throws ParseException {
return parse(options, arguments, null);
}
@Override
public CommandLine parse(final Options options, final String[] arguments, final boolean stopAtNonOption) throws ParseException {
return parse(options, arguments, null, stopAtNonOption);
}
/**
* Parses the arguments according to the specified options and properties.
*
* @param options the specified Options
* @param arguments the command line arguments
* @param properties command line option name-value pairs
* @return the list of atomic option and value tokens
*
* @throws ParseException if there are any problems encountered while parsing the command line tokens.
*/
public CommandLine parse(final Options options, final String[] arguments, final Properties properties) throws ParseException {
return parse(options, arguments, properties, false);
}
/**
* Parses the arguments according to the specified options and properties.
*
* @param options the specified Options
* @param arguments the command line arguments
* @param properties command line option name-value pairs
* @param stopAtNonOption if {@code true} an unrecognized argument stops the parsing and the remaining arguments
* are added to the {@link CommandLine}s args list. If {@code false} an unrecognized argument triggers a
* ParseException.
*
* @return the list of atomic option and value tokens
* @throws ParseException if there are any problems encountered while parsing the command line tokens.
*/
public CommandLine parse(final Options options, final String[] arguments, final Properties properties, final boolean stopAtNonOption)
throws ParseException {
this.options = options;
this.stopAtNonOption = stopAtNonOption;
skipParsing = false;
currentOption = null;
expectedOpts = new ArrayList<>(options.getRequiredOptions());
// clear the data from the groups
for (final OptionGroup group : options.getOptionGroups()) {
group.setSelected(null);
}
cmd = CommandLine.builder().setDeprecatedHandler(deprecatedHandler).build();
if (arguments != null) {
for (final String argument : arguments) {
handleToken(argument);
}
}
// check the arguments of the last option
checkRequiredArgs();
// add the default options
handleProperties(properties);
checkRequiredOptions();
return cmd;
}
/**
* Strips balanced leading and trailing quotes if the stripLeadingAndTrailingQuotes is set
* If stripLeadingAndTrailingQuotes is null, then do not strip
*
* @param token a string
* @return token with the quotes stripped (if set)
*/
private String stripLeadingAndTrailingQuotesDefaultOff(final String token) {
if (stripLeadingAndTrailingQuotes != null && stripLeadingAndTrailingQuotes) {
return Util.stripLeadingAndTrailingQuotes(token);
}
return token;
}
/**
* Strips balanced leading and trailing quotes if the stripLeadingAndTrailingQuotes is set
* If stripLeadingAndTrailingQuotes is null, then do not strip
*
* @param token a string
* @return token with the quotes stripped (if set)
*/
private String stripLeadingAndTrailingQuotesDefaultOn(final String token) {
if (stripLeadingAndTrailingQuotes == null || stripLeadingAndTrailingQuotes) {
return Util.stripLeadingAndTrailingQuotes(token);
}
return token;
}
/**
* Removes the option or its group from the list of expected elements.
*
* @param option
*/
private void updateRequiredOptions(final Option option) throws AlreadySelectedException {
if (option.isRequired()) {
expectedOpts.remove(option.getKey());
}
// if the option is in an OptionGroup make that option the selected option of the group
if (options.getOptionGroup(option) != null) {
final OptionGroup group = options.getOptionGroup(option);
if (group.isRequired()) {
expectedOpts.remove(group);
}
group.setSelected(option);
}
}
}