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