ascii-chat 0.11.33
Video chat in your terminal
Loading...
Searching...
No Matches
Data Fields
options_builder_t Struct Reference

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

Options builder.

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

Definition at line 441 of file builder.h.

Field Documentation

◆ custom_section_capacity

size_t options_builder_t::custom_section_capacity

Allocated capacity.

Definition at line 468 of file builder.h.

Referenced by options_builder_create().

◆ custom_sections

custom_section_descriptor_t* options_builder_t::custom_sections

Dynamic array of custom sections.

Definition at line 466 of file builder.h.

Referenced by options_builder_add_custom_section(), options_builder_build(), options_builder_create(), and options_builder_destroy().

◆ dependencies

option_dependency_t* options_builder_t::dependencies

Dynamic array of dependencies.

Definition at line 446 of file builder.h.

Referenced by ensure_dependency_capacity(), options_builder_add_dependency(), options_builder_add_dependency_conflicts(), options_builder_add_dependency_implies(), options_builder_add_dependency_requires(), options_builder_build(), options_builder_create(), and options_builder_destroy().

◆ dependency_capacity

size_t options_builder_t::dependency_capacity

Allocated capacity.

Definition at line 448 of file builder.h.

Referenced by ensure_dependency_capacity(), and options_builder_create().

◆ description

const char* options_builder_t::description

Definition at line 472 of file builder.h.

Referenced by options_builder_build(), options_builder_create(), options_builder_from_preset(), and options_preset_unified().

◆ descriptor_capacity

size_t options_builder_t::descriptor_capacity

Allocated capacity.

Definition at line 444 of file builder.h.

Referenced by ensure_descriptor_capacity(), and options_builder_create().

◆ descriptors

option_descriptor_t* options_builder_t::descriptors

Dynamic array of descriptors.

Definition at line 442 of file builder.h.

Referenced by ensure_descriptor_capacity(), options_builder_add_action(), options_builder_add_bool(), options_builder_add_callback(), options_builder_add_callback_optional(), options_builder_add_callback_with_metadata(), options_builder_add_descriptor(), options_builder_add_double(), options_builder_add_double_with_metadata(), options_builder_add_int(), options_builder_add_int_with_metadata(), options_builder_add_string(), options_builder_build(), options_builder_create(), options_builder_destroy(), options_builder_mark_as_list(), options_builder_mark_binary_only(), options_builder_set_arg_placeholder(), options_builder_set_default_value_display(), options_builder_set_enum_values(), options_builder_set_examples(), options_builder_set_input_type(), options_builder_set_mode_bitmask(), and options_builder_set_numeric_range().

◆ example_capacity

size_t options_builder_t::example_capacity

Allocated capacity.

Definition at line 460 of file builder.h.

Referenced by options_builder_create().

◆ examples

example_descriptor_t* options_builder_t::examples

Dynamic array of examples.

Definition at line 458 of file builder.h.

Referenced by options_builder_add_example(), options_builder_add_example_utility(), options_builder_build(), options_builder_create(), and options_builder_destroy().

◆ mode_capacity

size_t options_builder_t::mode_capacity

Allocated capacity.

Definition at line 464 of file builder.h.

Referenced by options_builder_create().

◆ modes

help_mode_descriptor_t* options_builder_t::modes

Dynamic array of modes.

Definition at line 462 of file builder.h.

Referenced by options_builder_add_mode(), options_builder_build(), options_builder_create(), and options_builder_destroy().

◆ num_custom_sections

size_t options_builder_t::num_custom_sections

Current count.

Definition at line 467 of file builder.h.

Referenced by options_builder_add_custom_section(), options_builder_build(), and options_builder_create().

◆ num_dependencies

size_t options_builder_t::num_dependencies

Current count.

Definition at line 447 of file builder.h.

Referenced by ensure_dependency_capacity(), options_builder_add_dependency(), options_builder_add_dependency_conflicts(), options_builder_add_dependency_implies(), options_builder_add_dependency_requires(), options_builder_build(), and options_builder_create().

◆ num_descriptors

size_t options_builder_t::num_descriptors

Current count.

Definition at line 443 of file builder.h.

Referenced by ensure_descriptor_capacity(), options_builder_add_action(), options_builder_add_bool(), options_builder_add_callback(), options_builder_add_callback_optional(), options_builder_add_callback_with_metadata(), options_builder_add_descriptor(), options_builder_add_double(), options_builder_add_double_with_metadata(), options_builder_add_int(), options_builder_add_int_with_metadata(), options_builder_add_string(), options_builder_build(), options_builder_create(), options_builder_mark_binary_only(), options_builder_set_arg_placeholder(), and options_builder_set_mode_bitmask().

◆ num_examples

size_t options_builder_t::num_examples

Current count.

Definition at line 459 of file builder.h.

Referenced by options_builder_add_example(), options_builder_add_example_utility(), options_builder_build(), and options_builder_create().

◆ num_modes

size_t options_builder_t::num_modes

Current count.

Definition at line 463 of file builder.h.

Referenced by options_builder_add_mode(), options_builder_build(), and options_builder_create().

◆ num_owned_strings_builder

size_t options_builder_t::num_owned_strings_builder

Definition at line 476 of file builder.h.

Referenced by options_builder_build(), and options_builder_create().

◆ num_positional_args

size_t options_builder_t::num_positional_args

Current count.

Definition at line 451 of file builder.h.

Referenced by ensure_positional_arg_capacity(), options_builder_add_positional(), options_builder_build(), and options_builder_create().

◆ num_usage_lines

size_t options_builder_t::num_usage_lines

Current count.

Definition at line 455 of file builder.h.

Referenced by options_builder_add_usage(), options_builder_build(), and options_builder_create().

◆ owned_strings_builder

char** options_builder_t::owned_strings_builder

Definition at line 475 of file builder.h.

Referenced by options_builder_build(), options_builder_create(), and options_builder_destroy().

◆ owned_strings_builder_capacity

size_t options_builder_t::owned_strings_builder_capacity

Definition at line 477 of file builder.h.

Referenced by options_builder_build(), and options_builder_create().

◆ positional_arg_capacity

size_t options_builder_t::positional_arg_capacity

Allocated capacity.

Definition at line 452 of file builder.h.

Referenced by ensure_positional_arg_capacity(), and options_builder_create().

◆ positional_args

positional_arg_descriptor_t* options_builder_t::positional_args

Dynamic array of positional args.

Definition at line 450 of file builder.h.

Referenced by ensure_positional_arg_capacity(), options_builder_add_positional(), options_builder_build(), options_builder_create(), and options_builder_destroy().

◆ program_name

const char* options_builder_t::program_name

Definition at line 471 of file builder.h.

Referenced by options_builder_build(), options_builder_create(), options_builder_from_preset(), and options_preset_unified().

◆ struct_size

size_t options_builder_t::struct_size

Definition at line 470 of file builder.h.

Referenced by options_builder_build(), and options_builder_create().

◆ usage_line_capacity

size_t options_builder_t::usage_line_capacity

Allocated capacity.

Definition at line 456 of file builder.h.

Referenced by options_builder_create().

◆ usage_lines

usage_descriptor_t* options_builder_t::usage_lines

Dynamic array of usage lines.

Definition at line 454 of file builder.h.

Referenced by options_builder_add_usage(), options_builder_build(), options_builder_create(), and options_builder_destroy().

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