binaries/src/ViennaRNA/Progs/RNAaliduplex_cmdl.h

   1 /** @file RNAaliduplex_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 RNAALIDUPLEX_CMDL_H
   9 #define RNAALIDUPLEX_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 RNAALIDUPLEX_CMDLINE_PARSER_PACKAGE
  23 /** @brief the program name (used for printing errors) */
  24 #define RNAALIDUPLEX_CMDLINE_PARSER_PACKAGE "RNAaliduplex"
  25 #endif
  26
  27 #ifndef RNAALIDUPLEX_CMDLINE_PARSER_PACKAGE_NAME
  28 /** @brief the complete program name (used for help and version) */
  29 #define RNAALIDUPLEX_CMDLINE_PARSER_PACKAGE_NAME "RNAaliduplex"
  30 #endif
  31
  32 #ifndef RNAALIDUPLEX_CMDLINE_PARSER_VERSION
  33 /** @brief the program version */
  34 #define RNAALIDUPLEX_CMDLINE_PARSER_VERSION VERSION
  35 #endif
  36
  37 /** @brief Where the command line options are stored */
  38 struct RNAaliduplex_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 *version_help; /**< @brief Print version and exit help description.  */
  43   float deltaEnergy_arg;        /**< @brief Compute suboptimal structures with energy in a certain range of the optimum (kcal/mol). Default is calculation of mfe structure only.
  44
  45 .  */
  46   char * deltaEnergy_orig;      /**< @brief Compute suboptimal structures with energy in a certain range of the optimum (kcal/mol). Default is calculation of mfe structure only.
  47
  48  original value given at command line.  */
  49   const char *deltaEnergy_help; /**< @brief Compute suboptimal structures with energy in a certain range of the optimum (kcal/mol). Default is calculation of mfe structure only.
  50
  51  help description.  */
  52   int sorted_flag;      /**< @brief print output sorted by free energy
  53
  54  (default=off).  */
  55   const char *sorted_help; /**< @brief print output sorted by free energy
  56
  57  help description.  */
  58   double temp_arg;      /**< @brief Rescale energy parameters to a temperature of temp C. Default is 37C.
  59
  60 .  */
  61   char * temp_orig;     /**< @brief Rescale energy parameters to a temperature of temp C. Default is 37C.
  62
  63  original value given at command line.  */
  64   const char *temp_help; /**< @brief Rescale energy parameters to a temperature of temp C. Default is 37C.
  65
  66  help description.  */
  67   int noTetra_flag;     /**< @brief Do not include special tabulated stabilizing energies for tri-, tetra- and hexaloop hairpins. Mostly for testing.
  68
  69  (default=off).  */
  70   const char *noTetra_help; /**< @brief Do not include special tabulated stabilizing energies for tri-, tetra- and hexaloop hairpins. Mostly for testing.
  71
  72  help description.  */
  73   int dangles_arg;      /**< @brief How to treat \"dangling end\" energies for bases adjacent to helices in free ends and multi-loops
  74  (default='2').  */
  75   char * dangles_orig;  /**< @brief How to treat \"dangling end\" energies for bases adjacent to helices in free ends and multi-loops
  76  original value given at command line.  */
  77   const char *dangles_help; /**< @brief How to treat \"dangling end\" energies for bases adjacent to helices in free ends and multi-loops
  78  help description.  */
  79   int noLP_flag;        /**< @brief Produce structures without lonely pairs (helices of length 1).
  80  (default=off).  */
  81   const char *noLP_help; /**< @brief Produce structures without lonely pairs (helices of length 1).
  82  help description.  */
  83   int noGU_flag;        /**< @brief Do not allow GU pairs
  84
  85  (default=off).  */
  86   const char *noGU_help; /**< @brief Do not allow GU pairs
  87
  88  help description.  */
  89   int noClosingGU_flag; /**< @brief Do not allow GU pairs at the end of helices
  90
  91  (default=off).  */
  92   const char *noClosingGU_help; /**< @brief Do not allow GU pairs at the end of helices
  93
  94  help description.  */
  95   int noconv_flag;      /**< @brief Do not automatically substitude nucleotide \"T\" with \"U\"
  96
  97  (default=off).  */
  98   const char *noconv_help; /**< @brief Do not automatically substitude nucleotide \"T\" with \"U\"
  99
 100  help description.  */
 101   char * nsp_arg;       /**< @brief Allow other pairs in addition to the usual AU,GC,and GU pairs.
 102 .  */
 103   char * nsp_orig;      /**< @brief Allow other pairs in addition to the usual AU,GC,and GU pairs.
 104  original value given at command line.  */
 105   const char *nsp_help; /**< @brief Allow other pairs in addition to the usual AU,GC,and GU pairs.
 106  help description.  */
 107   char * paramFile_arg; /**< @brief Read energy parameters from paramfile, instead of using the default parameter set.
 108 .  */
 109   char * paramFile_orig;        /**< @brief Read energy parameters from paramfile, instead of using the default parameter set.
 110  original value given at command line.  */
 111   const char *paramFile_help; /**< @brief Read energy parameters from paramfile, instead of using the default parameter set.
 112  help description.  */
 113
 114   unsigned int help_given ;     /**< @brief Whether help was given.  */
 115   unsigned int detailed_help_given ;    /**< @brief Whether detailed-help was given.  */
 116   unsigned int version_given ;  /**< @brief Whether version was given.  */
 117   unsigned int deltaEnergy_given ;      /**< @brief Whether deltaEnergy was given.  */
 118   unsigned int sorted_given ;   /**< @brief Whether sorted was given.  */
 119   unsigned int temp_given ;     /**< @brief Whether temp was given.  */
 120   unsigned int noTetra_given ;  /**< @brief Whether noTetra was given.  */
 121   unsigned int dangles_given ;  /**< @brief Whether dangles was given.  */
 122   unsigned int noLP_given ;     /**< @brief Whether noLP was given.  */
 123   unsigned int noGU_given ;     /**< @brief Whether noGU was given.  */
 124   unsigned int noClosingGU_given ;      /**< @brief Whether noClosingGU was given.  */
 125   unsigned int noconv_given ;   /**< @brief Whether noconv was given.  */
 126   unsigned int nsp_given ;      /**< @brief Whether nsp was given.  */
 127   unsigned int paramFile_given ;        /**< @brief Whether paramFile was given.  */
 128
 129   char **inputs ; /**< @brief unamed options (options without names) */
 130   unsigned inputs_num ; /**< @brief unamed options number */
 131 } ;
 132
 133 /** @brief The additional parameters to pass to parser functions */
 134 struct RNAaliduplex_cmdline_parser_params
 135 {
 136   int override; /**< @brief whether to override possibly already present options (default 0) */
 137   int initialize; /**< @brief whether to initialize the option structure RNAaliduplex_args_info (default 1) */
 138   int check_required; /**< @brief whether to check that all required options were provided (default 1) */
 139   int check_ambiguity; /**< @brief whether to check for options already specified in the option structure RNAaliduplex_args_info (default 0) */
 140   int print_errors; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */
 141 } ;
 142
 143 /** @brief the purpose string of the program */
 144 extern const char *RNAaliduplex_args_info_purpose;
 145 /** @brief the usage string of the program */
 146 extern const char *RNAaliduplex_args_info_usage;
 147 /** @brief all the lines making the help output */
 148 extern const char *RNAaliduplex_args_info_help[];
 149 /** @brief all the lines making the detailed help output (including hidden options and details) */
 150 extern const char *RNAaliduplex_args_info_detailed_help[];
 151
 152 /**
 153  * The command line parser
 154  * @param argc the number of command line options
 155  * @param argv the command line options
 156  * @param args_info the structure where option information will be stored
 157  * @return 0 if everything went fine, NON 0 if an error took place
 158  */
 159 int RNAaliduplex_cmdline_parser (int argc, char **argv,
 160   struct RNAaliduplex_args_info *args_info);
 161
 162 /**
 163  * The command line parser (version with additional parameters - deprecated)
 164  * @param argc the number of command line options
 165  * @param argv the command line options
 166  * @param args_info the structure where option information will be stored
 167  * @param override whether to override possibly already present options
 168  * @param initialize whether to initialize the option structure my_args_info
 169  * @param check_required whether to check that all required options were provided
 170  * @return 0 if everything went fine, NON 0 if an error took place
 171  * @deprecated use RNAaliduplex_cmdline_parser_ext() instead
 172  */
 173 int RNAaliduplex_cmdline_parser2 (int argc, char **argv,
 174   struct RNAaliduplex_args_info *args_info,
 175   int override, int initialize, int check_required);
 176
 177 /**
 178  * The command line parser (version with additional parameters)
 179  * @param argc the number of command line options
 180  * @param argv the command line options
 181  * @param args_info the structure where option information will be stored
 182  * @param params additional parameters for the parser
 183  * @return 0 if everything went fine, NON 0 if an error took place
 184  */
 185 int RNAaliduplex_cmdline_parser_ext (int argc, char **argv,
 186   struct RNAaliduplex_args_info *args_info,
 187   struct RNAaliduplex_cmdline_parser_params *params);
 188
 189 /**
 190  * Save the contents of the option struct into an already open FILE stream.
 191  * @param outfile the stream where to dump options
 192  * @param args_info the option struct to dump
 193  * @return 0 if everything went fine, NON 0 if an error took place
 194  */
 195 int RNAaliduplex_cmdline_parser_dump(FILE *outfile,
 196   struct RNAaliduplex_args_info *args_info);
 197
 198 /**
 199  * Save the contents of the option struct into a (text) file.
 200  * This file can be read by the config file parser (if generated by gengetopt)
 201  * @param filename the file where to save
 202  * @param args_info the option struct to save
 203  * @return 0 if everything went fine, NON 0 if an error took place
 204  */
 205 int RNAaliduplex_cmdline_parser_file_save(const char *filename,
 206   struct RNAaliduplex_args_info *args_info);
 207
 208 /**
 209  * Print the help
 210  */
 211 void RNAaliduplex_cmdline_parser_print_help(void);
 212 /**
 213  * Print the detailed help (including hidden options and details)
 214  */
 215 void RNAaliduplex_cmdline_parser_print_detailed_help(void);
 216 /**
 217  * Print the version
 218  */
 219 void RNAaliduplex_cmdline_parser_print_version(void);
 220
 221 /**
 222  * Initializes all the fields a RNAaliduplex_cmdline_parser_params structure
 223  * to their default values
 224  * @param params the structure to initialize
 225  */
 226 void RNAaliduplex_cmdline_parser_params_init(struct RNAaliduplex_cmdline_parser_params *params);
 227
 228 /**
 229  * Allocates dynamically a RNAaliduplex_cmdline_parser_params structure and initializes
 230  * all its fields to their default values
 231  * @return the created and initialized RNAaliduplex_cmdline_parser_params structure
 232  */
 233 struct RNAaliduplex_cmdline_parser_params *RNAaliduplex_cmdline_parser_params_create(void);
 234
 235 /**
 236  * Initializes the passed RNAaliduplex_args_info structure's fields
 237  * (also set default values for options that have a default)
 238  * @param args_info the structure to initialize
 239  */
 240 void RNAaliduplex_cmdline_parser_init (struct RNAaliduplex_args_info *args_info);
 241 /**
 242  * Deallocates the string fields of the RNAaliduplex_args_info structure
 243  * (but does not deallocate the structure itself)
 244  * @param args_info the structure to deallocate
 245  */
 246 void RNAaliduplex_cmdline_parser_free (struct RNAaliduplex_args_info *args_info);
 247
 248 /**
 249  * Checks that all the required options were specified
 250  * @param args_info the structure to check
 251  * @param prog_name the name of the program that will be used to print
 252  *   possible errors
 253  * @return
 254  */
 255 int RNAaliduplex_cmdline_parser_required (struct RNAaliduplex_args_info *args_info,
 256   const char *prog_name);
 257
 258
 259 #ifdef __cplusplus
 260 }
 261 #endif /* __cplusplus */
 262 #endif /* RNAALIDUPLEX_CMDL_H */