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