Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ParserMode setting as enum rather than GetoptMode as bool #690

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

ParserMode setting as enum rather than GetoptMode as bool #690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9dc2f1
Use enum for ParserMode
rmunn Aug 27, 2020
ee2f58e
Rename parser mode enums as per discussion
rmunn Feb 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 1 addition & 31 deletions src/CommandLine/Core/GetoptTokenizer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,36 +88,6 @@ public static Result<IEnumerable<Token>, Error> Tokenize(
return Result.Succeed<IEnumerable<Token>, Error>(tokens.AsEnumerable(), errors.AsEnumerable());
}

public static Result<IEnumerable<Token>, Error> ExplodeOptionList(
Result<IEnumerable<Token>, Error> tokenizerResult,
Func<string, Maybe<char>> optionSequenceWithSeparatorLookup)
{
var tokens = tokenizerResult.SucceededWith().Memoize();

var exploded = new List<Token>(tokens is ICollection<Token> coll ? coll.Count : tokens.Count());
var nothing = Maybe.Nothing<char>(); // Re-use same Nothing instance for efficiency
var separator = nothing;
foreach (var token in tokens) {
if (token.IsName()) {
separator = optionSequenceWithSeparatorLookup(token.Text);
exploded.Add(token);
} else {
// Forced values are never considered option values, so they should not be split
if (separator.MatchJust(out char sep) && sep != '\0' && !token.IsValueForced()) {
if (token.Text.Contains(sep)) {
exploded.AddRange(token.Text.Split(sep).Select(Token.ValueFromSeparator));
} else {
exploded.Add(token);
}
} else {
exploded.Add(token);
}
separator = nothing; // Only first value after a separator can possibly be split
}
}
return Result.Succeed(exploded as IEnumerable<Token>, tokenizerResult.SuccessMessages());
}

public static Func<
IEnumerable<string>,
IEnumerable<OptionSpecification>,
Expand All @@ -131,7 +101,7 @@ public static Func<
return (arguments, optionSpecs) =>
{
var tokens = GetoptTokenizer.Tokenize(arguments, name => NameLookup.Contains(name, optionSpecs, nameComparer), ignoreUnknownArguments, enableDashDash, posixlyCorrect);
var explodedTokens = GetoptTokenizer.ExplodeOptionList(tokens, name => NameLookup.HavingSeparator(name, optionSpecs, nameComparer));
var explodedTokens = Tokenizer.ExplodeOptionList(tokens, name => NameLookup.HavingSeparator(name, optionSpecs, nameComparer));
return explodedTokens;
};
}
Expand Down
20 changes: 16 additions & 4 deletions src/CommandLine/Parser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,16 +185,28 @@ private static Result<IEnumerable<Token>, Error> Tokenize(
IEnumerable<OptionSpecification> optionSpecs,
ParserSettings settings)
{
return settings.GetoptMode
? GetoptTokenizer.ConfigureTokenizer(
switch (settings.ParserMode)
{
case ParserMode.GetoptParserV1:
return Tokenizer.ConfigureTokenizer(
settings.NameComparer,
settings.IgnoreUnknownArguments,
settings.EnableDashDash)(arguments, optionSpecs);

case ParserMode.GetoptParserV2:
return GetoptTokenizer.ConfigureTokenizer(
settings.NameComparer,
settings.IgnoreUnknownArguments,
settings.EnableDashDash,
settings.PosixlyCorrect)(arguments, optionSpecs)
: Tokenizer.ConfigureTokenizer(
settings.PosixlyCorrect)(arguments, optionSpecs);

// No need to test ParserMode.Default, as it should always be one of the above modes
default:
return Tokenizer.ConfigureTokenizer(
settings.NameComparer,
settings.IgnoreUnknownArguments,
settings.EnableDashDash)(arguments, optionSpecs);
}
}

private static ParserResult<T> MakeParserResult<T>(ParserResult<T> parserResult, ParserSettings settings)
Expand Down
45 changes: 35 additions & 10 deletions src/CommandLine/ParserSettings.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,14 @@

namespace CommandLine
{
public enum ParserMode
{
GetoptParserV1,
GetoptParserV2,

Default = GetoptParserV1
}

/// <summary>
/// Provides settings for <see cref="CommandLine.Parser"/>. Once consumed cannot be reused.
/// </summary>
Expand All @@ -27,7 +35,7 @@ public class ParserSettings : IDisposable
private Maybe<bool> enableDashDash;
private int maximumDisplayWidth;
private Maybe<bool> allowMultiInstance;
private bool getoptMode;
private ParserMode parserMode;
private Maybe<bool> posixlyCorrect;

/// <summary>
Expand All @@ -41,7 +49,7 @@ public ParserSettings()
autoVersion = true;
parsingCulture = CultureInfo.InvariantCulture;
maximumDisplayWidth = GetWindowWidth();
getoptMode = false;
parserMode = ParserMode.Default;
enableDashDash = Maybe.Nothing<bool>();
allowMultiInstance = Maybe.Nothing<bool>();
posixlyCorrect = Maybe.Nothing<bool>();
Expand Down Expand Up @@ -166,11 +174,11 @@ public bool AutoVersion
/// <summary>
/// Gets or sets a value indicating whether enable double dash '--' syntax,
/// that forces parsing of all subsequent tokens as values.
/// If GetoptMode is true, this defaults to true, but can be turned off by explicitly specifying EnableDashDash = false.
/// Normally defaults to false. If ParserMode = ParserMode.GetoptParserV2, this defaults to true, but can be turned off by explicitly specifying EnableDashDash = false.
/// </summary>
public bool EnableDashDash
{
get => enableDashDash.MatchJust(out bool value) ? value : getoptMode;
get => enableDashDash.MatchJust(out bool value) ? value : (parserMode == ParserMode.GetoptParserV2);
set => PopsicleSetter.Set(Consumed, ref enableDashDash, Maybe.Just(value));
}

Expand All @@ -185,21 +193,38 @@ public int MaximumDisplayWidth

/// <summary>
/// Gets or sets a value indicating whether options are allowed to be specified multiple times.
/// If GetoptMode is true, this defaults to true, but can be turned off by explicitly specifying AllowMultiInstance = false.
/// If ParserMode = ParserMode.GetoptParserV2, this defaults to true, but can be turned off by explicitly specifying AllowMultiInstance = false.
/// </summary>
public bool AllowMultiInstance
{
get => allowMultiInstance.MatchJust(out bool value) ? value : getoptMode;
get => allowMultiInstance.MatchJust(out bool value) ? value : (parserMode == ParserMode.GetoptParserV2);
set => PopsicleSetter.Set(Consumed, ref allowMultiInstance, Maybe.Just(value));
}

/// <summary>
/// Whether strict getopt-like processing is applied to option values; if true, AllowMultiInstance and EnableDashDash will default to true as well.
/// Set this to change how the parser processes command-line arguments. Currently valid values are:
/// <list>
/// <item>
/// <term>Classic</term>
/// <description>Uses - for short options and -- for long options.
/// Values of long options can only start with a - character if the = syntax is used.
/// E.g., "--string-option -x" will consider "-x" to be an option, not the value of "--string-option",
/// but "--string-option=-x" will consider "-x" to be the value of "--string-option".</description>
/// </item>
/// <item>
/// <term>Getopt</term>
/// <description>Strict getopt-like processing is applied to option values.
/// Mostly like classic mode, except that option values with = and with space are more consistent.
/// After an option that takes a value, and whose value was not specified with "=", the next argument will be considered the value even if it starts with "-".
/// E.g., both "--string-option=-x" and "--string-option -x" will consider "-x" to be the value of "--string-option".
/// If this mode is chosen, AllowMultiInstance and EnableDashDash will default to true as well, though they can be explicitly turned off if desired.</description>
/// </item>
/// </list>
/// </summary>
public bool GetoptMode
public ParserMode ParserMode
{
get => getoptMode;
set => PopsicleSetter.Set(Consumed, ref getoptMode, value);
get => parserMode;
set => PopsicleSetter.Set(Consumed, ref parserMode, value);
}

/// <summary>
Expand Down
6 changes: 3 additions & 3 deletions tests/CommandLine.Tests/Unit/Core/GetoptTokenizerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public void Explode_scalar_with_separator_in_odd_args_input_returns_sequence()

// Exercize system
var result =
GetoptTokenizer.ExplodeOptionList(
Tokenizer.ExplodeOptionList(
Result.Succeed(
Enumerable.Empty<Token>().Concat(new[] { Token.Name("i"), Token.Value("10"),
Token.Name("string-seq"), Token.Value("aaa,bb,cccc"), Token.Name("switch") }),
Expand All @@ -47,7 +47,7 @@ public void Explode_scalar_with_separator_in_even_args_input_returns_sequence()

// Exercize system
var result =
GetoptTokenizer.ExplodeOptionList(
Tokenizer.ExplodeOptionList(
Result.Succeed(
Enumerable.Empty<Token>().Concat(new[] { Token.Name("x"),
Token.Name("string-seq"), Token.Value("aaa,bb,cccc"), Token.Name("switch") }),
Expand Down Expand Up @@ -90,7 +90,7 @@ public void Should_return_error_if_option_format_with_equals_is_not_correct()
var errors = result.SuccessMessages();

Assert.NotNull(errors);
Assert.Equal(1, errors.Count());
Assert.NotEmpty(errors);
Assert.Equal(ErrorType.BadFormatTokenError, errors.First().Tag);

var tokens = result.SucceededWith();
Expand Down
8 changes: 4 additions & 4 deletions tests/CommandLine.Tests/Unit/GetoptParserTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ public void Getopt_parser_without_posixly_correct_allows_mixed_options_and_nonop
{
// Arrange
var sut = new Parser(config => {
config.GetoptMode = true;
config.ParserMode = ParserMode.GetoptParserV2;
config.PosixlyCorrect = false;
});

Expand Down Expand Up @@ -215,7 +215,7 @@ public void Getopt_parser_with_posixly_correct_stops_parsing_at_first_nonoption(
{
// Arrange
var sut = new Parser(config => {
config.GetoptMode = true;
config.ParserMode = ParserMode.GetoptParserV2;
config.PosixlyCorrect = true;
config.EnableDashDash = true;
});
Expand All @@ -233,7 +233,7 @@ public void Getopt_mode_defaults_to_EnableDashDash_being_true()
{
// Arrange
var sut = new Parser(config => {
config.GetoptMode = true;
config.ParserMode = ParserMode.GetoptParserV2;
config.PosixlyCorrect = false;
});
var args = new string [] {"--stringvalue", "foo", "256", "--", "-x", "-sbar" };
Expand All @@ -259,7 +259,7 @@ public void Getopt_mode_can_have_EnableDashDash_expicitly_disabled()
{
// Arrange
var sut = new Parser(config => {
config.GetoptMode = true;
config.ParserMode = ParserMode.GetoptParserV2;
config.PosixlyCorrect = false;
config.EnableDashDash = false;
});
Expand Down
48 changes: 24 additions & 24 deletions tests/CommandLine.Tests/Unit/SequenceParsingTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,31 +17,31 @@ public class SequenceParsingTests
{
// Issue #91
[Theory]
[InlineData(false)]
[InlineData(true)]
public static void Enumerable_with_separator_before_values_does_not_try_to_parse_too_much(bool useGetoptMode)
[InlineData(ParserMode.GetoptParserV1)]
[InlineData(ParserMode.GetoptParserV2)]
public static void Enumerable_with_separator_before_values_does_not_try_to_parse_too_much(ParserMode parserMode)
{
var args = "--exclude=a,b InputFile.txt".Split();
var expected = new Options_For_Issue_91 {
Excluded = new[] { "a", "b" },
Included = Enumerable.Empty<string>(),
InputFileName = "InputFile.txt",
};
var sut = new Parser(parserSettings => { parserSettings.GetoptMode = useGetoptMode; });
var sut = new Parser(parserSettings => { parserSettings.ParserMode = parserMode; });
var result = sut.ParseArguments<Options_For_Issue_91>(args);
result.Should().BeOfType<Parsed<Options_For_Issue_91>>();
result.As<Parsed<Options_For_Issue_91>>().Value.Should().BeEquivalentTo(expected);
}

// Issue #396
[Theory]
[InlineData(false)]
[InlineData(true)]
public static void Options_with_similar_names_are_not_ambiguous(bool useGetoptMode)
[InlineData(ParserMode.GetoptParserV1)]
[InlineData(ParserMode.GetoptParserV2)]
public static void Options_with_similar_names_are_not_ambiguous(ParserMode parserMode)
{
var args = new[] { "--configure-profile", "deploy", "--profile", "local" };
var expected = new Options_With_Similar_Names { ConfigureProfile = "deploy", Profile = "local", Deploys = Enumerable.Empty<string>() };
var sut = new Parser(parserSettings => { parserSettings.GetoptMode = useGetoptMode; });
var sut = new Parser(parserSettings => { parserSettings.ParserMode = parserMode; });
var result = sut.ParseArguments<Options_With_Similar_Names>(args);
result.Should().BeOfType<Parsed<Options_With_Similar_Names>>();
result.As<Parsed<Options_With_Similar_Names>>().Value.Should().BeEquivalentTo(expected);
Expand All @@ -68,61 +68,61 @@ public static void Values_with_same_name_as_sequence_option_do_not_cause_later_v

// Issue #454
[Theory]
[InlineData(false)]
[InlineData(true)]
[InlineData(ParserMode.GetoptParserV1)]
[InlineData(ParserMode.GetoptParserV2)]

public static void Enumerable_with_colon_separator_before_values_does_not_try_to_parse_too_much(bool useGetoptMode)
public static void Enumerable_with_colon_separator_before_values_does_not_try_to_parse_too_much(ParserMode parserMode)
{
var args = "-c chanA:chanB file.hdf5".Split();
var expected = new Options_For_Issue_454 {
Channels = new[] { "chanA", "chanB" },
ArchivePath = "file.hdf5",
};
var sut = new Parser(parserSettings => { parserSettings.GetoptMode = useGetoptMode; });
var sut = new Parser(parserSettings => { parserSettings.ParserMode = parserMode; });
var result = sut.ParseArguments<Options_For_Issue_454>(args);
result.Should().BeOfType<Parsed<Options_For_Issue_454>>();
result.As<Parsed<Options_For_Issue_454>>().Value.Should().BeEquivalentTo(expected);
}

// Issue #510
[Theory]
[InlineData(false)]
[InlineData(true)]
[InlineData(ParserMode.GetoptParserV1)]
[InlineData(ParserMode.GetoptParserV2)]

public static void Enumerable_before_values_does_not_try_to_parse_too_much(bool useGetoptMode)
public static void Enumerable_before_values_does_not_try_to_parse_too_much(ParserMode parserMode)
{
var args = new[] { "-a", "1,2", "c" };
var expected = new Options_For_Issue_510 { A = new[] { "1", "2" }, C = "c" };
var sut = new Parser(parserSettings => { parserSettings.GetoptMode = useGetoptMode; });
var sut = new Parser(parserSettings => { parserSettings.ParserMode = parserMode; });
var result = sut.ParseArguments<Options_For_Issue_510>(args);
result.Should().BeOfType<Parsed<Options_For_Issue_510>>();
result.As<Parsed<Options_For_Issue_510>>().Value.Should().BeEquivalentTo(expected);
}

// Issue #617
[Theory]
[InlineData(false)]
[InlineData(true)]
[InlineData(ParserMode.GetoptParserV1)]
[InlineData(ParserMode.GetoptParserV2)]

public static void Enumerable_with_enum_before_values_does_not_try_to_parse_too_much(bool useGetoptMode)
public static void Enumerable_with_enum_before_values_does_not_try_to_parse_too_much(ParserMode parserMode)
{
var args = "--fm D,C a.txt".Split();
var expected = new Options_For_Issue_617 {
Mode = new[] { FMode.D, FMode.C },
Files = new[] { "a.txt" },
};
var sut = new Parser(parserSettings => { parserSettings.GetoptMode = useGetoptMode; });
var sut = new Parser(parserSettings => { parserSettings.ParserMode = parserMode; });
var result = sut.ParseArguments<Options_For_Issue_617>(args);
result.Should().BeOfType<Parsed<Options_For_Issue_617>>();
result.As<Parsed<Options_For_Issue_617>>().Value.Should().BeEquivalentTo(expected);
}

// Issue #619
[Theory]
[InlineData(false)]
[InlineData(true)]
[InlineData(ParserMode.GetoptParserV1)]
[InlineData(ParserMode.GetoptParserV2)]

public static void Separator_just_before_values_does_not_try_to_parse_values(bool useGetoptMode)
public static void Separator_just_before_values_does_not_try_to_parse_values(ParserMode parserMode)
{
var args = "--outdir ./x64/Debug --modules ../utilities/x64/Debug,../auxtool/x64/Debug m_xfunit.f03 m_xfunit_assertion.f03".Split();
var expected = new Options_For_Issue_619 {
Expand All @@ -131,7 +131,7 @@ public static void Separator_just_before_values_does_not_try_to_parse_values(boo
Ignores = Enumerable.Empty<string>(),
Srcs = new[] { "m_xfunit.f03", "m_xfunit_assertion.f03" },
};
var sut = new Parser(parserSettings => { parserSettings.GetoptMode = useGetoptMode; });
var sut = new Parser(parserSettings => { parserSettings.ParserMode = parserMode; });
var result = sut.ParseArguments<Options_For_Issue_619>(args);
result.Should().BeOfType<Parsed<Options_For_Issue_619>>();
result.As<Parsed<Options_For_Issue_619>>().Value.Should().BeEquivalentTo(expected);
Expand Down