applications/sequentialProps/SequentialPropsCmd.h

/** @file SequentialPropsCmd.h
 *  @brief The header file for the command line option parser
 *  generated by GNU Gengetopt version 2.22.4
 *  http://www.gnu.org/software/gengetopt.
 *  DO NOT modify this file, since it can be overwritten
 *  @author GNU Gengetopt by Lorenzo Bettini */

#ifndef SEQUENTIALPROPSCMD_H
#define SEQUENTIALPROPSCMD_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 CMDLINE_PARSER_PACKAGE
/** @brief the program name (used for printing errors) */
#define CMDLINE_PARSER_PACKAGE "SequentialProps"
#endif

#ifndef CMDLINE_PARSER_PACKAGE_NAME
/** @brief the complete program name (used for help and version) */
#define CMDLINE_PARSER_PACKAGE_NAME "SequentialProps"
#endif

#ifndef CMDLINE_PARSER_VERSION
/** @brief the program version */
#define CMDLINE_PARSER_VERSION "1.00"
#endif

/** @brief Where the command line options are stored */
struct gengetopt_args_info
{
  const char *help_help; /**< @brief Print help and exit help description.  */
  const char *version_help; /**< @brief Print version and exit help description.  */
  char * input_arg;     /**< @brief input dump file.  */
  char * input_orig;    /**< @brief input dump file original value given at command line.  */
  const char *input_help; /**< @brief input dump file help description.  */
  char * output_arg;    /**< @brief output file name.  */
  char * output_orig;   /**< @brief output file name original value given at command line.  */
  const char *output_help; /**< @brief output file name help description.  */
  char * sele1_arg;     /**< @brief select first stuntdouble set.  */
  char * sele1_orig;    /**< @brief select first stuntdouble set original value given at command line.  */
  const char *sele1_help; /**< @brief select first stuntdouble set help description.  */
  char * sele2_arg;     /**< @brief select second stuntdouble set (if sele2 is not set, use script from sele1).  */
  char * sele2_orig;    /**< @brief select second stuntdouble set (if sele2 is not set, use script from sele1) original value given at command line.  */
  const char *sele2_help; /**< @brief select second stuntdouble set (if sele2 is not set, use script from sele1) help description.  */
  int nbins_arg;        /**< @brief Number of bins (default='100').  */
  char * nbins_orig;    /**< @brief Number of bins original value given at command line.  */
  const char *nbins_help; /**< @brief Number of bins help description.  */
  const char *density_help; /**< @brief selection correlation function help description.  */
  
  unsigned int help_given ;     /**< @brief Whether help was given.  */
  unsigned int version_given ;  /**< @brief Whether version was given.  */
  unsigned int input_given ;    /**< @brief Whether input was given.  */
  unsigned int output_given ;   /**< @brief Whether output was given.  */
  unsigned int sele1_given ;    /**< @brief Whether sele1 was given.  */
  unsigned int sele2_given ;    /**< @brief Whether sele2 was given.  */
  unsigned int nbins_given ;    /**< @brief Whether nbins was given.  */
  unsigned int density_given ;  /**< @brief Whether density was given.  */

  char **inputs ; /**< @brief unamed options (options without names) */
  unsigned inputs_num ; /**< @brief unamed options number */
  int sequentialProps_group_counter; /**< @brief Counter for group sequentialProps */
} ;

/** @brief The additional parameters to pass to parser functions */
struct cmdline_parser_params
{
  int override; /**< @brief whether to override possibly already present options (default 0) */
  int initialize; /**< @brief whether to initialize the option structure gengetopt_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 gengetopt_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 *gengetopt_args_info_purpose;
/** @brief the usage string of the program */
extern const char *gengetopt_args_info_usage;
/** @brief all the lines making the help output */
extern const char *gengetopt_args_info_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 cmdline_parser (int argc, char **argv,
  struct gengetopt_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 cmdline_parser_ext() instead
 */
int cmdline_parser2 (int argc, char **argv,
  struct gengetopt_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 cmdline_parser_ext (int argc, char **argv,
  struct gengetopt_args_info *args_info,
  struct 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 cmdline_parser_dump(FILE *outfile,
  struct gengetopt_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 cmdline_parser_file_save(const char *filename,
  struct gengetopt_args_info *args_info);

/**
 * Print the help
 */
void cmdline_parser_print_help(void);
/**
 * Print the version
 */
void cmdline_parser_print_version(void);

/**
 * Initializes all the fields a cmdline_parser_params structure 
 * to their default values
 * @param params the structure to initialize
 */
void cmdline_parser_params_init(struct cmdline_parser_params *params);

/**
 * Allocates dynamically a cmdline_parser_params structure and initializes
 * all its fields to their default values
 * @return the created and initialized cmdline_parser_params structure
 */
struct cmdline_parser_params *cmdline_parser_params_create(void);

/**
 * Initializes the passed gengetopt_args_info structure's fields
 * (also set default values for options that have a default)
 * @param args_info the structure to initialize
 */
void cmdline_parser_init (struct gengetopt_args_info *args_info);
/**
 * Deallocates the string fields of the gengetopt_args_info structure
 * (but does not deallocate the structure itself)
 * @param args_info the structure to deallocate
 */
void cmdline_parser_free (struct gengetopt_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 cmdline_parser_required (struct gengetopt_args_info *args_info,
  const char *prog_name);


#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* SEQUENTIALPROPSCMD_H */
Revision:	2024
Committed:	Thu Oct 16 19:13:51 2014 UTC (10 years, 6 months ago) by gezelter
Content type:	text/plain
File size:	8157 byte(s)
Log Message:	Added Radial and Z-projected velocity autocorrelation functions Started to add SequentialProps program Mucking about with angular restraint potentials
#	Content
1	/** @file SequentialPropsCmd.h
2	* @brief The header file for the command line option parser
3	* generated by GNU Gengetopt version 2.22.4
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 SEQUENTIALPROPSCMD_H
9	#define SEQUENTIALPROPSCMD_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 "SequentialProps"
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 "SequentialProps"
30	#endif
31
32	#ifndef CMDLINE_PARSER_VERSION
33	/** @brief the program version */
34	#define CMDLINE_PARSER_VERSION "1.00"
35	#endif
36
37	/** @brief Where the command line options are stored */
38	struct gengetopt_args_info
39	{
40	const char help_help; /< @brief Print help and exit help description. /
41	const char version_help; /< @brief Print version and exit help description. /
42	char * input_arg; /*< @brief input dump file. /
43	char * input_orig; /*< @brief input dump file original value given at command line. /
44	const char input_help; /< @brief input dump file help description. /
45	char * output_arg; /*< @brief output file name. /
46	char * output_orig; /*< @brief output file name original value given at command line. /
47	const char output_help; /< @brief output file name help description. /
48	char * sele1_arg; /*< @brief select first stuntdouble set. /
49	char * sele1_orig; /*< @brief select first stuntdouble set original value given at command line. /
50	const char sele1_help; /< @brief select first stuntdouble set help description. /
51	char * sele2_arg; /*< @brief select second stuntdouble set (if sele2 is not set, use script from sele1). /
52	char * sele2_orig; /*< @brief select second stuntdouble set (if sele2 is not set, use script from sele1) original value given at command line. /
53	const char sele2_help; /< @brief select second stuntdouble set (if sele2 is not set, use script from sele1) help description. /
54	int nbins_arg; /*< @brief Number of bins (default='100'). /
55	char * nbins_orig; /*< @brief Number of bins original value given at command line. /
56	const char nbins_help; /< @brief Number of bins help description. /
57	const char density_help; /< @brief selection correlation function help description. /
58
59	unsigned int help_given ; /*< @brief Whether help was given. /
60	unsigned int version_given ; /*< @brief Whether version was given. /
61	unsigned int input_given ; /*< @brief Whether input was given. /
62	unsigned int output_given ; /*< @brief Whether output was given. /
63	unsigned int sele1_given ; /*< @brief Whether sele1 was given. /
64	unsigned int sele2_given ; /*< @brief Whether sele2 was given. /
65	unsigned int nbins_given ; /*< @brief Whether nbins was given. /
66	unsigned int density_given ; /*< @brief Whether density was given. /
67
68	char inputs ; /< @brief unamed options (options without names) */
69	unsigned inputs_num ; /*< @brief unamed options number /
70	int sequentialProps_group_counter; /*< @brief Counter for group sequentialProps /
71	} ;
72
73	/** @brief The additional parameters to pass to parser functions */
74	struct cmdline_parser_params
75	{
76	int override; /*< @brief whether to override possibly already present options (default 0) /
77	int initialize; /*< @brief whether to initialize the option structure gengetopt_args_info (default 1) /
78	int check_required; /*< @brief whether to check that all required options were provided (default 1) /
79	int check_ambiguity; /*< @brief whether to check for options already specified in the option structure gengetopt_args_info (default 0) /
80	int print_errors; /*< @brief whether getopt_long should print an error message for a bad option (default 1) /
81	} ;
82
83	/** @brief the purpose string of the program */
84	extern const char *gengetopt_args_info_purpose;
85	/** @brief the usage string of the program */
86	extern const char *gengetopt_args_info_usage;
87	/** @brief all the lines making the help output */
88	extern const char *gengetopt_args_info_help[];
89
90	/**
91	* The command line parser
92	* @param argc the number of command line options
93	* @param argv the command line options
94	* @param args_info the structure where option information will be stored
95	* @return 0 if everything went fine, NON 0 if an error took place
96	*/
97	int cmdline_parser (int argc, char **argv,
98	struct gengetopt_args_info *args_info);
99
100	/**
101	* The command line parser (version with additional parameters - deprecated)
102	* @param argc the number of command line options
103	* @param argv the command line options
104	* @param args_info the structure where option information will be stored
105	* @param override whether to override possibly already present options
106	* @param initialize whether to initialize the option structure my_args_info
107	* @param check_required whether to check that all required options were provided
108	* @return 0 if everything went fine, NON 0 if an error took place
109	* @deprecated use cmdline_parser_ext() instead
110	*/
111	int cmdline_parser2 (int argc, char **argv,
112	struct gengetopt_args_info *args_info,
113	int override, int initialize, int check_required);
114
115	/**
116	* The command line parser (version with additional parameters)
117	* @param argc the number of command line options
118	* @param argv the command line options
119	* @param args_info the structure where option information will be stored
120	* @param params additional parameters for the parser
121	* @return 0 if everything went fine, NON 0 if an error took place
122	*/
123	int cmdline_parser_ext (int argc, char **argv,
124	struct gengetopt_args_info *args_info,
125	struct cmdline_parser_params *params);
126
127	/**
128	* Save the contents of the option struct into an already open FILE stream.
129	* @param outfile the stream where to dump options
130	* @param args_info the option struct to dump
131	* @return 0 if everything went fine, NON 0 if an error took place
132	*/
133	int cmdline_parser_dump(FILE *outfile,
134	struct gengetopt_args_info *args_info);
135
136	/**
137	* Save the contents of the option struct into a (text) file.
138	* This file can be read by the config file parser (if generated by gengetopt)
139	* @param filename the file where to save
140	* @param args_info the option struct to save
141	* @return 0 if everything went fine, NON 0 if an error took place
142	*/
143	int cmdline_parser_file_save(const char *filename,
144	struct gengetopt_args_info *args_info);
145
146	/**
147	* Print the help
148	*/
149	void cmdline_parser_print_help(void);
150	/**
151	* Print the version
152	*/
153	void cmdline_parser_print_version(void);
154
155	/**
156	* Initializes all the fields a cmdline_parser_params structure
157	* to their default values
158	* @param params the structure to initialize
159	*/
160	void cmdline_parser_params_init(struct cmdline_parser_params *params);
161
162	/**
163	* Allocates dynamically a cmdline_parser_params structure and initializes
164	* all its fields to their default values
165	* @return the created and initialized cmdline_parser_params structure
166	*/
167	struct cmdline_parser_params *cmdline_parser_params_create(void);
168
169	/**
170	* Initializes the passed gengetopt_args_info structure's fields
171	* (also set default values for options that have a default)
172	* @param args_info the structure to initialize
173	*/
174	void cmdline_parser_init (struct gengetopt_args_info *args_info);
175	/**
176	* Deallocates the string fields of the gengetopt_args_info structure
177	* (but does not deallocate the structure itself)
178	* @param args_info the structure to deallocate
179	*/
180	void cmdline_parser_free (struct gengetopt_args_info *args_info);
181
182	/**
183	* Checks that all the required options were specified
184	* @param args_info the structure to check
185	* @param prog_name the name of the program that will be used to print
186	* possible errors
187	* @return
188	*/
189	int cmdline_parser_required (struct gengetopt_args_info *args_info,
190	const char *prog_name);
191
192
193	#ifdef __cplusplus
194	}
195	#endif /* __cplusplus */
196	#endif /* SEQUENTIALPROPSCMD_H */