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