registry_entry_t Struct Reference

Registry entry - stores option definition with mode bitmask and metadata. More...

#include <include/ascii-chat/options/registry/common.h>

Data Fields
const char *	long_name
char	short_name
option_type_t	type
size_t	offset
const void *	default_value
	Default value (single value for all modes, or NULL if mode_default_getter is set)
size_t	default_value_size
const char *	help_text
const char *	group
const char *	arg_placeholder
	Custom argument placeholder (e.g., "SHELL [FILE]" instead of "STR")
bool	required
const char *	env_var_name
bool(*	validate_fn )(const void *options_struct, char **error_msg)
bool(*	parse_fn )(const char *arg, void *dest, char **error_msg)
bool	owns_memory
bool	optional_arg
option_mode_bitmask_t	mode_bitmask
option_metadata_t	metadata
	Enum values, numeric ranges, examples.
mode_default_getter_fn	mode_default_getter
	Mode-aware default getter (NULL if using default_value) - LAST for backward compat.

Detailed Description

Registry entry - stores option definition with mode bitmask and metadata.

Definition at line 31 of file options/registry/common.h.

Field Documentation

arg_placeholder

const char* registry_entry_t::arg_placeholder

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

Definition at line 40 of file options/registry/common.h.

Referenced by options_registry_add_all_to_builder(), and registry_entry_to_descriptor().

default_value

const void* registry_entry_t::default_value

Default value (single value for all modes, or NULL if mode_default_getter is set)

Definition at line 36 of file options/registry/common.h.

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

default_value_size

size_t registry_entry_t::default_value_size

Definition at line 37 of file options/registry/common.h.

Referenced by options_registry_add_all_to_builder().

env_var_name

const char* registry_entry_t::env_var_name

Definition at line 42 of file options/registry/common.h.

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

group

const char* registry_entry_t::group

Definition at line 39 of file options/registry/common.h.

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

help_text

const char* registry_entry_t::help_text

Definition at line 38 of file options/registry/common.h.

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

long_name

const char* registry_entry_t::long_name

Definition at line 32 of file options/registry/common.h.

Referenced by options_get_help_text(), options_registry_add_all_to_builder(), options_registry_find_by_name(), options_registry_find_by_short(), options_registry_get_metadata(), registry_entry_applies_to_mode(), registry_entry_to_descriptor(), registry_find_entry_by_name(), registry_find_entry_by_short(), registry_init_from_builders(), registry_init_size(), and registry_validate_unique_options().

metadata

option_metadata_t registry_entry_t::metadata

Enum values, numeric ranges, examples.

Definition at line 48 of file options/registry/common.h.

Referenced by options_registry_add_all_to_builder(), options_registry_get_metadata(), and registry_entry_to_descriptor().

mode_bitmask

option_mode_bitmask_t registry_entry_t::mode_bitmask

Definition at line 47 of file options/registry/common.h.

Referenced by options_get_help_text(), options_registry_add_all_to_builder(), options_registry_find_by_name(), options_registry_find_by_short(), registry_entry_applies_to_mode(), and registry_entry_to_descriptor().

mode_default_getter

mode_default_getter_fn registry_entry_t::mode_default_getter

Mode-aware default getter (NULL if using default_value) - LAST for backward compat.

Definition at line 50 of file options/registry/common.h.

Referenced by registry_entry_to_descriptor().

offset

size_t registry_entry_t::offset

Definition at line 35 of file options/registry/common.h.

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

optional_arg

bool registry_entry_t::optional_arg

Definition at line 46 of file options/registry/common.h.

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

owns_memory

bool registry_entry_t::owns_memory

Definition at line 45 of file options/registry/common.h.

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

parse_fn

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

Definition at line 44 of file options/registry/common.h.

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

required

bool registry_entry_t::required

Definition at line 41 of file options/registry/common.h.

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

short_name

char registry_entry_t::short_name

Definition at line 33 of file options/registry/common.h.

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

type

option_type_t registry_entry_t::type

Definition at line 34 of file options/registry/common.h.

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

validate_fn

bool(* registry_entry_t::validate_fn) (const void *options_struct, char **error_msg)

Definition at line 43 of file options/registry/common.h.

Referenced by options_registry_add_all_to_builder(), 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:

• options/registry/common.h