The format that prints the help page to std::cout. More...

#include <sharg/detail/format_help.hpp>

Inheritance diagram for sharg::detail::format_help:

Classes
struct	console_layout_struct
	Stores the relevant parameters of the documentation on the screen. More...

Public Member Functions
Constructors, destructor and assignment
	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.

Private Types
using	base_type = format_help_base<format_help>
	The CRTP base class type.

Private Member Functions
void	print_header ()
	Prints a help page header to std::cout.

void	print_section (std::string const &title)
	Prints a help page section to std::cout.

void	print_subsection (std::string const &title)
	Prints a help page subsection to std::cout.

void	print_line (std::string const &text, bool const line_is_paragraph)
	Prints a text to std::cout.

void	print_list_item (std::string const &term, std::string const &desc)
	Prints a help page list_item to std::cout.

void	print_footer ()
	Prints a help page footer to std::cout.

std::string	to_text (std::string const &str)
	Formats text for pretty command line printing.

unsigned	text_width (std::string const &text)
	Returns width of text if printed.

void	print_text (std::string const &text, unsigned const tab)
	Prints text with correct line wrapping to the command line (std::cout).

std::string	in_bold (std::string const &str)
	Format string in bold.

Private Attributes
friend	base_type
	Befriend the base class to give access to the private member functions.

bool	prev_was_paragraph {false}
	Needed for correct formatting while calling different print functions.

console_layout_struct	layout {}
	Stores the relevant parameters of the documentation on the screen.

Friends
struct	::sharg::detail::test_accessor
	Befriend sharg::detail::test_accessor to grant access to layout.

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 help 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 format_help::parse().

Remarks: For a complete overview, take a look at Parser

Constructor & Destructor Documentation

◆ format_help()

sharg::detail::format_help::format_help	(	std::vector< std::string > const &	names,
		update_notifications const	version_updates,
		bool const	advanced = false )

inline

Defaulted.

Member Function Documentation

◆ in_bold()

std::string sharg::detail::format_help::in_bold ( std::string const & str )

inlineprivate

Format string in bold.

Parameters

[in] str The input string to format in bold.

Returns: The string str wrapped in bold formatting.

◆ print_line()

void sharg::detail::format_help::print_line	(	std::string const &	text,
		bool const	line_is_paragraph )

inlineprivate

Prints a text to std::cout.

Parameters

[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).

◆ print_list_item()

void sharg::detail::format_help::print_list_item	(	std::string const &	term,
		std::string const &	desc )

inlineprivate

Prints a help page list_item to std::cout.

Parameters

[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. E.g.:

-a, --age LONG

Super important integer for age.

◆ print_section()

void sharg::detail::format_help::print_section ( std::string const & title )

inlineprivate

Prints a help page section to std::cout.

Parameters

[in] title The title of the subsection of the help page.

◆ print_subsection()

void sharg::detail::format_help::print_subsection ( std::string const & title )

inlineprivate

Prints a help page subsection to std::cout.

Parameters

[in] title The title of the subsection of the help page.

◆ print_text()

void sharg::detail::format_help::print_text	(	std::string const &	text,
		unsigned const	tab )

inlineprivate

Prints text with correct line wrapping to the command line (std::cout).

Parameters

[in]	text	The string to print on the command line.
[in]	tab	The position offset (indentation) to start printing at.

◆ text_width()

unsigned sharg::detail::format_help::text_width ( std::string const & text )

inlineprivate

Returns width of text if printed.

Parameters

[in] text The string to compute the width for on the command line. /detail Note: "\-" has length 1, "\fI", "\fB", "\fP" have length 0.

◆ to_text()

std::string sharg::detail::format_help::to_text ( std::string const & str )

inlineprivate

Formats text for pretty command line printing.

Parameters

[in] str The input string to format for correct command line printing.

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

format_help.hpp

Classes

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ format_help()

Member Function Documentation

◆ in_bold()

◆ print_line()

◆ print_list_item()

◆ print_section()

◆ print_subsection()

◆ print_text()

◆ text_width()

◆ to_text()