OpenCores
URL https://opencores.org/ocsvn/openrisc_me/openrisc_me/trunk

Subversion Repositories openrisc_me

[/] [openrisc/] [trunk/] [gnu-src/] [newlib-1.18.0/] [newlib/] [libc/] [sys/] [linux/] [include/] [argp.h] - Blame information for rev 207

Details | Compare with Previous | View Log

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

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.