Definition of a command line option. More...
#include <gnunet_getopt_lib.h>
Data Fields | |
const char | shortName |
Short name of the option. More... | |
const char * | name |
Long name of the option (may not be NULL) More... | |
const char * | argumentHelp |
Name of the argument for the user in help text. More... | |
const char * | description |
Help text for the option (description) More... | |
int | require_argument |
Is an argument required? GNUNET_NO (includes optional) or GNUNET_YES (required) More... | |
int | option_mandatory |
Is the presence of this option mandatory? More... | |
int | option_exclusive |
Is the option exclusive? More... | |
GNUNET_GETOPT_CommandLineOptionProcessor | processor |
Handler for the option. More... | |
void(* | cleaner )(void *cls) |
Function to call on scls to clean up after processing all the arguments. More... | |
void * | scls |
Specific closure to pass to the processor. More... | |
Definition of a command line option.
Definition at line 109 of file gnunet_getopt_lib.h.
const char GNUNET_GETOPT_CommandLineOption::shortName |
Short name of the option.
Definition at line 114 of file gnunet_getopt_lib.h.
Referenced by cmd_sorter(), GNUNET_FS_GETOPT_KEYWORDS(), GNUNET_FS_GETOPT_METADATA(), GNUNET_GETOPT_option_absolute_time(), GNUNET_GETOPT_option_base32_fixed_size(), GNUNET_GETOPT_option_cfgfile(), GNUNET_GETOPT_option_filename(), GNUNET_GETOPT_option_flag(), GNUNET_GETOPT_option_help(), GNUNET_GETOPT_option_increment_uint(), GNUNET_GETOPT_option_logfile(), GNUNET_GETOPT_option_loglevel(), GNUNET_GETOPT_option_relative_time(), GNUNET_GETOPT_option_string(), GNUNET_GETOPT_option_timestamp(), GNUNET_GETOPT_option_timetravel(), GNUNET_GETOPT_option_uint(), GNUNET_GETOPT_option_uint16(), GNUNET_GETOPT_option_ulong(), GNUNET_GETOPT_option_verbose(), GNUNET_GETOPT_option_version(), GNUNET_GETOPT_run(), GNUNET_JSON_getopt(), and GNUNET_PROGRAM_run2().
const char* GNUNET_GETOPT_CommandLineOption::name |
Long name of the option (may not be NULL)
Definition at line 119 of file gnunet_getopt_lib.h.
Referenced by GNUNET_GETOPT_run(), and GNUNET_PROGRAM_run2().
const char* GNUNET_GETOPT_CommandLineOption::argumentHelp |
Name of the argument for the user in help text.
Definition at line 124 of file gnunet_getopt_lib.h.
Referenced by GNUNET_FS_GETOPT_KEYWORDS(), GNUNET_FS_GETOPT_METADATA(), GNUNET_GETOPT_option_absolute_time(), GNUNET_GETOPT_option_base32_fixed_size(), GNUNET_GETOPT_option_filename(), GNUNET_GETOPT_option_relative_time(), GNUNET_GETOPT_option_string(), GNUNET_GETOPT_option_timestamp(), GNUNET_GETOPT_option_uint(), GNUNET_GETOPT_option_uint16(), GNUNET_GETOPT_option_ulong(), and GNUNET_JSON_getopt().
const char* GNUNET_GETOPT_CommandLineOption::description |
Help text for the option (description)
Definition at line 129 of file gnunet_getopt_lib.h.
Referenced by GNUNET_FS_GETOPT_KEYWORDS(), GNUNET_FS_GETOPT_METADATA(), GNUNET_GETOPT_option_absolute_time(), GNUNET_GETOPT_option_base32_fixed_size(), GNUNET_GETOPT_option_filename(), GNUNET_GETOPT_option_flag(), GNUNET_GETOPT_option_increment_uint(), GNUNET_GETOPT_option_relative_time(), GNUNET_GETOPT_option_string(), GNUNET_GETOPT_option_timestamp(), GNUNET_GETOPT_option_uint(), GNUNET_GETOPT_option_uint16(), GNUNET_GETOPT_option_ulong(), GNUNET_JSON_getopt(), and main().
int GNUNET_GETOPT_CommandLineOption::require_argument |
Is an argument required? GNUNET_NO (includes optional) or GNUNET_YES (required)
Definition at line 135 of file gnunet_getopt_lib.h.
Referenced by GNUNET_GETOPT_run().
int GNUNET_GETOPT_CommandLineOption::option_mandatory |
Is the presence of this option mandatory?
Definition at line 140 of file gnunet_getopt_lib.h.
Referenced by GNUNET_GETOPT_option_mandatory().
int GNUNET_GETOPT_CommandLineOption::option_exclusive |
Is the option exclusive?
Definition at line 145 of file gnunet_getopt_lib.h.
Referenced by GNUNET_GETOPT_option_exclusive().
GNUNET_GETOPT_CommandLineOptionProcessor GNUNET_GETOPT_CommandLineOption::processor |
Handler for the option.
Definition at line 150 of file gnunet_getopt_lib.h.
Referenced by GNUNET_GETOPT_run().
void(* GNUNET_GETOPT_CommandLineOption::cleaner) (void *cls) |
Function to call on scls to clean up after processing all the arguments.
Can be NULL.
Definition at line 156 of file gnunet_getopt_lib.h.
Referenced by GNUNET_GETOPT_run().
void* GNUNET_GETOPT_CommandLineOption::scls |
Specific closure to pass to the processor.
Definition at line 161 of file gnunet_getopt_lib.h.
Referenced by format_help(), increment_value(), set_filename(), set_one(), set_string(), set_uint(), set_uint16(), and set_ulong().