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
241
242
243
244
245
246
247
248
249
|
/* Hierarchial argument parsing, layered over getopt
Copyright (C) 1995 Free Software Foundation, Inc.
Written by Miles Bader <miles@gnu.ai.mit.edu>
This file is part of the GNU Hurd.
The GNU Hurd is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2, or (at
your option) any later version.
The GNU Hurd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
#ifndef __ARGP_H__
#define __ARGP_H__
#include <stdio.h>
#include <errno.h>
#include <ctype.h>
#include <getopt.h>
/* A description of a particular option. A pointer to an array of
these is passed in the OPTIONS field of an argp structure. Each option
entry can correspond to one long option and/or one short option; more
names for the same option can be added by following an entry in an option
array with options having the OPTION_ALIAS flag set. */
struct argp_option
{
/* The long option name. For more than one name for the same option, you
can use following options with the OPTION_ALIAS flag set. */
char *name;
/* What key is returned for this option. If > 0 and printable, then it's
also accepted as a short option. */
int key;
/* If non-NULL, this is the name of the argument associated with this
option, which is required unless the OPTION_ARG_OPTIONAL flag is set. */
char *arg;
/* OPTION_ flags. */
int flags;
/* The doc string for this option. */
char *doc;
};
/* The argument associated with this option is optional. */
#define OPTION_ARG_OPTIONAL 0x1
/* This option isn't displayed in any help messages. */
#define OPTION_HIDDEN 0x2
/* This option is an alias for the closest previous non-alias option. This
means that it will be displayed in the same help entry, and will inherit
fields other than NAME and KEY from the aliased option. */
#define OPTION_ALIAS 0x4
struct argp; /* fwd declare this type */
struct argp_state; /* " */
/* The type of a pointer to an argp parsing function. */
typedef error_t (*argp_parser_t)(int key, char *arg, struct argp_state *state);
/* Special values for the KEY argument to an argument parsing function.
EINVAL should be returned if they aren't understood.
The sequence of keys to parser calls is either (where opt is a user key):
(opt | ARGP_KEY_ARG)... ARGP_KEY_END
or opt... ARGP_KEY_NO_ARGS ARGP_KEY_END. */
/* This is not an option at all, but rather a command line argument. If a
parser receiving this key returns success, the fact is recorded, and the
ARGP_KEY_NO_ARGS case won't be used. HOWEVER, if while processing the
argument, a parser function decrements the INDEX field of the state it's
passed, the option won't be considered processed; this is to allow you to
actually modify the argument (perhaps into an option), and have it
processed again. */
#define ARGP_KEY_ARG 0
/* There are no more command line arguments at all. */
#define ARGP_KEY_END 1
/* Because it's common to want to do some special processing if there aren't
any non-option args, user parsers are called with this key if they didn't
successfully process any non-option arguments. Called just before
ARGP_KEY_END (where more general validity checks on previously parsed
arguments can take place). */
#define ARGP_KEY_NO_ARGS 2
/* An argp structure contains a set of getopt options declarations, a
function to deal with getting one, and an optional pointer to another
argp structure. When actually parsing options, getopt is called with
the union of all the argp structures chained together through their
PARENT pointers, with conflicts being resolved in favor of the first
occurance in the chain. */
struct argp
{
/* An array of argp_option structures, terminated by an entry with both
NAME and KEY having a value of 0. */
struct argp_option *options;
/* What to do with an option from this structure. KEY is the key
associated with the option, and ARG is any associated argument (NULL if
none was supplied). If KEY isn't understood, EINVAL should be
returned. If a non-zero, non-EINVAL value is returned, then parsing is
stopped immediately, and that value is returned from argp_parse().
For special (non-user-supplied) values of KEY, see the ARGP_KEY_
definitions below. */
argp_parser_t parser;
/* A string describing what other arguments are wanted by this program. It
is only used by argp_usage to print the `Usage:' message. */
char *args_doc;
/* A string containing extra text to be printed after the options in a long
help message, if it is non-NULL. */
char *doc;
/* A NULL terminated list of other argp structures that should be parsed
with this one. Any conflicts are resolved in favor of this argp, or
early argps in the PARENTS list. This field is useful if you use
libraries that supply their own argp structure, which you want to use in
conjunction with your own. */
struct argp **parents;
};
/* Parsing state. This is provided to parsing functions called by argp,
which may examine and, as noted, modify fields. */
struct argp_state
{
/* The top level ARGP being parsed. */
struct argp *argp;
/* The argument vector being parsed. May be modified. */
int argc;
char **argv;
/* The current index into ARGV. May be modified. */
int index;
/* The flags supplied to argp_parse. May be modified. */
unsigned flags;
};
/* Flags for argp_parse (note that the defaults are those that are
convenient for program command line parsing): */
/* Don't ignore the first element of ARGV. Normally (and always unless
ARGP_NO_ERRS is set) the first element of the argument vector is
skipped for option parsing purposes, as it corresponds to the program name
in a command line. */
#define ARGP_PARSE_ARGV0 0x1
/* Don't print error messages for unknown options to stderr; unless this flag
is set, ARGP_PARSE_ARGV0 is ignored, as ARGV[0] is used as the program
name in the error messages. */
#define ARGP_NO_ERRS 0x2
/* Don't parse any non-option args. Normally non-option args are parsed by
calling the parse functions with a key of ARGP_KEY_ARG, and the actual
arg as the value. Since it's impossible to know which parse function
wants to handle it, each one is called in turn, until one returns 0 or an
error other than EINVAL; if an argument is handled by no one, the
argp_parse returns prematurely (but with a return value of 0). If
all args have been parsed without error, all parsing functions are called
one last time with a key of ARGP_KEY_END. This flag needn't normally
be set, as the normal behavior is to stop parsing as soon as some argument
can't be handled. */
#define ARGP_NO_ARGS 0x4
/* Parse options and arguments in the same order they occur on the command
line -- normally they're rearranged so that all options come first. */
#define ARGP_IN_ORDER 0x8
/* Don't provide the following standard help behavior:
o A long option --help is automatically added, which causes usage and
option help information to be output to stdout, and exit (0) called.
o Any option parsing errors will result in a short `Try --help' message
to be output to stderr and exit (1) called. */
#define ARGP_NO_HELP 0x16
/* Disables the exiting behavior of the above default argp help messages. */
#define ARGP_NO_EXIT 0x32
/* Turns off any message-printing/exiting options. */
#define ARGP_SILENT (ARGP_NO_ERRS | ARGP_NO_HELP)
/* Parse the options strings in ARGC & ARGV according to the options in
ARGP. FLAGS is one of the ARGP_ flags above. If ARG_INDEX is
non-NULL, the index in ARGV of the first unparsed option is returned in
it. If an unknown option is present, EINVAL is returned; if some parser
routine returned a non-zero value, it is returned; otherwise 0 is
returned. This function may also call exit unless the ARGP_NO_HELP
flag is set. */
error_t argp_parse (struct argp *argp, int argc, char **argv, unsigned flags,
int *arg_index);
/* Flags for argp_help: */
#define ARGP_HELP_USAGE 0x01 /* Print a Usage: message. */
#define ARGP_HELP_SHORT_USAGE 0x02 /* " but don't actually print options. */
#define ARGP_HELP_SEE 0x04 /* Print a `for more help...' message. */
#define ARGP_HELP_LONG 0x08 /* Print a long help message. */
#define ARGP_HELP_EXIT_ERR 0x10 /* Call exit(1) instead of returning. */
#define ARGP_HELP_EXIT_OK 0x20 /* Call exit(0) instead of returning. */
/* If used as a flag to argp_help, this has the same effect as
ARGP_HELP_EXIT_ERR. However it can be used to clear both types of exit
flags at once. */
#define ARGP_HELP_EXIT (ARGP_HELP_EXIT_ERR | ARGP_HELP_EXIT_OK)
/* The standard thing to do after a program command line parsing error, if an
error messages has already been printed. */
#define ARGP_HELP_STD_ERR \
(ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR)
/* The standard thing to do after a program command line parsing error, if no
more specific error message has been printed. */
#define ARGP_HELP_STD_USAGE \
(ARGP_HELP_SHORT_USAGE | ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR)
/* The standard thing to do in response to a --help option. */
#define ARGP_HELP_STD_HELP \
(ARGP_HELP_SHORT_USAGE | ARGP_HELP_LONG | ARGP_HELP_EXIT_OK)
/* Output a usage message for ARGP to STREAM. FLAGS are from the set
ARGP_HELP_*. */
void argp_help (struct argp *argp, FILE *stream, unsigned flags);
/* Returns true if the option OPT is a valid short option. */
extern inline int
_option_is_short (struct argp_option *opt)
{
int key = opt->key;
return key > 0 && isprint (key);
}
/* Returns true if the option OPT is in fact the last (unused) entry in an
options array. */
extern inline int
_option_is_end (struct argp_option *opt)
{
return !opt->key && !opt->name;
}
#endif /* __ARGP_H__ */
|
