config_format_t Struct Reference

#include <conftypes.h>

Data Fields
size_t	size
struct_magic_decl_t	magic
const config_abbrev_t *	abbrevs
const config_deprecation_t *	deprecations
const config_var_t *	vars
pre_normalize_fn_t	pre_normalize_fn
validate_fn_t	validate_fn
legacy_validate_fn_t	legacy_validate_fn
check_transition_fn_t	check_transition_fn
post_normalize_fn_t	post_normalize_fn
clear_cfg_fn_t	clear_fn
const struct_member_t *	extra
bool	has_config_suite
ptrdiff_t	config_suite_offset

Detailed Description

Information on the keys, value types, key-to-struct-member mappings, variable descriptions, validation functions, and abbreviations for a configuration or storage format.

Definition at line 347 of file conftypes.h.

Field Documentation

abbrevs

const config_abbrev_t* abbrevs

List of abbreviations that we expand when parsing this format.

Definition at line 350 of file conftypes.h.

check_transition_fn

check_transition_fn_t check_transition_fn

Transition checking function. Invoked by config_validate().

Definition at line 364 of file conftypes.h.

clear_fn

clear_cfg_fn_t clear_fn

Function to clear the configuration.

Definition at line 368 of file conftypes.h.

Referenced by config_free_().

config_suite_offset

ptrdiff_t config_suite_offset

The position of a config_suite_t pointer within the toplevel object. Ignored unless have_config_suite is true.

Definition at line 380 of file conftypes.h.

Referenced by config_mgr_get_suite_ptr().

extra

const struct_member_t* extra

If present, extra denotes a LINELIST variable for unrecognized lines. Otherwise, unrecognized lines are an error.

Definition at line 371 of file conftypes.h.

has_config_suite

bool has_config_suite

If true, this format describes a top-level configuration, with a suite containing multiple sub-configuration objects.

Definition at line 376 of file conftypes.h.

Referenced by config_mgr_get_suite_ptr().

legacy_validate_fn

legacy_validate_fn_t legacy_validate_fn

Legacy validation function. Invoked by config_validate().

Definition at line 362 of file conftypes.h.

magic

struct_magic_decl_t magic

Magic number info for this struct.

Definition at line 349 of file conftypes.h.

Referenced by config_mgr_freeze().

post_normalize_fn

post_normalize_fn_t post_normalize_fn

Late-stage normalization callback. Invoked by config_validate().

Definition at line 366 of file conftypes.h.

pre_normalize_fn

pre_normalize_fn_t pre_normalize_fn

Early-stage normalization callback. Invoked by config_validate().

Definition at line 358 of file conftypes.h.

size

size_t size

Size of the struct that everything gets parsed into.

Definition at line 348 of file conftypes.h.

validate_fn

validate_fn_t validate_fn

Configuration validation function. Invoked by config_validate().

Definition at line 360 of file conftypes.h.

vars

const config_var_t* vars

List of deprecated options List of variables we recognize, their default values, and where we stick them in the structure.

Definition at line 353 of file conftypes.h.

---

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

• lib/conf/conftypes.h