argp/argp.h

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