This file is part of GNUnet
Copyright (C) 2006, 2011 GNUnet e.V.
- 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 3, or (at your
- option) any later version.
+ 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
- General Public License for more details.
+ 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/>.
- 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., 51 Franklin Street, Fifth Floor,
- Boston, MA 02110-1301, USA.
+ SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
{
const char *version = scls;
+ (void) option;
+ (void) value;
printf ("%s v%s\n",
ctx->binaryName,
version);
* @param version string with the version number
*/
struct GNUNET_GETOPT_CommandLineOption
-GNUNET_GETOPT_OPTION_VERSION (const char *version)
+GNUNET_GETOPT_option_version (const char *version)
{
struct GNUNET_GETOPT_CommandLineOption clo = {
.shortName = 'v',
const struct GNUNET_GETOPT_CommandLineOption *opt;
const struct GNUNET_OS_ProjectData *pd;
+ (void) option;
+ (void) value;
if (NULL != about)
{
- printf ("%s\n%s\n", ctx->binaryOptions, gettext (about));
- printf (_
- ("Arguments mandatory for long options are also mandatory for short options.\n"));
+ printf ("%s\n%s\n",
+ ctx->binaryOptions,
+ gettext (about));
+ printf (_("Arguments mandatory for long options are also mandatory for short options.\n"));
}
i = 0;
opt = ctx->allOptions;
- while (opt[i].description != NULL)
+ while (NULL != opt[i].description)
{
if (opt[i].shortName == '\0')
printf (" ");
printf (" -%c, ", opt[i].shortName);
printf ("--%s", opt[i].name);
slen = 8 + strlen (opt[i].name);
- if (opt[i].argumentHelp != NULL)
+ if (NULL != opt[i].argumentHelp)
{
printf ("=%s", opt[i].argumentHelp);
slen += 1 + strlen (opt[i].argumentHelp);
OUTER:
while (ml - p > 78 - slen)
{
- for (j = p + 78 - slen; j > p; j--)
+ for (j = p + 78 - slen; j > (int) p; j--)
{
if (isspace ((unsigned char) trans[j]))
{
* @param about string with brief description of the application
*/
struct GNUNET_GETOPT_CommandLineOption
-GNUNET_GETOPT_OPTION_HELP (const char *about)
+GNUNET_GETOPT_option_help (const char *about)
{
struct GNUNET_GETOPT_CommandLineOption clo = {
.shortName = 'h',
{
unsigned int *val = scls;
+ (void) ctx;
+ (void) option;
+ (void) value;
(*val)++;
return GNUNET_OK;
}
* @param[out] val increment by 1 each time the option is present
*/
struct GNUNET_GETOPT_CommandLineOption
-GNUNET_GETOPT_OPTION_INCREMENT_VALUE (char shortName,
- const char *name,
- const char *description,
- unsigned int *val)
+GNUNET_GETOPT_option_increment_uint (char shortName,
+ const char *name,
+ const char *description,
+ unsigned int *val)
{
struct GNUNET_GETOPT_CommandLineOption clo = {
.shortName = shortName,
* @param[out] level set to the verbosity level
*/
struct GNUNET_GETOPT_CommandLineOption
-GNUNET_GETOPT_OPTION_VERBOSE (unsigned int *level)
+GNUNET_GETOPT_option_verbose (unsigned int *level)
{
struct GNUNET_GETOPT_CommandLineOption clo = {
.shortName = 'V',
{
int *val = scls;
+ (void) ctx;
+ (void) option;
+ (void) value;
*val = 1;
return GNUNET_OK;
}
* @param[out] val set to 1 if the option is present
*/
struct GNUNET_GETOPT_CommandLineOption
-GNUNET_GETOPT_OPTION_SET_ONE (char shortName,
- const char *name,
- const char *description,
- int *val)
+GNUNET_GETOPT_option_flag (char shortName,
+ const char *name,
+ const char *description,
+ int *val)
{
struct GNUNET_GETOPT_CommandLineOption clo = {
.shortName = shortName,
{
char **val = scls;
- GNUNET_assert (value != NULL);
+ (void) ctx;
+ (void) option;
+ GNUNET_assert (NULL != value);
GNUNET_free_non_null (*val);
*val = GNUNET_strdup (value);
return GNUNET_OK;
* @param[out] str set to the string
*/
struct GNUNET_GETOPT_CommandLineOption
-GNUNET_GETOPT_OPTION_STRING (char shortName,
+GNUNET_GETOPT_option_string (char shortName,
const char *name,
const char *argumentHelp,
const char *description,
* @param[out] level set to the log level
*/
struct GNUNET_GETOPT_CommandLineOption
-GNUNET_GETOPT_OPTION_LOGLEVEL (char **level)
+GNUNET_GETOPT_option_loglevel (char **level)
{
struct GNUNET_GETOPT_CommandLineOption clo = {
.shortName = 'L',
{
char **val = scls;
+ (void) ctx;
+ (void) option;
GNUNET_assert (NULL != value);
GNUNET_free_non_null (*val);
*val = GNUNET_STRINGS_filename_expand (value);
* @param[out] str set to the string
*/
struct GNUNET_GETOPT_CommandLineOption
-GNUNET_GETOPT_OPTION_FILENAME (char shortName,
- const char *name,
- const char *argumentHelp,
- const char *description,
- char **str)
+GNUNET_GETOPT_option_filename (char shortName,
+ const char *name,
+ const char *argumentHelp,
+ const char *description,
+ char **str)
{
struct GNUNET_GETOPT_CommandLineOption clo = {
.shortName = shortName,
* @param[out] logfn set to the name of the logfile
*/
struct GNUNET_GETOPT_CommandLineOption
-GNUNET_GETOPT_OPTION_LOGFILE (char **logfn)
+GNUNET_GETOPT_option_logfile (char **logfn)
{
struct GNUNET_GETOPT_CommandLineOption clo = {
.shortName = 'l',
* @param[out] fn set to the name of the configuration file
*/
struct GNUNET_GETOPT_CommandLineOption
-GNUNET_GETOPT_OPTION_CFG_FILE (char **fn)
+GNUNET_GETOPT_option_cfgfile (char **fn)
{
struct GNUNET_GETOPT_CommandLineOption clo = {
.shortName = 'c',
const char *value)
{
unsigned long long *val = scls;
+ char dummy[2];
+ (void) ctx;
if (1 != SSCANF (value,
- "%llu",
- val))
+ "%llu%1s",
+ val,
+ dummy))
{
FPRINTF (stderr,
_("You must pass a number to the `%s' option.\n"),
* @param[out] val set to the value specified at the command line
*/
struct GNUNET_GETOPT_CommandLineOption
-GNUNET_GETOPT_OPTION_SET_ULONG (char shortName,
- const char *name,
- const char *argumentHelp,
- const char *description,
- unsigned long long *val)
+GNUNET_GETOPT_option_ulong (char shortName,
+ const char *name,
+ const char *argumentHelp,
+ const char *description,
+ unsigned long long *val)
{
struct GNUNET_GETOPT_CommandLineOption clo = {
.shortName = shortName,
const char *value)
{
struct GNUNET_TIME_Relative *val = scls;
-
+
+ (void) ctx;
if (GNUNET_OK !=
GNUNET_STRINGS_fancy_time_to_relative (value,
val))
* @param[out] val set to the time specified at the command line
*/
struct GNUNET_GETOPT_CommandLineOption
-GNUNET_GETOPT_OPTION_SET_RELATIVE_TIME (char shortName,
- const char *name,
- const char *argumentHelp,
- const char *description,
- struct GNUNET_TIME_Relative *val)
+GNUNET_GETOPT_option_relative_time (char shortName,
+ const char *name,
+ const char *argumentHelp,
+ const char *description,
+ struct GNUNET_TIME_Relative *val)
{
struct GNUNET_GETOPT_CommandLineOption clo = {
.shortName = shortName,
}
+/**
+ * Set an option of type 'struct GNUNET_TIME_Absolute' from the command line.
+ * A pointer to this function should be passed as part of the
+ * 'struct GNUNET_GETOPT_CommandLineOption' array to initialize options
+ * of this type. It should be followed by a pointer to a value of
+ * type 'struct GNUNET_TIME_Absolute'.
+ *
+ * @param ctx command line processing context
+ * @param scls additional closure (will point to the `struct GNUNET_TIME_Absolute`)
+ * @param option name of the option
+ * @param value actual value of the option as a string.
+ * @return #GNUNET_OK if parsing the value worked
+ */
+static int
+set_absolute_time (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx,
+ void *scls,
+ const char *option,
+ const char *value)
+{
+ struct GNUNET_TIME_Absolute *val = scls;
+
+ (void) ctx;
+ if (GNUNET_OK !=
+ GNUNET_STRINGS_fancy_time_to_absolute (value,
+ val))
+ {
+ FPRINTF (stderr,
+ _("You must pass absolute time to the `%s' option.\n"),
+ option);
+ return GNUNET_SYSERR;
+ }
+ return GNUNET_OK;
+}
+
+
+/**
+ * Allow user to specify a `struct GNUNET_TIME_Absolute`
+ * (using human-readable "fancy" time).
+ *
+ * @param shortName short name of the option
+ * @param name long name of the option
+ * @param argumentHelp help text for the option argument
+ * @param description long help text for the option
+ * @param[out] val set to the time specified at the command line
+ */
+struct GNUNET_GETOPT_CommandLineOption
+GNUNET_GETOPT_option_absolute_time (char shortName,
+ const char *name,
+ const char *argumentHelp,
+ const char *description,
+ struct GNUNET_TIME_Absolute *val)
+{
+ struct GNUNET_GETOPT_CommandLineOption clo = {
+ .shortName = shortName,
+ .name = name,
+ .argumentHelp = argumentHelp,
+ .description = description,
+ .require_argument = 1,
+ .processor = &set_absolute_time,
+ .scls = (void *) val
+ };
+
+ return clo;
+}
+
+
/**
* Set an option of type 'unsigned int' from the command line.
* A pointer to this function should be passed as part of the
const char *value)
{
unsigned int *val = scls;
+ char dummy[2];
+ (void) ctx;
+ if('-' == *value)
+ {
+ FPRINTF (stderr,
+ _("Your input for the '%s' option has to be a non negative number \n"),
+ option);
+ return GNUNET_SYSERR;
+ }
if (1 != SSCANF (value,
- "%u",
- val))
+ "%u%1s",
+ val,
+ dummy))
{
FPRINTF (stderr,
_("You must pass a number to the `%s' option.\n"),
* @param[out] val set to the value specified at the command line
*/
struct GNUNET_GETOPT_CommandLineOption
-GNUNET_GETOPT_OPTION_SET_UINT (char shortName,
- const char *name,
- const char *argumentHelp,
- const char *description,
- unsigned int *val)
+GNUNET_GETOPT_option_uint (char shortName,
+ const char *name,
+ const char *argumentHelp,
+ const char *description,
+ unsigned int *val)
{
struct GNUNET_GETOPT_CommandLineOption clo = {
.shortName = shortName,
}
+
+/**
+ * Set an option of type 'uint16_t' from the command line.
+ * A pointer to this function should be passed as part of the
+ * 'struct GNUNET_GETOPT_CommandLineOption' array to initialize options
+ * of this type. It should be followed by a pointer to a value of
+ * type 'uint16_t'.
+ *
+ * @param ctx command line processing context
+ * @param scls additional closure (will point to the 'unsigned int')
+ * @param option name of the option
+ * @param value actual value of the option as a string.
+ * @return #GNUNET_OK if parsing the value worked
+ */
+static int
+set_uint16 (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx,
+ void *scls,
+ const char *option,
+ const char *value)
+{
+ uint16_t *val = scls;
+ unsigned int v;
+ char dummy[2];
+
+ (void) ctx;
+ if (1 != SSCANF (value,
+ "%u%1s",
+ &v,
+ dummy))
+ {
+ FPRINTF (stderr,
+ _("You must pass a number to the `%s' option.\n"),
+ option);
+ return GNUNET_SYSERR;
+ }
+ if (v > UINT16_MAX)
+ {
+ FPRINTF (stderr,
+ _("You must pass a number below %u to the `%s' option.\n"),
+ (unsigned int) UINT16_MAX,
+ option);
+ return GNUNET_SYSERR;
+ }
+ *val = (uint16_t) v;
+ return GNUNET_OK;
+}
+
+
+/**
+ * Allow user to specify an uint16_t.
+ *
+ * @param shortName short name of the option
+ * @param name long name of the option
+ * @param argumentHelp help text for the option argument
+ * @param description long help text for the option
+ * @param[out] val set to the value specified at the command line
+ */
+struct GNUNET_GETOPT_CommandLineOption
+GNUNET_GETOPT_option_uint16 (char shortName,
+ const char *name,
+ const char *argumentHelp,
+ const char *description,
+ uint16_t *val)
+{
+ struct GNUNET_GETOPT_CommandLineOption clo = {
+ .shortName = shortName,
+ .name = name,
+ .argumentHelp = argumentHelp,
+ .description = description,
+ .require_argument = 1,
+ .processor = &set_uint16,
+ .scls = (void *) val
+ };
+
+ return clo;
+}
+
+
/**
* Closure for #set_base32().
*/
{
struct Base32Context *bc = scls;
+ (void) ctx;
if (GNUNET_OK !=
GNUNET_STRINGS_string_to_data (value,
strlen (value),
/**
* Helper function to clean up after
- * #GNUNET_GETOPT_OPTION_SET_BASE32_FIXED_SIZE.
+ * #GNUNET_GETOPT_option_base32_fixed_size.
*
* @param cls value to GNUNET_free()
*/
* @param val_size size of @a val in bytes
*/
struct GNUNET_GETOPT_CommandLineOption
-GNUNET_GETOPT_OPTION_SET_BASE32_FIXED_SIZE (char shortName,
+GNUNET_GETOPT_option_base32_fixed_size (char shortName,
const char *name,
const char *argumentHelp,
const char *description,
}
+/**
+ * Make the given option mandatory.
+ *
+ * @param opt option to modify
+ * @return @a opt with the mandatory flag set.
+ */
+struct GNUNET_GETOPT_CommandLineOption
+GNUNET_GETOPT_option_mandatory (struct GNUNET_GETOPT_CommandLineOption opt)
+{
+ opt.option_mandatory = 1;
+ return opt;
+}
+
+
/* end of getopt_helpers.c */