binaries/src/ViennaRNA/Progs/RNAcofold_cmdl.h

   1 /** @file RNAcofold_cmdl.h
   2  *  @brief The header file for the command line option parser
   3  *  generated by GNU Gengetopt version 2.22.5
   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 RNACOFOLD_CMDL_H
   9 #define RNACOFOLD_CMDL_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 RNACOFOLD_CMDLINE_PARSER_PACKAGE
  23 /** @brief the program name (used for printing errors) */
  24 #define RNACOFOLD_CMDLINE_PARSER_PACKAGE "RNAcofold"
  25 #endif
  26
  27 #ifndef RNACOFOLD_CMDLINE_PARSER_PACKAGE_NAME
  28 /** @brief the complete program name (used for help and version) */
  29 #define RNACOFOLD_CMDLINE_PARSER_PACKAGE_NAME "RNAcofold"
  30 #endif
  31
  32 #ifndef RNACOFOLD_CMDLINE_PARSER_VERSION
  33 /** @brief the program version */
  34 #define RNACOFOLD_CMDLINE_PARSER_VERSION VERSION
  35 #endif
  36
  37 /** @brief Where the command line options are stored */
  38 struct RNAcofold_args_info
  39 {
  40   const char *help_help; /**< @brief Print help and exit help description.  */
  41   const char *detailed_help_help; /**< @brief Print help, including all details and hidden options, and exit help description.  */
  42   const char *full_help_help; /**< @brief Print help, including hidden options, and exit help description.  */
  43   const char *version_help; /**< @brief Print version and exit help description.  */
  44   int constraint_flag;  /**< @brief Calculate structures subject to constraints.
  45  (default=off).  */
  46   const char *constraint_help; /**< @brief Calculate structures subject to constraints.
  47  help description.  */
  48   int noconv_flag;      /**< @brief Do not automatically substitude nucleotide \"T\" with \"U\"
  49
  50  (default=off).  */
  51   const char *noconv_help; /**< @brief Do not automatically substitude nucleotide \"T\" with \"U\"
  52
  53  help description.  */
  54   int noPS_flag;        /**< @brief Do not produce postscript output
  55
  56  (default=off).  */
  57   const char *noPS_help; /**< @brief Do not produce postscript output
  58
  59  help description.  */
  60   int partfunc_arg;     /**< @brief Calculate the partition function and base pairing probability matrix in addition to the mfe structure. Default is calculation of mfe structure only.
  61  (default='1').  */
  62   char * partfunc_orig; /**< @brief Calculate the partition function and base pairing probability matrix in addition to the mfe structure. Default is calculation of mfe structure only.
  63  original value given at command line.  */
  64   const char *partfunc_help; /**< @brief Calculate the partition function and base pairing probability matrix in addition to the mfe structure. Default is calculation of mfe structure only.
  65  help description.  */
  66   int all_pf_flag;      /**< @brief Compute the partition function and free energies not only of the hetero-dimer consisting of the two input sequences (the \"AB dimer\"), but also of the homo-dimers AA and BB as well as A and B monomers.
  67  (default=off).  */
  68   const char *all_pf_help; /**< @brief Compute the partition function and free energies not only of the hetero-dimer consisting of the two input sequences (the \"AB dimer\"), but also of the homo-dimers AA and BB as well as A and B monomers.
  69  help description.  */
  70   int concentrations_flag;      /**< @brief In addition to everything listed under the -a option, read in initial monomer concentrations and compute the expected equilibrium concentrations of the 5 possible species (AB, AA, BB, A, B).
  71  (default=off).  */
  72   const char *concentrations_help; /**< @brief In addition to everything listed under the -a option, read in initial monomer concentrations and compute the expected equilibrium concentrations of the 5 possible species (AB, AA, BB, A, B).
  73  help description.  */
  74   char * concfile_arg;  /**< @brief Specify a file with initial concentrations for the to sequences..  */
  75   char * concfile_orig; /**< @brief Specify a file with initial concentrations for the to sequences. original value given at command line.  */
  76   const char *concfile_help; /**< @brief Specify a file with initial concentrations for the to sequences. help description.  */
  77   double pfScale_arg;   /**< @brief In the calculation of the pf use scale*mfe as an estimate for the ensemble free energy (used to avoid overflows).
  78 .  */
  79   char * pfScale_orig;  /**< @brief In the calculation of the pf use scale*mfe as an estimate for the ensemble free energy (used to avoid overflows).
  80  original value given at command line.  */
  81   const char *pfScale_help; /**< @brief In the calculation of the pf use scale*mfe as an estimate for the ensemble free energy (used to avoid overflows).
  82  help description.  */
  83   double bppmThreshold_arg;     /**< @brief Set the threshold for base pair probabilities included in the postscript output
  84  (default='1e-5').  */
  85   char * bppmThreshold_orig;    /**< @brief Set the threshold for base pair probabilities included in the postscript output
  86  original value given at command line.  */
  87   const char *bppmThreshold_help; /**< @brief Set the threshold for base pair probabilities included in the postscript output
  88  help description.  */
  89   int gquad_flag;       /**< @brief Incoorporate G-Quadruplex formation into the structure prediction algorithm
  90  (default=off).  */
  91   const char *gquad_help; /**< @brief Incoorporate G-Quadruplex formation into the structure prediction algorithm
  92  help description.  */
  93   double temp_arg;      /**< @brief Rescale energy parameters to a temperature of temp C. Default is 37C.
  94
  95 .  */
  96   char * temp_orig;     /**< @brief Rescale energy parameters to a temperature of temp C. Default is 37C.
  97
  98  original value given at command line.  */
  99   const char *temp_help; /**< @brief Rescale energy parameters to a temperature of temp C. Default is 37C.
 100
 101  help description.  */
 102   int noTetra_flag;     /**< @brief Do not include special stabilizing energies for certain tetra-loops. Mostly for testing.
 103
 104  (default=off).  */
 105   const char *noTetra_help; /**< @brief Do not include special stabilizing energies for certain tetra-loops. Mostly for testing.
 106
 107  help description.  */
 108   int dangles_arg;      /**< @brief How to treat \"dangling end\" energies for bases adjacent to helices in free ends and multi-loops
 109  (default='2').  */
 110   char * dangles_orig;  /**< @brief How to treat \"dangling end\" energies for bases adjacent to helices in free ends and multi-loops
 111  original value given at command line.  */
 112   const char *dangles_help; /**< @brief How to treat \"dangling end\" energies for bases adjacent to helices in free ends and multi-loops
 113  help description.  */
 114   int noLP_flag;        /**< @brief Produce structures without lonely pairs (helices of length 1).
 115  (default=off).  */
 116   const char *noLP_help; /**< @brief Produce structures without lonely pairs (helices of length 1).
 117  help description.  */
 118   int noGU_flag;        /**< @brief Do not allow GU pairs
 119
 120  (default=off).  */
 121   const char *noGU_help; /**< @brief Do not allow GU pairs
 122
 123  help description.  */
 124   int noClosingGU_flag; /**< @brief Do not allow GU pairs at the end of helices
 125
 126  (default=off).  */
 127   const char *noClosingGU_help; /**< @brief Do not allow GU pairs at the end of helices
 128
 129  help description.  */
 130   char * paramFile_arg; /**< @brief Read energy parameters from paramfile, instead of using the default parameter set.
 131 .  */
 132   char * paramFile_orig;        /**< @brief Read energy parameters from paramfile, instead of using the default parameter set.
 133  original value given at command line.  */
 134   const char *paramFile_help; /**< @brief Read energy parameters from paramfile, instead of using the default parameter set.
 135  help description.  */
 136   char * nsp_arg;       /**< @brief Allow other pairs in addition to the usual AU,GC,and GU pairs.
 137 .  */
 138   char * nsp_orig;      /**< @brief Allow other pairs in addition to the usual AU,GC,and GU pairs.
 139  original value given at command line.  */
 140   const char *nsp_help; /**< @brief Allow other pairs in addition to the usual AU,GC,and GU pairs.
 141  help description.  */
 142   int energyModel_arg;  /**< @brief Rarely used option to fold sequences from the artificial ABCD... alphabet, where A pairs B, C-D etc.  Use the energy parameters for GC (-e 1) or AU (-e 2) pairs.
 143
 144 .  */
 145   char * energyModel_orig;      /**< @brief Rarely used option to fold sequences from the artificial ABCD... alphabet, where A pairs B, C-D etc.  Use the energy parameters for GC (-e 1) or AU (-e 2) pairs.
 146
 147  original value given at command line.  */
 148   const char *energyModel_help; /**< @brief Rarely used option to fold sequences from the artificial ABCD... alphabet, where A pairs B, C-D etc.  Use the energy parameters for GC (-e 1) or AU (-e 2) pairs.
 149
 150  help description.  */
 151   double betaScale_arg; /**< @brief Set the scaling of the Boltzmann factors
 152  (default='1.').  */
 153   char * betaScale_orig;        /**< @brief Set the scaling of the Boltzmann factors
 154  original value given at command line.  */
 155   const char *betaScale_help; /**< @brief Set the scaling of the Boltzmann factors
 156  help description.  */
 157
 158   unsigned int help_given ;     /**< @brief Whether help was given.  */
 159   unsigned int detailed_help_given ;    /**< @brief Whether detailed-help was given.  */
 160   unsigned int full_help_given ;        /**< @brief Whether full-help was given.  */
 161   unsigned int version_given ;  /**< @brief Whether version was given.  */
 162   unsigned int constraint_given ;       /**< @brief Whether constraint was given.  */
 163   unsigned int noconv_given ;   /**< @brief Whether noconv was given.  */
 164   unsigned int noPS_given ;     /**< @brief Whether noPS was given.  */
 165   unsigned int partfunc_given ; /**< @brief Whether partfunc was given.  */
 166   unsigned int all_pf_given ;   /**< @brief Whether all_pf was given.  */
 167   unsigned int concentrations_given ;   /**< @brief Whether concentrations was given.  */
 168   unsigned int concfile_given ; /**< @brief Whether concfile was given.  */
 169   unsigned int pfScale_given ;  /**< @brief Whether pfScale was given.  */
 170   unsigned int bppmThreshold_given ;    /**< @brief Whether bppmThreshold was given.  */
 171   unsigned int gquad_given ;    /**< @brief Whether gquad was given.  */
 172   unsigned int temp_given ;     /**< @brief Whether temp was given.  */
 173   unsigned int noTetra_given ;  /**< @brief Whether noTetra was given.  */
 174   unsigned int dangles_given ;  /**< @brief Whether dangles was given.  */
 175   unsigned int noLP_given ;     /**< @brief Whether noLP was given.  */
 176   unsigned int noGU_given ;     /**< @brief Whether noGU was given.  */
 177   unsigned int noClosingGU_given ;      /**< @brief Whether noClosingGU was given.  */
 178   unsigned int paramFile_given ;        /**< @brief Whether paramFile was given.  */
 179   unsigned int nsp_given ;      /**< @brief Whether nsp was given.  */
 180   unsigned int energyModel_given ;      /**< @brief Whether energyModel was given.  */
 181   unsigned int betaScale_given ;        /**< @brief Whether betaScale was given.  */
 182
 183 } ;
 184
 185 /** @brief The additional parameters to pass to parser functions */
 186 struct RNAcofold_cmdline_parser_params
 187 {
 188   int override; /**< @brief whether to override possibly already present options (default 0) */
 189   int initialize; /**< @brief whether to initialize the option structure RNAcofold_args_info (default 1) */
 190   int check_required; /**< @brief whether to check that all required options were provided (default 1) */
 191   int check_ambiguity; /**< @brief whether to check for options already specified in the option structure RNAcofold_args_info (default 0) */
 192   int print_errors; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */
 193 } ;
 194
 195 /** @brief the purpose string of the program */
 196 extern const char *RNAcofold_args_info_purpose;
 197 /** @brief the usage string of the program */
 198 extern const char *RNAcofold_args_info_usage;
 199 /** @brief all the lines making the help output */
 200 extern const char *RNAcofold_args_info_help[];
 201 /** @brief all the lines making the full help output (including hidden options) */
 202 extern const char *RNAcofold_args_info_full_help[];
 203 /** @brief all the lines making the detailed help output (including hidden options and details) */
 204 extern const char *RNAcofold_args_info_detailed_help[];
 205
 206 /**
 207  * The command line parser
 208  * @param argc the number of command line options
 209  * @param argv the command line options
 210  * @param args_info the structure where option information will be stored
 211  * @return 0 if everything went fine, NON 0 if an error took place
 212  */
 213 int RNAcofold_cmdline_parser (int argc, char **argv,
 214   struct RNAcofold_args_info *args_info);
 215
 216 /**
 217  * The command line parser (version with additional parameters - deprecated)
 218  * @param argc the number of command line options
 219  * @param argv the command line options
 220  * @param args_info the structure where option information will be stored
 221  * @param override whether to override possibly already present options
 222  * @param initialize whether to initialize the option structure my_args_info
 223  * @param check_required whether to check that all required options were provided
 224  * @return 0 if everything went fine, NON 0 if an error took place
 225  * @deprecated use RNAcofold_cmdline_parser_ext() instead
 226  */
 227 int RNAcofold_cmdline_parser2 (int argc, char **argv,
 228   struct RNAcofold_args_info *args_info,
 229   int override, int initialize, int check_required);
 230
 231 /**
 232  * The command line parser (version with additional parameters)
 233  * @param argc the number of command line options
 234  * @param argv the command line options
 235  * @param args_info the structure where option information will be stored
 236  * @param params additional parameters for the parser
 237  * @return 0 if everything went fine, NON 0 if an error took place
 238  */
 239 int RNAcofold_cmdline_parser_ext (int argc, char **argv,
 240   struct RNAcofold_args_info *args_info,
 241   struct RNAcofold_cmdline_parser_params *params);
 242
 243 /**
 244  * Save the contents of the option struct into an already open FILE stream.
 245  * @param outfile the stream where to dump options
 246  * @param args_info the option struct to dump
 247  * @return 0 if everything went fine, NON 0 if an error took place
 248  */
 249 int RNAcofold_cmdline_parser_dump(FILE *outfile,
 250   struct RNAcofold_args_info *args_info);
 251
 252 /**
 253  * Save the contents of the option struct into a (text) file.
 254  * This file can be read by the config file parser (if generated by gengetopt)
 255  * @param filename the file where to save
 256  * @param args_info the option struct to save
 257  * @return 0 if everything went fine, NON 0 if an error took place
 258  */
 259 int RNAcofold_cmdline_parser_file_save(const char *filename,
 260   struct RNAcofold_args_info *args_info);
 261
 262 /**
 263  * Print the help
 264  */
 265 void RNAcofold_cmdline_parser_print_help(void);
 266 /**
 267  * Print the full help (including hidden options)
 268  */
 269 void RNAcofold_cmdline_parser_print_full_help(void);
 270 /**
 271  * Print the detailed help (including hidden options and details)
 272  */
 273 void RNAcofold_cmdline_parser_print_detailed_help(void);
 274 /**
 275  * Print the version
 276  */
 277 void RNAcofold_cmdline_parser_print_version(void);
 278
 279 /**
 280  * Initializes all the fields a RNAcofold_cmdline_parser_params structure
 281  * to their default values
 282  * @param params the structure to initialize
 283  */
 284 void RNAcofold_cmdline_parser_params_init(struct RNAcofold_cmdline_parser_params *params);
 285
 286 /**
 287  * Allocates dynamically a RNAcofold_cmdline_parser_params structure and initializes
 288  * all its fields to their default values
 289  * @return the created and initialized RNAcofold_cmdline_parser_params structure
 290  */
 291 struct RNAcofold_cmdline_parser_params *RNAcofold_cmdline_parser_params_create(void);
 292
 293 /**
 294  * Initializes the passed RNAcofold_args_info structure's fields
 295  * (also set default values for options that have a default)
 296  * @param args_info the structure to initialize
 297  */
 298 void RNAcofold_cmdline_parser_init (struct RNAcofold_args_info *args_info);
 299 /**
 300  * Deallocates the string fields of the RNAcofold_args_info structure
 301  * (but does not deallocate the structure itself)
 302  * @param args_info the structure to deallocate
 303  */
 304 void RNAcofold_cmdline_parser_free (struct RNAcofold_args_info *args_info);
 305
 306 /**
 307  * Checks that all the required options were specified
 308  * @param args_info the structure to check
 309  * @param prog_name the name of the program that will be used to print
 310  *   possible errors
 311  * @return
 312  */
 313 int RNAcofold_cmdline_parser_required (struct RNAcofold_args_info *args_info,
 314   const char *prog_name);
 315
 316
 317 #ifdef __cplusplus
 318 }
 319 #endif /* __cplusplus */
 320 #endif /* RNACOFOLD_CMDL_H */