conf2: implemented a command-line parser and sections supporting unknown items

[libucw.git] / lib / conf2.h

diff --git a/lib/conf2.h b/lib/conf2.h
index 7244af10bebe1ca409f3a2543ff84527ea65bdc4..0f49ec9ca321990841ad2ea0f1f822cbbde30235 100644 (file)
--- a/lib/conf2.h
+++ b/lib/conf2.h
@@ -106,21 +106,21 @@ 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, ...);
+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);
+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;
-byte *cf_reload(byte *file);
-byte *cf_load(byte *file);
-byte *cf_set(byte *string);
+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);
@@ -128,4 +128,30 @@ 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