summaryrefslogtreecommitdiff
path: root/lib/argp.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/argp.h')
-rw-r--r--lib/argp.h562
1 files changed, 0 insertions, 562 deletions
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,