GNUnet  0.11.x
gnunet_configuration_lib.h
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2006, 2008, 2009, 2018 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
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  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
20 
31 #ifndef GNUNET_CONFIGURATION_LIB_H
32 #define GNUNET_CONFIGURATION_LIB_H
33 
34 #include "gnunet_time_lib.h"
35 
36 #ifdef __cplusplus
37 extern "C"
38 {
39 #if 0 /* keep Emacsens' auto-indent happy */
40 }
41 #endif
42 #endif
43 
48 
55 
56 
65 
66 
72 void
74 
75 
87  const char *filename);
88 
89 
100  const char *defaults_d);
101 
102 
113 
114 
123 char *
125 
126 
137  const char *filename);
138 
139 
148 char *
150  size_t *size);
151 
152 
162 char *
165 
178  const char *mem,
179  size_t size,
180  const char *source_filename);
181 
182 
192  const char *filename);
193 
194 
205  const struct GNUNET_CONFIGURATION_Handle *cfg_default,
206  const struct GNUNET_CONFIGURATION_Handle *cfg_new,
207  const char *filename);
208 
209 
219  const struct GNUNET_CONFIGURATION_Handle *cfg_default,
220  const struct GNUNET_CONFIGURATION_Handle *cfg_new);
221 
222 
232 
233 
241 typedef enum GNUNET_GenericReturnValue
242 (*GNUNET_CONFIGURATION_Callback)(void *cls,
243  const struct GNUNET_CONFIGURATION_Handle *cfg);
244 
245 
260  void *cb_cls);
261 
268 void
271 
272 
281 typedef void
282 (*GNUNET_CONFIGURATION_Iterator) (void *cls,
283  const char *section,
284  const char *option,
285  const char *value);
286 
287 
294 typedef void
296  const char *section);
297 
298 
306 void
309  void *iter_cls);
310 
311 
319 void
323  iter,
324  void *iter_cls);
325 
326 
333 void
335  const char *section);
336 
337 
350  const char *section,
351  const char *option,
352  unsigned long long *number);
353 
354 
367  const char *section,
368  const char *option,
369  float *number);
370 
371 
384  const char *section,
385  const char *option,
386  struct GNUNET_TIME_Relative *time);
387 
388 
401  const char *section,
402  const char *option,
403  unsigned long long *size);
404 
405 
416  const char *section,
417  const char *option);
418 
419 
432  const struct GNUNET_CONFIGURATION_Handle *cfg,
433  const char *section,
434  const char *option,
435  char **value);
436 
437 
452  const char *section,
453  const char *option,
454  char **value);
455 
456 
467 int
470  const char *section,
471  const char *option,
473  void *cb_cls);
474 
483 void
486  const char *section,
488  void *iter_cls);
489 
505  const char *section,
506  const char *option,
507  const char *const *choices,
508  const char **value);
509 
522  const char *section,
523  const char *option);
524 
525 
540  const char *section,
541  const char *option,
542  void *buf,
543  size_t buf_size);
544 
545 
562 char *
564  const struct GNUNET_CONFIGURATION_Handle *cfg,
565  char *orig);
566 
567 
576 void
578  const char *section,
579  const char *option,
580  unsigned long long number);
581 
582 
591 void
593  const char *section,
594  const char *option,
595  const char *value);
596 
597 
612  const char *section,
613  const char *option,
614  const char *value);
615 
616 
631  const char *section,
632  const char *option,
633  const char *value);
634 
635 
642 {
643 
650  unsigned int api_version;
651 
655  char *section;
656 
660  char *option;
661 
665  char *value;
666 
671 
676 
680  int rewrite;
681 
686 
690  int full;
691 
692 
698 
699 };
700 
701 
709 #define GNUNET_CONFIGURATION_CONFIG_OPTIONS(cs) \
710  GNUNET_GETOPT_option_flag ( \
711  'F', \
712  "full", \
713  gettext_noop ( \
714  "write the full configuration file, including default values"), \
715  &(cs)->full), \
716  GNUNET_GETOPT_option_flag ( \
717  'f', \
718  "filename", \
719  gettext_noop ("interpret option value as a filename (with $-expansion)"), \
720  &(cs)->is_filename), \
721  GNUNET_GETOPT_option_string ('o', \
722  "option", \
723  "OPTION", \
724  gettext_noop ("name of the option to access"), \
725  &(cs)->option), \
726  GNUNET_GETOPT_option_flag ( \
727  'r', \
728  "rewrite", \
729  gettext_noop ( \
730  "rewrite the configuration file, even if nothing changed"), \
731  &(cs)->rewrite), \
732  GNUNET_GETOPT_option_flag ( \
733  'd', \
734  "diagnostics", \
735  gettext_noop ( \
736  "output extra diagnostics"), \
737  &(cs)->diagnostics), \
738  GNUNET_GETOPT_option_flag ('S', \
739  "list-sections", \
740  gettext_noop ( \
741  "print available configuration sections"), \
742  &(cs)->list_sections), \
743  GNUNET_GETOPT_option_string ('s', \
744  "section", \
745  "SECTION", \
746  gettext_noop ( \
747  "name of the section to access"), \
748  &(cs)->section), \
749  GNUNET_GETOPT_option_string ('V', \
750  "value", \
751  "VALUE", \
752  gettext_noop ("value to set"), \
753  &(cs)->value)
754 
755 
762 void
765 
766 
778 void
780  void *cls,
781  char *const *args,
782  const char *cfgfile,
783  const struct GNUNET_CONFIGURATION_Handle *cfg);
784 
785 
786 #if 0 /* keep Emacsens' auto-indent happy */
787 {
788 #endif
789 #ifdef __cplusplus
790 }
791 #endif
792 
793 #endif
794  /* end of group configuration */
static const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we are using.
Definition: gnunet-abd.c:36
static char * filename
static char * value
Value of the record to add/remove.
static char buf[2048]
enum GNUNET_GenericReturnValue(* GNUNET_FileNameCallback)(void *cls, const char *filename)
Function called with a filename.
GNUNET_GenericReturnValue
Named constants for return values.
Definition: gnunet_common.h:92
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_data(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, void *buf, size_t buf_size)
Get Crockford32-encoded fixed-size binary data from a configuration.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_is_dirty(const struct GNUNET_CONFIGURATION_Handle *cfg)
Test if there are configuration options that were changed since the last save.
void GNUNET_CONFIGURATION_set_value_string(struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, const char *value)
Set a configuration value that should be a string.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_append_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.
void GNUNET_CONFIGURATION_iterate_sections(const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_CONFIGURATION_Section_Iterator iter, void *iter_cls)
Iterate over all sections in the configuration.
char * GNUNET_CONFIGURATION_serialize_diagnostics(const struct GNUNET_CONFIGURATION_Handle *cfg)
Serializes the given configuration with diagnostics information.
char * GNUNET_CONFIGURATION_serialize(const struct GNUNET_CONFIGURATION_Handle *cfg, size_t *size)
Serializes the given configuration.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_filename(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.
void GNUNET_CONFIGURATION_remove_section(struct GNUNET_CONFIGURATION_Handle *cfg, const char *section)
Remove the given section and all options in it.
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_default(void)
Return GNUnet's default configuration.
enum GNUNET_GenericReturnValue(* GNUNET_CONFIGURATION_Callback)(void *cls, const struct GNUNET_CONFIGURATION_Handle *cfg)
Signature of a function to be run with a configuration.
enum GNUNET_GenericReturnValue 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 number.
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_create(void)
Create a new configuration object.
void GNUNET_CONFIGURATION_destroy(struct GNUNET_CONFIGURATION_Handle *cfg)
Destroy configuration object.
void GNUNET_CONFIGURATION_config_settings_free(struct GNUNET_CONFIGURATION_ConfigSettings *cs)
Free resources associated with cs.
void GNUNET_CONFIGURATION_iterate(const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_CONFIGURATION_Iterator iter, void *iter_cls)
Iterate over all options in the configuration.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_remove_value_filename(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.
void GNUNET_CONFIGURATION_config_tool_run(void *cls, char *const *args, const char *cfgfile, const struct GNUNET_CONFIGURATION_Handle *cfg)
Main task to run to perform operations typical for gnunet-config as per the configuration settings gi...
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_deserialize(struct GNUNET_CONFIGURATION_Handle *cfg, const char *mem, size_t size, const char *source_filename)
De-serializes configuration.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_size(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, unsigned long long *size)
Get a configuration value that should be a size in bytes.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_yesno(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option)
Get a configuration value that should be in a set of "YES" or "NO".
char * GNUNET_CONFIGURATION_expand_dollar(const struct GNUNET_CONFIGURATION_Handle *cfg, char *orig)
Expand an expression of the form "$FOO/BAR" to "DIRECTORY/BAR" where either in the "PATHS" section or...
enum GNUNET_GenericReturnValue 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 relative time.
enum GNUNET_GenericReturnValue 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 a string.
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 number.
void(* GNUNET_CONFIGURATION_Section_Iterator)(void *cls, const char *section)
Function to iterate over section.
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_get_diff(const struct GNUNET_CONFIGURATION_Handle *cfg_default, const struct GNUNET_CONFIGURATION_Handle *cfg_new)
Compute configuration with only entries that have been changed.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_load(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Load configuration.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_parse(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Parse a configuration file, add all of the options in the file to the configuration environment.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_get_value_float(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option, float *number)
Get a configuration value that should be a floating point number.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_load_from(struct GNUNET_CONFIGURATION_Handle *cfg, const char *defaults_d)
Load default configuration.
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 the set of filenames stored in a configuration value.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_parse_and_run(const char *filename, GNUNET_CONFIGURATION_Callback cb, void *cb_cls)
Parse a configuration file filename and run the function cb with the resulting configuration object.
char * GNUNET_CONFIGURATION_default_filename(void)
Return the filename of the default configuration filename that is used when no explicit configuration...
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_have_value(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, const char *option)
Test if we have a value for a particular option.
enum GNUNET_GenericReturnValue 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 predefined strings.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_write(struct GNUNET_CONFIGURATION_Handle *cfg, const char *filename)
Write configuration file.
void(* GNUNET_CONFIGURATION_Iterator)(void *cls, const char *section, const char *option, const char *value)
Function to iterate over options.
void GNUNET_CONFIGURATION_iterate_section_values(const struct GNUNET_CONFIGURATION_Handle *cfg, const char *section, GNUNET_CONFIGURATION_Iterator iter, void *iter_cls)
Iterate over values of a section in the configuration.
enum GNUNET_GenericReturnValue GNUNET_CONFIGURATION_write_diffs(const struct GNUNET_CONFIGURATION_Handle *cfg_default, const struct GNUNET_CONFIGURATION_Handle *cfg_new, const char *filename)
Write only configuration entries that have been changed to configuration file.
struct GNUNET_CONFIGURATION_Handle * GNUNET_CONFIGURATION_dup(const struct GNUNET_CONFIGURATION_Handle *cfg)
Duplicate an existing configuration object.
void GNUNET_CONFIGURATION_enable_diagnostics(struct GNUNET_CONFIGURATION_Handle *cfg)
Enable extra diagnostics.
static unsigned int size
Size of the "table".
Definition: peer.c:67
uint32_t number
Closure for GNUNET_CONFIGURATION_config_tool_run() with settings for what should be done with the con...
int full
Should the generated configuration file contain the whole configuration?
int global_ret
Return value from the operation, to be returned from 'main'.
int diagnostics
Should we give extra diagnostics?
int list_sections
Whether to show the sections.
int rewrite
Should we write out the configuration file, even if no value was changed?
int is_filename
Treat option as a filename.
unsigned int api_version
Must be set to the API version, i.e.
Time for relative time used by GNUnet, in microseconds.