GNUnet 0.21.1
getopt.c
Go to the documentation of this file.
1/* Getopt for GNU.
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
4 before changing it!
5
6 Copyright (C) 1987, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97
7 Free Software Foundation, Inc.
8
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.
11
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
15 later version.
16
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.
21
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,
25 USA.
26
27
28 This code was heavily modified for GNUnet.
29 Copyright (C) 2006, 2017 Christian Grothoff
30 */
31
41#include "platform.h"
42#include "gnunet_util_lib.h"
43
44#ifdef VMS
45#include <unixlib.h>
46#if HAVE_STRING_H - 0
47#include <string.h>
48#endif
49#endif
50
51#define LOG(kind, ...) GNUNET_log_from (kind, "util-getopt", __VA_ARGS__)
52
53#define LOG_STRERROR(kind, syscall) \
54 GNUNET_log_from_strerror (kind, "util-getopt", syscall)
55
56#ifndef _
57/* This is for other GNU distributions with internationalized messages.
58 When compiling libc, the _ macro is predefined. */
59#ifdef HAVE_LIBINTL_H
60#include <libintl.h>
61#define _(msgid) gettext (msgid)
62#else
63#define _(msgid) (msgid)
64#endif
65#endif
66
67/* Describe the long-named options requested by the application.
68 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
69 of `struct GNoption' terminated by an element containing a name which is
70 zero.
71
72 The field `has_arg' is:
73 no_argument (or 0) if the option does not take an argument,
74 required_argument (or 1) if the option requires an argument,
75 optional_argument (or 2) if the option takes an optional argument.
76
77 If the field `flag' is not NULL, it points to a variable that is set
78 to the value given in the field `val' when the option is found, but
79 left unchanged if the option is not found.
80
81 To have a long-named option do something other than set an `int' to
82 a compiled-in constant, such as set a value from `GNoptarg', set the
83 option's `flag' field to zero and its `val' field to a nonzero
84 value (the equivalent single-letter option character, if there is
85 one). For long options that have a zero `flag' field, `getopt'
86 returns the contents of the `val' field. */
87
89{
90 const char *name;
91 /* has_arg can't be an enum because some compilers complain about
92 * type mismatches in all the code that assumes it is an int. */
94 int *flag;
95 int val;
96};
97
98
99/* This version of `getopt' appears to the caller like standard Unix `getopt'
100 but it behaves differently for the user, since it allows the user
101 to intersperse the options with the other arguments.
102
103 As `getopt' works, it permutes the elements of ARGV so that,
104 when it is done, all the options precede everything else. Thus
105 all application programs are extended to handle flexible argument order.
106
107 Setting the environment variable POSIXLY_CORRECT disables permutation.
108 Then the behavior is completely standard.
109
110 GNU application programs can use a third alternative mode in which
111 they can distinguish the relative order of options and other arguments. */
112
113/* For communication from `getopt' to the caller.
114 When `getopt' finds an option that takes an argument,
115 the argument value is returned here.
116 Also, when `ordering' is RETURN_IN_ORDER,
117 each non-option ARGV-element is returned here. */
118
119static char *GNoptarg = NULL;
120
121/* Index in ARGV of the next element to be scanned.
122 This is used for communication to and from the caller
123 and for communication between successive calls to `getopt'.
124
125 On entry to `getopt', zero means this is the first call; initialize.
126
127 When `getopt' returns -1, this is the index of the first of the
128 non-option elements that the caller should itself scan.
129
130 Otherwise, `GNoptind' communicates from one call to the next
131 how much of ARGV has been scanned so far. */
132
133/* 1003.2 says this must be 1 before any call. */
134static int GNoptind = 1;
135
136/* The next char to be scanned in the option-element
137 in which the last option character we returned was found.
138 This allows us to pick up the scan where we left off.
139
140 If this is zero, or a null string, it means resume the scan
141 by advancing to the next ARGV-element. */
142
143static char *nextchar;
144
145
146/* Describe how to deal with options that follow non-option ARGV-elements.
147
148 If the caller did not specify anything,
149 the default is REQUIRE_ORDER if the environment variable
150 POSIXLY_CORRECT is defined, PERMUTE otherwise.
151
152 REQUIRE_ORDER means don't recognize them as options;
153 stop option processing when the first non-option is seen.
154 This is what Unix does.
155 This mode of operation is selected by either setting the environment
156 variable POSIXLY_CORRECT, or using `+' as the first character
157 of the list of option characters.
158
159 PERMUTE is the default. We GNUNET_CRYPTO_random_permute the contents of ARGV as we scan,
160 so that eventually all the non-options are at the end. This allows options
161 to be given in any order, even with programs that were not written to
162 expect this.
163
164 RETURN_IN_ORDER is an option available to programs that were written
165 to expect GNoptions and other ARGV-elements in any order and that care about
166 the ordering of the two. We describe each non-option ARGV-element
167 as if it were the argument of an option with character code 1.
168 Using `-' as the first character of the list of option characters
169 selects this mode of operation.
170
171 The special argument `--' forces an end of option-scanning regardless
172 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
173 `--' can cause `getopt' to return -1 with `GNoptind' != ARGC. */
174
176
177/* Value of POSIXLY_CORRECT environment variable. */
178static char *posixly_correct;
179
180#ifdef __GNU_LIBRARY__
181/* We want to avoid inclusion of string.h with non-GNU libraries
182 because there are many ways it can cause trouble.
183 On some systems, it contains special magic macros that don't work
184 in GCC. */
185#include <string.h>
186#define my_index strchr
187#else
188
189/* Avoid depending on library functions or files
190 whose names are inconsistent. */
191
192char *
194
195static char *
196my_index (const char *str, int chr)
197{
198 while (*str)
199 {
200 if (*str == chr)
201 return (char *) str;
202 str++;
203 }
204 return 0;
205}
206
207
208/* If using GCC, we can safely declare strlen this way.
209 If not using GCC, it is ok not to declare it. */
210#ifdef __GNUC__
211/* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
212 That was relevant to code that was here before. */
213#if ! defined(__STDC__) || ! __STDC__
214/* gcc with -traditional declares the built-in strlen to return int,
215 and has done so at least since version 2.4.5. -- rms. */
216extern int
217strlen (const char *);
218
219#endif /* not __STDC__ */
220#endif /* __GNUC__ */
221
222#endif /* not __GNU_LIBRARY__ */
223
224/* Handle permutation of arguments. */
225
226/* Describe the part of ARGV that contains non-options that have
227 been skipped. `first_nonopt' is the index in ARGV of the first of them;
228 `last_nonopt' is the index after the last of them. */
229
230static int first_nonopt;
231static int last_nonopt;
232
233#define SWAP_FLAGS(ch1, ch2)
234
235/* Exchange two adjacent subsequences of ARGV.
236 One subsequence is elements [first_nonopt,last_nonopt)
237 which contains all the non-options that have been skipped so far.
238 The other is elements [last_nonopt,GNoptind), which contains all
239 the options processed since those non-options were skipped.
240
241 `first_nonopt' and `last_nonopt' are relocated so that they describe
242 the new indices of the non-options in ARGV after they are moved. */
243
244#if defined(__STDC__) && __STDC__
245static void
246exchange (char **);
247
248#endif
249
250static void
251exchange (char **argv)
252{
253 int bottom = first_nonopt;
254 int middle = last_nonopt;
255 int top = GNoptind;
256 char *tem;
257
258 /* Exchange the shorter segment with the far end of the longer segment.
259 * That puts the shorter segment into the right place.
260 * It leaves the longer segment in the right place overall,
261 * but it consists of two parts that need to be swapped next. */
262
263 while (top > middle && middle > bottom)
264 {
265 if (top - middle > middle - bottom)
266 {
267 /* Bottom segment is the short one. */
268 int len = middle - bottom;
269 register int i;
270
271 /* Swap it with the top part of the top segment. */
272 for (i = 0; i < len; i++)
273 {
274 tem = argv[bottom + i];
275 argv[bottom + i] = argv[top - (middle - bottom) + i];
276 argv[top - (middle - bottom) + i] = tem;
277 SWAP_FLAGS (bottom + i, top - (middle - bottom) + i);
278 }
279 /* Exclude the moved bottom segment from further swapping. */
280 top -= len;
281 }
282 else
283 {
284 /* Top segment is the short one. */
285 int len = top - middle;
286 register int i;
287
288 /* Swap it with the bottom part of the bottom segment. */
289 for (i = 0; i < len; i++)
290 {
291 tem = argv[bottom + i];
292 argv[bottom + i] = argv[middle + i];
293 argv[middle + i] = tem;
294 SWAP_FLAGS (bottom + i, middle + i);
295 }
296 /* Exclude the moved top segment from further swapping. */
297 bottom += len;
298 }
299 }
300
301 /* Update records for the slots the non-options now occupy. */
302
305}
306
307
308/* Initialize the internal data when the first call is made. */
309
310#if defined(__STDC__) && __STDC__
311static const char *
312_getopt_initialize (int, char *const *, const char *);
313
314#endif
315static const char *
316_getopt_initialize (int argc, char *const *argv, const char *optstring)
317{
318 /* Start processing options with ARGV-element 1 (since ARGV-element 0
319 * is the program name); the sequence of previously skipped
320 * non-option ARGV-elements is empty. */
321
323
324 nextchar = NULL;
325
326 posixly_correct = getenv ("POSIXLY_CORRECT");
327
328 /* Determine how to handle the ordering of options and nonoptions. */
329
330 if (optstring[0] == '-')
331 {
333 ++optstring;
334 }
335 else if (optstring[0] == '+')
336 {
338 ++optstring;
339 }
340 else if (posixly_correct != NULL)
342 else
344
345 return optstring;
346}
347
348
349/* Scan elements of ARGV (whose length is ARGC) for option characters
350 given in OPTSTRING.
351
352 If an element of ARGV starts with '-', and is not exactly "-" or "--",
353 then it is an option element. The characters of this element
354 (aside from the initial '-') are option characters. If `getopt'
355 is called repeatedly, it returns successively each of the option characters
356 from each of the option elements.
357
358 If `getopt' finds another option character, it returns that character,
359 updating `GNoptind' and `nextchar' so that the next call to `getopt' can
360 resume the scan with the following option character or ARGV-element.
361
362 If there are no more option characters, `getopt' returns -1.
363 Then `GNoptind' is the index in ARGV of the first ARGV-element
364 that is not an option. (The ARGV-elements have been permuted
365 so that those that are not options now come last.)
366
367 OPTSTRING is a string containing the legitimate option characters.
368 If an option character is seen that is not listed in OPTSTRING,
369 return '?' after printing an error message. If you set `GNopterr' to
370 zero, the error message is suppressed but we still return '?'.
371
372 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
373 so the following text in the same ARGV-element, or the text of the following
374 ARGV-element, is returned in `GNoptarg'. Two colons mean an option that
375 wants an optional arg; if there is text in the current ARGV-element,
376 it is returned in `GNoptarg', otherwise `GNoptarg' is set to zero.
377
378 If OPTSTRING starts with `-' or `+', it requests different methods of
379 handling the non-option ARGV-elements.
380 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
381
382 Long-named options begin with `--' instead of `-'.
383 Their names may be abbreviated as long as the abbreviation is unique
384 or is an exact match for some defined option. If they have an
385 argument, it follows the option name in the same ARGV-element, separated
386 from the option name by a `=', or else the in next ARGV-element.
387 When `getopt' finds a long-named option, it returns 0 if that option's
388 `flag' field is nonzero, the value of the option's `val' field
389 if the `flag' field is zero.
390
391 The elements of ARGV aren't really const, because we GNUNET_CRYPTO_random_permute them.
392 But we pretend they're const in the prototype to be compatible
393 with other systems.
394
395 LONGOPTS is a vector of `struct GNoption' terminated by an
396 element containing a name which is zero.
397
398 LONGIND returns the index in LONGOPT of the long-named option found.
399 It is only valid when a long-named option has been found by the most
400 recent call.
401
402 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
403 long-named options. */
404
405static int
407 char *const *argv,
408 const char *optstring,
409 const struct GNoption *longopts,
410 int *longind,
411 int long_only)
412{
413 static int __getopt_initialized = 0;
414 static int GNopterr = 1;
415
416 GNoptarg = NULL;
417
418 if ((GNoptind == 0) || ! __getopt_initialized)
419 {
420 if (GNoptind == 0)
421 GNoptind = 1; /* Don't scan ARGV[0], the program name. */
422 optstring = _getopt_initialize (argc, argv, optstring);
423 __getopt_initialized = 1;
424 }
425
426 /* Test whether ARGV[GNoptind] points to a non-option argument.
427 * Either it does not have option syntax, or there is an environment flag
428 * from the shell indicating it is not an option. The later information
429 * is only used when the used in the GNU libc. */
430#define NONOPTION_P (argv[GNoptind][0] != '-' || argv[GNoptind][1] == '\0')
431
432 if ((nextchar == NULL) || (*nextchar == '\0'))
433 {
434 /* Advance to the next ARGV-element. */
435
436 /* Give FIRST_NONOPT & LAST_NONOPT rational values if GNoptind has been
437 * moved back by the user (who may also have changed the arguments). */
438 if (last_nonopt > GNoptind)
442
443 if (ordering == PERMUTE)
444 {
445 /* If we have just processed some options following some non-options,
446 * exchange them so that the options come first. */
447
449 exchange ((char **) argv);
450 else if (last_nonopt != GNoptind)
452
453 /* Skip any additional non-options
454 * and extend the range of non-options previously skipped. */
455
456 while (GNoptind < argc && NONOPTION_P)
457 GNoptind++;
459 }
460
461 /* The special ARGV-element `--' means premature end of options.
462 * Skip it like a null option,
463 * then exchange with previous non-options as if it were an option,
464 * then skip everything else like a non-option. */
465 if ((GNoptind != argc) && ! strcmp (argv[GNoptind], "--"))
466 {
467 GNoptind++;
468
470 exchange ((char **) argv);
471 else if (first_nonopt == last_nonopt)
473 last_nonopt = argc;
474
475 GNoptind = argc;
476 }
477
478 /* If we have done all the ARGV-elements, stop the scan
479 * and back over any non-options that we skipped and permuted. */
480
481 if (GNoptind == argc)
482 {
483 /* Set the next-arg-index to point at the non-options
484 * that we previously skipped, so the caller will digest them. */
487 return -1;
488 }
489
490 /* If we have come to a non-option and did not permute it,
491 * either stop the scan or describe it to the caller and pass it by. */
492
493 if (NONOPTION_P)
494 {
495 if (ordering == REQUIRE_ORDER)
496 return -1;
497 GNoptarg = argv[GNoptind++];
498 return 1;
499 }
500
501 /* We have found another option-ARGV-element.
502 * Skip the initial punctuation. */
503
504 nextchar =
505 (argv[GNoptind] + 1 + (longopts != NULL && argv[GNoptind][1] == '-'));
506 }
507
508 /* Decode the current option-ARGV-element. */
509
510 /* Check whether the ARGV-element is a long option.
511 *
512 * If long_only and the ARGV-element has the form "-f", where f is
513 * a valid short option, don't consider it an abbreviated form of
514 * a long option that starts with f. Otherwise there would be no
515 * way to give the -f short option.
516 *
517 * On the other hand, if there's a long option "fubar" and
518 * the ARGV-element is "-fu", do consider that an abbreviation of
519 * the long option, just like "--fu", and not "-f" with arg "u".
520 *
521 * This distinction seems to be the most useful approach. */if ((longopts != NULL) &&
522 ((argv[GNoptind][1] == '-') ||
523 (long_only &&
524 (argv[GNoptind][2] || ! my_index (optstring, argv[GNoptind][1])))))
525 {
526 char *nameend;
527 const struct GNoption *p;
528 const struct GNoption *pfound = NULL;
529 int exact = 0;
530 int ambig = 0;
531 int indfound = -1;
532 int option_index;
533
534 for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
535 /* Do nothing. */;
536
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))
541 {
542 if ((unsigned int) (nameend - nextchar) ==
543 (unsigned int) strlen (p->name))
544 {
545 /* Exact match found. */
546 pfound = p;
547 indfound = option_index;
548 exact = 1;
549 break;
550 }
551 else if (pfound == NULL)
552 {
553 /* First nonexact match found. */
554 pfound = p;
555 indfound = option_index;
556 }
557 else
558 /* Second or later nonexact match found. */
559 ambig = 1;
560 }
561
562 if (ambig && ! exact)
563 {
564 if (GNopterr)
565 fprintf (stderr,
566 _ ("%s: option `%s' is ambiguous\n"),
567 argv[0],
568 argv[GNoptind]);
569 nextchar += strlen (nextchar);
570 GNoptind++;
571 return '?';
572 }
573
574 if (pfound != NULL)
575 {
576 option_index = indfound;
577 GNoptind++;
578 if (*nameend)
579 {
580 /* Don't test has_arg with >, because some C compilers don't
581 * allow it to be used on enums. */
582 if (pfound->has_arg)
583 GNoptarg = nameend + 1;
584 else
585 {
586 if (GNopterr)
587 {
588 if (argv[GNoptind - 1][1] == '-')
589 /* --option */
590 fprintf (stderr,
591 _ ("%s: option `--%s' does not allow an argument\n"),
592 argv[0],
593 pfound->name);
594 else
595 /* +option or -option */
596 fprintf (stderr,
597 _ ("%s: option `%c%s' does not allow an argument\n"),
598 argv[0],
599 argv[GNoptind - 1][0],
600 pfound->name);
601 }
602 nextchar += strlen (nextchar);
603 return '?';
604 }
605 }
606 else if (pfound->has_arg == 1)
607 {
608 if (GNoptind < argc)
609 {
610 GNoptarg = argv[GNoptind++];
611 }
612 else
613 {
614 if (GNopterr)
615 {
616 fprintf (stderr,
617 _ ("%s: option `%s' requires an argument\n"),
618 argv[0],
619 argv[GNoptind - 1]);
620 }
621 nextchar += strlen (nextchar);
622 return (optstring[0] == ':') ? ':' : '?';
623 }
624 }
625 nextchar += strlen (nextchar);
626 if (longind != NULL)
627 *longind = option_index;
628 if (pfound->flag)
629 {
630 *(pfound->flag) = pfound->val;
631 return 0;
632 }
633 return pfound->val;
634 }
635
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) )
642 {
643 if (GNopterr)
644 {
645 if (argv[GNoptind][1] == '-')
646 /* --option */
647 fprintf (stderr,
648 _ ("%s: unrecognized option `--%s'\n"),
649 argv[0],
650 nextchar);
651 else
652 /* +option or -option */
653 fprintf (stderr,
654 _ ("%s: unrecognized option `%c%s'\n"),
655 argv[0],
656 argv[GNoptind][0],
657 nextchar);
658 }
659 nextchar = (char *) "";
660 GNoptind++;
661 return '?';
662 }
663 }
664
665 /* Look at and handle the next short option-character. */
666
667 {
668 char c = *nextchar++;
669 char *temp = my_index (optstring, c);
670
671 /* Increment `GNoptind' when we start to process its last character. */
672 if (*nextchar == '\0')
673 ++GNoptind;
674
675 if ((temp == NULL) || (c == ':'))
676 {
677 if (GNopterr)
678 {
679 if (posixly_correct)
680 /* 1003.2 specifies the format of this message. */
681 fprintf (stderr, _ ("%s: illegal option -- %c\n"), argv[0], c);
682 else
683 fprintf (stderr, _ ("%s: invalid option -- %c\n"), argv[0], c);
684 }
685 return '?';
686 }
687 /* Convenience. Treat POSIX -W foo same as long option --foo */
688 if ((temp[0] == 'W') && (temp[1] == ';'))
689 {
690 char *nameend;
691 const struct GNoption *p;
692 const struct GNoption *pfound = NULL;
693 int exact = 0;
694 int ambig = 0;
695 int indfound = 0;
696 int option_index;
697
698 /* This is an option that requires an argument. */
699 if (*nextchar != '\0')
700 {
702 /* If we end this ARGV-element by taking the rest as an arg,
703 * we must advance to the next element now. */
704 GNoptind++;
705 }
706 else if (GNoptind == argc)
707 {
708 if (GNopterr)
709 {
710 /* 1003.2 specifies the format of this message. */
711 fprintf (stderr,
712 _ ("%s: option requires an argument -- %c\n"),
713 argv[0],
714 c);
715 }
716 if (optstring[0] == ':')
717 c = ':';
718 else
719 c = '?';
720 return c;
721 }
722 else
723 /* We already incremented `GNoptind' once;
724 * increment it again when taking next ARGV-elt as argument. */
725 GNoptarg = argv[GNoptind++];
726
727 /* GNoptarg is now the argument, see if it's in the
728 * table of longopts. */
729
730 for (nextchar = nameend = GNoptarg; *nameend && *nameend != '=';
731 nameend++)
732 /* Do nothing. */;
733
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))
739 {
740 if ((unsigned int) (nameend - nextchar) == strlen (p->name))
741 {
742 /* Exact match found. */
743 pfound = p;
744 indfound = option_index;
745 exact = 1;
746 break;
747 }
748 else if (pfound == NULL)
749 {
750 /* First nonexact match found. */
751 pfound = p;
752 indfound = option_index;
753 }
754 else
755 /* Second or later nonexact match found. */
756 ambig = 1;
757 }
758 if (ambig && ! exact)
759 {
760 if (GNopterr)
761 fprintf (stderr,
762 _ ("%s: option `-W %s' is ambiguous\n"),
763 argv[0],
764 argv[GNoptind]);
765 nextchar += strlen (nextchar);
766 GNoptind++;
767 return '?';
768 }
769 if (pfound != NULL)
770 {
771 option_index = indfound;
772 if (*nameend)
773 {
774 /* Don't test has_arg with >, because some C compilers don't
775 * allow it to be used on enums. */
776 if (pfound->has_arg)
777 GNoptarg = nameend + 1;
778 else
779 {
780 if (GNopterr)
781 fprintf (stderr,
782 _ ("%s: option `-W %s' does not allow an argument\n"),
783 argv[0],
784 pfound->name);
785
786 nextchar += strlen (nextchar);
787 return '?';
788 }
789 }
790 else if (pfound->has_arg == 1)
791 {
792 if (GNoptind < argc)
793 GNoptarg = argv[GNoptind++];
794 else
795 {
796 if (GNopterr)
797 fprintf (stderr,
798 _ ("%s: option `%s' requires an argument\n"),
799 argv[0],
800 argv[GNoptind - 1]);
801 nextchar += strlen (nextchar);
802 return optstring[0] == ':' ? ':' : '?';
803 }
804 }
805 nextchar += strlen (nextchar);
806 if (longind != NULL)
807 *longind = option_index;
808 if (pfound->flag)
809 {
810 *(pfound->flag) = pfound->val;
811 return 0;
812 }
813 return pfound->val;
814 }
815 nextchar = NULL;
816 return 'W'; /* Let the application handle it. */
817 }
818 if (temp[1] == ':')
819 {
820 if (temp[2] == ':')
821 {
822 /* This is an option that accepts an argument optionally. */
823 if (*nextchar != '\0')
824 {
826 GNoptind++;
827 }
828 else
829 GNoptarg = NULL;
830 nextchar = NULL;
831 }
832 else
833 {
834 /* This is an option that requires an argument. */
835 if (*nextchar != '\0')
836 {
838 /* If we end this ARGV-element by taking the rest as an arg,
839 * we must advance to the next element now. */
840 GNoptind++;
841 }
842 else if (GNoptind == argc)
843 {
844 if (GNopterr)
845 {
846 /* 1003.2 specifies the format of this message. */
847 fprintf (stderr,
848 _ ("%s: option requires an argument -- %c\n"),
849 argv[0],
850 c);
851 }
852 if (optstring[0] == ':')
853 c = ':';
854 else
855 c = '?';
856 }
857 else
858 /* We already incremented `GNoptind' once;
859 * increment it again when taking next ARGV-elt as argument. */
860 GNoptarg = argv[GNoptind++];
861 nextchar = NULL;
862 }
863 }
864 return c;
865 }
866}
867
868
869static int
871 char *const *argv,
872 const char *options,
873 const struct GNoption *long_options,
874 int *opt_index)
875{
876 return GN_getopt_internal (argc, argv, options, long_options, opt_index, 0);
877}
878
879
880/* ******************** now the GNUnet specific modifications... ********************* */
881
882
883int
884GNUNET_GETOPT_run (const char *binaryOptions,
885 const struct GNUNET_GETOPT_CommandLineOption *allOptions,
886 unsigned int argc,
887 char *const *argv)
888{
889 struct GNoption *long_options;
891 int count;
892 char *shorts;
893 int spos;
895 uint8_t *seen;
896 unsigned int optmatch = 0;
897 const char *have_exclusive = NULL;
898
899 GNUNET_assert (argc > 0);
900 GNoptind = 0;
901 clpc.binaryName = argv[0];
903 clpc.allOptions = allOptions;
904 clpc.argv = argv;
905 clpc.argc = argc;
906 for (count = 0; NULL != allOptions[count].name; count++)
907 ;
908
909 /* transform our option representation into the format
910 used by the GNU getopt copylib */
911 long_options = GNUNET_new_array (count + 1, struct GNoption);
912 seen = GNUNET_new_array (count, uint8_t);
913 shorts = GNUNET_malloc (count * 2 + 1);
914 spos = 0;
915 for (unsigned i = 0; i < count; i++)
916 {
917 long_options[i].name = allOptions[i].name;
918 long_options[i].has_arg = allOptions[i].require_argument;
919 long_options[i].flag = NULL;
920 long_options[i].val = allOptions[i].shortName;
921 shorts[spos++] = allOptions[i].shortName;
922 if (allOptions[i].require_argument != 0)
923 shorts[spos++] = ':';
924 }
925 long_options[count].name = NULL;
926 long_options[count].has_arg = 0;
927 long_options[count].flag = NULL;
928 long_options[count].val = '\0';
929 shorts[spos] = '\0';
930 cont = GNUNET_OK;
931
932 /* main getopt loop */
933 while (1)
934 {
935 int option_index = 0;
936 unsigned int i;
937 int c;
938
939 c = GNgetopt_long (argc,
940 argv,
941 shorts,
942 long_options,
943 &option_index);
944 if (c == GNUNET_SYSERR)
945 break; /* No more flags to process */
946
947 /* Check which of our program's options was given by the user */
948 for (i = 0; i < count; i++)
949 {
950 clpc.currentArgument = GNoptind - 1;
951 if ((char) c == allOptions[i].shortName)
952 {
953 optmatch++;
954 if (allOptions[i].option_exclusive)
955 have_exclusive = allOptions[i].name;
956 if (GNUNET_OK == cont)
957 {
958 /* parse the option using the option-specific processor */
959 cont = allOptions[i].processor (&clpc,
960 allOptions[i].scls,
961 allOptions[i].name,
962 GNoptarg);
963 }
964 seen[i] = 1;
965 break;
966 }
967 }
968 if (i == count)
969 {
970 fprintf (stderr,
971 _ ("Use %s to get a list of options.\n"),
972 "--help");
973 cont = GNUNET_SYSERR;
974 }
975 }
976 GNUNET_free (shorts);
977 GNUNET_free (long_options);
978
979 /* check that if any option that was marked as exclusive
980 is the only option that was provided */
981 if ((NULL != have_exclusive) && (optmatch > 1))
982 {
983 fprintf (stderr,
984 _ ("Option `%s' can't be used with other options.\n"),
985 have_exclusive);
986 cont = GNUNET_SYSERR;
987 }
988 if (GNUNET_YES == cont)
989 {
990 /* check that all mandatory options are present */
991 for (count = 0; NULL != allOptions[count].name; count++)
992 {
993 if ((0 == seen[count]) && (allOptions[count].option_mandatory))
994 {
995 fprintf (stderr,
996 _ ("Missing mandatory option `%s'.\n"),
997 allOptions[count].name);
998 cont = GNUNET_SYSERR;
999 }
1000 }
1001 }
1002 GNUNET_free (seen);
1003
1004 /* call cleaners, if available */
1005 for (unsigned int i = 0; NULL != allOptions[i].name; i++)
1006 if (NULL != allOptions[i].cleaner)
1007 allOptions[i].cleaner (allOptions[i].scls);
1008
1009 if (GNUNET_OK != cont)
1010 return cont;
1011 return GNoptind;
1012}
1013
1014
1015/* end of getopt.c */
struct GNUNET_GETOPT_CommandLineOption options[]
Definition: 002.c:5
static int GNoptind
Definition: getopt.c:134
static int GNgetopt_long(int argc, char *const *argv, const char *options, const struct GNoption *long_options, int *opt_index)
Definition: getopt.c:870
static char * GNoptarg
Definition: getopt.c:119
@ REQUIRE_ORDER
Definition: getopt.c:175
@ RETURN_IN_ORDER
Definition: getopt.c:175
@ PERMUTE
Definition: getopt.c:175
static void exchange(char **argv)
Definition: getopt.c:251
static char * nextchar
Definition: getopt.c:143
static const char * _getopt_initialize(int argc, char *const *argv, const char *optstring)
Definition: getopt.c:316
static char * my_index(const char *str, int chr)
Definition: getopt.c:196
static int last_nonopt
Definition: getopt.c:231
static int GN_getopt_internal(int argc, char *const *argv, const char *optstring, const struct GNoption *longopts, int *longind, int long_only)
Definition: getopt.c:406
#define SWAP_FLAGS(ch1, ch2)
Definition: getopt.c:233
#define NONOPTION_P
static int first_nonopt
Definition: getopt.c:230
#define _(msgid)
Definition: getopt.c:63
static enum @36 ordering
char * getenv()
static char * posixly_correct
Definition: getopt.c:178
static char * name
Name (label) of the records to list.
static struct GNUNET_OS_Process * p
Helper process we started.
Definition: gnunet-uri.c:38
int GNUNET_GETOPT_run(const char *binaryOptions, const struct GNUNET_GETOPT_CommandLineOption *allOptions, unsigned int argc, char *const *argv)
Parse the command line.
Definition: getopt.c:884
GNUNET_GenericReturnValue
Named constants for return values.
@ GNUNET_OK
@ GNUNET_YES
@ GNUNET_SYSERR
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define GNUNET_malloc(size)
Wrapper around malloc.
#define GNUNET_new_array(n, type)
Allocate a size n array with structs or unions of the given type.
#define GNUNET_free(ptr)
Wrapper around free.
Definition of a command line option.
int require_argument
Is an argument required? GNUNET_NO (includes optional) or GNUNET_YES (required)
const char * name
Long name of the option (may not be NULL)
GNUNET_GETOPT_CommandLineOptionProcessor processor
Handler for the option.
const char shortName
Short name of the option.
void(* cleaner)(void *cls)
Function to call on scls to clean up after processing all the arguments.
General context for command line processors.
const char * binaryName
Name of the application.
const char * binaryOptions
Name of application with option summary.
const struct GNUNET_GETOPT_CommandLineOption * allOptions
Array with all command line options.
char *const * argv
Original command line.
unsigned int argc
Total number of argv's.
unsigned int currentArgument
Current argument.
int has_arg
Definition: getopt.c:93
int val
Definition: getopt.c:95
const char * name
Definition: getopt.c:90
int * flag
Definition: getopt.c:94