The format that prints the help page as html to std::cout. More...
#include <seqan3/argument_parser/detail/format_html.hpp>
Public Member Functions | |
Constructors, destructor and assignment | |
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, bool const advanced=false) | |
Initializes a format_help_base object. More... | |
Public Member Functions inherited from seqan3::detail::format_help_base< format_html > | |
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. More... | |
void | add_line (std::string const &text, bool is_paragraph, option_spec const spec) |
Adds a print_line call to parser_set_up_calls. More... | |
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. More... | |
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. More... | |
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. More... | |
void | add_section (std::string const &title, option_spec const spec) |
Adds a print_section call to parser_set_up_calls. More... | |
void | add_subsection (std::string const &title, option_spec const spec) |
Adds a print_subsection call to parser_set_up_calls. More... | |
void | parse (argument_parser_meta_data &parser_meta) |
Initiates the printing of the help page to std::cout. More... | |
Private Types | |
using | base_type = format_help_base< format_html > |
The CRTP base class type. | |
Private Member Functions | |
std::string | in_bold (std::string const &str) |
Format string as in_bold. More... | |
void | maybe_close_list () |
Closes HTML list tag (dl) if needed. | |
void | maybe_close_paragraph () |
Closes HTML paragraph tag (p) if needed. | |
void | print_footer () |
Prints a help page footer in HTML format to std::cout. | |
void | print_header () |
Prints a help page header in HTML format to std::cout. | |
void | print_line (std::string const &text, bool line_is_paragraph) |
Prints a text in HTML format to std::cout. More... | |
void | print_list_item (std::string const &term, std::string const &desc) |
Prints a help page list_item in HTML format to std::cout. More... | |
void | print_section (std::string const &title) |
Prints a section title in HTML format to std::cout. More... | |
void | print_subsection (std::string const &title) |
Prints a subsection title in HTML format to std::cout. More... | |
std::string | to_html (std::string const &input) |
Converts console output formatting to the HTML equivalent. More... | |
Private Attributes | |
friend | base_type |
Befriend the base class to give access to the private member functions. | |
bool | is_dl {false} |
Current state is either inside a html <dl> tag (true) or not (false). | |
bool | is_p {false} |
Current state is either inside a html <p> tag (true) or not (false). | |
Additional Inherited Members | |
Public Attributes inherited from seqan3::detail::format_help_base< format_html > | |
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. More... | |
Protected Member Functions inherited from seqan3::detail::format_help_base< format_html > | |
format_html & | 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. More... | |
void | print_synopsis () |
Prints a synopsis in any format. | |
void | print_version () |
Prints the version information. | |
Protected Member Functions inherited from seqan3::detail::format_base | |
std::string | escape_special_xml_chars (std::string const &original) |
Escapes certain characters for correct output. More... | |
Static Protected Member Functions inherited from seqan3::detail::format_base | |
static std::string | expand_multiple_flags (std::string const &flag_cluster) |
Expands multiple one character flag identifiers for pretty help output. More... | |
template<sequence_container 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). More... | |
template<typename value_type > | |
static std::string | get_type_name_as_string (value_type const &) |
Returns the input type as a string (reflection). More... | |
template<typename 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. More... | |
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. More... | |
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. More... | |
Protected Attributes inherited from seqan3::detail::format_help_base< format_html > | |
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 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().
|
inline |
Initializes a format_help_base object.
[in] | names | A list of subcommands (see subcommand parsing ). |
[in] | advanced | Set to true to show advanced options. |
|
inlineprivate |
Format string as in_bold.
[in] | str | The input string to format in bold. |
str
wrapped in bold formatting.
|
inlineprivate |
Prints a text in HTML format to std::cout.
[in] | text | The text to print. |
[in] | line_is_paragraph | Whether to insert as paragraph or just a line (only one line break if not a paragraph). |
|
inlineprivate |
Prints a help page list_item in HTML format to std::cout.
[in] | term | The key of the key-value pair of the list item. |
[in] | desc | The value of the key-value pair of the list item. |
A list item is composed of a key (term) and value (desc) and usually used for option identifier-description-pairs.
|
inlineprivate |
Prints a section title in HTML format to std::cout.
[in] | title | The title of the section of the help page. |
|
inlineprivate |
Prints a subsection title in HTML format to std::cout.
[in] | title | The title of the subsection of the help page. |
|
inlineprivate |
Converts console output formatting to the HTML equivalent.
[in] | input | The text to transform. |