options_builder_t Struct Reference

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

#include <include/ascii-chat/options/builder.h>

Data Fields
option_descriptor_t *	descriptors
	Dynamic array of descriptors.
size_t	num_descriptors
	Current count.
size_t	descriptor_capacity
	Allocated capacity.
option_dependency_t *	dependencies
	Dynamic array of dependencies.
size_t	num_dependencies
	Current count.
size_t	dependency_capacity
	Allocated capacity.
positional_arg_descriptor_t *	positional_args
	Dynamic array of positional args.
size_t	num_positional_args
	Current count.
size_t	positional_arg_capacity
	Allocated capacity.
usage_descriptor_t *	usage_lines
	Dynamic array of usage lines.
size_t	num_usage_lines
	Current count.
size_t	usage_line_capacity
	Allocated capacity.
example_descriptor_t *	examples
	Dynamic array of examples.
size_t	num_examples
	Current count.
size_t	example_capacity
	Allocated capacity.
help_mode_descriptor_t *	modes
	Dynamic array of modes.
size_t	num_modes
	Current count.
size_t	mode_capacity
	Allocated capacity.
custom_section_descriptor_t *	custom_sections
	Dynamic array of custom sections.
size_t	num_custom_sections
	Current count.
size_t	custom_section_capacity
	Allocated capacity.
size_t	struct_size
const char *	program_name
const char *	description
char **	owned_strings_builder
size_t	num_owned_strings_builder
size_t	owned_strings_builder_capacity

Detailed Description

Immutable parsing tables produced from an options builder.

Mutable owner used to assemble option descriptors, dependencies, help sections, and examples before building a config.

For incrementally constructing option configurations. Use builder functions to add options and dependencies, then build an immutable config.

Definition at line 457 of file builder.h.

Field Documentation

custom_section_capacity

size_t options_builder_t::custom_section_capacity

Allocated capacity.

Definition at line 484 of file builder.h.

custom_sections

custom_section_descriptor_t* options_builder_t::custom_sections

Dynamic array of custom sections.

Definition at line 482 of file builder.h.

dependencies

option_dependency_t* options_builder_t::dependencies

Dynamic array of dependencies.

Definition at line 462 of file builder.h.

dependency_capacity

size_t options_builder_t::dependency_capacity

Allocated capacity.

Definition at line 464 of file builder.h.

description

const char* options_builder_t::description

Definition at line 488 of file builder.h.

Referenced by options_preset_unified().

descriptor_capacity

size_t options_builder_t::descriptor_capacity

Allocated capacity.

Definition at line 460 of file builder.h.

descriptors

option_descriptor_t* options_builder_t::descriptors

Dynamic array of descriptors.

Definition at line 458 of file builder.h.

example_capacity

size_t options_builder_t::example_capacity

Allocated capacity.

Definition at line 476 of file builder.h.

examples

example_descriptor_t* options_builder_t::examples

Dynamic array of examples.

Definition at line 474 of file builder.h.

mode_capacity

size_t options_builder_t::mode_capacity

Allocated capacity.

Definition at line 480 of file builder.h.

modes

help_mode_descriptor_t* options_builder_t::modes

Dynamic array of modes.

Definition at line 478 of file builder.h.

num_custom_sections

size_t options_builder_t::num_custom_sections

Current count.

Definition at line 483 of file builder.h.

num_dependencies

size_t options_builder_t::num_dependencies

Current count.

Definition at line 463 of file builder.h.

num_descriptors

size_t options_builder_t::num_descriptors

Current count.

Definition at line 459 of file builder.h.

num_examples

size_t options_builder_t::num_examples

Current count.

Definition at line 475 of file builder.h.

num_modes

size_t options_builder_t::num_modes

Current count.

Definition at line 479 of file builder.h.

num_owned_strings_builder

size_t options_builder_t::num_owned_strings_builder

Definition at line 492 of file builder.h.

num_positional_args

size_t options_builder_t::num_positional_args

Current count.

Definition at line 467 of file builder.h.

num_usage_lines

size_t options_builder_t::num_usage_lines

Current count.

Definition at line 471 of file builder.h.

owned_strings_builder

char** options_builder_t::owned_strings_builder

Definition at line 491 of file builder.h.

owned_strings_builder_capacity

size_t options_builder_t::owned_strings_builder_capacity

Definition at line 493 of file builder.h.

positional_arg_capacity

size_t options_builder_t::positional_arg_capacity

Allocated capacity.

Definition at line 468 of file builder.h.

positional_args

positional_arg_descriptor_t* options_builder_t::positional_args

Dynamic array of positional args.

Definition at line 466 of file builder.h.

program_name

const char* options_builder_t::program_name

Definition at line 487 of file builder.h.

Referenced by options_preset_unified().

struct_size

size_t options_builder_t::struct_size

Definition at line 486 of file builder.h.

usage_line_capacity

size_t options_builder_t::usage_line_capacity

Allocated capacity.

Definition at line 472 of file builder.h.

usage_lines

usage_descriptor_t* options_builder_t::usage_lines

Dynamic array of usage lines.

Definition at line 470 of file builder.h.

---

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

• builder.h