X-Git-Url: http://mj.ucw.cz/gitweb/?a=blobdiff_plain;f=ucw%2Fgetopt.h;h=5fe66cead34d435eb0d67a2d1044052f51d2e631;hb=0f88062c8973258611a8cba9a0e9668d1c688030;hp=531d2582e2607063df98e3b426fa4886fc37c53b;hpb=031256ad2e123eec58521f8e3eb9496c197641d2;p=libucw.git diff --git a/ucw/getopt.h b/ucw/getopt.h index 531d2582..5fe66cea 100644 --- a/ucw/getopt.h +++ b/ucw/getopt.h @@ -17,63 +17,152 @@ #include #endif -void reset_getopt(void); +void reset_getopt(void); /** If you want to start parsing of the arguments from the first one again. **/ -/* Safe loading and reloading of configuration files: conf-input.c */ +/*** + * [[conf_load]] + * Safe configuration loading + * ~~~~~~~~~~~~~~~~~~~~~~~~~~ + * + * These functions can be used to to safely load or reload configuration. + */ -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); -int cf_load(const char *file); +/** + * The default config (DEFAULT_CONFIG config option) or NULL if already loaded. + * You can set it to something else manually. + */ +extern char *cf_def_file; +/** + * Name of environment variable that can override what configuration + * is loaded. + **/ +extern char *cf_env_file; +int cf_reload(const char *file); /** Reload configuration from @file, replace the old one. **/ +int cf_load(const char *file); /** Load configuration from @file. If @file is NULL, reload all loaded configuration files. **/ +/** + * Parse some part of configuration passed in @string. + * The syntax is the same as in the <>. + **/ int cf_set(const char *string); -/* Direct access to configuration items: conf-intr.c */ - +/*** + * [[conf_direct]] + * Direct access + * ~~~~~~~~~~~~~ + * + * Direct access to configuration items. + * You probably should not need this. + ***/ + +/** + * List of operations used on items. + * This macro is used to generate internal source code, + * but you may be interested in the list of operations it creates. + * + * Each operation corresponds to the same-named operation + * described in <>. + **/ #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) + T(APPEND) T(PREPEND) T(REMOVE) T(EDIT) T(AFTER) T(BEFORE) T(COPY) T(RESET) /* 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 }; +enum cf_operation { CF_OPERATIONS }; /** Allowed operations on items. See <> for list (they have an `OP_` prefix -- it means you use `OP_SET` instead of just `SET`). **/ #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); -char *cf_write_item(struct cf_item *item, enum cf_operation op, int number, char **pars); +/** + * Performs a single operation on a given item. + **/ +char *cf_modify_item(struct cf_item *item, enum cf_operation op, int number, char **pars); -/* Debug dumping: conf-dump.c */ +/*** + * [[conf_dump]] + * Debug dumping + * ~~~~~~~~~~~~~ + ***/ struct fastbuf; +/** + * Take everything and write it into @fb. + **/ void cf_dump_sections(struct fastbuf *fb); -/* Journaling control: conf-journal.c */ - -struct cf_journal_item; +/*** + * [[conf_journal]] + * Journaling control + * ~~~~~~~~~~~~~~~~~~ + * + * The configuration system uses journaling to safely reload + * configuration. It begins a transaction and tries to load the + * configuration. If it fails, it restores the original state. + * + * The behaviour of journal is described in <>. + ***/ + +struct cf_journal_item; /** Opaque identifier of the journal state. **/ +/** + * Starts a new transaction. It returns the current state so you can + * get back to it. The @new_pool parameter tells if a new memory pool + * should be created and used from now. + **/ struct cf_journal_item *cf_journal_new_transaction(uns new_pool); +/** + * Marks current state as a complete transaction. The @new_pool + * parameter tells if the transaction was created with new memory pool + * (the parameter must be the same as the one with + * @cf_journal_new_transaction() was called with). The @oldj parameter + * is the journal state returned from last + * @cf_journal_new_transaction() call. + **/ void cf_journal_commit_transaction(uns new_pool, struct cf_journal_item *oldj); +/** + * Returns to an old journal state, reverting anything the current + * transaction did. The @new_pool parameter must be the same as the + * one you used when you created the transaction. The @oldj parameter + * is the journal state you got from @cf_journal_new_transaction() -- + * it is the state to return to. + **/ void cf_journal_rollback_transaction(uns new_pool, struct cf_journal_item *oldj); -/* - * cf_getopt() takes care of parsing the command-line arguments, loading the - * default configuration file (cf_def_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 CF_(SHORT|LONG)_OPTS or pass CF_NO_LONG_OPTS - * of there are no long options. - * - * The default configuration file can be overriden by the --config options, - * which must come first. During parsing of all other options, the configuration - * is already available. - */ +/*** + * [[conf_getopt]] + * Loading by @cf_getopt() + * ~~~~~~~~~~~~~~~~~~~~~~~ + ***/ +/** + * Short options for loading configuration by @cf_getopt(). + * Prepend to your own options. + **/ #define CF_SHORT_OPTS "C:S:" +/** + * Long options for loading configuration by @cf_getopt(). + * Prepend to your own options. + **/ #define CF_LONG_OPTS {"config", 1, 0, 'C'}, {"set", 1, 0, 'S'}, CF_LONG_OPTS_DEBUG +/** + * Use this constant as @long_opts parameter of @cf_getopt() if you do + * not have any long options in your program. + **/ #define CF_NO_LONG_OPTS (const struct option []) { CF_LONG_OPTS { NULL, 0, 0, 0 } } #ifndef CF_USAGE_TAB #define CF_USAGE_TAB "" #endif +/** + * This macro provides text describing usage of the configuration + * loading options. Concatenate with description of your options and + * write to the user, if he/she provides invalid options. + **/ #define CF_USAGE \ "-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 @@ -86,7 +175,18 @@ void cf_journal_rollback_transaction(uns new_pool, struct cf_journal_item *oldj) #define CF_USAGE_DEBUG #endif -// conf-input.c +/** + * 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 + * pass <> if there are no long 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); #endif