Command line parsing and –help formatting. More...

Collaboration diagram for Getopt library:

Data Structures
struct	GNUNET_GETOPT_CommandLineProcessorContext
	General context for command line processors. More...

struct	GNUNET_GETOPT_CommandLineOption
	Definition of a command line option. More...

Macros
#define	GNUNET_GETOPT_option_base32_auto(shortName, name, argumentHelp, description, val)
	Allow user to specify a binary value using Crockford Base32 encoding where the size of the binary value is automatically determined from its type. More...

#define	GNUNET_GETOPT_OPTION_END
	Marker for the end of the list of options. More...

Typedefs
typedef int(*	GNUNET_GETOPT_CommandLineOptionProcessor) (struct GNUNET_GETOPT_CommandLineProcessorContext ctx, void scls, const char option, const char value)
	Process a command line option. More...

Functions
struct GNUNET_GETOPT_CommandLineOption	GNUNET_GETOPT_option_help (const struct GNUNET_OS_ProjectData pd, const char about)
	Defining the option to print the command line help text (-h option). More...

struct GNUNET_GETOPT_CommandLineOption	GNUNET_GETOPT_option_timetravel (char shortName, const char *name)
	Allow user to specify a `long long` with an offset to add to the current system time to construct the time seen by the application. More...

struct GNUNET_GETOPT_CommandLineOption	GNUNET_GETOPT_option_version (const char *version)
	Define the option to print the version of the application (-v option) More...

struct GNUNET_GETOPT_CommandLineOption	GNUNET_GETOPT_option_logfile (char **logfn)
	Allow user to specify log file name (-l option) More...

struct GNUNET_GETOPT_CommandLineOption	GNUNET_GETOPT_option_string (char shortName, const char name, const char argumentHelp, const char description, char *str)
	Allow user to specify a string. More...

struct GNUNET_GETOPT_CommandLineOption	GNUNET_GETOPT_option_filename (char shortName, const char name, const char argumentHelp, const char description, char *str)
	Allow user to specify a filename (automatically path expanded). More...

struct GNUNET_GETOPT_CommandLineOption	GNUNET_GETOPT_option_base32_fixed_size (char shortName, const char name, const char argumentHelp, const char description, void val, size_t val_size)
	Allow user to specify a binary value using Crockford Base32 encoding. More...

struct GNUNET_GETOPT_CommandLineOption	GNUNET_GETOPT_option_flag (char shortName, const char name, const char description, int *val)
	Allow user to specify a flag (which internally means setting an integer to 1/GNUNET_YES/GNUNET_OK. More...

struct GNUNET_GETOPT_CommandLineOption	GNUNET_GETOPT_option_uint (char shortName, const char name, const char argumentHelp, const char description, unsigned int val)
	Allow user to specify an `unsigned int`. More...

struct GNUNET_GETOPT_CommandLineOption	GNUNET_GETOPT_option_uint16 (char shortName, const char name, const char argumentHelp, const char description, uint16_t val)
	Allow user to specify an uint16_t. More...

struct GNUNET_GETOPT_CommandLineOption	GNUNET_GETOPT_option_ulong (char shortName, const char name, const char argumentHelp, const char description, unsigned long long val)
	Allow user to specify an `unsigned long long`. More...

struct GNUNET_GETOPT_CommandLineOption	GNUNET_GETOPT_option_relative_time (char shortName, const char name, const char argumentHelp, const char description, struct GNUNET_TIME_Relative val)
	Allow user to specify a `struct GNUNET_TIME_Relative` (using human-readable "fancy" time). More...

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)
	Allow user to specify a `struct GNUNET_TIME_Absolute` (using human-readable "fancy" time). More...

struct GNUNET_GETOPT_CommandLineOption	GNUNET_GETOPT_option_timestamp (char shortName, const char name, const char argumentHelp, const char description, struct GNUNET_TIME_Timestamp val)
	Allow user to specify a `struct GNUNET_TIME_Timestamp` (using human-readable "fancy" time). More...

struct GNUNET_GETOPT_CommandLineOption	GNUNET_GETOPT_option_increment_uint (char shortName, const char name, const char description, unsigned int *val)
	Increment val each time the option flag is given by one. More...

struct GNUNET_GETOPT_CommandLineOption	GNUNET_GETOPT_option_loglevel (char **level)
	Define the '-L' log level option. More...

struct GNUNET_GETOPT_CommandLineOption	GNUNET_GETOPT_option_verbose (unsigned int *level)
	Define the '-V' verbosity option. More...

struct GNUNET_GETOPT_CommandLineOption	GNUNET_GETOPT_option_cfgfile (char **fn)
	Allow user to specify configuration file name (-c option) More...

struct GNUNET_GETOPT_CommandLineOption	GNUNET_GETOPT_option_mandatory (struct GNUNET_GETOPT_CommandLineOption opt)
	Make the given option mandatory. More...

struct GNUNET_GETOPT_CommandLineOption	GNUNET_GETOPT_option_exclusive (struct GNUNET_GETOPT_CommandLineOption opt)
	Make the given option mutually exclusive with other options. More...

int	GNUNET_GETOPT_run (const char binaryOptions, const struct GNUNET_GETOPT_CommandLineOption allOptions, unsigned int argc, char const argv)
	Parse the command line. More...

Detailed Description

Command line parsing and –help formatting.

Macro Definition Documentation

◆ GNUNET_GETOPT_option_base32_auto

#define GNUNET_GETOPT_option_base32_auto	(	shortName,
		name,
		argumentHelp,
		description,
		val
	)

Value:

        GNUNET_GETOPT_option_base32_fixed_size (shortName,    \
                                                name,         \
                                                argumentHelp, \
                                                description,  \
                                                val,          \
                                                sizeof(*val))

Allow user to specify a binary value using Crockford Base32 encoding where the size of the binary value is automatically determined from its type.

Parameters

	shortName	short name of the option
	name	long name of the option
	argumentHelp	help text for the option argument
	description	long help text for the option
[out]	val	binary value decoded from Crockford Base32-encoded argument; size is determined by type (sizeof (*val)).

Definition at line 275 of file gnunet_getopt_lib.h.

◆ GNUNET_GETOPT_OPTION_END

#define GNUNET_GETOPT_OPTION_END

Value:

        {                                                   \
          '\0', NULL, NULL, NULL, 0, 0, 0, NULL, NULL, NULL \
        }

Marker for the end of the list of options.

Definition at line 476 of file gnunet_getopt_lib.h.

Typedef Documentation

◆ GNUNET_GETOPT_CommandLineOptionProcessor

typedef int(* GNUNET_GETOPT_CommandLineOptionProcessor) (struct GNUNET_GETOPT_CommandLineProcessorContext *ctx, void *scls, const char *option, const char *value)

Process a command line option.

Parameters

ctx	context for all options
scls	specific closure (for this processor)
option	long name of the option (e.g. "config" for –config)
value	argument, NULL if none was given

Returns: GNUNET_OK to continue processing other options, GNUNET_SYSERR to abort

Definition at line 99 of file gnunet_getopt_lib.h.

Function Documentation

◆ GNUNET_GETOPT_option_help()

struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_help	(	const struct GNUNET_OS_ProjectData *	pd,
		const char *	about
	)

Defining the option to print the command line help text (-h option).

Parameters

pd	project data to determine details about the application
about	string with brief description of the application

Definition at line 200 of file getopt_helpers.c.

{
  struct GNUNET_GETOPT_CommandLineOption clo = {
    .shortName = 'h',
    .name = "help",
    .argumentHelp = about,
    .description = gettext_noop (
      "print this help"),
    .option_exclusive = 1,
    .processor = &format_help,
    .scls = (void *) pd,
  };
 
  return clo;
}

References format_help(), gettext_noop, and GNUNET_GETOPT_CommandLineOption::shortName.

Referenced by GNUNET_PROGRAM_conf_and_options(), GNUNET_PROGRAM_run2(), GNUNET_SERVICE_run_(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GNUNET_GETOPT_option_timetravel()

struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_timetravel	(	char	shortName,
		const char *	name
	)

Allow user to specify a long long with an offset to add to the current system time to construct the time seen by the application.

Used for debugging / testing.

Parameters

	shortName	short name of the option
	name	long name of the option
[out]	val	set to the time specified at the command line

Definition at line 600 of file getopt_helpers.c.

{
  struct GNUNET_GETOPT_CommandLineOption clo = {
    .shortName = shortName,
    .name = name,
    .argumentHelp = _ ("[+/-]MICROSECONDS"),
    .description = _ (
      "modify system time by given offset (for debugging/testing only)"),
    .require_argument = 1,
    .processor = &set_timetravel_time
  };
 
  return clo;
}

References _, name, set_timetravel_time(), and GNUNET_GETOPT_CommandLineOption::shortName.

Here is the call graph for this function:

◆ GNUNET_GETOPT_option_version()

struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_version ( const char * version )

Define the option to print the version of the application (-v option)

Parameters

version string with the version number

Definition at line 60 of file getopt_helpers.c.

{
  struct GNUNET_GETOPT_CommandLineOption clo = {
    .shortName = 'v',
    .name = "version",
    .description = gettext_noop (
      "print the version number"),
    .option_exclusive = 1,
    .processor = &print_version,
    .scls = (void *) version
  };
 
  return clo;
}

References gettext_noop, print_version(), and GNUNET_GETOPT_CommandLineOption::shortName.

Referenced by GNUNET_PROGRAM_conf_and_options(), GNUNET_PROGRAM_run2(), GNUNET_SERVICE_run_(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GNUNET_GETOPT_option_logfile()

struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_logfile ( char ** logfn )

Allow user to specify log file name (-l option)

Parameters

[out] logfn set to the name of the logfile

Definition at line 449 of file getopt_helpers.c.

{
  struct GNUNET_GETOPT_CommandLineOption clo = {
    .shortName = 'l',
    .name = "logfile",
    .argumentHelp = "FILENAME",
    .description =
      gettext_noop ("configure logging to write logs to FILENAME"),
    .require_argument = 1,
    .processor = &set_filename,
    .scls = (void *) logfn
  };
 
  return clo;
}

References gettext_noop, set_filename(), and GNUNET_GETOPT_CommandLineOption::shortName.

Referenced by GNUNET_PROGRAM_conf_and_options(), GNUNET_PROGRAM_run2(), GNUNET_SERVICE_run_(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GNUNET_GETOPT_option_string()

struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_string	(	char	shortName,
		const char *	name,
		const char *	argumentHelp,
		const char *	description,
		char **	str
	)

Allow user to specify a string.

Parameters

	shortName	short name of the option
	name	long name of the option
	argumentHelp	help text for the option argument
	description	long help text for the option
[out]	str	set to the string

Definition at line 362 of file getopt_helpers.c.

{
  struct GNUNET_GETOPT_CommandLineOption clo = {
    .shortName = shortName,
    .name = name,
    .argumentHelp = argumentHelp,
    .description = description,
    .require_argument = 1,
    .processor = &set_string,
    .scls = (void *) str
  };
 
  return clo;
}

References GNUNET_GETOPT_CommandLineOption::argumentHelp, GNUNET_GETOPT_CommandLineOption::description, name, set_string(), and GNUNET_GETOPT_CommandLineOption::shortName.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GNUNET_GETOPT_option_filename()

struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_filename	(	char	shortName,
		const char *	name,
		const char *	argumentHelp,
		const char *	description,
		char **	str
	)

Allow user to specify a filename (automatically path expanded).

Parameters

	shortName	short name of the option
	name	long name of the option
	argumentHelp	help text for the option argument
	description	long help text for the option
[out]	str	set to the string

Definition at line 428 of file getopt_helpers.c.

{
  struct GNUNET_GETOPT_CommandLineOption clo = {
    .shortName = shortName,
    .name = name,
    .argumentHelp = argumentHelp,
    .description = description,
    .require_argument = 1,
    .processor = &set_filename,
    .scls = (void *) str
  };
 
  return clo;
}

References GNUNET_GETOPT_CommandLineOption::argumentHelp, GNUNET_GETOPT_CommandLineOption::description, name, set_filename(), and GNUNET_GETOPT_CommandLineOption::shortName.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GNUNET_GETOPT_option_base32_fixed_size()

struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_base32_fixed_size	(	char	shortName,
		const char *	name,
		const char *	argumentHelp,
		const char *	description,
		void *	val,
		size_t	val_size
	)

Allow user to specify a binary value using Crockford Base32 encoding.

Parameters

	shortName	short name of the option
	name	long name of the option
	argumentHelp	help text for the option argument
	description	long help text for the option
[out]	val	binary value decoded from Crockford Base32-encoded argument
	val_size	size of val in bytes

Definition at line 987 of file getopt_helpers.c.

{
  struct Base32Context *bc = GNUNET_new (struct Base32Context);
  struct GNUNET_GETOPT_CommandLineOption clo = {
    .shortName = shortName,
    .name = name,
    .argumentHelp = argumentHelp,
    .description = description,
    .require_argument = 1,
    .processor = &set_base32,
    .cleaner = &free_bc,
    .scls = (void *) bc
  };
 
  bc->val = val;
  bc->val_size = val_size;
  return clo;
}

References GNUNET_GETOPT_CommandLineOption::argumentHelp, GNUNET_GETOPT_CommandLineOption::description, free_bc(), GNUNET_new, name, set_base32(), GNUNET_GETOPT_CommandLineOption::shortName, Base32Context::val, and Base32Context::val_size.

Here is the call graph for this function:

◆ GNUNET_GETOPT_option_flag()

struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_flag	(	char	shortName,
		const char *	name,
		const char *	description,
		int *	val
	)

Allow user to specify a flag (which internally means setting an integer to 1/GNUNET_YES/GNUNET_OK.

Parameters

	shortName	short name of the option
	name	long name of the option
	description	long help text for the option
[out]	val	set to 1 if the option is present

Definition at line 313 of file getopt_helpers.c.

{
  struct GNUNET_GETOPT_CommandLineOption clo = {
    .shortName = shortName,
    .name = name,
    .description = description,
    .processor = &set_one,
    .scls = (void *) val
  };
 
  return clo;
}

References GNUNET_GETOPT_CommandLineOption::description, name, set_one(), and GNUNET_GETOPT_CommandLineOption::shortName.

Referenced by GNUNET_PROGRAM_conf_and_options(), GNUNET_SERVICE_run_(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GNUNET_GETOPT_option_uint()

struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_uint	(	char	shortName,
		const char *	name,
		const char *	argumentHelp,
		const char *	description,
		unsigned int *	val
	)

Allow user to specify an unsigned int.

Parameters

	shortName	short name of the option
	name	long name of the option
	argumentHelp	help text for the option argument
	description	long help text for the option
[out]	val	set to the value specified at the command line

Definition at line 832 of file getopt_helpers.c.

{
  struct GNUNET_GETOPT_CommandLineOption clo = {
    .shortName = shortName,
    .name = name,
    .argumentHelp = argumentHelp,
    .description = description,
    .require_argument = 1,
    .processor = &set_uint,
    .scls = (void *) val
  };
 
  return clo;
}

References GNUNET_GETOPT_CommandLineOption::argumentHelp, GNUNET_GETOPT_CommandLineOption::description, name, set_uint(), and GNUNET_GETOPT_CommandLineOption::shortName.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GNUNET_GETOPT_option_uint16()

struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_uint16	(	char	shortName,
		const char *	name,
		const char *	argumentHelp,
		const char *	description,
		uint16_t *	val
	)

Allow user to specify an uint16_t.

Parameters

	shortName	short name of the option
	name	long name of the option
	argumentHelp	help text for the option argument
	description	long help text for the option
[out]	val	set to the value specified at the command line

Definition at line 897 of file getopt_helpers.c.

{
  struct GNUNET_GETOPT_CommandLineOption clo = {
    .shortName = shortName,
    .name = name,
    .argumentHelp = argumentHelp,
    .description = description,
    .require_argument = 1,
    .processor = &set_uint16,
    .scls = (void *) val
  };
 
  return clo;
}

References GNUNET_GETOPT_CommandLineOption::argumentHelp, GNUNET_GETOPT_CommandLineOption::description, name, set_uint16(), and GNUNET_GETOPT_CommandLineOption::shortName.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GNUNET_GETOPT_option_ulong()

struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_ulong	(	char	shortName,
		const char *	name,
		const char *	argumentHelp,
		const char *	description,
		unsigned long long *	val
	)

Allow user to specify an unsigned long long.

Parameters

	shortName	short name of the option
	name	long name of the option
	argumentHelp	help text for the option argument
	description	long help text for the option
[out]	val	set to the value specified at the command line

Definition at line 518 of file getopt_helpers.c.

{
  struct GNUNET_GETOPT_CommandLineOption clo = {
    .shortName = shortName,
    .name = name,
    .argumentHelp = argumentHelp,
    .description = description,
    .require_argument = 1,
    .processor = &set_ulong,
    .scls = (void *) val
  };
 
  return clo;
}

References GNUNET_GETOPT_CommandLineOption::argumentHelp, GNUNET_GETOPT_CommandLineOption::description, name, set_ulong(), and GNUNET_GETOPT_CommandLineOption::shortName.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GNUNET_GETOPT_option_relative_time()

struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_relative_time	(	char	shortName,
		const char *	name,
		const char *	argumentHelp,
		const char *	description,
		struct GNUNET_TIME_Relative *	val
	)

Allow user to specify a struct GNUNET_TIME_Relative (using human-readable "fancy" time).

Parameters

	shortName	short name of the option
	name	long name of the option
	argumentHelp	help text for the option argument
	description	long help text for the option
[out]	val	set to the time specified at the command line

Definition at line 651 of file getopt_helpers.c.

{
  struct GNUNET_GETOPT_CommandLineOption clo = {
    .shortName = shortName,
    .name = name,
    .argumentHelp = argumentHelp,
    .description = description,
    .require_argument = 1,
    .processor = &set_relative_time,
    .scls = (void *) val
  };
 
  return clo;
}

References GNUNET_GETOPT_CommandLineOption::argumentHelp, GNUNET_GETOPT_CommandLineOption::description, name, set_relative_time(), and GNUNET_GETOPT_CommandLineOption::shortName.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GNUNET_GETOPT_option_absolute_time()

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
	)

Allow user to specify a struct GNUNET_TIME_Absolute (using human-readable "fancy" time).

Parameters

	shortName	short name of the option
	name	long name of the option
	argumentHelp	help text for the option argument
	description	long help text for the option
[out]	val	set to the time specified at the command line

Definition at line 705 of file getopt_helpers.c.

{
  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;
}

References GNUNET_GETOPT_CommandLineOption::argumentHelp, GNUNET_GETOPT_CommandLineOption::description, name, set_absolute_time(), and GNUNET_GETOPT_CommandLineOption::shortName.

Here is the call graph for this function:

◆ GNUNET_GETOPT_option_timestamp()

struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_timestamp	(	char	shortName,
		const char *	name,
		const char *	argumentHelp,
		const char *	description,
		struct GNUNET_TIME_Timestamp *	val
	)

Allow user to specify a struct GNUNET_TIME_Timestamp (using human-readable "fancy" time).

Parameters

	shortName	short name of the option
	name	long name of the option
	argumentHelp	help text for the option argument
	description	long help text for the option
[out]	val	set to the time specified at the command line

Definition at line 769 of file getopt_helpers.c.

{
  struct GNUNET_GETOPT_CommandLineOption clo = {
    .shortName = shortName,
    .name = name,
    .argumentHelp = argumentHelp,
    .description = description,
    .require_argument = 1,
    .processor = &set_timestamp,
    .scls = (void *) val
  };
 
  return clo;
}

References GNUNET_GETOPT_CommandLineOption::argumentHelp, GNUNET_GETOPT_CommandLineOption::description, name, set_timestamp(), and GNUNET_GETOPT_CommandLineOption::shortName.

Here is the call graph for this function:

◆ GNUNET_GETOPT_option_increment_uint()

struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_increment_uint	(	char	shortName,
		const char *	name,
		const char *	description,
		unsigned int *	val
	)

Increment val each time the option flag is given by one.

Parameters

	shortName	short name of the option
	name	long name of the option
	description	long help text for the option
[out]	val	set to 1 if the option is present

Definition at line 249 of file getopt_helpers.c.

{
  struct GNUNET_GETOPT_CommandLineOption clo = {
    .shortName = shortName,
    .name = name,
    .description = description,
    .processor = &increment_value,
    .scls = (void *) val
  };
 
  return clo;
}

References GNUNET_GETOPT_CommandLineOption::description, increment_value(), name, and GNUNET_GETOPT_CommandLineOption::shortName.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GNUNET_GETOPT_option_loglevel()

struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_loglevel ( char ** level )

Define the '-L' log level option.

Note that we do not check that the log level is valid here.

Parameters

[out] level set to the log level

Definition at line 383 of file getopt_helpers.c.

{
  struct GNUNET_GETOPT_CommandLineOption clo = {
    .shortName = 'L',
    .name = "log",
    .argumentHelp = "LOGLEVEL",
    .description = gettext_noop ("configure logging to use LOGLEVEL"),
    .require_argument = 1,
    .processor = &set_string,
    .scls = (void *) level
  };
 
  return clo;
}

References gettext_noop, set_string(), and GNUNET_GETOPT_CommandLineOption::shortName.

Referenced by GNUNET_PROGRAM_conf_and_options(), GNUNET_PROGRAM_run2(), GNUNET_SERVICE_run_(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GNUNET_GETOPT_option_verbose()

struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_verbose ( unsigned int * level )

Define the '-V' verbosity option.

Using the option more than once increments level each time.

Parameters

[out] level set to the verbosity level

Definition at line 267 of file getopt_helpers.c.

{
  struct GNUNET_GETOPT_CommandLineOption clo = {
    .shortName = 'V',
    .name = "verbose",
    .description =
      gettext_noop ("be verbose"),
    .processor = &increment_value,
    .scls = (void *) level
  };
 
  return clo;
}

References gettext_noop, increment_value(), and GNUNET_GETOPT_CommandLineOption::shortName.

Referenced by main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GNUNET_GETOPT_option_cfgfile()

struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_cfgfile ( char ** fn )

Allow user to specify configuration file name (-c option)

Parameters

[out] fn set to the name of the configuration file

Definition at line 467 of file getopt_helpers.c.

{
  struct GNUNET_GETOPT_CommandLineOption clo = {
    .shortName = 'c',
    .name = "config",
    .argumentHelp = "FILENAME",
    .description = gettext_noop ("use configuration file FILENAME"),
    .require_argument = 1,
    .processor = &set_filename,
    .scls = (void *) fn
  };
 
  return clo;
}

References gettext_noop, set_filename(), and GNUNET_GETOPT_CommandLineOption::shortName.

Referenced by GNUNET_PROGRAM_conf_and_options(), GNUNET_PROGRAM_run2(), GNUNET_SERVICE_run_(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GNUNET_GETOPT_option_mandatory()

struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_mandatory ( struct GNUNET_GETOPT_CommandLineOption opt )

Make the given option mandatory.

Parameters

opt	option to modify

Returns: opt with the mandatory flag set.

Definition at line 1013 of file getopt_helpers.c.

{
  opt.option_mandatory = 1;
  return opt;
}

References GNUNET_GETOPT_CommandLineOption::option_mandatory.

Referenced by main().

Here is the caller graph for this function:

◆ GNUNET_GETOPT_option_exclusive()

struct GNUNET_GETOPT_CommandLineOption GNUNET_GETOPT_option_exclusive ( struct GNUNET_GETOPT_CommandLineOption opt )

Make the given option mutually exclusive with other options.

Parameters

opt	option to modify

Returns: opt with the exclusive flag set.

Definition at line 1021 of file getopt_helpers.c.

{
  opt.option_exclusive = 1;
  return opt;
}

References GNUNET_GETOPT_CommandLineOption::option_exclusive.

Referenced by main().

Here is the caller graph for this function:

◆ GNUNET_GETOPT_run()

int GNUNET_GETOPT_run	(	const char *	binaryOptions,
		const struct GNUNET_GETOPT_CommandLineOption *	allOptions,
		unsigned int	argc,
		char const	argv
	)

Parse the command line.

Parameters

binaryOptions	Name of application with option summary
allOptions	defined options and handlers
argc	number of arguments in argv
argv	actual arguments

Returns: index into argv with first non-option argument, or GNUNET_SYSERR on error

Definition at line 884 of file getopt.c.

{
  struct GNoption *long_options;
  struct GNUNET_GETOPT_CommandLineProcessorContext clpc;
  int count;
  char *shorts;
  int spos;
  enum GNUNET_GenericReturnValue cont;
  uint8_t *seen;
  unsigned int optmatch = 0;
  const char *have_exclusive = NULL;
 
  GNUNET_assert (argc > 0);
  GNoptind = 0;
  clpc.binaryName = argv[0];
  clpc.binaryOptions = binaryOptions;
  clpc.allOptions = allOptions;
  clpc.argv = argv;
  clpc.argc = argc;
  for (count = 0; NULL != allOptions[count].name; count++)
    ;
 
  /* transform our option representation into the format
     used by the GNU getopt copylib */
  long_options = GNUNET_new_array (count + 1, struct GNoption);
  seen = GNUNET_new_array (count, uint8_t);
  shorts = GNUNET_malloc (count * 2 + 1);
  spos = 0;
  for (unsigned i = 0; i < count; i++)
  {
    long_options[i].name = allOptions[i].name;
    long_options[i].has_arg = allOptions[i].require_argument;
    long_options[i].flag = NULL;
    long_options[i].val = allOptions[i].shortName;
    shorts[spos++] = allOptions[i].shortName;
    if (allOptions[i].require_argument != 0)
      shorts[spos++] = ':';
  }
  long_options[count].name = NULL;
  long_options[count].has_arg = 0;
  long_options[count].flag = NULL;
  long_options[count].val = '\0';
  shorts[spos] = '\0';
  cont = GNUNET_OK;
 
  /* main getopt loop */
  while (1)
  {
    int option_index = 0;
    unsigned int i;
    int c;
 
    c = GNgetopt_long (argc,
                       argv,
                       shorts,
                       long_options,
                       &option_index);
    if (c == GNUNET_SYSERR)
      break;   /* No more flags to process */
 
    /* Check which of our program's options was given by the user */
    for (i = 0; i < count; i++)
    {
      clpc.currentArgument = GNoptind - 1;
      if ((char) c == allOptions[i].shortName)
      {
        optmatch++;
        if (allOptions[i].option_exclusive)
          have_exclusive = allOptions[i].name;
        if (GNUNET_OK == cont)
        {
          /* parse the option using the option-specific processor */
          cont = allOptions[i].processor (&clpc,
                                          allOptions[i].scls,
                                          allOptions[i].name,
                                          GNoptarg);
        }
        seen[i] = 1;
        break;
      }
    }
    if (i == count)
    {
      fprintf (stderr,
               _ ("Use %s to get a list of options.\n"),
               "--help");
      cont = GNUNET_SYSERR;
    }
  }
  GNUNET_free (shorts);
  GNUNET_free (long_options);
 
  /* check that if any option that was marked as exclusive
     is the only option that was provided */
  if ((NULL != have_exclusive) && (optmatch > 1))
  {
    fprintf (stderr,
             _ ("Option `%s' can't be used with other options.\n"),
             have_exclusive);
    cont = GNUNET_SYSERR;
  }
  if (GNUNET_YES == cont)
  {
    /* check that all mandatory options are present */
    for (count = 0; NULL != allOptions[count].name; count++)
    {
      if ((0 == seen[count]) && (allOptions[count].option_mandatory))
      {
        fprintf (stderr,
                 _ ("Missing mandatory option `%s'.\n"),
                 allOptions[count].name);
        cont = GNUNET_SYSERR;
      }
    }
  }
  GNUNET_free (seen);
 
  /* call cleaners, if available */
  for (unsigned int i = 0; NULL != allOptions[i].name; i++)
    if (NULL != allOptions[i].cleaner)
      allOptions[i].cleaner (allOptions[i].scls);
 
  if (GNUNET_OK != cont)
    return cont;
  return GNoptind;
}

Referenced by GNUNET_PROGRAM_conf_and_options(), GNUNET_PROGRAM_run2(), GNUNET_SERVICE_run_(), and main().

Here is the call graph for this function:

Here is the caller graph for this function:

Data Structures

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ GNUNET_GETOPT_option_base32_auto

◆ GNUNET_GETOPT_OPTION_END

Typedef Documentation

◆ GNUNET_GETOPT_CommandLineOptionProcessor

Function Documentation

◆ GNUNET_GETOPT_option_help()

◆ GNUNET_GETOPT_option_timetravel()

◆ GNUNET_GETOPT_option_version()

◆ GNUNET_GETOPT_option_logfile()

◆ GNUNET_GETOPT_option_string()

◆ GNUNET_GETOPT_option_filename()

◆ GNUNET_GETOPT_option_base32_fixed_size()

◆ GNUNET_GETOPT_option_flag()

◆ GNUNET_GETOPT_option_uint()

◆ GNUNET_GETOPT_option_uint16()

◆ GNUNET_GETOPT_option_ulong()

◆ GNUNET_GETOPT_option_relative_time()

◆ GNUNET_GETOPT_option_absolute_time()

◆ GNUNET_GETOPT_option_timestamp()

◆ GNUNET_GETOPT_option_increment_uint()

◆ GNUNET_GETOPT_option_loglevel()

◆ GNUNET_GETOPT_option_verbose()

◆ GNUNET_GETOPT_option_cfgfile()

◆ GNUNET_GETOPT_option_mandatory()

◆ GNUNET_GETOPT_option_exclusive()

◆ GNUNET_GETOPT_run()