Description

Functor to configure diagnostics.

This functor uses the string(s) from the specified switch key to configure the specified message facilities object. If a string is the word "list" then the message facility configuration is shown on standard output. If the string is the word "help" then some documentation is emitted on std::cout and the program optionally exits with success (depending on exitOnHelp).

Here's an example usage. In particular, be sure to specify SAVE_ALL so that more than one –log switch can appear on the command line, like: a.out –log ">=info" –log list

generic.insert(Switch("log")
               .action(configureDiagnostics("log", Sawyer::Message::mfacilities))
               .argument("config")
               .whichValue(SAVE_ALL)
               .doc("Configures diagnostics..."));

Definition at line 1726 of file Sawyer/CommandLine.h.

#include <Sawyer/CommandLine.h>

Inheritance diagram for Sawyer::CommandLine::ConfigureDiagnostics:

[legend]

Collaboration diagram for Sawyer::CommandLine::ConfigureDiagnostics:

[legend]

Public Types
typedef SharedPointer< ConfigureDiagnostics >	Ptr
	Reference counting pointer for this class.

Public Types inherited from Sawyer::CommandLine::SwitchAction
typedef SharedPointer< SwitchAction >	Ptr
	Reference counting pointer for this class.

Public Member Functions

bool	exitOnHelp () const
	Property: program exit after help is displayed.

void	exitOnHelp (bool b)
	Property: program exit after help is displayed.

Public Member Functions inherited from Sawyer::CommandLine::SwitchAction
void	run (const ParserResult &parserResult)
	Runs the action.

Public Member Functions inherited from Sawyer::SharedObject
	SharedObject ()
	Default constructor.

	SharedObject (const SharedObject &)
	Copy constructor.

virtual	~SharedObject ()
	Virtual destructor.

SharedObject &	operator= (const SharedObject &)
	Assignment.

Static Public Member Functions
static Ptr	instance (const std::string &switchKey, Message::Facilities &facilities, bool exitOnHelp=true)
	Allocating constructor.

Protected Member Functions
	ConfigureDiagnostics (const std::string &switchKey, Message::Facilities &facilities, bool exitOnHelp)
	Constructor for derived classes.

virtual void	operator() (const ParserResult &)

Member Typedef Documentation

◆ Ptr

typedef SharedPointer<ConfigureDiagnostics> Sawyer::CommandLine::ConfigureDiagnostics::Ptr

Reference counting pointer for this class.

Definition at line 1738 of file Sawyer/CommandLine.h.

Constructor & Destructor Documentation

◆ ConfigureDiagnostics()

Sawyer::CommandLine::ConfigureDiagnostics::ConfigureDiagnostics	(	const std::string &	switchKey,
		Message::Facilities &	facilities,
		bool	exitOnHelp
	)

inlineprotected

Constructor for derived classes.

Non-subclass users should use instance instead.

Definition at line 1734 of file Sawyer/CommandLine.h.

Member Function Documentation

◆ instance()

static Ptr Sawyer::CommandLine::ConfigureDiagnostics::instance	(	const std::string &	switchKey,
		Message::Facilities &	facilities,
		bool	exitOnHelp = `true`
	)

inlinestatic

Allocating constructor.

Returns a pointer to a new ConfigureDiagnostics object. Users will most likely want to use the configureDiagnostics factory instead, which requires less typing.

See also: Command line action factories, and the SwitchAction class.

Definition at line 1744 of file Sawyer/CommandLine.h.

◆ exitOnHelp() [1/2]

bool Sawyer::CommandLine::ConfigureDiagnostics::exitOnHelp ( ) const

inline

Property: program exit after help is displayed.

If true, then the program exits with success immediately after a "help" command is processed.

Definition at line 1753 of file Sawyer/CommandLine.h.

◆ exitOnHelp() [2/2]

void Sawyer::CommandLine::ConfigureDiagnostics::exitOnHelp ( bool b )

inline

Property: program exit after help is displayed.

If true, then the program exits with success immediately after a "help" command is processed.

Definition at line 1754 of file Sawyer/CommandLine.h.

◆ operator()()

virtual void Sawyer::CommandLine::ConfigureDiagnostics::operator() ( const ParserResult & )

protectedvirtual

Implements Sawyer::CommandLine::SwitchAction.

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

Sawyer/CommandLine.h