vv/tools_ggo/clitkProfileImage_ggo.h

   1 /** @file clitkProfileImage_ggo.h
   2  *  @brief The header file for the command line option parser
   3  *  generated by GNU Gengetopt version 2.22
   4  *  http://www.gnu.org/software/gengetopt.
   5  *  DO NOT modify this file, since it can be overwritten
   6  *  @author GNU Gengetopt by Lorenzo Bettini */
   7
   8 #ifndef CLITKPROFILEIMAGE_GGO_H
   9 #define CLITKPROFILEIMAGE_GGO_H
  10
  11 /* If we use autoconf.  */
  12 #ifdef HAVE_CONFIG_H
  13 #include "config.h"
  14 #endif
  15
  16 #include <stdio.h> /* for FILE */
  17
  18 #ifdef __cplusplus
  19 extern "C" {
  20 #endif /* __cplusplus */
  21
  22 #ifndef CMDLINE_PARSER_CLITKPROFILEIMAGE_PACKAGE
  23 /** @brief the program name */
  24 #define CMDLINE_PARSER_CLITKPROFILEIMAGE_PACKAGE "clitkProfileImage"
  25 #endif
  26
  27 #ifndef CMDLINE_PARSER_CLITKPROFILEIMAGE_VERSION
  28 /** @brief the program version */
  29 #define CMDLINE_PARSER_CLITKPROFILEIMAGE_VERSION "1.0"
  30 #endif
  31
  32 /** @brief Where the command line options are stored */
  33 struct args_info_clitkProfileImage
  34 {
  35   const char *help_help; /**< @brief Print help and exit help description.  */
  36   const char *version_help; /**< @brief Print version and exit help description.  */
  37   char * config_arg;    /**< @brief Config file.  */
  38   char * config_orig;   /**< @brief Config file original value given at command line.  */
  39   const char *config_help; /**< @brief Config file help description.  */
  40   int verbose_flag;     /**< @brief Verbose (default=off).  */
  41   const char *verbose_help; /**< @brief Verbose help description.  */
  42   int imagetypes_flag;  /**< @brief Display allowed image types (default=off).  */
  43   const char *imagetypes_help; /**< @brief Display allowed image types help description.  */
  44   char * input_arg;     /**< @brief Input image filename.  */
  45   char * input_orig;    /**< @brief Input image filename original value given at command line.  */
  46   const char *input_help; /**< @brief Input image filename help description.  */
  47   char * output_arg;    /**< @brief Output texte filename.  */
  48   char * output_orig;   /**< @brief Output texte filename original value given at command line.  */
  49   const char *output_help; /**< @brief Output texte filename help description.  */
  50   double* point1_arg;   /**< @brief First point (mm).  */
  51   char ** point1_orig;  /**< @brief First point (mm) original value given at command line.  */
  52   int point1_min; /**< @brief First point (mm)'s minimum occurreces */
  53   int point1_max; /**< @brief First point (mm)'s maximum occurreces */
  54   const char *point1_help; /**< @brief First point (mm) help description.  */
  55   double* point2_arg;   /**< @brief Second point (mm).  */
  56   char ** point2_orig;  /**< @brief Second point (mm) original value given at command line.  */
  57   int point2_min; /**< @brief Second point (mm)'s minimum occurreces */
  58   int point2_max; /**< @brief Second point (mm)'s maximum occurreces */
  59   const char *point2_help; /**< @brief Second point (mm) help description.  */
  60
  61   unsigned int help_given ;     /**< @brief Whether help was given.  */
  62   unsigned int version_given ;  /**< @brief Whether version was given.  */
  63   unsigned int config_given ;   /**< @brief Whether config was given.  */
  64   unsigned int verbose_given ;  /**< @brief Whether verbose was given.  */
  65   unsigned int imagetypes_given ;       /**< @brief Whether imagetypes was given.  */
  66   unsigned int input_given ;    /**< @brief Whether input was given.  */
  67   unsigned int output_given ;   /**< @brief Whether output was given.  */
  68   unsigned int point1_given ;   /**< @brief Whether point1 was given.  */
  69   unsigned int point2_given ;   /**< @brief Whether point2 was given.  */
  70
  71   char **inputs ; /**< @brief unamed options (options without names) */
  72   unsigned inputs_num ; /**< @brief unamed options number */
  73 } ;
  74
  75 /** @brief The additional parameters to pass to parser functions */
  76 struct cmdline_parser_clitkProfileImage_params
  77 {
  78   int override; /**< @brief whether to override possibly already present options (default 0) */
  79   int initialize; /**< @brief whether to initialize the option structure args_info_clitkProfileImage (default 1) */
  80   int check_required; /**< @brief whether to check that all required options were provided (default 1) */
  81   int check_ambiguity; /**< @brief whether to check for options already specified in the option structure args_info_clitkProfileImage (default 0) */
  82   int print_errors; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */
  83 } ;
  84
  85 /** @brief the purpose string of the program */
  86 extern const char *args_info_clitkProfileImage_purpose;
  87 /** @brief the usage string of the program */
  88 extern const char *args_info_clitkProfileImage_usage;
  89 /** @brief all the lines making the help output */
  90 extern const char *args_info_clitkProfileImage_help[];
  91
  92 /**
  93  * The command line parser
  94  * @param argc the number of command line options
  95  * @param argv the command line options
  96  * @param args_info the structure where option information will be stored
  97  * @return 0 if everything went fine, NON 0 if an error took place
  98  */
  99 int cmdline_parser_clitkProfileImage (int argc, char * const *argv,
 100   struct args_info_clitkProfileImage *args_info);
 101
 102 /**
 103  * The command line parser (version with additional parameters - deprecated)
 104  * @param argc the number of command line options
 105  * @param argv the command line options
 106  * @param args_info the structure where option information will be stored
 107  * @param override whether to override possibly already present options
 108  * @param initialize whether to initialize the option structure my_args_info
 109  * @param check_required whether to check that all required options were provided
 110  * @return 0 if everything went fine, NON 0 if an error took place
 111  * @deprecated use cmdline_parser_clitkProfileImage_ext() instead
 112  */
 113 int cmdline_parser_clitkProfileImage2 (int argc, char * const *argv,
 114   struct args_info_clitkProfileImage *args_info,
 115   int override, int initialize, int check_required);
 116
 117 /**
 118  * The command line parser (version with additional parameters)
 119  * @param argc the number of command line options
 120  * @param argv the command line options
 121  * @param args_info the structure where option information will be stored
 122  * @param params additional parameters for the parser
 123  * @return 0 if everything went fine, NON 0 if an error took place
 124  */
 125 int cmdline_parser_clitkProfileImage_ext (int argc, char * const *argv,
 126   struct args_info_clitkProfileImage *args_info,
 127   struct cmdline_parser_clitkProfileImage_params *params);
 128
 129 /**
 130  * Save the contents of the option struct into an already open FILE stream.
 131  * @param outfile the stream where to dump options
 132  * @param args_info the option struct to dump
 133  * @return 0 if everything went fine, NON 0 if an error took place
 134  */
 135 int cmdline_parser_clitkProfileImage_dump(FILE *outfile,
 136   struct args_info_clitkProfileImage *args_info);
 137
 138 /**
 139  * Save the contents of the option struct into a (text) file.
 140  * This file can be read by the config file parser (if generated by gengetopt)
 141  * @param filename the file where to save
 142  * @param args_info the option struct to save
 143  * @return 0 if everything went fine, NON 0 if an error took place
 144  */
 145 int cmdline_parser_clitkProfileImage_file_save(const char *filename,
 146   struct args_info_clitkProfileImage *args_info);
 147
 148 /**
 149  * Print the help
 150  */
 151 void cmdline_parser_clitkProfileImage_print_help(void);
 152 /**
 153  * Print the version
 154  */
 155 void cmdline_parser_clitkProfileImage_print_version(void);
 156
 157 /**
 158  * Initializes all the fields a cmdline_parser_clitkProfileImage_params structure
 159  * to their default values
 160  * @param params the structure to initialize
 161  */
 162 void cmdline_parser_clitkProfileImage_params_init(struct cmdline_parser_clitkProfileImage_params *params);
 163
 164 /**
 165  * Allocates dynamically a cmdline_parser_clitkProfileImage_params structure and initializes
 166  * all its fields to their default values
 167  * @return the created and initialized cmdline_parser_clitkProfileImage_params structure
 168  */
 169 struct cmdline_parser_clitkProfileImage_params *cmdline_parser_clitkProfileImage_params_create(void);
 170
 171 /**
 172  * Initializes the passed args_info_clitkProfileImage structure's fields
 173  * (also set default values for options that have a default)
 174  * @param args_info the structure to initialize
 175  */
 176 void cmdline_parser_clitkProfileImage_init (struct args_info_clitkProfileImage *args_info);
 177 /**
 178  * Deallocates the string fields of the args_info_clitkProfileImage structure
 179  * (but does not deallocate the structure itself)
 180  * @param args_info the structure to deallocate
 181  */
 182 void cmdline_parser_clitkProfileImage_free (struct args_info_clitkProfileImage *args_info);
 183
 184 /**
 185  * The config file parser (deprecated version)
 186  * @param filename the name of the config file
 187  * @param args_info the structure where option information will be stored
 188  * @param override whether to override possibly already present options
 189  * @param initialize whether to initialize the option structure my_args_info
 190  * @param check_required whether to check that all required options were provided
 191  * @return 0 if everything went fine, NON 0 if an error took place
 192  * @deprecated use cmdline_parser_clitkProfileImage_config_file() instead
 193  */
 194 int cmdline_parser_clitkProfileImage_configfile (char * const filename,
 195   struct args_info_clitkProfileImage *args_info,
 196   int override, int initialize, int check_required);
 197
 198 /**
 199  * The config file parser
 200  * @param filename the name of the config file
 201  * @param args_info the structure where option information will be stored
 202  * @param params additional parameters for the parser
 203  * @return 0 if everything went fine, NON 0 if an error took place
 204  */
 205 int cmdline_parser_clitkProfileImage_config_file (char * const filename,
 206   struct args_info_clitkProfileImage *args_info,
 207   struct cmdline_parser_clitkProfileImage_params *params);
 208
 209 /**
 210  * Checks that all the required options were specified
 211  * @param args_info the structure to check
 212  * @param prog_name the name of the program that will be used to print
 213  *   possible errors
 214  * @return
 215  */
 216 int cmdline_parser_clitkProfileImage_required (struct args_info_clitkProfileImage *args_info,
 217   const char *prog_name);
 218
 219
 220 #ifdef __cplusplus
 221 }
 222 #endif /* __cplusplus */
 223 #endif /* CLITKPROFILEIMAGE_GGO_H */