]>
Commit | Line | Data |
---|---|---|
c84142e8 | 1 | /* Hierarchial argument parsing, layered over getopt. |
85c54a32 | 2 | Copyright (C) 1995,1996,1997,1998,1999,2003 Free Software Foundation, Inc. |
c84142e8 UD |
3 | This file is part of the GNU C Library. |
4 | Written by Miles Bader <miles@gnu.ai.mit.edu>. | |
5 | ||
6 | The GNU C Library is free software; you can redistribute it and/or | |
41bdb6e2 AJ |
7 | modify it under the terms of the GNU Lesser General Public |
8 | License as published by the Free Software Foundation; either | |
9 | version 2.1 of the License, or (at your option) any later version. | |
c84142e8 UD |
10 | |
11 | The GNU C Library is distributed in the hope that it will be useful, | |
12 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
41bdb6e2 | 14 | Lesser General Public License for more details. |
c84142e8 | 15 | |
41bdb6e2 AJ |
16 | You should have received a copy of the GNU Lesser General Public |
17 | License along with the GNU C Library; if not, write to the Free | |
18 | Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA | |
19 | 02111-1307 USA. */ | |
c84142e8 | 20 | |
5107cf1d UD |
21 | #ifndef _ARGP_H |
22 | #define _ARGP_H | |
c84142e8 UD |
23 | |
24 | #include <stdio.h> | |
c84142e8 UD |
25 | #include <ctype.h> |
26 | #include <getopt.h> | |
27 | ||
1fb05e3d UD |
28 | #define __need_error_t |
29 | #include <errno.h> | |
30 | ||
c84142e8 | 31 | #ifndef __const |
36775c3b | 32 | # define __const const |
c84142e8 UD |
33 | #endif |
34 | ||
66b110e8 UD |
35 | #ifndef __THROW |
36 | # define __THROW | |
37 | #endif | |
38 | ||
1fb05e3d UD |
39 | #ifndef __error_t_defined |
40 | typedef int error_t; | |
36775c3b | 41 | # define __error_t_defined |
1fb05e3d | 42 | #endif |
c84142e8 UD |
43 | \f |
44 | #ifdef __cplusplus | |
45 | extern "C" { | |
46 | #endif | |
47 | ||
48 | /* A description of a particular option. A pointer to an array of | |
49 | these is passed in the OPTIONS field of an argp structure. Each option | |
50 | entry can correspond to one long option and/or one short option; more | |
51 | names for the same option can be added by following an entry in an option | |
52 | array with options having the OPTION_ALIAS flag set. */ | |
53 | struct argp_option | |
54 | { | |
55 | /* The long option name. For more than one name for the same option, you | |
56 | can use following options with the OPTION_ALIAS flag set. */ | |
57 | __const char *name; | |
58 | ||
59 | /* What key is returned for this option. If > 0 and printable, then it's | |
60 | also accepted as a short option. */ | |
61 | int key; | |
62 | ||
63 | /* If non-NULL, this is the name of the argument associated with this | |
64 | option, which is required unless the OPTION_ARG_OPTIONAL flag is set. */ | |
65 | __const char *arg; | |
66 | ||
67 | /* OPTION_ flags. */ | |
68 | int flags; | |
69 | ||
70 | /* The doc string for this option. If both NAME and KEY are 0, This string | |
71 | will be printed outdented from the normal option column, making it | |
72 | useful as a group header (it will be the first thing printed in its | |
73 | group); in this usage, it's conventional to end the string with a `:'. */ | |
74 | __const char *doc; | |
75 | ||
76 | /* The group this option is in. In a long help message, options are sorted | |
77 | alphabetically within each group, and the groups presented in the order | |
78 | 0, 1, 2, ..., n, -m, ..., -2, -1. Every entry in an options array with | |
79 | if this field 0 will inherit the group number of the previous entry, or | |
80 | zero if it's the first one, unless its a group header (NAME and KEY both | |
81 | 0), in which case, the previous entry + 1 is the default. Automagic | |
82 | options such as --help are put into group -1. */ | |
83 | int group; | |
84 | }; | |
85 | ||
86 | /* The argument associated with this option is optional. */ | |
87 | #define OPTION_ARG_OPTIONAL 0x1 | |
88 | ||
89 | /* This option isn't displayed in any help messages. */ | |
90 | #define OPTION_HIDDEN 0x2 | |
91 | ||
92 | /* This option is an alias for the closest previous non-alias option. This | |
93 | means that it will be displayed in the same help entry, and will inherit | |
94 | fields other than NAME and KEY from the aliased option. */ | |
95 | #define OPTION_ALIAS 0x4 | |
96 | ||
97 | /* This option isn't actually an option (and so should be ignored by the | |
98 | actual option parser), but rather an arbitrary piece of documentation that | |
99 | should be displayed in much the same manner as the options. If this flag | |
100 | is set, then the option NAME field is displayed unmodified (e.g., no `--' | |
101 | prefix is added) at the left-margin (where a *short* option would normally | |
102 | be displayed), and the documentation string in the normal place. For | |
85c54a32 | 103 | purposes of sorting, any leading whitespace and punctuation is ignored, |
c84142e8 UD |
104 | except that if the first non-whitespace character is not `-', this entry |
105 | is displayed after all options (and OPTION_DOC entries with a leading `-') | |
106 | in the same group. */ | |
107 | #define OPTION_DOC 0x8 | |
5a97622d UD |
108 | |
109 | /* This option shouldn't be included in `long' usage messages (but is still | |
110 | included in help messages). This is mainly intended for options that are | |
111 | completely documented in an argp's ARGS_DOC field, in which case including | |
112 | the option in the generic usage list would be redundant. For instance, | |
113 | if ARGS_DOC is "FOO BAR\n-x BLAH", and the `-x' option's purpose is to | |
114 | distinguish these two cases, -x should probably be marked | |
115 | OPTION_NO_USAGE. */ | |
116 | #define OPTION_NO_USAGE 0x10 | |
c84142e8 UD |
117 | \f |
118 | struct argp; /* fwd declare this type */ | |
119 | struct argp_state; /* " */ | |
120 | struct argp_child; /* " */ | |
121 | ||
122 | /* The type of a pointer to an argp parsing function. */ | |
c1422e5b UD |
123 | typedef error_t (*argp_parser_t) (int key, char *arg, |
124 | struct argp_state *state); | |
c84142e8 UD |
125 | |
126 | /* What to return for unrecognized keys. For special ARGP_KEY_ keys, such | |
127 | returns will simply be ignored. For user keys, this error will be turned | |
128 | into EINVAL (if the call to argp_parse is such that errors are propagated | |
129 | back to the user instead of exiting); returning EINVAL itself would result | |
130 | in an immediate stop to parsing in *all* cases. */ | |
131 | #define ARGP_ERR_UNKNOWN E2BIG /* Hurd should never need E2BIG. XXX */ | |
132 | ||
133 | /* Special values for the KEY argument to an argument parsing function. | |
134 | ARGP_ERR_UNKNOWN should be returned if they aren't understood. | |
135 | ||
5a97622d UD |
136 | The sequence of keys to a parsing function is either (where each |
137 | uppercased word should be prefixed by `ARGP_KEY_' and opt is a user key): | |
138 | ||
139 | INIT opt... NO_ARGS END SUCCESS -- No non-option arguments at all | |
140 | or INIT (opt | ARG)... END SUCCESS -- All non-option args parsed | |
141 | or INIT (opt | ARG)... SUCCESS -- Some non-option arg unrecognized | |
c84142e8 | 142 | |
5a97622d UD |
143 | The third case is where every parser returned ARGP_KEY_UNKNOWN for an |
144 | argument, in which case parsing stops at that argument (returning the | |
145 | unparsed arguments to the caller of argp_parse if requested, or stopping | |
146 | with an error message if not). | |
147 | ||
148 | If an error occurs (either detected by argp, or because the parsing | |
149 | function returned an error value), then the parser is called with | |
150 | ARGP_KEY_ERROR, and no further calls are made. */ | |
c84142e8 UD |
151 | |
152 | /* This is not an option at all, but rather a command line argument. If a | |
153 | parser receiving this key returns success, the fact is recorded, and the | |
154 | ARGP_KEY_NO_ARGS case won't be used. HOWEVER, if while processing the | |
155 | argument, a parser function decrements the NEXT field of the state it's | |
156 | passed, the option won't be considered processed; this is to allow you to | |
157 | actually modify the argument (perhaps into an option), and have it | |
158 | processed again. */ | |
159 | #define ARGP_KEY_ARG 0 | |
d705269e UD |
160 | /* There are remaining arguments not parsed by any parser, which may be found |
161 | starting at (STATE->argv + STATE->next). If success is returned, but | |
162 | STATE->next left untouched, it's assumed that all arguments were consume, | |
163 | otherwise, the parser should adjust STATE->next to reflect any arguments | |
164 | consumed. */ | |
165 | #define ARGP_KEY_ARGS 0x1000006 | |
c84142e8 UD |
166 | /* There are no more command line arguments at all. */ |
167 | #define ARGP_KEY_END 0x1000001 | |
168 | /* Because it's common to want to do some special processing if there aren't | |
169 | any non-option args, user parsers are called with this key if they didn't | |
170 | successfully process any non-option arguments. Called just before | |
171 | ARGP_KEY_END (where more general validity checks on previously parsed | |
172 | arguments can take place). */ | |
173 | #define ARGP_KEY_NO_ARGS 0x1000002 | |
174 | /* Passed in before any parsing is done. Afterwards, the values of each | |
175 | element of the CHILD_INPUT field, if any, in the state structure is | |
176 | copied to each child's state to be the initial value of the INPUT field. */ | |
177 | #define ARGP_KEY_INIT 0x1000003 | |
d705269e UD |
178 | /* Use after all other keys, including SUCCESS & END. */ |
179 | #define ARGP_KEY_FINI 0x1000007 | |
c84142e8 UD |
180 | /* Passed in when parsing has successfully been completed (even if there are |
181 | still arguments remaining). */ | |
182 | #define ARGP_KEY_SUCCESS 0x1000004 | |
d705269e | 183 | /* Passed in if an error occurs. */ |
c84142e8 UD |
184 | #define ARGP_KEY_ERROR 0x1000005 |
185 | ||
5a97622d UD |
186 | /* An argp structure contains a set of options declarations, a function to |
187 | deal with parsing one, documentation string, a possible vector of child | |
188 | argp's, and perhaps a function to filter help output. When actually | |
189 | parsing options, getopt is called with the union of all the argp | |
190 | structures chained together through their CHILD pointers, with conflicts | |
49c091e5 | 191 | being resolved in favor of the first occurrence in the chain. */ |
c84142e8 UD |
192 | struct argp |
193 | { | |
194 | /* An array of argp_option structures, terminated by an entry with both | |
195 | NAME and KEY having a value of 0. */ | |
196 | __const struct argp_option *options; | |
197 | ||
198 | /* What to do with an option from this structure. KEY is the key | |
199 | associated with the option, and ARG is any associated argument (NULL if | |
200 | none was supplied). If KEY isn't understood, ARGP_ERR_UNKNOWN should be | |
201 | returned. If a non-zero, non-ARGP_ERR_UNKNOWN value is returned, then | |
202 | parsing is stopped immediately, and that value is returned from | |
203 | argp_parse(). For special (non-user-supplied) values of KEY, see the | |
204 | ARGP_KEY_ definitions below. */ | |
205 | argp_parser_t parser; | |
206 | ||
207 | /* A string describing what other arguments are wanted by this program. It | |
208 | is only used by argp_usage to print the `Usage:' message. If it | |
209 | contains newlines, the strings separated by them are considered | |
210 | alternative usage patterns, and printed on separate lines (lines after | |
211 | the first are prefix by ` or: ' instead of `Usage:'). */ | |
212 | __const char *args_doc; | |
213 | ||
214 | /* If non-NULL, a string containing extra text to be printed before and | |
215 | after the options in a long help message (separated by a vertical tab | |
216 | `\v' character). */ | |
217 | __const char *doc; | |
218 | ||
219 | /* A vector of argp_children structures, terminated by a member with a 0 | |
220 | argp field, pointing to child argps should be parsed with this one. Any | |
221 | conflicts are resolved in favor of this argp, or early argps in the | |
222 | CHILDREN list. This field is useful if you use libraries that supply | |
223 | their own argp structure, which you want to use in conjunction with your | |
224 | own. */ | |
225 | __const struct argp_child *children; | |
1fb05e3d UD |
226 | |
227 | /* If non-zero, this should be a function to filter the output of help | |
228 | messages. KEY is either a key from an option, in which case TEXT is | |
229 | that option's help text, or a special key from the ARGP_KEY_HELP_ | |
230 | defines, below, describing which other help text TEXT is. The function | |
231 | should return either TEXT, if it should be used as-is, a replacement | |
232 | string, which should be malloced, and will be freed by argp, or NULL, | |
233 | meaning `print nothing'. The value for TEXT is *after* any translation | |
234 | has been done, so if any of the replacement text also needs translation, | |
235 | that should be done by the filter function. INPUT is either the input | |
236 | supplied to argp_parse, or NULL, if argp_help was called directly. */ | |
c1422e5b | 237 | char *(*help_filter) (int __key, __const char *__text, void *__input); |
9184d3db UD |
238 | |
239 | /* If non-zero the strings used in the argp library are translated using | |
240 | the domain described by this string. Otherwise the currently installed | |
241 | default domain is used. */ | |
242 | const char *argp_domain; | |
c84142e8 | 243 | }; |
1fb05e3d UD |
244 | |
245 | /* Possible KEY arguments to a help filter function. */ | |
246 | #define ARGP_KEY_HELP_PRE_DOC 0x2000001 /* Help text preceeding options. */ | |
247 | #define ARGP_KEY_HELP_POST_DOC 0x2000002 /* Help text following options. */ | |
248 | #define ARGP_KEY_HELP_HEADER 0x2000003 /* Option header string. */ | |
249 | #define ARGP_KEY_HELP_EXTRA 0x2000004 /* After all other documentation; | |
250 | TEXT is NULL for this key. */ | |
5a97622d UD |
251 | /* Explanatory note emitted when duplicate option arguments have been |
252 | suppressed. */ | |
4cca6b86 | 253 | #define ARGP_KEY_HELP_DUP_ARGS_NOTE 0x2000005 |
9498096c | 254 | #define ARGP_KEY_HELP_ARGS_DOC 0x2000006 /* Argument doc string. */ |
c84142e8 UD |
255 | \f |
256 | /* When an argp has a non-zero CHILDREN field, it should point to a vector of | |
257 | argp_child structures, each of which describes a subsidiary argp. */ | |
258 | struct argp_child | |
259 | { | |
260 | /* The child parser. */ | |
261 | __const struct argp *argp; | |
262 | ||
263 | /* Flags for this child. */ | |
264 | int flags; | |
265 | ||
266 | /* If non-zero, an optional header to be printed in help output before the | |
267 | child options. As a side-effect, a non-zero value forces the child | |
268 | options to be grouped together; to achieve this effect without actually | |
269 | printing a header string, use a value of "". */ | |
270 | __const char *header; | |
271 | ||
272 | /* Where to group the child options relative to the other (`consolidated') | |
273 | options in the parent argp; the values are the same as the GROUP field | |
274 | in argp_option structs, but all child-groupings follow parent options at | |
275 | a particular group level. If both this field and HEADER are zero, then | |
276 | they aren't grouped at all, but rather merged with the parent options | |
277 | (merging the child's grouping levels with the parents). */ | |
278 | int group; | |
279 | }; | |
280 | \f | |
281 | /* Parsing state. This is provided to parsing functions called by argp, | |
282 | which may examine and, as noted, modify fields. */ | |
283 | struct argp_state | |
284 | { | |
285 | /* The top level ARGP being parsed. */ | |
ebbad4cc | 286 | __const struct argp *root_argp; |
c84142e8 UD |
287 | |
288 | /* The argument vector being parsed. May be modified. */ | |
289 | int argc; | |
290 | char **argv; | |
291 | ||
292 | /* The index in ARGV of the next arg that to be parsed. May be modified. */ | |
293 | int next; | |
294 | ||
295 | /* The flags supplied to argp_parse. May be modified. */ | |
296 | unsigned flags; | |
297 | ||
298 | /* While calling a parsing function with a key of ARGP_KEY_ARG, this is the | |
299 | number of the current arg, starting at zero, and incremented after each | |
300 | such call returns. At all other times, this is the number of such | |
301 | arguments that have been processed. */ | |
302 | unsigned arg_num; | |
303 | ||
304 | /* If non-zero, the index in ARGV of the first argument following a special | |
305 | `--' argument (which prevents anything following being interpreted as an | |
306 | option). Only set once argument parsing has proceeded past this point. */ | |
307 | int quoted; | |
308 | ||
309 | /* An arbitrary pointer passed in from the user. */ | |
310 | void *input; | |
311 | /* Values to pass to child parsers. This vector will be the same length as | |
312 | the number of children for the current parser. */ | |
313 | void **child_inputs; | |
314 | ||
315 | /* For the parser's use. Initialized to 0. */ | |
316 | void *hook; | |
317 | ||
318 | /* The name used when printing messages. This is initialized to ARGV[0], | |
319 | or PROGRAM_INVOCATION_NAME if that is unavailable. */ | |
320 | char *name; | |
321 | ||
322 | /* Streams used when argp prints something. */ | |
323 | FILE *err_stream; /* For errors; initialized to stderr. */ | |
324 | FILE *out_stream; /* For information; initialized to stdout. */ | |
1fb05e3d UD |
325 | |
326 | void *pstate; /* Private, for use by argp. */ | |
c84142e8 UD |
327 | }; |
328 | \f | |
329 | /* Flags for argp_parse (note that the defaults are those that are | |
330 | convenient for program command line parsing): */ | |
331 | ||
332 | /* Don't ignore the first element of ARGV. Normally (and always unless | |
333 | ARGP_NO_ERRS is set) the first element of the argument vector is | |
334 | skipped for option parsing purposes, as it corresponds to the program name | |
335 | in a command line. */ | |
336 | #define ARGP_PARSE_ARGV0 0x01 | |
337 | ||
338 | /* Don't print error messages for unknown options to stderr; unless this flag | |
339 | is set, ARGP_PARSE_ARGV0 is ignored, as ARGV[0] is used as the program | |
340 | name in the error messages. This flag implies ARGP_NO_EXIT (on the | |
341 | assumption that silent exiting upon errors is bad behaviour). */ | |
342 | #define ARGP_NO_ERRS 0x02 | |
343 | ||
344 | /* Don't parse any non-option args. Normally non-option args are parsed by | |
345 | calling the parse functions with a key of ARGP_KEY_ARG, and the actual arg | |
346 | as the value. Since it's impossible to know which parse function wants to | |
347 | handle it, each one is called in turn, until one returns 0 or an error | |
348 | other than ARGP_ERR_UNKNOWN; if an argument is handled by no one, the | |
349 | argp_parse returns prematurely (but with a return value of 0). If all | |
350 | args have been parsed without error, all parsing functions are called one | |
351 | last time with a key of ARGP_KEY_END. This flag needn't normally be set, | |
352 | as the normal behavior is to stop parsing as soon as some argument can't | |
353 | be handled. */ | |
354 | #define ARGP_NO_ARGS 0x04 | |
355 | ||
356 | /* Parse options and arguments in the same order they occur on the command | |
357 | line -- normally they're rearranged so that all options come first. */ | |
358 | #define ARGP_IN_ORDER 0x08 | |
359 | ||
360 | /* Don't provide the standard long option --help, which causes usage and | |
361 | option help information to be output to stdout, and exit (0) called. */ | |
362 | #define ARGP_NO_HELP 0x10 | |
363 | ||
364 | /* Don't exit on errors (they may still result in error messages). */ | |
365 | #define ARGP_NO_EXIT 0x20 | |
366 | ||
367 | /* Use the gnu getopt `long-only' rules for parsing arguments. */ | |
368 | #define ARGP_LONG_ONLY 0x40 | |
369 | ||
370 | /* Turns off any message-printing/exiting options. */ | |
371 | #define ARGP_SILENT (ARGP_NO_EXIT | ARGP_NO_ERRS | ARGP_NO_HELP) | |
372 | ||
373 | /* Parse the options strings in ARGC & ARGV according to the options in ARGP. | |
374 | FLAGS is one of the ARGP_ flags above. If ARG_INDEX is non-NULL, the | |
375 | index in ARGV of the first unparsed option is returned in it. If an | |
376 | unknown option is present, ARGP_ERR_UNKNOWN is returned; if some parser | |
377 | routine returned a non-zero value, it is returned; otherwise 0 is | |
378 | returned. This function may also call exit unless the ARGP_NO_HELP flag | |
379 | is set. INPUT is a pointer to a value to be passed in to the parser. */ | |
c1422e5b UD |
380 | extern error_t argp_parse (__const struct argp *__restrict __argp, |
381 | int __argc, char **__restrict __argv, | |
382 | unsigned __flags, int *__restrict __arg_index, | |
383 | void *__restrict __input) __THROW; | |
384 | extern error_t __argp_parse (__const struct argp *__restrict __argp, | |
385 | int __argc, char **__restrict __argv, | |
386 | unsigned __flags, int *__restrict __arg_index, | |
387 | void *__restrict __input) __THROW; | |
c84142e8 UD |
388 | \f |
389 | /* Global variables. */ | |
390 | ||
391 | /* If defined or set by the user program to a non-zero value, then a default | |
392 | option --version is added (unless the ARGP_NO_HELP flag is used), which | |
1fb05e3d | 393 | will print this string followed by a newline and exit (unless the |
c84142e8 | 394 | ARGP_NO_EXIT flag is used). Overridden by ARGP_PROGRAM_VERSION_HOOK. */ |
4cca6b86 | 395 | extern __const char *argp_program_version; |
c84142e8 UD |
396 | |
397 | /* If defined or set by the user program to a non-zero value, then a default | |
398 | option --version is added (unless the ARGP_NO_HELP flag is used), which | |
399 | calls this function with a stream to print the version to and a pointer to | |
400 | the current parsing state, and then exits (unless the ARGP_NO_EXIT flag is | |
401 | used). This variable takes precedent over ARGP_PROGRAM_VERSION. */ | |
c1422e5b UD |
402 | extern void (*argp_program_version_hook) (FILE *__restrict __stream, |
403 | struct argp_state *__restrict | |
404 | __state); | |
c84142e8 UD |
405 | |
406 | /* If defined or set by the user program, it should point to string that is | |
407 | the bug-reporting address for the program. It will be printed by | |
408 | argp_help if the ARGP_HELP_BUG_ADDR flag is set (as it is by various | |
409 | standard help messages), embedded in a sentence that says something like | |
410 | `Report bugs to ADDR.'. */ | |
76b87c03 | 411 | extern __const char *argp_program_bug_address; |
4cca6b86 UD |
412 | |
413 | /* The exit status that argp will use when exiting due to a parsing error. | |
43b0e40f UD |
414 | If not defined or set by the user program, this defaults to EX_USAGE from |
415 | <sysexits.h>. */ | |
4cca6b86 | 416 | extern error_t argp_err_exit_status; |
c84142e8 UD |
417 | \f |
418 | /* Flags for argp_help. */ | |
419 | #define ARGP_HELP_USAGE 0x01 /* a Usage: message. */ | |
420 | #define ARGP_HELP_SHORT_USAGE 0x02 /* " but don't actually print options. */ | |
421 | #define ARGP_HELP_SEE 0x04 /* a `Try ... for more help' message. */ | |
422 | #define ARGP_HELP_LONG 0x08 /* a long help message. */ | |
423 | #define ARGP_HELP_PRE_DOC 0x10 /* doc string preceding long help. */ | |
424 | #define ARGP_HELP_POST_DOC 0x20 /* doc string following long help. */ | |
425 | #define ARGP_HELP_DOC (ARGP_HELP_PRE_DOC | ARGP_HELP_POST_DOC) | |
426 | #define ARGP_HELP_BUG_ADDR 0x40 /* bug report address */ | |
427 | #define ARGP_HELP_LONG_ONLY 0x80 /* modify output appropriately to | |
428 | reflect ARGP_LONG_ONLY mode. */ | |
429 | ||
430 | /* These ARGP_HELP flags are only understood by argp_state_help. */ | |
431 | #define ARGP_HELP_EXIT_ERR 0x100 /* Call exit(1) instead of returning. */ | |
432 | #define ARGP_HELP_EXIT_OK 0x200 /* Call exit(0) instead of returning. */ | |
433 | ||
434 | /* The standard thing to do after a program command line parsing error, if an | |
435 | error message has already been printed. */ | |
436 | #define ARGP_HELP_STD_ERR \ | |
437 | (ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR) | |
438 | /* The standard thing to do after a program command line parsing error, if no | |
439 | more specific error message has been printed. */ | |
440 | #define ARGP_HELP_STD_USAGE \ | |
441 | (ARGP_HELP_SHORT_USAGE | ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR) | |
442 | /* The standard thing to do in response to a --help option. */ | |
443 | #define ARGP_HELP_STD_HELP \ | |
444 | (ARGP_HELP_SHORT_USAGE | ARGP_HELP_LONG | ARGP_HELP_EXIT_OK \ | |
445 | | ARGP_HELP_DOC | ARGP_HELP_BUG_ADDR) | |
446 | ||
447 | /* Output a usage message for ARGP to STREAM. FLAGS are from the set | |
448 | ARGP_HELP_*. */ | |
c1422e5b UD |
449 | extern void argp_help (__const struct argp *__restrict __argp, |
450 | FILE *__restrict __stream, | |
451 | unsigned __flags, char *__restrict __name) __THROW; | |
64ad0de2 UD |
452 | extern void __argp_help (__const struct argp *__restrict __argp, |
453 | FILE *__restrict __stream, unsigned __flags, | |
454 | char *__name) __THROW; | |
c84142e8 UD |
455 | \f |
456 | /* The following routines are intended to be called from within an argp | |
457 | parsing routine (thus taking an argp_state structure as the first | |
458 | argument). They may or may not print an error message and exit, depending | |
459 | on the flags in STATE -- in any case, the caller should be prepared for | |
460 | them *not* to exit, and should return an appropiate error after calling | |
461 | them. [argp_usage & argp_error should probably be called argp_state_..., | |
462 | but they're used often enough that they should be short] */ | |
463 | ||
464 | /* Output, if appropriate, a usage message for STATE to STREAM. FLAGS are | |
465 | from the set ARGP_HELP_*. */ | |
c1422e5b UD |
466 | extern void argp_state_help (__const struct argp_state *__restrict __state, |
467 | FILE *__restrict __stream, | |
468 | unsigned int __flags) __THROW; | |
469 | extern void __argp_state_help (__const struct argp_state *__restrict __state, | |
470 | FILE *__restrict __stream, | |
471 | unsigned int __flags) __THROW; | |
c84142e8 UD |
472 | |
473 | /* Possibly output the standard usage message for ARGP to stderr and exit. */ | |
c1422e5b UD |
474 | extern void argp_usage (__const struct argp_state *__state) __THROW; |
475 | extern void __argp_usage (__const struct argp_state *__state) __THROW; | |
c84142e8 UD |
476 | |
477 | /* If appropriate, print the printf string FMT and following args, preceded | |
478 | by the program name and `:', to stderr, and followed by a `Try ... --help' | |
479 | message, then exit (1). */ | |
c1422e5b UD |
480 | extern void argp_error (__const struct argp_state *__restrict __state, |
481 | __const char *__restrict __fmt, ...) __THROW | |
c84142e8 | 482 | __attribute__ ((__format__ (__printf__, 2, 3))); |
c1422e5b UD |
483 | extern void __argp_error (__const struct argp_state *__restrict __state, |
484 | __const char *__restrict __fmt, ...) __THROW | |
c84142e8 UD |
485 | __attribute__ ((__format__ (__printf__, 2, 3))); |
486 | ||
487 | /* Similar to the standard gnu error-reporting function error(), but will | |
488 | respect the ARGP_NO_EXIT and ARGP_NO_ERRS flags in STATE, and will print | |
489 | to STATE->err_stream. This is useful for argument parsing code that is | |
490 | shared between program startup (when exiting is desired) and runtime | |
491 | option parsing (when typically an error code is returned instead). The | |
492 | difference between this function and argp_error is that the latter is for | |
493 | *parsing errors*, and the former is for other problems that occur during | |
494 | parsing but don't reflect a (syntactic) problem with the input. */ | |
c1422e5b UD |
495 | extern void argp_failure (__const struct argp_state *__restrict __state, |
496 | int __status, int __errnum, | |
497 | __const char *__restrict __fmt, ...) __THROW | |
c84142e8 | 498 | __attribute__ ((__format__ (__printf__, 4, 5))); |
c1422e5b UD |
499 | extern void __argp_failure (__const struct argp_state *__restrict __state, |
500 | int __status, int __errnum, | |
501 | __const char *__restrict __fmt, ...) __THROW | |
c84142e8 UD |
502 | __attribute__ ((__format__ (__printf__, 4, 5))); |
503 | ||
504 | /* Returns true if the option OPT is a valid short option. */ | |
c1422e5b UD |
505 | extern int _option_is_short (__const struct argp_option *__opt) __THROW; |
506 | extern int __option_is_short (__const struct argp_option *__opt) __THROW; | |
c84142e8 UD |
507 | |
508 | /* Returns true if the option OPT is in fact the last (unused) entry in an | |
509 | options array. */ | |
c1422e5b UD |
510 | extern int _option_is_end (__const struct argp_option *__opt) __THROW; |
511 | extern int __option_is_end (__const struct argp_option *__opt) __THROW; | |
1fb05e3d UD |
512 | |
513 | /* Return the input field for ARGP in the parser corresponding to STATE; used | |
514 | by the help routines. */ | |
c1422e5b UD |
515 | extern void *_argp_input (__const struct argp *__restrict __argp, |
516 | __const struct argp_state *__restrict __state) | |
517 | __THROW; | |
518 | extern void *__argp_input (__const struct argp *__restrict __argp, | |
519 | __const struct argp_state *__restrict __state) | |
520 | __THROW; | |
c84142e8 | 521 | \f |
0c6cee5d | 522 | #ifdef __USE_EXTERN_INLINES |
c84142e8 | 523 | |
36775c3b UD |
524 | # if !_LIBC |
525 | # define __argp_usage argp_usage | |
526 | # define __argp_state_help argp_state_help | |
527 | # define __option_is_short _option_is_short | |
528 | # define __option_is_end _option_is_end | |
529 | # endif | |
c84142e8 | 530 | |
36775c3b | 531 | # ifndef ARGP_EI |
6dbb7062 | 532 | # define ARGP_EI extern __inline__ |
36775c3b | 533 | # endif |
c84142e8 UD |
534 | |
535 | ARGP_EI void | |
99e46354 | 536 | __argp_usage (__const struct argp_state *__state) __THROW |
c84142e8 UD |
537 | { |
538 | __argp_state_help (__state, stderr, ARGP_HELP_STD_USAGE); | |
539 | } | |
540 | ||
541 | ARGP_EI int | |
99e46354 | 542 | __option_is_short (__const struct argp_option *__opt) __THROW |
c84142e8 UD |
543 | { |
544 | if (__opt->flags & OPTION_DOC) | |
545 | return 0; | |
546 | else | |
547 | { | |
548 | int __key = __opt->key; | |
549 | return __key > 0 && isprint (__key); | |
550 | } | |
551 | } | |
552 | ||
553 | ARGP_EI int | |
99e46354 | 554 | __option_is_end (__const struct argp_option *__opt) __THROW |
c84142e8 UD |
555 | { |
556 | return !__opt->key && !__opt->name && !__opt->doc && !__opt->group; | |
557 | } | |
558 | ||
36775c3b UD |
559 | # if !_LIBC |
560 | # undef __argp_usage | |
561 | # undef __argp_state_help | |
562 | # undef __option_is_short | |
563 | # undef __option_is_end | |
564 | # endif | |
0c6cee5d | 565 | #endif /* Use extern inlines. */ |
c84142e8 UD |
566 | |
567 | #ifdef __cplusplus | |
568 | } | |
569 | #endif | |
570 | ||
36775c3b | 571 | #endif /* argp.h */ |