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