--- /dev/null
+/** @file RNA2Dfold_cmdl.h
+ * @brief The header file for the command line option parser
+ * generated by GNU Gengetopt version 2.22.5
+ * http://www.gnu.org/software/gengetopt.
+ * DO NOT modify this file, since it can be overwritten
+ * @author GNU Gengetopt by Lorenzo Bettini */
+
+#ifndef RNA2DFOLD_CMDL_H
+#define RNA2DFOLD_CMDL_H
+
+/* If we use autoconf. */
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <stdio.h> /* for FILE */
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+#ifndef RNA2DFOLD_CMDLINE_PARSER_PACKAGE
+/** @brief the program name (used for printing errors) */
+#define RNA2DFOLD_CMDLINE_PARSER_PACKAGE "RNA2Dfold"
+#endif
+
+#ifndef RNA2DFOLD_CMDLINE_PARSER_PACKAGE_NAME
+/** @brief the complete program name (used for help and version) */
+#define RNA2DFOLD_CMDLINE_PARSER_PACKAGE_NAME "RNA2Dfold"
+#endif
+
+#ifndef RNA2DFOLD_CMDLINE_PARSER_VERSION
+/** @brief the program version */
+#define RNA2DFOLD_CMDLINE_PARSER_VERSION VERSION
+#endif
+
+/** @brief Where the command line options are stored */
+struct RNA2Dfold_args_info
+{
+ const char *help_help; /**< @brief Print help and exit help description. */
+ const char *detailed_help_help; /**< @brief Print help, including all details and hidden options, and exit help description. */
+ const char *version_help; /**< @brief Print version and exit help description. */
+ int noconv_flag; /**< @brief Do not automatically substitude nucleotide \"T\" with \"U\"
+
+ (default=off). */
+ const char *noconv_help; /**< @brief Do not automatically substitude nucleotide \"T\" with \"U\"
+
+ help description. */
+ int numThreads_arg; /**< @brief Set the number of threads used for calculations (only available when compiled with OpenMP support)
+
+. */
+ char * numThreads_orig; /**< @brief Set the number of threads used for calculations (only available when compiled with OpenMP support)
+
+ original value given at command line. */
+ const char *numThreads_help; /**< @brief Set the number of threads used for calculations (only available when compiled with OpenMP support)
+
+ help description. */
+ int partfunc_flag; /**< @brief calculate partition function and thus, Boltzmann probabilities and Gibbs free energy
+
+ (default=off). */
+ const char *partfunc_help; /**< @brief calculate partition function and thus, Boltzmann probabilities and Gibbs free energy
+
+ help description. */
+ int stochBT_arg; /**< @brief backtrack a certain number of Boltzmann samples from the appropriate k,l neighborhood(s)
+
+. */
+ char * stochBT_orig; /**< @brief backtrack a certain number of Boltzmann samples from the appropriate k,l neighborhood(s)
+
+ original value given at command line. */
+ const char *stochBT_help; /**< @brief backtrack a certain number of Boltzmann samples from the appropriate k,l neighborhood(s)
+
+ help description. */
+ char ** neighborhood_arg; /**< @brief backtrack structures from certain k,l-neighborhood only, can be specified multiple times (<k>:<l>,<m>:<n>,...)
+
+. */
+ char ** neighborhood_orig; /**< @brief backtrack structures from certain k,l-neighborhood only, can be specified multiple times (<k>:<l>,<m>:<n>,...)
+
+ original value given at command line. */
+ unsigned int neighborhood_min; /**< @brief backtrack structures from certain k,l-neighborhood only, can be specified multiple times (<k>:<l>,<m>:<n>,...)
+
+'s minimum occurreces */
+ unsigned int neighborhood_max; /**< @brief backtrack structures from certain k,l-neighborhood only, can be specified multiple times (<k>:<l>,<m>:<n>,...)
+
+'s maximum occurreces */
+ const char *neighborhood_help; /**< @brief backtrack structures from certain k,l-neighborhood only, can be specified multiple times (<k>:<l>,<m>:<n>,...)
+
+ help description. */
+ double pfScale_arg; /**< @brief scaling factor for pf to avoid overflows
+
+. */
+ char * pfScale_orig; /**< @brief scaling factor for pf to avoid overflows
+
+ original value given at command line. */
+ const char *pfScale_help; /**< @brief scaling factor for pf to avoid overflows
+
+ help description. */
+ int noBT_flag; /**< @brief do not backtrack structures, calculate energy contributions only
+
+ (default=off). */
+ const char *noBT_help; /**< @brief do not backtrack structures, calculate energy contributions only
+
+ help description. */
+ int circ_flag; /**< @brief Assume a circular (instead of linear) RNA molecule.
+
+ (default=off). */
+ const char *circ_help; /**< @brief Assume a circular (instead of linear) RNA molecule.
+
+ help description. */
+ double temp_arg; /**< @brief Rescale energy parameters to a temperature of temp C. Default is 37C.
+
+. */
+ char * temp_orig; /**< @brief Rescale energy parameters to a temperature of temp C. Default is 37C.
+
+ original value given at command line. */
+ const char *temp_help; /**< @brief Rescale energy parameters to a temperature of temp C. Default is 37C.
+
+ help description. */
+ int maxDist1_arg; /**< @brief maximum distance to first reference structure. */
+ char * maxDist1_orig; /**< @brief maximum distance to first reference structure original value given at command line. */
+ const char *maxDist1_help; /**< @brief maximum distance to first reference structure help description. */
+ int maxDist2_arg; /**< @brief maximum distance to second reference structure. */
+ char * maxDist2_orig; /**< @brief maximum distance to second reference structure original value given at command line. */
+ const char *maxDist2_help; /**< @brief maximum distance to second reference structure help description. */
+ int noTetra_flag; /**< @brief Do not include special tabulated stabilizing energies for tri-, tetra- and hexaloop hairpins. Mostly for testing.
+
+ (default=off). */
+ const char *noTetra_help; /**< @brief Do not include special tabulated stabilizing energies for tri-, tetra- and hexaloop hairpins. Mostly for testing.
+
+ help description. */
+ char * parameterFile_arg; /**< @brief Read energy parameters from paramfile, instead of using the default parameter set.
+. */
+ char * parameterFile_orig; /**< @brief Read energy parameters from paramfile, instead of using the default parameter set.
+ original value given at command line. */
+ const char *parameterFile_help; /**< @brief Read energy parameters from paramfile, instead of using the default parameter set.
+ help description. */
+ int dangles_arg; /**< @brief How to treat \"dangling end\" energies for bases adjacent to helices in free ends and multi-loops
+ (default='2'). */
+ char * dangles_orig; /**< @brief How to treat \"dangling end\" energies for bases adjacent to helices in free ends and multi-loops
+ original value given at command line. */
+ const char *dangles_help; /**< @brief How to treat \"dangling end\" energies for bases adjacent to helices in free ends and multi-loops
+ help description. */
+ int noGU_flag; /**< @brief Do not allow GU pairs
+
+ (default=off). */
+ const char *noGU_help; /**< @brief Do not allow GU pairs
+
+ help description. */
+ int noClosingGU_flag; /**< @brief Do not allow GU pairs at the end of helices
+
+ (default=off). */
+ const char *noClosingGU_help; /**< @brief Do not allow GU pairs at the end of helices
+
+ help description. */
+
+ unsigned int help_given ; /**< @brief Whether help was given. */
+ unsigned int detailed_help_given ; /**< @brief Whether detailed-help was given. */
+ unsigned int version_given ; /**< @brief Whether version was given. */
+ unsigned int noconv_given ; /**< @brief Whether noconv was given. */
+ unsigned int numThreads_given ; /**< @brief Whether numThreads was given. */
+ unsigned int partfunc_given ; /**< @brief Whether partfunc was given. */
+ unsigned int stochBT_given ; /**< @brief Whether stochBT was given. */
+ unsigned int neighborhood_given ; /**< @brief Whether neighborhood was given. */
+ unsigned int pfScale_given ; /**< @brief Whether pfScale was given. */
+ unsigned int noBT_given ; /**< @brief Whether noBT was given. */
+ unsigned int circ_given ; /**< @brief Whether circ was given. */
+ unsigned int temp_given ; /**< @brief Whether temp was given. */
+ unsigned int maxDist1_given ; /**< @brief Whether maxDist1 was given. */
+ unsigned int maxDist2_given ; /**< @brief Whether maxDist2 was given. */
+ unsigned int noTetra_given ; /**< @brief Whether noTetra was given. */
+ unsigned int parameterFile_given ; /**< @brief Whether parameterFile was given. */
+ unsigned int dangles_given ; /**< @brief Whether dangles was given. */
+ unsigned int noGU_given ; /**< @brief Whether noGU was given. */
+ unsigned int noClosingGU_given ; /**< @brief Whether noClosingGU was given. */
+
+} ;
+
+/** @brief The additional parameters to pass to parser functions */
+struct RNA2Dfold_cmdline_parser_params
+{
+ int override; /**< @brief whether to override possibly already present options (default 0) */
+ int initialize; /**< @brief whether to initialize the option structure RNA2Dfold_args_info (default 1) */
+ int check_required; /**< @brief whether to check that all required options were provided (default 1) */
+ int check_ambiguity; /**< @brief whether to check for options already specified in the option structure RNA2Dfold_args_info (default 0) */
+ int print_errors; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */
+} ;
+
+/** @brief the purpose string of the program */
+extern const char *RNA2Dfold_args_info_purpose;
+/** @brief the usage string of the program */
+extern const char *RNA2Dfold_args_info_usage;
+/** @brief all the lines making the help output */
+extern const char *RNA2Dfold_args_info_help[];
+/** @brief all the lines making the detailed help output (including hidden options and details) */
+extern const char *RNA2Dfold_args_info_detailed_help[];
+
+/**
+ * The command line parser
+ * @param argc the number of command line options
+ * @param argv the command line options
+ * @param args_info the structure where option information will be stored
+ * @return 0 if everything went fine, NON 0 if an error took place
+ */
+int RNA2Dfold_cmdline_parser (int argc, char **argv,
+ struct RNA2Dfold_args_info *args_info);
+
+/**
+ * The command line parser (version with additional parameters - deprecated)
+ * @param argc the number of command line options
+ * @param argv the command line options
+ * @param args_info the structure where option information will be stored
+ * @param override whether to override possibly already present options
+ * @param initialize whether to initialize the option structure my_args_info
+ * @param check_required whether to check that all required options were provided
+ * @return 0 if everything went fine, NON 0 if an error took place
+ * @deprecated use RNA2Dfold_cmdline_parser_ext() instead
+ */
+int RNA2Dfold_cmdline_parser2 (int argc, char **argv,
+ struct RNA2Dfold_args_info *args_info,
+ int override, int initialize, int check_required);
+
+/**
+ * The command line parser (version with additional parameters)
+ * @param argc the number of command line options
+ * @param argv the command line options
+ * @param args_info the structure where option information will be stored
+ * @param params additional parameters for the parser
+ * @return 0 if everything went fine, NON 0 if an error took place
+ */
+int RNA2Dfold_cmdline_parser_ext (int argc, char **argv,
+ struct RNA2Dfold_args_info *args_info,
+ struct RNA2Dfold_cmdline_parser_params *params);
+
+/**
+ * Save the contents of the option struct into an already open FILE stream.
+ * @param outfile the stream where to dump options
+ * @param args_info the option struct to dump
+ * @return 0 if everything went fine, NON 0 if an error took place
+ */
+int RNA2Dfold_cmdline_parser_dump(FILE *outfile,
+ struct RNA2Dfold_args_info *args_info);
+
+/**
+ * Save the contents of the option struct into a (text) file.
+ * This file can be read by the config file parser (if generated by gengetopt)
+ * @param filename the file where to save
+ * @param args_info the option struct to save
+ * @return 0 if everything went fine, NON 0 if an error took place
+ */
+int RNA2Dfold_cmdline_parser_file_save(const char *filename,
+ struct RNA2Dfold_args_info *args_info);
+
+/**
+ * Print the help
+ */
+void RNA2Dfold_cmdline_parser_print_help(void);
+/**
+ * Print the detailed help (including hidden options and details)
+ */
+void RNA2Dfold_cmdline_parser_print_detailed_help(void);
+/**
+ * Print the version
+ */
+void RNA2Dfold_cmdline_parser_print_version(void);
+
+/**
+ * Initializes all the fields a RNA2Dfold_cmdline_parser_params structure
+ * to their default values
+ * @param params the structure to initialize
+ */
+void RNA2Dfold_cmdline_parser_params_init(struct RNA2Dfold_cmdline_parser_params *params);
+
+/**
+ * Allocates dynamically a RNA2Dfold_cmdline_parser_params structure and initializes
+ * all its fields to their default values
+ * @return the created and initialized RNA2Dfold_cmdline_parser_params structure
+ */
+struct RNA2Dfold_cmdline_parser_params *RNA2Dfold_cmdline_parser_params_create(void);
+
+/**
+ * Initializes the passed RNA2Dfold_args_info structure's fields
+ * (also set default values for options that have a default)
+ * @param args_info the structure to initialize
+ */
+void RNA2Dfold_cmdline_parser_init (struct RNA2Dfold_args_info *args_info);
+/**
+ * Deallocates the string fields of the RNA2Dfold_args_info structure
+ * (but does not deallocate the structure itself)
+ * @param args_info the structure to deallocate
+ */
+void RNA2Dfold_cmdline_parser_free (struct RNA2Dfold_args_info *args_info);
+
+/**
+ * Checks that all the required options were specified
+ * @param args_info the structure to check
+ * @param prog_name the name of the program that will be used to print
+ * possible errors
+ * @return
+ */
+int RNA2Dfold_cmdline_parser_required (struct RNA2Dfold_args_info *args_info,
+ const char *prog_name);
+
+extern const char *RNA2Dfold_cmdline_parser_dangles_values[]; /**< @brief Possible values for dangles. */
+
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+#endif /* RNA2DFOLD_CMDL_H */
git://source.jalview.org / jabaws.git / blobdiff