aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTaylor C. Richberger <taywee@gmx.com>2017-12-12 18:04:02 -0700
committerGitHub <noreply@github.com>2017-12-12 18:04:02 -0700
commitf66f108159c9c075657b0709166d623da1375ff8 (patch)
tree7a0e890bf33217e475d4f80f852fe1db3cf95c3d
parentMerge pull request #53 from pavel-belikov/map-flag-list-choices (diff)
parentadd Options::HiddenFromUsage and Options::HiddenFromDescription (diff)
downloadargs.hxx-f66f108159c9c075657b0709166d623da1375ff8.tar.xz
Merge pull request #54 from pavel-belikov/hidden-from-usage-or-description
Add Options::HiddenFromUsage and Options::HiddenFromDescription
-rw-r--r--args.hxx22
-rw-r--r--test.cxx8
2 files changed, 21 insertions, 9 deletions
diff --git a/args.hxx b/args.hxx
index 549fd54..f947de6 100644
--- a/args.hxx
+++ b/args.hxx
@@ -514,17 +514,25 @@ namespace args
*/
Required = 0x02,
- /** Flag is excluded from help output.
+ /** Flag is excluded from usage line.
*/
- Hidden = 0x04,
+ HiddenFromUsage = 0x04,
+
+ /** Flag is excluded from options help.
+ */
+ HiddenFromDescription = 0x08,
/** Flag is global and can be used in any subcommand.
*/
- Global = 0x08,
+ Global = 0x10,
/** Flag stops a parser.
*/
- KickOut = 0x10,
+ KickOut = 0x20,
+
+ /** Flag is excluded from options help and usage line
+ */
+ Hidden = HiddenFromUsage | HiddenFromDescription,
};
inline Options operator | (Options lhs, Options rhs)
@@ -1391,7 +1399,7 @@ namespace args
for (Base *child: Children())
{
- if ((child->GetOptions() & Options::Hidden) != Options::None)
+ if ((child->GetOptions() & Options::HiddenFromDescription) != Options::None)
{
continue;
}
@@ -1412,7 +1420,7 @@ namespace args
std::vector <std::string> names;
for (Base *child: Children())
{
- if ((child->GetOptions() & Options::Hidden) != Options::None)
+ if ((child->GetOptions() & Options::HiddenFromUsage) != Options::None)
{
continue;
}
@@ -1941,7 +1949,7 @@ namespace args
for (Base *child: Children())
{
- if ((child->GetOptions() & Options::Hidden) != Options::None)
+ if ((child->GetOptions() & Options::HiddenFromDescription) != Options::None)
{
continue;
}
diff --git a/test.cxx b/test.cxx
index 1ad728b..01decbe 100644
--- a/test.cxx
+++ b/test.cxx
@@ -593,8 +593,8 @@ TEST_CASE("Required flags work as expected", "[args]")
TEST_CASE("Hidden options are excluded from help", "[args]")
{
args::ArgumentParser parser1("");
- args::ValueFlag<int> foo(parser1, "foo", "foo", {'f', "foo"}, args::Options::Hidden);
- args::ValueFlag<int> bar(parser1, "bar", "bar", {'b'});
+ args::ValueFlag<int> foo(parser1, "foo", "foo", {'f', "foo"}, args::Options::HiddenFromDescription);
+ args::ValueFlag<int> bar(parser1, "bar", "bar", {'b'}, args::Options::HiddenFromUsage);
args::Group group(parser1, "group");
args::ValueFlag<int> foo1(group, "foo", "foo", {'f', "foo"}, args::Options::Hidden);
args::ValueFlag<int> bar2(group, "bar", "bar", {'b'});
@@ -604,6 +604,10 @@ TEST_CASE("Hidden options are excluded from help", "[args]")
REQUIRE(std::get<0>(desc[0]) == "-b[bar]");
REQUIRE(std::get<0>(desc[1]) == "group");
REQUIRE(std::get<0>(desc[2]) == "-b[bar]");
+
+ parser1.helpParams.proglineShowFlags = true;
+ parser1.helpParams.proglinePreferShortFlags = true;
+ REQUIRE((parser1.GetProgramLine(parser1.helpParams) == std::vector<std::string>{"[-f <foo>]", "[-b <bar>]"}));
}
TEST_CASE("Implicit values work as expected", "[args]")