source: trunk/essentials/app-arch/tar/lib/argp.h

Last change on this file was 3342, checked in by bird, 18 years ago

tar 1.16.1

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