2 This file is part of GNUnet.
3 (C) 2006, 2008, 2009 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 2, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file include/gnunet_configuration_lib.h
23 * @brief configuration API
25 * @author Christian Grothoff
28 #ifndef GNUNET_CONFIGURATION_LIB_H
29 #define GNUNET_CONFIGURATION_LIB_H
35 #if 0 /* keep Emacsens' auto-indent happy */
40 #include "gnunet_common.h"
41 #include "gnunet_time_lib.h"
44 * A configuration object.
46 struct GNUNET_CONFIGURATION_Handle;
49 * Create a new configuration object.
50 * @return fresh configuration object
52 struct GNUNET_CONFIGURATION_Handle *GNUNET_CONFIGURATION_create (void);
56 * Duplicate an existing configuration object.
58 * @param cfg configuration to duplicate
59 * @return duplicate configuration
61 struct GNUNET_CONFIGURATION_Handle *
62 GNUNET_CONFIGURATION_dup (const struct GNUNET_CONFIGURATION_Handle *cfg);
66 * Destroy configuration object.
68 * @param cfg configuration to destroy
70 void GNUNET_CONFIGURATION_destroy (struct GNUNET_CONFIGURATION_Handle *cfg);
74 * Load configuration. This function will first parse the
75 * defaults and then parse the specific configuration file
76 * to overwrite the defaults.
78 * @param cfg configuration to update
79 * @param filename name of the configuration file, NULL to load defaults
80 * @return GNUNET_OK on success, GNUNET_SYSERR on error
82 int GNUNET_CONFIGURATION_load (struct GNUNET_CONFIGURATION_Handle *cfg,
83 const char *filename);
87 * Parse a configuration file, add all of the options in the
88 * file to the configuration environment.
90 * @param cfg configuration to update
91 * @param filename name of the configuration file
92 * @return GNUNET_OK on success, GNUNET_SYSERR on error
94 int GNUNET_CONFIGURATION_parse (struct GNUNET_CONFIGURATION_Handle *cfg,
95 const char *filename);
99 * Write configuration file.
101 * @param cfg configuration to write
102 * @param filename where to write the configuration
103 * @return GNUNET_OK on success, GNUNET_SYSERR on error
105 int GNUNET_CONFIGURATION_write (struct GNUNET_CONFIGURATION_Handle *cfg,
106 const char *filename);
109 * Write only configuration entries that have been changed to configuration file
110 * @param cfgDefault default configuration
111 * @param cfgNew new configuration
112 * @param filename where to write the configuration diff between default and new
113 * @return GNUNET_OK on success, GNUNET_SYSERR on error
116 GNUNET_CONFIGURATION_write_diffs(const struct GNUNET_CONFIGURATION_Handle *cfgDefault,
117 const struct GNUNET_CONFIGURATION_Handle *cfgNew,
118 const char* filename);
121 * Test if there are configuration options that were
122 * changed since the last save.
124 * @param cfg configuration to inspect
125 * @return GNUNET_NO if clean, GNUNET_YES if dirty, GNUNET_SYSERR on error (i.e. last save failed)
127 int GNUNET_CONFIGURATION_is_dirty (const struct GNUNET_CONFIGURATION_Handle *cfg);
131 * Function to iterate over options.
134 * @param section name of the section
135 * @param option name of the option
136 * @param value value of the option
138 typedef void (*GNUNET_CONFIGURATION_Iterator)(void *cls,
145 * Function to iterate over section.
148 * @param section name of the section
150 typedef void (*GNUNET_CONFIGURATION_Section_Iterator)(void *cls,
151 const char *section);
155 * Iterate over all options in the configuration.
157 * @param cfg configuration to inspect
158 * @param iter function to call on each option
159 * @param iter_cls closure for iter
161 void GNUNET_CONFIGURATION_iterate (const struct GNUNET_CONFIGURATION_Handle *cfg,
162 GNUNET_CONFIGURATION_Iterator iter,
167 * Iterate over all sections in the configuration.
169 * @param cfg configuration to inspect
170 * @param iter function to call on each section
171 * @param iter_cls closure for iter
173 void GNUNET_CONFIGURATION_iterate_sections (const struct GNUNET_CONFIGURATION_Handle *cfg,
174 GNUNET_CONFIGURATION_Section_Iterator iter,
178 * Get a configuration value that should be a number.
180 * @param cfg configuration to inspect
181 * @param section section of interest
182 * @param option option of interest
183 * @param number where to store the numeric value of the option
184 * @return GNUNET_OK on success, GNUNET_SYSERR on error
186 int GNUNET_CONFIGURATION_get_value_number (const struct GNUNET_CONFIGURATION_Handle
187 *cfg, const char *section,
189 unsigned long long *number);
193 * Get a configuration value that should be a relative time.
195 * @param cfg configuration to inspect
196 * @param section section of interest
197 * @param option option of interest
198 * @param time set to the time value stored in the configuration
199 * @return GNUNET_OK on success, GNUNET_SYSERR on error
201 int GNUNET_CONFIGURATION_get_value_time (const struct GNUNET_CONFIGURATION_Handle
202 *cfg, const char *section,
204 struct GNUNET_TIME_Relative *time);
208 * Test if we have a value for a particular option
210 * @param cfg configuration to inspect
211 * @param section section of interest
212 * @param option option of interest
213 * @return GNUNET_YES if so, GNUNET_NO if not.
215 int GNUNET_CONFIGURATION_have_value (const struct GNUNET_CONFIGURATION_Handle *cfg,
216 const char *section, const char *option);
220 * Get a configuration value that should be a string.
222 * @param cfg configuration to inspect
223 * @param section section of interest
224 * @param option option of interest
225 * @param value will be set to a freshly allocated configuration
226 * value, or NULL if option is not specified
227 * @return GNUNET_OK on success, GNUNET_SYSERR on error
229 int GNUNET_CONFIGURATION_get_value_string (const struct GNUNET_CONFIGURATION_Handle
230 *cfg, const char *section,
231 const char *option, char **value);
235 * Get a configuration value that should be the name of a file
238 * @param cfg configuration to inspect
239 * @param section section of interest
240 * @param option option of interest
241 * @param value will be set to a freshly allocated configuration
242 * value, or NULL if option is not specified
243 * @return GNUNET_OK on success, GNUNET_SYSERR on error
245 int GNUNET_CONFIGURATION_get_value_filename (const struct
246 GNUNET_CONFIGURATION_Handle *cfg,
252 * Iterate over the set of filenames stored in a configuration value.
254 * @param cfg configuration to inspect
255 * @param section section of interest
256 * @param option option of interest
257 * @param cb function to call on each filename
258 * @param cb_cls closure for cb
259 * @return number of filenames iterated over, -1 on error
261 int GNUNET_CONFIGURATION_iterate_value_filenames (const struct
262 GNUNET_CONFIGURATION_Handle
266 GNUNET_FileNameCallback
270 * Get a configuration value that should be in a set of
273 * @param cfg configuration to inspect
274 * @param section section of interest
275 * @param option option of interest
276 * @param choices NULL-terminated list of legal values
277 * @param value will be set to an entry in the legal list,
278 * or NULL if option is not specified and no default given
279 * @return GNUNET_OK on success, GNUNET_SYSERR on error
281 int GNUNET_CONFIGURATION_get_value_choice (const struct GNUNET_CONFIGURATION_Handle
282 *cfg, const char *section,
284 const char **choices,
288 * Get a configuration value that should be in a set of
291 * @param cfg configuration to inspect
292 * @param section section of interest
293 * @param option option of interest
294 * @return GNUNET_YES, GNUNET_NO or if option has no valid value, GNUNET_SYSERR
296 int GNUNET_CONFIGURATION_get_value_yesno (const struct GNUNET_CONFIGURATION_Handle
297 *cfg, const char *section,
301 * Expand an expression of the form "$FOO/BAR" to "DIRECTORY/BAR"
302 * where either in the "PATHS" section or the environtment
303 * "FOO" is set to "DIRECTORY".
305 * @param cfg configuration to use for path expansion
306 * @param orig string to $-expand (will be freed!)
307 * @return $-expanded string
309 char *GNUNET_CONFIGURATION_expand_dollar (const struct GNUNET_CONFIGURATION_Handle
314 * Set a configuration value that should be a number.
316 * @param cfg configuration to update
317 * @param section section of interest
318 * @param option option of interest
319 * @param number value to set
322 GNUNET_CONFIGURATION_set_value_number (struct GNUNET_CONFIGURATION_Handle
326 unsigned long long number);
330 * Set a configuration value that should be a string.
332 * @param cfg configuration to update
333 * @param section section of interest
334 * @param option option of interest
335 * @param value value to set
338 GNUNET_CONFIGURATION_set_value_string (struct GNUNET_CONFIGURATION_Handle
341 const char *option, const char *value);
344 * Remove a filename from a configuration value that
345 * represents a list of filenames
347 * @param cfg configuration to update
348 * @param section section of interest
349 * @param option option of interest
350 * @param value filename to remove
351 * @return GNUNET_OK on success,
352 * GNUNET_SYSERR if the filename is not in the list
354 int GNUNET_CONFIGURATION_remove_value_filename (struct
355 GNUNET_CONFIGURATION_Handle
362 * Append a filename to a configuration value that
363 * represents a list of filenames
365 * @param cfg configuration to update
366 * @param section section of interest
367 * @param option option of interest
368 * @param value filename to append
369 * @return GNUNET_OK on success,
370 * GNUNET_SYSERR if the filename already in the list
372 int GNUNET_CONFIGURATION_append_value_filename (struct
373 GNUNET_CONFIGURATION_Handle
374 *cfg, const char *section,
379 #if 0 /* keep Emacsens' auto-indent happy */