Forgot to commit this one during the "search by age" changes.

[libucw.git] / lib / conf.h

diff --git a/lib/conf.h b/lib/conf.h
index d2a56af5b30b877bf1eede49fa683bcc7fb74254..b58224d34bb97ba4afe5d8afa5af6763014d3191 100644 (file)
--- a/lib/conf.h
+++ b/lib/conf.h
@@ -4,19 +4,32 @@
  *     (c) 2001 Robert Spalek <robert@ucw.cz>
  */
 
+#ifndef        _LIB_CONF_H
+#define        _LIB_CONF_H
+
 #include <getopt.h>
 
+/*
+ * Allocation in configuration memory pool.
+ */
+
+void *cfg_malloc(uns size);
+byte *cfg_stralloc(byte *s);
+
 /*
  * 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_INT, CT_STRING, CT_FUNCTION };
+enum cftype { CT_STOP, CT_SECTION, CT_INCOMPLETE_SECTION, CT_INT, CT_STRING, CT_FUNCTION };
 
 struct cfitem {
        byte *name;
@@ -32,12 +45,21 @@ 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);
 
 /*
  * 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:"
@@ -45,8 +67,14 @@ void cf_read(byte *filename);
        {"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        \
+"-S, --set sec.item=val\tManual setting of a configuration item\n\
+-C, --config filename\tOverwrite default config filename\n"
+
+extern byte *cfdeffile;
 
 int cf_getopt(int argc,char * const argv[],
                const char *shortopts,const struct option *longopts,
                int *longindex);
 
+#endif