1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
/** @file test_simple_multiple_cmd.h
* @brief The header file for the command line option parser
* generated by GNU Gengetopt
* http://www.gnu.org/software/gengetopt.
* DO NOT modify this file, since it can be overwritten
* @author GNU Gengetopt by Lorenzo Bettini */
#ifndef TEST_SIMPLE_MULTIPLE_CMD_H
#define TEST_SIMPLE_MULTIPLE_CMD_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 TEST_SIMPLE_MULTIPLE_CMD_PARSER_PACKAGE
/** @brief the program name (used for printing errors) */
#define TEST_SIMPLE_MULTIPLE_CMD_PARSER_PACKAGE "test_simple_multiple"
#endif
#ifndef TEST_SIMPLE_MULTIPLE_CMD_PARSER_PACKAGE_NAME
/** @brief the complete program name (used for help and version) */
#define TEST_SIMPLE_MULTIPLE_CMD_PARSER_PACKAGE_NAME "test_simple_multiple"
#endif
#ifndef TEST_SIMPLE_MULTIPLE_CMD_PARSER_VERSION
/** @brief the program version */
#define TEST_SIMPLE_MULTIPLE_CMD_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 ** string_arg; /**< @brief string option (default='foo'). */
char ** string_orig; /**< @brief string option original value given at command line. */
unsigned int string_min; /**< @brief string option's minimum occurreces */
unsigned int string_max; /**< @brief string option's maximum occurreces */
const char *string_help; /**< @brief string option help description. */
unsigned int help_given ; /**< @brief Whether help was given. */
unsigned int version_given ; /**< @brief Whether version was given. */
unsigned int string_given ; /**< @brief Whether string 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 test_simple_multiple_cmd_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 the description string of the program */
extern const char *gengetopt_args_info_description;
/** @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 test_simple_multiple_cmd_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 test_simple_multiple_cmd_parser_ext() instead
*/
int test_simple_multiple_cmd_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 test_simple_multiple_cmd_parser_ext (int argc, char **argv,
struct gengetopt_args_info *args_info,
struct test_simple_multiple_cmd_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 test_simple_multiple_cmd_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 test_simple_multiple_cmd_parser_file_save(const char *filename,
struct gengetopt_args_info *args_info);
/**
* Print the help
*/
void test_simple_multiple_cmd_parser_print_help(void);
/**
* Print the version
*/
void test_simple_multiple_cmd_parser_print_version(void);
/**
* Initializes all the fields a test_simple_multiple_cmd_parser_params structure
* to their default values
* @param params the structure to initialize
*/
void test_simple_multiple_cmd_parser_params_init(struct test_simple_multiple_cmd_parser_params *params);
/**
* Allocates dynamically a test_simple_multiple_cmd_parser_params structure and initializes
* all its fields to their default values
* @return the created and initialized test_simple_multiple_cmd_parser_params structure
*/
struct test_simple_multiple_cmd_parser_params *test_simple_multiple_cmd_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 test_simple_multiple_cmd_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 test_simple_multiple_cmd_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 test_simple_multiple_cmd_parser_required (struct gengetopt_args_info *args_info,
const char *prog_name);
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* TEST_SIMPLE_MULTIPLE_CMD_H */
|
