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,
179 * Remove the given section and all options in it.
181 * @param cfg configuration to inspect
182 * @param section name of the section to remove
184 void GNUNET_CONFIGURATION_remove_section (struct GNUNET_CONFIGURATION_Handle *cfg,
185 const char *section);
188 * Get a configuration value that should be a number.
190 * @param cfg configuration to inspect
191 * @param section section of interest
192 * @param option option of interest
193 * @param number where to store the numeric value of the option
194 * @return GNUNET_OK on success, GNUNET_SYSERR on error
196 int GNUNET_CONFIGURATION_get_value_number (const struct GNUNET_CONFIGURATION_Handle
197 *cfg, const char *section,
199 unsigned long long *number);
203 * Get a configuration value that should be a relative time.
205 * @param cfg configuration to inspect
206 * @param section section of interest
207 * @param option option of interest
208 * @param time set to the time value stored in the configuration
209 * @return GNUNET_OK on success, GNUNET_SYSERR on error
211 int GNUNET_CONFIGURATION_get_value_time (const struct GNUNET_CONFIGURATION_Handle
212 *cfg, const char *section,
214 struct GNUNET_TIME_Relative *time);
218 * Test if we have a value for a particular option
220 * @param cfg configuration to inspect
221 * @param section section of interest
222 * @param option option of interest
223 * @return GNUNET_YES if so, GNUNET_NO if not.
225 int GNUNET_CONFIGURATION_have_value (const struct GNUNET_CONFIGURATION_Handle *cfg,
226 const char *section, const char *option);
230 * Get a configuration value that should be a string.
232 * @param cfg configuration to inspect
233 * @param section section of interest
234 * @param option option of interest
235 * @param value will be set to a freshly allocated configuration
236 * value, or NULL if option is not specified
237 * @return GNUNET_OK on success, GNUNET_SYSERR on error
239 int GNUNET_CONFIGURATION_get_value_string (const struct GNUNET_CONFIGURATION_Handle
240 *cfg, const char *section,
241 const char *option, char **value);
245 * Get a configuration value that should be the name of a file
248 * @param cfg configuration to inspect
249 * @param section section of interest
250 * @param option option of interest
251 * @param value will be set to a freshly allocated configuration
252 * value, or NULL if option is not specified
253 * @return GNUNET_OK on success, GNUNET_SYSERR on error
255 int GNUNET_CONFIGURATION_get_value_filename (const struct
256 GNUNET_CONFIGURATION_Handle *cfg,
262 * Iterate over the set of filenames stored in a configuration value.
264 * @param cfg configuration to inspect
265 * @param section section of interest
266 * @param option option of interest
267 * @param cb function to call on each filename
268 * @param cb_cls closure for cb
269 * @return number of filenames iterated over, -1 on error
271 int GNUNET_CONFIGURATION_iterate_value_filenames (const struct
272 GNUNET_CONFIGURATION_Handle
276 GNUNET_FileNameCallback
280 * Iterate over values of a section in the configuration.
282 * @param cfg configuration to inspect
283 * @param section the section
284 * @param iter function to call on each option
285 * @param iter_cls closure for iter
288 GNUNET_CONFIGURATION_iterate_section_values (const struct GNUNET_CONFIGURATION_Handle *cfg,
290 GNUNET_CONFIGURATION_Iterator iter,
294 * Get a configuration value that should be in a set of
297 * @param cfg configuration to inspect
298 * @param section section of interest
299 * @param option option of interest
300 * @param choices NULL-terminated list of legal values
301 * @param value will be set to an entry in the legal list,
302 * or NULL if option is not specified and no default given
303 * @return GNUNET_OK on success, GNUNET_SYSERR on error
305 int GNUNET_CONFIGURATION_get_value_choice (const struct GNUNET_CONFIGURATION_Handle
306 *cfg, const char *section,
308 const char **choices,
312 * Get a configuration value that should be in a set of
315 * @param cfg configuration to inspect
316 * @param section section of interest
317 * @param option option of interest
318 * @return GNUNET_YES, GNUNET_NO or if option has no valid value, GNUNET_SYSERR
320 int GNUNET_CONFIGURATION_get_value_yesno (const struct GNUNET_CONFIGURATION_Handle
321 *cfg, const char *section,
325 * Expand an expression of the form "$FOO/BAR" to "DIRECTORY/BAR"
326 * where either in the "PATHS" section or the environtment
327 * "FOO" is set to "DIRECTORY".
329 * @param cfg configuration to use for path expansion
330 * @param orig string to $-expand (will be freed!)
331 * @return $-expanded string
333 char *GNUNET_CONFIGURATION_expand_dollar (const struct GNUNET_CONFIGURATION_Handle
338 * Set a configuration value that should be a number.
340 * @param cfg configuration to update
341 * @param section section of interest
342 * @param option option of interest
343 * @param number value to set
346 GNUNET_CONFIGURATION_set_value_number (struct GNUNET_CONFIGURATION_Handle
350 unsigned long long number);
354 * Set a configuration value that should be a string.
356 * @param cfg configuration to update
357 * @param section section of interest
358 * @param option option of interest
359 * @param value value to set
362 GNUNET_CONFIGURATION_set_value_string (struct GNUNET_CONFIGURATION_Handle
365 const char *option, const char *value);
368 * Remove a filename from a configuration value that
369 * represents a list of filenames
371 * @param cfg configuration to update
372 * @param section section of interest
373 * @param option option of interest
374 * @param value filename to remove
375 * @return GNUNET_OK on success,
376 * GNUNET_SYSERR if the filename is not in the list
378 int GNUNET_CONFIGURATION_remove_value_filename (struct
379 GNUNET_CONFIGURATION_Handle
386 * Append a filename to a configuration value that
387 * represents a list of filenames
389 * @param cfg configuration to update
390 * @param section section of interest
391 * @param option option of interest
392 * @param value filename to append
393 * @return GNUNET_OK on success,
394 * GNUNET_SYSERR if the filename already in the list
396 int GNUNET_CONFIGURATION_append_value_filename (struct
397 GNUNET_CONFIGURATION_Handle
398 *cfg, const char *section,
403 #if 0 /* keep Emacsens' auto-indent happy */