X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;f=lib%2Fconf2.h;h=0f49ec9ca321990841ad2ea0f1f822cbbde30235;hb=1ab52b1a51cb828a5868bfcca555d6752136fb52;hp=9f5de68d7355624d1c4208fdada273164bbb3e64;hpb=a9e97e1e2f38dd2e9cdff4a196f96371580a9243;p=libucw.git diff --git a/lib/conf2.h b/lib/conf2.h index 9f5de68d..0f49ec9c 100644 --- a/lib/conf2.h +++ b/lib/conf2.h @@ -1,76 +1,157 @@ /* * UCW Library -- Reading of configuration files * - * (c) 2006 Robert Spalek + * (c) 2001--2006 Robert Spalek + * (c) 2003--2006 Martin Mares * * This software may be freely distributed and used according to the terms * of the GNU Lesser General Public License. */ -#ifndef _LIB_CONF2_H -#define _LIB_CONF2_H +#ifndef _UCW_CONF2_H +#define _UCW_CONF2_H + +enum cf_class { + CC_END, // end of list + CC_STATIC, // single variable or static array + CC_DYNAMIC, // dynamically allocated array + CC_PARSER, // arbitrary parser function + CC_SECTION, // section appears exactly once + CC_LIST // list with 0..many nodes +}; enum cf_type { - CT_END, // end of list CT_INT, CT_U64, CT_DOUBLE, // number types - CT_STRING, // string type - CT_PARSER, // arbitrary parser function - CT_SUB_SECTION, // sub-section appears exactly once - CT_LINK_LIST // link-list with 0..many nodes + CT_IP, // IP address + CT_STRING // string type }; -struct cf_section; +typedef byte *cf_parser(uns number, byte **pars, void *ptr); + /* A parser function gets an array of (strdup'ed) strings and a pointer with + * the customized information (most likely the target address). It can store + * the parsed value anywhere in any way it likes, however it must first call + * cf_journal_block() on the overwritten memory block. It returns an error + * message or NULL if everything is all right. */ typedef byte *cf_hook(void *ptr); - /* An init- or commit-hook gets a pointer to the sub-section or NULL if this + /* An init- or commit-hook gets a pointer to the section or NULL if this * is the global section. It returns an error message or NULL if everything - * is all right. */ -typedef byte *cf_parser(byte *name, uns number, byte **pars, void *ptr); - /* A parser function gets a name of the attribute and an array of strings, - * and stores the parsed value in any way it likes into *ptr. It returns an - * error message or NULL if everything is all right. */ + * is all right. The init-hook should fill in default values (needed for + * dynamically allocated nodes of link lists or for filling global variables + * that are run-time dependent). The commit-hook should perform sanity + * checks and postprocess the parsed values. Commit-hooks must call + * cf_journal_block() too. */ +struct cf_section; struct cf_item { - enum cf_type type; + enum cf_class cls; byte *name; - int number; // number of values: k>=0 means exactly k, k<0 means at most -k - void *ptr; // pointer to a global variable or an offset in a sub-section + int number; // length of an array or #parameters of a parser (negative means at most) + void *ptr; // pointer to a global variable or an offset in a section union { - struct cf_section *sub; // declaration of a sub-section or a link-list + enum cf_type type; // type of a static or dynamic attribute + struct cf_section *sec; // declaration of a section or a list cf_parser *par; // parser function - } ptr2; + } u; }; struct cf_section { - uns size; // 0 for a global block, sizeof(struct) for a sub-section - cf_hook *init; // fills in default values - cf_hook *commit; // verifies parsed data and checks ranges (optional) - struct cf_item *cfg; // CT_END-terminated array of items + uns size; // 0 for a global block, sizeof(struct) for a section + cf_hook *init; // fills in default values (otherwise 0's are used) + cf_hook *commit; // verifies parsed data (optional) + struct cf_item *cfg; // CC_END-terminated array of items + uns flags; // for internal use only }; -#define CHECK_VAR_TYPE(x,type) ((x)-(type)(x) + (type)(x)) - // for a pointer x it returns x, and performs a compile-time check whether typeof(x)==type -#define ARRAY_ALLOC(type,len,val...) (type[]) { (type)len, ##val } + 1 - // creates an array with an allocated space in the front for the (Pascal-like) length -#define ARRAY_LEN(a) *(uns*)(a-1) - // length of the array -#define CF_FIELD(str,f) &((str*)0)->f - // returns a pointer to a field inside a structure suitable for passing as cf_item->ptr - -#define CF_END { .type = CT_END } - // please better put this at the end of each section -#define CF_INT(n,p) { .type = CT_INT, .name = n, .number = 1, .ptr = CHECK_VAR_TYPE(p,int*) } -#define CF_U64(n,p) { .type = CT_U64, .name = n, .number = 1, .ptr = CHECK_VAR_TYPE(p,u64*) } -#define CF_DOUBLE(n,p) { .type = CT_DOUBLE, .name = n, .number = 1, .ptr = CHECK_VAR_TYPE(p,double*) } -#define CF_STRING(n,p) { .type = CT_STRING, .name = n, .number = 1, .ptr = CHECK_VAR_TYPE(p,byte**) } - // use the macros above to declare configuration items for single variables -#define CF_INT_AR(n,p,c) { .type = CT_INT, .name = n, .number = c, .ptr = CHECK_VAR_TYPE(p,int**) } -#define CF_U64_AR(n,p,c) { .type = CT_U64, .name = n, .number = c, .ptr = CHECK_VAR_TYPE(p,u64**) } -#define CF_DOUBLE_AR(n,p,c) { .type = CT_DOUBLE, .name = n, .number = c, .ptr = CHECK_VAR_TYPE(p,double**) } -#define CF_STRING_AR(n,p,c) { .type = CT_STRING, .name = n, .number = c, .ptr = CHECK_VAR_TYPE(p,byte***) } - // use the macros above to declare configuration items for arrays of variables +/* Declaration of cf_section */ +#define CF_TYPE(s) .size = sizeof(s) +#define CF_INIT(f) .init = (cf_hook*) f +#define CF_COMMIT(f) .commit = (cf_hook*) f +#define CF_ITEMS .cfg = ( struct cf_item[] ) +#define CF_END { .cls = CC_END } +/* Configuration items */ struct clist; -#define CF_PARSER(n,p,f,c) { .type = CT_PARSER, .name = n, .number = c, .ptr = p, .ptr2.par = f } -#define CF_SUB_SECTION(n,p,s) { .type = CT_SUB_SECTION, .name = n, .number = 1, .ptr = p, .ptr2.sub = s } -#define CF_LINK_LIST(n,p,s) { .type = CT_LINK_LIST, .name = n, .number = 1, .ptr = CHECK_VAR_TYPE(p,struct clist*), .ptr2.sub = s } +#define CF_STATIC(n,p,T,t,c) { .cls = CC_STATIC, .name = n, .number = c, .ptr = CHECK_PTR_TYPE(p,t*), .u.type = CT_##T } +#define CF_DYNAMIC(n,p,T,t,c) { .cls = CC_DYNAMIC, .name = n, .number = c, .ptr = CHECK_PTR_TYPE(p,t**), .u.type = CT_##T } +#define CF_PARSER(n,p,f,c) { .cls = CC_PARSER, .name = n, .number = c, .ptr = p, .u.par = (cf_parser*) f } +#define CF_SECTION(n,p,s) { .cls = CC_SECTION, .name = n, .number = 1, .ptr = p, .u.sec = s } +#define CF_LIST(n,p,s) { .cls = CC_LIST, .name = n, .number = 1, .ptr = CHECK_PTR_TYPE(p,struct clist*), .u.sec = s } +/* Configuration items for basic types */ +#define CF_INT(n,p) CF_STATIC(n,p,INT,int,1) +#define CF_INT_ARY(n,p,c) CF_STATIC(n,p,INT,int,c) +#define CF_INT_DYN(n,p,c) CF_DYNAMIC(n,p,INT,int,c) +#define CF_UNS(n,p) CF_STATIC(n,p,INT,uns,1) +#define CF_UNS_ARY(n,p,c) CF_STATIC(n,p,INT,uns,c) +#define CF_UNS_DYN(n,p,c) CF_DYNAMIC(n,p,INT,uns,c) +#define CF_U64(n,p) CF_STATIC(n,p,U64,u64,1) +#define CF_U64_ARY(n,p,c) CF_STATIC(n,p,U64,u64,c) +#define CF_U64_DYN(n,p,c) CF_DYNAMIC(n,p,U64,u64,c) +#define CF_DOUBLE(n,p) CF_STATIC(n,p,DOUBLE,double,1) +#define CF_DOUBLE_ARY(n,p,c) CF_STATIC(n,p,DOUBLE,double,c) +#define CF_DOUBLE_DYN(n,p,c) CF_DYNAMIC(n,p,DOUBLE,double,c) +#define CF_IP(n,p) CF_STATIC(n,p,IP,u32,1) +#define CF_IP_ARY(n,p,c) CF_STATIC(n,p,IP,u32,c) +#define CF_IP_DYN(n,p,c) CF_DYNAMIC(n,p,IP,u32,c) +#define CF_STRING(n,p) CF_STATIC(n,p,STRING,byte*,1) +#define CF_STRING_ARY(n,p,c) CF_STATIC(n,p,STRING,byte*,c) +#define CF_STRING_DYN(n,p,c) CF_DYNAMIC(n,p,STRING,byte*,c) + +#define DYN_LEN(a) *(uns*)(a-1) + // length of a dynamic array +#define DYN_ALLOC(type,len,val...) (type[]) { (type)len, ##val } + 1 + // creates a static instance of a dynamic array + +/* Memory allocation */ +struct mempool; +extern struct mempool *cf_pool; +void *cf_malloc(uns size); +void *cf_malloc_zero(uns size); +byte *cf_strdup(byte *s); +byte *cf_printf(char *fmt, ...) FORMAT_CHECK(printf,1,2); + +/* Undo journal for error recovery */ +extern uns cf_need_journal; +void cf_journal_block(void *ptr, uns len); + +/* Declaration */ +void cf_declare_section(byte *name, struct cf_section *sec, uns allow_unknown); +void cf_init_section(byte *name, struct cf_section *sec, void *ptr); + +/* Safe reloading and loading of configuration files */ +extern byte *cf_def_file; +int cf_reload(byte *file); +int cf_load(byte *file); +int cf_set(byte *string); + +/* Parsers for basic types */ +byte *cf_parse_int(byte *str, int *ptr); +byte *cf_parse_u64(byte *str, u64 *ptr); +byte *cf_parse_double(byte *str, double *ptr); +byte *cf_parse_ip(byte *p, u32 *varp); + +/* + * When using cf_get_opt(), you must prefix your own short/long options by the + * CF_(SHORT|LONG)_OPTS. + * + * cf_def_file contains the name of a configuration file that will be + * automatically loaded before the first --set option is executed. If no --set + * option occurs, it will be loaded after getopt() returns -1 (i.e. at the end + * of the configuration options). cf_def_file will be ignored if another + * configuration file has already been loaded using the --config option. The + * initial value of cf_def_file is DEFAULT_CONFIG from config.h, but you can + * override it manually before calling cf_get_opt(). + */ + +#define CF_SHORT_OPTS "S:C:" +#define CF_LONG_OPTS {"set", 1, 0, 'S'}, {"config", 1, 0, 'C'}, +#define CF_NO_LONG_OPTS (const struct option []) { CF_LONG_OPTS { NULL, 0, 0, 0 } } +#ifndef CF_USAGE_TAB +#define CF_USAGE_TAB "" +#endif +#define CF_USAGE \ +"-S, --set sec.item=val\t" CF_USAGE_TAB "Manual setting of a configuration item\n\ +-C, --config filename\t" CF_USAGE_TAB "Overwrite default configuration file\n" + +struct option; +int cf_get_opt(int argc, char * const argv[], const char *short_opts, const struct option *long_opts, int *long_index); #endif