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