|
|
| format_html ()=default |
| Defaulted.
|
|
| format_html (format_html const &pf)=default |
| Defaulted.
|
|
format_html & | operator= (format_html const &pf)=default |
| Defaulted.
|
|
| format_html (format_html &&)=default |
| Defaulted.
|
|
format_html & | operator= (format_html &&)=default |
| Defaulted.
|
|
| ~format_html ()=default |
| Defaulted.
|
|
| format_html (std::vector< std::string > const &names, update_notifications const version_updates, bool const advanced=false) |
| Defaulted.
|
|
void | add_option (option_type &value, config< validator_t > const &config) |
| Adds a sharg::print_list_item call to be evaluated later on.
|
|
void | add_flag (bool &value, config< validator_t > const &config) |
| Adds a sharg::print_list_item call to be evaluated later on.
|
|
void | add_positional_option (option_type &value, config< validator_t > const &config) |
| Adds a sharg::print_list_item call to be evaluated later on.
|
|
void | parse (parser_meta_data &parser_meta) |
| Initiates the printing of the help page to std::cout.
|
|
void | add_section (std::string const &title, bool const advanced_only) |
| Adds a print_section call to parser_set_up_calls.
|
|
void | add_subsection (std::string const &title, bool const advanced_only) |
| Adds a print_subsection call to parser_set_up_calls.
|
|
void | add_line (std::string const &text, bool is_paragraph, bool const advanced_only) |
| Adds a print_line call to parser_set_up_calls.
|
|
void | add_list_item (std::string const &key, std::string const &desc, bool const advanced_only) |
| Adds a sharg::print_list_item call to parser_set_up_calls.
|
|
|
parser_meta_data | meta |
| Stores all meta information about the application.
|
|
friend | derived_type |
| Befriend the derived type so it can access private functions.
|
|
format_html & | derived_t () |
| Returns the derived type.
|
|
void | print_synopsis () |
| Prints a synopsis in any format.
|
|
void | print_line (std::string const &text) |
| Delegates to sharg::print_line(std::string const & text, true) of each format.
|
|
void | print_version () |
| Prints the version information.
|
|
void | print_legal () |
| Prints the legal information.
|
|
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 | get_type_name_as_string (container_type const &) |
| Returns the value_type of the input container as a string (reflection).
|
|
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.
|
|
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.
|
|
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.
|
|
static 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<typename option_type , typename default_type > |
static std::string | get_default_message (option_type const &option, default_type const &value) |
| Returns the default message for the help page.
|
|
update_notifications | version_check_dev_decision |
| Set on construction and indicates whether the developer deactivated the version check calls completely.
|
|
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.
|
|
std::vector< std::string > | command_names |
| The names of subcommand programs.
|
|
bool | show_advanced_options |
| Whether to show advanced options or not.
|
|
The format that prints the help page as html 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 format_help::parse().