|
|
| format_man ()=default |
| Defaulted.
|
|
| format_man (format_man const &pf)=default |
| Defaulted.
|
|
format_man & | operator= (format_man const &pf)=default |
| Defaulted.
|
|
| format_man (format_man &&)=default |
| Defaulted.
|
|
format_man & | operator= (format_man &&)=default |
| Defaulted.
|
|
| ~format_man ()=default |
| Defaulted.
|
|
| format_man (std::vector< std::string > const &names, bool const advanced=false) |
| Initializes a format_help_base object.
|
|
void | add_flag (bool &value, char const short_id, std::string const &long_id, std::string const &desc, option_spec const spec) |
| Adds a seqan3::print_list_item call to be evaluated later on.
|
|
void | add_line (std::string const &text, bool is_paragraph, option_spec const spec) |
| Adds a print_line call to parser_set_up_calls.
|
|
void | add_list_item (std::string const &key, std::string const &desc, option_spec const spec) |
| Adds a seqan3::print_list_item call to parser_set_up_calls.
|
|
void | add_option (option_type &value, char const short_id, std::string const &long_id, std::string const &desc, option_spec const spec, validator_type &&option_validator) |
| Adds a seqan3::print_list_item call to be evaluated later on.
|
|
void | add_positional_option (option_type &value, std::string const &desc, validator_type &option_validator) |
| Adds a seqan3::print_list_item call to be evaluated later on.
|
|
void | add_section (std::string const &title, option_spec const spec) |
| Adds a print_section call to parser_set_up_calls.
|
|
void | add_subsection (std::string const &title, option_spec const spec) |
| Adds a print_subsection call to parser_set_up_calls.
|
|
void | parse (argument_parser_meta_data &parser_meta) |
| Initiates the printing of the help page to std::cout.
|
|
|
friend | derived_type |
| Befriend the derived type so it can access private functions.
|
|
argument_parser_meta_data | meta |
| Stores all meta information about the application.
|
|
format_man & | derived_t () |
| Returns the derived type.
|
|
void | print_legal () |
| Prints the legal information.
|
|
void | print_line (std::string const &text) |
| Delegates to seqan3::print_line(std::string const & text, true) of each format.
|
|
void | print_synopsis () |
| Prints a synopsis in any format.
|
|
void | print_version () |
| Prints the version information.
|
|
std::string | escape_special_xml_chars (std::string const &original) |
| Escapes certain characters for correct output.
|
|
static std::string | expand_multiple_flags (std::string const &flag_cluster) |
| Expands multiple one character flag identifiers for pretty help output.
|
|
template<detail::is_container_option container_type> |
static std::string | get_type_name_as_string (container_type const &) |
| Returns the value_type of the input container as a string (reflection).
|
|
template<typename value_type > |
static std::string | get_type_name_as_string (value_type const &) |
| Returns the input type as a string (reflection).
|
|
template<detail::is_container_option container_type> |
static std::string | option_type_and_list_info (container_type const &container) |
| Formats the container and its value_type for the help page printing.
|
|
template<typename option_value_type > |
static std::string | option_type_and_list_info (option_value_type const &value) |
| Formats the type of a value for the help page printing.
|
|
static std::string | prep_id_for_help (char const short_id, std::string const &long_id) |
| Formats the option/flag identifier pair for the help page printing.
|
|
std::vector< std::string > | command_names |
| The names of subcommand programs.
|
|
std::vector< std::function< void()> > | parser_set_up_calls |
| Vector of functions that stores all calls except add_positional_option.
|
|
std::vector< std::function< void()> > | positional_option_calls |
| Vector of functions that stores add_positional_option calls.
|
|
unsigned | positional_option_count |
| Keeps track of the number of positional options.
|
|
bool | show_advanced_options |
| Whether to show advanced options or not.
|
|
The format that prints the help page information formatted for a man page to std::cout.
The help page printing is not done immediately, because the user might not provide meta information, positional options, etc. in the correct order. In addition the needed order would be different from the parse format. Thus the calls are stored (parser_set_up_calls and positional_option_calls) and only evaluated when calling seqan3::detail::format_help_base::parse.