options_config_t Struct Reference

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

Options configuration.

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

Definition at line 401 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 425 of file builder.h.

Referenced by options_builder_build(), options_config_destroy(), and options_print_help_for_mode().

dependencies

option_dependency_t* options_config_t::dependencies

Array of dependencies.

Definition at line 405 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 413 of file builder.h.

Referenced by options_builder_build(), and options_builder_from_preset().

descriptors

option_descriptor_t* options_config_t::descriptors

Array of option descriptors.

Definition at line 402 of file builder.h.

Referenced by config_schema_build_from_configs(), find_option(), find_option_descriptor(), find_similar_option_with_mode(), manpage_content_generate_environment(), manpage_content_generate_environment_with_manual(), manpage_content_generate_options(), options_builder_build(), options_builder_from_preset(), options_config_calculate_max_col_width(), options_config_destroy(), options_config_generate_manpage_template(), options_config_print_options_sections_with_width(), options_config_print_usage(), options_config_set_defaults(), options_config_validate(), and options_struct_destroy().

examples

example_descriptor_t* options_config_t::examples

Array of example descriptors.

Definition at line 419 of file builder.h.

Referenced by manpage_content_generate_examples(), options_builder_build(), options_config_calculate_max_col_width(), and options_config_destroy().

modes

help_mode_descriptor_t* options_config_t::modes

Array of mode descriptors.

Definition at line 422 of file builder.h.

Referenced by options_builder_build(), options_config_calculate_max_col_width(), and options_config_destroy().

num_custom_sections

size_t options_config_t::num_custom_sections

Number of custom sections.

Definition at line 426 of file builder.h.

Referenced by options_builder_build(), and options_print_help_for_mode().

num_dependencies

size_t options_config_t::num_dependencies

Number of dependencies.

Definition at line 406 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 403 of file builder.h.

Referenced by config_schema_build_from_configs(), find_option(), find_option_descriptor(), find_similar_option_with_mode(), manpage_content_generate_environment(), manpage_content_generate_environment_with_manual(), manpage_content_generate_options(), options_builder_build(), options_builder_from_preset(), options_config_calculate_max_col_width(), options_config_generate_manpage_merged(), options_config_generate_manpage_template(), options_config_print_options_sections_with_width(), options_config_print_usage(), options_config_set_defaults(), options_config_validate(), and options_struct_destroy().

num_examples

size_t options_config_t::num_examples

Number of examples.

Definition at line 420 of file builder.h.

Referenced by manpage_content_generate_examples(), options_builder_build(), options_config_calculate_max_col_width(), options_config_generate_manpage_merged(), and options_config_generate_manpage_template().

num_modes

size_t options_config_t::num_modes

Number of modes.

Definition at line 423 of file builder.h.

Referenced by options_builder_build(), options_config_calculate_max_col_width(), and options_print_help_for_mode().

num_owned_strings

size_t options_config_t::num_owned_strings

Number of owned strings.

Definition at line 430 of file builder.h.

Referenced by options_builder_build(), options_config_destroy(), and options_struct_destroy().

num_positional_args

size_t options_config_t::num_positional_args

Number of positional arguments.

Definition at line 409 of file builder.h.

Referenced by manpage_content_generate_positional(), options_builder_build(), options_builder_from_preset(), options_config_generate_manpage_merged(), options_config_generate_manpage_template(), options_config_parse_positional(), and options_print_help_for_mode().

num_usage_lines

size_t options_config_t::num_usage_lines

Number of usage lines.

Definition at line 417 of file builder.h.

Referenced by manpage_content_generate_usage(), manpage_merger_generate_usage(), options_builder_build(), options_config_calculate_max_col_width(), options_config_generate_manpage_merged(), and options_print_help_for_mode().

owned_strings

char** options_config_t::owned_strings

Strdup'd strings to free on cleanup.

Definition at line 429 of file builder.h.

Referenced by options_builder_build(), options_config_destroy(), and options_struct_destroy().

owned_strings_capacity

size_t options_config_t::owned_strings_capacity

Allocated capacity.

Definition at line 431 of file builder.h.

Referenced by options_builder_build().

positional_args

positional_arg_descriptor_t* options_config_t::positional_args

Array of positional argument descriptors.

Definition at line 408 of file builder.h.

Referenced by manpage_content_generate_positional(), options_builder_build(), options_builder_from_preset(), options_config_destroy(), options_config_parse_positional(), and options_print_help_for_mode().

program_name

const char* options_config_t::program_name

For usage header.

Definition at line 412 of file builder.h.

Referenced by options_builder_build(), and options_builder_from_preset().

struct_size

size_t options_config_t::struct_size

sizeof(options_t) for bounds checking

Definition at line 411 of file builder.h.

Referenced by options_builder_build(), and options_builder_from_preset().

usage_lines

usage_descriptor_t* options_config_t::usage_lines

Array of usage line descriptors.

Definition at line 416 of file builder.h.

Referenced by manpage_content_generate_usage(), manpage_merger_generate_usage(), options_builder_build(), options_config_calculate_max_col_width(), options_config_destroy(), and options_print_help_for_mode().

---

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

• builder.h