2 NOTE: getopt is now part of the C library, so if you don't know what
3 "Keep this file name-space clean" means, talk to roland@gnu.ai.mit.edu
6 Copyright (C) 1987, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97
7 Free Software Foundation, Inc.
9 NOTE: The canonical source of this file is maintained with the GNU C Library.
10 Bugs can be reported to bug-glibc@prep.ai.mit.edu.
12 This program is free software; you can redistribute it and/or modify it
13 under the terms of the GNU General Public License as published by the
14 Free Software Foundation; either version 3, or (at your option) any
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program; if not, write to the Free Software
24 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
28 This code was heavily modified for GNUnet.
29 Copyright (C) 2006, 2017 Christian Grothoff
34 * @brief GNU style option parsing
36 * TODO: get rid of statics (make reentrant) and
37 * replace main GNU getopt parser with one that
38 * actually fits our API.
41 #include "gnunet_util_lib.h"
50 #define LOG(kind, ...) GNUNET_log_from(kind, "util-getopt", __VA_ARGS__)
52 #define LOG_STRERROR(kind, syscall) \
53 GNUNET_log_from_strerror(kind, "util-getopt", syscall)
55 #if defined(WIN32) && !defined(__CYGWIN32__)
56 /* It's not Unix, really. See? Capital letters. */
58 #define getpid() GetCurrentProcessId()
62 /* This is for other GNU distributions with internationalized messages.
63 When compiling libc, the _ macro is predefined. */
66 #define _(msgid) gettext(msgid)
68 #define _(msgid) (msgid)
72 /* Describe the long-named options requested by the application.
73 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
74 of `struct GNoption' terminated by an element containing a name which is
77 The field `has_arg' is:
78 no_argument (or 0) if the option does not take an argument,
79 required_argument (or 1) if the option requires an argument,
80 optional_argument (or 2) if the option takes an optional argument.
82 If the field `flag' is not NULL, it points to a variable that is set
83 to the value given in the field `val' when the option is found, but
84 left unchanged if the option is not found.
86 To have a long-named option do something other than set an `int' to
87 a compiled-in constant, such as set a value from `GNoptarg', set the
88 option's `flag' field to zero and its `val' field to a nonzero
89 value (the equivalent single-letter option character, if there is
90 one). For long options that have a zero `flag' field, `getopt'
91 returns the contents of the `val' field. */
95 /* has_arg can't be an enum because some compilers complain about
96 * type mismatches in all the code that assumes it is an int. */
103 /* This version of `getopt' appears to the caller like standard Unix `getopt'
104 but it behaves differently for the user, since it allows the user
105 to intersperse the options with the other arguments.
107 As `getopt' works, it permutes the elements of ARGV so that,
108 when it is done, all the options precede everything else. Thus
109 all application programs are extended to handle flexible argument order.
111 Setting the environment variable POSIXLY_CORRECT disables permutation.
112 Then the behavior is completely standard.
114 GNU application programs can use a third alternative mode in which
115 they can distinguish the relative order of options and other arguments. */
117 /* For communication from `getopt' to the caller.
118 When `getopt' finds an option that takes an argument,
119 the argument value is returned here.
120 Also, when `ordering' is RETURN_IN_ORDER,
121 each non-option ARGV-element is returned here. */
123 static char *GNoptarg = NULL;
125 /* Index in ARGV of the next element to be scanned.
126 This is used for communication to and from the caller
127 and for communication between successive calls to `getopt'.
129 On entry to `getopt', zero means this is the first call; initialize.
131 When `getopt' returns -1, this is the index of the first of the
132 non-option elements that the caller should itself scan.
134 Otherwise, `GNoptind' communicates from one call to the next
135 how much of ARGV has been scanned so far. */
137 /* 1003.2 says this must be 1 before any call. */
138 static int GNoptind = 1;
140 /* The next char to be scanned in the option-element
141 in which the last option character we returned was found.
142 This allows us to pick up the scan where we left off.
144 If this is zero, or a null string, it means resume the scan
145 by advancing to the next ARGV-element. */
147 static char *nextchar;
150 /* Describe how to deal with options that follow non-option ARGV-elements.
152 If the caller did not specify anything,
153 the default is REQUIRE_ORDER if the environment variable
154 POSIXLY_CORRECT is defined, PERMUTE otherwise.
156 REQUIRE_ORDER means don't recognize them as options;
157 stop option processing when the first non-option is seen.
158 This is what Unix does.
159 This mode of operation is selected by either setting the environment
160 variable POSIXLY_CORRECT, or using `+' as the first character
161 of the list of option characters.
163 PERMUTE is the default. We GNUNET_CRYPTO_random_permute the contents of ARGV as we scan,
164 so that eventually all the non-options are at the end. This allows options
165 to be given in any order, even with programs that were not written to
168 RETURN_IN_ORDER is an option available to programs that were written
169 to expect GNoptions and other ARGV-elements in any order and that care about
170 the ordering of the two. We describe each non-option ARGV-element
171 as if it were the argument of an option with character code 1.
172 Using `-' as the first character of the list of option characters
173 selects this mode of operation.
175 The special argument `--' forces an end of option-scanning regardless
176 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
177 `--' can cause `getopt' to return -1 with `GNoptind' != ARGC. */
179 static enum { REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER } ordering;
181 /* Value of POSIXLY_CORRECT environment variable. */
182 static char *posixly_correct;
184 #ifdef __GNU_LIBRARY__
185 /* We want to avoid inclusion of string.h with non-GNU libraries
186 because there are many ways it can cause trouble.
187 On some systems, it contains special magic macros that don't work
190 #define my_index strchr
193 /* Avoid depending on library functions or files
194 whose names are inconsistent. */
200 my_index(const char *str, int chr)
211 /* If using GCC, we can safely declare strlen this way.
212 If not using GCC, it is ok not to declare it. */
214 /* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
215 That was relevant to code that was here before. */
216 #if !defined(__STDC__) || !__STDC__
217 /* gcc with -traditional declares the built-in strlen to return int,
218 and has done so at least since version 2.4.5. -- rms. */
220 strlen(const char *);
221 #endif /* not __STDC__ */
222 #endif /* __GNUC__ */
224 #endif /* not __GNU_LIBRARY__ */
226 /* Handle permutation of arguments. */
228 /* Describe the part of ARGV that contains non-options that have
229 been skipped. `first_nonopt' is the index in ARGV of the first of them;
230 `last_nonopt' is the index after the last of them. */
232 static int first_nonopt;
233 static int last_nonopt;
235 #define SWAP_FLAGS(ch1, ch2)
237 /* Exchange two adjacent subsequences of ARGV.
238 One subsequence is elements [first_nonopt,last_nonopt)
239 which contains all the non-options that have been skipped so far.
240 The other is elements [last_nonopt,GNoptind), which contains all
241 the options processed since those non-options were skipped.
243 `first_nonopt' and `last_nonopt' are relocated so that they describe
244 the new indices of the non-options in ARGV after they are moved. */
246 #if defined(__STDC__) && __STDC__
252 exchange(char **argv)
254 int bottom = first_nonopt;
255 int middle = last_nonopt;
259 /* Exchange the shorter segment with the far end of the longer segment.
260 * That puts the shorter segment into the right place.
261 * It leaves the longer segment in the right place overall,
262 * but it consists of two parts that need to be swapped next. */
264 while (top > middle && middle > bottom)
266 if (top - middle > middle - bottom)
268 /* Bottom segment is the short one. */
269 int len = middle - bottom;
272 /* Swap it with the top part of the top segment. */
273 for (i = 0; i < len; i++)
275 tem = argv[bottom + i];
276 argv[bottom + i] = argv[top - (middle - bottom) + i];
277 argv[top - (middle - bottom) + i] = tem;
278 SWAP_FLAGS(bottom + i, top - (middle - bottom) + i);
280 /* Exclude the moved bottom segment from further swapping. */
285 /* Top segment is the short one. */
286 int len = top - middle;
289 /* Swap it with the bottom part of the bottom segment. */
290 for (i = 0; i < len; i++)
292 tem = argv[bottom + i];
293 argv[bottom + i] = argv[middle + i];
294 argv[middle + i] = tem;
295 SWAP_FLAGS(bottom + i, middle + i);
297 /* Exclude the moved top segment from further swapping. */
302 /* Update records for the slots the non-options now occupy. */
304 first_nonopt += (GNoptind - last_nonopt);
305 last_nonopt = GNoptind;
308 /* Initialize the internal data when the first call is made. */
310 #if defined(__STDC__) && __STDC__
312 _getopt_initialize(int, char *const *, const char *);
315 _getopt_initialize(int argc, char *const *argv, const char *optstring)
317 /* Start processing options with ARGV-element 1 (since ARGV-element 0
318 * is the program name); the sequence of previously skipped
319 * non-option ARGV-elements is empty. */
321 first_nonopt = last_nonopt = GNoptind;
325 posixly_correct = getenv("POSIXLY_CORRECT");
327 /* Determine how to handle the ordering of options and nonoptions. */
329 if (optstring[0] == '-')
331 ordering = RETURN_IN_ORDER;
334 else if (optstring[0] == '+')
336 ordering = REQUIRE_ORDER;
339 else if (posixly_correct != NULL)
340 ordering = REQUIRE_ORDER;
347 /* Scan elements of ARGV (whose length is ARGC) for option characters
350 If an element of ARGV starts with '-', and is not exactly "-" or "--",
351 then it is an option element. The characters of this element
352 (aside from the initial '-') are option characters. If `getopt'
353 is called repeatedly, it returns successively each of the option characters
354 from each of the option elements.
356 If `getopt' finds another option character, it returns that character,
357 updating `GNoptind' and `nextchar' so that the next call to `getopt' can
358 resume the scan with the following option character or ARGV-element.
360 If there are no more option characters, `getopt' returns -1.
361 Then `GNoptind' is the index in ARGV of the first ARGV-element
362 that is not an option. (The ARGV-elements have been permuted
363 so that those that are not options now come last.)
365 OPTSTRING is a string containing the legitimate option characters.
366 If an option character is seen that is not listed in OPTSTRING,
367 return '?' after printing an error message. If you set `GNopterr' to
368 zero, the error message is suppressed but we still return '?'.
370 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
371 so the following text in the same ARGV-element, or the text of the following
372 ARGV-element, is returned in `GNoptarg'. Two colons mean an option that
373 wants an optional arg; if there is text in the current ARGV-element,
374 it is returned in `GNoptarg', otherwise `GNoptarg' is set to zero.
376 If OPTSTRING starts with `-' or `+', it requests different methods of
377 handling the non-option ARGV-elements.
378 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
380 Long-named options begin with `--' instead of `-'.
381 Their names may be abbreviated as long as the abbreviation is unique
382 or is an exact match for some defined option. If they have an
383 argument, it follows the option name in the same ARGV-element, separated
384 from the option name by a `=', or else the in next ARGV-element.
385 When `getopt' finds a long-named option, it returns 0 if that option's
386 `flag' field is nonzero, the value of the option's `val' field
387 if the `flag' field is zero.
389 The elements of ARGV aren't really const, because we GNUNET_CRYPTO_random_permute them.
390 But we pretend they're const in the prototype to be compatible
393 LONGOPTS is a vector of `struct GNoption' terminated by an
394 element containing a name which is zero.
396 LONGIND returns the index in LONGOPT of the long-named option found.
397 It is only valid when a long-named option has been found by the most
400 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
401 long-named options. */
404 GN_getopt_internal(int argc,
406 const char *optstring,
407 const struct GNoption *longopts,
411 static int __getopt_initialized = 0;
412 static int GNopterr = 1;
416 if (GNoptind == 0 || !__getopt_initialized)
419 GNoptind = 1; /* Don't scan ARGV[0], the program name. */
420 optstring = _getopt_initialize(argc, argv, optstring);
421 __getopt_initialized = 1;
424 /* Test whether ARGV[GNoptind] points to a non-option argument.
425 * Either it does not have option syntax, or there is an environment flag
426 * from the shell indicating it is not an option. The later information
427 * is only used when the used in the GNU libc. */
428 #define NONOPTION_P (argv[GNoptind][0] != '-' || argv[GNoptind][1] == '\0')
430 if (nextchar == NULL || *nextchar == '\0')
432 /* Advance to the next ARGV-element. */
434 /* Give FIRST_NONOPT & LAST_NONOPT rational values if GNoptind has been
435 * moved back by the user (who may also have changed the arguments). */
436 if (last_nonopt > GNoptind)
437 last_nonopt = GNoptind;
438 if (first_nonopt > GNoptind)
439 first_nonopt = GNoptind;
441 if (ordering == PERMUTE)
443 /* If we have just processed some options following some non-options,
444 * exchange them so that the options come first. */
446 if (first_nonopt != last_nonopt && last_nonopt != GNoptind)
447 exchange((char **)argv);
448 else if (last_nonopt != GNoptind)
449 first_nonopt = GNoptind;
451 /* Skip any additional non-options
452 * and extend the range of non-options previously skipped. */
454 while (GNoptind < argc && NONOPTION_P)
456 last_nonopt = GNoptind;
459 /* The special ARGV-element `--' means premature end of options.
460 * Skip it like a null option,
461 * then exchange with previous non-options as if it were an option,
462 * then skip everything else like a non-option. */
463 if (GNoptind != argc && !strcmp(argv[GNoptind], "--"))
467 if (first_nonopt != last_nonopt && last_nonopt != GNoptind)
468 exchange((char **)argv);
469 else if (first_nonopt == last_nonopt)
470 first_nonopt = GNoptind;
476 /* If we have done all the ARGV-elements, stop the scan
477 * and back over any non-options that we skipped and permuted. */
479 if (GNoptind == argc)
481 /* Set the next-arg-index to point at the non-options
482 * that we previously skipped, so the caller will digest them. */
483 if (first_nonopt != last_nonopt)
484 GNoptind = first_nonopt;
488 /* If we have come to a non-option and did not permute it,
489 * either stop the scan or describe it to the caller and pass it by. */
493 if (ordering == REQUIRE_ORDER)
495 GNoptarg = argv[GNoptind++];
499 /* We have found another option-ARGV-element.
500 * Skip the initial punctuation. */
503 (argv[GNoptind] + 1 + (longopts != NULL && argv[GNoptind][1] == '-'));
506 /* Decode the current option-ARGV-element. */
508 /* Check whether the ARGV-element is a long option.
510 * If long_only and the ARGV-element has the form "-f", where f is
511 * a valid short option, don't consider it an abbreviated form of
512 * a long option that starts with f. Otherwise there would be no
513 * way to give the -f short option.
515 * On the other hand, if there's a long option "fubar" and
516 * the ARGV-element is "-fu", do consider that an abbreviation of
517 * the long option, just like "--fu", and not "-f" with arg "u".
519 * This distinction seems to be the most useful approach. */
521 if (longopts != NULL &&
522 (argv[GNoptind][1] == '-' ||
524 (argv[GNoptind][2] || !my_index(optstring, argv[GNoptind][1])))))
527 const struct GNoption *p;
528 const struct GNoption *pfound = NULL;
534 for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
537 /* Test all long options for either exact match
538 * or abbreviated matches. */
539 for (p = longopts, option_index = 0; p->name; p++, option_index++)
540 if (!strncmp(p->name, nextchar, nameend - nextchar))
542 if ((unsigned int)(nameend - nextchar) ==
543 (unsigned int)strlen(p->name))
545 /* Exact match found. */
547 indfound = option_index;
551 else if (pfound == NULL)
553 /* First nonexact match found. */
555 indfound = option_index;
558 /* Second or later nonexact match found. */
566 _("%s: option `%s' is ambiguous\n"),
569 nextchar += strlen(nextchar);
576 option_index = indfound;
580 /* Don't test has_arg with >, because some C compilers don't
581 * allow it to be used on enums. */
583 GNoptarg = nameend + 1;
588 if (argv[GNoptind - 1][1] == '-')
591 _("%s: option `--%s' does not allow an argument\n"),
595 /* +option or -option */
597 _("%s: option `%c%s' does not allow an argument\n"),
599 argv[GNoptind - 1][0],
602 nextchar += strlen(nextchar);
606 else if (pfound->has_arg == 1)
610 GNoptarg = argv[GNoptind++];
617 _("%s: option `%s' requires an argument\n"),
621 nextchar += strlen(nextchar);
622 return (optstring[0] == ':') ? ':' : '?';
625 nextchar += strlen(nextchar);
627 *longind = option_index;
630 *(pfound->flag) = pfound->val;
636 /* Can't find it as a long option. If this is not getopt_long_only,
637 * or the option starts with '--' or is not a valid short
638 * option, then it's an error.
639 * Otherwise interpret it as a short option. */
640 if (!long_only || argv[GNoptind][1] == '-' ||
641 my_index(optstring, *nextchar) == NULL)
645 if (argv[GNoptind][1] == '-')
648 _("%s: unrecognized option `--%s'\n"),
652 /* +option or -option */
654 _("%s: unrecognized option `%c%s'\n"),
659 nextchar = (char *)"";
665 /* Look at and handle the next short option-character. */
668 char c = *nextchar++;
669 char *temp = my_index(optstring, c);
671 /* Increment `GNoptind' when we start to process its last character. */
672 if (*nextchar == '\0')
675 if (temp == NULL || c == ':')
680 /* 1003.2 specifies the format of this message. */
681 fprintf(stderr, _("%s: illegal option -- %c\n"), argv[0], c);
683 fprintf(stderr, _("%s: invalid option -- %c\n"), argv[0], c);
687 /* Convenience. Treat POSIX -W foo same as long option --foo */
688 if (temp[0] == 'W' && temp[1] == ';')
691 const struct GNoption *p;
692 const struct GNoption *pfound = NULL;
698 /* This is an option that requires an argument. */
699 if (*nextchar != '\0')
702 /* If we end this ARGV-element by taking the rest as an arg,
703 * we must advance to the next element now. */
706 else if (GNoptind == argc)
710 /* 1003.2 specifies the format of this message. */
712 _("%s: option requires an argument -- %c\n"),
716 if (optstring[0] == ':')
723 /* We already incremented `GNoptind' once;
724 * increment it again when taking next ARGV-elt as argument. */
725 GNoptarg = argv[GNoptind++];
727 /* GNoptarg is now the argument, see if it's in the
728 * table of longopts. */
730 for (nextchar = nameend = GNoptarg; *nameend && *nameend != '=';
734 /* Test all long options for either exact match
735 * or abbreviated matches. */
736 if (longopts != NULL)
737 for (p = longopts, option_index = 0; p->name; p++, option_index++)
738 if (!strncmp(p->name, nextchar, nameend - nextchar))
740 if ((unsigned int)(nameend - nextchar) == strlen(p->name))
742 /* Exact match found. */
744 indfound = option_index;
748 else if (pfound == NULL)
750 /* First nonexact match found. */
752 indfound = option_index;
755 /* Second or later nonexact match found. */
762 _("%s: option `-W %s' is ambiguous\n"),
765 nextchar += strlen(nextchar);
771 option_index = indfound;
774 /* Don't test has_arg with >, because some C compilers don't
775 * allow it to be used on enums. */
777 GNoptarg = nameend + 1;
782 _("%s: option `-W %s' does not allow an argument\n"),
786 nextchar += strlen(nextchar);
790 else if (pfound->has_arg == 1)
793 GNoptarg = argv[GNoptind++];
798 _("%s: option `%s' requires an argument\n"),
801 nextchar += strlen(nextchar);
802 return optstring[0] == ':' ? ':' : '?';
805 nextchar += strlen(nextchar);
807 *longind = option_index;
810 *(pfound->flag) = pfound->val;
816 return 'W'; /* Let the application handle it. */
822 /* This is an option that accepts an argument optionally. */
823 if (*nextchar != '\0')
834 /* This is an option that requires an argument. */
835 if (*nextchar != '\0')
838 /* If we end this ARGV-element by taking the rest as an arg,
839 * we must advance to the next element now. */
842 else if (GNoptind == argc)
846 /* 1003.2 specifies the format of this message. */
848 _("%s: option requires an argument -- %c\n"),
852 if (optstring[0] == ':')
858 /* We already incremented `GNoptind' once;
859 * increment it again when taking next ARGV-elt as argument. */
860 GNoptarg = argv[GNoptind++];
870 GNgetopt_long(int argc,
873 const struct GNoption *long_options,
876 return GN_getopt_internal(argc, argv, options, long_options, opt_index, 0);
879 /* ******************** now the GNUnet specific modifications... ********************* */
882 * Parse the command line.
884 * @param binaryOptions Name of application with option summary
885 * @param allOptions defined options and handlers
886 * @param argc number of arguments
887 * @param argv actual arguments
888 * @return index into argv with first non-option
889 * argument, or #GNUNET_SYSERR on error
892 GNUNET_GETOPT_run(const char *binaryOptions,
893 const struct GNUNET_GETOPT_CommandLineOption *allOptions,
897 struct GNoption *long_options;
898 struct GNUNET_GETOPT_CommandLineProcessorContext clpc;
904 unsigned int optmatch = 0;
905 const char *have_exclusive = NULL;
907 GNUNET_assert(argc > 0);
909 clpc.binaryName = argv[0];
910 clpc.binaryOptions = binaryOptions;
911 clpc.allOptions = allOptions;
914 for (count = 0; NULL != allOptions[count].name; count++)
917 /* transform our option representation into the format
918 used by the GNU getopt copylib */
919 long_options = GNUNET_new_array(count + 1, struct GNoption);
920 seen = GNUNET_new_array(count, uint8_t);
921 shorts = GNUNET_malloc(count * 2 + 1);
923 for (unsigned i = 0; i < count; i++)
925 long_options[i].name = allOptions[i].name;
926 long_options[i].has_arg = allOptions[i].require_argument;
927 long_options[i].flag = NULL;
928 long_options[i].val = allOptions[i].shortName;
929 shorts[spos++] = allOptions[i].shortName;
930 if (allOptions[i].require_argument != 0)
931 shorts[spos++] = ':';
933 long_options[count].name = NULL;
934 long_options[count].has_arg = 0;
935 long_options[count].flag = NULL;
936 long_options[count].val = '\0';
940 /* main getopt loop */
943 int option_index = 0;
947 c = GNgetopt_long(argc, argv, shorts, long_options, &option_index);
948 if (c == GNUNET_SYSERR)
949 break; /* No more flags to process */
951 /* Check which of our program's options was given by the user */
952 for (i = 0; i < count; i++)
954 clpc.currentArgument = GNoptind - 1;
955 if ((char)c == allOptions[i].shortName)
958 if (allOptions[i].option_exclusive)
959 have_exclusive = allOptions[i].name;
960 if (GNUNET_OK == cont)
962 /* parse the option using the option-specific processor */
963 cont = allOptions[i].processor(&clpc,
974 fprintf(stderr, _("Use %s to get a list of options.\n"), "--help");
975 cont = GNUNET_SYSERR;
979 GNUNET_free(long_options);
981 /* check that if any option that was marked as exclusive
982 is the only option that was provided */
983 if ((NULL != have_exclusive) && (optmatch > 1))
986 _("Option `%s' can't be used with other options.\n"),
988 cont = GNUNET_SYSERR;
990 if (GNUNET_YES == cont)
992 /* check that all mandatory options are present */
993 for (count = 0; NULL != allOptions[count].name; count++)
995 if ((0 == seen[count]) && (allOptions[count].option_mandatory))
998 _("Missing mandatory option `%s'.\n"),
999 allOptions[count].name);
1000 cont = GNUNET_SYSERR;
1006 /* call cleaners, if available */
1007 for (unsigned int i = 0; NULL != allOptions[i].name; i++)
1008 if (NULL != allOptions[i].cleaner)
1009 allOptions[i].cleaner(allOptions[i].scls);
1011 if (GNUNET_OK != cont)
1016 /* end of getopt.c */