Data Fields
const config_format_t *	toplevel

smartlist_t *	subconfigs

smartlist_t *	all_vars

smartlist_t *	all_abbrevs

smartlist_t *	all_deprecations

bool	frozen

struct_magic_decl_t	toplevel_magic

Detailed Description

A collection of config_format_t objects to describe several objects that are all configured with the same configuration file.

(NOTE: for now, this only handles a single config_format_t.)

Definition at line 107 of file confmgt.c.

Field Documentation

◆ all_abbrevs

smartlist_t* all_abbrevs

A smartlist of config_abbrev_t objects for all configuration formats. These objects are used to track synonyms and abbreviations for different configuration options.

Definition at line 125 of file confmgt.c.

Referenced by config_expand_abbrev().

◆ all_deprecations

smartlist_t* all_deprecations

A smartlist of config_deprecation_t for all configuration formats.

Definition at line 127 of file confmgt.c.

Referenced by config_mgr_list_deprecated_vars().

◆ all_vars

smartlist_t* all_vars

A smartlist of managed_var_t objects for all configuration formats.

Definition at line 121 of file confmgt.c.

Referenced by config_check_ok(), config_dup(), config_get_changes(), config_init(), config_mark_lists_fragile(), config_mgr_find_var(), config_mgr_free_(), config_mgr_freeze(), and config_mgr_list_vars().

◆ frozen

bool frozen

True if this manager has been frozen and cannot have any more formats added to it. A manager must be frozen before it can be used to construct or manipulate objects.

Definition at line 131 of file confmgt.c.

Referenced by config_mgr_assert_magic_ok(), config_mgr_freeze(), and config_new().

◆ subconfigs

smartlist_t* subconfigs

List of second-level configuration format objects that this manager also knows about.

Definition at line 119 of file confmgt.c.

Referenced by config_validate().

◆ toplevel

const config_format_t* toplevel

The 'top-level' configuration format. This one is used for legacy options that have not yet been assigned to different sub-modules.

(NOTE: for now, this is the only config_format_t that a config_mgr_t contains. A subsequent commit will add more. XXXX)

Definition at line 114 of file confmgt.c.

Referenced by config_assign_line(), config_dump(), config_free_(), config_mgr_freeze(), and config_mgr_get_suite_ptr().

◆ toplevel_magic

struct_magic_decl_t toplevel_magic

A replacement for the magic number of the toplevel object. We override that number to make it unique for this particular config_mgr_t, so that an object constructed with one mgr can't be used with another, even if those managers' contents are equal.

Definition at line 137 of file confmgt.c.

Referenced by config_check_toplevel_magic(), config_mgr_assert_magic_ok(), and config_mgr_freeze().

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

lib/confmgt/confmgt.c

Data Fields