Back to index

glibc  2.9
argp.h
Go to the documentation of this file.
00001 /* Hierarchial argument parsing, layered over getopt.
00002    Copyright (C) 1995-1999, 2003, 2004, 2005, 2006, 2007
00003    Free Software Foundation, Inc.
00004    This file is part of the GNU C Library.
00005    Written by Miles Bader <miles@gnu.ai.mit.edu>.
00006 
00007    The GNU C Library is free software; you can redistribute it and/or
00008    modify it under the terms of the GNU Lesser General Public
00009    License as published by the Free Software Foundation; either
00010    version 2.1 of the License, or (at your option) any later version.
00011 
00012    The GNU C Library is distributed in the hope that it will be useful,
00013    but WITHOUT ANY WARRANTY; without even the implied warranty of
00014    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015    Lesser General Public License for more details.
00016 
00017    You should have received a copy of the GNU Lesser General Public
00018    License along with the GNU C Library; if not, write to the Free
00019    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
00020    02111-1307 USA.  */
00021 
00022 #ifndef _ARGP_H
00023 #define _ARGP_H
00024 
00025 #include <stdio.h>
00026 #include <ctype.h>
00027 #include <getopt.h>
00028 #include <limits.h>
00029 
00030 #define __need_error_t
00031 #include <errno.h>
00032 
00033 #ifndef __const
00034 # define __const const
00035 #endif
00036 
00037 #ifndef __THROW
00038 # define __THROW
00039 #endif
00040 #ifndef __NTH
00041 # define __NTH(fct) fct __THROW
00042 #endif
00043 
00044 #ifndef __attribute__
00045 /* This feature is available in gcc versions 2.5 and later.  */
00046 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5) || __STRICT_ANSI__
00047 #  define __attribute__(Spec) /* empty */
00048 # endif
00049 /* The __-protected variants of `format' and `printf' attributes
00050    are accepted by gcc versions 2.6.4 (effectively 2.7) and later.  */
00051 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7) || __STRICT_ANSI__
00052 #  define __format__ format
00053 #  define __printf__ printf
00054 # endif
00055 #endif
00056 
00057 /* GCC 2.95 and later have "__restrict"; C99 compilers have
00058    "restrict", and "configure" may have defined "restrict".  */
00059 #ifndef __restrict
00060 # if ! (2 < __GNUC__ || (2 == __GNUC__ && 95 <= __GNUC_MINOR__))
00061 #  if defined restrict || 199901L <= __STDC_VERSION__
00062 #   define __restrict restrict
00063 #  else
00064 #   define __restrict
00065 #  endif
00066 # endif
00067 #endif
00068 
00069 #ifndef __error_t_defined
00070 typedef int error_t;
00071 # define __error_t_defined
00072 #endif
00073 
00074 #ifdef  __cplusplus
00075 extern "C" {
00076 #endif
00077 
00078 /* A description of a particular option.  A pointer to an array of
00079    these is passed in the OPTIONS field of an argp structure.  Each option
00080    entry can correspond to one long option and/or one short option; more
00081    names for the same option can be added by following an entry in an option
00082    array with options having the OPTION_ALIAS flag set.  */
00083 struct argp_option
00084 {
00085   /* The long option name.  For more than one name for the same option, you
00086      can use following options with the OPTION_ALIAS flag set.  */
00087   __const char *name;
00088 
00089   /* What key is returned for this option.  If > 0 and printable, then it's
00090      also accepted as a short option.  */
00091   int key;
00092 
00093   /* If non-NULL, this is the name of the argument associated with this
00094      option, which is required unless the OPTION_ARG_OPTIONAL flag is set. */
00095   __const char *arg;
00096 
00097   /* OPTION_ flags.  */
00098   int flags;
00099 
00100   /* The doc string for this option.  If both NAME and KEY are 0, This string
00101      will be printed outdented from the normal option column, making it
00102      useful as a group header (it will be the first thing printed in its
00103      group); in this usage, it's conventional to end the string with a `:'.  */
00104   __const char *doc;
00105 
00106   /* The group this option is in.  In a long help message, options are sorted
00107      alphabetically within each group, and the groups presented in the order
00108      0, 1, 2, ..., n, -m, ..., -2, -1.  Every entry in an options array with
00109      if this field 0 will inherit the group number of the previous entry, or
00110      zero if it's the first one, unless its a group header (NAME and KEY both
00111      0), in which case, the previous entry + 1 is the default.  Automagic
00112      options such as --help are put into group -1.  */
00113   int group;
00114 };
00115 
00116 /* The argument associated with this option is optional.  */
00117 #define OPTION_ARG_OPTIONAL 0x1
00118 
00119 /* This option isn't displayed in any help messages.  */
00120 #define OPTION_HIDDEN                     0x2
00121 
00122 /* This option is an alias for the closest previous non-alias option.  This
00123    means that it will be displayed in the same help entry, and will inherit
00124    fields other than NAME and KEY from the aliased option.  */
00125 #define OPTION_ALIAS        0x4
00126 
00127 /* This option isn't actually an option (and so should be ignored by the
00128    actual option parser), but rather an arbitrary piece of documentation that
00129    should be displayed in much the same manner as the options.  If this flag
00130    is set, then the option NAME field is displayed unmodified (e.g., no `--'
00131    prefix is added) at the left-margin (where a *short* option would normally
00132    be displayed), and the documentation string in the normal place.  For
00133    purposes of sorting, any leading whitespace and punctuation is ignored,
00134    except that if the first non-whitespace character is not `-', this entry
00135    is displayed after all options (and OPTION_DOC entries with a leading `-')
00136    in the same group.  */
00137 #define OPTION_DOC          0x8
00138 
00139 /* This option shouldn't be included in `long' usage messages (but is still
00140    included in help messages).  This is mainly intended for options that are
00141    completely documented in an argp's ARGS_DOC field, in which case including
00142    the option in the generic usage list would be redundant.  For instance,
00143    if ARGS_DOC is "FOO BAR\n-x BLAH", and the `-x' option's purpose is to
00144    distinguish these two cases, -x should probably be marked
00145    OPTION_NO_USAGE.  */
00146 #define OPTION_NO_USAGE            0x10
00147 
00148 struct argp;                /* fwd declare this type */
00149 struct argp_state;          /* " */
00150 struct argp_child;          /* " */
00151 
00152 /* The type of a pointer to an argp parsing function.  */
00153 typedef error_t (*argp_parser_t) (int key, char *arg,
00154                               struct argp_state *state);
00155 
00156 /* What to return for unrecognized keys.  For special ARGP_KEY_ keys, such
00157    returns will simply be ignored.  For user keys, this error will be turned
00158    into EINVAL (if the call to argp_parse is such that errors are propagated
00159    back to the user instead of exiting); returning EINVAL itself would result
00160    in an immediate stop to parsing in *all* cases.  */
00161 #define ARGP_ERR_UNKNOWN    E2BIG /* Hurd should never need E2BIG.  XXX */
00162 
00163 /* Special values for the KEY argument to an argument parsing function.
00164    ARGP_ERR_UNKNOWN should be returned if they aren't understood.
00165 
00166    The sequence of keys to a parsing function is either (where each
00167    uppercased word should be prefixed by `ARGP_KEY_' and opt is a user key):
00168 
00169        INIT opt... NO_ARGS END SUCCESS  -- No non-option arguments at all
00170    or  INIT (opt | ARG)... END SUCCESS  -- All non-option args parsed
00171    or  INIT (opt | ARG)... SUCCESS      -- Some non-option arg unrecognized
00172 
00173    The third case is where every parser returned ARGP_KEY_UNKNOWN for an
00174    argument, in which case parsing stops at that argument (returning the
00175    unparsed arguments to the caller of argp_parse if requested, or stopping
00176    with an error message if not).
00177 
00178    If an error occurs (either detected by argp, or because the parsing
00179    function returned an error value), then the parser is called with
00180    ARGP_KEY_ERROR, and no further calls are made.  */
00181 
00182 /* This is not an option at all, but rather a command line argument.  If a
00183    parser receiving this key returns success, the fact is recorded, and the
00184    ARGP_KEY_NO_ARGS case won't be used.  HOWEVER, if while processing the
00185    argument, a parser function decrements the NEXT field of the state it's
00186    passed, the option won't be considered processed; this is to allow you to
00187    actually modify the argument (perhaps into an option), and have it
00188    processed again.  */
00189 #define ARGP_KEY_ARG        0
00190 /* There are remaining arguments not parsed by any parser, which may be found
00191    starting at (STATE->argv + STATE->next).  If success is returned, but
00192    STATE->next left untouched, it's assumed that all arguments were consume,
00193    otherwise, the parser should adjust STATE->next to reflect any arguments
00194    consumed.  */
00195 #define ARGP_KEY_ARGS              0x1000006
00196 /* There are no more command line arguments at all.  */
00197 #define ARGP_KEY_END        0x1000001
00198 /* Because it's common to want to do some special processing if there aren't
00199    any non-option args, user parsers are called with this key if they didn't
00200    successfully process any non-option arguments.  Called just before
00201    ARGP_KEY_END (where more general validity checks on previously parsed
00202    arguments can take place).  */
00203 #define ARGP_KEY_NO_ARGS    0x1000002
00204 /* Passed in before any parsing is done.  Afterwards, the values of each
00205    element of the CHILD_INPUT field, if any, in the state structure is
00206    copied to each child's state to be the initial value of the INPUT field.  */
00207 #define ARGP_KEY_INIT              0x1000003
00208 /* Use after all other keys, including SUCCESS & END.  */
00209 #define ARGP_KEY_FINI              0x1000007
00210 /* Passed in when parsing has successfully been completed (even if there are
00211    still arguments remaining).  */
00212 #define ARGP_KEY_SUCCESS    0x1000004
00213 /* Passed in if an error occurs.  */
00214 #define ARGP_KEY_ERROR             0x1000005
00215 
00216 /* An argp structure contains a set of options declarations, a function to
00217    deal with parsing one, documentation string, a possible vector of child
00218    argp's, and perhaps a function to filter help output.  When actually
00219    parsing options, getopt is called with the union of all the argp
00220    structures chained together through their CHILD pointers, with conflicts
00221    being resolved in favor of the first occurrence in the chain.  */
00222 struct argp
00223 {
00224   /* An array of argp_option structures, terminated by an entry with both
00225      NAME and KEY having a value of 0.  */
00226   __const struct argp_option *options;
00227 
00228   /* What to do with an option from this structure.  KEY is the key
00229      associated with the option, and ARG is any associated argument (NULL if
00230      none was supplied).  If KEY isn't understood, ARGP_ERR_UNKNOWN should be
00231      returned.  If a non-zero, non-ARGP_ERR_UNKNOWN value is returned, then
00232      parsing is stopped immediately, and that value is returned from
00233      argp_parse().  For special (non-user-supplied) values of KEY, see the
00234      ARGP_KEY_ definitions below.  */
00235   argp_parser_t parser;
00236 
00237   /* A string describing what other arguments are wanted by this program.  It
00238      is only used by argp_usage to print the `Usage:' message.  If it
00239      contains newlines, the strings separated by them are considered
00240      alternative usage patterns, and printed on separate lines (lines after
00241      the first are prefix by `  or: ' instead of `Usage:').  */
00242   __const char *args_doc;
00243 
00244   /* If non-NULL, a string containing extra text to be printed before and
00245      after the options in a long help message (separated by a vertical tab
00246      `\v' character).  */
00247   __const char *doc;
00248 
00249   /* A vector of argp_children structures, terminated by a member with a 0
00250      argp field, pointing to child argps should be parsed with this one.  Any
00251      conflicts are resolved in favor of this argp, or early argps in the
00252      CHILDREN list.  This field is useful if you use libraries that supply
00253      their own argp structure, which you want to use in conjunction with your
00254      own.  */
00255   __const struct argp_child *children;
00256 
00257   /* If non-zero, this should be a function to filter the output of help
00258      messages.  KEY is either a key from an option, in which case TEXT is
00259      that option's help text, or a special key from the ARGP_KEY_HELP_
00260      defines, below, describing which other help text TEXT is.  The function
00261      should return either TEXT, if it should be used as-is, a replacement
00262      string, which should be malloced, and will be freed by argp, or NULL,
00263      meaning `print nothing'.  The value for TEXT is *after* any translation
00264      has been done, so if any of the replacement text also needs translation,
00265      that should be done by the filter function.  INPUT is either the input
00266      supplied to argp_parse, or NULL, if argp_help was called directly.  */
00267   char *(*help_filter) (int __key, __const char *__text, void *__input);
00268 
00269   /* If non-zero the strings used in the argp library are translated using
00270      the domain described by this string.  Otherwise the currently installed
00271      default domain is used.  */
00272   const char *argp_domain;
00273 };
00274 
00275 /* Possible KEY arguments to a help filter function.  */
00276 #define ARGP_KEY_HELP_PRE_DOC      0x2000001 /* Help text preceeding options. */
00277 #define ARGP_KEY_HELP_POST_DOC     0x2000002 /* Help text following options. */
00278 #define ARGP_KEY_HELP_HEADER       0x2000003 /* Option header string. */
00279 #define ARGP_KEY_HELP_EXTRA 0x2000004 /* After all other documentation;
00280                                         TEXT is NULL for this key.  */
00281 /* Explanatory note emitted when duplicate option arguments have been
00282    suppressed.  */
00283 #define ARGP_KEY_HELP_DUP_ARGS_NOTE 0x2000005
00284 #define ARGP_KEY_HELP_ARGS_DOC     0x2000006 /* Argument doc string.  */
00285 
00286 /* When an argp has a non-zero CHILDREN field, it should point to a vector of
00287    argp_child structures, each of which describes a subsidiary argp.  */
00288 struct argp_child
00289 {
00290   /* The child parser.  */
00291   __const struct argp *argp;
00292 
00293   /* Flags for this child.  */
00294   int flags;
00295 
00296   /* If non-zero, an optional header to be printed in help output before the
00297      child options.  As a side-effect, a non-zero value forces the child
00298      options to be grouped together; to achieve this effect without actually
00299      printing a header string, use a value of "".  */
00300   __const char *header;
00301 
00302   /* Where to group the child options relative to the other (`consolidated')
00303      options in the parent argp; the values are the same as the GROUP field
00304      in argp_option structs, but all child-groupings follow parent options at
00305      a particular group level.  If both this field and HEADER are zero, then
00306      they aren't grouped at all, but rather merged with the parent options
00307      (merging the child's grouping levels with the parents).  */
00308   int group;
00309 };
00310 
00311 /* Parsing state.  This is provided to parsing functions called by argp,
00312    which may examine and, as noted, modify fields.  */
00313 struct argp_state
00314 {
00315   /* The top level ARGP being parsed.  */
00316   __const struct argp *root_argp;
00317 
00318   /* The argument vector being parsed.  May be modified.  */
00319   int argc;
00320   char **argv;
00321 
00322   /* The index in ARGV of the next arg that to be parsed.  May be modified. */
00323   int next;
00324 
00325   /* The flags supplied to argp_parse.  May be modified.  */
00326   unsigned flags;
00327 
00328   /* While calling a parsing function with a key of ARGP_KEY_ARG, this is the
00329      number of the current arg, starting at zero, and incremented after each
00330      such call returns.  At all other times, this is the number of such
00331      arguments that have been processed.  */
00332   unsigned arg_num;
00333 
00334   /* If non-zero, the index in ARGV of the first argument following a special
00335      `--' argument (which prevents anything following being interpreted as an
00336      option).  Only set once argument parsing has proceeded past this point. */
00337   int quoted;
00338 
00339   /* An arbitrary pointer passed in from the user.  */
00340   void *input;
00341   /* Values to pass to child parsers.  This vector will be the same length as
00342      the number of children for the current parser.  */
00343   void **child_inputs;
00344 
00345   /* For the parser's use.  Initialized to 0.  */
00346   void *hook;
00347 
00348   /* The name used when printing messages.  This is initialized to ARGV[0],
00349      or PROGRAM_INVOCATION_NAME if that is unavailable.  */
00350   char *name;
00351 
00352   /* Streams used when argp prints something.  */
00353   FILE *err_stream;         /* For errors; initialized to stderr. */
00354   FILE *out_stream;         /* For information; initialized to stdout. */
00355 
00356   void *pstate;                    /* Private, for use by argp.  */
00357 };
00358 
00359 /* Flags for argp_parse (note that the defaults are those that are
00360    convenient for program command line parsing): */
00361 
00362 /* Don't ignore the first element of ARGV.  Normally (and always unless
00363    ARGP_NO_ERRS is set) the first element of the argument vector is
00364    skipped for option parsing purposes, as it corresponds to the program name
00365    in a command line.  */
00366 #define ARGP_PARSE_ARGV0  0x01
00367 
00368 /* Don't print error messages for unknown options to stderr; unless this flag
00369    is set, ARGP_PARSE_ARGV0 is ignored, as ARGV[0] is used as the program
00370    name in the error messages.  This flag implies ARGP_NO_EXIT (on the
00371    assumption that silent exiting upon errors is bad behaviour).  */
00372 #define ARGP_NO_ERRS 0x02
00373 
00374 /* Don't parse any non-option args.  Normally non-option args are parsed by
00375    calling the parse functions with a key of ARGP_KEY_ARG, and the actual arg
00376    as the value.  Since it's impossible to know which parse function wants to
00377    handle it, each one is called in turn, until one returns 0 or an error
00378    other than ARGP_ERR_UNKNOWN; if an argument is handled by no one, the
00379    argp_parse returns prematurely (but with a return value of 0).  If all
00380    args have been parsed without error, all parsing functions are called one
00381    last time with a key of ARGP_KEY_END.  This flag needn't normally be set,
00382    as the normal behavior is to stop parsing as soon as some argument can't
00383    be handled.  */
00384 #define ARGP_NO_ARGS 0x04
00385 
00386 /* Parse options and arguments in the same order they occur on the command
00387    line -- normally they're rearranged so that all options come first. */
00388 #define ARGP_IN_ORDER       0x08
00389 
00390 /* Don't provide the standard long option --help, which causes usage and
00391       option help information to be output to stdout, and exit (0) called. */
00392 #define ARGP_NO_HELP 0x10
00393 
00394 /* Don't exit on errors (they may still result in error messages).  */
00395 #define ARGP_NO_EXIT 0x20
00396 
00397 /* Use the gnu getopt `long-only' rules for parsing arguments.  */
00398 #define ARGP_LONG_ONLY      0x40
00399 
00400 /* Turns off any message-printing/exiting options.  */
00401 #define ARGP_SILENT    (ARGP_NO_EXIT | ARGP_NO_ERRS | ARGP_NO_HELP)
00402 
00403 /* Parse the options strings in ARGC & ARGV according to the options in ARGP.
00404    FLAGS is one of the ARGP_ flags above.  If ARG_INDEX is non-NULL, the
00405    index in ARGV of the first unparsed option is returned in it.  If an
00406    unknown option is present, ARGP_ERR_UNKNOWN is returned; if some parser
00407    routine returned a non-zero value, it is returned; otherwise 0 is
00408    returned.  This function may also call exit unless the ARGP_NO_HELP flag
00409    is set.  INPUT is a pointer to a value to be passed in to the parser.  */
00410 extern error_t argp_parse (__const struct argp *__restrict __argp,
00411                         int __argc, char **__restrict __argv,
00412                         unsigned __flags, int *__restrict __arg_index,
00413                         void *__restrict __input);
00414 extern error_t __argp_parse (__const struct argp *__restrict __argp,
00415                           int __argc, char **__restrict __argv,
00416                           unsigned __flags, int *__restrict __arg_index,
00417                           void *__restrict __input);
00418 
00419 /* Global variables.  */
00420 
00421 /* If defined or set by the user program to a non-zero value, then a default
00422    option --version is added (unless the ARGP_NO_HELP flag is used), which
00423    will print this string followed by a newline and exit (unless the
00424    ARGP_NO_EXIT flag is used).  Overridden by ARGP_PROGRAM_VERSION_HOOK.  */
00425 extern __const char *argp_program_version;
00426 
00427 /* If defined or set by the user program to a non-zero value, then a default
00428    option --version is added (unless the ARGP_NO_HELP flag is used), which
00429    calls this function with a stream to print the version to and a pointer to
00430    the current parsing state, and then exits (unless the ARGP_NO_EXIT flag is
00431    used).  This variable takes precedent over ARGP_PROGRAM_VERSION.  */
00432 extern void (*argp_program_version_hook) (FILE *__restrict __stream,
00433                                      struct argp_state *__restrict
00434                                      __state);
00435 
00436 /* If defined or set by the user program, it should point to string that is
00437    the bug-reporting address for the program.  It will be printed by
00438    argp_help if the ARGP_HELP_BUG_ADDR flag is set (as it is by various
00439    standard help messages), embedded in a sentence that says something like
00440    `Report bugs to ADDR.'.  */
00441 extern __const char *argp_program_bug_address;
00442 
00443 /* The exit status that argp will use when exiting due to a parsing error.
00444    If not defined or set by the user program, this defaults to EX_USAGE from
00445    <sysexits.h>.  */
00446 extern error_t argp_err_exit_status;
00447 
00448 /* Flags for argp_help.  */
00449 #define ARGP_HELP_USAGE            0x01 /* a Usage: message. */
00450 #define ARGP_HELP_SHORT_USAGE      0x02 /*  " but don't actually print options. */
00451 #define ARGP_HELP_SEE              0x04 /* a `Try ... for more help' message. */
00452 #define ARGP_HELP_LONG             0x08 /* a long help message. */
00453 #define ARGP_HELP_PRE_DOC   0x10 /* doc string preceding long help.  */
00454 #define ARGP_HELP_POST_DOC  0x20 /* doc string following long help.  */
00455 #define ARGP_HELP_DOC              (ARGP_HELP_PRE_DOC | ARGP_HELP_POST_DOC)
00456 #define ARGP_HELP_BUG_ADDR  0x40 /* bug report address */
00457 #define ARGP_HELP_LONG_ONLY 0x80 /* modify output appropriately to
00458                                    reflect ARGP_LONG_ONLY mode.  */
00459 
00460 /* These ARGP_HELP flags are only understood by argp_state_help.  */
00461 #define ARGP_HELP_EXIT_ERR  0x100 /* Call exit(1) instead of returning.  */
00462 #define ARGP_HELP_EXIT_OK   0x200 /* Call exit(0) instead of returning.  */
00463 
00464 /* The standard thing to do after a program command line parsing error, if an
00465    error message has already been printed.  */
00466 #define ARGP_HELP_STD_ERR \
00467   (ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR)
00468 /* The standard thing to do after a program command line parsing error, if no
00469    more specific error message has been printed.  */
00470 #define ARGP_HELP_STD_USAGE \
00471   (ARGP_HELP_SHORT_USAGE | ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR)
00472 /* The standard thing to do in response to a --help option.  */
00473 #define ARGP_HELP_STD_HELP \
00474   (ARGP_HELP_SHORT_USAGE | ARGP_HELP_LONG | ARGP_HELP_EXIT_OK \
00475    | ARGP_HELP_DOC | ARGP_HELP_BUG_ADDR)
00476 
00477 /* Output a usage message for ARGP to STREAM.  FLAGS are from the set
00478    ARGP_HELP_*.  */
00479 extern void argp_help (__const struct argp *__restrict __argp,
00480                      FILE *__restrict __stream,
00481                      unsigned __flags, char *__restrict __name);
00482 extern void __argp_help (__const struct argp *__restrict __argp,
00483                       FILE *__restrict __stream, unsigned __flags,
00484                       char *__name);
00485 
00486 /* The following routines are intended to be called from within an argp
00487    parsing routine (thus taking an argp_state structure as the first
00488    argument).  They may or may not print an error message and exit, depending
00489    on the flags in STATE -- in any case, the caller should be prepared for
00490    them *not* to exit, and should return an appropiate error after calling
00491    them.  [argp_usage & argp_error should probably be called argp_state_...,
00492    but they're used often enough that they should be short]  */
00493 
00494 /* Output, if appropriate, a usage message for STATE to STREAM.  FLAGS are
00495    from the set ARGP_HELP_*.  */
00496 extern void argp_state_help (__const struct argp_state *__restrict __state,
00497                           FILE *__restrict __stream,
00498                           unsigned int __flags);
00499 extern void __argp_state_help (__const struct argp_state *__restrict __state,
00500                             FILE *__restrict __stream,
00501                             unsigned int __flags);
00502 
00503 /* Possibly output the standard usage message for ARGP to stderr and exit.  */
00504 extern void argp_usage (__const struct argp_state *__state);
00505 extern void __argp_usage (__const struct argp_state *__state);
00506 
00507 /* If appropriate, print the printf string FMT and following args, preceded
00508    by the program name and `:', to stderr, and followed by a `Try ... --help'
00509    message, then exit (1).  */
00510 extern void argp_error (__const struct argp_state *__restrict __state,
00511                      __const char *__restrict __fmt, ...)
00512      __attribute__ ((__format__ (__printf__, 2, 3)));
00513 extern void __argp_error (__const struct argp_state *__restrict __state,
00514                        __const char *__restrict __fmt, ...)
00515      __attribute__ ((__format__ (__printf__, 2, 3)));
00516 
00517 /* Similar to the standard gnu error-reporting function error(), but will
00518    respect the ARGP_NO_EXIT and ARGP_NO_ERRS flags in STATE, and will print
00519    to STATE->err_stream.  This is useful for argument parsing code that is
00520    shared between program startup (when exiting is desired) and runtime
00521    option parsing (when typically an error code is returned instead).  The
00522    difference between this function and argp_error is that the latter is for
00523    *parsing errors*, and the former is for other problems that occur during
00524    parsing but don't reflect a (syntactic) problem with the input.  */
00525 extern void argp_failure (__const struct argp_state *__restrict __state,
00526                        int __status, int __errnum,
00527                        __const char *__restrict __fmt, ...)
00528      __attribute__ ((__format__ (__printf__, 4, 5)));
00529 extern void __argp_failure (__const struct argp_state *__restrict __state,
00530                          int __status, int __errnum,
00531                          __const char *__restrict __fmt, ...)
00532      __attribute__ ((__format__ (__printf__, 4, 5)));
00533 
00534 /* Returns true if the option OPT is a valid short option.  */
00535 extern int _option_is_short (__const struct argp_option *__opt) __THROW;
00536 extern int __option_is_short (__const struct argp_option *__opt) __THROW;
00537 
00538 /* Returns true if the option OPT is in fact the last (unused) entry in an
00539    options array.  */
00540 extern int _option_is_end (__const struct argp_option *__opt) __THROW;
00541 extern int __option_is_end (__const struct argp_option *__opt) __THROW;
00542 
00543 /* Return the input field for ARGP in the parser corresponding to STATE; used
00544    by the help routines.  */
00545 extern void *_argp_input (__const struct argp *__restrict __argp,
00546                        __const struct argp_state *__restrict __state)
00547      __THROW;
00548 extern void *__argp_input (__const struct argp *__restrict __argp,
00549                         __const struct argp_state *__restrict __state)
00550      __THROW;
00551 
00552 #ifdef __USE_EXTERN_INLINES
00553 
00554 # if !_LIBC
00555 #  define __argp_usage argp_usage
00556 #  define __argp_state_help argp_state_help
00557 #  define __option_is_short _option_is_short
00558 #  define __option_is_end _option_is_end
00559 # endif
00560 
00561 # ifndef ARGP_EI
00562 #  define ARGP_EI __extern_inline
00563 # endif
00564 
00565 ARGP_EI void
00566 __argp_usage (__const struct argp_state *__state)
00567 {
00568   __argp_state_help (__state, stderr, ARGP_HELP_STD_USAGE);
00569 }
00570 
00571 ARGP_EI int
00572 __NTH (__option_is_short (__const struct argp_option *__opt))
00573 {
00574   if (__opt->flags & OPTION_DOC)
00575     return 0;
00576   else
00577     {
00578       int __key = __opt->key;
00579       return __key > 0 && __key <= UCHAR_MAX && isprint (__key);
00580     }
00581 }
00582 
00583 ARGP_EI int
00584 __NTH (__option_is_end (__const struct argp_option *__opt))
00585 {
00586   return !__opt->key && !__opt->name && !__opt->doc && !__opt->group;
00587 }
00588 
00589 # if !_LIBC
00590 #  undef __argp_usage
00591 #  undef __argp_state_help
00592 #  undef __option_is_short
00593 #  undef __option_is_end
00594 # endif
00595 #endif /* Use extern inlines.  */
00596 
00597 #ifdef  __cplusplus
00598 }
00599 #endif
00600 
00601 #endif /* argp.h */