2017-09-14 17:40:40 +00:00
/** @file egk-tool-cmdline.h
* @ brief The header file for the command line option parser
2020-03-02 17:22:36 +00:00
* generated by GNU Gengetopt version 2.23
2017-09-14 17:40:40 +00:00
* http : //www.gnu.org/software/gengetopt.
* DO NOT modify this file , since it can be overwritten
2020-03-02 17:22:36 +00:00
* @ author GNU Gengetopt */
2017-09-14 17:40:40 +00:00
# ifndef EGK_TOOL_CMDLINE_H
# define EGK_TOOL_CMDLINE_H
/* If we use autoconf. */
# ifdef HAVE_CONFIG_H
# include "config.h"
# endif
# include <stdio.h> /* for FILE */
# ifdef __cplusplus
extern " C " {
# endif /* __cplusplus */
# ifndef CMDLINE_PARSER_PACKAGE
/** @brief the program name (used for printing errors) */
# define CMDLINE_PARSER_PACKAGE "egk-tool"
# endif
# ifndef CMDLINE_PARSER_PACKAGE_NAME
/** @brief the complete program name (used for help and version) */
# define CMDLINE_PARSER_PACKAGE_NAME "egk-tool"
# endif
# ifndef CMDLINE_PARSER_VERSION
/** @brief the program version */
# define CMDLINE_PARSER_VERSION VERSION
# endif
/** @brief Where the command line options are stored */
struct gengetopt_args_info
{
const char * help_help ; /**< @brief Print help and exit help description. */
const char * version_help ; /**< @brief Print version and exit help description. */
2020-04-22 14:32:08 +00:00
char * reader_arg ; /**< @brief Number of the reader to use. By default, the first reader with a present card is used. If the argument is an ATR, the reader with a matching card will be chosen.. */
char * reader_orig ; /**< @brief Number of the reader to use. By default, the first reader with a present card is used. If the argument is an ATR, the reader with a matching card will be chosen. original value given at command line. */
const char * reader_help ; /**< @brief Number of the reader to use. By default, the first reader with a present card is used. If the argument is an ATR, the reader with a matching card will be chosen. help description. */
2018-05-21 18:57:13 +00:00
unsigned int verbose_min ; /**< @brief Use (several times) to be more verbose's minimum occurreces */
unsigned int verbose_max ; /**< @brief Use (several times) to be more verbose's maximum occurreces */
2017-09-14 17:40:40 +00:00
const char * verbose_help ; /**< @brief Use (several times) to be more verbose help description. */
int pd_flag ; /**< @brief Show 'Persönliche Versicherungsdaten' (XML) (default=off). */
const char * pd_help ; /**< @brief Show 'Persönliche Versicherungsdaten' (XML) help description. */
int vd_flag ; /**< @brief Show 'Allgemeine Versicherungsdaten' (XML) (default=off). */
const char * vd_help ; /**< @brief Show 'Allgemeine Versicherungsdaten' (XML) help description. */
int gvd_flag ; /**< @brief Show 'Geschützte Versicherungsdaten' (XML) (default=off). */
const char * gvd_help ; /**< @brief Show 'Geschützte Versicherungsdaten' (XML) help description. */
int vsd_status_flag ; /**< @brief Show 'Versichertenstammdaten-Status' (default=off). */
const char * vsd_status_help ; /**< @brief Show 'Versichertenstammdaten-Status' help description. */
unsigned int help_given ; /**< @brief Whether help was given. */
unsigned int version_given ; /**< @brief Whether version was given. */
unsigned int reader_given ; /**< @brief Whether reader was given. */
unsigned int verbose_given ; /**< @brief Whether verbose was given. */
unsigned int pd_given ; /**< @brief Whether pd was given. */
unsigned int vd_given ; /**< @brief Whether vd was given. */
unsigned int gvd_given ; /**< @brief Whether gvd was given. */
unsigned int vsd_status_given ; /**< @brief Whether vsd-status was given. */
} ;
/** @brief The additional parameters to pass to parser functions */
struct cmdline_parser_params
{
int override ; /**< @brief whether to override possibly already present options (default 0) */
int initialize ; /**< @brief whether to initialize the option structure gengetopt_args_info (default 1) */
int check_required ; /**< @brief whether to check that all required options were provided (default 1) */
int check_ambiguity ; /**< @brief whether to check for options already specified in the option structure gengetopt_args_info (default 0) */
int print_errors ; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */
} ;
/** @brief the purpose string of the program */
extern const char * gengetopt_args_info_purpose ;
/** @brief the usage string of the program */
extern const char * gengetopt_args_info_usage ;
/** @brief the description string of the program */
extern const char * gengetopt_args_info_description ;
/** @brief all the lines making the help output */
extern const char * gengetopt_args_info_help [ ] ;
/**
* The command line parser
* @ param argc the number of command line options
* @ param argv the command line options
* @ param args_info the structure where option information will be stored
* @ return 0 if everything went fine , NON 0 if an error took place
*/
int cmdline_parser ( int argc , char * * argv ,
struct gengetopt_args_info * args_info ) ;
/**
* The command line parser ( version with additional parameters - deprecated )
* @ param argc the number of command line options
* @ param argv the command line options
* @ param args_info the structure where option information will be stored
* @ param override whether to override possibly already present options
* @ param initialize whether to initialize the option structure my_args_info
* @ param check_required whether to check that all required options were provided
* @ return 0 if everything went fine , NON 0 if an error took place
* @ deprecated use cmdline_parser_ext ( ) instead
*/
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 )
* @ param argc the number of command line options
* @ param argv the command line options
* @ param args_info the structure where option information will be stored
* @ param params additional parameters for the parser
* @ return 0 if everything went fine , NON 0 if an error took place
*/
int cmdline_parser_ext ( int argc , char * * argv ,
struct gengetopt_args_info * args_info ,
struct cmdline_parser_params * params ) ;
/**
* Save the contents of the option struct into an already open FILE stream .
* @ param outfile the stream where to dump options
* @ param args_info the option struct to dump
* @ return 0 if everything went fine , NON 0 if an error took place
*/
int cmdline_parser_dump ( FILE * outfile ,
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 )
* @ param filename the file where to save
* @ param args_info the option struct to save
* @ return 0 if everything went fine , NON 0 if an error took place
*/
int cmdline_parser_file_save ( const char * filename ,
struct gengetopt_args_info * args_info ) ;
/**
* Print the help
*/
void cmdline_parser_print_help ( void ) ;
/**
* Print the version
*/
void cmdline_parser_print_version ( void ) ;
/**
* Initializes all the fields a cmdline_parser_params structure
* to their default values
* @ param params the structure to initialize
*/
void cmdline_parser_params_init ( struct cmdline_parser_params * params ) ;
/**
* Allocates dynamically a cmdline_parser_params structure and initializes
* all its fields to their default values
* @ return the created and initialized cmdline_parser_params structure
*/
struct cmdline_parser_params * cmdline_parser_params_create ( void ) ;
/**
* Initializes the passed gengetopt_args_info structure ' s fields
* ( also set default values for options that have a default )
* @ param args_info the structure to initialize
*/
void cmdline_parser_init ( struct gengetopt_args_info * args_info ) ;
/**
* Deallocates the string fields of the gengetopt_args_info structure
* ( but does not deallocate the structure itself )
* @ param args_info the structure to deallocate
*/
void cmdline_parser_free ( struct gengetopt_args_info * args_info ) ;
/**
* Checks that all the required options were specified
* @ param args_info the structure to check
* @ param prog_name the name of the program that will be used to print
* possible errors
* @ return
*/
int cmdline_parser_required ( struct gengetopt_args_info * args_info ,
const char * prog_name ) ;
# ifdef __cplusplus
}
# endif /* __cplusplus */
# endif /* EGK_TOOL_CMDLINE_H */