1 /* Hierarchial argument parsing, layered over getopt.
2 Copyright (C) 1995, 1996, 1997 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 The GNU C Library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Library General Public License as
8 published by the Free Software Foundation; either version 2 of the
9 License, or (at your option) any later version.
11 The GNU C Library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Library General Public License for more details.
16 You should have received a copy of the GNU Library General Public
17 License along with the GNU C Library; see the file COPYING.LIB. If not,
18 write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
28 #define __need_error_t
35 #ifndef __error_t_defined
40 # if (defined (__STDC__) && __STDC__) || defined (__cplusplus)
41 # define __P(args) args
51 /* A description of a particular option. A pointer to an array of
52 these is passed in the OPTIONS field of an argp structure. Each option
53 entry can correspond to one long option and/or one short option; more
54 names for the same option can be added by following an entry in an option
55 array with options having the OPTION_ALIAS flag set. */
58 /* The long option name. For more than one name for the same option, you
59 can use following options with the OPTION_ALIAS flag set. */
62 /* What key is returned for this option. If > 0 and printable, then it's
63 also accepted as a short option. */
66 /* If non-NULL, this is the name of the argument associated with this
67 option, which is required unless the OPTION_ARG_OPTIONAL flag is set. */
73 /* The doc string for this option. If both NAME and KEY are 0, This string
74 will be printed outdented from the normal option column, making it
75 useful as a group header (it will be the first thing printed in its
76 group); in this usage, it's conventional to end the string with a `:'. */
79 /* The group this option is in. In a long help message, options are sorted
80 alphabetically within each group, and the groups presented in the order
81 0, 1, 2, ..., n, -m, ..., -2, -1. Every entry in an options array with
82 if this field 0 will inherit the group number of the previous entry, or
83 zero if it's the first one, unless its a group header (NAME and KEY both
84 0), in which case, the previous entry + 1 is the default. Automagic
85 options such as --help are put into group -1. */
89 /* The argument associated with this option is optional. */
90 #define OPTION_ARG_OPTIONAL 0x1
92 /* This option isn't displayed in any help messages. */
93 #define OPTION_HIDDEN 0x2
95 /* This option is an alias for the closest previous non-alias option. This
96 means that it will be displayed in the same help entry, and will inherit
97 fields other than NAME and KEY from the aliased option. */
98 #define OPTION_ALIAS 0x4
100 /* This option isn't actually an option (and so should be ignored by the
101 actual option parser), but rather an arbitrary piece of documentation that
102 should be displayed in much the same manner as the options. If this flag
103 is set, then the option NAME field is displayed unmodified (e.g., no `--'
104 prefix is added) at the left-margin (where a *short* option would normally
105 be displayed), and the documentation string in the normal place. For
106 purposes of sorting, any leading whitespace and puncuation is ignored,
107 except that if the first non-whitespace character is not `-', this entry
108 is displayed after all options (and OPTION_DOC entries with a leading `-')
109 in the same group. */
110 #define OPTION_DOC 0x8
112 /* This option shouldn't be included in `long' usage messages (but is still
113 included in help messages). This is mainly intended for options that are
114 completely documented in an argp's ARGS_DOC field, in which case including
115 the option in the generic usage list would be redundant. For instance,
116 if ARGS_DOC is "FOO BAR\n-x BLAH", and the `-x' option's purpose is to
117 distinguish these two cases, -x should probably be marked
119 #define OPTION_NO_USAGE 0x10
121 struct argp; /* fwd declare this type */
122 struct argp_state; /* " */
123 struct argp_child; /* " */
125 /* The type of a pointer to an argp parsing function. */
126 typedef error_t (*argp_parser_t)(int key, char *arg, struct argp_state *state);
128 /* What to return for unrecognized keys. For special ARGP_KEY_ keys, such
129 returns will simply be ignored. For user keys, this error will be turned
130 into EINVAL (if the call to argp_parse is such that errors are propagated
131 back to the user instead of exiting); returning EINVAL itself would result
132 in an immediate stop to parsing in *all* cases. */
133 #define ARGP_ERR_UNKNOWN E2BIG /* Hurd should never need E2BIG. XXX */
135 /* Special values for the KEY argument to an argument parsing function.
136 ARGP_ERR_UNKNOWN should be returned if they aren't understood.
138 The sequence of keys to a parsing function is either (where each
139 uppercased word should be prefixed by `ARGP_KEY_' and opt is a user key):
141 INIT opt... NO_ARGS END SUCCESS -- No non-option arguments at all
142 or INIT (opt | ARG)... END SUCCESS -- All non-option args parsed
143 or INIT (opt | ARG)... SUCCESS -- Some non-option arg unrecognized
145 The third case is where every parser returned ARGP_KEY_UNKNOWN for an
146 argument, in which case parsing stops at that argument (returning the
147 unparsed arguments to the caller of argp_parse if requested, or stopping
148 with an error message if not).
150 If an error occurs (either detected by argp, or because the parsing
151 function returned an error value), then the parser is called with
152 ARGP_KEY_ERROR, and no further calls are made. */
154 /* This is not an option at all, but rather a command line argument. If a
155 parser receiving this key returns success, the fact is recorded, and the
156 ARGP_KEY_NO_ARGS case won't be used. HOWEVER, if while processing the
157 argument, a parser function decrements the NEXT field of the state it's
158 passed, the option won't be considered processed; this is to allow you to
159 actually modify the argument (perhaps into an option), and have it
161 #define ARGP_KEY_ARG 0
162 /* There are no more command line arguments at all. */
163 #define ARGP_KEY_END 0x1000001
164 /* Because it's common to want to do some special processing if there aren't
165 any non-option args, user parsers are called with this key if they didn't
166 successfully process any non-option arguments. Called just before
167 ARGP_KEY_END (where more general validity checks on previously parsed
168 arguments can take place). */
169 #define ARGP_KEY_NO_ARGS 0x1000002
170 /* Passed in before any parsing is done. Afterwards, the values of each
171 element of the CHILD_INPUT field, if any, in the state structure is
172 copied to each child's state to be the initial value of the INPUT field. */
173 #define ARGP_KEY_INIT 0x1000003
174 /* Passed in when parsing has successfully been completed (even if there are
175 still arguments remaining). */
176 #define ARGP_KEY_SUCCESS 0x1000004
177 /* Passed in if an error occurs (in which case a call with ARGP_KEY_SUCCESS is
178 never made, so any cleanup must be done here). */
179 #define ARGP_KEY_ERROR 0x1000005
181 /* An argp structure contains a set of options declarations, a function to
182 deal with parsing one, documentation string, a possible vector of child
183 argp's, and perhaps a function to filter help output. When actually
184 parsing options, getopt is called with the union of all the argp
185 structures chained together through their CHILD pointers, with conflicts
186 being resolved in favor of the first occurance in the chain. */
189 /* An array of argp_option structures, terminated by an entry with both
190 NAME and KEY having a value of 0. */
191 __const struct argp_option *options;
193 /* What to do with an option from this structure. KEY is the key
194 associated with the option, and ARG is any associated argument (NULL if
195 none was supplied). If KEY isn't understood, ARGP_ERR_UNKNOWN should be
196 returned. If a non-zero, non-ARGP_ERR_UNKNOWN value is returned, then
197 parsing is stopped immediately, and that value is returned from
198 argp_parse(). For special (non-user-supplied) values of KEY, see the
199 ARGP_KEY_ definitions below. */
200 argp_parser_t parser;
202 /* A string describing what other arguments are wanted by this program. It
203 is only used by argp_usage to print the `Usage:' message. If it
204 contains newlines, the strings separated by them are considered
205 alternative usage patterns, and printed on separate lines (lines after
206 the first are prefix by ` or: ' instead of `Usage:'). */
207 __const char *args_doc;
209 /* If non-NULL, a string containing extra text to be printed before and
210 after the options in a long help message (separated by a vertical tab
214 /* A vector of argp_children structures, terminated by a member with a 0
215 argp field, pointing to child argps should be parsed with this one. Any
216 conflicts are resolved in favor of this argp, or early argps in the
217 CHILDREN list. This field is useful if you use libraries that supply
218 their own argp structure, which you want to use in conjunction with your
220 __const struct argp_child *children;
222 /* If non-zero, this should be a function to filter the output of help
223 messages. KEY is either a key from an option, in which case TEXT is
224 that option's help text, or a special key from the ARGP_KEY_HELP_
225 defines, below, describing which other help text TEXT is. The function
226 should return either TEXT, if it should be used as-is, a replacement
227 string, which should be malloced, and will be freed by argp, or NULL,
228 meaning `print nothing'. The value for TEXT is *after* any translation
229 has been done, so if any of the replacement text also needs translation,
230 that should be done by the filter function. INPUT is either the input
231 supplied to argp_parse, or NULL, if argp_help was called directly. */
232 char *(*help_filter)(int __key, __const char *__text, void *__input);
235 /* Possible KEY arguments to a help filter function. */
236 #define ARGP_KEY_HELP_PRE_DOC 0x2000001 /* Help text preceeding options. */
237 #define ARGP_KEY_HELP_POST_DOC 0x2000002 /* Help text following options. */
238 #define ARGP_KEY_HELP_HEADER 0x2000003 /* Option header string. */
239 #define ARGP_KEY_HELP_EXTRA 0x2000004 /* After all other documentation;
240 TEXT is NULL for this key. */
241 /* Explanatory note emitted when duplicate option arguments have been
243 #define ARGP_KEY_HELP_DUP_ARGS_NOTE 0x2000005
245 /* When an argp has a non-zero CHILDREN field, it should point to a vector of
246 argp_child structures, each of which describes a subsidiary argp. */
249 /* The child parser. */
250 __const struct argp *argp;
252 /* Flags for this child. */
255 /* If non-zero, an optional header to be printed in help output before the
256 child options. As a side-effect, a non-zero value forces the child
257 options to be grouped together; to achieve this effect without actually
258 printing a header string, use a value of "". */
259 __const char *header;
261 /* Where to group the child options relative to the other (`consolidated')
262 options in the parent argp; the values are the same as the GROUP field
263 in argp_option structs, but all child-groupings follow parent options at
264 a particular group level. If both this field and HEADER are zero, then
265 they aren't grouped at all, but rather merged with the parent options
266 (merging the child's grouping levels with the parents). */
270 /* Parsing state. This is provided to parsing functions called by argp,
271 which may examine and, as noted, modify fields. */
274 /* The top level ARGP being parsed. */
275 __const struct argp *argp;
277 /* The argument vector being parsed. May be modified. */
281 /* The index in ARGV of the next arg that to be parsed. May be modified. */
284 /* The flags supplied to argp_parse. May be modified. */
287 /* While calling a parsing function with a key of ARGP_KEY_ARG, this is the
288 number of the current arg, starting at zero, and incremented after each
289 such call returns. At all other times, this is the number of such
290 arguments that have been processed. */
293 /* If non-zero, the index in ARGV of the first argument following a special
294 `--' argument (which prevents anything following being interpreted as an
295 option). Only set once argument parsing has proceeded past this point. */
298 /* An arbitrary pointer passed in from the user. */
300 /* Values to pass to child parsers. This vector will be the same length as
301 the number of children for the current parser. */
304 /* For the parser's use. Initialized to 0. */
307 /* The name used when printing messages. This is initialized to ARGV[0],
308 or PROGRAM_INVOCATION_NAME if that is unavailable. */
311 /* Streams used when argp prints something. */
312 FILE *err_stream; /* For errors; initialized to stderr. */
313 FILE *out_stream; /* For information; initialized to stdout. */
315 void *pstate; /* Private, for use by argp. */
318 /* Flags for argp_parse (note that the defaults are those that are
319 convenient for program command line parsing): */
321 /* Don't ignore the first element of ARGV. Normally (and always unless
322 ARGP_NO_ERRS is set) the first element of the argument vector is
323 skipped for option parsing purposes, as it corresponds to the program name
324 in a command line. */
325 #define ARGP_PARSE_ARGV0 0x01
327 /* Don't print error messages for unknown options to stderr; unless this flag
328 is set, ARGP_PARSE_ARGV0 is ignored, as ARGV[0] is used as the program
329 name in the error messages. This flag implies ARGP_NO_EXIT (on the
330 assumption that silent exiting upon errors is bad behaviour). */
331 #define ARGP_NO_ERRS 0x02
333 /* Don't parse any non-option args. Normally non-option args are parsed by
334 calling the parse functions with a key of ARGP_KEY_ARG, and the actual arg
335 as the value. Since it's impossible to know which parse function wants to
336 handle it, each one is called in turn, until one returns 0 or an error
337 other than ARGP_ERR_UNKNOWN; if an argument is handled by no one, the
338 argp_parse returns prematurely (but with a return value of 0). If all
339 args have been parsed without error, all parsing functions are called one
340 last time with a key of ARGP_KEY_END. This flag needn't normally be set,
341 as the normal behavior is to stop parsing as soon as some argument can't
343 #define ARGP_NO_ARGS 0x04
345 /* Parse options and arguments in the same order they occur on the command
346 line -- normally they're rearranged so that all options come first. */
347 #define ARGP_IN_ORDER 0x08
349 /* Don't provide the standard long option --help, which causes usage and
350 option help information to be output to stdout, and exit (0) called. */
351 #define ARGP_NO_HELP 0x10
353 /* Don't exit on errors (they may still result in error messages). */
354 #define ARGP_NO_EXIT 0x20
356 /* Use the gnu getopt `long-only' rules for parsing arguments. */
357 #define ARGP_LONG_ONLY 0x40
359 /* Turns off any message-printing/exiting options. */
360 #define ARGP_SILENT (ARGP_NO_EXIT | ARGP_NO_ERRS | ARGP_NO_HELP)
362 /* Parse the options strings in ARGC & ARGV according to the options in ARGP.
363 FLAGS is one of the ARGP_ flags above. If ARG_INDEX is non-NULL, the
364 index in ARGV of the first unparsed option is returned in it. If an
365 unknown option is present, ARGP_ERR_UNKNOWN is returned; if some parser
366 routine returned a non-zero value, it is returned; otherwise 0 is
367 returned. This function may also call exit unless the ARGP_NO_HELP flag
368 is set. INPUT is a pointer to a value to be passed in to the parser. */
369 extern error_t argp_parse __P ((__const struct argp *__argp,
370 int __argc, char **__argv, unsigned __flags,
371 int *__arg_index, void *__input));
372 extern error_t __argp_parse __P ((__const struct argp *__argp,
373 int __argc, char **__argv, unsigned __flags,
374 int *__arg_index, void *__input));
376 /* Global variables. */
378 /* If defined or set by the user program to a non-zero value, then a default
379 option --version is added (unless the ARGP_NO_HELP flag is used), which
380 will print this string followed by a newline and exit (unless the
381 ARGP_NO_EXIT flag is used). Overridden by ARGP_PROGRAM_VERSION_HOOK. */
382 extern const char *argp_program_version;
384 /* If defined or set by the user program to a non-zero value, then a default
385 option --version is added (unless the ARGP_NO_HELP flag is used), which
386 calls this function with a stream to print the version to and a pointer to
387 the current parsing state, and then exits (unless the ARGP_NO_EXIT flag is
388 used). This variable takes precedent over ARGP_PROGRAM_VERSION. */
389 extern void (*argp_program_version_hook) __P ((FILE *__stream,
390 struct argp_state *__state));
392 /* If defined or set by the user program, it should point to string that is
393 the bug-reporting address for the program. It will be printed by
394 argp_help if the ARGP_HELP_BUG_ADDR flag is set (as it is by various
395 standard help messages), embedded in a sentence that says something like
396 `Report bugs to ADDR.'. */
397 __const extern char *argp_program_bug_address;
399 /* Flags for argp_help. */
400 #define ARGP_HELP_USAGE 0x01 /* a Usage: message. */
401 #define ARGP_HELP_SHORT_USAGE 0x02 /* " but don't actually print options. */
402 #define ARGP_HELP_SEE 0x04 /* a `Try ... for more help' message. */
403 #define ARGP_HELP_LONG 0x08 /* a long help message. */
404 #define ARGP_HELP_PRE_DOC 0x10 /* doc string preceding long help. */
405 #define ARGP_HELP_POST_DOC 0x20 /* doc string following long help. */
406 #define ARGP_HELP_DOC (ARGP_HELP_PRE_DOC | ARGP_HELP_POST_DOC)
407 #define ARGP_HELP_BUG_ADDR 0x40 /* bug report address */
408 #define ARGP_HELP_LONG_ONLY 0x80 /* modify output appropriately to
409 reflect ARGP_LONG_ONLY mode. */
411 /* These ARGP_HELP flags are only understood by argp_state_help. */
412 #define ARGP_HELP_EXIT_ERR 0x100 /* Call exit(1) instead of returning. */
413 #define ARGP_HELP_EXIT_OK 0x200 /* Call exit(0) instead of returning. */
415 /* The standard thing to do after a program command line parsing error, if an
416 error message has already been printed. */
417 #define ARGP_HELP_STD_ERR \
418 (ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR)
419 /* The standard thing to do after a program command line parsing error, if no
420 more specific error message has been printed. */
421 #define ARGP_HELP_STD_USAGE \
422 (ARGP_HELP_SHORT_USAGE | ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR)
423 /* The standard thing to do in response to a --help option. */
424 #define ARGP_HELP_STD_HELP \
425 (ARGP_HELP_SHORT_USAGE | ARGP_HELP_LONG | ARGP_HELP_EXIT_OK \
426 | ARGP_HELP_DOC | ARGP_HELP_BUG_ADDR)
428 /* Output a usage message for ARGP to STREAM. FLAGS are from the set
430 extern void argp_help __P ((__const struct argp *__argp, FILE *__stream,
431 unsigned __flags, char *__name));
432 extern void __argp_help __P ((__const struct argp *__argp, FILE *__stream,
433 unsigned __flags, char *__name));
435 /* The following routines are intended to be called from within an argp
436 parsing routine (thus taking an argp_state structure as the first
437 argument). They may or may not print an error message and exit, depending
438 on the flags in STATE -- in any case, the caller should be prepared for
439 them *not* to exit, and should return an appropiate error after calling
440 them. [argp_usage & argp_error should probably be called argp_state_...,
441 but they're used often enough that they should be short] */
443 /* Output, if appropriate, a usage message for STATE to STREAM. FLAGS are
444 from the set ARGP_HELP_*. */
445 extern void argp_state_help __P ((__const struct argp_state *__state,
446 FILE *__stream, unsigned __flags));
447 extern void __argp_state_help __P ((__const struct argp_state *__state,
448 FILE *__stream, unsigned __flags));
450 /* Possibly output the standard usage message for ARGP to stderr and exit. */
451 extern void argp_usage __P ((__const struct argp_state *__state));
452 extern void __argp_usage __P ((__const struct argp_state *__state));
454 /* If appropriate, print the printf string FMT and following args, preceded
455 by the program name and `:', to stderr, and followed by a `Try ... --help'
456 message, then exit (1). */
457 extern void argp_error __P ((__const struct argp_state *__state,
458 __const char *__fmt, ...))
459 __attribute__ ((__format__ (__printf__, 2, 3)));
460 extern void __argp_error __P ((__const struct argp_state *__state,
461 __const char *__fmt, ...))
462 __attribute__ ((__format__ (__printf__, 2, 3)));
464 /* Similar to the standard gnu error-reporting function error(), but will
465 respect the ARGP_NO_EXIT and ARGP_NO_ERRS flags in STATE, and will print
466 to STATE->err_stream. This is useful for argument parsing code that is
467 shared between program startup (when exiting is desired) and runtime
468 option parsing (when typically an error code is returned instead). The
469 difference between this function and argp_error is that the latter is for
470 *parsing errors*, and the former is for other problems that occur during
471 parsing but don't reflect a (syntactic) problem with the input. */
472 extern void argp_failure __P ((__const struct argp_state *__state,
473 int __status, int __errnum,
474 __const char *__fmt, ...))
475 __attribute__ ((__format__ (__printf__, 4, 5)));
476 extern void __argp_failure __P ((__const struct argp_state *__state,
477 int __status, int __errnum,
478 __const char *__fmt, ...))
479 __attribute__ ((__format__ (__printf__, 4, 5)));
481 /* Returns true if the option OPT is a valid short option. */
482 extern int _option_is_short __P ((__const struct argp_option *__opt));
483 extern int __option_is_short __P ((__const struct argp_option *__opt));
485 /* Returns true if the option OPT is in fact the last (unused) entry in an
487 extern int _option_is_end __P ((__const struct argp_option *__opt));
488 extern int __option_is_end __P ((__const struct argp_option *__opt));
490 /* Return the input field for ARGP in the parser corresponding to STATE; used
491 by the help routines. */
492 extern void *_argp_input __P ((__const struct argp *argp,
493 __const struct argp_state *state));
494 extern void *__argp_input __P ((__const struct argp *argp,
495 __const struct argp_state *state));
500 # define __argp_usage argp_usage
501 # define __argp_state_help argp_state_help
502 # define __option_is_short _option_is_short
503 # define __option_is_end _option_is_end
507 # define ARGP_EI extern inline
511 __argp_usage (__const struct argp_state *__state)
513 __argp_state_help (__state, stderr, ARGP_HELP_STD_USAGE);
517 __option_is_short (__const struct argp_option *__opt)
519 if (__opt->flags & OPTION_DOC)
523 int __key = __opt->key;
524 return __key > 0 && isprint (__key);
529 __option_is_end (__const struct argp_option *__opt)
531 return !__opt->key && !__opt->name && !__opt->doc && !__opt->group;
536 # undef __argp_state_help
537 # undef __option_is_short
538 # undef __option_is_end
541 #endif /* __OPTIMIZE__ */
547 #endif /* __ARGP_H__ */