1 /*****************************************************************************
3 *****************************************************************************
4 * Copyright (C) 1987-1997 Free Software Foundation, Inc.
5 * Copyright (C) 2005-2010 the VideoLAN team
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU Lesser General Public License as published by
9 * the Free Software Foundation; either version 2.1 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public License
18 * along with this program; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
20 *****************************************************************************/
25 #include <vlc_common.h>
30 /* This version of `getopt' appears to the caller like standard Unix `getopt'
31 but it behaves differently for the user, since it allows the user
32 to intersperse the options with the other arguments.
34 As `getopt' works, it permutes the elements of ARGV so that,
35 when it is done, all the options precede everything else. Thus
36 all application programs are extended to handle flexible argument order.
38 Setting the environment variable POSIXLY_CORRECT disables permutation.
39 Then the behavior is completely standard.
41 GNU application programs can use a third alternative mode in which
42 they can distinguish the relative order of options and other arguments. */
44 #include "vlc_getopt.h"
46 /* For communication from `getopt' to the caller.
47 When `getopt' finds an option that takes an argument,
48 the argument value is returned here.
49 Also, when `ordering' is RETURN_IN_ORDER,
50 each non-option ARGV-element is returned here. */
54 /* Index in ARGV of the next element to be scanned.
55 This is used for communication to and from the caller
56 and for communication between successive calls to `getopt'.
58 On entry to `getopt', zero means this is the first call; initialize.
60 When `getopt' returns -1, this is the index of the first of the
61 non-option elements that the caller should itself scan.
63 Otherwise, `optind' communicates from one call to the next
64 how much of ARGV has been scanned so far. */
66 /* 1003.2 says this must be 1 before any call. */
69 /* Formerly, initialization of getopt depended on optind==0, which
70 causes problems with re-calling getopt as programs generally don't
73 int __getopt_initialized = 0;
75 /* The next char to be scanned in the option-element
76 in which the last option character we returned was found.
77 This allows us to pick up the scan where we left off.
79 If this is zero, or a null string, it means resume the scan
80 by advancing to the next ARGV-element. */
82 static char *nextchar;
84 /* Callers store zero here to inhibit the error message
85 for unrecognized options. */
89 /* Set to an option character which was unrecognized.
90 This must be initialized on some systems to avoid linking in the
91 system's own getopt implementation. */
95 /* Describe how to deal with options that follow non-option ARGV-elements.
97 If the caller did not specify anything,
98 the default is REQUIRE_ORDER if the environment variable
99 POSIXLY_CORRECT is defined, PERMUTE otherwise.
101 REQUIRE_ORDER means don't recognize them as options;
102 stop option processing when the first non-option is seen.
103 This is what Unix does.
104 This mode of operation is selected by either setting the environment
105 variable POSIXLY_CORRECT, or using `+' as the first character
106 of the list of option characters.
108 PERMUTE is the default. We permute the contents of ARGV as we scan,
109 so that eventually all the non-options are at the end. This allows options
110 to be given in any order, even with programs that were not written to
113 RETURN_IN_ORDER is an option available to programs that were written
114 to expect options and other ARGV-elements in any order and that care about
115 the ordering of the two. We describe each non-option ARGV-element
116 as if it were the argument of an option with character code 1.
117 Using `-' as the first character of the list of option characters
118 selects this mode of operation.
120 The special argument `--' forces an end of option-scanning regardless
121 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
122 `--' can cause `getopt' to return -1 with `optind' != ARGC. */
126 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
130 /* Value of POSIXLY_CORRECT environment variable. */
131 static char *posixly_correct;
133 /* Handle permutation of arguments. */
135 /* Describe the part of ARGV that contains non-options that have
136 been skipped. `first_nonopt' is the index in ARGV of the first of them;
137 `last_nonopt' is the index after the last of them. */
139 static int first_nonopt;
140 static int last_nonopt;
142 /* Exchange two adjacent subsequences of ARGV.
143 One subsequence is elements [first_nonopt,last_nonopt)
144 which contains all the non-options that have been skipped so far.
145 The other is elements [last_nonopt,optind), which contains all
146 the options processed since those non-options were skipped.
148 `first_nonopt' and `last_nonopt' are relocated so that they describe
149 the new indices of the non-options in ARGV after they are moved. */
151 static void exchange(char **);
157 int bottom = first_nonopt;
158 int middle = last_nonopt;
162 /* Exchange the shorter segment with the far end of the longer segment.
163 That puts the shorter segment into the right place.
164 It leaves the longer segment in the right place overall,
165 but it consists of two parts that need to be swapped next. */
167 while (top > middle && middle > bottom)
169 if (top - middle > middle - bottom)
171 /* Bottom segment is the short one. */
172 int len = middle - bottom;
175 /* Swap it with the top part of the top segment. */
176 for (i = 0; i < len; i++)
178 tem = argv[bottom + i];
179 argv[bottom + i] = argv[top - (middle - bottom) + i];
180 argv[top - (middle - bottom) + i] = tem;
182 /* Exclude the moved bottom segment from further swapping. */
187 /* Top segment is the short one. */
188 int len = top - middle;
191 /* Swap it with the bottom part of the bottom segment. */
192 for (i = 0; i < len; i++)
194 tem = argv[bottom + i];
195 argv[bottom + i] = argv[middle + i];
196 argv[middle + i] = tem;
198 /* Exclude the moved top segment from further swapping. */
203 /* Update records for the slots the non-options now occupy. */
205 first_nonopt += (optind - last_nonopt);
206 last_nonopt = optind;
209 /* Initialize the internal data when the first call is made. */
211 static const char *_getopt_initialize(int, char *const *, const char *);
214 _getopt_initialize(argc, argv, optstring)
217 const char *optstring;
221 /* Start processing options with ARGV-element 1 (since ARGV-element 0
222 is the program name); the sequence of previously skipped
223 non-option ARGV-elements is empty. */
225 first_nonopt = last_nonopt = optind = 1;
229 posixly_correct = getenv("POSIXLY_CORRECT");
231 /* Determine how to handle the ordering of options and nonoptions. */
233 if (optstring[0] == '-')
235 ordering = RETURN_IN_ORDER;
238 else if (optstring[0] == '+')
240 ordering = REQUIRE_ORDER;
243 else if (posixly_correct != NULL)
244 ordering = REQUIRE_ORDER;
251 /* Scan elements of ARGV (whose length is ARGC) for option characters
254 If an element of ARGV starts with '-', and is not exactly "-" or "--",
255 then it is an option element. The characters of this element
256 (aside from the initial '-') are option characters. If `getopt'
257 is called repeatedly, it returns successively each of the option characters
258 from each of the option elements.
260 If `getopt' finds another option character, it returns that character,
261 updating `optind' and `nextchar' so that the next call to `getopt' can
262 resume the scan with the following option character or ARGV-element.
264 If there are no more option characters, `getopt' returns -1.
265 Then `optind' is the index in ARGV of the first ARGV-element
266 that is not an option. (The ARGV-elements have been permuted
267 so that those that are not options now come last.)
269 OPTSTRING is a string containing the legitimate option characters.
270 If an option character is seen that is not listed in OPTSTRING,
271 return '?' after printing an error message. If you set `opterr' to
272 zero, the error message is suppressed but we still return '?'.
274 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
275 so the following text in the same ARGV-element, or the text of the following
276 ARGV-element, is returned in `optarg'. Two colons mean an option that
277 wants an optional arg; if there is text in the current ARGV-element,
278 it is returned in `optarg', otherwise `optarg' is set to zero.
280 If OPTSTRING starts with `-' or `+', it requests different methods of
281 handling the non-option ARGV-elements.
282 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
284 Long-named options begin with `--' instead of `-'.
285 Their names may be abbreviated as long as the abbreviation is unique
286 or is an exact match for some defined option. If they have an
287 argument, it follows the option name in the same ARGV-element, separated
288 from the option name by a `=', or else the in next ARGV-element.
289 When `getopt' finds a long-named option, it returns 0 if that option's
290 `flag' field is nonzero, the value of the option's `val' field
291 if the `flag' field is zero.
293 The elements of ARGV aren't really const, because we permute them.
294 But we pretend they're const in the prototype to be compatible
297 LONGOPTS is a vector of `struct option' terminated by an
298 element containing a name which is zero.
300 LONGIND returns the index in LONGOPT of the long-named option found.
301 It is only valid when a long-named option has been found by the most
305 vlc_getopt_long(argc, argv, optstring, longopts, longind)
308 const char *optstring;
309 const struct option *longopts;
314 if (!__getopt_initialized || optind == 0)
316 optstring = _getopt_initialize(argc, argv, optstring);
317 optind = 1; /* Don't scan ARGV[0], the program name. */
318 __getopt_initialized = 1;
321 #define NONOPTION_P (argv[optind][0] != '-' || argv[optind][1] == '\0')
323 if (nextchar == NULL || *nextchar == '\0')
325 /* Advance to the next ARGV-element. */
327 /* Give FIRST_NONOPT & LAST_NONOPT rational values if OPTIND has been
328 moved back by the user (who may also have changed the arguments). */
329 if (last_nonopt > optind)
330 last_nonopt = optind;
331 if (first_nonopt > optind)
332 first_nonopt = optind;
334 if (ordering == PERMUTE)
336 /* If we have just processed some options following some non-options,
337 exchange them so that the options come first. */
339 if (first_nonopt != last_nonopt && last_nonopt != optind)
340 exchange((char **) argv);
341 else if (last_nonopt != optind)
342 first_nonopt = optind;
344 /* Skip any additional non-options
345 and extend the range of non-options previously skipped. */
347 while (optind < argc && NONOPTION_P)
349 last_nonopt = optind;
352 /* The special ARGV-element `--' means premature end of options.
353 Skip it like a null option,
354 then exchange with previous non-options as if it were an option,
355 then skip everything else like a non-option. */
357 if (optind != argc && !strcmp(argv[optind], "--"))
361 if (first_nonopt != last_nonopt && last_nonopt != optind)
362 exchange((char **) argv);
363 else if (first_nonopt == last_nonopt)
364 first_nonopt = optind;
370 /* If we have done all the ARGV-elements, stop the scan
371 and back over any non-options that we skipped and permuted. */
375 /* Set the next-arg-index to point at the non-options
376 that we previously skipped, so the caller will digest them. */
377 if (first_nonopt != last_nonopt)
378 optind = first_nonopt;
382 /* If we have come to a non-option and did not permute it,
383 either stop the scan or describe it to the caller and pass it by. */
387 if (ordering == REQUIRE_ORDER)
389 optarg = argv[optind++];
393 /* We have found another option-ARGV-element.
394 Skip the initial punctuation. */
396 nextchar = (argv[optind] + 1
397 + (argv[optind][1] == '-'));
400 /* Decode the current option-ARGV-element. */
402 /* Check whether the ARGV-element is a long option. */
404 if (argv[optind][1] == '-')
407 const struct option *p;
408 const struct option *pfound = NULL;
414 for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
417 /* Test all long options for either exact match
418 or abbreviated matches. */
419 for (p = longopts, option_index = 0; p->name; p++, option_index++)
420 if (!strncmp(p->name, nextchar, nameend - nextchar))
422 if ((unsigned int) (nameend - nextchar)
423 == (unsigned int) strlen(p->name))
425 /* Exact match found. */
427 indfound = option_index;
431 else if (pfound == NULL)
433 /* First nonexact match found. */
435 indfound = option_index;
438 /* Second or later nonexact match found. */
445 fprintf(stderr, _("%s: option `%s' is ambiguous\n"),
446 argv[0], argv[optind]);
447 nextchar += strlen(nextchar);
455 option_index = indfound;
459 /* Don't test has_arg with >, because some C compilers don't
460 allow it to be used on enums. */
462 optarg = nameend + 1;
467 if (argv[optind - 1][1] == '-')
470 _("%s: option `--%s' doesn't allow an argument\n"),
471 argv[0], pfound->name);
473 /* +option or -option */
475 _("%s: option `%c%s' doesn't allow an argument\n"),
476 argv[0], argv[optind - 1][0], pfound->name);
479 nextchar += strlen(nextchar);
481 optopt = pfound->val;
485 else if (pfound->has_arg == 1)
488 optarg = argv[optind++];
493 _("%s: option `%s' requires an argument\n"),
494 argv[0], argv[optind - 1]);
495 nextchar += strlen(nextchar);
496 optopt = pfound->val;
497 return optstring[0] == ':' ? ':' : '?';
500 nextchar += strlen(nextchar);
502 *longind = option_index;
505 *(pfound->flag) = pfound->val;
511 /* Can't find it as a long option. It's an error. */
514 if (argv[optind][1] == '-')
516 fprintf(stderr, _("%s: unrecognized option `%s%s'\n"),
517 "--", argv[0], nextchar);
520 char t[2] = { argv[optind][0], '\0' };
521 /* +option or -option */
522 fprintf(stderr, _("%s: unrecognized option `%s%s'\n"),
523 argv[0], t, nextchar);
526 nextchar = (char *) "";
532 /* Look at and handle the next short option-character. */
535 char c = *nextchar++;
536 char *temp = strchr(optstring, c);
538 /* Increment `optind' when we start to process its last character. */
539 if (*nextchar == '\0')
542 if (temp == NULL || c == ':')
547 /* 1003.2 specifies the format of this message. */
548 fprintf(stderr, _("%s: illegal option -- %c\n"),
551 fprintf(stderr, _("%s: invalid option -- %c\n"),
557 /* Convenience. Treat POSIX -W foo same as long option --foo */
558 if (temp[0] == 'W' && temp[1] == ';')
561 const struct option *p;
562 const struct option *pfound = NULL;
568 /* This is an option that requires an argument. */
569 if (*nextchar != '\0')
572 /* If we end this ARGV-element by taking the rest as an arg,
573 we must advance to the next element now. */
576 else if (optind == argc)
580 /* 1003.2 specifies the format of this message. */
581 fprintf(stderr, _("%s: option requires an argument -- %c\n"),
585 if (optstring[0] == ':')
592 /* We already incremented `optind' once;
593 increment it again when taking next ARGV-elt as argument. */
594 optarg = argv[optind++];
596 /* optarg is now the argument, see if it's in the
597 table of longopts. */
599 for (nextchar = nameend = optarg; *nameend && *nameend != '='; nameend++)
602 /* Test all long options for either exact match
603 or abbreviated matches. */
604 for (p = longopts, option_index = 0; p->name; p++, option_index++)
605 if (!strncmp(p->name, nextchar, nameend - nextchar))
607 if ((unsigned int) (nameend - nextchar) == strlen(p->name))
609 /* Exact match found. */
611 indfound = option_index;
615 else if (pfound == NULL)
617 /* First nonexact match found. */
619 indfound = option_index;
622 /* Second or later nonexact match found. */
628 fprintf(stderr, _("%s: option `-W %s' is ambiguous\n"),
629 argv[0], argv[optind]);
630 nextchar += strlen(nextchar);
636 option_index = indfound;
639 /* Don't test has_arg with >, because some C compilers don't
640 allow it to be used on enums. */
642 optarg = nameend + 1;
647 %s: option `-W %s' doesn't allow an argument\n"),
648 argv[0], pfound->name);
650 nextchar += strlen(nextchar);
654 else if (pfound->has_arg == 1)
657 optarg = argv[optind++];
662 _("%s: option `%s' requires an argument\n"),
663 argv[0], argv[optind - 1]);
664 nextchar += strlen(nextchar);
665 return optstring[0] == ':' ? ':' : '?';
668 nextchar += strlen(nextchar);
670 *longind = option_index;
673 *(pfound->flag) = pfound->val;
679 return 'W'; /* Let the application handle it. */
685 /* This is an option that accepts an argument optionally. */
686 if (*nextchar != '\0')
697 /* This is an option that requires an argument. */
698 if (*nextchar != '\0')
701 /* If we end this ARGV-element by taking the rest as an arg,
702 we must advance to the next element now. */
705 else if (optind == argc)
709 /* 1003.2 specifies the format of this message. */
711 _("%s: option requires an argument -- %c\n"),
715 if (optstring[0] == ':')
721 /* We already incremented `optind' once;
722 increment it again when taking next ARGV-elt as argument. */
723 optarg = argv[optind++];