Type information about a category-level configurable object. More...
#include <config_options.h>
Data Fields | |
| const char * | category |
| enum aco_category_op | category_match |
| unsigned int | hidden |
| struct aco_type_internal * | internal |
| aco_type_item_alloc | item_alloc |
| aco_type_item_find | item_find |
| size_t | item_offset |
| aco_type_item_pre_process | item_pre_process |
| aco_type_prelink | item_prelink |
| const char * | matchfield |
| aco_matchvalue_func | matchfunc |
| const char * | matchvalue |
| const char * | name |
| enum aco_type_t | type |
Detailed Description
Type information about a category-level configurable object.
- Examples
- app_skel.c.
Definition at line 121 of file config_options.h.
Field Documentation
◆ category
| const char* category |
A regular expression for matching categories to be allowed or denied
Definition at line 125 of file config_options.h.
Referenced by internal_aco_type_find().
◆ category_match
| enum aco_category_op category_match |
Whether the following category regex is a whitelist or blacklist
Definition at line 129 of file config_options.h.
◆ hidden
| unsigned int hidden |
Type is for internal purposes only and it and all options should not be visible to users
Definition at line 131 of file config_options.h.
◆ internal
| struct aco_type_internal* internal |
Definition at line 138 of file config_options.h.
Referenced by link_option_to_types().
◆ item_alloc
| aco_type_item_alloc item_alloc |
An allocation function for item associated with this type
- Examples
- app_skel.c.
Definition at line 134 of file config_options.h.
◆ item_find
| aco_type_item_find item_find |
A callback function to find an existing item in a particular container
- Examples
- app_skel.c.
Definition at line 135 of file config_options.h.
◆ item_offset
| size_t item_offset |
The offset in the config snapshot for the global config or item config container
- Examples
- app_skel.c.
Definition at line 130 of file config_options.h.
◆ item_pre_process
| aco_type_item_pre_process item_pre_process |
An optional callback function that is called after defaults are applied, but before config processing
Definition at line 136 of file config_options.h.
◆ item_prelink
| aco_type_prelink item_prelink |
An optional callback function that is called after config processing, but before applying changes
Definition at line 137 of file config_options.h.
◆ matchfield
| const char* matchfield |
An option name to match for this type (i.e. a 'type'-like column)
Definition at line 126 of file config_options.h.
◆ matchfunc
| aco_matchvalue_func matchfunc |
A function for determining whether the option value matches
Definition at line 128 of file config_options.h.
◆ matchvalue
| const char* matchvalue |
The value of the option to require for matching (i.e. 'peer')
Definition at line 127 of file config_options.h.
◆ name
| const char* name |
The name of this type (must match XML documentation)
Definition at line 124 of file config_options.h.
Referenced by ast_context_find(), ast_xml_doc_item_hash(), build_cli_notify(), check_match(), cli_show_modules(), featuregroup_handler(), find_context(), find_context_locked(), PathSegment::get_child(), handle_manager_show_event(), SwaggerType::load(), notify_option_handler(), print_applicationmap(), select_entry(), select_item_menu(), select_item_seq(), and setup_dynamic_feature().
◆ type
| enum aco_type_t type |
Whether this is a global or item type
- Examples
- app_skel.c.
Definition at line 123 of file config_options.h.
Referenced by ast_sorcery_object_unregister(), ast_xmldoc_regenerate_doc_item(), check_pval_item(), destroy_pval_item(), find_pval_goto_item(), find_switch_item(), match_pval_item(), print_pval(), and traverse_pval_item_template().
The documentation for this struct was generated from the following file:
