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