Basic class for arg parsing. Example use: More...

#include <ArgMap.h>

Classes
struct	ArgProcessor

Public Types
enum	Separator { Separator::COLON, Separator::EQUALS, Separator::WHITESPACE }

Public Member Functions
template<typename T >
ArgMap &	arg (const std::string &name, T &value)
	Add a new argument description Adds a new argument description with value of type T. Throws helib::RuntimeError if the arg key is duplicated or if the storing variable is used more than once. More...

template<typename T >
ArgMap &	arg (const std::string &name, T &value, const std::string &doc)
	Add a new argument with docs Adds a new argument description with value of type T and docs. Throws helib::RuntimeError if the arg key is duplicated or if the storing variable is used more than once. More...

template<typename T >
ArgMap &	arg (const std::string &name, T &value, const std::string &doc, const char *info)
	Add a new argument with docs and default description Adds a new argument description with value of type T, with docs and default description. Throws helib::RuntimeError if the arg key is duplicated or if the storing variable is used more than once. More...

template<typename C >
ArgMap &	dots (C &container, const char *name)
	Adds variable number of positional arg types after defined arg types are exhausted. These are treated as optional. More...

ArgMap &	parse (int argc, char **argv)
	Parse the argv array Parse the argv array If it fails or -h is an argument it prints the usage and exits the program. More...

ArgMap &	parse (const std::string &filepath)
	Parse the configuration/parameters file Parsing a configuration file only functions with named arguments Parse the config file Throws RuntimeError on failure. More...

ArgMap &	optional ()
	Swaps to optional arg mode (default) Swaps to optional arg mode. Following arguments will be considered optional. More...

ArgMap &	required ()
	Swaps to required arg mode Swaps to required arg mode. Following arguments will be considered required. More...

ArgMap &	toggle (bool t=true)
	Swaps to toggle arg type Swaps to required arg mode. Following arguments will be considered of toggle type. More...

ArgMap &	named ()
	Swaps to named arg type (default) Swaps to required arg mode. Following arguments will be considered of named type. More...

ArgMap &	positional ()
	Swaps to positional arg type Swaps to required arg mode. Following arguments will be considered of positional type. More...

ArgMap &	helpArgs (const std::initializer_list< std::string > s)
	Provide custom help toggle args. (defaults are "-h", "--help") Overwrite default help toggle args to custom ones for parsing. More...

ArgMap &	helpArgs (const std::string s)

ArgMap &	diagnostics (std::ostream &ostrm=std::cout)
	Turns on diagnostics printout when parsing Swaps to required arg mode. Following arguments will be considered of positional type. More...

ArgMap &	separator (Separator s)
	Sets the key-value separator Sets the named args key-value pair separator character. More...

ArgMap &	note (const std::string &s)
	Adds a note to usage Adds a note to the arg usage description. More...

void	usage (const std::string &msg="") const
	Print usage and exit Prints the usage and exits the program. More...

std::string	doc () const
	Return arg docs Returns the argument documentation as a string. More...

Detailed Description

Basic class for arg parsing. Example use:

// Variables to be set by command line.
long p = 2;                                 // default values.
long m = 19;
bool t = false;
bool f = true;
std::string k = "Hello World";
 
ArgMap()                                    // (*) marks default.
  .required()                               // set args to required.
  .positional()                             //
    .arg("p", p, "doc for p")               //
    .arg("m", m, "doc for m", "undefined")  // special default info.
  .optional()                               // swap to optional args (*).
  .named()                                  // named args (*) e.g.k=v.
  .separator(ArgMap::Separator::WHITESPACE) // change separator to
    .arg("-k", k, "doc for k", "")          // whitespace ('=' is (*)).
    .note("an extra note")                  // no default value info.
  .toggle()                                 // add extra doc/note.
     .arg("-t", t, "doc for t", "")         // toggle flag sets bool true.
  .toggle(false)                            // toggle flag sets bool false.
     .arg("-f", f, "doc for f", "")         //
  .helpArgs({"--myhelp"})                   // changes default help flags
  .parse(argc, argv);                       // (*) is {"-h", "--help"}.
                                            // parses and overwrites values

Member Enumeration Documentation

◆ Separator

enum helib::ArgMap::Separator

strong

Enumerator
COLON
EQUALS
WHITESPACE

Member Function Documentation

◆ arg() [1/3]

template<typename T >

ArgMap & helib::ArgMap::arg	(	const std::string &	name,
		T &	value
	)

Add a new argument description Adds a new argument description with value of type T. Throws helib::RuntimeError if the arg key is duplicated or if the storing variable is used more than once.

Template Parameters

T	The type of the argument

Parameters

name	The argument name (key)
value	a variable where the argument will be stored. Also used as default value

Returns: A reference to the modified ArgMap object

◆ arg() [2/3]

template<typename T >

ArgMap & helib::ArgMap::arg	(	const std::string &	name,
		T &	value,
		const std::string &	doc
	)

Add a new argument with docs Adds a new argument description with value of type T and docs. Throws helib::RuntimeError if the arg key is duplicated or if the storing variable is used more than once.

Template Parameters

T	The type of the argument

Parameters

name	The argument name (key)
value	a variable where the argument will be stored. Also used as default value
doc1	Description of the argument used when displaying usage

Returns: A reference to the modified ArgMap object

◆ arg() [3/3]

template<typename T >

ArgMap & helib::ArgMap::arg	(	const std::string &	name,
		T &	value,
		const std::string &	doc,
		const char *	info
	)

Add a new argument with docs and default description Adds a new argument description with value of type T, with docs and default description. Throws helib::RuntimeError if the arg key is duplicated or if the storing variable is used more than once.

Template Parameters

T	The type of the argument

Parameters

name	The argument name (key)
value	a variable where the argument will be stored. Also used as default value
doc1	Description of the argument used when displaying usage
info	The default value description (ignored if nullptr or "")

Returns: A reference to the modified ArgMap object

◆ diagnostics()

ArgMap & helib::ArgMap::diagnostics ( std::ostream & ostrm = std::cout )

inline

Turns on diagnostics printout when parsing Swaps to required arg mode. Following arguments will be considered of positional type.

Returns: A reference to the ArgMap object

◆ doc()

std::string helib::ArgMap::doc ( ) const

inline

Return arg docs Returns the argument documentation as a string.

Returns: the argument documentation string

◆ dots()

template<typename C >

ArgMap & helib::ArgMap::dots	(	C &	container,
		const char *	name
	)

Adds variable number of positional arg types after defined arg types are exhausted. These are treated as optional.

Parameters

container holds the variable positional args. It must have a push_back method for insertion

Returns: A reference to the ArgMap object

◆ helpArgs() [1/2]

ArgMap & helib::ArgMap::helpArgs ( const std::initializer_list< std::string > s )

inline

Provide custom help toggle args. (defaults are "-h", "--help") Overwrite default help toggle args to custom ones for parsing.

Returns: A reference to the ArgMap object

◆ helpArgs() [2/2]

ArgMap & helib::ArgMap::helpArgs ( const std::string s )

inline

◆ named()

ArgMap & helib::ArgMap::named ( )

inline

Swaps to named arg type (default) Swaps to required arg mode. Following arguments will be considered of named type.

Returns: A reference to the ArgMap object

◆ note()

ArgMap & helib::ArgMap::note ( const std::string & s )

inline

Adds a note to usage Adds a note to the arg usage description.

Parameters

s	The note string

Returns: A reference to the ArgMap object

◆ optional()

ArgMap & helib::ArgMap::optional ( )

inline

Swaps to optional arg mode (default) Swaps to optional arg mode. Following arguments will be considered optional.

Returns: A reference to the ArgMap object

◆ parse() [1/2]

ArgMap & helib::ArgMap::parse ( const std::string & filepath )

inline

Parse the configuration/parameters file Parsing a configuration file only functions with named arguments Parse the config file Throws RuntimeError on failure.

Parameters

filepath the config file path

Returns: A reference to the ArgMap object

◆ parse() [2/2]

ArgMap & helib::ArgMap::parse	(	int	argc,
		char **	argv
	)

inline

Parse the argv array Parse the argv array If it fails or -h is an argument it prints the usage and exits the program.

Parameters

argc	number of entries in argv
argv	array containing the arguments

Returns: A reference to the ArgMap object

◆ positional()

ArgMap & helib::ArgMap::positional ( )

inline

Swaps to positional arg type Swaps to required arg mode. Following arguments will be considered of positional type.

Returns: A reference to the ArgMap object

◆ required()

ArgMap & helib::ArgMap::required ( )

inline

Swaps to required arg mode Swaps to required arg mode. Following arguments will be considered required.

Returns: A reference to the ArgMap object

◆ separator()

ArgMap & helib::ArgMap::separator ( Separator s )

inline

Sets the key-value separator Sets the named args key-value pair separator character.

Parameters

s	the separator enum must be set either to COLON or EQUALS(default).

Returns: A reference to the ArgMap object

◆ toggle()

ArgMap & helib::ArgMap::toggle ( bool t = true )

inline

Swaps to toggle arg type Swaps to required arg mode. Following arguments will be considered of toggle type.

Returns: A reference to the ArgMap object

◆ usage()

void helib::ArgMap::usage ( const std::string & msg = "" ) const

inline

Print usage and exit Prints the usage and exits the program.

Parameters

msg	An additional message to print before showing usage

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Separator

Member Function Documentation

◆ arg() [1/3]

◆ arg() [2/3]

◆ arg() [3/3]

◆ diagnostics()

◆ doc()

◆ dots()

◆ helpArgs() [1/2]

◆ helpArgs() [2/2]

◆ named()

◆ note()

◆ optional()

◆ parse() [1/2]

◆ parse() [2/2]

◆ positional()

◆ required()

◆ separator()

◆ toggle()

◆ usage()