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