sharg::detail::format_copyright Class Reference

The format that prints the copyright information to std::cout. More...

#include <sharg/detail/format_help.hpp>

Inheritance diagram for sharg::detail::format_copyright:

Public Member Functions
void	parse (parser_meta_data const &parser_meta)
	Initiates the printing of the copyright message to std::cout.
Public Member Functions inherited from sharg::detail::format_help
	format_help ()=default
	Defaulted.
	format_help (format_help const &pf)=default
	Defaulted.
format_help &	operator= (format_help const &)=default
	Defaulted.
	format_help (format_help &&)=default
	Defaulted.
format_help &	operator= (format_help &&)=default
	Defaulted.
	~format_help ()=default
	Defaulted.
	format_help (std::vector< std::string > const &names, update_notifications const version_updates, bool const advanced=false)
	Defaulted.
Public Member Functions inherited from sharg::detail::format_help_base< format_help >
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.

Additional Inherited Members
Public Attributes inherited from sharg::detail::format_help_base< format_help >
parser_meta_data	meta
	Stores all meta information about the application.
friend	derived_type
	Befriend the derived type so it can access private functions.
Protected Member Functions inherited from sharg::detail::format_help_base< format_help >
format_help &	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.
Static Protected Member Functions inherited from sharg::detail::format_base
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.
Protected Attributes inherited from sharg::detail::format_help_base< format_help >
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.

Detailed Description

The format that prints the copyright information to std::cout.

The copyright message printing is not done immediately, because the user cannot provide meta information (e.g. long_copyright) on construction of the parser. Thus the meta information is collected and only evaluated when calling sharg::detail::format_version::parse.

Remarks

For a complete overview, take a look at Parser

Member Function Documentation

parse()

void sharg::detail::format_copyright::parse ( parser_meta_data const & parser_meta )

inline

Initiates the printing of the copyright message to std::cout.

Parameters

[in]

parser_meta

The meta information that are needed for a detailed version information.

---

The documentation for this class was generated from the following file:

• format_help.hpp