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