CLI::Formatter Class Reference

#include <CLI11.hpp>

Inheritance diagram for CLI::Formatter:

Collaboration diagram for CLI::Formatter:

Public Member Functions
	Formatter ()=default
	Formatter (const Formatter &)=default
	Formatter (Formatter &&)=default
Overridables
virtual std::string	make_group (std::string group, bool is_positional, std::vector< const Option * > opts) const
virtual std::string	make_positionals (const App *app) const
	This prints out just the positionals "group".
std::string	make_groups (const App *app, AppFormatMode mode) const
	This prints out all the groups of options.
virtual std::string	make_subcommands (const App *app, AppFormatMode mode) const
	This prints out all the subcommands.
virtual std::string	make_subcommand (const App *sub) const
	This prints out a subcommand.
virtual std::string	make_expanded (const App *sub) const
	This prints out a subcommand in help-all.
virtual std::string	make_footer (const App *app) const
	This prints out all the groups of options.
virtual std::string	make_description (const App *app) const
	This displays the description line.
virtual std::string	make_usage (const App *app, std::string name) const
	This displays the usage line.
std::string	make_help (const App *, std::string, AppFormatMode) const override
	This puts everything together.
Options
virtual std::string	make_option (const Option *opt, bool is_positional) const
	This prints out an option help line, either positional or optional form.
virtual std::string	make_option_name (const Option *, bool) const
	This is the name part of an option, Default: left column.
virtual std::string	make_option_opts (const Option *) const
	This is the options part of the name, Default: combined into left column.
virtual std::string	make_option_desc (const Option *) const
	This is the description. Default: Right column, on new line if left column too large.
virtual std::string	make_option_usage (const Option *opt) const
	This is used to print the name on the USAGE line.
Public Member Functions inherited from CLI::FormatterBase
	FormatterBase ()=default
	FormatterBase (const FormatterBase &)=default
	FormatterBase (FormatterBase &&)=default
virtual	~FormatterBase () noexcept
	Adding a destructor in this form to work around bug in GCC 4.7.
void	label (std::string key, std::string val)
	Set the "REQUIRED" label.
void	column_width (std::size_t val)
	Set the column width.
std::string	get_label (std::string key) const
	Get the current value of a name (REQUIRED, etc.)
std::size_t	get_column_width () const
	Get the current column width.

Additional Inherited Members
Protected Attributes inherited from CLI::FormatterBase
std::size_t	column_width_ {30}
	The width of the first column.
std::map< std::string, std::string >	labels_ {}
	The required help printout labels (user changeable) Values are Needs, Excludes, etc.

Detailed Description

This is the default Formatter for CLI11. It pretty prints help output, and is broken into quite a few overridable methods, to be highly customizable with minimal effort.

Constructor & Destructor Documentation

Formatter() [1/3]

CLI::Formatter::Formatter ( )

default

Formatter() [2/3]

CLI::Formatter::Formatter ( const Formatter &  )

default

Formatter() [3/3]

CLI::Formatter::Formatter ( Formatter &&  )

default

Member Function Documentation

make_description()

std::string CLI::Formatter::make_description ( const App *  app ) const

inlinevirtual

This displays the description line.

Here is the call graph for this function:

make_expanded()

std::string CLI::Formatter::make_expanded ( const App *  sub ) const

inlinevirtual

This prints out a subcommand in help-all.

Here is the call graph for this function:

make_footer()

std::string CLI::Formatter::make_footer ( const App *  app ) const

inlinevirtual

This prints out all the groups of options.

Here is the call graph for this function:

make_group()

std::string CLI::Formatter::make_group ( std::string  group, bool  is_positional, std::vector< const Option * >  opts  ) const

inlinevirtual

This prints out a group of options with title

make_groups()

std::string CLI::Formatter::make_groups ( const App *  app, AppFormatMode  mode  ) const

inline

This prints out all the groups of options.

Here is the call graph for this function:

make_help()

std::string CLI::Formatter::make_help ( const App *  app, std::string  name, AppFormatMode  mode  ) const

inlineoverridevirtual

This puts everything together.

Implements CLI::FormatterBase.

Here is the call graph for this function:

make_option()

virtual std::string CLI::Formatter::make_option ( const Option *  opt, bool  is_positional  ) const

inlinevirtual

This prints out an option help line, either positional or optional form.

make_option_desc()

std::string CLI::Formatter::make_option_desc ( const Option *  opt ) const

inlinevirtual

This is the description. Default: Right column, on new line if left column too large.

Here is the call graph for this function:

make_option_name()

std::string CLI::Formatter::make_option_name ( const Option *  opt, bool  is_positional  ) const

inlinevirtual

This is the name part of an option, Default: left column.

Here is the call graph for this function:

make_option_opts()

std::string CLI::Formatter::make_option_opts ( const Option *  opt ) const

inlinevirtual

This is the options part of the name, Default: combined into left column.

Here is the call graph for this function:

make_option_usage()

std::string CLI::Formatter::make_option_usage ( const Option *  opt ) const

inlinevirtual

This is used to print the name on the USAGE line.

Here is the call graph for this function:

make_positionals()

std::string CLI::Formatter::make_positionals ( const App *  app ) const

inlinevirtual

This prints out just the positionals "group".

Here is the call graph for this function:

make_subcommand()

std::string CLI::Formatter::make_subcommand ( const App *  sub ) const

inlinevirtual

This prints out a subcommand.

Here is the call graph for this function:

make_subcommands()

std::string CLI::Formatter::make_subcommands ( const App *  app, AppFormatMode  mode  ) const

inlinevirtual

This prints out all the subcommands.

Here is the call graph for this function:

make_usage()

std::string CLI::Formatter::make_usage ( const App *  app, std::string  name  ) const

inlinevirtual

This displays the usage line.

Here is the call graph for this function:

---

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

• CLI11.hpp