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