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