apps/transop-ewald/transop_ewald_cmdline.h

   1 /** @file transop_ewald_cmdline.h
   2  *  @brief The header file for the command line option parser
   3  *  generated by GNU Gengetopt version 2.22.6
   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 TRANSOP_EWALD_CMDLINE_H
   9 #define TRANSOP_EWALD_CMDLINE_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_PACKAGE
  23 /** @brief the program name (used for printing errors) */
  24 #define CMDLINE_PARSER_PACKAGE "qpms-translations-ewald32"
  25 #endif
  26
  27 #ifndef CMDLINE_PARSER_PACKAGE_NAME
  28 /** @brief the complete program name (used for help and version) */
  29 #define CMDLINE_PARSER_PACKAGE_NAME "qpms-translations-ewald32"
  30 #endif
  31
  32 #ifndef CMDLINE_PARSER_VERSION
  33 /** @brief the program version */
  34 #define CMDLINE_PARSER_VERSION "dev"
  35 #endif
  36
  37 enum enum_normalisation { normalisation__NULL = -1, normalisation_arg_Power = 0, normalisation_arg_None, normalisation_arg_SH };
  38 enum enum_frequency_unit { frequency_unit__NULL = -1, frequency_unit_arg_eV = 0, frequency_unit_arg_scuff };
  39
  40 /** @brief Where the command line options are stored */
  41 struct gengetopt_args_info
  42 {
  43   const char *help_help; /**< @brief Print help and exit help description.  */
  44   const char *detailed_help_help; /**< @brief Print help, including all details and hidden options, and exit help description.  */
  45   const char *version_help; /**< @brief Print version and exit help description.  */
  46   char * output_arg;    /**< @brief Output file (default='').  */
  47   char * output_orig;   /**< @brief Output file original value given at command line.  */
  48   const char *output_help; /**< @brief Output file help description.  */
  49   char ** base_vector_arg;      /**< @brief Base vector.  */
  50   char ** base_vector_orig;     /**< @brief Base vector original value given at command line.  */
  51   unsigned int base_vector_min; /**< @brief Base vector's minimum occurreces */
  52   unsigned int base_vector_max; /**< @brief Base vector's maximum occurreces */
  53   const char *base_vector_help; /**< @brief Base vector help description.  */
  54   char * error_estimate_output_arg;     /**< @brief Path to the output with error estimates.  */
  55   char * error_estimate_output_orig;    /**< @brief Path to the output with error estimates original value given at command line.  */
  56   const char *error_estimate_output_help; /**< @brief Path to the output with error estimates help description.  */
  57   enum enum_normalisation normalisation_arg;    /**< @brief VSWF normalisation convention (default='Power').  */
  58   char * normalisation_orig;    /**< @brief VSWF normalisation convention original value given at command line.  */
  59   const char *normalisation_help; /**< @brief VSWF normalisation convention help description.  */
  60   int csphase_arg;      /**< @brief Whether the Condon-Shortley phase is included in VSWF definition (-1) or not (+1) (default='-1').  */
  61   char * csphase_orig;  /**< @brief Whether the Condon-Shortley phase is included in VSWF definition (-1) or not (+1) original value given at command line.  */
  62   const char *csphase_help; /**< @brief Whether the Condon-Shortley phase is included in VSWF definition (-1) or not (+1) help description.  */
  63   double Ewald_parameter_arg;   /**< @brief The value of Ewald parameter η.  */
  64   char * Ewald_parameter_orig;  /**< @brief The value of Ewald parameter η original value given at command line.  */
  65   const char *Ewald_parameter_help; /**< @brief The value of Ewald parameter η help description.  */
  66   enum enum_frequency_unit frequency_unit_arg;  /**< @brief Specifies the frequency unit is used for inputs. (default='scuff').  */
  67   char * frequency_unit_orig;   /**< @brief Specifies the frequency unit is used for inputs. original value given at command line.  */
  68   const char *frequency_unit_help; /**< @brief Specifies the frequency unit is used for inputs. help description.  */
  69   int lMax_arg; /**< @brief Maximum spherical multipole order to which the translation operator elements are calculated.  */
  70   char * lMax_orig;     /**< @brief Maximum spherical multipole order to which the translation operator elements are calculated original value given at command line.  */
  71   const char *lMax_help; /**< @brief Maximum spherical multipole order to which the translation operator elements are calculated help description.  */
  72   double refractive_index_arg;  /**< @brief Medium refractive index.  */
  73   char * refractive_index_orig; /**< @brief Medium refractive index original value given at command line.  */
  74   const char *refractive_index_help; /**< @brief Medium refractive index help description.  */
  75   char ** particle_arg; /**< @brief Specify the x and y coordinates of a single particle; If not specified, one particle per unit cell is assumed..  */
  76   char ** particle_orig;        /**< @brief Specify the x and y coordinates of a single particle; If not specified, one particle per unit cell is assumed. original value given at command line.  */
  77   unsigned int particle_min; /**< @brief Specify the x and y coordinates of a single particle; If not specified, one particle per unit cell is assumed.'s minimum occurreces */
  78   unsigned int particle_max; /**< @brief Specify the x and y coordinates of a single particle; If not specified, one particle per unit cell is assumed.'s maximum occurreces */
  79   const char *particle_help; /**< @brief Specify the x and y coordinates of a single particle; If not specified, one particle per unit cell is assumed. help description.  */
  80   char ** pointfile_arg;        /**< @brief Path to a file containing frequency, k_x, k_y triples(separated by white spaces). If not specified, read them from stdin. (default='-').  */
  81   char ** pointfile_orig;       /**< @brief Path to a file containing frequency, k_x, k_y triples(separated by white spaces). If not specified, read them from stdin. original value given at command line.  */
  82   unsigned int pointfile_min; /**< @brief Path to a file containing frequency, k_x, k_y triples(separated by white spaces). If not specified, read them from stdin.'s minimum occurreces */
  83   unsigned int pointfile_max; /**< @brief Path to a file containing frequency, k_x, k_y triples(separated by white spaces). If not specified, read them from stdin.'s maximum occurreces */
  84   const char *pointfile_help; /**< @brief Path to a file containing frequency, k_x, k_y triples(separated by white spaces). If not specified, read them from stdin. help description.  */
  85   char ** point_arg;    /**< @brief Specifies a frequency, k_x, k_y triple, separated by commas..  */
  86   char ** point_orig;   /**< @brief Specifies a frequency, k_x, k_y triple, separated by commas. original value given at command line.  */
  87   unsigned int point_min; /**< @brief Specifies a frequency, k_x, k_y triple, separated by commas.'s minimum occurreces */
  88   unsigned int point_max; /**< @brief Specifies a frequency, k_x, k_y triple, separated by commas.'s maximum occurreces */
  89   const char *point_help; /**< @brief Specifies a frequency, k_x, k_y triple, separated by commas. help description.  */
  90   char ** omegafile_arg;        /**< @brief Path to a file containing a list of frequenciesseparated by whitespaces..  */
  91   char ** omegafile_orig;       /**< @brief Path to a file containing a list of frequenciesseparated by whitespaces. original value given at command line.  */
  92   unsigned int omegafile_min; /**< @brief Path to a file containing a list of frequenciesseparated by whitespaces.'s minimum occurreces */
  93   unsigned int omegafile_max; /**< @brief Path to a file containing a list of frequenciesseparated by whitespaces.'s maximum occurreces */
  94   const char *omegafile_help; /**< @brief Path to a file containing a list of frequenciesseparated by whitespaces. help description.  */
  95   char ** omega_arg;    /**< @brief Specifies frequency (or multiple frequencies separated by commas) on the command line..  */
  96   char ** omega_orig;   /**< @brief Specifies frequency (or multiple frequencies separated by commas) on the command line. original value given at command line.  */
  97   unsigned int omega_min; /**< @brief Specifies frequency (or multiple frequencies separated by commas) on the command line.'s minimum occurreces */
  98   unsigned int omega_max; /**< @brief Specifies frequency (or multiple frequencies separated by commas) on the command line.'s maximum occurreces */
  99   const char *omega_help; /**< @brief Specifies frequency (or multiple frequencies separated by commas) on the command line. help description.  */
 100   char ** kfile_arg;    /**< @brief Path to a file containing a list of k_x, k_y pairs. (default='-').  */
 101   char ** kfile_orig;   /**< @brief Path to a file containing a list of k_x, k_y pairs. original value given at command line.  */
 102   unsigned int kfile_min; /**< @brief Path to a file containing a list of k_x, k_y pairs.'s minimum occurreces */
 103   unsigned int kfile_max; /**< @brief Path to a file containing a list of k_x, k_y pairs.'s maximum occurreces */
 104   const char *kfile_help; /**< @brief Path to a file containing a list of k_x, k_y pairs. help description.  */
 105   char ** k_arg;        /**< @brief Specifies pair(s) of k_x, k_y values.  */
 106   char ** k_orig;       /**< @brief Specifies pair(s) of k_x, k_y values original value given at command line.  */
 107   unsigned int k_min; /**< @brief Specifies pair(s) of k_x, k_y values's minimum occurreces */
 108   unsigned int k_max; /**< @brief Specifies pair(s) of k_x, k_y values's maximum occurreces */
 109   const char *k_help; /**< @brief Specifies pair(s) of k_x, k_y values help description.  */
 110
 111   unsigned int help_given ;     /**< @brief Whether help was given.  */
 112   unsigned int detailed_help_given ;    /**< @brief Whether detailed-help was given.  */
 113   unsigned int version_given ;  /**< @brief Whether version was given.  */
 114   unsigned int output_given ;   /**< @brief Whether output was given.  */
 115   unsigned int base_vector_given ;      /**< @brief Whether base-vector was given.  */
 116   unsigned int error_estimate_output_given ;    /**< @brief Whether error-estimate-output was given.  */
 117   unsigned int normalisation_given ;    /**< @brief Whether normalisation was given.  */
 118   unsigned int csphase_given ;  /**< @brief Whether csphase was given.  */
 119   unsigned int Ewald_parameter_given ;  /**< @brief Whether Ewald-parameter was given.  */
 120   unsigned int frequency_unit_given ;   /**< @brief Whether frequency-unit was given.  */
 121   unsigned int lMax_given ;     /**< @brief Whether lMax was given.  */
 122   unsigned int refractive_index_given ; /**< @brief Whether refractive-index was given.  */
 123   unsigned int particle_given ; /**< @brief Whether particle was given.  */
 124   unsigned int pointfile_given ;        /**< @brief Whether pointfile was given.  */
 125   unsigned int point_given ;    /**< @brief Whether point was given.  */
 126   unsigned int omegafile_given ;        /**< @brief Whether omegafile was given.  */
 127   unsigned int omega_given ;    /**< @brief Whether omega was given.  */
 128   unsigned int kfile_given ;    /**< @brief Whether kfile was given.  */
 129   unsigned int k_given ;        /**< @brief Whether k was given.  */
 130
 131   int k_omega_meshgrid_mode_counter; /**< @brief Counter for mode k_omega_meshgrid */
 132   int k_omega_points_mode_counter; /**< @brief Counter for mode k_omega_points */
 133 } ;
 134
 135 /** @brief The additional parameters to pass to parser functions */
 136 struct cmdline_parser_params
 137 {
 138   int override; /**< @brief whether to override possibly already present options (default 0) */
 139   int initialize; /**< @brief whether to initialize the option structure gengetopt_args_info (default 1) */
 140   int check_required; /**< @brief whether to check that all required options were provided (default 1) */
 141   int check_ambiguity; /**< @brief whether to check for options already specified in the option structure gengetopt_args_info (default 0) */
 142   int print_errors; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */
 143 } ;
 144
 145 /** @brief the purpose string of the program */
 146 extern const char *gengetopt_args_info_purpose;
 147 /** @brief the usage string of the program */
 148 extern const char *gengetopt_args_info_usage;
 149 /** @brief the description string of the program */
 150 extern const char *gengetopt_args_info_description;
 151 /** @brief all the lines making the help output */
 152 extern const char *gengetopt_args_info_help[];
 153 /** @brief all the lines making the detailed help output (including hidden options and details) */
 154 extern const char *gengetopt_args_info_detailed_help[];
 155
 156 /**
 157  * The command line parser
 158  * @param argc the number of command line options
 159  * @param argv the command line options
 160  * @param args_info the structure where option information will be stored
 161  * @return 0 if everything went fine, NON 0 if an error took place
 162  */
 163 int cmdline_parser (int argc, char **argv,
 164   struct gengetopt_args_info *args_info);
 165
 166 /**
 167  * The command line parser (version with additional parameters - deprecated)
 168  * @param argc the number of command line options
 169  * @param argv the command line options
 170  * @param args_info the structure where option information will be stored
 171  * @param override whether to override possibly already present options
 172  * @param initialize whether to initialize the option structure my_args_info
 173  * @param check_required whether to check that all required options were provided
 174  * @return 0 if everything went fine, NON 0 if an error took place
 175  * @deprecated use cmdline_parser_ext() instead
 176  */
 177 int cmdline_parser2 (int argc, char **argv,
 178   struct gengetopt_args_info *args_info,
 179   int override, int initialize, int check_required);
 180
 181 /**
 182  * The command line parser (version with additional parameters)
 183  * @param argc the number of command line options
 184  * @param argv the command line options
 185  * @param args_info the structure where option information will be stored
 186  * @param params additional parameters for the parser
 187  * @return 0 if everything went fine, NON 0 if an error took place
 188  */
 189 int cmdline_parser_ext (int argc, char **argv,
 190   struct gengetopt_args_info *args_info,
 191   struct cmdline_parser_params *params);
 192
 193 /**
 194  * Save the contents of the option struct into an already open FILE stream.
 195  * @param outfile the stream where to dump options
 196  * @param args_info the option struct to dump
 197  * @return 0 if everything went fine, NON 0 if an error took place
 198  */
 199 int cmdline_parser_dump(FILE *outfile,
 200   struct gengetopt_args_info *args_info);
 201
 202 /**
 203  * Save the contents of the option struct into a (text) file.
 204  * This file can be read by the config file parser (if generated by gengetopt)
 205  * @param filename the file where to save
 206  * @param args_info the option struct to save
 207  * @return 0 if everything went fine, NON 0 if an error took place
 208  */
 209 int cmdline_parser_file_save(const char *filename,
 210   struct gengetopt_args_info *args_info);
 211
 212 /**
 213  * Print the help
 214  */
 215 void cmdline_parser_print_help(void);
 216 /**
 217  * Print the detailed help (including hidden options and details)
 218  */
 219 void cmdline_parser_print_detailed_help(void);
 220 /**
 221  * Print the version
 222  */
 223 void cmdline_parser_print_version(void);
 224
 225 /**
 226  * Initializes all the fields a cmdline_parser_params structure
 227  * to their default values
 228  * @param params the structure to initialize
 229  */
 230 void cmdline_parser_params_init(struct cmdline_parser_params *params);
 231
 232 /**
 233  * Allocates dynamically a cmdline_parser_params structure and initializes
 234  * all its fields to their default values
 235  * @return the created and initialized cmdline_parser_params structure
 236  */
 237 struct cmdline_parser_params *cmdline_parser_params_create(void);
 238
 239 /**
 240  * Initializes the passed gengetopt_args_info structure's fields
 241  * (also set default values for options that have a default)
 242  * @param args_info the structure to initialize
 243  */
 244 void cmdline_parser_init (struct gengetopt_args_info *args_info);
 245 /**
 246  * Deallocates the string fields of the gengetopt_args_info structure
 247  * (but does not deallocate the structure itself)
 248  * @param args_info the structure to deallocate
 249  */
 250 void cmdline_parser_free (struct gengetopt_args_info *args_info);
 251
 252 /**
 253  * Checks that all the required options were specified
 254  * @param args_info the structure to check
 255  * @param prog_name the name of the program that will be used to print
 256  *   possible errors
 257  * @return
 258  */
 259 int cmdline_parser_required (struct gengetopt_args_info *args_info,
 260   const char *prog_name);
 261
 262 extern const char *cmdline_parser_normalisation_values[];  /**< @brief Possible values for normalisation. */
 263 extern const char *cmdline_parser_csphase_values[];  /**< @brief Possible values for csphase. */
 264 extern const char *cmdline_parser_frequency_unit_values[];  /**< @brief Possible values for frequency-unit. */
 265
 266
 267 #ifdef __cplusplus
 268 }
 269 #endif /* __cplusplus */
 270 #endif /* TRANSOP_EWALD_CMDLINE_H */