2 This file is part of GNUnet
3 (C) 2006, 2011 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
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 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file src/util/getopt_helpers.c
23 * @brief implements command line that sets option
24 * @author Christian Grothoff
27 #include "gnunet_util_lib.h"
29 #define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
33 * Print out program version (implements --version).
35 * @param ctx command line processing context
36 * @param scls additional closure (points to version string)
37 * @param option name of the option
38 * @param value not used (NULL)
39 * @return GNUNET_NO (do not continue, not an error)
42 GNUNET_GETOPT_print_version_ (struct GNUNET_GETOPT_CommandLineProcessorContext
43 *ctx, void *scls, const char *option,
46 const char *version = scls;
48 printf ("%s v%s\n", ctx->binaryName, version);
57 * Print out details on command line options (implements --help).
59 * @param ctx command line processing context
60 * @param scls additional closure (points to about text)
61 * @param option name of the option
62 * @param value not used (NULL)
63 * @return GNUNET_NO (do not continue, not an error)
66 GNUNET_GETOPT_format_help_ (struct GNUNET_GETOPT_CommandLineProcessorContext
67 *ctx, void *scls, const char *option,
70 const char *about = scls;
78 const struct GNUNET_GETOPT_CommandLineOption *opt;
82 printf ("%s\n%s\n", ctx->binaryOptions, gettext (about));
84 ("Arguments mandatory for long options are also mandatory for short options.\n"));
87 opt = ctx->allOptions;
88 while (opt[i].description != NULL)
90 if (opt[i].shortName == '\0')
93 printf (" -%c, ", opt[i].shortName);
94 printf ("--%s", opt[i].name);
95 slen = 8 + strlen (opt[i].name);
96 if (opt[i].argumentHelp != NULL)
98 printf ("=%s", opt[i].argumentHelp);
99 slen += 1 + strlen (opt[i].argumentHelp);
103 printf ("\n%*s", BORDER, "");
108 printf ("%*s", (int) (BORDER - slen), "");
111 if (0 < strlen (opt[i].description))
112 trans = gettext (opt[i].description);
118 while (ml - p > 78 - slen)
120 for (j = p + 78 - slen; j > p; j--)
122 if (isspace ((unsigned char) trans[j]))
124 scp = GNUNET_malloc (j - p + 1);
125 memcpy (scp, &trans[p], j - p);
127 printf ("%s\n%*s", scp, BORDER + 2, "");
134 /* could not find space to break line */
135 scp = GNUNET_malloc (78 - slen + 1);
136 memcpy (scp, &trans[p], 78 - slen);
137 scp[78 - slen] = '\0';
138 printf ("%s\n%*s", scp, BORDER + 2, "");
145 printf ("%s\n", &trans[p]);
146 if (strlen (trans) == 0)
150 printf ("Report bugs to gnunet-developers@gnu.org.\n"
151 "GNUnet home page: http://www.gnu.org/software/gnunet/\n"
152 "General help using GNU software: http://www.gnu.org/gethelp/\n");
158 * Set an option of type 'unsigned int' from the command line. Each
159 * time the option flag is given, the value is incremented by one.
160 * A pointer to this function should be passed as part of the
161 * 'struct GNUNET_GETOPT_CommandLineOption' array to initialize options
162 * of this type. It should be followed by a pointer to a value of
165 * @param ctx command line processing context
166 * @param scls additional closure (will point to the 'int')
167 * @param option name of the option
168 * @param value not used (NULL)
172 GNUNET_GETOPT_increment_value (struct GNUNET_GETOPT_CommandLineProcessorContext
173 *ctx, void *scls, const char *option,
184 * Set an option of type 'int' from the command line to 1 if the
185 * given option is present.
186 * A pointer to this function should be passed as part of the
187 * 'struct GNUNET_GETOPT_CommandLineOption' array to initialize options
188 * of this type. It should be followed by a pointer to a value of
191 * @param ctx command line processing context
192 * @param scls additional closure (will point to the 'int')
193 * @param option name of the option
194 * @param value not used (NULL)
198 GNUNET_GETOPT_set_one (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx,
199 void *scls, const char *option, const char *value)
209 * Set an option of type 'char *' from the command line.
210 * A pointer to this function should be passed as part of the
211 * 'struct GNUNET_GETOPT_CommandLineOption' array to initialize options
212 * of this type. It should be followed by a pointer to a value of
213 * type 'char *', which will be allocated with the requested string.
215 * @param ctx command line processing context
216 * @param scls additional closure (will point to the 'char *',
217 * which will be allocated)
218 * @param option name of the option
219 * @param value actual value of the option (a string)
223 GNUNET_GETOPT_set_string (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx,
224 void *scls, const char *option, const char *value)
228 GNUNET_assert (value != NULL);
229 GNUNET_free_non_null (*val);
230 *val = GNUNET_strdup (value);
236 GNUNET_GETOPT_set_filename (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx,
237 void *scls, const char *option, const char *value)
241 GNUNET_assert (value != NULL);
242 GNUNET_free_non_null (*val);
243 *val = GNUNET_STRINGS_filename_expand (value);
248 * Set an option of type 'unsigned long long' from the command line.
249 * A pointer to this function should be passed as part of the
250 * 'struct GNUNET_GETOPT_CommandLineOption' array to initialize options
251 * of this type. It should be followed by a pointer to a value of
252 * type 'unsigned long long'.
254 * @param ctx command line processing context
255 * @param scls additional closure (will point to the 'unsigned long long')
256 * @param option name of the option
257 * @param value actual value of the option as a string.
258 * @return GNUNET_OK if parsing the value worked
261 GNUNET_GETOPT_set_ulong (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx,
262 void *scls, const char *option, const char *value)
264 unsigned long long *val = scls;
266 if (1 != SSCANF (value, "%llu", val))
268 FPRINTF (stderr, _("You must pass a number to the `%s' option.\n"), option);
269 return GNUNET_SYSERR;
276 * Set an option of type 'struct GNUNET_TIME_Relative' from the command line.
277 * A pointer to this function should be passed as part of the
278 * 'struct GNUNET_GETOPT_CommandLineOption' array to initialize options
279 * of this type. It should be followed by a pointer to a value of
280 * type 'struct GNUNET_TIME_Relative'.
282 * @param ctx command line processing context
283 * @param scls additional closure (will point to the 'struct GNUNET_TIME_Relative')
284 * @param option name of the option
285 * @param value actual value of the option as a string.
286 * @return GNUNET_OK if parsing the value worked
289 GNUNET_GETOPT_set_relative_time (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx,
290 void *scls, const char *option, const char *value)
292 struct GNUNET_TIME_Relative *val = scls;
295 GNUNET_STRINGS_fancy_time_to_relative (value,
298 FPRINTF (stderr, _("You must pass relative time to the `%s' option.\n"), option);
299 return GNUNET_SYSERR;
306 * Set an option of type 'unsigned int' from the command line.
307 * A pointer to this function should be passed as part of the
308 * 'struct GNUNET_GETOPT_CommandLineOption' array to initialize options
309 * of this type. It should be followed by a pointer to a value of
310 * type 'unsigned int'.
312 * @param ctx command line processing context
313 * @param scls additional closure (will point to the 'unsigned int')
314 * @param option name of the option
315 * @param value actual value of the option as a string.
316 * @return GNUNET_OK if parsing the value worked
319 GNUNET_GETOPT_set_uint (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx,
320 void *scls, const char *option, const char *value)
322 unsigned int *val = scls;
324 if (1 != SSCANF (value, "%u", val))
326 FPRINTF (stderr, _("You must pass a number to the `%s' option.\n"), option);
327 return GNUNET_SYSERR;
333 /* end of getopt_helpers.c */