argagg::definition Struct Reference

An option definition which essentially represents what an option is. More...

#include <argagg.hpp>

Public Member Functions
bool	wants_no_arguments () const
	Returns true if this option does not want any arguments. More...
bool	requires_arguments () const
	Returns true if this option requires arguments. More...

Public Attributes
const std::string	name
	Name of the option. Option parser results are keyed by this name. More...
std::vector< std::string >	flags
	List of strings to match that correspond to this option. Should be fully specified with hyphens (e.g. "-v" or "--verbose"). More...
std::string	help
	Help string for this option. More...
unsigned int	num_args
	Number of arguments this option requires. Must be 0 or 1. All other values have undefined behavior. Okay, the code actually works with positive values in general, but it's unorthodox command line behavior. More...

Detailed Description

An option definition which essentially represents what an option is.

Definition at line 388 of file argagg.hpp.

Member Function Documentation

bool argagg::definition::requires_arguments ( ) const

inline

Returns true if this option requires arguments.

Definition at line 817 of file argagg.hpp.

bool argagg::definition::wants_no_arguments ( ) const

inline

Returns true if this option does not want any arguments.

Definition at line 810 of file argagg.hpp.

Member Data Documentation

std::vector<std::string> argagg::definition::flags

List of strings to match that correspond to this option. Should be fully specified with hyphens (e.g. "-v" or "--verbose").

Definition at line 401 of file argagg.hpp.

std::string argagg::definition::help

Help string for this option.

Definition at line 407 of file argagg.hpp.

const std::string argagg::definition::name

Name of the option. Option parser results are keyed by this name.

Definition at line 394 of file argagg.hpp.

unsigned int argagg::definition::num_args

Number of arguments this option requires. Must be 0 or 1. All other values have undefined behavior. Okay, the code actually works with positive values in general, but it's unorthodox command line behavior.

Definition at line 415 of file argagg.hpp.

---

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

• /home/vnguyen/projects/misc/third-party/argagg/include/argagg/argagg.hpp