1 /* $NetBSD: getopt_long.c,v 1.16 2003/10/27 00:12:42 lukem Exp $ */
2 /* $DragonFly: src/lib/libc/stdlib/getopt_long.c,v 1.1 2004/01/31 13:38:48 joerg Exp $ */
5 * Copyright (c) 2000 The NetBSD Foundation, Inc.
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Dieter Baron and Thomas Klausner.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the NetBSD
22 * Foundation, Inc. and its contributors.
23 * 4. Neither the name of The NetBSD Foundation nor the names of its
24 * contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 * POSSIBILITY OF SUCH DAMAGE.
40 #include <sys/cdefs.h>
49 int opterr = 1; /* if error message should be printed */
50 int optind = 1; /* index into parent argv vector */
51 int optopt = '?'; /* character checked for validity */
52 int optreset; /* reset getopt */
53 char *optarg; /* argument associated with option */
56 #define IGNORE_FIRST (*options == '-' || *options == '+')
57 #define PRINT_ERROR ((opterr) && ((*options != ':') \
58 || (IGNORE_FIRST && options[1] != ':')))
59 #define IS_POSIXLY_CORRECT (getenv("POSIXLY_CORRECT") != NULL)
60 #define PERMUTE (!IS_POSIXLY_CORRECT && !IGNORE_FIRST)
61 /* XXX: GNU ignores PC if *options == '-' */
62 #define IN_ORDER (!IS_POSIXLY_CORRECT && *options == '-')
65 #define BADCH (int)'?'
66 #define BADARG ((IGNORE_FIRST && options[1] == ':') \
67 || (*options == ':') ? (int)':' : (int)'?')
68 #define INORDER (int)1
70 static int getopt_internal(int, char * const *, const char *);
71 static int gcd(int, int);
72 static void permute_args(int, int, int, char * const *);
74 static char EMSG[] = {0};
75 static char *place = EMSG; /* option letter processing */
77 /* XXX: set optreset to 1 rather than these two */
78 static int nonopt_start = -1; /* first non option argument (for permute) */
79 static int nonopt_end = -1; /* first option after non options (for permute) */
82 static const char recargchar[] = "option requires an argument -- %c";
83 static const char recargstring[] = "option requires an argument -- %s";
84 static const char ambig[] = "ambiguous option -- %.*s";
85 static const char noarg[] = "option doesn't take an argument -- %.*s";
86 static const char illoptchar[] = "unknown option -- %c";
87 static const char illoptstring[] = "unknown option -- %s";
91 * Compute the greatest common divisor of a and b.
109 * Exchange the block from nonopt_start to nonopt_end with the block
110 * from nonopt_end to opt_end (keeping the same order of arguments
114 permute_args(int panonopt_start, int panonopt_end, int opt_end,
117 int cstart, cyclelen, i, j, ncycle, nnonopts, nopts, pos;
121 * compute lengths of blocks and number and size of cycles
123 nnonopts = panonopt_end - panonopt_start;
124 nopts = opt_end - panonopt_end;
125 ncycle = gcd(nnonopts, nopts);
126 cyclelen = (opt_end - panonopt_start) / ncycle;
128 for (i = 0; i < ncycle; i++) {
129 cstart = panonopt_end+i;
131 for (j = 0; j < cyclelen; j++) {
132 if (pos >= panonopt_end)
137 /* LINTED const cast */
138 ((char **) nargv)[pos] = nargv[cstart];
139 /* LINTED const cast */
140 ((char **)nargv)[cstart] = swap;
147 * Parse argc/argv argument vector. Called by user level routines.
148 * Returns -2 if -- is found (can be long option or end of options marker).
151 getopt_internal(int nargc, char * const *nargv, const char *options)
153 char *oli; /* option letter list index */
159 * XXX Some programs (like rsyncd) expect to be able to
160 * XXX re-initialize optind to 0 and have getopt_long(3)
161 * XXX properly function again. Work around this braindamage.
167 nonopt_start = nonopt_end = -1;
169 if (optreset || !*place) { /* update scanning pointer */
171 if (optind >= nargc) { /* end of argument vector */
173 if (nonopt_end != -1) {
174 /* do permutation, if we have to */
175 permute_args(nonopt_start, nonopt_end,
177 optind -= nonopt_end - nonopt_start;
179 else if (nonopt_start != -1) {
181 * If we skipped non-options, set optind
182 * to the first of them.
184 optind = nonopt_start;
186 nonopt_start = nonopt_end = -1;
189 if ((*(place = nargv[optind]) != '-')
190 || (place[1] == '\0')) { /* found non-option */
195 * return non-option as argument to option 1
197 optarg = nargv[optind++];
202 * if no permutation wanted, stop parsing
203 * at first non-option
208 if (nonopt_start == -1)
209 nonopt_start = optind;
210 else if (nonopt_end != -1) {
211 permute_args(nonopt_start, nonopt_end,
213 nonopt_start = optind -
214 (nonopt_end - nonopt_start);
218 /* process next argument */
221 if (nonopt_start != -1 && nonopt_end == -1)
223 if (place[1] && *++place == '-') { /* found "--" */
228 if ((optchar = (int)*place++) == (int)':' ||
229 (oli = strchr(options + (IGNORE_FIRST ? 1 : 0), optchar)) == NULL) {
230 /* option letter unknown or ':' */
234 warnx(illoptchar, optchar);
238 if (optchar == 'W' && oli[1] == ';') { /* -W long-option */
239 /* XXX: what if no long options provided (called by getopt)? */
243 if (++optind >= nargc) { /* no arg */
246 warnx(recargchar, optchar);
249 } else /* white space */
250 place = nargv[optind];
252 * Handle -W arg the same as --arg (which causes getopt to
257 if (*++oli != ':') { /* doesn't take argument */
260 } else { /* takes (optional) argument */
262 if (*place) /* no white space */
264 /* XXX: disable test for :: if PC? (GNU doesn't) */
265 else if (oli[1] != ':') { /* arg not optional */
266 if (++optind >= nargc) { /* no arg */
269 warnx(recargchar, optchar);
273 optarg = nargv[optind];
278 /* dump back option letter */
282 #ifdef REPLACE_GETOPT
285 * Parse argc/argv argument vector.
287 * [eventually this will replace the real getopt]
290 getopt(int nargc, char * const *nargv, const char *options)
294 if ((retval = getopt_internal(nargc, nargv, options)) == -2) {
297 * We found an option (--), so if we skipped non-options,
298 * we have to permute.
300 if (nonopt_end != -1) {
301 permute_args(nonopt_start, nonopt_end, optind,
303 optind -= nonopt_end - nonopt_start;
305 nonopt_start = nonopt_end = -1;
314 * Parse argc/argv argument vector.
317 getopt_long(int nargc, char * const *nargv, const char *options,
318 const struct option *long_options, int *idx)
322 /* idx may be NULL */
324 if ((retval = getopt_internal(nargc, nargv, options)) == -2) {
325 char *current_argv, *has_equal;
326 size_t current_argv_len;
329 current_argv = place;
335 if (*current_argv == '\0') { /* found "--" */
337 * We found an option (--), so if we skipped
338 * non-options, we have to permute.
340 if (nonopt_end != -1) {
341 permute_args(nonopt_start, nonopt_end,
343 optind -= nonopt_end - nonopt_start;
345 nonopt_start = nonopt_end = -1;
348 if ((has_equal = strchr(current_argv, '=')) != NULL) {
349 /* argument found (--option=arg) */
350 current_argv_len = has_equal - current_argv;
353 current_argv_len = strlen(current_argv);
355 for (i = 0; long_options[i].name; i++) {
356 /* find matching long option */
357 if (strncmp(current_argv, long_options[i].name,
361 if (strlen(long_options[i].name) ==
362 (unsigned)current_argv_len) {
367 if (match == -1) /* partial match */
370 /* ambiguous abbreviation */
372 warnx(ambig, (int)current_argv_len,
378 if (match != -1) { /* option found */
379 if (long_options[match].has_arg == no_argument
382 warnx(noarg, (int)current_argv_len,
385 * XXX: GNU sets optopt to val regardless of
388 if (long_options[match].flag == NULL)
389 optopt = long_options[match].val;
394 if (long_options[match].has_arg == required_argument ||
395 long_options[match].has_arg == optional_argument) {
398 else if (long_options[match].has_arg ==
401 * optional argument doesn't use
404 optarg = nargv[optind++];
407 if ((long_options[match].has_arg == required_argument)
408 && (optarg == NULL)) {
410 * Missing argument; leading ':'
411 * indicates no error should be generated
414 warnx(recargstring, current_argv);
416 * XXX: GNU sets optopt to val regardless
419 if (long_options[match].flag == NULL)
420 optopt = long_options[match].val;
426 } else { /* unknown option */
428 warnx(illoptstring, current_argv);
432 if (long_options[match].flag) {
433 *long_options[match].flag = long_options[match].val;
436 retval = long_options[match].val;