Remove TLS configure tests.
[platform/upstream/linaro-glibc.git] / argp / argp.h
1 /* Hierarchial argument parsing, layered over getopt.
2    Copyright (C) 1995-2014 Free Software Foundation, Inc.
3    This file is part of the GNU C Library.
4    Written by Miles Bader <miles@gnu.ai.mit.edu>.
5
6    The GNU C Library is free software; you can redistribute it and/or
7    modify it under the terms of the GNU Lesser General Public
8    License as published by the Free Software Foundation; either
9    version 2.1 of the License, or (at your option) any later version.
10
11    The GNU C Library is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Lesser General Public License for more details.
15
16    You should have received a copy of the GNU Lesser General Public
17    License along with the GNU C Library; if not, see
18    <http://www.gnu.org/licenses/>.  */
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) || \
41   defined __STRICT_ANSI__
42 #  define __attribute__(Spec) /* empty */
43 # endif
44 /* The __-protected variants of `format' and `printf' attributes
45    are accepted by gcc versions 2.6.4 (effectively 2.7) and later.  */
46 # if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7) || \
47   defined __STRICT_ANSI__
48 #  define __format__ format
49 #  define __printf__ printf
50 # endif
51 #endif
52
53 /* GCC 2.95 and later have "__restrict"; C99 compilers have
54    "restrict", and "configure" may have defined "restrict".  */
55 #ifndef __restrict
56 # if ! (2 < __GNUC__ || (2 == __GNUC__ && 95 <= __GNUC_MINOR__))
57 #  if defined restrict || 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   const char *doc;
101
102   /* The group this option is in.  In a long help message, options are sorted
103      alphabetically within each group, and the groups presented in the order
104      0, 1, 2, ..., n, -m, ..., -2, -1.  Every entry in an options array with
105      if this field 0 will inherit the group number of the previous entry, or
106      zero if it's the first one, unless its a group header (NAME and KEY both
107      0), in which case, the previous entry + 1 is the default.  Automagic
108      options such as --help are put into group -1.  */
109   int group;
110 };
111
112 /* The argument associated with this option is optional.  */
113 #define OPTION_ARG_OPTIONAL     0x1
114
115 /* This option isn't displayed in any help messages.  */
116 #define OPTION_HIDDEN           0x2
117
118 /* This option is an alias for the closest previous non-alias option.  This
119    means that it will be displayed in the same help entry, and will inherit
120    fields other than NAME and KEY from the aliased option.  */
121 #define OPTION_ALIAS            0x4
122
123 /* This option isn't actually an option (and so should be ignored by the
124    actual option parser), but rather an arbitrary piece of documentation that
125    should be displayed in much the same manner as the options.  If this flag
126    is set, then the option NAME field is displayed unmodified (e.g., no `--'
127    prefix is added) at the left-margin (where a *short* option would normally
128    be displayed), and the documentation string in the normal place.  For
129    purposes of sorting, any leading whitespace and punctuation is ignored,
130    except that if the first non-whitespace character is not `-', this entry
131    is displayed after all options (and OPTION_DOC entries with a leading `-')
132    in the same group.  */
133 #define OPTION_DOC              0x8
134
135 /* This option shouldn't be included in `long' usage messages (but is still
136    included in help messages).  This is mainly intended for options that are
137    completely documented in an argp's ARGS_DOC field, in which case including
138    the option in the generic usage list would be redundant.  For instance,
139    if ARGS_DOC is "FOO BAR\n-x BLAH", and the `-x' option's purpose is to
140    distinguish these two cases, -x should probably be marked
141    OPTION_NO_USAGE.  */
142 #define OPTION_NO_USAGE         0x10
143 \f
144 struct argp;                    /* fwd declare this type */
145 struct argp_state;              /* " */
146 struct argp_child;              /* " */
147
148 /* The type of a pointer to an argp parsing function.  */
149 typedef error_t (*argp_parser_t) (int __key, char *__arg,
150                                   struct argp_state *__state);
151
152 /* What to return for unrecognized keys.  For special ARGP_KEY_ keys, such
153    returns will simply be ignored.  For user keys, this error will be turned
154    into EINVAL (if the call to argp_parse is such that errors are propagated
155    back to the user instead of exiting); returning EINVAL itself would result
156    in an immediate stop to parsing in *all* cases.  */
157 #define ARGP_ERR_UNKNOWN        E2BIG /* Hurd should never need E2BIG.  XXX */
158
159 /* Special values for the KEY argument to an argument parsing function.
160    ARGP_ERR_UNKNOWN should be returned if they aren't understood.
161
162    The sequence of keys to a parsing function is either (where each
163    uppercased word should be prefixed by `ARGP_KEY_' and opt is a user key):
164
165        INIT opt... NO_ARGS END SUCCESS  -- No non-option arguments at all
166    or  INIT (opt | ARG)... END SUCCESS  -- All non-option args parsed
167    or  INIT (opt | ARG)... SUCCESS      -- Some non-option arg unrecognized
168
169    The third case is where every parser returned ARGP_KEY_UNKNOWN for an
170    argument, in which case parsing stops at that argument (returning the
171    unparsed arguments to the caller of argp_parse if requested, or stopping
172    with an error message if not).
173
174    If an error occurs (either detected by argp, or because the parsing
175    function returned an error value), then the parser is called with
176    ARGP_KEY_ERROR, and no further calls are made.  */
177
178 /* This is not an option at all, but rather a command line argument.  If a
179    parser receiving this key returns success, the fact is recorded, and the
180    ARGP_KEY_NO_ARGS case won't be used.  HOWEVER, if while processing the
181    argument, a parser function decrements the NEXT field of the state it's
182    passed, the option won't be considered processed; this is to allow you to
183    actually modify the argument (perhaps into an option), and have it
184    processed again.  */
185 #define ARGP_KEY_ARG            0
186 /* There are remaining arguments not parsed by any parser, which may be found
187    starting at (STATE->argv + STATE->next).  If success is returned, but
188    STATE->next left untouched, it's assumed that all arguments were consume,
189    otherwise, the parser should adjust STATE->next to reflect any arguments
190    consumed.  */
191 #define ARGP_KEY_ARGS           0x1000006
192 /* There are no more command line arguments at all.  */
193 #define ARGP_KEY_END            0x1000001
194 /* Because it's common to want to do some special processing if there aren't
195    any non-option args, user parsers are called with this key if they didn't
196    successfully process any non-option arguments.  Called just before
197    ARGP_KEY_END (where more general validity checks on previously parsed
198    arguments can take place).  */
199 #define ARGP_KEY_NO_ARGS        0x1000002
200 /* Passed in before any parsing is done.  Afterwards, the values of each
201    element of the CHILD_INPUT field, if any, in the state structure is
202    copied to each child's state to be the initial value of the INPUT field.  */
203 #define ARGP_KEY_INIT           0x1000003
204 /* Use after all other keys, including SUCCESS & END.  */
205 #define ARGP_KEY_FINI           0x1000007
206 /* Passed in when parsing has successfully been completed (even if there are
207    still arguments remaining).  */
208 #define ARGP_KEY_SUCCESS        0x1000004
209 /* Passed in if an error occurs.  */
210 #define ARGP_KEY_ERROR          0x1000005
211
212 /* An argp structure contains a set of options declarations, a function to
213    deal with parsing one, documentation string, a possible vector of child
214    argp's, and perhaps a function to filter help output.  When actually
215    parsing options, getopt is called with the union of all the argp
216    structures chained together through their CHILD pointers, with conflicts
217    being resolved in favor of the first occurrence in the chain.  */
218 struct argp
219 {
220   /* An array of argp_option structures, terminated by an entry with both
221      NAME and KEY having a value of 0.  */
222   const struct argp_option *options;
223
224   /* What to do with an option from this structure.  KEY is the key
225      associated with the option, and ARG is any associated argument (NULL if
226      none was supplied).  If KEY isn't understood, ARGP_ERR_UNKNOWN should be
227      returned.  If a non-zero, non-ARGP_ERR_UNKNOWN value is returned, then
228      parsing is stopped immediately, and that value is returned from
229      argp_parse().  For special (non-user-supplied) values of KEY, see the
230      ARGP_KEY_ definitions below.  */
231   argp_parser_t parser;
232
233   /* A string describing what other arguments are wanted by this program.  It
234      is only used by argp_usage to print the `Usage:' message.  If it
235      contains newlines, the strings separated by them are considered
236      alternative usage patterns, and printed on separate lines (lines after
237      the first are prefix by `  or: ' instead of `Usage:').  */
238   const char *args_doc;
239
240   /* If non-NULL, a string containing extra text to be printed before and
241      after the options in a long help message (separated by a vertical tab
242      `\v' character).  */
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 preceeding 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 /* If defined or set by the user program to a non-zero value, then a default
418    option --version is added (unless the ARGP_NO_HELP flag is used), which
419    will print this string followed by a newline and exit (unless the
420    ARGP_NO_EXIT flag is used).  Overridden by ARGP_PROGRAM_VERSION_HOOK.  */
421 extern const char *argp_program_version;
422
423 /* If defined or set by the user program to a non-zero value, then a default
424    option --version is added (unless the ARGP_NO_HELP flag is used), which
425    calls this function with a stream to print the version to and a pointer to
426    the current parsing state, and then exits (unless the ARGP_NO_EXIT flag is
427    used).  This variable takes precedent over ARGP_PROGRAM_VERSION.  */
428 extern void (*argp_program_version_hook) (FILE *__restrict __stream,
429                                           struct argp_state *__restrict
430                                           __state);
431
432 /* If defined or set by the user program, it should point to string that is
433    the bug-reporting address for the program.  It will be printed by
434    argp_help if the ARGP_HELP_BUG_ADDR flag is set (as it is by various
435    standard help messages), embedded in a sentence that says something like
436    `Report bugs to ADDR.'.  */
437 extern const char *argp_program_bug_address;
438
439 /* The exit status that argp will use when exiting due to a parsing error.
440    If not defined or set by the user program, this defaults to EX_USAGE from
441    <sysexits.h>.  */
442 extern error_t argp_err_exit_status;
443 \f
444 /* Flags for argp_help.  */
445 #define ARGP_HELP_USAGE         0x01 /* a Usage: message. */
446 #define ARGP_HELP_SHORT_USAGE   0x02 /*  " but don't actually print options. */
447 #define ARGP_HELP_SEE           0x04 /* a `Try ... for more help' message. */
448 #define ARGP_HELP_LONG          0x08 /* a long help message. */
449 #define ARGP_HELP_PRE_DOC       0x10 /* doc string preceding long help.  */
450 #define ARGP_HELP_POST_DOC      0x20 /* doc string following long help.  */
451 #define ARGP_HELP_DOC           (ARGP_HELP_PRE_DOC | ARGP_HELP_POST_DOC)
452 #define ARGP_HELP_BUG_ADDR      0x40 /* bug report address */
453 #define ARGP_HELP_LONG_ONLY     0x80 /* modify output appropriately to
454                                         reflect ARGP_LONG_ONLY mode.  */
455
456 /* These ARGP_HELP flags are only understood by argp_state_help.  */
457 #define ARGP_HELP_EXIT_ERR      0x100 /* Call exit(1) instead of returning.  */
458 #define ARGP_HELP_EXIT_OK       0x200 /* Call exit(0) instead of returning.  */
459
460 /* The standard thing to do after a program command line parsing error, if an
461    error message has already been printed.  */
462 #define ARGP_HELP_STD_ERR \
463   (ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR)
464 /* The standard thing to do after a program command line parsing error, if no
465    more specific error message has been printed.  */
466 #define ARGP_HELP_STD_USAGE \
467   (ARGP_HELP_SHORT_USAGE | ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR)
468 /* The standard thing to do in response to a --help option.  */
469 #define ARGP_HELP_STD_HELP \
470   (ARGP_HELP_SHORT_USAGE | ARGP_HELP_LONG | ARGP_HELP_EXIT_OK \
471    | ARGP_HELP_DOC | ARGP_HELP_BUG_ADDR)
472
473 /* Output a usage message for ARGP to STREAM.  FLAGS are from the set
474    ARGP_HELP_*.  */
475 extern void argp_help (const struct argp *__restrict __argp,
476                        FILE *__restrict __stream,
477                        unsigned __flags, char *__restrict __name);
478 extern void __argp_help (const struct argp *__restrict __argp,
479                          FILE *__restrict __stream, unsigned __flags,
480                          char *__name);
481 \f
482 /* The following routines are intended to be called from within an argp
483    parsing routine (thus taking an argp_state structure as the first
484    argument).  They may or may not print an error message and exit, depending
485    on the flags in STATE -- in any case, the caller should be prepared for
486    them *not* to exit, and should return an appropiate error after calling
487    them.  [argp_usage & argp_error should probably be called argp_state_...,
488    but they're used often enough that they should be short]  */
489
490 /* Output, if appropriate, a usage message for STATE to STREAM.  FLAGS are
491    from the set ARGP_HELP_*.  */
492 extern void argp_state_help (const struct argp_state *__restrict __state,
493                              FILE *__restrict __stream,
494                              unsigned int __flags);
495 extern void __argp_state_help (const struct argp_state *__restrict __state,
496                                FILE *__restrict __stream,
497                                unsigned int __flags);
498
499 /* Possibly output the standard usage message for ARGP to stderr and exit.  */
500 extern void argp_usage (const struct argp_state *__state);
501 extern void __argp_usage (const struct argp_state *__state);
502
503 /* If appropriate, print the printf string FMT and following args, preceded
504    by the program name and `:', to stderr, and followed by a `Try ... --help'
505    message, then exit (1).  */
506 extern void argp_error (const struct argp_state *__restrict __state,
507                         const char *__restrict __fmt, ...)
508      __attribute__ ((__format__ (__printf__, 2, 3)));
509 extern void __argp_error (const struct argp_state *__restrict __state,
510                           const char *__restrict __fmt, ...)
511      __attribute__ ((__format__ (__printf__, 2, 3)));
512
513 /* Similar to the standard gnu error-reporting function error(), but will
514    respect the ARGP_NO_EXIT and ARGP_NO_ERRS flags in STATE, and will print
515    to STATE->err_stream.  This is useful for argument parsing code that is
516    shared between program startup (when exiting is desired) and runtime
517    option parsing (when typically an error code is returned instead).  The
518    difference between this function and argp_error is that the latter is for
519    *parsing errors*, and the former is for other problems that occur during
520    parsing but don't reflect a (syntactic) problem with the input.  */
521 extern void argp_failure (const struct argp_state *__restrict __state,
522                           int __status, int __errnum,
523                           const char *__restrict __fmt, ...)
524      __attribute__ ((__format__ (__printf__, 4, 5)));
525 extern void __argp_failure (const struct argp_state *__restrict __state,
526                             int __status, int __errnum,
527                             const char *__restrict __fmt, ...)
528      __attribute__ ((__format__ (__printf__, 4, 5)));
529
530 /* Returns true if the option OPT is a valid short option.  */
531 extern int _option_is_short (const struct argp_option *__opt) __THROW;
532 extern int __option_is_short (const struct argp_option *__opt) __THROW;
533
534 /* Returns true if the option OPT is in fact the last (unused) entry in an
535    options array.  */
536 extern int _option_is_end (const struct argp_option *__opt) __THROW;
537 extern int __option_is_end (const struct argp_option *__opt) __THROW;
538
539 /* Return the input field for ARGP in the parser corresponding to STATE; used
540    by the help routines.  */
541 extern void *_argp_input (const struct argp *__restrict __argp,
542                           const struct argp_state *__restrict __state)
543      __THROW;
544 extern void *__argp_input (const struct argp *__restrict __argp,
545                            const struct argp_state *__restrict __state)
546      __THROW;
547 \f
548 #ifdef __USE_EXTERN_INLINES
549
550 # if !_LIBC
551 #  define __argp_usage argp_usage
552 #  define __argp_state_help argp_state_help
553 #  define __option_is_short _option_is_short
554 #  define __option_is_end _option_is_end
555 # endif
556
557 # ifndef ARGP_EI
558 #  define ARGP_EI __extern_inline
559 # endif
560
561 ARGP_EI void
562 __argp_usage (const struct argp_state *__state)
563 {
564   __argp_state_help (__state, stderr, ARGP_HELP_STD_USAGE);
565 }
566
567 ARGP_EI int
568 __NTH (__option_is_short (const struct argp_option *__opt))
569 {
570   if (__opt->flags & OPTION_DOC)
571     return 0;
572   else
573     {
574       int __key = __opt->key;
575       return __key > 0 && __key <= UCHAR_MAX && isprint (__key);
576     }
577 }
578
579 ARGP_EI int
580 __NTH (__option_is_end (const struct argp_option *__opt))
581 {
582   return !__opt->key && !__opt->name && !__opt->doc && !__opt->group;
583 }
584
585 # if !_LIBC
586 #  undef __argp_usage
587 #  undef __argp_state_help
588 #  undef __option_is_short
589 #  undef __option_is_end
590 # endif
591 #endif /* Use extern inlines.  */
592
593 #ifdef  __cplusplus
594 }
595 #endif
596
597 #endif /* argp.h */