]> sourceware.org Git - glibc.git/blob - argp/argp.h
update from main archive 970218
[glibc.git] / argp / argp.h
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>.
5
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.
10
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.
15
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. */
20
21 #ifndef __ARGP_H__
22 #define __ARGP_H__
23
24 #include <stdio.h>
25 #include <ctype.h>
26 #include <getopt.h>
27
28 #define __need_error_t
29 #include <errno.h>
30
31 #ifndef __const
32 #define __const const
33 #endif
34
35 #ifndef __error_t_defined
36 typedef int error_t;
37 #endif
38
39 #ifndef __P
40 # if (defined (__STDC__) && __STDC__) || defined (__cplusplus)
41 # define __P(args) args
42 # else
43 # define __P(args) ()
44 # endif
45 #endif
46 \f
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50
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. */
56 struct argp_option
57 {
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. */
60 __const char *name;
61
62 /* What key is returned for this option. If > 0 and printable, then it's
63 also accepted as a short option. */
64 int key;
65
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. */
68 __const char *arg;
69
70 /* OPTION_ flags. */
71 int flags;
72
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 `:'. */
77 __const char *doc;
78
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. */
86 int group;
87 };
88
89 /* The argument associated with this option is optional. */
90 #define OPTION_ARG_OPTIONAL 0x1
91
92 /* This option isn't displayed in any help messages. */
93 #define OPTION_HIDDEN 0x2
94
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
99
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
111 \f
112 struct argp; /* fwd declare this type */
113 struct argp_state; /* " */
114 struct argp_child; /* " */
115
116 /* The type of a pointer to an argp parsing function. */
117 typedef error_t (*argp_parser_t)(int key, char *arg, struct argp_state *state);
118
119 /* What to return for unrecognized keys. For special ARGP_KEY_ keys, such
120 returns will simply be ignored. For user keys, this error will be turned
121 into EINVAL (if the call to argp_parse is such that errors are propagated
122 back to the user instead of exiting); returning EINVAL itself would result
123 in an immediate stop to parsing in *all* cases. */
124 #define ARGP_ERR_UNKNOWN E2BIG /* Hurd should never need E2BIG. XXX */
125
126 /* Special values for the KEY argument to an argument parsing function.
127 ARGP_ERR_UNKNOWN should be returned if they aren't understood.
128
129 The sequence of keys to parser calls is either (where opt is a user key):
130 ARGP_KEY_INIT (opt | ARGP_KEY_ARG)... ARGP_KEY_END
131 or ARGP_KEY_INIT opt... ARGP_KEY_NO_ARGS ARGP_KEY_END
132
133 If an error occurs, then the parser is called with ARGP_KEY_ERR, and no
134 other calls are made. */
135
136 /* This is not an option at all, but rather a command line argument. If a
137 parser receiving this key returns success, the fact is recorded, and the
138 ARGP_KEY_NO_ARGS case won't be used. HOWEVER, if while processing the
139 argument, a parser function decrements the NEXT field of the state it's
140 passed, the option won't be considered processed; this is to allow you to
141 actually modify the argument (perhaps into an option), and have it
142 processed again. */
143 #define ARGP_KEY_ARG 0
144 /* There are no more command line arguments at all. */
145 #define ARGP_KEY_END 0x1000001
146 /* Because it's common to want to do some special processing if there aren't
147 any non-option args, user parsers are called with this key if they didn't
148 successfully process any non-option arguments. Called just before
149 ARGP_KEY_END (where more general validity checks on previously parsed
150 arguments can take place). */
151 #define ARGP_KEY_NO_ARGS 0x1000002
152 /* Passed in before any parsing is done. Afterwards, the values of each
153 element of the CHILD_INPUT field, if any, in the state structure is
154 copied to each child's state to be the initial value of the INPUT field. */
155 #define ARGP_KEY_INIT 0x1000003
156 /* Passed in when parsing has successfully been completed (even if there are
157 still arguments remaining). */
158 #define ARGP_KEY_SUCCESS 0x1000004
159 /* Passed in if an error occurs (in which case a call with ARGP_KEY_SUCCESS is
160 never made, so any cleanup must be done here). */
161 #define ARGP_KEY_ERROR 0x1000005
162
163 /* An argp structure contains a set of getopt options declarations, a
164 function to deal with getting one, and an optional pointer to another
165 argp structure. When actually parsing options, getopt is called with
166 the union of all the argp structures chained together through their
167 CHILD pointers, with conflicts being resolved in favor of the first
168 occurance in the chain. */
169 struct argp
170 {
171 /* An array of argp_option structures, terminated by an entry with both
172 NAME and KEY having a value of 0. */
173 __const struct argp_option *options;
174
175 /* What to do with an option from this structure. KEY is the key
176 associated with the option, and ARG is any associated argument (NULL if
177 none was supplied). If KEY isn't understood, ARGP_ERR_UNKNOWN should be
178 returned. If a non-zero, non-ARGP_ERR_UNKNOWN value is returned, then
179 parsing is stopped immediately, and that value is returned from
180 argp_parse(). For special (non-user-supplied) values of KEY, see the
181 ARGP_KEY_ definitions below. */
182 argp_parser_t parser;
183
184 /* A string describing what other arguments are wanted by this program. It
185 is only used by argp_usage to print the `Usage:' message. If it
186 contains newlines, the strings separated by them are considered
187 alternative usage patterns, and printed on separate lines (lines after
188 the first are prefix by ` or: ' instead of `Usage:'). */
189 __const char *args_doc;
190
191 /* If non-NULL, a string containing extra text to be printed before and
192 after the options in a long help message (separated by a vertical tab
193 `\v' character). */
194 __const char *doc;
195
196 /* A vector of argp_children structures, terminated by a member with a 0
197 argp field, pointing to child argps should be parsed with this one. Any
198 conflicts are resolved in favor of this argp, or early argps in the
199 CHILDREN list. This field is useful if you use libraries that supply
200 their own argp structure, which you want to use in conjunction with your
201 own. */
202 __const struct argp_child *children;
203
204 /* If non-zero, this should be a function to filter the output of help
205 messages. KEY is either a key from an option, in which case TEXT is
206 that option's help text, or a special key from the ARGP_KEY_HELP_
207 defines, below, describing which other help text TEXT is. The function
208 should return either TEXT, if it should be used as-is, a replacement
209 string, which should be malloced, and will be freed by argp, or NULL,
210 meaning `print nothing'. The value for TEXT is *after* any translation
211 has been done, so if any of the replacement text also needs translation,
212 that should be done by the filter function. INPUT is either the input
213 supplied to argp_parse, or NULL, if argp_help was called directly. */
214 char *(*help_filter)(int __key, __const char *__text, void *__input);
215 };
216
217 /* Possible KEY arguments to a help filter function. */
218 #define ARGP_KEY_HELP_PRE_DOC 0x2000001 /* Help text preceeding options. */
219 #define ARGP_KEY_HELP_POST_DOC 0x2000002 /* Help text following options. */
220 #define ARGP_KEY_HELP_HEADER 0x2000003 /* Option header string. */
221 #define ARGP_KEY_HELP_EXTRA 0x2000004 /* After all other documentation;
222 TEXT is NULL for this key. */
223 \f
224 /* When an argp has a non-zero CHILDREN field, it should point to a vector of
225 argp_child structures, each of which describes a subsidiary argp. */
226 struct argp_child
227 {
228 /* The child parser. */
229 __const struct argp *argp;
230
231 /* Flags for this child. */
232 int flags;
233
234 /* If non-zero, an optional header to be printed in help output before the
235 child options. As a side-effect, a non-zero value forces the child
236 options to be grouped together; to achieve this effect without actually
237 printing a header string, use a value of "". */
238 __const char *header;
239
240 /* Where to group the child options relative to the other (`consolidated')
241 options in the parent argp; the values are the same as the GROUP field
242 in argp_option structs, but all child-groupings follow parent options at
243 a particular group level. If both this field and HEADER are zero, then
244 they aren't grouped at all, but rather merged with the parent options
245 (merging the child's grouping levels with the parents). */
246 int group;
247 };
248 \f
249 /* Parsing state. This is provided to parsing functions called by argp,
250 which may examine and, as noted, modify fields. */
251 struct argp_state
252 {
253 /* The top level ARGP being parsed. */
254 __const struct argp *argp;
255
256 /* The argument vector being parsed. May be modified. */
257 int argc;
258 char **argv;
259
260 /* The index in ARGV of the next arg that to be parsed. May be modified. */
261 int next;
262
263 /* The flags supplied to argp_parse. May be modified. */
264 unsigned flags;
265
266 /* While calling a parsing function with a key of ARGP_KEY_ARG, this is the
267 number of the current arg, starting at zero, and incremented after each
268 such call returns. At all other times, this is the number of such
269 arguments that have been processed. */
270 unsigned arg_num;
271
272 /* If non-zero, the index in ARGV of the first argument following a special
273 `--' argument (which prevents anything following being interpreted as an
274 option). Only set once argument parsing has proceeded past this point. */
275 int quoted;
276
277 /* An arbitrary pointer passed in from the user. */
278 void *input;
279 /* Values to pass to child parsers. This vector will be the same length as
280 the number of children for the current parser. */
281 void **child_inputs;
282
283 /* For the parser's use. Initialized to 0. */
284 void *hook;
285
286 /* The name used when printing messages. This is initialized to ARGV[0],
287 or PROGRAM_INVOCATION_NAME if that is unavailable. */
288 char *name;
289
290 /* Streams used when argp prints something. */
291 FILE *err_stream; /* For errors; initialized to stderr. */
292 FILE *out_stream; /* For information; initialized to stdout. */
293
294 void *pstate; /* Private, for use by argp. */
295 };
296 \f
297 /* Flags for argp_parse (note that the defaults are those that are
298 convenient for program command line parsing): */
299
300 /* Don't ignore the first element of ARGV. Normally (and always unless
301 ARGP_NO_ERRS is set) the first element of the argument vector is
302 skipped for option parsing purposes, as it corresponds to the program name
303 in a command line. */
304 #define ARGP_PARSE_ARGV0 0x01
305
306 /* Don't print error messages for unknown options to stderr; unless this flag
307 is set, ARGP_PARSE_ARGV0 is ignored, as ARGV[0] is used as the program
308 name in the error messages. This flag implies ARGP_NO_EXIT (on the
309 assumption that silent exiting upon errors is bad behaviour). */
310 #define ARGP_NO_ERRS 0x02
311
312 /* Don't parse any non-option args. Normally non-option args are parsed by
313 calling the parse functions with a key of ARGP_KEY_ARG, and the actual arg
314 as the value. Since it's impossible to know which parse function wants to
315 handle it, each one is called in turn, until one returns 0 or an error
316 other than ARGP_ERR_UNKNOWN; if an argument is handled by no one, the
317 argp_parse returns prematurely (but with a return value of 0). If all
318 args have been parsed without error, all parsing functions are called one
319 last time with a key of ARGP_KEY_END. This flag needn't normally be set,
320 as the normal behavior is to stop parsing as soon as some argument can't
321 be handled. */
322 #define ARGP_NO_ARGS 0x04
323
324 /* Parse options and arguments in the same order they occur on the command
325 line -- normally they're rearranged so that all options come first. */
326 #define ARGP_IN_ORDER 0x08
327
328 /* Don't provide the standard long option --help, which causes usage and
329 option help information to be output to stdout, and exit (0) called. */
330 #define ARGP_NO_HELP 0x10
331
332 /* Don't exit on errors (they may still result in error messages). */
333 #define ARGP_NO_EXIT 0x20
334
335 /* Use the gnu getopt `long-only' rules for parsing arguments. */
336 #define ARGP_LONG_ONLY 0x40
337
338 /* Turns off any message-printing/exiting options. */
339 #define ARGP_SILENT (ARGP_NO_EXIT | ARGP_NO_ERRS | ARGP_NO_HELP)
340
341 /* Parse the options strings in ARGC & ARGV according to the options in ARGP.
342 FLAGS is one of the ARGP_ flags above. If ARG_INDEX is non-NULL, the
343 index in ARGV of the first unparsed option is returned in it. If an
344 unknown option is present, ARGP_ERR_UNKNOWN is returned; if some parser
345 routine returned a non-zero value, it is returned; otherwise 0 is
346 returned. This function may also call exit unless the ARGP_NO_HELP flag
347 is set. INPUT is a pointer to a value to be passed in to the parser. */
348 extern error_t argp_parse __P ((__const struct argp *__argp,
349 int __argc, char **__argv, unsigned __flags,
350 int *__arg_index, void *__input));
351 extern error_t __argp_parse __P ((__const struct argp *__argp,
352 int __argc, char **__argv, unsigned __flags,
353 int *__arg_index, void *__input));
354 \f
355 /* Global variables. */
356
357 /* If defined or set by the user program to a non-zero value, then a default
358 option --version is added (unless the ARGP_NO_HELP flag is used), which
359 will print this string followed by a newline and exit (unless the
360 ARGP_NO_EXIT flag is used). Overridden by ARGP_PROGRAM_VERSION_HOOK. */
361 extern const char *argp_program_version;
362
363 /* If defined or set by the user program to a non-zero value, then a default
364 option --version is added (unless the ARGP_NO_HELP flag is used), which
365 calls this function with a stream to print the version to and a pointer to
366 the current parsing state, and then exits (unless the ARGP_NO_EXIT flag is
367 used). This variable takes precedent over ARGP_PROGRAM_VERSION. */
368 extern void (*argp_program_version_hook) __P ((FILE *__stream,
369 struct argp_state *__state));
370
371 /* If defined or set by the user program, it should point to string that is
372 the bug-reporting address for the program. It will be printed by
373 argp_help if the ARGP_HELP_BUG_ADDR flag is set (as it is by various
374 standard help messages), embedded in a sentence that says something like
375 `Report bugs to ADDR.'. */
376 extern char *argp_program_bug_address;
377 \f
378 /* Flags for argp_help. */
379 #define ARGP_HELP_USAGE 0x01 /* a Usage: message. */
380 #define ARGP_HELP_SHORT_USAGE 0x02 /* " but don't actually print options. */
381 #define ARGP_HELP_SEE 0x04 /* a `Try ... for more help' message. */
382 #define ARGP_HELP_LONG 0x08 /* a long help message. */
383 #define ARGP_HELP_PRE_DOC 0x10 /* doc string preceding long help. */
384 #define ARGP_HELP_POST_DOC 0x20 /* doc string following long help. */
385 #define ARGP_HELP_DOC (ARGP_HELP_PRE_DOC | ARGP_HELP_POST_DOC)
386 #define ARGP_HELP_BUG_ADDR 0x40 /* bug report address */
387 #define ARGP_HELP_LONG_ONLY 0x80 /* modify output appropriately to
388 reflect ARGP_LONG_ONLY mode. */
389
390 /* These ARGP_HELP flags are only understood by argp_state_help. */
391 #define ARGP_HELP_EXIT_ERR 0x100 /* Call exit(1) instead of returning. */
392 #define ARGP_HELP_EXIT_OK 0x200 /* Call exit(0) instead of returning. */
393
394 /* The standard thing to do after a program command line parsing error, if an
395 error message has already been printed. */
396 #define ARGP_HELP_STD_ERR \
397 (ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR)
398 /* The standard thing to do after a program command line parsing error, if no
399 more specific error message has been printed. */
400 #define ARGP_HELP_STD_USAGE \
401 (ARGP_HELP_SHORT_USAGE | ARGP_HELP_SEE | ARGP_HELP_EXIT_ERR)
402 /* The standard thing to do in response to a --help option. */
403 #define ARGP_HELP_STD_HELP \
404 (ARGP_HELP_SHORT_USAGE | ARGP_HELP_LONG | ARGP_HELP_EXIT_OK \
405 | ARGP_HELP_DOC | ARGP_HELP_BUG_ADDR)
406
407 /* Output a usage message for ARGP to STREAM. FLAGS are from the set
408 ARGP_HELP_*. */
409 extern void argp_help __P ((__const struct argp *__argp, FILE *__stream,
410 unsigned __flags, char *__name));
411 extern void __argp_help __P ((__const struct argp *__argp, FILE *__stream,
412 unsigned __flags, char *__name));
413 \f
414 /* The following routines are intended to be called from within an argp
415 parsing routine (thus taking an argp_state structure as the first
416 argument). They may or may not print an error message and exit, depending
417 on the flags in STATE -- in any case, the caller should be prepared for
418 them *not* to exit, and should return an appropiate error after calling
419 them. [argp_usage & argp_error should probably be called argp_state_...,
420 but they're used often enough that they should be short] */
421
422 /* Output, if appropriate, a usage message for STATE to STREAM. FLAGS are
423 from the set ARGP_HELP_*. */
424 extern void argp_state_help __P ((struct argp_state *__state, FILE *__stream,
425 unsigned __flags));
426 extern void __argp_state_help __P ((struct argp_state *__state, FILE *__stream,
427 unsigned __flags));
428
429 /* Possibly output the standard usage message for ARGP to stderr and exit. */
430 extern void argp_usage __P ((struct argp_state *__state));
431 extern void __argp_usage __P ((struct argp_state *__state));
432
433 /* If appropriate, print the printf string FMT and following args, preceded
434 by the program name and `:', to stderr, and followed by a `Try ... --help'
435 message, then exit (1). */
436 extern void argp_error __P ((struct argp_state *__state, __const char *__fmt,
437 ...))
438 __attribute__ ((__format__ (__printf__, 2, 3)));
439 extern void __argp_error __P ((struct argp_state *__state,
440 __const char *__fmt, ...))
441 __attribute__ ((__format__ (__printf__, 2, 3)));
442
443 /* Similar to the standard gnu error-reporting function error(), but will
444 respect the ARGP_NO_EXIT and ARGP_NO_ERRS flags in STATE, and will print
445 to STATE->err_stream. This is useful for argument parsing code that is
446 shared between program startup (when exiting is desired) and runtime
447 option parsing (when typically an error code is returned instead). The
448 difference between this function and argp_error is that the latter is for
449 *parsing errors*, and the former is for other problems that occur during
450 parsing but don't reflect a (syntactic) problem with the input. */
451 extern void argp_failure __P ((struct argp_state *__state, int __status,
452 int __errnum, __const char *__fmt, ...))
453 __attribute__ ((__format__ (__printf__, 4, 5)));
454 extern void __argp_failure __P ((struct argp_state *__state, int __status,
455 int __errnum, __const char *__fmt, ...))
456 __attribute__ ((__format__ (__printf__, 4, 5)));
457
458 /* Returns true if the option OPT is a valid short option. */
459 extern int _option_is_short __P ((__const struct argp_option *__opt));
460 extern int __option_is_short __P ((__const struct argp_option *__opt));
461
462 /* Returns true if the option OPT is in fact the last (unused) entry in an
463 options array. */
464 extern int _option_is_end __P ((__const struct argp_option *__opt));
465 extern int __option_is_end __P ((__const struct argp_option *__opt));
466
467 /* Return the input field for ARGP in the parser corresponding to STATE; used
468 by the help routines. */
469 extern void *_argp_input __P ((__const struct argp *argp,
470 __const struct argp_state *state));
471 extern void *__argp_input __P ((__const struct argp *argp,
472 __const struct argp_state *state));
473 \f
474 #ifdef __OPTIMIZE__
475
476 #if !_LIBC
477 # define __argp_usage argp_usage
478 # define __argp_state_help argp_state_help
479 # define __option_is_short _option_is_short
480 # define __option_is_end _option_is_end
481 #endif
482
483 #ifndef ARGP_EI
484 # define ARGP_EI extern inline
485 #endif
486
487 ARGP_EI void
488 __argp_usage (struct argp_state *__state)
489 {
490 __argp_state_help (__state, stderr, ARGP_HELP_STD_USAGE);
491 }
492
493 ARGP_EI int
494 __option_is_short (__const struct argp_option *__opt)
495 {
496 if (__opt->flags & OPTION_DOC)
497 return 0;
498 else
499 {
500 int __key = __opt->key;
501 return __key > 0 && isprint (__key);
502 }
503 }
504
505 ARGP_EI int
506 __option_is_end (__const struct argp_option *__opt)
507 {
508 return !__opt->key && !__opt->name && !__opt->doc && !__opt->group;
509 }
510
511 #if !_LIBC
512 # undef __argp_usage
513 # undef __argp_state_help
514 # undef __option_is_short
515 # undef __option_is_end
516 #endif
517
518 #endif /* __OPTIMIZE__ */
519
520 #ifdef __cplusplus
521 }
522 #endif
523
524 #endif /* __ARGP_H__ */
This page took 0.797228 seconds and 5 git commands to generate.