lib/argp.h

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