Merge with git+ssh://cvs.ucw.cz/projects/sherlock/GIT/sherlock.git#v3.8

[libucw.git] / lib / conf.h

diff --git a/lib/conf.h b/lib/conf.h
index 015ff0c1b553cd86556c20b6f3bb0b725946cd62..ef727512b2b08f1d97706dd3ad9614f9434d2843 100644 (file)
--- a/lib/conf.h
+++ b/lib/conf.h
@@ -1,9 +1,42 @@
-/* Reading conf files
- * Robert Spalek, (c) 2001, robert@ucw.cz
- * $Id: conf.h,v 1.1 2001/01/07 21:21:53 robert Exp $
+/*
+ *     UCW Library -- Reading of configuration files
+ *
+ *     (c) 2001 Robert Spalek <robert@ucw.cz>
+ *     (c) 2003--2005 Martin Mares <mj@ucw.cz>
+ *
+ *     This software may be freely distributed and used according to the terms
+ *     of the GNU Lesser General Public License.
  */
 
-enum cftype { ct_stop, ct_int, ct_string, ct_function };
+#ifndef        _LIB_CONF_H
+#define        _LIB_CONF_H
+
+#include <getopt.h>
+
+/*
+ * Allocation in configuration memory pool.
+ */
+
+extern struct mempool *cfpool;
+void *cfg_malloc(uns size);
+void *cfg_malloc_zero(uns size);
+byte *cfg_strdup(byte *s);
+byte *cfg_printf(char *fmt, ...) FORMAT_CHECK(printf,1,2);
+
+/*
+ * Every module places its configuration setting into some section.  Section is
+ * an array of cfitem, whose first record is of type CT_SECTION and contains
+ * the name of the section.  The configuration sections are registered by
+ * calling cf_register().
+ *
+ * CT_INCOMPLETE_SECTION is identical to CT_SECTION, but when an unknown variable
+ * is spotted, we ignore it instead of bailing out with an error message.
+ *
+ * item->var is a pointer to the destination variable or to the special parsing
+ * function.
+ */
+
+enum cftype { CT_STOP, CT_SECTION, CT_INCOMPLETE_SECTION, CT_INT, CT_STRING, CT_FUNCTION, CT_DOUBLE, CT_U64 };
 
 struct cfitem {
        byte *name;
@@ -13,10 +46,51 @@ struct cfitem {
 
 typedef byte *(*ci_func)(struct cfitem *, byte *);
 
-void cf_register(byte *section,struct cfitem *items);
-void cf_register_opts(byte *so,struct option *lo);
+void cf_register(struct cfitem *items);
+
+/*
+ * Direct setting of configuration items and parsing the configuration file.
+ */
+
+int cf_item_count(void);
+struct cfitem *cf_get_item(byte *sect, byte *name);
+byte *cf_set_item(byte *sect, byte *name, byte *value);
+void cf_read(byte *filename);
+
+/*
+ * Number parsing functions which could be useful in CT_FUNCTION callbacks.
+ */
+
+byte *cf_parse_int(byte *value, uns *varp);
+byte *cf_parse_u64(byte *value, u64 *varp);
+byte *cf_parse_double(byte *value, double *varp);
+
+/*
+ * When using cf_getopt, you must prefix your own short/long options by the
+ * CF_(SHORT|LONG)_OPTS.
+ *
+ * cfdeffile contains filename of config file automatically loaded before a
+ * first --set option is executed.  If none --set option occures, it will be
+ * loaded after getopt returns -1 (at the end of configuration options).  It
+ * will be ignored, if another config file is set by --config option at first.
+ * Its initial value is DEFAULT_CONFIG from config.h, but you can override it
+ * manually.
+ */
+
+#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 } }
+#define CF_USAGE_TAB ""
+#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 config filename\n"
+
+extern byte *cfdeffile;
 
-int cf_read(byte *filename);
-void cf_read_err(byte *filename);
-int cf_getopt(int argc,char * const argv[], int *longindex);
+int cf_getopt(int argc,char * const argv[],
+               const char *shortopts,const struct option *longopts,
+               int *longindex);
 
+#endif