X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;ds=inline;f=ucw%2Fconf.h;h=d661f48e9146685ba2537de2ca298dacc886668d;hb=f6d9af10d04cc9b1d72a32ff2bb6e7102ffc5659;hp=fc228eb86826cb1bb15c0d38e0739306b13681cc;hpb=61dec66f0e14df50777adab21cd7d03488452a1e;p=libucw.git diff --git a/ucw/conf.h b/ucw/conf.h index fc228eb8..d661f48e 100644 --- a/ucw/conf.h +++ b/ucw/conf.h @@ -2,7 +2,7 @@ * UCW Library -- Configuration files * * (c) 2001--2006 Robert Spalek - * (c) 2003--2012 Martin Mares + * (c) 2003--2014 Martin Mares * * This software may be freely distributed and used according to the terms * of the GNU Lesser General Public License. @@ -12,6 +12,39 @@ #define _UCW_CONF_H #include +#include + +#ifdef CONFIG_UCW_CLEAN_ABI +#define cf_close_group ucw_cf_close_group +#define cf_declare_rel_section ucw_cf_declare_rel_section +#define cf_declare_section ucw_cf_declare_section +#define cf_delete_context ucw_cf_delete_context +#define cf_dump_sections ucw_cf_dump_sections +#define cf_find_item ucw_cf_find_item +#define cf_get_pool ucw_cf_get_pool +#define cf_init_section ucw_cf_init_section +#define cf_journal_block ucw_cf_journal_block +#define cf_journal_commit_transaction ucw_cf_journal_commit_transaction +#define cf_journal_new_transaction ucw_cf_journal_new_transaction +#define cf_journal_rollback_transaction ucw_cf_journal_rollback_transaction +#define cf_load ucw_cf_load +#define cf_malloc ucw_cf_malloc +#define cf_malloc_zero ucw_cf_malloc_zero +#define cf_modify_item ucw_cf_modify_item +#define cf_new_context ucw_cf_new_context +#define cf_open_group ucw_cf_open_group +#define cf_parse_double ucw_cf_parse_double +#define cf_parse_int ucw_cf_parse_int +#define cf_parse_ip ucw_cf_parse_ip +#define cf_parse_u64 ucw_cf_parse_u64 +#define cf_printf ucw_cf_printf +#define cf_reload ucw_cf_reload +#define cf_revert ucw_cf_revert +#define cf_set ucw_cf_set +#define cf_set_journalling ucw_cf_set_journalling +#define cf_strdup ucw_cf_strdup +#define cf_switch_context ucw_cf_switch_context +#endif struct mempool; @@ -39,9 +72,9 @@ struct cf_context *cf_new_context(void); * All configuration settings made within the context are rolled back * (except when journalling is turned off). All memory allocated on behalf * of the context is freed, which includes memory obtained by calls to - * cf_malloc(). + * @cf_malloc(). **/ -void cf_free_context(struct cf_context *cc); +void cf_delete_context(struct cf_context *cc); /** * Make the given configuration context current and return the previously @@ -63,14 +96,16 @@ struct cf_context *cf_switch_context(struct cf_context *cc); * configuration specified in the file are undone. **/ int cf_load(const char *file); + /** * Reload configuration from @file, replace the old one. * If @file is NULL, reload all loaded configuration files and re-apply - * bits of configuration passed to cf_set(). + * bits of configuration passed to @cf_set(). * Returns a non-zero value upon error. In that case, all configuration * settings are rolled back to the state before calling this function. **/ int cf_reload(const char *file); + /** * Parse some part of configuration passed in @string. * The syntax is the same as in the <>. @@ -92,11 +127,17 @@ int cf_set(const char *string); void cf_open_group(void); /** - * Close a group opened by cf_open_group(). Returns a non-zero value upon error, + * Close a group opened by @cf_open_group(). Returns a non-zero value upon error, * which usually means that a commit hook has failed. **/ int cf_close_group(void); +/** + * Return all configuration items to their initial state before loading the + * configuration file. If journalling is disabled, it does nothing. + **/ +void cf_revert(void); + /*** === Data types [[conf_types]] ***/ enum cf_class { /** Class of the configuration item. **/ @@ -383,9 +424,7 @@ struct cf_section { /** A section. **/ **/ #define CF_ANY_NUM -0x7fffffff -#define DARY_LEN(a) ((uns*)a)[-1] /** Length of an dynamic array. **/ -#define DARY_ALLOC(type,len,val...) ((struct { uns l; type a[len]; }) { .l = len, .a = { val } }).a - // creates a static instance of a dynamic array +#define DARY_LEN(a) GARY_SIZE(a) /** Length of an dynamic array. An alias for `GARY_SIZE`. **/ /*** * [[alloc]] @@ -480,8 +519,17 @@ void cf_journal_rollback_transaction(uns new_pool, struct cf_journal_item *oldj) * If @allow_unknown is set to 0 and a variable not described in @sec * is found in the configuration file, it produces an error. * If you set it to 1, all such variables are ignored. + * + * Please note that a single section definition cannot be used in multiple + * configuration contexts simultaneously. **/ void cf_declare_section(const char *name, struct cf_section *sec, uns allow_unknown); +/** + * Like @cf_declare_section(), but instead of item pointers, the section + * contains offsets relative to @ptr. In other words, it does the same + * as `CF_SECTION`, but for top-level sections. + **/ +void cf_declare_rel_section(const char *name, struct cf_section *sec, void *ptr, uns allow_unknown); /** * If you have a section in a structure and you want to initialize it * (eg. if you want a copy of default values outside the configuration),