X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Finclude%2Fgnunet_configuration_lib.h;h=84c20bde02854fa12115aee6e111e3d88aba2a76;hb=f23239f779a412049d064ad38e307b7a083baa10;hp=fefc6884a3e01bdde38a1e056bf4450ef475fef5;hpb=0a217a8df1657b4334b55b0e4a6c7837a8dbcfd9;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_configuration_lib.h b/src/include/gnunet_configuration_lib.h index fefc6884a..84c20bde0 100644 --- a/src/include/gnunet_configuration_lib.h +++ b/src/include/gnunet_configuration_lib.h @@ -38,6 +38,7 @@ extern "C" #endif #include "gnunet_common.h" +#include "gnunet_time_lib.h" /** * A configuration object. @@ -46,72 +47,151 @@ struct GNUNET_CONFIGURATION_Handle; /** * Create a new configuration object. - * - * @param component name of responsible component + * @return fresh configuration object */ struct GNUNET_CONFIGURATION_Handle *GNUNET_CONFIGURATION_create (void); + +/** + * Duplicate an existing configuration object. + * + * @param c configuration to duplicate + * @return duplicate configuration + */ +struct GNUNET_CONFIGURATION_Handle * +GNUNET_CONFIGURATION_dup (const struct GNUNET_CONFIGURATION_Handle *c); + + /** * Destroy configuration object. + * + * @param cfg configuration to destroy */ void GNUNET_CONFIGURATION_destroy (struct GNUNET_CONFIGURATION_Handle *cfg); + /** * Load configuration. This function will first parse the * defaults and then parse the specific configuration file * to overwrite the defaults. * + * @param cfg configuration to update * @param filename name of the configuration file * @return GNUNET_OK on success, GNUNET_SYSERR on error */ int GNUNET_CONFIGURATION_load (struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename); + /** * Parse a configuration file, add all of the options in the * file to the configuration environment. + * + * @param cfg configuration to update + * @param filename name of the configuration file * @return GNUNET_OK on success, GNUNET_SYSERR on error */ int GNUNET_CONFIGURATION_parse (struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename); + /** * Write configuration file. + * + * @param cfg configuration to write + * @param filename where to write the configuration * @return GNUNET_OK on success, GNUNET_SYSERR on error */ int GNUNET_CONFIGURATION_write (struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename); + /** * Test if there are configuration options that were * changed since the last save. + * + * @param cfg configuration to inspect * @return GNUNET_NO if clean, GNUNET_YES if dirty, GNUNET_SYSERR on error (i.e. last save failed) */ -int GNUNET_CONFIGURATION_is_dirty (struct GNUNET_CONFIGURATION_Handle *cfg); +int GNUNET_CONFIGURATION_is_dirty (const struct GNUNET_CONFIGURATION_Handle *cfg); + + +/** + * Function to iterate over options. + * + * @param cls closure + * @param section name of the section + * @param option name of the option + * @param value value of the option + */ +typedef void (*GNUNET_CONFIGURATION_Iterator)(void *cls, + const char *section, + const char *option, + const char *value); + + +/** + * Iterate over all options in the configuration. + * + * @param cfg configuration to inspect + * @param iter function to call on each option + * @param iter_cls closure for iter + */ +void GNUNET_CONFIGURATION_iterate (const struct GNUNET_CONFIGURATION_Handle *cfg, + GNUNET_CONFIGURATION_Iterator iter, + void *iter_cls); + /** * Get a configuration value that should be a number. + * + * @param cfg configuration to inspect + * @param section section of interest + * @param option option of interest + * @param number where to store the numeric value of the option * @return GNUNET_OK on success, GNUNET_SYSERR on error */ -int GNUNET_CONFIGURATION_get_value_number (struct GNUNET_CONFIGURATION_Handle +int GNUNET_CONFIGURATION_get_value_number (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, unsigned long long *number); +/** + * Get a configuration value that should be a relative time. + * + * @param cfg configuration to inspect + * @param section section of interest + * @param option option of interest + * @param time set to the time value stored in the configuration + * @return GNUNET_OK on success, GNUNET_SYSERR on error + */ +int GNUNET_CONFIGURATION_get_value_time (const struct GNUNET_CONFIGURATION_Handle + *cfg, const char *section, + const char *option, + struct GNUNET_TIME_Relative *time); + /** * Test if we have a value for a particular option + * + * @param cfg configuration to inspect + * @param section section of interest + * @param option option of interest * @return GNUNET_YES if so, GNUNET_NO if not. */ -int GNUNET_CONFIGURATION_have_value (struct GNUNET_CONFIGURATION_Handle *cfg, +int GNUNET_CONFIGURATION_have_value (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option); /** * Get a configuration value that should be a string. + * + * @param cfg configuration to inspect + * @param section section of interest + * @param option option of interest * @param value will be set to a freshly allocated configuration * value, or NULL if option is not specified * @return GNUNET_OK on success, GNUNET_SYSERR on error */ -int GNUNET_CONFIGURATION_get_value_string (struct GNUNET_CONFIGURATION_Handle +int GNUNET_CONFIGURATION_get_value_string (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, char **value); @@ -119,11 +199,14 @@ int GNUNET_CONFIGURATION_get_value_string (struct GNUNET_CONFIGURATION_Handle * Get a configuration value that should be the name of a file * or directory. * + * @param cfg configuration to inspect + * @param section section of interest + * @param option option of interest * @param value will be set to a freshly allocated configuration * value, or NULL if option is not specified * @return GNUNET_OK on success, GNUNET_SYSERR on error */ -int GNUNET_CONFIGURATION_get_value_filename (struct +int GNUNET_CONFIGURATION_get_value_filename (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, @@ -132,26 +215,34 @@ int GNUNET_CONFIGURATION_get_value_filename (struct /** * Iterate over the set of filenames stored in a configuration value. * + * @param cfg configuration to inspect + * @param section section of interest + * @param option option of interest + * @param cb function to call on each filename + * @param cb_cls closure for cb * @return number of filenames iterated over, -1 on error */ -int GNUNET_CONFIGURATION_iterate_value_filenames (struct +int GNUNET_CONFIGURATION_iterate_value_filenames (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, GNUNET_FileNameCallback - cb, void *cls); + cb, void *cb_cls); /** * Get a configuration value that should be in a set of * predefined strings * + * @param cfg configuration to inspect + * @param section section of interest + * @param option option of interest * @param choices NULL-terminated list of legal values * @param value will be set to an entry in the legal list, * or NULL if option is not specified and no default given * @return GNUNET_OK on success, GNUNET_SYSERR on error */ -int GNUNET_CONFIGURATION_get_value_choice (struct GNUNET_CONFIGURATION_Handle +int GNUNET_CONFIGURATION_get_value_choice (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, const char **choices, @@ -161,9 +252,12 @@ int GNUNET_CONFIGURATION_get_value_choice (struct GNUNET_CONFIGURATION_Handle * Get a configuration value that should be in a set of * "YES" or "NO". * + * @param cfg configuration to inspect + * @param section section of interest + * @param option option of interest * @return GNUNET_YES, GNUNET_NO or if option has no valid value, GNUNET_SYSERR */ -int GNUNET_CONFIGURATION_get_value_yesno (struct GNUNET_CONFIGURATION_Handle +int GNUNET_CONFIGURATION_get_value_yesno (const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option); @@ -171,15 +265,21 @@ int GNUNET_CONFIGURATION_get_value_yesno (struct GNUNET_CONFIGURATION_Handle * Expand an expression of the form "$FOO/BAR" to "DIRECTORY/BAR" * where either in the "PATHS" section or the environtment * "FOO" is set to "DIRECTORY". - + * + * @param cfg configuration to use for path expansion * @param old string to $-expand (will be freed!) * @return $-expanded string */ -char *GNUNET_CONFIGURATION_expand_dollar (struct GNUNET_CONFIGURATION_Handle +char *GNUNET_CONFIGURATION_expand_dollar (const struct GNUNET_CONFIGURATION_Handle *cfg, char *old); /** * Set a configuration value that should be a number. + * + * @param cfg configuration to update + * @param section section of interest + * @param option option of interest + * @param number value to set */ void GNUNET_CONFIGURATION_set_value_number (struct GNUNET_CONFIGURATION_Handle @@ -191,7 +291,11 @@ GNUNET_CONFIGURATION_set_value_number (struct GNUNET_CONFIGURATION_Handle /** * Set a configuration value that should be a string. - * @param value + * + * @param cfg configuration to update + * @param section section of interest + * @param option option of interest + * @param value value to set */ void GNUNET_CONFIGURATION_set_value_string (struct GNUNET_CONFIGURATION_Handle @@ -203,6 +307,9 @@ GNUNET_CONFIGURATION_set_value_string (struct GNUNET_CONFIGURATION_Handle * Remove a filename from a configuration value that * represents a list of filenames * + * @param cfg configuration to update + * @param section section of interest + * @param option option of interest * @param value filename to remove * @return GNUNET_OK on success, * GNUNET_SYSERR if the filename is not in the list @@ -218,6 +325,9 @@ int GNUNET_CONFIGURATION_remove_value_filename (struct * Append a filename to a configuration value that * represents a list of filenames * + * @param cfg configuration to update + * @param section section of interest + * @param option option of interest * @param value filename to append * @return GNUNET_OK on success, * GNUNET_SYSERR if the filename already in the list @@ -228,6 +338,7 @@ int GNUNET_CONFIGURATION_append_value_filename (struct const char *option, const char *value); + #if 0 /* keep Emacsens' auto-indent happy */ { #endif