Command line argument parsing

Command line argument parsing TODO: reduce the amount of allocations by allowing config to accept string views TODO: nicely support error propagation out of the parser. More...

Collaboration diagram for Command line argument parsing:

Typedefs
typedef bool(*	ap_event_t) (ap_t *ap, const cfg_field_t *param, const void *value, void *data)
	callback for a parameter event called when a parameter is parsed return true to indicate the event was handled, false to continue to the next handler More...

Functions
CT_ARGPARSE_API ap_t *	ap_new (cfg_group_t *config, arena_t *arena)
	create a new parser instance More...
CT_ARGPARSE_API void	ap_update (ap_t *self)
	update the parser with the latest config More...
CT_ARGPARSE_API void	ap_event (ap_t *self, const cfg_field_t *param, ap_event_t callback, void *data)
	add a callback event to a parameter More...
CT_ARGPARSE_API int	ap_parse_args (ap_t *self, int argc, const char **argv)
	parse a command line More...
CT_ARGPARSE_API int	ap_parse (ap_t *self, const char *str)
	parse a string More...
CT_ARGPARSE_API vector_t *	ap_get_posargs (ap_t *self)
	get all positional arguments More...
CT_ARGPARSE_API vector_t *	ap_get_unknown (ap_t *self)
	get all unknown arguments More...
CT_ARGPARSE_API vector_t *	ap_get_errors (ap_t *self)
	get all errors More...
CT_ARGPARSE_API size_t	ap_count_params (ap_t *self)
	get the number of processed arguments More...

Detailed Description

Command line argument parsing TODO: reduce the amount of allocations by allowing config to accept string views TODO: nicely support error propagation out of the parser.

Typedef Documentation

ap_event_t

typedef bool(* ap_event_t) (ap_t *ap, const cfg_field_t *param, const void *value, void *data)

callback for a parameter event called when a parameter is parsed return true to indicate the event was handled, false to continue to the next handler

Parameters

ap	the parser instance
param	the parameter that triggered the event, may be NULL for positional args
value	the value of the parameter, NULL for positional args, mpz_t for int, const char * for string, and bool* for bool
data	the data passed to ap_event

Return values

true	if the event was handled
false	if the event was not handled

Definition at line 44 of file argparse.h.

Function Documentation

ap_count_params()

CT_ARGPARSE_API size_t ap_count_params

(

ap_t *

self

)

get the number of processed arguments

Parameters

self	the parser instance

Returns

the number of processed arguments

Definition at line 181 of file argparse.c.

ap_event()

CT_ARGPARSE_API void ap_event	(	ap_t *	self,
		const cfg_field_t *	param,
		ap_event_t	callback,
		void *	data
	)

add a callback event to a parameter

Parameters

self	the parser instance
param	the parameter to add the event to
callback	the callback to add
data	the data to pass to the callback

Definition at line 139 of file argparse.c.

ap_get_errors()

CT_ARGPARSE_API vector_t* ap_get_errors

(

ap_t *

self

)

get all errors

Note

does not include unknown arguments

Parameters

self	the parser instance

Returns

all errors

Definition at line 174 of file argparse.c.

ap_get_posargs()

CT_ARGPARSE_API vector_t* ap_get_posargs

(

ap_t *

self

)

get all positional arguments

Parameters

self	the parser instance

Returns

all positional arguments

Definition at line 158 of file argparse.c.

ap_get_unknown()

CT_ARGPARSE_API vector_t* ap_get_unknown

(

ap_t *

self

)

get all unknown arguments

Parameters

self	the parser instance

Returns

all unknown arguments

Definition at line 166 of file argparse.c.

ap_new()

CT_ARGPARSE_API ap_t* ap_new	(	cfg_group_t *	config,
		arena_t *	arena
	)

create a new parser instance

Parameters

config	the config object to use
arena	the arena to allocate from

Returns

the created parser instance

Definition at line 97 of file argparse.c.

ap_parse()

CT_ARGPARSE_API int ap_parse	(	ap_t *	self,
		const char *	str
	)

parse a string

Parameters

self	the parser instance
str	the string to parse

Returns

int exit code

Definition at line 106 of file parse.c.

ap_parse_args()

CT_ARGPARSE_API int ap_parse_args	(	ap_t *	self,
		int	argc,
		const char **	argv
	)

parse a command line

Parameters

self	the parser instance
argc	from main
argv	from main

Returns

int exit code

Definition at line 100 of file parse.c.

ap_update()

CT_ARGPARSE_API void ap_update

(

ap_t *

self

)

update the parser with the latest config

Parameters

self	the parser instance

Definition at line 128 of file argparse.c.