applications/nanoparticleBuilder/icosahedralBuilderCmd.h

/** @file icosahedralBuilderCmd.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 ICOSAHEDRALBUILDERCMD_H
#define ICOSAHEDRALBUILDERCMD_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 "icosahedralBuilder"
#endif

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

#ifndef CMDLINE_PARSER_VERSION
/** @brief the program version */
#define CMDLINE_PARSER_VERSION "1.0"
#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 * 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.  */
  int shells_arg;       /**< @brief Nanoparticle shells.  */
  char * shells_orig;   /**< @brief Nanoparticle shells original value given at command line.  */
  const char *shells_help; /**< @brief Nanoparticle shells help description.  */
  double latticeConstant_arg;   /**< @brief Lattice spacing in Angstroms for cubic lattice..  */
  char * latticeConstant_orig;  /**< @brief Lattice spacing in Angstroms for cubic lattice. original value given at command line.  */
  const char *latticeConstant_help; /**< @brief Lattice spacing in Angstroms for cubic lattice. help description.  */
  int columnAtoms_arg;  /**< @brief Number of atoms along central column (Decahedron only).  */
  char * columnAtoms_orig;      /**< @brief Number of atoms along central column (Decahedron only) original value given at command line.  */
  const char *columnAtoms_help; /**< @brief Number of atoms along central column (Decahedron only) help description.  */
  int twinAtoms_arg;    /**< @brief Number of atoms along twin boundary (Decahedron only).  */
  char * twinAtoms_orig;        /**< @brief Number of atoms along twin boundary (Decahedron only) original value given at command line.  */
  const char *twinAtoms_help; /**< @brief Number of atoms along twin boundary (Decahedron only) help description.  */
  int truncatedPlanes_arg;      /**< @brief Number of truncated planes (Curling-stone Decahedron only).  */
  char * truncatedPlanes_orig;  /**< @brief Number of truncated planes (Curling-stone Decahedron only) original value given at command line.  */
  const char *truncatedPlanes_help; /**< @brief Number of truncated planes (Curling-stone Decahedron only) help description.  */
  const char *ico_help; /**< @brief Create an Icosahedral cluster help description.  */
  const char *deca_help; /**< @brief Create a regualar Decahedral cluster help description.  */
  const char *ino_help; /**< @brief Create an Ino Decahedral cluster help description.  */
  const char *marks_help; /**< @brief Create a Marks Decahedral cluster help description.  */
  const char *stone_help; /**< @brief Create a Curling-stone Decahedral cluster help description.  */
  
  unsigned int help_given ;     /**< @brief Whether help was given.  */
  unsigned int version_given ;  /**< @brief Whether version was given.  */
  unsigned int output_given ;   /**< @brief Whether output was given.  */
  unsigned int shells_given ;   /**< @brief Whether shells was given.  */
  unsigned int latticeConstant_given ;  /**< @brief Whether latticeConstant was given.  */
  unsigned int columnAtoms_given ;      /**< @brief Whether columnAtoms was given.  */
  unsigned int twinAtoms_given ;        /**< @brief Whether twinAtoms was given.  */
  unsigned int truncatedPlanes_given ;  /**< @brief Whether truncatedPlanes was given.  */
  unsigned int ico_given ;      /**< @brief Whether ico was given.  */
  unsigned int deca_given ;     /**< @brief Whether deca was given.  */
  unsigned int ino_given ;      /**< @brief Whether ino was given.  */
  unsigned int marks_given ;    /**< @brief Whether marks was given.  */
  unsigned int stone_given ;    /**< @brief Whether stone was given.  */

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

/** @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 /* ICOSAHEDRALBUILDERCMD_H */
Revision:	1862
Committed:	Fri Apr 12 20:45:04 2013 UTC (12 years, 1 month ago) by gezelter
Content type:	text/plain
File size:	9487 byte(s)
Log Message:	Adding nanoparticle generators, fixing a Qhull static link bug
#	User	Rev	Content
1	gezelter	1860	/** @file icosahedralBuilderCmd.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 ICOSAHEDRALBUILDERCMD_H
9			#define ICOSAHEDRALBUILDERCMD_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 "icosahedralBuilder"
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 "icosahedralBuilder"
30			#endif
31
32			#ifndef CMDLINE_PARSER_VERSION
33			/** @brief the program version */
34			#define CMDLINE_PARSER_VERSION "1.0"
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 * output_arg; /*< @brief Output file name. /
43			char * output_orig; /*< @brief Output file name original value given at command line. /
44			const char output_help; /< @brief Output file name help description. /
45	gezelter	1862	int shells_arg; /*< @brief Nanoparticle shells. /
46			char * shells_orig; /*< @brief Nanoparticle shells original value given at command line. /
47			const char shells_help; /< @brief Nanoparticle shells help description. /
48	gezelter	1860	double latticeConstant_arg; /*< @brief Lattice spacing in Angstroms for cubic lattice.. /
49			char * latticeConstant_orig; /*< @brief Lattice spacing in Angstroms for cubic lattice. original value given at command line. /
50			const char latticeConstant_help; /< @brief Lattice spacing in Angstroms for cubic lattice. help description. /
51	gezelter	1862	int columnAtoms_arg; /*< @brief Number of atoms along central column (Decahedron only). /
52			char * columnAtoms_orig; /*< @brief Number of atoms along central column (Decahedron only) original value given at command line. /
53			const char columnAtoms_help; /< @brief Number of atoms along central column (Decahedron only) help description. /
54			int twinAtoms_arg; /*< @brief Number of atoms along twin boundary (Decahedron only). /
55			char * twinAtoms_orig; /*< @brief Number of atoms along twin boundary (Decahedron only) original value given at command line. /
56			const char twinAtoms_help; /< @brief Number of atoms along twin boundary (Decahedron only) help description. /
57			int truncatedPlanes_arg; /*< @brief Number of truncated planes (Curling-stone Decahedron only). /
58			char * truncatedPlanes_orig; /*< @brief Number of truncated planes (Curling-stone Decahedron only) original value given at command line. /
59			const char truncatedPlanes_help; /< @brief Number of truncated planes (Curling-stone Decahedron only) help description. /
60			const char ico_help; /< @brief Create an Icosahedral cluster help description. /
61			const char deca_help; /< @brief Create a regualar Decahedral cluster help description. /
62			const char ino_help; /< @brief Create an Ino Decahedral cluster help description. /
63			const char marks_help; /< @brief Create a Marks Decahedral cluster help description. /
64			const char stone_help; /< @brief Create a Curling-stone Decahedral cluster help description. /
65	gezelter	1860
66			unsigned int help_given ; /*< @brief Whether help was given. /
67			unsigned int version_given ; /*< @brief Whether version was given. /
68			unsigned int output_given ; /*< @brief Whether output was given. /
69	gezelter	1862	unsigned int shells_given ; /*< @brief Whether shells was given. /
70	gezelter	1860	unsigned int latticeConstant_given ; /*< @brief Whether latticeConstant was given. /
71	gezelter	1862	unsigned int columnAtoms_given ; /*< @brief Whether columnAtoms was given. /
72			unsigned int twinAtoms_given ; /*< @brief Whether twinAtoms was given. /
73			unsigned int truncatedPlanes_given ; /*< @brief Whether truncatedPlanes was given. /
74			unsigned int ico_given ; /*< @brief Whether ico was given. /
75			unsigned int deca_given ; /*< @brief Whether deca was given. /
76			unsigned int ino_given ; /*< @brief Whether ino was given. /
77			unsigned int marks_given ; /*< @brief Whether marks was given. /
78			unsigned int stone_given ; /*< @brief Whether stone was given. /
79	gezelter	1860
80			char inputs ; /< @brief unamed options (options without names) */
81			unsigned inputs_num ; /*< @brief unamed options number /
82	gezelter	1862	int clusterShape_group_counter; /*< @brief Counter for group clusterShape /
83	gezelter	1860	} ;
84
85			/** @brief The additional parameters to pass to parser functions */
86			struct cmdline_parser_params
87			{
88			int override; /*< @brief whether to override possibly already present options (default 0) /
89			int initialize; /*< @brief whether to initialize the option structure gengetopt_args_info (default 1) /
90			int check_required; /*< @brief whether to check that all required options were provided (default 1) /
91			int check_ambiguity; /*< @brief whether to check for options already specified in the option structure gengetopt_args_info (default 0) /
92			int print_errors; /*< @brief whether getopt_long should print an error message for a bad option (default 1) /
93			} ;
94
95			/** @brief the purpose string of the program */
96			extern const char *gengetopt_args_info_purpose;
97			/** @brief the usage string of the program */
98			extern const char *gengetopt_args_info_usage;
99			/** @brief all the lines making the help output */
100			extern const char *gengetopt_args_info_help[];
101
102			/**
103			* The command line parser
104			* @param argc the number of command line options
105			* @param argv the command line options
106			* @param args_info the structure where option information will be stored
107			* @return 0 if everything went fine, NON 0 if an error took place
108			*/
109			int cmdline_parser (int argc, char **argv,
110			struct gengetopt_args_info *args_info);
111
112			/**
113			* The command line parser (version with additional parameters - deprecated)
114			* @param argc the number of command line options
115			* @param argv the command line options
116			* @param args_info the structure where option information will be stored
117			* @param override whether to override possibly already present options
118			* @param initialize whether to initialize the option structure my_args_info
119			* @param check_required whether to check that all required options were provided
120			* @return 0 if everything went fine, NON 0 if an error took place
121			* @deprecated use cmdline_parser_ext() instead
122			*/
123			int cmdline_parser2 (int argc, char **argv,
124			struct gengetopt_args_info *args_info,
125			int override, int initialize, int check_required);
126
127			/**
128			* The command line parser (version with additional parameters)
129			* @param argc the number of command line options
130			* @param argv the command line options
131			* @param args_info the structure where option information will be stored
132			* @param params additional parameters for the parser
133			* @return 0 if everything went fine, NON 0 if an error took place
134			*/
135			int cmdline_parser_ext (int argc, char **argv,
136			struct gengetopt_args_info *args_info,
137			struct cmdline_parser_params *params);
138
139			/**
140			* Save the contents of the option struct into an already open FILE stream.
141			* @param outfile the stream where to dump options
142			* @param args_info the option struct to dump
143			* @return 0 if everything went fine, NON 0 if an error took place
144			*/
145			int cmdline_parser_dump(FILE *outfile,
146			struct gengetopt_args_info *args_info);
147
148			/**
149			* Save the contents of the option struct into a (text) file.
150			* This file can be read by the config file parser (if generated by gengetopt)
151			* @param filename the file where to save
152			* @param args_info the option struct to save
153			* @return 0 if everything went fine, NON 0 if an error took place
154			*/
155			int cmdline_parser_file_save(const char *filename,
156			struct gengetopt_args_info *args_info);
157
158			/**
159			* Print the help
160			*/
161			void cmdline_parser_print_help(void);
162			/**
163			* Print the version
164			*/
165			void cmdline_parser_print_version(void);
166
167			/**
168			* Initializes all the fields a cmdline_parser_params structure
169			* to their default values
170			* @param params the structure to initialize
171			*/
172			void cmdline_parser_params_init(struct cmdline_parser_params *params);
173
174			/**
175			* Allocates dynamically a cmdline_parser_params structure and initializes
176			* all its fields to their default values
177			* @return the created and initialized cmdline_parser_params structure
178			*/
179			struct cmdline_parser_params *cmdline_parser_params_create(void);
180
181			/**
182			* Initializes the passed gengetopt_args_info structure's fields
183			* (also set default values for options that have a default)
184			* @param args_info the structure to initialize
185			*/
186			void cmdline_parser_init (struct gengetopt_args_info *args_info);
187			/**
188			* Deallocates the string fields of the gengetopt_args_info structure
189			* (but does not deallocate the structure itself)
190			* @param args_info the structure to deallocate
191			*/
192			void cmdline_parser_free (struct gengetopt_args_info *args_info);
193
194			/**
195			* Checks that all the required options were specified
196			* @param args_info the structure to check
197			* @param prog_name the name of the program that will be used to print
198			* possible errors
199			* @return
200			*/
201			int cmdline_parser_required (struct gengetopt_args_info *args_info,
202			const char *prog_name);
203
204
205			#ifdef __cplusplus
206			}
207			#endif /* __cplusplus */
208			#endif /* ICOSAHEDRALBUILDERCMD_H */