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

Option descriptor. More...

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

Data Fields

const char * long_name
 Long option name (e.g., "port")
 
char short_name
 Short option char (e.g., 'p', or '\0' if none)
 
option_type_t type
 Value type.
 
size_t offset
 offsetof(struct, field) - where to store value
 
const char * help_text
 Description for –help.
 
const char * group
 Group name for help sections (e.g., "NETWORK OPTIONS")
 
const char * arg_placeholder
 Custom argument placeholder (e.g., "SHELL [FILE]" instead of "STR")
 
bool hide_from_mode_help
 If true, don't show in mode-specific help (binary-level only)
 
bool hide_from_binary_help
 If true, don't show in binary-level help (e.g., in release builds)
 
const void * default_value
 Pointer to default value (or NULL if required)
 
bool required
 If true, option must be provided.
 
const char * env_var_name
 Environment variable fallback (or NULL)
 
bool(* validate )(const void *options_struct, char **error_msg)
 
bool(* parse_fn )(const char *arg, void *dest, char **error_msg)
 
void(* action_fn )(void)
 Action to execute (may call exit)
 
bool owns_memory
 If true, strings are strdup'd and freed on cleanup.
 
bool optional_arg
 If true, argument is optional (for callbacks like –verbose)
 
option_mode_bitmask_t mode_bitmask
 Which modes this option applies to.
 
option_metadata_t metadata
 Metadata for shell completions (enums, ranges, examples, etc.)
 
const void *(* mode_default_getter )(asciichat_mode_t mode)
 Get mode-specific default value (NULL if not mode-aware)
 

Detailed Description

Option descriptor.

Describes a single command-line option with all its metadata. Includes both parsing information and completion metadata for generating smart shell completions.

Definition at line 241 of file builder.h.

Field Documentation

◆ action_fn

void(* option_descriptor_t::action_fn) (void)

Action to execute (may call exit)

Definition at line 269 of file builder.h.

Referenced by options_registry_find_by_name(), options_registry_find_by_short(), and registry_entry_to_descriptor().

◆ arg_placeholder

const char* option_descriptor_t::arg_placeholder

Custom argument placeholder (e.g., "SHELL [FILE]" instead of "STR")

Definition at line 253 of file builder.h.

Referenced by get_option_help_placeholder_str(), manpage_content_generate_options(), options_builder_set_arg_placeholder(), and registry_entry_to_descriptor().

◆ default_value

const void* option_descriptor_t::default_value

Pointer to default value (or NULL if required)

Definition at line 258 of file builder.h.

Referenced by format_option_default_value_str(), manpage_content_generate_options(), options_config_print_options_sections_with_width(), options_config_print_usage(), options_config_set_defaults(), options_registry_find_by_name(), options_registry_find_by_short(), and registry_entry_to_descriptor().

◆ env_var_name

const char* option_descriptor_t::env_var_name

Environment variable fallback (or NULL)

Definition at line 260 of file builder.h.

Referenced by manpage_content_generate_environment(), manpage_content_generate_environment_with_manual(), options_config_generate_manpage_template(), options_config_set_defaults(), options_config_validate(), options_registry_find_by_name(), options_registry_find_by_short(), and registry_entry_to_descriptor().

◆ group

const char* option_descriptor_t::group

Group name for help sections (e.g., "NETWORK OPTIONS")

Definition at line 252 of file builder.h.

Referenced by config_schema_build_from_configs(), manpage_content_generate_options(), options_config_calculate_max_col_width(), options_config_print_options_sections_with_width(), options_config_print_usage(), options_registry_find_by_name(), options_registry_find_by_short(), and registry_entry_to_descriptor().

◆ help_text

const char* option_descriptor_t::help_text

Description for –help.

Definition at line 251 of file builder.h.

Referenced by config_schema_build_from_configs(), manpage_content_generate_environment(), manpage_content_generate_environment_with_manual(), manpage_content_generate_options(), options_config_print_options_sections_with_width(), options_config_print_usage(), options_registry_find_by_name(), options_registry_find_by_short(), and registry_entry_to_descriptor().

◆ hide_from_binary_help

bool option_descriptor_t::hide_from_binary_help

If true, don't show in binary-level help (e.g., in release builds)

Definition at line 255 of file builder.h.

Referenced by manpage_content_generate_options(), option_applies_to_mode(), options_builder_add_action(), options_config_calculate_max_col_width(), options_registry_find_by_name(), options_registry_find_by_short(), and registry_entry_to_descriptor().

◆ hide_from_mode_help

bool option_descriptor_t::hide_from_mode_help

If true, don't show in mode-specific help (binary-level only)

Definition at line 254 of file builder.h.

Referenced by manpage_content_generate_options(), option_applies_to_mode(), options_builder_mark_binary_only(), options_config_calculate_max_col_width(), options_registry_find_by_name(), options_registry_find_by_short(), and registry_entry_to_descriptor().

◆ long_name

const char* option_descriptor_t::long_name

Long option name (e.g., "port")

Definition at line 243 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_with_manual(), manpage_content_generate_options(), 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_double(), options_builder_add_double_with_metadata(), options_builder_add_int(), options_builder_add_int_with_metadata(), options_builder_add_string(), options_builder_mark_binary_only(), options_config_calculate_max_col_width(), options_config_print_options_sections_with_width(), options_config_print_usage(), options_config_validate(), options_registry_find_by_name(), options_registry_find_by_short(), and registry_entry_to_descriptor().

◆ metadata

option_metadata_t option_descriptor_t::metadata

Metadata for shell completions (enums, ranges, examples, etc.)

Definition at line 281 of file builder.h.

Referenced by config_schema_build_from_configs(), format_option_default_value_str(), get_option_help_placeholder_str(), options_builder_mark_as_list(), options_builder_set_default_value_display(), options_builder_set_enum_values(), options_builder_set_examples(), options_builder_set_input_type(), options_builder_set_numeric_range(), and registry_entry_to_descriptor().

◆ mode_bitmask

option_mode_bitmask_t option_descriptor_t::mode_bitmask

Which modes this option applies to.

Definition at line 278 of file builder.h.

Referenced by config_schema_build_from_configs(), find_similar_option_with_mode(), manpage_content_generate_options(), option_applies_to_mode(), options_builder_set_mode_bitmask(), options_registry_find_by_name(), options_registry_find_by_short(), and registry_entry_to_descriptor().

◆ mode_default_getter

const void *(* option_descriptor_t::mode_default_getter) (asciichat_mode_t mode)

Get mode-specific default value (NULL if not mode-aware)

Definition at line 284 of file builder.h.

Referenced by config_schema_build_from_configs(), and registry_entry_to_descriptor().

◆ offset

size_t option_descriptor_t::offset

offsetof(struct, field) - where to store value

Definition at line 248 of file builder.h.

Referenced by config_schema_build_from_configs(), is_option_set(), options_config_set_defaults(), options_config_validate(), options_registry_find_by_name(), options_registry_find_by_short(), options_struct_destroy(), and registry_entry_to_descriptor().

◆ optional_arg

bool option_descriptor_t::optional_arg

If true, argument is optional (for callbacks like –verbose)

Definition at line 275 of file builder.h.

Referenced by options_registry_find_by_name(), options_registry_find_by_short(), and registry_entry_to_descriptor().

◆ owns_memory

bool option_descriptor_t::owns_memory

If true, strings are strdup'd and freed on cleanup.

Definition at line 272 of file builder.h.

Referenced by options_registry_find_by_name(), options_registry_find_by_short(), options_struct_destroy(), and registry_entry_to_descriptor().

◆ parse_fn

bool(* option_descriptor_t::parse_fn) (const char *arg, void *dest, char **error_msg)

Definition at line 266 of file builder.h.

Referenced by config_schema_build_from_configs(), options_config_set_defaults(), options_registry_find_by_name(), options_registry_find_by_short(), and registry_entry_to_descriptor().

◆ required

bool option_descriptor_t::required

If true, option must be provided.

Definition at line 259 of file builder.h.

Referenced by manpage_content_generate_options(), options_config_print_options_sections_with_width(), options_config_print_usage(), options_config_validate(), options_registry_find_by_name(), options_registry_find_by_short(), and registry_entry_to_descriptor().

◆ short_name

char option_descriptor_t::short_name

Short option char (e.g., 'p', or '\0' if none)

Definition at line 244 of file builder.h.

Referenced by find_option_descriptor(), manpage_content_generate_options(), options_config_calculate_max_col_width(), options_config_print_options_sections_with_width(), options_config_print_usage(), options_registry_find_by_name(), options_registry_find_by_short(), and registry_entry_to_descriptor().

◆ type

option_type_t option_descriptor_t::type

Value type.

Definition at line 247 of file builder.h.

Referenced by config_schema_build_from_configs(), format_option_default_value_str(), get_option_help_placeholder_str(), is_option_set(), manpage_content_generate_options(), options_config_print_options_sections_with_width(), options_config_print_usage(), options_config_set_defaults(), options_config_validate(), options_registry_find_by_name(), options_registry_find_by_short(), options_struct_destroy(), and registry_entry_to_descriptor().

◆ validate

bool(* option_descriptor_t::validate) (const void *options_struct, char **error_msg)

Definition at line 263 of file builder.h.

Referenced by config_schema_build_from_configs(), options_config_validate(), options_registry_find_by_name(), options_registry_find_by_short(), and registry_entry_to_descriptor().

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