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