lib/argp.h

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