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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
/*==============================================================================
HERE IS AN EXAMPLE OF THE USE OF SHHOPT:
#include <shhopt.h>
int
main ( int argc, char **argv ) {
int help_flag = 7;
unsigned int help_spec =7;
unsigned int height_spec =7;
unsigned int name_spec= 7;
char *name= "initial";
int height=7;
int verbose_flag=7;
int debug_flag=7;
struct optNameValue * optlist;
optStruct3 opt;
unsigned int option_def_index = 0;
optEntry *option_def = malloc(100*sizeof(option_def[0]));
OPTENT3(0, "help", OPT_FLAG, &help_flag, &help_spec, 0);
OPTENT3(0, "height", OPT_INT, &height, &height_spec, 0);
OPTENT3('n', "name", OPT_STRING, &name, &name_spec, 0);
OPTENT3('v', "verbose", OPT_FLAG, &verbose_flag, NULL, 0);
OPTENT3('g', "debug", OPT_FLAG, &debug_flag, NULL, 0);
OPTENT3(0, "options", OPT_NAMELIST, &optlist, NULL, 0);
opt.opt_table = option_def;
opt.short_allowed = 1;
opt.allowNegNum = 1;
optParseOptions3(&argc, argv, opt, sizeof(opt), 0);
printf("argc=%d\n", argc);
printf("help_flag=%d\n", help_flag);
printf("help_spec=%d\n", help_spec);
printf("height=%d\n", height);
printf("height_spec=%d\n", height_spec);
printf("name='%s'\n", name);
printf("name_spec=%d\n", name_spec);
printf("verbose_flag=%d\n", verbose_flag);
printf("debug_flag=%d\n", verbose_flag);
if (optlist) {
unsigned int i;
while (optlist[i].name) {
printf("option '%s' = '%s'\n", optlist[i].name, optlist[i].value);
++i;
}
optDestroyNameValueList(optlist);
} else
printf("No -options\n");
}
Now run this program with something like
myprog -vg --name=Bryan --hei 4 "My first argument" --help
or do it with opt.short_allowed=0 and
myprog -v /etc/passwd -name=Bryan --hei=4
========================================================================*/
#ifndef SHHOPT_H
#define SHHOPT_H
#ifdef __cplusplus
extern "C" {
#endif
#if 0
} /* to fake out automatic code indenters */
#endif
/* constants for recognized option types. */
typedef enum {
OPT_END, /* nothing. used as ending element. */
OPT_FLAG, /* no argument following. sets variable to 1. */
OPT_STRING, /* string argument. */
OPT_INT, /* signed integer argument. */
OPT_UINT, /* unsigned integer argument. */
OPT_LONG, /* signed long integer argument. */
OPT_ULONG, /* unsigned long integer argument. */
OPT_FLOAT, /* floating point argument. */
OPT_NAMELIST /* list like "key1=val1,key2=val2" */
} optArgType;
typedef struct {
/* This structure describes a single program option in a form for
use by the optParseOptions() or optParseOptions2() function.
*/
char shortName; /* short option name. */
const char *longName; /* long option name, not including '--'. */
optArgType type; /* option type. */
void *arg; /* pointer to variable to fill with argument,
* or pointer to function if type == OPT_FUNC. */
int flags; /* modifier flags. */
} optStruct;
typedef struct {
/* This structure describes a single program option in a form for
use by the optParseOptions3() function.
*/
char shortName; /* short option name. */
const char *longName; /* long option name, not including '--' or '-' */
optArgType type; /* option type. */
void *arg;
/* pointer to variable in which to return option's argument (or TRUE
if it's a flag option), or pointer to function if
type == OPT_FUNC. If the option is specified multiple times, only
the rightmost one affects this return value.
*/
unsigned int *specified;
/* pointer to variable in which to return the number of times that
the option was specified. If NULL, don't return anything.
*/
int flags; /* modifier flags. */
} optEntry;
typedef struct {
/* This structure describes the options of a program in a form for
use with the optParseOptions2() function.
*/
unsigned char short_allowed; /* boolean */
/* The syntax may include short (i.e. one-character) options.
These options may be stacked within a single token (e.g.
-abc = -a -b -c). If this value is not true, the short option
member of the option table entry is meaningless and long
options may have either one or two dashes.
*/
unsigned char allowNegNum; /* boolean */
/* Anything that starts with - and then a digit is a numeric
parameter, not an option
*/
optStruct *opt_table;
} optStruct2;
typedef struct {
/* Same as optStruct2, but for optParseOptions3() */
unsigned char short_allowed;
unsigned char allowNegNum;
optEntry *opt_table;
} optStruct3;
/* You can use OPTENTRY to assign a value to a dynamically or automatically
allocated optStruct structure with minimal typing and easy readability.
Here is an example:
unsigned int option_def_index = 0;
optStruct *option_def = malloc(100*sizeof(optStruct));
OPTENTRY('h', "help", OPT_FLAG, &help_flag, 0);
OPTENTRY(0, "alphaout", OPT_STRING, &alpha_filename, 0);
*/
/* If you name your variables option_def and option_def_index like in the
example above, everything's easy. If you want to use OPTENTRY with other
variables, define macros OPTION_DEF and OPTION_DEF_INDEX before calling
OPTENTRY.
*/
#ifndef OPTION_DEF
#define OPTION_DEF option_def
#endif
#ifndef OPTION_DEF_INDEX
#define OPTION_DEF_INDEX option_def_index
#endif
#define OPTENTRY(shortvalue,longvalue,typevalue,outputvalue,flagvalue) {\
OPTION_DEF[OPTION_DEF_INDEX].shortName = (shortvalue); \
OPTION_DEF[OPTION_DEF_INDEX].longName = (longvalue); \
OPTION_DEF[OPTION_DEF_INDEX].type = (typevalue); \
OPTION_DEF[OPTION_DEF_INDEX].arg = (outputvalue); \
OPTION_DEF[OPTION_DEF_INDEX].flags = (flagvalue); \
OPTION_DEF[++OPTION_DEF_INDEX].type = OPT_END; \
}
/* OPTENT3 is the same as OPTENTRY except that it also sets the "specified"
element of the table entry (so it assumes OPTION_DEF is a table of
optEntry instead of optStruct).
Here is an example:
unsigned int option_def_index = 0;
optEntry *option_def = malloc(100*sizeof(optEntry));
OPTENT3('h', "help", OPT_FLAG, &help_flag, 0);
OPTENT3(0, "alphaout", OPT_STRING, &alpha_filename, 0);
*/
#define OPTENT3(shortvalue,longvalue,typevalue,outputvalue,specifiedvalue, \
flagvalue) {\
OPTION_DEF[OPTION_DEF_INDEX].specified = (specifiedvalue); \
OPTENTRY(shortvalue, longvalue, typevalue, outputvalue, flagvalue) \
}
struct optNameValue {
const char * name;
const char * value;
};
void optSetFatalFunc(void (*f)(const char *, ...));
void optParseOptions(int *argc, char *argv[],
optStruct opt[], int allowNegNum);
void
optParseOptions2(int * const argc_p, char *argv[], const optStruct2 opt,
const unsigned long flags);
void
optParseOptions3(int * const argc_p, char *argv[], const optStruct3 opt,
const unsigned int optStructSize, const unsigned long flags);
void
optDestroyNameValueList(struct optNameValue * const list);
#ifdef __cplusplus
}
#endif
/* Here's a hack to help us introduce pm_c_util.h. That should be
#included in nearly every Netpbm program, but we're too lazy to insert
it into hundreds of files right now. But shhopt.h is included into
most of those files, so we #include it here!
Before 2005.12.03, the stuff that is now in pm_c_util.h was in pm.h,
but that's a bad place for it because pm.h is an external header file.
*/
#include "pm_c_util.h"
#endif
|
