Bump to 1.14.1
[platform/upstream/augeas.git] / lib / argp.h
1 /* Hierarchical argument parsing, layered over getopt.
2    Copyright (C) 1995-2016 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 3 of the License, or
9    (at your option) 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
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
18
19 #ifndef _ARGP_H
20 #define _ARGP_H
21
22 #include <stdio.h>
23 #include <ctype.h>
24 #include <getopt.h>
25 #include <limits.h>
26
27 #define __need_error_t
28 #include <errno.h>
29
30 #ifndef __THROW
31 # define __THROW
32 #endif
33 #ifndef __NTH
34 # define __NTH(fct) fct __THROW
35 #endif
36
37 /* The __attribute__ feature is available in gcc versions 2.5 and later.
38    The __-protected variants of the attributes 'format' and 'printf' are
39    accepted by gcc versions 2.6.4 (effectively 2.7) and later.
40    We enable _GL_ATTRIBUTE_FORMAT only if these are supported too, because
41    gnulib and libintl do '#define printf __printf__' when they override
42    the 'printf' function.  */
43 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 7)
44 # define _GL_ATTRIBUTE_FORMAT(spec) __attribute__ ((__format__ spec))
45 #else
46 # define _GL_ATTRIBUTE_FORMAT(spec) /* empty */
47 #endif
48
49 /* GCC 2.95 and later have "__restrict"; C99 compilers have
50    "restrict", and "configure" may have defined "restrict".
51    Other compilers use __restrict, __restrict__, and _Restrict, and
52    'configure' might #define 'restrict' to those words.  */
53 #ifndef __restrict
54 # if ! (2 < __GNUC__ || (2 == __GNUC__ && 95 <= __GNUC_MINOR__))
55 #  if 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
99      Write the initial value as N_("TEXT") if you want xgettext to collect
100      it into a POT file.  */
101   const char *doc;
102
103   /* The group this option is in.  In a long help message, options are sorted
104      alphabetically within each group, and the groups presented in the order
105      0, 1, 2, ..., n, -m, ..., -2, -1.  Every entry in an options array with
106      if this field 0 will inherit the group number of the previous entry, or
107      zero if it's the first one, unless its a group header (NAME and KEY both
108      0), in which case, the previous entry + 1 is the default.  Automagic
109      options such as --help are put into group -1.  */
110   int group;
111 };
112
113 /* The argument associated with this option is optional.  */
114 #define OPTION_ARG_OPTIONAL     0x1
115
116 /* This option isn't displayed in any help messages.  */
117 #define OPTION_HIDDEN           0x2
118
119 /* This option is an alias for the closest previous non-alias option.  This
120    means that it will be displayed in the same help entry, and will inherit
121    fields other than NAME and KEY from the aliased option.  */
122 #define OPTION_ALIAS            0x4
123
124 /* This option isn't actually an option (and so should be ignored by the
125    actual option parser), but rather an arbitrary piece of documentation that
126    should be displayed in much the same manner as the options.  If this flag
127    is set, then the option NAME field is displayed unmodified (e.g., no '--'
128    prefix is added) at the left-margin (where a *short* option would normally
129    be displayed), and the documentation string in the normal place. The NAME
130    field will be translated using gettext, unless OPTION_NO_TRANS is set (see
131    below). For purposes of sorting, any leading whitespace and punctuation is
132    ignored, except that if the first non-whitespace character is not '-', this
133    entry is displayed after all options (and OPTION_DOC entries with a leading
134    '-') in the same group.  */
135 #define OPTION_DOC              0x8
136
137 /* This option shouldn't be included in "long" usage messages (but is still
138    included in help messages).  This is mainly intended for options that are
139    completely documented in an argp's ARGS_DOC field, in which case including
140    the option in the generic usage list would be redundant.  For instance,
141    if ARGS_DOC is "FOO BAR\n-x BLAH", and the '-x' option's purpose is to
142    distinguish these two cases, -x should probably be marked
143    OPTION_NO_USAGE.  */
144 #define OPTION_NO_USAGE         0x10
145
146 /* Valid only in conjunction with OPTION_DOC. This option disables translation
147    of option name. */
148 #define OPTION_NO_TRANS         0x20
149 \f
150 struct argp;                    /* fwd declare this type */
151 struct argp_state;              /* " */
152 struct argp_child;              /* " */
153
154 /* The type of a pointer to an argp parsing function.  */
155 typedef error_t (*argp_parser_t) (int __key, char *__arg,
156                                   struct argp_state *__state);
157
158 /* What to return for unrecognized keys.  For special ARGP_KEY_ keys, such
159    returns will simply be ignored.  For user keys, this error will be turned
160    into EINVAL (if the call to argp_parse is such that errors are propagated
161    back to the user instead of exiting); returning EINVAL itself would result
162    in an immediate stop to parsing in *all* cases.  */
163 #define ARGP_ERR_UNKNOWN        E2BIG /* Hurd should never need E2BIG.  XXX */
164
165 /* Special values for the KEY argument to an argument parsing function.
166    ARGP_ERR_UNKNOWN should be returned if they aren't understood.
167
168    The sequence of keys to a parsing function is either (where each
169    uppercased word should be prefixed by 'ARGP_KEY_' and opt is a user key):
170
171        INIT opt... NO_ARGS END SUCCESS  -- No non-option arguments at all
172    or  INIT (opt | ARG)... END SUCCESS  -- All non-option args parsed
173    or  INIT (opt | ARG)... SUCCESS      -- Some non-option arg unrecognized
174
175    The third case is where every parser returned ARGP_KEY_UNKNOWN for an
176    argument, in which case parsing stops at that argument (returning the
177    unparsed arguments to the caller of argp_parse if requested, or stopping
178    with an error message if not).
179
180    If an error occurs (either detected by argp, or because the parsing
181    function returned an error value), then the parser is called with
182    ARGP_KEY_ERROR, and no further calls are made.  */
183
184 /* This is not an option at all, but rather a command line argument.  If a
185    parser receiving this key returns success, the fact is recorded, and the
186    ARGP_KEY_NO_ARGS case won't be used.  HOWEVER, if while processing the
187    argument, a parser function decrements the NEXT field of the state it's
188    passed, the option won't be considered processed; this is to allow you to
189    actually modify the argument (perhaps into an option), and have it
190    processed again.  */
191 #define ARGP_KEY_ARG            0
192 /* There are remaining arguments not parsed by any parser, which may be found
193    starting at (STATE->argv + STATE->next).  If success is returned, but
194    STATE->next left untouched, it's assumed that all arguments were consume,
195    otherwise, the parser should adjust STATE->next to reflect any arguments
196    consumed.  */
197 #define ARGP_KEY_ARGS           0x1000006
198 /* There are no more command line arguments at all.  */
199 #define ARGP_KEY_END            0x1000001
200 /* Because it's common to want to do some special processing if there aren't
201    any non-option args, user parsers are called with this key if they didn't
202    successfully process any non-option arguments.  Called just before
203    ARGP_KEY_END (where more general validity checks on previously parsed
204    arguments can take place).  */
205 #define ARGP_KEY_NO_ARGS        0x1000002
206 /* Passed in before any parsing is done.  Afterwards, the values of each
207    element of the CHILD_INPUT field, if any, in the state structure is
208    copied to each child's state to be the initial value of the INPUT field.  */
209 #define ARGP_KEY_INIT           0x1000003
210 /* Use after all other keys, including SUCCESS & END.  */
211 #define ARGP_KEY_FINI           0x1000007
212 /* Passed in when parsing has successfully been completed (even if there are
213    still arguments remaining).  */
214 #define ARGP_KEY_SUCCESS        0x1000004
215 /* Passed in if an error occurs.  */
216 #define ARGP_KEY_ERROR          0x1000005
217
218 /* An argp structure contains a set of options declarations, a function to
219    deal with parsing one, documentation string, a possible vector of child
220    argp's, and perhaps a function to filter help output.  When actually
221    parsing options, getopt is called with the union of all the argp
222    structures chained together through their CHILD pointers, with conflicts
223    being resolved in favor of the first occurrence in the chain.  */
224 struct argp
225 {
226   /* An array of argp_option structures, terminated by an entry with both
227      NAME and KEY having a value of 0.  */
228   const struct argp_option *options;
229
230   /* What to do with an option from this structure.  KEY is the key
231      associated with the option, and ARG is any associated argument (NULL if
232      none was supplied).  If KEY isn't understood, ARGP_ERR_UNKNOWN should be
233      returned.  If a non-zero, non-ARGP_ERR_UNKNOWN value is returned, then
234      parsing is stopped immediately, and that value is returned from
235      argp_parse().  For special (non-user-supplied) values of KEY, see the
236      ARGP_KEY_ definitions below.  */
237   argp_parser_t parser;
238
239   /* A string describing what other arguments are wanted by this program.  It
240      is only used by argp_usage to print the "Usage:" message.  If it
241      contains newlines, the strings separated by them are considered
242      alternative usage patterns, and printed on separate lines (lines after
243      the first are prefix by "  or: " instead of "Usage:").  */
244   const char *args_doc;
245
246   /* If non-NULL, a string containing extra text to be printed before and
247      after the options in a long help message (separated by a vertical tab
248      '\v' character).
249      Write the initial value as N_("BEFORE-TEXT") "\v" N_("AFTER-TEXT") if
250      you want xgettext to collect the two pieces of text into a POT file.  */
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 preceding 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 /* GNULIB makes sure both program_invocation_name and
426    program_invocation_short_name are available */
427 #ifdef GNULIB_PROGRAM_INVOCATION_NAME
428 extern char *program_invocation_name;
429 # undef HAVE_DECL_PROGRAM_INVOCATION_NAME
430 # define HAVE_DECL_PROGRAM_INVOCATION_NAME 1
431 #endif
432
433 #ifdef GNULIB_PROGRAM_INVOCATION_SHORT_NAME
434 extern char *program_invocation_short_name;
435 # undef HAVE_DECL_PROGRAM_INVOCATION_SHORT_NAME
436 # define HAVE_DECL_PROGRAM_INVOCATION_SHORT_NAME 1
437 #endif
438
439 /* If defined or set by the user program to a non-zero value, then a default
440    option --version is added (unless the ARGP_NO_HELP flag is used), which
441    will print this string followed by a newline and exit (unless the
442    ARGP_NO_EXIT flag is used).  Overridden by ARGP_PROGRAM_VERSION_HOOK.  */
443 extern const char *argp_program_version;
444
445 /* If defined or set by the user program to a non-zero value, then a default
446    option --version is added (unless the ARGP_NO_HELP flag is used), which
447    calls this function with a stream to print the version to and a pointer to
448    the current parsing state, and then exits (unless the ARGP_NO_EXIT flag is
449    used).  This variable takes precedent over ARGP_PROGRAM_VERSION.  */
450 extern void (*argp_program_version_hook) (FILE *__restrict __stream,
451                                           struct argp_state *__restrict
452                                           __state);
453
454 /* If defined or set by the user program, it should point to string that is
455    the bug-reporting address for the program.  It will be printed by
456    argp_help if the ARGP_HELP_BUG_ADDR flag is set (as it is by various
457    standard help messages), embedded in a sentence that says something like
458    "Report bugs to ADDR."  */
459 extern const char *argp_program_bug_address;
460
461 /* The exit status that argp will use when exiting due to a parsing error.
462    If not defined or set by the user program, this defaults to EX_USAGE from
463    <sysexits.h>.  */
464 extern error_t argp_err_exit_status;
465 \f
466 /* Flags for argp_help.  */
467 #define ARGP_HELP_USAGE         0x01 /* a Usage: message. */
468 #define ARGP_HELP_SHORT_USAGE   0x02 /*  " but don't actually print options. */
469 #define ARGP_HELP_SEE           0x04 /* a "Try ... for more help" message. */
470 #define ARGP_HELP_LONG          0x08 /* a long help message. */
471 #define ARGP_HELP_PRE_DOC       0x10 /* doc string preceding long help.  */
472 #define ARGP_HELP_POST_DOC      0x20 /* doc string following long help.  */
473 #define ARGP_HELP_DOC           (ARGP_HELP_PRE_DOC | ARGP_HELP_POST_DOC)
474 #define ARGP_HELP_BUG_ADDR      0x40 /* bug report address */
475 #define ARGP_HELP_LONG_ONLY     0x80 /* modify output appropriately to
476                                         reflect ARGP_LONG_ONLY mode.  */
477
478 /* These ARGP_HELP flags are only understood by argp_state_help.  */
479 #define ARGP_HELP_EXIT_ERR      0x100 /* Call exit(1) instead of returning.  */
480 #define ARGP_HELP_EXIT_OK       0x200 /* Call exit(0) instead of returning.  */
481
482 /* The standard thing to do after a program command line parsing error, if an
483    error message has already been printed.  */
484 #define ARGP_HELP_STD_ERR \
485   (ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR)
486 /* The standard thing to do after a program command line parsing error, if no
487    more specific error message has been printed.  */
488 #define ARGP_HELP_STD_USAGE \
489   (ARGP_HELP_SHORT_USAGE | ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR)
490 /* The standard thing to do in response to a --help option.  */
491 #define ARGP_HELP_STD_HELP \
492   (ARGP_HELP_SHORT_USAGE | ARGP_HELP_LONG | ARGP_HELP_EXIT_OK \
493    | ARGP_HELP_DOC | ARGP_HELP_BUG_ADDR)
494
495 /* Output a usage message for ARGP to STREAM.  FLAGS are from the set
496    ARGP_HELP_*.  */
497 extern void argp_help (const struct argp *__restrict __argp,
498                        FILE *__restrict __stream,
499                        unsigned __flags, char *__restrict __name);
500 extern void __argp_help (const struct argp *__restrict __argp,
501                          FILE *__restrict __stream, unsigned __flags,
502                          char *__name);
503 \f
504 /* The following routines are intended to be called from within an argp
505    parsing routine (thus taking an argp_state structure as the first
506    argument).  They may or may not print an error message and exit, depending
507    on the flags in STATE -- in any case, the caller should be prepared for
508    them *not* to exit, and should return an appropriate error after calling
509    them.  [argp_usage & argp_error should probably be called argp_state_...,
510    but they're used often enough that they should be short]  */
511
512 /* Output, if appropriate, a usage message for STATE to STREAM.  FLAGS are
513    from the set ARGP_HELP_*.  */
514 extern void argp_state_help (const struct argp_state *__restrict __state,
515                              FILE *__restrict __stream,
516                              unsigned int __flags);
517 extern void __argp_state_help (const struct argp_state *__restrict __state,
518                                FILE *__restrict __stream,
519                                unsigned int __flags);
520
521 #if _LIBC
522 /* Possibly output the standard usage message for ARGP to stderr and exit.  */
523 extern void argp_usage (const struct argp_state *__state);
524 extern void __argp_usage (const struct argp_state *__state);
525 #endif
526
527 /* If appropriate, print the printf string FMT and following args, preceded
528    by the program name and ':', to stderr, and followed by a "Try ... --help"
529    message, then exit (1).  */
530 extern void argp_error (const struct argp_state *__restrict __state,
531                         const char *__restrict __fmt, ...)
532      _GL_ATTRIBUTE_FORMAT ((__printf__, 2, 3));
533 extern void __argp_error (const struct argp_state *__restrict __state,
534                           const char *__restrict __fmt, ...)
535      _GL_ATTRIBUTE_FORMAT ((__printf__, 2, 3));
536
537 /* Similar to the standard gnu error-reporting function error(), but will
538    respect the ARGP_NO_EXIT and ARGP_NO_ERRS flags in STATE, and will print
539    to STATE->err_stream.  This is useful for argument parsing code that is
540    shared between program startup (when exiting is desired) and runtime
541    option parsing (when typically an error code is returned instead).  The
542    difference between this function and argp_error is that the latter is for
543    *parsing errors*, and the former is for other problems that occur during
544    parsing but don't reflect a (syntactic) problem with the input.  */
545 extern void argp_failure (const struct argp_state *__restrict __state,
546                           int __status, int __errnum,
547                           const char *__restrict __fmt, ...)
548      _GL_ATTRIBUTE_FORMAT ((__printf__, 4, 5));
549 extern void __argp_failure (const struct argp_state *__restrict __state,
550                             int __status, int __errnum,
551                             const char *__restrict __fmt, ...)
552      _GL_ATTRIBUTE_FORMAT ((__printf__, 4, 5));
553
554 #if _LIBC
555 /* Returns true if the option OPT is a valid short option.  */
556 extern int _option_is_short (const struct argp_option *__opt) __THROW;
557 extern int __option_is_short (const struct argp_option *__opt) __THROW;
558
559 /* Returns true if the option OPT is in fact the last (unused) entry in an
560    options array.  */
561 extern int _option_is_end (const struct argp_option *__opt) __THROW;
562 extern int __option_is_end (const struct argp_option *__opt) __THROW;
563 #endif
564
565 /* Return the input field for ARGP in the parser corresponding to STATE; used
566    by the help routines.  */
567 extern void *_argp_input (const struct argp *__restrict __argp,
568                           const struct argp_state *__restrict __state)
569      __THROW;
570 extern void *__argp_input (const struct argp *__restrict __argp,
571                            const struct argp_state *__restrict __state)
572      __THROW;
573 \f
574 #if !_LIBC || defined __USE_EXTERN_INLINES
575
576 # if !_LIBC
577 #  define __argp_usage argp_usage
578 #  define __argp_state_help argp_state_help
579 #  define __option_is_short _option_is_short
580 #  define __option_is_end _option_is_end
581 #ifndef _GL_INLINE_HEADER_BEGIN
582  #error "Please include config.h first."
583 #endif
584 _GL_INLINE_HEADER_BEGIN
585 #  ifndef ARGP_EI
586 #   define ARGP_EI _GL_INLINE
587 #  endif
588 # endif
589
590 # ifndef ARGP_EI
591 #  define ARGP_EI __extern_inline
592 # endif
593
594 ARGP_EI void
595 __argp_usage (const struct argp_state *__state)
596 {
597   __argp_state_help (__state, stderr, ARGP_HELP_STD_USAGE);
598 }
599
600 ARGP_EI int
601 __NTH (__option_is_short (const struct argp_option *__opt))
602 {
603   if (__opt->flags & OPTION_DOC)
604     return 0;
605   else
606     {
607       int __key = __opt->key;
608       return __key > 0 && __key <= UCHAR_MAX && isprint (__key);
609     }
610 }
611
612 ARGP_EI int
613 __NTH (__option_is_end (const struct argp_option *__opt))
614 {
615   return !__opt->key && !__opt->name && !__opt->doc && !__opt->group;
616 }
617
618 # if !_LIBC
619 #  undef __argp_usage
620 #  undef __argp_state_help
621 #  undef __option_is_short
622 #  undef __option_is_end
623 _GL_INLINE_HEADER_END
624 # endif
625 #endif /* Use extern inlines.  */
626
627 #ifdef  __cplusplus
628 }
629 #endif
630
631 #endif /* argp.h */