Several bug fixes in usage, and improvement in usage and help #333
Conversation
- Display mutually exclusive arguments as ``[[-a]|[-b]]`` in usage
- Add ... trailer to repeatable arguments in usage: `[-x]...```
- Implement the following enhancements:
By default usage is reported on a single line.
The ``ArgumentParser::set_usage_max_line_width(width)`` method can be used
to display the usage() on multiple line, by defining the maximum line width.
It can be accompanied by a call to ``ArgumentParser::set_usage_break_on_mutex()``
to ask grouped mutually exclusive arguments to be displayed on a separate line.
The following snippet
```cpp
argparse::ArgumentParser program("program");
program.set_usage_max_line_width(80);
program.set_usage_break_on_mutex();
program.add_argument("--quite-long-option-name").flag();
auto &group = program.add_mutually_exclusive_group();
group.add_argument("-a").flag();
group.add_argument("-b").flag();
program.add_argument("-c").flag();
program.add_argument("--another-one").flag();
program.add_argument("-d").flag();
program.add_argument("--yet-another-long-one").flag();
program.add_argument("--will-go-on-new-line").flag();
std::cout << program.usage() << std::endl;
```
will display:
```console
Usage: program [--help] [--version] [--quite-long-option-name]
[[-a]|[-b]]
[-c] [--another-one] [-d] [--yet-another-long-one]
[--will-go-on-new-line]
```
Furthermore arguments can be separated into several groups by calling
``ArgumentParser::add_group(group_name)``. Only optional arguments should
be specified after the first call to add_group().
```cpp
argparse::ArgumentParser program("program");
program.set_usage_max_line_width(80);
program.add_argument("-a").flag().help("help_a");
program.add_group("Advanced options");
program.add_argument("-b").flag().help("help_b");
```
will display:
```console
Usage: program [--help] [--version] [-a]
Advanced options:
[-b]
```
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
include/argparse/argparse.hpp
Outdated
| const std::string arg_inline_usage = argument.get_inline_usage(); | ||
| const MutuallyExclusiveGroup *arg_mutex = | ||
| get_belonging_mutex(&argument); | ||
| if (cur_mutex && !arg_mutex) { |
There was a problem hiding this comment.
implicit conversion const argparse::ArgumentParser::MutuallyExclusiveGroup * -> bool
| if (cur_mutex && !arg_mutex) { | |
| if (cur_mutex && (arg_mutex == nullptr)) { |
| stream << curline << std::endl; | ||
| curline = std::string(indent_size, ' '); | ||
| } | ||
| } else if (!cur_mutex && arg_mutex) { |
There was a problem hiding this comment.
implicit conversion const argparse::ArgumentParser::MutuallyExclusiveGroup * -> bool
| } else if (!cur_mutex && arg_mutex) { | |
| } else if ((cur_mutex == nullptr) && arg_mutex) { |
| stream << curline << std::endl; | ||
| curline = std::string(indent_size, ' '); | ||
| } | ||
| } else if (!cur_mutex && arg_mutex) { |
There was a problem hiding this comment.
implicit conversion const argparse::ArgumentParser::MutuallyExclusiveGroup * -> bool
| } else if (!cur_mutex && arg_mutex) { | |
| } else if (!cur_mutex && (arg_mutex != nullptr)) { |
| curline = std::string(indent_size, ' '); | ||
| } | ||
| curline += " ["; | ||
| } else if (cur_mutex && arg_mutex) { |
There was a problem hiding this comment.
implicit conversion const argparse::ArgumentParser::MutuallyExclusiveGroup * -> bool
| } else if (cur_mutex && arg_mutex) { | |
| } else if ((cur_mutex != nullptr) && arg_mutex) { |
| curline = std::string(indent_size, ' '); | ||
| } | ||
| curline += " ["; | ||
| } else if (cur_mutex && arg_mutex) { |
There was a problem hiding this comment.
implicit conversion const argparse::ArgumentParser::MutuallyExclusiveGroup * -> bool
| } else if (cur_mutex && arg_mutex) { | |
| } else if (cur_mutex && (arg_mutex != nullptr)) { |
| stream << curline << std::endl; | ||
| curline = std::string(indent_size, ' '); | ||
| curline += " "; | ||
| } else if (!cur_mutex) { |
There was a problem hiding this comment.
implicit conversion const argparse::ArgumentParser::MutuallyExclusiveGroup * -> bool
| } else if (!cur_mutex) { | |
| } else if (cur_mutex == nullptr) { |
| } | ||
| curline += arg_inline_usage; | ||
| } | ||
| if (cur_mutex) { |
There was a problem hiding this comment.
implicit conversion const argparse::ArgumentParser::MutuallyExclusiveGroup * -> bool
| if (cur_mutex) { | |
| if (cur_mutex != nullptr) { |
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
| const std::string arg_inline_usage = argument.get_inline_usage(); | ||
| const MutuallyExclusiveGroup *arg_mutex = | ||
| get_belonging_mutex(&argument); | ||
| if ((cur_mutex != nullptr) && !arg_mutex) { |
There was a problem hiding this comment.
implicit conversion const argparse::ArgumentParser::MutuallyExclusiveGroup * -> bool
| if ((cur_mutex != nullptr) && !arg_mutex) { | |
| if ((cur_mutex != nullptr) && (arg_mutex == nullptr)) { |
|
oops sorry for the erroneous closing. reopened as #334 with ctidy fixes |
Display mutually exclusive arguments as
[[-a]|[-b]]in usageAdd ... trailer to repeatable arguments in usage: `[-x]...```
Implement the following enhancements:
By default usage is reported on a single line.
The
ArgumentParser::set_usage_max_line_width(width)method can be used to display the usage() on multiple line, by defining the maximum line width.It can be accompanied by a call to
ArgumentParser::set_usage_break_on_mutex()to ask grouped mutually exclusive arguments to be displayed on a separate line.The following snippet
will display:
Furthermore arguments can be separated into several groups by calling
ArgumentParser::add_group(group_name). Only optional arguments should be specified after the first call to add_group().will display: