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

Return to:

Send suggestions and report system problems to the System administrator.