setup

command line parsing and setup More...

Collaboration diagram for setup:

Data Structures
struct	setup_options_t
	default options shared by all tools More...
struct	setup_init_t
	the result of parsing the command line More...

Functions
CT_BEGIN_API CT_SETUP_API arena_t *	ctu_default_alloc (void)
	get the default allocator More...
CT_SETUP_API void	setup_default (arena_t *arena)
	initialise the runtime with default options More...
CT_SETUP_API setup_options_t	setup_options (version_info_t info, cfg_group_t *root)
	setup default options More...
CT_SETUP_API setup_init_t	setup_parse (int argc, const char **argv, setup_options_t setup)
	parse the command line More...
CT_PUREFN CT_SETUP_API bool	setup_should_exit (const setup_init_t *init)
	accessor functions More...
CT_PUREFN CT_SETUP_API int	setup_exit_code (const setup_init_t *init)
	get the exit code More...
CT_SETUP_API int	setup_exit_help (setup_options_t setup, const setup_init_t *init)
	print the help message and exit More...

Detailed Description

command line parsing and setup

Function Documentation

ctu_default_alloc()

CT_BEGIN_API CT_SETUP_API arena_t* ctu_default_alloc

(

void

)

get the default allocator

Returns

the default allocator

Definition at line 43 of file memory.c.

setup_default()

CT_SETUP_API void setup_default

(

arena_t *

arena

)

initialise the runtime with default options

initialise the runtime with default options

Definition at line 188 of file setup.c.

setup_exit_code()

CT_PUREFN CT_SETUP_API int setup_exit_code

(

const setup_init_t *

init

)

get the exit code

Note

only call this if setup_should_exit() returns true

Parameters

init	the setup init

Returns

the exit code

Definition at line 442 of file setup.c.

setup_exit_help()

CT_SETUP_API int setup_exit_help	(	setup_options_t	setup,
		const setup_init_t *	init
	)

print the help message and exit

Parameters

init	the setup init

Returns

the exit code

Definition at line 450 of file setup.c.

setup_options()

CT_SETUP_API setup_options_t setup_options	(	version_info_t	info,
		cfg_group_t *	root
	)

setup default options

Note

this should be called before you've added all your options

Parameters

info	the version information
root	the root config group

Returns

the setup options

Definition at line 215 of file setup.c.

setup_parse()

CT_SETUP_API setup_init_t setup_parse	(	int	argc,
		const char **	argv,
		setup_options_t	setup
	)

parse the command line

Parameters

argc	the number of arguments
argv	the arguments
setup	the setup options

Returns

the parsed command line

Definition at line 366 of file setup.c.

setup_should_exit()

CT_PUREFN CT_SETUP_API bool setup_should_exit

(

const setup_init_t *

init

)

accessor functions

check if the program should exit

Parameters

init	the setup init

Returns

true if the program should exit

accessor functions

Definition at line 434 of file setup.c.