Stats Struct Reference

Detailed Description

Determines the minimum lengths of the buffer and options arrays used for Parser.

Because Parser doesn't use dynamic memory its output arrays have to be pre-allocated. If you don't want to use fixed size arrays (which may turn out too small, causing command line arguments to be dropped), you can use Stats to determine the correct sizes. Stats work cumulative. You can first pass in your default options and then the real options and afterwards the counts will reflect the union.

Definition at line 950 of file optionparser.h.

Public Member Functions
	Stats ()
	Creates a Stats object with counts set to 1 (for the sentinel element). More...
	Stats (bool gnu, const Descriptor usage[], int argc, const char **argv, int min_abbr_len=0, bool single_minus_longopt=false)
	Creates a new Stats object and immediately updates it for the given usage and argument vector. You may pass 0 for argc and/or argv, if you just want to update options_max. More...
	Stats (bool gnu, const Descriptor usage[], int argc, char **argv, int min_abbr_len=0, bool single_minus_longopt=false)
	Stats(...) with non-const argv. More...
	Stats (const Descriptor usage[], int argc, const char **argv, int min_abbr_len=0, bool single_minus_longopt=false)
	POSIX Stats(...) (gnu==false). More...
	Stats (const Descriptor usage[], int argc, char **argv, int min_abbr_len=0, bool single_minus_longopt=false)
	POSIX Stats(...) (gnu==false) with non-const argv. More...
void	add (bool gnu, const Descriptor usage[], int argc, const char **argv, int min_abbr_len=0, bool single_minus_longopt=false)
	Updates this Stats object for the given usage and argument vector. You may pass 0 for argc and/or argv, if you just want to update options_max. More...
void	add (bool gnu, const Descriptor usage[], int argc, char **argv, int min_abbr_len=0, bool single_minus_longopt=false)
	add() with non-const argv. More...
void	add (const Descriptor usage[], int argc, const char **argv, int min_abbr_len=0, bool single_minus_longopt=false)
	POSIX add() (gnu==false). More...
void	add (const Descriptor usage[], int argc, char **argv, int min_abbr_len=0, bool single_minus_longopt=false)
	POSIX add() (gnu==false) with non-const argv. More...

Public Attributes
unsigned	buffer_max
	Number of elements needed for a buffer[] array to be used for parsing the same argument vectors that were fed into this Stats object. More...
unsigned	options_max
	Number of elements needed for an options[] array to be used for parsing the same argument vectors that were fed into this Stats object. More...

Constructor & Destructor Documentation

Stats

(

)

Creates a Stats object with counts set to 1 (for the sentinel element).

Definition at line 979 of file optionparser.h.

Stats	(	bool	gnu,
		const Descriptor	usage[],
		int	argc,
		const char **	argv,
		int	min_abbr_len = 0,
		bool	single_minus_longopt = false
	)

Creates a new Stats object and immediately updates it for the given usage and argument vector. You may pass 0 for argc and/or argv, if you just want to update options_max.

Note

The calls to Stats methods must match the later calls to Parser methods. See Parser::parse() for the meaning of the arguments.

Definition at line 993 of file optionparser.h.

Stats	(	bool	gnu,
		const Descriptor	usage[],
		int	argc,
		char **	argv,
		int	min_abbr_len = 0,
		bool	single_minus_longopt = false
	)

Stats(...) with non-const argv.

Definition at line 1001 of file optionparser.h.

Stats	(	const Descriptor	usage[],
		int	argc,
		const char **	argv,
		int	min_abbr_len = 0,
		bool	single_minus_longopt = false
	)

POSIX Stats(...) (gnu==false).

Definition at line 1009 of file optionparser.h.

Stats	(	const Descriptor	usage[],
		int	argc,
		char **	argv,
		int	min_abbr_len = 0,
		bool	single_minus_longopt = false
	)

POSIX Stats(...) (gnu==false) with non-const argv.

Definition at line 1017 of file optionparser.h.

Member Function Documentation

void add	(	bool	gnu,
		const Descriptor	usage[],
		int	argc,
		const char **	argv,
		int	min_abbr_len = 0,
		bool	single_minus_longopt = false
	)

Updates this Stats object for the given usage and argument vector. You may pass 0 for argc and/or argv, if you just want to update options_max.

Note

The calls to Stats methods must match the later calls to Parser methods. See Parser::parse() for the meaning of the arguments.

Definition at line 1522 of file optionparser.h.

void add	(	bool	gnu,
		const Descriptor	usage[],
		int	argc,
		char **	argv,
		int	min_abbr_len = 0,
		bool	single_minus_longopt = false
	)

add() with non-const argv.

Definition at line 1037 of file optionparser.h.

void add	(	const Descriptor	usage[],
		int	argc,
		const char **	argv,
		int	min_abbr_len = 0,
		bool	single_minus_longopt = false
	)

POSIX add() (gnu==false).

Definition at line 1044 of file optionparser.h.

void add	(	const Descriptor	usage[],
		int	argc,
		char **	argv,
		int	min_abbr_len = 0,
		bool	single_minus_longopt = false
	)

POSIX add() (gnu==false) with non-const argv.

Definition at line 1051 of file optionparser.h.

Member Data Documentation

unsigned buffer_max

Number of elements needed for a buffer[] array to be used for parsing the same argument vectors that were fed into this Stats object.

Note

This number is always 1 greater than the actual number needed, to give you a sentinel element.

Definition at line 961 of file optionparser.h.

unsigned options_max

Number of elements needed for an options[] array to be used for parsing the same argument vectors that were fed into this Stats object.

Note

• This number is always 1 greater than the actual number needed, to give you a sentinel element.
• This number depends only on the usage, not the argument vectors, because the options array needs exactly one slot for each possible Descriptor::index.

Definition at line 974 of file optionparser.h.

---

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

• src/optionparser.h