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
|
/*
This file is part of GNUnet.
(C) 2001, 2002, 2003, 2004, 2005, 2006, 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 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 include/gnunet_getopt_lib.h
* @brief command line parsing and --help formatting
*
* @author Christian Grothoff
*/
#ifndef GNUNET_GETOPT_LIB_H
#define GNUNET_GETOPT_LIB_H
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
#include "gnunet_configuration_lib.h"
/**
* @brief General context for command line processors.
*/
struct GNUNET_GETOPT_CommandLineProcessorContext
{
/**
* Name of the application
*/
const char *binaryName;
/**
* Name of application with option summary
*/
const char *binaryOptions;
/**
* Array with all command line options.
*/
const struct GNUNET_GETOPT_CommandLineOption *allOptions;
/**
* For configuration
*/
struct GNUNET_CONFIGURATION_Handle *cfg;
/**
* Original command line
*/
char *const *argv;
/**
* Total number of argv's.
*/
unsigned int argc;
/**
* Current argument.
*/
unsigned int currentArgument;
};
/**
* @brief Process a command line option
*
* @param ctx context for all options
* @param scls specific closure (for this processor)
* @param option long name of the option (i.e. "config" for --config)
* @param value argument, NULL if none was given
* @return GNUNET_OK to continue processing other options, GNUNET_SYSERR to abort
*/
typedef
int (*GNUNET_GETOPT_CommandLineOptionProcessor) (struct
GNUNET_GETOPT_CommandLineProcessorContext
* ctx, void *scls,
const char *option,
const char *value);
/**
* @brief Definition of a command line option.
*/
struct GNUNET_GETOPT_CommandLineOption
{
/**
* Short name of the option (use '\0' for none).
*/
const char shortName;
/**
* Long name of the option (may not be NULL)
*/
const char *name;
/**
* Name of the argument for the user in help text
*/
const char *argumentHelp;
/**
* Help text for the option (description)
*/
const char *description;
/**
* Is an argument required? 0: GNUNET_NO (includes optional), 1: GNUNET_YES.
*/
int require_argument;
/**
* Handler for the option.
*/
GNUNET_GETOPT_CommandLineOptionProcessor processor;
/**
* Specific closure to pass to the processor.
*/
void *scls;
};
/**
* Macro defining the option to print the command line
* help text.
*
* @param about string with brief description of the application
*/
#define GNUNET_GETOPT_OPTION_HELP(about) \
{ 'h', "help", (const char *) NULL, gettext_noop("print this help"), 0, &GNUNET_GETOPT_format_help_, (void *) about }
/**
* Macro defining the option to print the version of
* the application
*
* @param version string with the version number
*/
#define GNUNET_GETOPT_OPTION_VERSION(version) \
{ 'v', "version", (const char *) NULL, gettext_noop("print the version number"), 0, &GNUNET_GETOPT_print_version_, (void *) version }
/**
* Get the log level
*/
#define GNUNET_GETOPT_OPTION_LOGFILE(logfn) \
{ 'l', "logfile", "LOGFILE", gettext_noop("configure logging to write logs to LOGFILE"), 1, &GNUNET_GETOPT_set_string, (void *) logfn }
/**
* Set the configuration option for logging.
*/
#define GNUNET_GETOPT_OPTION_LOGLEVEL(loglev) \
{ 'L', "log", "LOGLEVEL", gettext_noop("configure logging to use LOGLEVEL"), 1, &GNUNET_GETOPT_set_string, (void *) loglev }
/**
* Get number of verbose flags
*/
#define GNUNET_GETOPT_OPTION_VERBOSE(level) \
{ 'V', "verbose", (const char *) NULL, gettext_noop("be verbose"), 0, &GNUNET_GETOPT_increment_value, (void *) level }
/**
* Get configuration file name
*/
#define GNUNET_GETOPT_OPTION_CFG_FILE(fn) \
{ 'c', "config", "FILENAME", gettext_noop("use configuration file FILENAME"), 1, &GNUNET_GETOPT_set_string, (void *) fn }
/**
* Marker to end the list of options.
*/
#define GNUNET_GETOPT_OPTION_END \
{ '\0', NULL, NULL, NULL, 0, NULL, NULL }
/**
* Parse the command line.
*
* @param binaryName name of the binary / application with options
* @param cfg for storing/accessing configuration data
* @param allOptions defined options and handlers
* @param argc number of arguments
* @param argv actual arguments
* @return index into argv with first non-option
* argument, or GNUNET_SYSERR on error
*/
int GNUNET_GETOPT_run (const char *binaryName,
struct GNUNET_CONFIGURATION_Handle *cfg,
const struct GNUNET_GETOPT_CommandLineOption
*allOptions, unsigned int argc, char *const *argv);
int GNUNET_GETOPT_set_ulong (struct GNUNET_GETOPT_CommandLineProcessorContext
*ctx, void *scls, const char *option,
const char *value);
int GNUNET_GETOPT_set_uint (struct GNUNET_GETOPT_CommandLineProcessorContext
*ctx, void *scls, const char *option,
const char *value);
int GNUNET_GETOPT_set_one (struct GNUNET_GETOPT_CommandLineProcessorContext
*ctx, void *scls, const char *option,
const char *value);
int GNUNET_GETOPT_set_string (struct GNUNET_GETOPT_CommandLineProcessorContext
*ctx, void *scls, const char *option,
const char *value);
int
GNUNET_GETOPT_increment_value (struct
GNUNET_GETOPT_CommandLineProcessorContext *ctx,
void *scls, const char *option,
const char *value);
/* *************** internal prototypes - use macros above! ************* */
int GNUNET_GETOPT_format_help_ (struct
GNUNET_GETOPT_CommandLineProcessorContext
*ctx, void *scls, const char *option,
const char *value);
int GNUNET_GETOPT_print_version_ (struct
GNUNET_GETOPT_CommandLineProcessorContext
*ctx, void *scls, const char *option,
const char *value);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
/* ifndef GNUNET_GETOPT_LIB_H */
#endif
/* end of gnunet_getopt_lib.h */
|
