gnunet_configuration_lib.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2006, 2008, 2009, 2018, 2024 GNUnet e.V.
 
     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     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
     Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
#ifndef GNUNET_CONFIGURATION_LIB_H
#define GNUNET_CONFIGURATION_LIB_H
 
#include "gnunet_os_lib.h"
#include "gnunet_time_lib.h"
 
#ifdef __cplusplus
extern "C"
{
#if 0                           /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
struct GNUNET_CONFIGURATION_Handle;
 
struct GNUNET_CONFIGURATION_Handle *
GNUNET_CONFIGURATION_create (const struct GNUNET_OS_ProjectData *pd);
 
 
struct GNUNET_CONFIGURATION_Handle *
GNUNET_CONFIGURATION_dup (
  const struct GNUNET_CONFIGURATION_Handle *cfg);
 
 
void
GNUNET_CONFIGURATION_destroy (
  struct GNUNET_CONFIGURATION_Handle *cfg);
 
 
enum GNUNET_GenericReturnValue
GNUNET_CONFIGURATION_load (
  struct GNUNET_CONFIGURATION_Handle *cfg,
  const char *filename);
 
 
enum GNUNET_GenericReturnValue
GNUNET_CONFIGURATION_load_from (
  struct GNUNET_CONFIGURATION_Handle *cfg,
  const char *defaults_d);
 
 
char *
GNUNET_CONFIGURATION_default_filename (
  const struct GNUNET_OS_ProjectData *pd);
 
 
enum GNUNET_GenericReturnValue
GNUNET_CONFIGURATION_parse (
  struct GNUNET_CONFIGURATION_Handle *cfg,
  const char *filename);
 
 
char *
GNUNET_CONFIGURATION_serialize (
  const struct GNUNET_CONFIGURATION_Handle *cfg,
  size_t *size);
 
 
char *
GNUNET_CONFIGURATION_serialize_diagnostics (
  const struct GNUNET_CONFIGURATION_Handle *cfg);
 
 
enum GNUNET_GenericReturnValue
GNUNET_CONFIGURATION_deserialize (
  struct GNUNET_CONFIGURATION_Handle *cfg,
  const char *mem,
  size_t size,
  const char *source_filename);
 
 
enum GNUNET_GenericReturnValue
GNUNET_CONFIGURATION_write (
  struct GNUNET_CONFIGURATION_Handle *cfg,
  const char *filename);
 
 
enum GNUNET_GenericReturnValue
GNUNET_CONFIGURATION_write_diffs (
  const struct GNUNET_CONFIGURATION_Handle *cfg_default,
  const struct GNUNET_CONFIGURATION_Handle *cfg_new,
  const char *filename);
 
 
struct GNUNET_CONFIGURATION_Handle *
GNUNET_CONFIGURATION_get_diff (
  const struct GNUNET_CONFIGURATION_Handle *cfg_default,
  const struct GNUNET_CONFIGURATION_Handle *cfg_new);
 
 
enum GNUNET_GenericReturnValue
GNUNET_CONFIGURATION_is_dirty (
  const struct GNUNET_CONFIGURATION_Handle *cfg);
 
 
typedef enum GNUNET_GenericReturnValue
(*GNUNET_CONFIGURATION_Callback)(
  void *cls,
  const struct GNUNET_CONFIGURATION_Handle *cfg);
 
 
enum GNUNET_GenericReturnValue
GNUNET_CONFIGURATION_parse_and_run (
  const struct GNUNET_OS_ProjectData *pd,
  const char *filename,
  GNUNET_CONFIGURATION_Callback cb,
  void *cb_cls);
 
void
GNUNET_CONFIGURATION_enable_diagnostics (
  struct GNUNET_CONFIGURATION_Handle *cfg);
 
 
const struct GNUNET_OS_ProjectData *
GNUNET_CONFIGURATION_get_project_data (
  const struct GNUNET_CONFIGURATION_Handle *cfg);
 
 
typedef void
(*GNUNET_CONFIGURATION_Iterator) (void *cls,
                                  const char *section,
                                  const char *option,
                                  const char *value);
 
 
typedef void
(*GNUNET_CONFIGURATION_SectionIterator) (void *cls,
                                         const char *section);
 
 
void
GNUNET_CONFIGURATION_iterate (
  const struct GNUNET_CONFIGURATION_Handle *cfg,
  GNUNET_CONFIGURATION_Iterator iter,
  void *iter_cls);
 
 
void
GNUNET_CONFIGURATION_iterate_sections (
  const struct GNUNET_CONFIGURATION_Handle *cfg,
  GNUNET_CONFIGURATION_SectionIterator iter,
  void *iter_cls);
 
 
void
GNUNET_CONFIGURATION_remove_section (
  struct GNUNET_CONFIGURATION_Handle *cfg,
  const char *section);
 
 
enum GNUNET_GenericReturnValue
GNUNET_CONFIGURATION_get_value_number (
  const struct GNUNET_CONFIGURATION_Handle *cfg,
  const char *section,
  const char *option,
  unsigned long long *number);
 
void
GNUNET_CONFIGURATION_set_value_float (struct GNUNET_CONFIGURATION_Handle *cfg,
                                       const char *section,
                                       const char *option,
                                       float number);
 
enum GNUNET_GenericReturnValue
GNUNET_CONFIGURATION_get_value_float (
  const struct GNUNET_CONFIGURATION_Handle *cfg,
  const char *section,
  const char *option,
  float *number);
 
 
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);
 
 
enum GNUNET_GenericReturnValue
GNUNET_CONFIGURATION_get_value_size (
  const struct GNUNET_CONFIGURATION_Handle *cfg,
  const char *section,
  const char *option,
  unsigned long long *size);
 
 
enum GNUNET_GenericReturnValue
GNUNET_CONFIGURATION_have_value (const struct GNUNET_CONFIGURATION_Handle *cfg,
                                 const char *section,
                                 const char *option);
 
 
enum GNUNET_GenericReturnValue
GNUNET_CONFIGURATION_get_value_string (
  const struct GNUNET_CONFIGURATION_Handle *cfg,
  const char *section,
  const char *option,
  char **value);
 
 
enum GNUNET_GenericReturnValue
GNUNET_CONFIGURATION_get_value_filename (
  const struct GNUNET_CONFIGURATION_Handle *cfg,
  const char *section,
  const char *option,
  char **value);
 
 
int
GNUNET_CONFIGURATION_iterate_value_filenames (
  const struct GNUNET_CONFIGURATION_Handle *cfg,
  const char *section,
  const char *option,
  GNUNET_FileNameCallback cb,
  void *cb_cls);
 
 
void
GNUNET_CONFIGURATION_iterate_section_values (
  const struct GNUNET_CONFIGURATION_Handle *cfg,
  const char *section,
  GNUNET_CONFIGURATION_Iterator iter,
  void *iter_cls);
 
 
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);
 
 
enum GNUNET_GenericReturnValue
GNUNET_CONFIGURATION_get_value_yesno (
  const struct GNUNET_CONFIGURATION_Handle *cfg,
  const char *section,
  const char *option);
 
 
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);
 
 
char *
GNUNET_CONFIGURATION_expand_dollar (
  const struct GNUNET_CONFIGURATION_Handle *cfg,
  char *orig);
 
 
void
GNUNET_CONFIGURATION_set_value_number (
  struct GNUNET_CONFIGURATION_Handle *cfg,
  const char *section,
  const char *option,
  unsigned long long number);
 
 
void
GNUNET_CONFIGURATION_set_value_string (
  struct GNUNET_CONFIGURATION_Handle *cfg,
  const char *section,
  const char *option,
  const char *value);
 
 
enum GNUNET_GenericReturnValue
GNUNET_CONFIGURATION_remove_value_filename (
  struct GNUNET_CONFIGURATION_Handle *cfg,
  const char *section,
  const char *option,
  const char *value);
 
 
enum GNUNET_GenericReturnValue
GNUNET_CONFIGURATION_append_value_filename (
  struct GNUNET_CONFIGURATION_Handle *cfg,
  const char *section,
  const char *option,
  const char *value);
 
 
struct GNUNET_CONFIGURATION_ConfigSettings
{
 
  unsigned int api_version;
 
  char *section;
 
  char *option;
 
  char *value;
 
  int is_filename;
 
  int list_sections;
 
  int rewrite;
 
  int diagnostics;
 
  int full;
 
  int global_ret;
 
};
 
 
#define GNUNET_CONFIGURATION_CONFIG_OPTIONS(cs) \
        GNUNET_GETOPT_option_flag ( \
          'F', \
          "full", \
          gettext_noop ( \
            "write the full configuration file, including default values"), \
          &(cs)->full), \
        GNUNET_GETOPT_option_flag ( \
          'f', \
          "filename", \
          gettext_noop ( \
            "interpret option value as a filename (with $-expansion)"), \
          &(cs)->is_filename), \
        GNUNET_GETOPT_option_string ('o', \
                                     "option", \
                                     "OPTION", \
                                     gettext_noop ( \
                                       "name of the option to access"), \
                                     &(cs)->option), \
        GNUNET_GETOPT_option_flag ( \
          'r', \
          "rewrite", \
          gettext_noop ( \
            "rewrite the configuration file, even if nothing changed"), \
          &(cs)->rewrite), \
        GNUNET_GETOPT_option_flag ( \
          'd', \
          "diagnostics", \
          gettext_noop ( \
            "output extra diagnostics"), \
          &(cs)->diagnostics), \
        GNUNET_GETOPT_option_flag ('S', \
                                   "list-sections", \
                                   gettext_noop ( \
                                     "print available configuration sections"), \
                                   &(cs)->list_sections), \
        GNUNET_GETOPT_option_string ('s', \
                                     "section", \
                                     "SECTION", \
                                     gettext_noop ( \
                                       "name of the section to access"), \
                                     &(cs)->section), \
        GNUNET_GETOPT_option_string ('V', \
                                     "value", \
                                     "VALUE", \
                                     gettext_noop ("value to set"), \
                                     &(cs)->value)
 
 
void
GNUNET_CONFIGURATION_config_settings_free (
  struct GNUNET_CONFIGURATION_ConfigSettings *cs);
 
 
void
GNUNET_CONFIGURATION_config_tool_run (
  void *cls,
  char *const *args,
  const char *cfgfile,
  const struct GNUNET_CONFIGURATION_Handle *cfg);
 
 
#if 0                           /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
#endif
 /* end of group configuration */
 /* end of group addition */