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