argp/argp.h

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