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