source: vendor/glibc/current/argp/argp.h

Last change on this file was 2141, checked in by bird, 20 years ago

Initial revision

  • Property cvs2svn:cvs-rev set to 1.1
  • Property svn:eol-style set to native
  • Property svn:executable set to *
File size: 25.8 KB
Line 
1/* Hierarchial argument parsing, layered over getopt.
2 Copyright (C) 1995-1999,2003,2004 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, write to the Free
18 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19 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 __THROW
36# define __THROW
37#endif
38#ifndef __NTH
39# define __NTH(fct) fct __THROW
40#endif
41
42#ifndef __attribute__
43/* This feature is available in gcc versions 2.5 and later. */
44# if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5) || __STRICT_ANSI__
45# define __attribute__(Spec) /* empty */
46# endif
47/* The __-protected variants of `format' and `printf' attributes
48 are accepted by gcc versions 2.6.4 (effectively 2.7) and later. */
49# if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 7) || __STRICT_ANSI__
50# define __format__ format
51# define __printf__ printf
52# endif
53#endif
54
55/* GCC 2.95 and later have "__restrict"; C99 compilers have
56 "restrict", and "configure" may have defined "restrict". */
57#ifndef __restrict
58# if ! (2 < __GNUC__ || (2 == __GNUC__ && 95 <= __GNUC_MINOR__))
59# if defined restrict || 199901L <= __STDC_VERSION__
60# define __restrict restrict
61# else
62# define __restrict
63# endif
64# endif
65#endif
66
67#ifndef __error_t_defined
68typedef int error_t;
69# define __error_t_defined
70#endif
71
72
73#ifdef __cplusplus
74extern "C" {
75#endif
76
77/* A description of a particular option. A pointer to an array of
78 these is passed in the OPTIONS field of an argp structure. Each option
79 entry can correspond to one long option and/or one short option; more
80 names for the same option can be added by following an entry in an option
81 array with options having the OPTION_ALIAS flag set. */
82struct argp_option
83{
84 /* The long option name. For more than one name for the same option, you
85 can use following options with the OPTION_ALIAS flag set. */
86 __const char *name;
87
88 /* What key is returned for this option. If > 0 and printable, then it's
89 also accepted as a short option. */
90 int key;
91
92 /* If non-NULL, this is the name of the argument associated with this
93 option, which is required unless the OPTION_ARG_OPTIONAL flag is set. */
94 __const char *arg;
95
96 /* OPTION_ flags. */
97 int flags;
98
99 /* The doc string for this option. If both NAME and KEY are 0, This string
100 will be printed outdented from the normal option column, making it
101 useful as a group header (it will be the first thing printed in its
102 group); in this usage, it's conventional to end the string with a `:'. */
103 __const char *doc;
104
105 /* The group this option is in. In a long help message, options are sorted
106 alphabetically within each group, and the groups presented in the order
107 0, 1, 2, ..., n, -m, ..., -2, -1. Every entry in an options array with
108 if this field 0 will inherit the group number of the previous entry, or
109 zero if it's the first one, unless its a group header (NAME and KEY both
110 0), in which case, the previous entry + 1 is the default. Automagic
111 options such as --help are put into group -1. */
112 int group;
113};
114
115/* The argument associated with this option is optional. */
116#define OPTION_ARG_OPTIONAL 0x1
117
118/* This option isn't displayed in any help messages. */
119#define OPTION_HIDDEN 0x2
120
121/* This option is an alias for the closest previous non-alias option. This
122 means that it will be displayed in the same help entry, and will inherit
123 fields other than NAME and KEY from the aliased option. */
124#define OPTION_ALIAS 0x4
125
126/* This option isn't actually an option (and so should be ignored by the
127 actual option parser), but rather an arbitrary piece of documentation that
128 should be displayed in much the same manner as the options. If this flag
129 is set, then the option NAME field is displayed unmodified (e.g., no `--'
130 prefix is added) at the left-margin (where a *short* option would normally
131 be displayed), and the documentation string in the normal place. For
132 purposes of sorting, any leading whitespace and punctuation is ignored,
133 except that if the first non-whitespace character is not `-', this entry
134 is displayed after all options (and OPTION_DOC entries with a leading `-')
135 in the same group. */
136#define OPTION_DOC 0x8
137
138/* This option shouldn't be included in `long' usage messages (but is still
139 included in help messages). This is mainly intended for options that are
140 completely documented in an argp's ARGS_DOC field, in which case including
141 the option in the generic usage list would be redundant. For instance,
142 if ARGS_DOC is "FOO BAR\n-x BLAH", and the `-x' option's purpose is to
143 distinguish these two cases, -x should probably be marked
144 OPTION_NO_USAGE. */
145#define OPTION_NO_USAGE 0x10
146
147
148struct argp; /* fwd declare this type */
149struct argp_state; /* " */
150struct argp_child; /* " */
151
152/* The type of a pointer to an argp parsing function. */
153typedef 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. */
222struct 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
287/* When an argp has a non-zero CHILDREN field, it should point to a vector of
288 argp_child structures, each of which describes a subsidiary argp. */
289struct argp_child
290{
291 /* The child parser. */
292 __const struct argp *argp;
293
294 /* Flags for this child. */
295 int flags;
296
297 /* If non-zero, an optional header to be printed in help output before the
298 child options. As a side-effect, a non-zero value forces the child
299 options to be grouped together; to achieve this effect without actually
300 printing a header string, use a value of "". */
301 __const char *header;
302
303 /* Where to group the child options relative to the other (`consolidated')
304 options in the parent argp; the values are the same as the GROUP field
305 in argp_option structs, but all child-groupings follow parent options at
306 a particular group level. If both this field and HEADER are zero, then
307 they aren't grouped at all, but rather merged with the parent options
308 (merging the child's grouping levels with the parents). */
309 int group;
310};
311
312
313/* Parsing state. This is provided to parsing functions called by argp,
314 which may examine and, as noted, modify fields. */
315struct argp_state
316{
317 /* The top level ARGP being parsed. */
318 __const struct argp *root_argp;
319
320 /* The argument vector being parsed. May be modified. */
321 int argc;
322 char **argv;
323
324 /* The index in ARGV of the next arg that to be parsed. May be modified. */
325 int next;
326
327 /* The flags supplied to argp_parse. May be modified. */
328 unsigned flags;
329
330 /* While calling a parsing function with a key of ARGP_KEY_ARG, this is the
331 number of the current arg, starting at zero, and incremented after each
332 such call returns. At all other times, this is the number of such
333 arguments that have been processed. */
334 unsigned arg_num;
335
336 /* If non-zero, the index in ARGV of the first argument following a special
337 `--' argument (which prevents anything following being interpreted as an
338 option). Only set once argument parsing has proceeded past this point. */
339 int quoted;
340
341 /* An arbitrary pointer passed in from the user. */
342 void *input;
343 /* Values to pass to child parsers. This vector will be the same length as
344 the number of children for the current parser. */
345 void **child_inputs;
346
347 /* For the parser's use. Initialized to 0. */
348 void *hook;
349
350 /* The name used when printing messages. This is initialized to ARGV[0],
351 or PROGRAM_INVOCATION_NAME if that is unavailable. */
352 char *name;
353
354 /* Streams used when argp prints something. */
355 FILE *err_stream; /* For errors; initialized to stderr. */
356 FILE *out_stream; /* For information; initialized to stdout. */
357
358 void *pstate; /* Private, for use by argp. */
359};
360
361
362/* Flags for argp_parse (note that the defaults are those that are
363 convenient for program command line parsing): */
364
365/* Don't ignore the first element of ARGV. Normally (and always unless
366 ARGP_NO_ERRS is set) the first element of the argument vector is
367 skipped for option parsing purposes, as it corresponds to the program name
368 in a command line. */
369#define ARGP_PARSE_ARGV0 0x01
370
371/* Don't print error messages for unknown options to stderr; unless this flag
372 is set, ARGP_PARSE_ARGV0 is ignored, as ARGV[0] is used as the program
373 name in the error messages. This flag implies ARGP_NO_EXIT (on the
374 assumption that silent exiting upon errors is bad behaviour). */
375#define ARGP_NO_ERRS 0x02
376
377/* Don't parse any non-option args. Normally non-option args are parsed by
378 calling the parse functions with a key of ARGP_KEY_ARG, and the actual arg
379 as the value. Since it's impossible to know which parse function wants to
380 handle it, each one is called in turn, until one returns 0 or an error
381 other than ARGP_ERR_UNKNOWN; if an argument is handled by no one, the
382 argp_parse returns prematurely (but with a return value of 0). If all
383 args have been parsed without error, all parsing functions are called one
384 last time with a key of ARGP_KEY_END. This flag needn't normally be set,
385 as the normal behavior is to stop parsing as soon as some argument can't
386 be handled. */
387#define ARGP_NO_ARGS 0x04
388
389/* Parse options and arguments in the same order they occur on the command
390 line -- normally they're rearranged so that all options come first. */
391#define ARGP_IN_ORDER 0x08
392
393/* Don't provide the standard long option --help, which causes usage and
394 option help information to be output to stdout, and exit (0) called. */
395#define ARGP_NO_HELP 0x10
396
397/* Don't exit on errors (they may still result in error messages). */
398#define ARGP_NO_EXIT 0x20
399
400/* Use the gnu getopt `long-only' rules for parsing arguments. */
401#define ARGP_LONG_ONLY 0x40
402
403/* Turns off any message-printing/exiting options. */
404#define ARGP_SILENT (ARGP_NO_EXIT | ARGP_NO_ERRS | ARGP_NO_HELP)
405
406/* Parse the options strings in ARGC & ARGV according to the options in ARGP.
407 FLAGS is one of the ARGP_ flags above. If ARG_INDEX is non-NULL, the
408 index in ARGV of the first unparsed option is returned in it. If an
409 unknown option is present, ARGP_ERR_UNKNOWN is returned; if some parser
410 routine returned a non-zero value, it is returned; otherwise 0 is
411 returned. This function may also call exit unless the ARGP_NO_HELP flag
412 is set. INPUT is a pointer to a value to be passed in to the parser. */
413extern error_t argp_parse (__const struct argp *__restrict __argp,
414 int __argc, char **__restrict __argv,
415 unsigned __flags, int *__restrict __arg_index,
416 void *__restrict __input);
417extern error_t __argp_parse (__const struct argp *__restrict __argp,
418 int __argc, char **__restrict __argv,
419 unsigned __flags, int *__restrict __arg_index,
420 void *__restrict __input);
421
422
423/* Global variables. */
424
425/* If defined or set by the user program to a non-zero value, then a default
426 option --version is added (unless the ARGP_NO_HELP flag is used), which
427 will print this string followed by a newline and exit (unless the
428 ARGP_NO_EXIT flag is used). Overridden by ARGP_PROGRAM_VERSION_HOOK. */
429extern __const char *argp_program_version;
430
431/* If defined or set by the user program to a non-zero value, then a default
432 option --version is added (unless the ARGP_NO_HELP flag is used), which
433 calls this function with a stream to print the version to and a pointer to
434 the current parsing state, and then exits (unless the ARGP_NO_EXIT flag is
435 used). This variable takes precedent over ARGP_PROGRAM_VERSION. */
436extern void (*argp_program_version_hook) (FILE *__restrict __stream,
437 struct argp_state *__restrict
438 __state);
439
440/* If defined or set by the user program, it should point to string that is
441 the bug-reporting address for the program. It will be printed by
442 argp_help if the ARGP_HELP_BUG_ADDR flag is set (as it is by various
443 standard help messages), embedded in a sentence that says something like
444 `Report bugs to ADDR.'. */
445extern __const char *argp_program_bug_address;
446
447/* The exit status that argp will use when exiting due to a parsing error.
448 If not defined or set by the user program, this defaults to EX_USAGE from
449 <sysexits.h>. */
450extern error_t argp_err_exit_status;
451
452
453/* Flags for argp_help. */
454#define ARGP_HELP_USAGE 0x01 /* a Usage: message. */
455#define ARGP_HELP_SHORT_USAGE 0x02 /* " but don't actually print options. */
456#define ARGP_HELP_SEE 0x04 /* a `Try ... for more help' message. */
457#define ARGP_HELP_LONG 0x08 /* a long help message. */
458#define ARGP_HELP_PRE_DOC 0x10 /* doc string preceding long help. */
459#define ARGP_HELP_POST_DOC 0x20 /* doc string following long help. */
460#define ARGP_HELP_DOC (ARGP_HELP_PRE_DOC | ARGP_HELP_POST_DOC)
461#define ARGP_HELP_BUG_ADDR 0x40 /* bug report address */
462#define ARGP_HELP_LONG_ONLY 0x80 /* modify output appropriately to
463 reflect ARGP_LONG_ONLY mode. */
464
465/* These ARGP_HELP flags are only understood by argp_state_help. */
466#define ARGP_HELP_EXIT_ERR 0x100 /* Call exit(1) instead of returning. */
467#define ARGP_HELP_EXIT_OK 0x200 /* Call exit(0) instead of returning. */
468
469/* The standard thing to do after a program command line parsing error, if an
470 error message has already been printed. */
471#define ARGP_HELP_STD_ERR \
472 (ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR)
473/* The standard thing to do after a program command line parsing error, if no
474 more specific error message has been printed. */
475#define ARGP_HELP_STD_USAGE \
476 (ARGP_HELP_SHORT_USAGE | ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR)
477/* The standard thing to do in response to a --help option. */
478#define ARGP_HELP_STD_HELP \
479 (ARGP_HELP_SHORT_USAGE | ARGP_HELP_LONG | ARGP_HELP_EXIT_OK \
480 | ARGP_HELP_DOC | ARGP_HELP_BUG_ADDR)
481
482/* Output a usage message for ARGP to STREAM. FLAGS are from the set
483 ARGP_HELP_*. */
484extern void argp_help (__const struct argp *__restrict __argp,
485 FILE *__restrict __stream,
486 unsigned __flags, char *__restrict __name);
487extern void __argp_help (__const struct argp *__restrict __argp,
488 FILE *__restrict __stream, unsigned __flags,
489 char *__name);
490
491
492/* The following routines are intended to be called from within an argp
493 parsing routine (thus taking an argp_state structure as the first
494 argument). They may or may not print an error message and exit, depending
495 on the flags in STATE -- in any case, the caller should be prepared for
496 them *not* to exit, and should return an appropiate error after calling
497 them. [argp_usage & argp_error should probably be called argp_state_...,
498 but they're used often enough that they should be short] */
499
500/* Output, if appropriate, a usage message for STATE to STREAM. FLAGS are
501 from the set ARGP_HELP_*. */
502extern void argp_state_help (__const struct argp_state *__restrict __state,
503 FILE *__restrict __stream,
504 unsigned int __flags);
505extern void __argp_state_help (__const struct argp_state *__restrict __state,
506 FILE *__restrict __stream,
507 unsigned int __flags);
508
509/* Possibly output the standard usage message for ARGP to stderr and exit. */
510extern void argp_usage (__const struct argp_state *__state);
511extern void __argp_usage (__const struct argp_state *__state);
512
513/* If appropriate, print the printf string FMT and following args, preceded
514 by the program name and `:', to stderr, and followed by a `Try ... --help'
515 message, then exit (1). */
516extern void argp_error (__const struct argp_state *__restrict __state,
517 __const char *__restrict __fmt, ...)
518 __attribute__ ((__format__ (__printf__, 2, 3)));
519extern void __argp_error (__const struct argp_state *__restrict __state,
520 __const char *__restrict __fmt, ...)
521 __attribute__ ((__format__ (__printf__, 2, 3)));
522
523/* Similar to the standard gnu error-reporting function error(), but will
524 respect the ARGP_NO_EXIT and ARGP_NO_ERRS flags in STATE, and will print
525 to STATE->err_stream. This is useful for argument parsing code that is
526 shared between program startup (when exiting is desired) and runtime
527 option parsing (when typically an error code is returned instead). The
528 difference between this function and argp_error is that the latter is for
529 *parsing errors*, and the former is for other problems that occur during
530 parsing but don't reflect a (syntactic) problem with the input. */
531extern void argp_failure (__const struct argp_state *__restrict __state,
532 int __status, int __errnum,
533 __const char *__restrict __fmt, ...)
534 __attribute__ ((__format__ (__printf__, 4, 5)));
535extern void __argp_failure (__const struct argp_state *__restrict __state,
536 int __status, int __errnum,
537 __const char *__restrict __fmt, ...)
538 __attribute__ ((__format__ (__printf__, 4, 5)));
539
540/* Returns true if the option OPT is a valid short option. */
541extern int _option_is_short (__const struct argp_option *__opt) __THROW;
542extern int __option_is_short (__const struct argp_option *__opt) __THROW;
543
544/* Returns true if the option OPT is in fact the last (unused) entry in an
545 options array. */
546extern int _option_is_end (__const struct argp_option *__opt) __THROW;
547extern int __option_is_end (__const struct argp_option *__opt) __THROW;
548
549/* Return the input field for ARGP in the parser corresponding to STATE; used
550 by the help routines. */
551extern void *_argp_input (__const struct argp *__restrict __argp,
552 __const struct argp_state *__restrict __state)
553 __THROW;
554extern void *__argp_input (__const struct argp *__restrict __argp,
555 __const struct argp_state *__restrict __state)
556 __THROW;
557
558
559#ifdef __USE_EXTERN_INLINES
560
561# if !_LIBC
562# define __argp_usage argp_usage
563# define __argp_state_help argp_state_help
564# define __option_is_short _option_is_short
565# define __option_is_end _option_is_end
566# endif
567
568# ifndef ARGP_EI
569# define ARGP_EI extern __inline__
570# endif
571
572ARGP_EI void
573__NTH (__argp_usage (__const struct argp_state *__state))
574{
575 __argp_state_help (__state, stderr, ARGP_HELP_STD_USAGE);
576}
577
578ARGP_EI int
579__NTH (__option_is_short (__const struct argp_option *__opt))
580{
581 if (__opt->flags & OPTION_DOC)
582 return 0;
583 else
584 {
585 int __key = __opt->key;
586 return __key > 0 && isprint (__key);
587 }
588}
589
590ARGP_EI int
591__NTH (__option_is_end (__const struct argp_option *__opt))
592{
593 return !__opt->key && !__opt->name && !__opt->doc && !__opt->group;
594}
595
596# if !_LIBC
597# undef __argp_usage
598# undef __argp_state_help
599# undef __option_is_short
600# undef __option_is_end
601# endif
602#endif /* Use extern inlines. */
603
604#ifdef __cplusplus
605}
606#endif
607
608#endif /* argp.h */
Note: See TracBrowser for help on using the repository browser.