applications/hydrodynamics/HydroCmd.h

/** @file HydroCmd.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 HYDROCMD_H
#define HYDROCMD_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 "Hydro"
#endif

#ifndef CMDLINE_PARSER_PACKAGE_NAME
/** @brief the complete program name (used for help and version) */
#define CMDLINE_PARSER_PACKAGE_NAME "Hydro"
#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 * input_arg;     /**< @brief input MetaData (md) file.  */
  char * input_orig;    /**< @brief input MetaData (md) file original value given at command line.  */
  const char *input_help; /**< @brief input MetaData (md) file help description.  */
  char * output_arg;    /**< @brief output file prefix (default='hydro').  */
  char * output_orig;   /**< @brief output file prefix original value given at command line.  */
  const char *output_help; /**< @brief output file prefix help description.  */
  char * model_arg;     /**< @brief hydrodynamics model (supports RoughShell and BeadModel).  */
  char * model_orig;    /**< @brief hydrodynamics model (supports RoughShell and BeadModel) original value given at command line.  */
  const char *model_help; /**< @brief hydrodynamics model (supports RoughShell and BeadModel) help description.  */
  int beads_flag;       /**< @brief generate the beads only, hydrodynamics will be performed (default=off).  */
  const char *beads_help; /**< @brief generate the beads only, hydrodynamics will be performed 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 model_given ;    /**< @brief Whether model was given.  */
  unsigned int beads_given ;    /**< @brief Whether beads was given.  */

  char **inputs ; /**< @brief unamed options (options without names) */
  unsigned inputs_num ; /**< @brief unamed options number */
} ;

/** @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 /* HYDROCMD_H */
Revision:	1630
Committed:	Wed Sep 14 21:40:12 2011 UTC (13 years, 7 months ago) by gezelter
Content type:	text/plain
File size:	7501 byte(s)
Log Message:	updating gengetopt runs
#	User	Rev	Content
1	gezelter	1390	/** @file HydroCmd.h
2			* @brief The header file for the command line option parser
3	gezelter	1630	* generated by GNU Gengetopt version 2.22.4
4	gezelter	1390	* 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	tim	891
8			#ifndef HYDROCMD_H
9			#define HYDROCMD_H
10
11			/* If we use autoconf. */
12			#ifdef HAVE_CONFIG_H
13			#include "config.h"
14			#endif
15
16	gezelter	1390	#include <stdio.h> /* for FILE */
17
18	tim	891	#ifdef __cplusplus
19			extern "C" {
20			#endif /* __cplusplus */
21
22			#ifndef CMDLINE_PARSER_PACKAGE
23	gezelter	1630	/** @brief the program name (used for printing errors) */
24	tim	891	#define CMDLINE_PARSER_PACKAGE "Hydro"
25			#endif
26
27	gezelter	1630	#ifndef CMDLINE_PARSER_PACKAGE_NAME
28			/** @brief the complete program name (used for help and version) */
29			#define CMDLINE_PARSER_PACKAGE_NAME "Hydro"
30			#endif
31
32	tim	891	#ifndef CMDLINE_PARSER_VERSION
33	gezelter	1390	/** @brief the program version */
34	tim	891	#define CMDLINE_PARSER_VERSION "1.0"
35			#endif
36
37	gezelter	1390	/** @brief Where the command line options are stored */
38	tim	891	struct gengetopt_args_info
39			{
40	gezelter	1390	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 MetaData (md) file. /
43			char * input_orig; /*< @brief input MetaData (md) file original value given at command line. /
44			const char input_help; /< @brief input MetaData (md) file help description. /
45			char * output_arg; /*< @brief output file prefix (default='hydro'). /
46			char * output_orig; /*< @brief output file prefix original value given at command line. /
47			const char output_help; /< @brief output file prefix help description. /
48			char * model_arg; /*< @brief hydrodynamics model (supports RoughShell and BeadModel). /
49			char * model_orig; /*< @brief hydrodynamics model (supports RoughShell and BeadModel) original value given at command line. /
50			const char model_help; /< @brief hydrodynamics model (supports RoughShell and BeadModel) help description. /
51			int beads_flag; /*< @brief generate the beads only, hydrodynamics will be performed (default=off). /
52			const char beads_help; /< @brief generate the beads only, hydrodynamics will be performed help description. /
53	gezelter	938
54	gezelter	1390	unsigned int help_given ; /*< @brief Whether help was given. /
55			unsigned int version_given ; /*< @brief Whether version was given. /
56			unsigned int input_given ; /*< @brief Whether input was given. /
57			unsigned int output_given ; /*< @brief Whether output was given. /
58			unsigned int model_given ; /*< @brief Whether model was given. /
59			unsigned int beads_given ; /*< @brief Whether beads was given. /
60	tim	891
61	gezelter	1630	char inputs ; /< @brief unamed options (options without names) */
62			unsigned inputs_num ; /*< @brief unamed options number /
63	tim	891	} ;
64
65	gezelter	1390	/** @brief The additional parameters to pass to parser functions */
66			struct cmdline_parser_params
67			{
68			int override; /*< @brief whether to override possibly already present options (default 0) /
69			int initialize; /*< @brief whether to initialize the option structure gengetopt_args_info (default 1) /
70			int check_required; /*< @brief whether to check that all required options were provided (default 1) /
71			int check_ambiguity; /*< @brief whether to check for options already specified in the option structure gengetopt_args_info (default 0) /
72			int print_errors; /*< @brief whether getopt_long should print an error message for a bad option (default 1) /
73			} ;
74	tim	891
75	gezelter	1390	/** @brief the purpose string of the program */
76			extern const char *gengetopt_args_info_purpose;
77			/** @brief the usage string of the program */
78			extern const char *gengetopt_args_info_usage;
79			/** @brief all the lines making the help output */
80			extern const char *gengetopt_args_info_help[];
81
82			/**
83			* The command line parser
84			* @param argc the number of command line options
85			* @param argv the command line options
86			* @param args_info the structure where option information will be stored
87			* @return 0 if everything went fine, NON 0 if an error took place
88			*/
89	gezelter	1630	int cmdline_parser (int argc, char **argv,
90	gezelter	1390	struct gengetopt_args_info *args_info);
91
92			/**
93			* The command line parser (version with additional parameters - deprecated)
94			* @param argc the number of command line options
95			* @param argv the command line options
96			* @param args_info the structure where option information will be stored
97			* @param override whether to override possibly already present options
98			* @param initialize whether to initialize the option structure my_args_info
99			* @param check_required whether to check that all required options were provided
100			* @return 0 if everything went fine, NON 0 if an error took place
101			* @deprecated use cmdline_parser_ext() instead
102			*/
103	gezelter	1630	int cmdline_parser2 (int argc, char **argv,
104	gezelter	1390	struct gengetopt_args_info *args_info,
105			int override, int initialize, int check_required);
106
107			/**
108			* The command line parser (version with additional parameters)
109			* @param argc the number of command line options
110			* @param argv the command line options
111			* @param args_info the structure where option information will be stored
112			* @param params additional parameters for the parser
113			* @return 0 if everything went fine, NON 0 if an error took place
114			*/
115	gezelter	1630	int cmdline_parser_ext (int argc, char **argv,
116	gezelter	1390	struct gengetopt_args_info *args_info,
117			struct cmdline_parser_params *params);
118
119			/**
120			* Save the contents of the option struct into an already open FILE stream.
121			* @param outfile the stream where to dump options
122			* @param args_info the option struct to dump
123			* @return 0 if everything went fine, NON 0 if an error took place
124			*/
125			int cmdline_parser_dump(FILE *outfile,
126			struct gengetopt_args_info *args_info);
127
128			/**
129			* Save the contents of the option struct into a (text) file.
130			* This file can be read by the config file parser (if generated by gengetopt)
131			* @param filename the file where to save
132			* @param args_info the option struct to save
133			* @return 0 if everything went fine, NON 0 if an error took place
134			*/
135			int cmdline_parser_file_save(const char *filename,
136			struct gengetopt_args_info *args_info);
137
138			/**
139			* Print the help
140			*/
141	tim	891	void cmdline_parser_print_help(void);
142	gezelter	1390	/**
143			* Print the version
144			*/
145	tim	891	void cmdline_parser_print_version(void);
146
147	gezelter	1390	/**
148			* Initializes all the fields a cmdline_parser_params structure
149			* to their default values
150			* @param params the structure to initialize
151			*/
152			void cmdline_parser_params_init(struct cmdline_parser_params *params);
153
154			/**
155			* Allocates dynamically a cmdline_parser_params structure and initializes
156			* all its fields to their default values
157			* @return the created and initialized cmdline_parser_params structure
158			*/
159			struct cmdline_parser_params *cmdline_parser_params_create(void);
160
161			/**
162			* Initializes the passed gengetopt_args_info structure's fields
163			* (also set default values for options that have a default)
164			* @param args_info the structure to initialize
165			*/
166	gezelter	938	void cmdline_parser_init (struct gengetopt_args_info *args_info);
167	gezelter	1390	/**
168			* Deallocates the string fields of the gengetopt_args_info structure
169			* (but does not deallocate the structure itself)
170			* @param args_info the structure to deallocate
171			*/
172	gezelter	938	void cmdline_parser_free (struct gengetopt_args_info *args_info);
173
174	gezelter	1390	/**
175			* Checks that all the required options were specified
176			* @param args_info the structure to check
177			* @param prog_name the name of the program that will be used to print
178			* possible errors
179			* @return
180			*/
181			int cmdline_parser_required (struct gengetopt_args_info *args_info,
182			const char *prog_name);
183	gezelter	938
184
185	tim	891	#ifdef __cplusplus
186			}
187			#endif /* __cplusplus */
188			#endif /* HYDROCMD_H */