aboutsummaryrefslogtreecommitdiff
path: root/src/setup/gnunet-setup-options.h
blob: 31727d30a5d971f1f31bb8d48feaaa13699ba572 (plain) (blame)
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
/*
     This file is part of GNUnet.
     (C) 2010 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 2, 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 src/setup/gnunet-setup-options.h
 * @brief configuration details
 * @author Christian Grothoff
 */
#ifndef GNUNET_SETUP_OPTIONS_H
#define GNUNET_SETUP_OPTIONS_H

#include "gnunet-setup.h"


/**
 * Function to setup the value on load.
 *
 * @param cls closure
 * @param section section with the value
 * @param option option name
 * @param value value as a string
 * @param widget widget to initialize
 * @param cfg configuration handle
 * @return GNUNET_OK on success, GNUNET_SYSERR if there was a problem
 */
typedef int (*GNUNET_SETUP_LoadFunction) (const void *cls, const char *section,
                                          const char *option, const char *value,
                                          GObject * widget,
                                          const struct
                                          GNUNET_CONFIGURATION_Handle * cfg);


/**
 * Modify the configuration to contain the right value for
 * the option based on the state of the widget.
 *
 * @param cls closure
 * @param section section with the value
 * @param option option name
 * @param widget widget to initialize
 * @param cfg configuration handle to update
 * @return GNUNET_OK on success, GNUNET_SYSERR if there was a problem
 */
typedef int (*GNUNET_SETUP_SaveFunction) (const void *cls, const char *section,
                                          const char *option, GObject * widget,
                                          struct GNUNET_CONFIGURATION_Handle *
                                          cfg);


/**
 * Structs of this type specify under which conditions the values of
 * a particular option impact the visibility (or sensitivity) of some
 * other widget.
 */
struct GNUNET_SETUP_VisibilitySpecification
{
  /**
   * Which widget should be changed?
   */
  const char *widget_name;

  /**
   * If the option value matchis this regex, the widget should be
   * shown.  If NULL, the "hide_value" controls visibility.
   */
  const char *show_value;

  /**
   * If the option value matchis this regex, the widget should be
   * hidden.  If NULL, the "show_value" controls visibility.
   */
  const char *hide_value;

};


/**
 * Structs of this type define how widgets relate to GNUnet options
 * and control visibility and special actions.
 */
struct GNUNET_SETUP_OptionSpecification
{
  /**
   * Name of the GTK widget in Glade.
   */
  const char *widget_name;

  /**
   * Name of the signal the widget emits if its state changes.
   */
  const char *change_signal;

  /**
   * Section in the configuration
   */
  const char *section;

  /**
   * Name of the configuration option.
   */
  const char *option;

  /**
   * Help text to display for this option.
   */
  const char *help_text;

  /**
   * Help URL to link to for this option.
   */
  const char *help_url;

  /**
   * Function to call to initialize the widget from the configuration.
   */
  GNUNET_SETUP_LoadFunction load_function;

  /**
   * Function to call set the configuration from the widget.
   */
  GNUNET_SETUP_SaveFunction save_function;

  /**
   * Closure for 'validation_function'.
   */
  const void *load_save_cls;

  /**
   * Visibility changes to apply if this option changes (NULL, or
   * NULL-terminated).
   */
  const struct GNUNET_SETUP_VisibilitySpecification *visibility;

};


/**
 * Option specification data.
 */
extern const struct GNUNET_SETUP_OptionSpecification option_specifications[];

#endif