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