Macros | |
#define | FIX_UNUSED(X) (void) (X) /* avoid warnings for unused params */ |
Enumerations | |
enum | cmdline_parser_arg_type { ARG_NO , ARG_FLAG , ARG_STRING , ARG_INT , ARG_NO , ARG_FLAG , ARG_STRING , ARG_INT , ARG_NO , ARG_FLAG , ARG_STRING , ARG_INT } |
Functions | |
void | cmdline_parser_print_version (void) |
void | cmdline_parser_print_help (void) |
void | cmdline_parser_init (struct gengetopt_args_info *args_info) |
void | cmdline_parser_params_init (struct cmdline_parser_params *params) |
struct cmdline_parser_params * | cmdline_parser_params_create (void) |
int | cmdline_parser_dump (FILE *outfile, struct gengetopt_args_info *args_info) |
int | cmdline_parser_file_save (const char *filename, struct gengetopt_args_info *args_info) |
void | cmdline_parser_free (struct gengetopt_args_info *args_info) |
int | cmdline_parser (int argc, char **argv, struct gengetopt_args_info *args_info) |
int | cmdline_parser_ext (int argc, char **argv, struct gengetopt_args_info *args_info, struct cmdline_parser_params *params) |
int | cmdline_parser2 (int argc, char **argv, struct gengetopt_args_info *args_info, int override, int initialize, int check_required) |
int | cmdline_parser_required (struct gengetopt_args_info *args_info, const char *prog_name) |
Variables | |
const char * | gengetopt_args_info_purpose = "" |
the purpose string of the program More... | |
const char * | gengetopt_args_info_usage = "Usage: janus [OPTION]..." |
the usage string of the program More... | |
const char * | gengetopt_args_info_versiontext = "" |
const char * | gengetopt_args_info_description = "" |
the description string of the program More... | |
const char * | gengetopt_args_info_help [] |
all the lines making the help output More... | |
#define FIX_UNUSED | ( | X | ) | (void) (X) /* avoid warnings for unused params */ |
int cmdline_parser | ( | int | argc, |
char ** | argv, | ||
struct gengetopt_args_info * | args_info | ||
) |
The command line parser
argc | the number of command line options |
argv | the command line options |
args_info | the structure where option information will be stored |
int cmdline_parser2 | ( | int | argc, |
char ** | argv, | ||
struct gengetopt_args_info * | args_info, | ||
int | override, | ||
int | initialize, | ||
int | check_required | ||
) |
The command line parser (version with additional parameters - deprecated)
argc | the number of command line options |
argv | the command line options |
args_info | the structure where option information will be stored |
override | whether to override possibly already present options |
initialize | whether to initialize the option structure my_args_info |
check_required | whether to check that all required options were provided |
int cmdline_parser_dump | ( | FILE * | outfile, |
struct gengetopt_args_info * | args_info | ||
) |
Save the contents of the option struct into an already open FILE stream.
outfile | the stream where to dump options |
args_info | the option struct to dump |
int cmdline_parser_ext | ( | int | argc, |
char ** | argv, | ||
struct gengetopt_args_info * | args_info, | ||
struct cmdline_parser_params * | params | ||
) |
The command line parser (version with additional parameters)
argc | the number of command line options |
argv | the command line options |
args_info | the structure where option information will be stored |
params | additional parameters for the parser |
int cmdline_parser_file_save | ( | const char * | filename, |
struct gengetopt_args_info * | args_info | ||
) |
Save the contents of the option struct into a (text) file. This file can be read by the config file parser (if generated by gengetopt)
filename | the file where to save |
args_info | the option struct to save |
void cmdline_parser_free | ( | struct gengetopt_args_info * | args_info | ) |
Deallocates the string fields of the gengetopt_args_info structure (but does not deallocate the structure itself)
args_info | the structure to deallocate |
void cmdline_parser_init | ( | struct gengetopt_args_info * | args_info | ) |
Initializes the passed gengetopt_args_info structure's fields (also set default values for options that have a default)
args_info | the structure to initialize |
struct cmdline_parser_params * cmdline_parser_params_create | ( | void | ) |
Allocates dynamically a cmdline_parser_params structure and initializes all its fields to their default values
void cmdline_parser_params_init | ( | struct cmdline_parser_params * | params | ) |
Initializes all the fields a cmdline_parser_params structure to their default values
params | the structure to initialize |
void cmdline_parser_print_help | ( | void | ) |
Print the help
void cmdline_parser_print_version | ( | void | ) |
Print the version
int cmdline_parser_required | ( | struct gengetopt_args_info * | args_info, |
const char * | prog_name | ||
) |
Checks that all the required options were specified
args_info | the structure to check |
prog_name | the name of the program that will be used to print possible errors |
const char* gengetopt_args_info_description = "" |
the description string of the program
const char* gengetopt_args_info_help[] |
all the lines making the help output
const char* gengetopt_args_info_purpose = "" |
the purpose string of the program
const char* gengetopt_args_info_usage = "Usage: janus [OPTION]..." |
the usage string of the program
const char* gengetopt_args_info_versiontext = "" |