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

#include <optionparser.h>

Classes
class	CountOptionsAction

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

	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.

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

	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.

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.

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

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.

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...

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.

Constructor & Destructor Documentation

◆ Stats()

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

inline

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.

Here is the call graph for this function:

Member Function Documentation

◆ add()

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

inline

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.

Member Data Documentation

◆ buffer_max

unsigned option::Stats::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.

◆ options_max

unsigned option::Stats::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.

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

jtestbench/include/optionparser.h

Classes

Public Member Functions

Public Attributes