options_config_t Struct Reference

Options configuration. More...

#include <lib/options/builder.h>

Data Fields
option_descriptor_t *	descriptors
	Array of option descriptors.
size_t	num_descriptors
	Number of descriptors.
option_dependency_t *	dependencies
	Array of dependencies.
size_t	num_dependencies
	Number of dependencies.
positional_arg_descriptor_t *	positional_args
	Array of positional argument descriptors.
size_t	num_positional_args
	Number of positional arguments.
size_t	struct_size
	sizeof(options_t) for bounds checking
const char *	program_name
	For usage header.
const char *	description
	For usage header.
char **	owned_strings
	Strdup'd strings to free on cleanup.
size_t	num_owned_strings
	Number of owned strings.
size_t	owned_strings_capacity
	Allocated capacity.

Detailed Description

Options configuration.

A complete, immutable configuration of options for a mode. Built by options_builder_t and used for parsing.

Definition at line 165 of file builder.h.

Field Documentation

dependencies

option_dependency_t* options_config_t::dependencies

Array of dependencies.

Definition at line 169 of file builder.h.

Referenced by options_builder_build(), options_builder_from_preset(), options_config_destroy(), and options_config_validate().

description

const char* options_config_t::description

For usage header.

Definition at line 177 of file builder.h.

Referenced by options_builder_build(), options_builder_from_preset(), options_config_print_usage(), usage_acds(), usage_client(), usage_mirror(), and usage_server().

descriptors

option_descriptor_t* options_config_t::descriptors

Array of option descriptors.

Definition at line 166 of file builder.h.

Referenced by options_builder_build(), options_builder_from_preset(), options_config_cleanup(), options_config_destroy(), options_config_print_usage(), options_config_set_defaults(), and options_config_validate().

num_dependencies

size_t options_config_t::num_dependencies

Number of dependencies.

Definition at line 170 of file builder.h.

Referenced by options_builder_build(), options_builder_from_preset(), and options_config_validate().

num_descriptors

size_t options_config_t::num_descriptors

Number of descriptors.

Definition at line 167 of file builder.h.

Referenced by options_builder_build(), options_builder_from_preset(), options_config_cleanup(), options_config_print_usage(), options_config_set_defaults(), and options_config_validate().

num_owned_strings

size_t options_config_t::num_owned_strings

Number of owned strings.

Definition at line 181 of file builder.h.

Referenced by __attribute__(), options_builder_build(), and options_config_cleanup().

num_positional_args

size_t options_config_t::num_positional_args

Number of positional arguments.

Definition at line 173 of file builder.h.

Referenced by options_builder_build(), options_builder_from_preset(), options_config_parse_positional(), usage_acds(), usage_client(), and usage_server().

owned_strings

char** options_config_t::owned_strings

Strdup'd strings to free on cleanup.

Definition at line 180 of file builder.h.

Referenced by __attribute__(), options_builder_build(), options_config_cleanup(), and options_config_destroy().

owned_strings_capacity

size_t options_config_t::owned_strings_capacity

Allocated capacity.

Definition at line 182 of file builder.h.

Referenced by __attribute__(), and options_builder_build().

positional_args

positional_arg_descriptor_t* options_config_t::positional_args

Array of positional argument descriptors.

Definition at line 172 of file builder.h.

Referenced by options_builder_build(), options_builder_from_preset(), options_config_destroy(), options_config_parse_positional(), usage_acds(), usage_client(), and usage_server().

program_name

const char* options_config_t::program_name

For usage header.

Definition at line 176 of file builder.h.

Referenced by options_builder_build(), options_builder_from_preset(), options_config_print_usage(), usage_acds(), usage_client(), usage_mirror(), and usage_server().

struct_size

size_t options_config_t::struct_size

sizeof(options_t) for bounds checking

Definition at line 175 of file builder.h.

Referenced by options_builder_build(), and options_builder_from_preset().

---

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

• builder.h