binaries/src/ViennaRNA/Progs/RNAplfold_cmdl.h

   1 /** @file RNAplfold_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 RNAPLFOLD_CMDL_H
   9 #define RNAPLFOLD_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 RNAPLFOLD_CMDLINE_PARSER_PACKAGE
  23 /** @brief the program name (used for printing errors) */
  24 #define RNAPLFOLD_CMDLINE_PARSER_PACKAGE "RNAplfold"
  25 #endif
  26
  27 #ifndef RNAPLFOLD_CMDLINE_PARSER_PACKAGE_NAME
  28 /** @brief the complete program name (used for help and version) */
  29 #define RNAPLFOLD_CMDLINE_PARSER_PACKAGE_NAME "RNAplfold"
  30 #endif
  31
  32 #ifndef RNAPLFOLD_CMDLINE_PARSER_VERSION
  33 /** @brief the program version */
  34 #define RNAPLFOLD_CMDLINE_PARSER_VERSION VERSION
  35 #endif
  36
  37 /** @brief Where the command line options are stored */
  38 struct RNAplfold_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 winsize_arg;      /**< @brief Average the pair probabilities over windows of given size
  45
  46  (default='70').  */
  47   char * winsize_orig;  /**< @brief Average the pair probabilities over windows of given size
  48
  49  original value given at command line.  */
  50   const char *winsize_help; /**< @brief Average the pair probabilities over windows of given size
  51
  52  help description.  */
  53   int span_arg; /**< @brief Set the maximum allowed separation of a base pair to span. I.e. no pairs (i,j) with j-i > span will be allowed. Defaults to winsize if parameter is omitted
  54
  55 .  */
  56   char * span_orig;     /**< @brief Set the maximum allowed separation of a base pair to span. I.e. no pairs (i,j) with j-i > span will be allowed. Defaults to winsize if parameter is omitted
  57
  58  original value given at command line.  */
  59   const char *span_help; /**< @brief Set the maximum allowed separation of a base pair to span. I.e. no pairs (i,j) with j-i > span will be allowed. Defaults to winsize if parameter is omitted
  60
  61  help description.  */
  62   float cutoff_arg;     /**< @brief Report only base pairs with an average probability > cutoff in the dot plot
  63
  64  (default='0.01').  */
  65   char * cutoff_orig;   /**< @brief Report only base pairs with an average probability > cutoff in the dot plot
  66
  67  original value given at command line.  */
  68   const char *cutoff_help; /**< @brief Report only base pairs with an average probability > cutoff in the dot plot
  69
  70  help description.  */
  71   int print_onthefly_flag;      /**< @brief Save memory by printing out everything during computation.
  72   NOTE: activated per default for sequences over 1M bp.
  73
  74  (default=off).  */
  75   const char *print_onthefly_help; /**< @brief Save memory by printing out everything during computation.
  76   NOTE: activated per default for sequences over 1M bp.
  77
  78  help description.  */
  79   int ulength_arg;      /**< @brief Compute the mean probability that regions of length 1 to a given length are unpaired. Output is saved in a _lunp file.
  80
  81  (default='31').  */
  82   char * ulength_orig;  /**< @brief Compute the mean probability that regions of length 1 to a given length are unpaired. Output is saved in a _lunp file.
  83
  84  original value given at command line.  */
  85   const char *ulength_help; /**< @brief Compute the mean probability that regions of length 1 to a given length are unpaired. Output is saved in a _lunp file.
  86
  87  help description.  */
  88   int opening_energies_flag;    /**< @brief Switch output from probabilities to their logarithms, which are NOT exactly the mean energies needed to the respective stretch of bases!
  89   NOTE: This actives -u option.
  90
  91  (default=off).  */
  92   const char *opening_energies_help; /**< @brief Switch output from probabilities to their logarithms, which are NOT exactly the mean energies needed to the respective stretch of bases!
  93   NOTE: This actives -u option.
  94
  95  help description.  */
  96   int plex_output_flag; /**< @brief Create additional output files for RNAplex.
  97
  98  (default=off).  */
  99   const char *plex_output_help; /**< @brief Create additional output files for RNAplex.
 100
 101  help description.  */
 102   int noconv_flag;      /**< @brief Do not automatically substitude nucleotide \"T\" with \"U\"
 103
 104  (default=off).  */
 105   const char *noconv_help; /**< @brief Do not automatically substitude nucleotide \"T\" with \"U\"
 106
 107  help description.  */
 108   double temp_arg;      /**< @brief Rescale energy parameters to a temperature of temp C. Default is 37C.
 109
 110 .  */
 111   char * temp_orig;     /**< @brief Rescale energy parameters to a temperature of temp C. Default is 37C.
 112
 113  original value given at command line.  */
 114   const char *temp_help; /**< @brief Rescale energy parameters to a temperature of temp C. Default is 37C.
 115
 116  help description.  */
 117   int noTetra_flag;     /**< @brief Do not include special tabulated stabilizing energies for tri-, tetra- and hexaloop hairpins. Mostly for testing.
 118
 119  (default=off).  */
 120   const char *noTetra_help; /**< @brief Do not include special tabulated stabilizing energies for tri-, tetra- and hexaloop hairpins. Mostly for testing.
 121
 122  help description.  */
 123   int dangles_arg;      /**< @brief How to treat \"dangling end\" energies for bases adjacent to helices in free ends and multi-loops
 124  (default='2').  */
 125   char * dangles_orig;  /**< @brief How to treat \"dangling end\" energies for bases adjacent to helices in free ends and multi-loops
 126  original value given at command line.  */
 127   const char *dangles_help; /**< @brief How to treat \"dangling end\" energies for bases adjacent to helices in free ends and multi-loops
 128  help description.  */
 129   int noLP_flag;        /**< @brief Produce structures without lonely pairs (helices of length 1).
 130  (default=off).  */
 131   const char *noLP_help; /**< @brief Produce structures without lonely pairs (helices of length 1).
 132  help description.  */
 133   int noGU_flag;        /**< @brief Do not allow GU pairs
 134
 135  (default=off).  */
 136   const char *noGU_help; /**< @brief Do not allow GU pairs
 137
 138  help description.  */
 139   int noClosingGU_flag; /**< @brief Do not allow GU pairs at the end of helices
 140
 141  (default=off).  */
 142   const char *noClosingGU_help; /**< @brief Do not allow GU pairs at the end of helices
 143
 144  help description.  */
 145   char * paramFile_arg; /**< @brief Read energy parameters from paramfile, instead of using the default parameter set.
 146 .  */
 147   char * paramFile_orig;        /**< @brief Read energy parameters from paramfile, instead of using the default parameter set.
 148  original value given at command line.  */
 149   const char *paramFile_help; /**< @brief Read energy parameters from paramfile, instead of using the default parameter set.
 150  help description.  */
 151   int binaries_flag;    /**< @brief Output accessibility profiles in binary format
 152   . (default=off).  */
 153   const char *binaries_help; /**< @brief Output accessibility profiles in binary format
 154   . help description.  */
 155   char * nsp_arg;       /**< @brief Allow other pairs in addition to the usual AU,GC,and GU pairs.
 156 .  */
 157   char * nsp_orig;      /**< @brief Allow other pairs in addition to the usual AU,GC,and GU pairs.
 158  original value given at command line.  */
 159   const char *nsp_help; /**< @brief Allow other pairs in addition to the usual AU,GC,and GU pairs.
 160  help description.  */
 161   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.
 162
 163 .  */
 164   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.
 165
 166  original value given at command line.  */
 167   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.
 168
 169  help description.  */
 170   double betaScale_arg; /**< @brief Set the scaling of the Boltzmann factors
 171  (default='1.').  */
 172   char * betaScale_orig;        /**< @brief Set the scaling of the Boltzmann factors
 173  original value given at command line.  */
 174   const char *betaScale_help; /**< @brief Set the scaling of the Boltzmann factors
 175  help description.  */
 176
 177   unsigned int help_given ;     /**< @brief Whether help was given.  */
 178   unsigned int detailed_help_given ;    /**< @brief Whether detailed-help was given.  */
 179   unsigned int full_help_given ;        /**< @brief Whether full-help was given.  */
 180   unsigned int version_given ;  /**< @brief Whether version was given.  */
 181   unsigned int winsize_given ;  /**< @brief Whether winsize was given.  */
 182   unsigned int span_given ;     /**< @brief Whether span was given.  */
 183   unsigned int cutoff_given ;   /**< @brief Whether cutoff was given.  */
 184   unsigned int print_onthefly_given ;   /**< @brief Whether print_onthefly was given.  */
 185   unsigned int ulength_given ;  /**< @brief Whether ulength was given.  */
 186   unsigned int opening_energies_given ; /**< @brief Whether opening_energies was given.  */
 187   unsigned int plex_output_given ;      /**< @brief Whether plex_output was given.  */
 188   unsigned int noconv_given ;   /**< @brief Whether noconv was given.  */
 189   unsigned int temp_given ;     /**< @brief Whether temp was given.  */
 190   unsigned int noTetra_given ;  /**< @brief Whether noTetra was given.  */
 191   unsigned int dangles_given ;  /**< @brief Whether dangles was given.  */
 192   unsigned int noLP_given ;     /**< @brief Whether noLP was given.  */
 193   unsigned int noGU_given ;     /**< @brief Whether noGU was given.  */
 194   unsigned int noClosingGU_given ;      /**< @brief Whether noClosingGU was given.  */
 195   unsigned int paramFile_given ;        /**< @brief Whether paramFile was given.  */
 196   unsigned int binaries_given ; /**< @brief Whether binaries was given.  */
 197   unsigned int nsp_given ;      /**< @brief Whether nsp was given.  */
 198   unsigned int energyModel_given ;      /**< @brief Whether energyModel was given.  */
 199   unsigned int betaScale_given ;        /**< @brief Whether betaScale was given.  */
 200
 201 } ;
 202
 203 /** @brief The additional parameters to pass to parser functions */
 204 struct RNAplfold_cmdline_parser_params
 205 {
 206   int override; /**< @brief whether to override possibly already present options (default 0) */
 207   int initialize; /**< @brief whether to initialize the option structure RNAplfold_args_info (default 1) */
 208   int check_required; /**< @brief whether to check that all required options were provided (default 1) */
 209   int check_ambiguity; /**< @brief whether to check for options already specified in the option structure RNAplfold_args_info (default 0) */
 210   int print_errors; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */
 211 } ;
 212
 213 /** @brief the purpose string of the program */
 214 extern const char *RNAplfold_args_info_purpose;
 215 /** @brief the usage string of the program */
 216 extern const char *RNAplfold_args_info_usage;
 217 /** @brief all the lines making the help output */
 218 extern const char *RNAplfold_args_info_help[];
 219 /** @brief all the lines making the full help output (including hidden options) */
 220 extern const char *RNAplfold_args_info_full_help[];
 221 /** @brief all the lines making the detailed help output (including hidden options and details) */
 222 extern const char *RNAplfold_args_info_detailed_help[];
 223
 224 /**
 225  * The command line parser
 226  * @param argc the number of command line options
 227  * @param argv the command line options
 228  * @param args_info the structure where option information will be stored
 229  * @return 0 if everything went fine, NON 0 if an error took place
 230  */
 231 int RNAplfold_cmdline_parser (int argc, char **argv,
 232   struct RNAplfold_args_info *args_info);
 233
 234 /**
 235  * The command line parser (version with additional parameters - deprecated)
 236  * @param argc the number of command line options
 237  * @param argv the command line options
 238  * @param args_info the structure where option information will be stored
 239  * @param override whether to override possibly already present options
 240  * @param initialize whether to initialize the option structure my_args_info
 241  * @param check_required whether to check that all required options were provided
 242  * @return 0 if everything went fine, NON 0 if an error took place
 243  * @deprecated use RNAplfold_cmdline_parser_ext() instead
 244  */
 245 int RNAplfold_cmdline_parser2 (int argc, char **argv,
 246   struct RNAplfold_args_info *args_info,
 247   int override, int initialize, int check_required);
 248
 249 /**
 250  * The command line parser (version with additional parameters)
 251  * @param argc the number of command line options
 252  * @param argv the command line options
 253  * @param args_info the structure where option information will be stored
 254  * @param params additional parameters for the parser
 255  * @return 0 if everything went fine, NON 0 if an error took place
 256  */
 257 int RNAplfold_cmdline_parser_ext (int argc, char **argv,
 258   struct RNAplfold_args_info *args_info,
 259   struct RNAplfold_cmdline_parser_params *params);
 260
 261 /**
 262  * Save the contents of the option struct into an already open FILE stream.
 263  * @param outfile the stream where to dump options
 264  * @param args_info the option struct to dump
 265  * @return 0 if everything went fine, NON 0 if an error took place
 266  */
 267 int RNAplfold_cmdline_parser_dump(FILE *outfile,
 268   struct RNAplfold_args_info *args_info);
 269
 270 /**
 271  * Save the contents of the option struct into a (text) file.
 272  * This file can be read by the config file parser (if generated by gengetopt)
 273  * @param filename the file where to save
 274  * @param args_info the option struct to save
 275  * @return 0 if everything went fine, NON 0 if an error took place
 276  */
 277 int RNAplfold_cmdline_parser_file_save(const char *filename,
 278   struct RNAplfold_args_info *args_info);
 279
 280 /**
 281  * Print the help
 282  */
 283 void RNAplfold_cmdline_parser_print_help(void);
 284 /**
 285  * Print the full help (including hidden options)
 286  */
 287 void RNAplfold_cmdline_parser_print_full_help(void);
 288 /**
 289  * Print the detailed help (including hidden options and details)
 290  */
 291 void RNAplfold_cmdline_parser_print_detailed_help(void);
 292 /**
 293  * Print the version
 294  */
 295 void RNAplfold_cmdline_parser_print_version(void);
 296
 297 /**
 298  * Initializes all the fields a RNAplfold_cmdline_parser_params structure
 299  * to their default values
 300  * @param params the structure to initialize
 301  */
 302 void RNAplfold_cmdline_parser_params_init(struct RNAplfold_cmdline_parser_params *params);
 303
 304 /**
 305  * Allocates dynamically a RNAplfold_cmdline_parser_params structure and initializes
 306  * all its fields to their default values
 307  * @return the created and initialized RNAplfold_cmdline_parser_params structure
 308  */
 309 struct RNAplfold_cmdline_parser_params *RNAplfold_cmdline_parser_params_create(void);
 310
 311 /**
 312  * Initializes the passed RNAplfold_args_info structure's fields
 313  * (also set default values for options that have a default)
 314  * @param args_info the structure to initialize
 315  */
 316 void RNAplfold_cmdline_parser_init (struct RNAplfold_args_info *args_info);
 317 /**
 318  * Deallocates the string fields of the RNAplfold_args_info structure
 319  * (but does not deallocate the structure itself)
 320  * @param args_info the structure to deallocate
 321  */
 322 void RNAplfold_cmdline_parser_free (struct RNAplfold_args_info *args_info);
 323
 324 /**
 325  * Checks that all the required options were specified
 326  * @param args_info the structure to check
 327  * @param prog_name the name of the program that will be used to print
 328  *   possible errors
 329  * @return
 330  */
 331 int RNAplfold_cmdline_parser_required (struct RNAplfold_args_info *args_info,
 332   const char *prog_name);
 333
 334
 335 #ifdef __cplusplus
 336 }
 337 #endif /* __cplusplus */
 338 #endif /* RNAPLFOLD_CMDL_H */