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