Immutable parsing tables produced from an options builder. More...

#include <include/ascii-chat/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.
usage_descriptor_t *	usage_lines
	Array of usage line descriptors.
size_t	num_usage_lines
	Number of usage lines.
example_descriptor_t *	examples
	Array of example descriptors.
size_t	num_examples
	Number of examples.
help_mode_descriptor_t *	modes
	Array of mode descriptors.
size_t	num_modes
	Number of modes.
custom_section_descriptor_t *	custom_sections
	Array of custom help sections.
size_t	num_custom_sections
	Number of custom sections.
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

Immutable parsing tables produced from an options builder.

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

Definition at line 414 of file builder.h.

Field Documentation

◆ custom_sections

custom_section_descriptor_t* options_config_t::custom_sections

Array of custom help sections.

Definition at line 438 of file builder.h.

◆ dependencies

option_dependency_t* options_config_t::dependencies

Array of dependencies.

Definition at line 418 of file builder.h.

◆ description

const char* options_config_t::description

For usage header.

Definition at line 426 of file builder.h.

◆ descriptors

option_descriptor_t* options_config_t::descriptors

Array of option descriptors.

Definition at line 415 of file builder.h.

Referenced by config_schema_build_from_configs(), find_similar_option_with_mode(), manpage_content_generate_environment(), manpage_content_generate_environment_with_manual(), manpage_content_generate_options(), and options_config_generate_manpage_template().

◆ examples

example_descriptor_t* options_config_t::examples

Array of example descriptors.

Definition at line 432 of file builder.h.

Referenced by manpage_content_generate_examples().

◆ modes

help_mode_descriptor_t* options_config_t::modes

Array of mode descriptors.

Definition at line 435 of file builder.h.

◆ num_custom_sections

size_t options_config_t::num_custom_sections

Number of custom sections.

Definition at line 439 of file builder.h.

◆ num_dependencies

size_t options_config_t::num_dependencies

Number of dependencies.

Definition at line 419 of file builder.h.

◆ num_descriptors

size_t options_config_t::num_descriptors

Number of descriptors.

Definition at line 416 of file builder.h.

Referenced by config_schema_build_from_configs(), find_similar_option_with_mode(), manpage_content_generate_environment(), manpage_content_generate_environment_with_manual(), manpage_content_generate_options(), and options_config_generate_manpage_template().

◆ num_examples

size_t options_config_t::num_examples

Number of examples.

Definition at line 433 of file builder.h.

Referenced by manpage_content_generate_examples(), and options_config_generate_manpage_template().

◆ num_modes

size_t options_config_t::num_modes

Number of modes.

Definition at line 436 of file builder.h.

◆ num_owned_strings

size_t options_config_t::num_owned_strings

Number of owned strings.

Definition at line 443 of file builder.h.

◆ num_positional_args

size_t options_config_t::num_positional_args

Number of positional arguments.

Definition at line 422 of file builder.h.

Referenced by manpage_content_generate_positional(), and options_config_generate_manpage_template().

◆ num_usage_lines

size_t options_config_t::num_usage_lines

Number of usage lines.

Definition at line 430 of file builder.h.

Referenced by manpage_content_generate_usage(), and manpage_merger_generate_usage().

◆ owned_strings

char** options_config_t::owned_strings

Strdup'd strings to free on cleanup.

Definition at line 442 of file builder.h.

◆ owned_strings_capacity

size_t options_config_t::owned_strings_capacity

Allocated capacity.

Definition at line 444 of file builder.h.

◆ positional_args

positional_arg_descriptor_t* options_config_t::positional_args

Array of positional argument descriptors.

Definition at line 421 of file builder.h.

Referenced by manpage_content_generate_positional().

◆ program_name

const char* options_config_t::program_name

For usage header.

Definition at line 425 of file builder.h.

◆ struct_size

size_t options_config_t::struct_size

sizeof(options_t) for bounds checking

Definition at line 424 of file builder.h.

◆ usage_lines

usage_descriptor_t* options_config_t::usage_lines

Array of usage line descriptors.

Definition at line 429 of file builder.h.