Mercurial > hg-old > index.cgi

comparison lib/argp.h @ 421:3c2e1f24cc7d 3.0-beta2

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