X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;f=ucw%2Fgetopt.h;h=9ea498ce7d6d6b9daab6ae72455d37050cc759d9;hb=959566090f98dd31eaa67d3d5959b641e5fe902b;hp=2c6da5fb8cbb6dee8f4c7fc8406f98b4a958530e;hpb=18fbfbf2ecd1750a3367c88df3120ccd6677c217;p=libucw.git diff --git a/ucw/getopt.h b/ucw/getopt.h index 2c6da5fb..9ea498ce 100644 --- a/ucw/getopt.h +++ b/ucw/getopt.h @@ -2,7 +2,7 @@ * UCW Library -- Parsing of configuration and command-line options * * (c) 2001--2006 Robert Spalek - * (c) 2003--2006 Martin Mares + * (c) 2003--2012 Martin Mares * * This software may be freely distributed and used according to the terms * of the GNU Lesser General Public License. @@ -11,96 +11,35 @@ #ifndef _UCW_GETOPT_H #define _UCW_GETOPT_H -#ifdef CONFIG_OWN_GETOPT -#include "ucw/getopt/getopt-sh.h" +#ifdef CONFIG_UCW_CLEAN_ABI +#define cf_def_file ucw_cf_def_file +#define cf_env_file ucw_cf_env_file +#define cf_getopt ucw_cf_getopt +#define reset_getopt ucw_reset_getopt +#endif + +#ifdef CONFIG_UCW_OWN_GETOPT +#include #else #include #endif -void reset_getopt(void); /** If you want to start parsing of the arguments from the first one again. **/ - /*** - * [[conf_load]] - * Safe configuration loading - * ~~~~~~~~~~~~~~~~~~~~~~~~~~ - * - * These functions can be used to to safely load or reload configuration. - */ + * [[conf_getopt]] + * Loading by @cf_getopt() + * ~~~~~~~~~~~~~~~~~~~~~~~ + ***/ /** - * The default config (DEFAULT_CONFIG config option) or NULL if already loaded. + * The default config (as set by `CONFIG_UCW_DEFAULT_CONFIG`) or NULL if already loaded. * You can set it to something else manually. */ -extern char *cf_def_file; /* DEFAULT_CONFIG; NULL if already loaded */ -extern char *cf_env_file; /* ENV_VAR_CONFIG */ -int cf_reload(const char *file); /** Reload configuration from @file, replace the old one. **/ -int cf_load(const char *file); /** Load configuration from @file. **/ +extern char *cf_def_file; /** - * Parse some part of configuration passed in @string. - * The syntax is the same as in the <>. + * Name of environment variable that can override what configuration is loaded. + * Defaults to `CONFIG_UCW_ENV_VAR_CONFIG`. **/ -int cf_set(const char *string); - -/*** - * [[conf_direct]] - * Direct access - * ~~~~~~~~~~~~~ - * - * Direct access to configuration items. - * You probably should not need this. - ***/ - -#define CF_OPERATIONS T(CLOSE) T(SET) T(CLEAR) T(ALL) \ - T(APPEND) T(PREPEND) T(REMOVE) T(EDIT) T(AFTER) T(BEFORE) T(COPY) - /* Closing brace finishes previous block. - * Basic attributes (static, dynamic, parsed) can be used with SET. - * Dynamic arrays can be used with SET, APPEND, PREPEND. - * Sections can be used with SET. - * Lists can be used with everything. */ -#define T(x) OP_##x, -enum cf_operation { CF_OPERATIONS }; -#undef T - -struct cf_item; -/** - * Searches for a configuration item called @name. - * If it is found, it is copied into @item and NULL is returned. - * Otherwise, an error is returned and @item is zeroed. - **/ -char *cf_find_item(const char *name, struct cf_item *item); -// TODO What does this do? -char *cf_write_item(struct cf_item *item, enum cf_operation op, int number, char **pars); - -/*** - * [[conf_dump]] - * Debug dumping - * ~~~~~~~~~~~~~ - ***/ - -struct fastbuf; -/** - * Take everything and write it into @fb. - **/ -void cf_dump_sections(struct fastbuf *fb); - -/*** - * [[conf_journal]] - * Journaling control - * ~~~~~~~~~~~~~~~~~~ - ***/ - -struct cf_journal_item; -// TODO -struct cf_journal_item *cf_journal_new_transaction(uns new_pool); -void cf_journal_commit_transaction(uns new_pool, struct cf_journal_item *oldj); -void cf_journal_rollback_transaction(uns new_pool, struct cf_journal_item *oldj); - -/*** - * [[conf_getopt]] - * Loading by @cf_getopt() - * ~~~~~~~~~~~~~~~~~~~~~~~ - ***/ - +extern char *cf_env_file; /** * Short options for loading configuration by @cf_getopt(). * Prepend to your own options. @@ -128,7 +67,7 @@ void cf_journal_rollback_transaction(uns new_pool, struct cf_journal_item *oldj) "-C, --config filename\t" CF_USAGE_TAB "Override the default configuration file\n\ -S, --set sec.item=val\t" CF_USAGE_TAB "Manual setting of a configuration item\n" CF_USAGE_DEBUG -#ifdef CONFIG_DEBUG +#ifdef CONFIG_UCW_DEBUG #define CF_LONG_OPTS_DEBUG { "dumpconfig", 0, 0, 0x64436667 } , #define CF_USAGE_DEBUG " --dumpconfig\t" CF_USAGE_TAB "Dump program configuration\n" #else @@ -136,18 +75,20 @@ void cf_journal_rollback_transaction(uns new_pool, struct cf_journal_item *oldj) #define CF_USAGE_DEBUG #endif -/*** +/** * Takes care of parsing the command-line arguments, loading the * default configuration file (<>) and processing * configuration options. The calling convention is the same as with GNU getopt_long(), * but you must prefix your own short/long options by the - * <> or <>or + * <> or <> or * pass <> if there are no long options. * - * The default configuration file can be overwriten by the --config options, + * The default configuration file can be overwritten by the --config options, * which must come first. During parsing of all other options, the configuration * is already available. - ***/ + **/ int cf_getopt(int argc, char * const argv[], const char *short_opts, const struct option *long_opts, int *long_index); +void reset_getopt(void); /** If you want to start parsing of the arguments from the first one again. **/ + #endif