/usr/include/gnunet/gnunet_configuration_lib.h is in gnunet-dev 0.10.1-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 | /*
This file is part of GNUnet.
(C) 2006, 2008, 2009 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 3, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
/**
* @file include/gnunet_configuration_lib.h
* @brief configuration API
* @author Christian Grothoff
* @defgroup configuration Configuration management
* @{
*/
#ifndef GNUNET_CONFIGURATION_LIB_H
#define GNUNET_CONFIGURATION_LIB_H
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
/**
* A configuration object.
*/
struct GNUNET_CONFIGURATION_Handle;
/**
* Create a new configuration object.
* @return fresh configuration object
*/
struct GNUNET_CONFIGURATION_Handle *
GNUNET_CONFIGURATION_create (void);
/**
* Duplicate an existing configuration object.
*
* @param cfg configuration to duplicate
* @return duplicate configuration
*/
struct GNUNET_CONFIGURATION_Handle *
GNUNET_CONFIGURATION_dup (const struct GNUNET_CONFIGURATION_Handle *cfg);
/**
* 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, NULL to load defaults
* @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
GNUNET_CONFIGURATION_load (struct GNUNET_CONFIGURATION_Handle *cfg,
const char *filename);
/**
* Load default configuration. This function will parse the
* defaults from the given defaults_d directory.
*
* @param cfg configuration to update
* @param defaults_d directory with the defaults
* @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
GNUNET_CONFIGURATION_load_from (struct GNUNET_CONFIGURATION_Handle *cfg,
const char *defaults_d);
/**
* 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);
/**
* Serializes the given configuration.
*
* @param cfg configuration to serialize
* @param size will be set to the size of the serialized memory block
* @return the memory block where the serialized configuration is
* present. This memory should be freed by the caller
*/
char *
GNUNET_CONFIGURATION_serialize (const struct GNUNET_CONFIGURATION_Handle *cfg,
size_t *size);
/**
* De-serializes configuration
*
* @param cfg configuration to update
* @param mem the memory block of serialized configuration
* @param size the size of the memory block
* @param allow_inline set to #GNUNET_YES if we recursively load configuration
* from inlined configurations; #GNUNET_NO if not and raise warnings
* when we come across them
* @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
GNUNET_CONFIGURATION_deserialize (struct GNUNET_CONFIGURATION_Handle *cfg,
const char *mem,
const size_t size,
int allow_inline);
/**
* 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);
/**
* Write only configuration entries that have been changed to configuration file
* @param cfg_default default configuration
* @param cfg_new new configuration
* @param filename where to write the configuration diff between default and new
* @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
GNUNET_CONFIGURATION_write_diffs (const struct GNUNET_CONFIGURATION_Handle *cfg_default,
const struct GNUNET_CONFIGURATION_Handle *cfg_new,
const char *filename);
/**
* Compute configuration with only entries that have been changed
*
* @param cfg_default original configuration
* @param cfg_new new configuration
* @return configuration with only the differences, never NULL
*/
struct GNUNET_CONFIGURATION_Handle *
GNUNET_CONFIGURATION_get_diff (const struct GNUNET_CONFIGURATION_Handle *cfg_default,
const struct GNUNET_CONFIGURATION_Handle *cfg_new);
/**
* 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 (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);
/**
* Function to iterate over section.
*
* @param cls closure
* @param section name of the section
*/
typedef void
(*GNUNET_CONFIGURATION_Section_Iterator) (void *cls,
const char *section);
/**
* 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 @a iter
*/
void
GNUNET_CONFIGURATION_iterate (const struct GNUNET_CONFIGURATION_Handle *cfg,
GNUNET_CONFIGURATION_Iterator iter,
void *iter_cls);
/**
* Iterate over all sections in the configuration.
*
* @param cfg configuration to inspect
* @param iter function to call on each section
* @param iter_cls closure for @a iter
*/
void
GNUNET_CONFIGURATION_iterate_sections (const struct GNUNET_CONFIGURATION_Handle *cfg,
GNUNET_CONFIGURATION_Section_Iterator iter,
void *iter_cls);
/**
* Remove the given section and all options in it.
*
* @param cfg configuration to inspect
* @param section name of the section to remove
*/
void
GNUNET_CONFIGURATION_remove_section (struct GNUNET_CONFIGURATION_Handle *cfg,
const char *section);
/**
* 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 (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);
/**
* Get a configuration value that should be a size in bytes.
*
* @param cfg configuration to inspect
* @param section section of interest
* @param option option of interest
* @param size set to the size in bytes as stored in the configuration
* @return #GNUNET_OK on success, #GNUNET_SYSERR on error
*/
int
GNUNET_CONFIGURATION_get_value_size (const struct GNUNET_CONFIGURATION_Handle *cfg,
const char *section,
const char *option,
unsigned long long *size);
/**
* 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 (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 (const struct GNUNET_CONFIGURATION_Handle *cfg,
const char *section,
const char *option,
char **value);
/**
* 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 (const struct GNUNET_CONFIGURATION_Handle *cfg,
const char *section,
const char *option,
char **value);
/**
* 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 @a cb
* @return number of filenames iterated over, -1 on error
*/
int
GNUNET_CONFIGURATION_iterate_value_filenames (const struct GNUNET_CONFIGURATION_Handle *cfg,
const char *section,
const char *option,
GNUNET_FileNameCallback cb,
void *cb_cls);
/**
* Iterate over values of a section in the configuration.
*
* @param cfg configuration to inspect
* @param section the section
* @param iter function to call on each option
* @param iter_cls closure for @a iter
*/
void
GNUNET_CONFIGURATION_iterate_section_values (const struct GNUNET_CONFIGURATION_Handle *cfg,
const char *section,
GNUNET_CONFIGURATION_Iterator iter,
void *iter_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 (const struct GNUNET_CONFIGURATION_Handle *cfg,
const char *section,
const char *option,
const char *const *choices,
const char **value);
/**
* 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 (const struct GNUNET_CONFIGURATION_Handle *cfg,
const char *section,
const char *option);
/**
* 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". We also support default expansion,
* i.e. ${VARIABLE:-default} will expand to $VARIABLE if VARIABLE is
* set in PATHS or the environment, and otherwise to "default". Note
* that "default" itself can also be a $-expression, thus
* "${VAR1:-{$VAR2}}" will expand to VAR1 and if that is not defined
* to VAR2.
*
* @param cfg configuration to use for path expansion
* @param orig string to $-expand (will be freed!) Note that multiple
* $-expressions can be present in this string. They will all be
* $-expanded.
* @return $-expanded string
*/
char *
GNUNET_CONFIGURATION_expand_dollar (const struct GNUNET_CONFIGURATION_Handle *cfg,
char *orig);
/**
* 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 *cfg,
const char *section,
const char *option,
unsigned long long number);
/**
* Set a configuration value that should be a string.
*
* @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 *cfg,
const char *section,
const char *option,
const char *value);
/**
* 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
*/
int
GNUNET_CONFIGURATION_remove_value_filename (struct GNUNET_CONFIGURATION_Handle *cfg,
const char *section,
const char *option,
const char *value);
/**
* 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
*/
int
GNUNET_CONFIGURATION_append_value_filename (struct GNUNET_CONFIGURATION_Handle *cfg,
const char *section,
const char *option,
const char *value);
/** @} */ /* end of group configuration */
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
#endif
|