/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying file Copyright.txt or https://cmake.org/licensing for details. */ #include #include #include #include #include #include #include #include #include #include #include "cmArgumentParser.h" #include "cmArgumentParserTypes.h" namespace { struct Result : public ArgumentParser::ParseResult { bool Option1 = false; bool Option2 = false; std::string String1; cm::optional String2; cm::optional String3; ArgumentParser::Maybe String4; ArgumentParser::NonEmpty String5; ArgumentParser::NonEmpty String6; ArgumentParser::NonEmpty> List1; ArgumentParser::NonEmpty> List2; cm::optional>> List3; cm::optional>> List4; cm::optional>> List5; cm::optional>> List6; std::vector> Multi1; std::vector> Multi2; cm::optional>> Multi3; cm::optional>> Multi4; cm::optional Pos0; cm::optional Pos1; cm::optional Pos2; bool Func0_ = false; ArgumentParser::Continue Func0(cm::string_view) { Func0_ = true; return ArgumentParser::Continue::No; } std::string Func1_; ArgumentParser::Continue Func1(cm::string_view arg) { Func1_ = std::string(arg); return ArgumentParser::Continue::No; } std::map> Func2_; ArgumentParser::Continue Func2(cm::string_view key, cm::string_view arg) { Func2_[std::string(key)].emplace_back(arg); return key == "FUNC_2b" ? ArgumentParser::Continue::Yes : ArgumentParser::Continue::No; } std::vector Func3_; ArgumentParser::Continue Func3(cm::string_view arg) { Func3_.emplace_back(arg); return ArgumentParser::Continue::Yes; } std::map> Func4_; ArgumentParser::Continue Func4(cm::string_view key, cm::string_view arg) { Func4_[std::string(key)].emplace_back(arg); return key == "FUNC_4b" ? ArgumentParser::Continue::Yes : ArgumentParser::Continue::No; } ArgumentParser::Maybe UnboundMaybe{ 'u', 'n', 'b', 'o', 'u', 'n', 'd' }; ArgumentParser::MaybeEmpty> UnboundMaybeEmpty{ 1, "unbound" }; ArgumentParser::NonEmpty> UnboundNonEmpty{ 1, "unbound" }; ArgumentParser::NonEmpty UnboundNonEmptyStr{ 'u', 'n', 'b', 'o', 'u', 'n', 'd' }; std::vector ParsedKeywords; }; std::initializer_list const args = { /* clang-format off */ "pos0", // position index 0 "OPTION_1", // option "pos2", // position index 2, ignored because after keyword // "OPTION_2", // option that is not present "STRING_1", // string arg missing value "STRING_2", "foo", "bar", // string arg + unparsed value, presence captured // "STRING_3", // string arg that is not present "STRING_4", // string arg allowed to be missing value "STRING_5", "foo", // string arg that is not empty "STRING_6", "", // string arg that is empty "LIST_1", // list arg missing values "LIST_2", "foo", "bar", // list arg with 2 elems "LIST_3", "bar", // list arg ... "LIST_3", "foo", // ... with continuation "LIST_4", // list arg missing values, presence captured // "LIST_5", // list arg that is not present "LIST_6", // list arg allowed to be empty "MULTI_2", // multi list with 0 lists "MULTI_3", "foo", "bar", // multi list with first list with two elems "MULTI_3", "bar", "foo", // multi list with second list with two elems // "MULTI_4", // multi list arg that is not present "FUNC_0", // callback arg missing value "FUNC_1", "foo", "ign1", // callback with one arg + unparsed value "FUNC_2a", "foo", "ign2", // callback with keyword-dependent arg count "FUNC_2b", "bar", "zot", // callback with keyword-dependent arg count "FUNC_3", "foo", "bar", // callback with list arg ... "FUNC_4a", "foo", "ign4", // callback with keyword-dependent arg count "FUNC_4b", "bar", "zot", // callback with keyword-dependent arg count /* clang-format on */ }; bool verifyResult(Result const& result, std::vector const& unparsedArguments) { static std::vector const foobar = { "foo", "bar" }; static std::vector const barfoo = { "bar", "foo" }; static std::vector const unbound = { "unbound" }; static std::vector const parsedKeywords = { /* clang-format off */ "OPTION_1", "STRING_1", "STRING_2", "STRING_4", "STRING_5", "STRING_6", "LIST_1", "LIST_2", "LIST_3", "LIST_3", "LIST_4", "LIST_6", "MULTI_2", "MULTI_3", "MULTI_3", "FUNC_0", "FUNC_1", "FUNC_2a", "FUNC_2b", "FUNC_3", "FUNC_4a", "FUNC_4b", /* clang-format on */ }; static std::map> const func2map = { { "FUNC_2a", { "foo" } }, { "FUNC_2b", { "bar", "zot" } } }; static std::map> const func4map = { { "FUNC_4a", { "foo" } }, { "FUNC_4b", { "bar", "zot" } } }; static std::map const keywordErrors = { { "STRING_1"_s, " missing required value\n" }, { "STRING_6"_s, " empty string not allowed\n" }, { "LIST_1"_s, " missing required value\n" }, { "LIST_4"_s, " missing required value\n" }, { "FUNC_0"_s, " missing required value\n" } }; static std::vector const unparsed = { "pos2", "bar", "ign1", "ign2", "ign4" }; #define ASSERT_TRUE(x) \ do { \ if (!(x)) { \ std::cout << "ASSERT_TRUE(" #x ") failed on line " << __LINE__ << "\n"; \ return false; \ } \ } while (false) ASSERT_TRUE(!result); ASSERT_TRUE(result.Option1); ASSERT_TRUE(!result.Option2); ASSERT_TRUE(result.String1.empty()); ASSERT_TRUE(result.String2); ASSERT_TRUE(*result.String2 == "foo"); ASSERT_TRUE(!result.String3); ASSERT_TRUE(result.String4.empty()); ASSERT_TRUE(result.String5 == "foo"); ASSERT_TRUE(result.String6.empty()); ASSERT_TRUE(result.List1.empty()); ASSERT_TRUE(result.List2 == foobar); ASSERT_TRUE(result.List3); ASSERT_TRUE(*result.List3 == barfoo); ASSERT_TRUE(result.List4); ASSERT_TRUE(result.List4->empty()); ASSERT_TRUE(!result.List5); ASSERT_TRUE(result.List6); ASSERT_TRUE(result.List6->empty()); ASSERT_TRUE(result.Multi1.empty()); ASSERT_TRUE(result.Multi2.size() == 1); ASSERT_TRUE(result.Multi2[0].empty()); ASSERT_TRUE(result.Multi3); ASSERT_TRUE((*result.Multi3).size() == 2); ASSERT_TRUE((*result.Multi3)[0] == foobar); ASSERT_TRUE((*result.Multi3)[1] == barfoo); ASSERT_TRUE(!result.Multi4); ASSERT_TRUE(result.Pos0 == "pos0"); ASSERT_TRUE(!result.Pos1); ASSERT_TRUE(!result.Pos2); ASSERT_TRUE(result.Func0_ == false); ASSERT_TRUE(result.Func1_ == "foo"); ASSERT_TRUE(result.Func2_ == func2map); ASSERT_TRUE(result.Func3_ == foobar); ASSERT_TRUE(result.Func4_ == func4map); ASSERT_TRUE(unparsedArguments == unparsed); ASSERT_TRUE(result.UnboundMaybe == "unbound"); ASSERT_TRUE(result.UnboundMaybeEmpty == unbound); ASSERT_TRUE(result.UnboundNonEmpty == unbound); ASSERT_TRUE(result.UnboundNonEmptyStr == "unbound"); ASSERT_TRUE(result.ParsedKeywords == parsedKeywords); ASSERT_TRUE(result.GetKeywordErrors().size() == keywordErrors.size()); for (auto const& ke : result.GetKeywordErrors()) { auto const ki = keywordErrors.find(ke.first); ASSERT_TRUE(ki != keywordErrors.end()); ASSERT_TRUE(ke.second == ki->second); } return true; } bool testArgumentParserDynamic() { Result result; std::vector unparsedArguments; std::function func4 = [&result](cm::string_view key, cm::string_view arg) -> ArgumentParser::Continue { return result.Func4(key, arg); }; static_cast(result) = cmArgumentParser{} .Bind(0, result.Pos0) .Bind(1, result.Pos1) .Bind(2, result.Pos2) .Bind("OPTION_1"_s, result.Option1) .Bind("OPTION_2"_s, result.Option2) .Bind("STRING_1"_s, result.String1) .Bind("STRING_2"_s, result.String2) .Bind("STRING_3"_s, result.String3) .Bind("STRING_4"_s, result.String4) .Bind("STRING_5"_s, result.String5) .Bind("STRING_6"_s, result.String6) .Bind("LIST_1"_s, result.List1) .Bind("LIST_2"_s, result.List2) .Bind("LIST_3"_s, result.List3) .Bind("LIST_4"_s, result.List4) .Bind("LIST_5"_s, result.List5) .Bind("LIST_6"_s, result.List6) .Bind("MULTI_1"_s, result.Multi1) .Bind("MULTI_2"_s, result.Multi2) .Bind("MULTI_3"_s, result.Multi3) .Bind("MULTI_4"_s, result.Multi4) .Bind("FUNC_0"_s, [&result](cm::string_view arg) -> ArgumentParser::Continue { return result.Func0(arg); }) .Bind("FUNC_1"_s, [&result](cm::string_view arg) -> ArgumentParser::Continue { return result.Func1(arg); }) .Bind("FUNC_2a"_s, [&result](cm::string_view key, cm::string_view arg) -> ArgumentParser::Continue { return result.Func2(key, arg); }) .Bind("FUNC_2b"_s, [&result](cm::string_view key, cm::string_view arg) -> ArgumentParser::Continue { return result.Func2(key, arg); }) .Bind("FUNC_3"_s, [&result](cm::string_view arg) -> ArgumentParser::Continue { return result.Func3(arg); }) .Bind("FUNC_4a"_s, func4) .Bind("FUNC_4b"_s, func4) .BindParsedKeywords(result.ParsedKeywords) .Parse(args, &unparsedArguments); return verifyResult(result, unparsedArguments); } static auto const parserStaticFunc4 = [](Result& result, cm::string_view key, cm::string_view arg) -> ArgumentParser::Continue { return result.Func4(key, arg); }; static auto const parserStatic = // cmArgumentParser{} .Bind(0, &Result::Pos0) .Bind(1, &Result::Pos1) .Bind(2, &Result::Pos2) .Bind("OPTION_1"_s, &Result::Option1) .Bind("OPTION_2"_s, &Result::Option2) .Bind("STRING_1"_s, &Result::String1) .Bind("STRING_2"_s, &Result::String2) .Bind("STRING_3"_s, &Result::String3) .Bind("STRING_4"_s, &Result::String4) .Bind("STRING_5"_s, &Result::String5) .Bind("STRING_6"_s, &Result::String6) .Bind("LIST_1"_s, &Result::List1) .Bind("LIST_2"_s, &Result::List2) .Bind("LIST_3"_s, &Result::List3) .Bind("LIST_4"_s, &Result::List4) .Bind("LIST_5"_s, &Result::List5) .Bind("LIST_6"_s, &Result::List6) .Bind("MULTI_1"_s, &Result::Multi1) .Bind("MULTI_2"_s, &Result::Multi2) .Bind("MULTI_3"_s, &Result::Multi3) .Bind("MULTI_4"_s, &Result::Multi4) .Bind("FUNC_0"_s, &Result::Func0) .Bind("FUNC_1"_s, &Result::Func1) .Bind("FUNC_2a"_s, &Result::Func2) .Bind("FUNC_2b"_s, &Result::Func2) .Bind("FUNC_3"_s, [](Result& result, cm::string_view arg) -> ArgumentParser::Continue { return result.Func3(arg); }) .Bind("FUNC_4a"_s, parserStaticFunc4) .Bind("FUNC_4b"_s, parserStaticFunc4) .BindParsedKeywords(&Result::ParsedKeywords) /* keep semicolon on own line */; bool testArgumentParserStatic() { std::vector unparsedArguments; Result const result = parserStatic.Parse(args, &unparsedArguments); return verifyResult(result, unparsedArguments); } bool testArgumentParserStaticBool() { std::vector unparsedArguments; Result result; ASSERT_TRUE(parserStatic.Parse(result, args, &unparsedArguments) == false); return verifyResult(result, unparsedArguments); } } // namespace int testArgumentParser(int /*unused*/, char* /*unused*/[]) { if (!testArgumentParserDynamic()) { std::cout << "While executing testArgumentParserDynamic().\n"; return -1; } if (!testArgumentParserStatic()) { std::cout << "While executing testArgumentParserStatic().\n"; return -1; } if (!testArgumentParserStaticBool()) { std::cout << "While executing testArgumentParserStaticBool().\n"; return -1; } return 0; }