Option printer for the console. More...

#include <popl.h>

Inheritance diagram for Piduino::ConsoleOptionPrinter:

Collaboration diagram for Piduino::ConsoleOptionPrinter:

Public Member Functions
	ConsoleOptionPrinter (const OptionParser *option_parser)
	ConsoleOptionPrinter implementation /////////////////////////////////.

	~ConsoleOptionPrinter () override=default

std::string	print (const Attribute &max_attribute=Attribute::optional) const override

Protected Attributes
const OptionParser *	option_parser_

Private Member Functions
std::string	to_string (Option_ptr option) const

Detailed Description

Option printer for the console.

Standard console option printer Creates a human readable help message

Definition at line 441 of file popl.h.

Constructor & Destructor Documentation

◆ ConsoleOptionPrinter()

Piduino::ConsoleOptionPrinter::ConsoleOptionPrinter ( const OptionParser * option_parser )

inlineexplicit

ConsoleOptionPrinter implementation /////////////////////////////////.

Definition at line 993 of file popl.h.

◆ ~ConsoleOptionPrinter()

Piduino::ConsoleOptionPrinter::~ConsoleOptionPrinter ( )

overridedefault

Member Function Documentation

◆ print()

std::string Piduino::ConsoleOptionPrinter::print ( const Attribute & max_attribute = Attribute::optional ) const

inlineoverridevirtual

Create a help message

Parameters

max_attribute show options up to this level (optional, advanced, expert)

Returns: the help message

Implements Piduino::OptionPrinter.

Definition at line 1032 of file popl.h.

References Piduino::OptionParser::description(), Piduino::hidden, Piduino::OptionPrinter::option_parser_, Piduino::optional, Piduino::OptionParser::options(), and to_string().

Referenced by Piduino::OptionParser::help().

Here is the call graph for this function:

◆ to_string()

std::string Piduino::ConsoleOptionPrinter::to_string ( Option_ptr option ) const

inlineprivate

Definition at line 997 of file popl.h.

References Piduino::optional, and Piduino::required.

Referenced by print().

Member Data Documentation

◆ option_parser_

const OptionParser* Piduino::OptionPrinter::option_parser_

protectedinherited

Definition at line 430 of file popl.h.

Referenced by print(), Piduino::GroffOptionPrinter::print(), and Piduino::BashCompletionOptionPrinter::print().

Public Member Functions

Protected Attributes

Private Member Functions