Fixed some focus related problems when switching workspaces, including the
[wmaker-crm.git] / plugins / libwmfun / getopt.c
blob45461a48a902bae73362fcd7bcaad22f111772f7
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!
6 Copyright (C) 1987, 88, 89, 90, 91, 92, 93, 94
7 Free Software Foundation, Inc.
9 This program is free software; you can redistribute it and/or modify it
10 under the terms of the GNU General Public License as published by the
11 Free Software Foundation; either version 2, or (at your option) any
12 later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details. */
19 /* This tells Alpha OSF/1 not to define a getopt prototype in <stdio.h>.
20 Ditto for AIX 3.2 and <stdlib.h>. */
21 #ifndef _NO_PROTO
22 #define _NO_PROTO
23 #endif
25 #ifndef __STDC__
26 /* This is a separate conditional since some stdc systems
27 reject `defined (const)'. */
28 #ifndef const
29 #define const
30 #endif
31 #endif
33 #include <stdio.h>
35 #ifdef HAVE_STRING_H
36 #include <string.h>
37 #endif
39 /* Comment out all this code if we are using the GNU C Library, and are not
40 actually compiling the library itself. This code is part of the GNU C
41 Library, but also included in many other GNU distributions. Compiling
42 and linking in this code is a waste when using the GNU C library
43 (especially if it is a shared library). Rather than having every GNU
44 program understand `configure --with-gnu-libc' and omit the object files,
45 it is simpler to just do this in the source for each such file. */
47 #if defined (_LIBC) || !defined (__GNU_LIBRARY__)
50 /* This needs to come after some library #include
51 to get __GNU_LIBRARY__ defined. */
52 #ifdef __GNU_LIBRARY__
53 /* Don't include stdlib.h for non-GNU C libraries because some of them
54 contain conflicting prototypes for getopt. */
55 #include <stdlib.h>
56 #endif /* GNU C library. */
58 /* This version of `getopt' appears to the caller like standard Unix `getopt'
59 but it behaves differently for the user, since it allows the user
60 to intersperse the options with the other arguments.
62 As `getopt' works, it permutes the elements of ARGV so that,
63 when it is done, all the options precede everything else. Thus
64 all application programs are extended to handle flexible argument order.
66 Setting the environment variable POSIXLY_CORRECT disables permutation.
67 Then the behavior is completely standard.
69 GNU application programs can use a third alternative mode in which
70 they can distinguish the relative order of options and other arguments. */
72 #include "getopt.h"
74 /* For communication from `getopt' to the caller.
75 When `getopt' finds an option that takes an argument,
76 the argument value is returned here.
77 Also, when `ordering' is RETURN_IN_ORDER,
78 each non-option ARGV-element is returned here. */
80 char *optarg = NULL;
82 /* Index in ARGV of the next element to be scanned.
83 This is used for communication to and from the caller
84 and for communication between successive calls to `getopt'.
86 On entry to `getopt', zero means this is the first call; initialize.
88 When `getopt' returns EOF, this is the index of the first of the
89 non-option elements that the caller should itself scan.
91 Otherwise, `optind' communicates from one call to the next
92 how much of ARGV has been scanned so far. */
94 /* XXX 1003.2 says this must be 1 before any call. */
95 int optind = 0;
97 /* The next char to be scanned in the option-element
98 in which the last option character we returned was found.
99 This allows us to pick up the scan where we left off.
101 If this is zero, or a null string, it means resume the scan
102 by advancing to the next ARGV-element. */
104 static char *nextchar;
106 /* Callers store zero here to inhibit the error message
107 for unrecognized options. */
109 int opterr = 1;
111 /* Set to an option character which was unrecognized.
112 This must be initialized on some systems to avoid linking in the
113 system's own getopt implementation. */
115 int optopt = '?';
117 /* Describe how to deal with options that follow non-option ARGV-elements.
119 If the caller did not specify anything,
120 the default is REQUIRE_ORDER if the environment variable
121 POSIXLY_CORRECT is defined, PERMUTE otherwise.
123 REQUIRE_ORDER means don't recognize them as options;
124 stop option processing when the first non-option is seen.
125 This is what Unix does.
126 This mode of operation is selected by either setting the environment
127 variable POSIXLY_CORRECT, or using `+' as the first character
128 of the list of option characters.
130 PERMUTE is the default. We permute the contents of ARGV as we scan,
131 so that eventually all the non-options are at the end. This allows options
132 to be given in any order, even with programs that were not written to
133 expect this.
135 RETURN_IN_ORDER is an option available to programs that were written
136 to expect options and other ARGV-elements in any order and that care about
137 the ordering of the two. We describe each non-option ARGV-element
138 as if it were the argument of an option with character code 1.
139 Using `-' as the first character of the list of option characters
140 selects this mode of operation.
142 The special argument `--' forces an end of option-scanning regardless
143 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
144 `--' can cause `getopt' to return EOF with `optind' != ARGC. */
146 static enum
148 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
149 } ordering;
151 /* Value of POSIXLY_CORRECT environment variable. */
152 static char *posixly_correct;
154 #ifdef __GNU_LIBRARY__
155 /* We want to avoid inclusion of string.h with non-GNU libraries
156 because there are many ways it can cause trouble.
157 On some systems, it contains special magic macros that don't work
158 in GCC. */
159 #include <string.h>
160 #define my_index strchr
161 #else
163 /* Avoid depending on library functions or files
164 whose names are inconsistent. */
166 char *getenv ();
168 static char *
169 my_index (str, chr)
170 const char *str;
171 int chr;
173 while (*str)
175 if (*str == chr)
176 return (char *) str;
177 str++;
179 return 0;
182 /* If using GCC, we can safely declare strlen this way.
183 If not using GCC, it is ok not to declare it. */
184 #ifdef __GNUC__
185 /* Note that Motorola Delta 68k R3V7 comes with GCC but not stddef.h.
186 That was relevant to code that was here before. */
187 #ifndef __STDC__
188 /* gcc with -traditional declares the built-in strlen to return int,
189 and has done so at least since version 2.4.5. -- rms. */
190 extern int strlen (const char *);
191 #endif /* not __STDC__ */
192 #endif /* __GNUC__ */
194 #endif /* not __GNU_LIBRARY__ */
196 /* Handle permutation of arguments. */
198 /* Describe the part of ARGV that contains non-options that have
199 been skipped. `first_nonopt' is the index in ARGV of the first of them;
200 `last_nonopt' is the index after the last of them. */
202 static int first_nonopt;
203 static int last_nonopt;
205 /* Exchange two adjacent subsequences of ARGV.
206 One subsequence is elements [first_nonopt,last_nonopt)
207 which contains all the non-options that have been skipped so far.
208 The other is elements [last_nonopt,optind), which contains all
209 the options processed since those non-options were skipped.
211 `first_nonopt' and `last_nonopt' are relocated so that they describe
212 the new indices of the non-options in ARGV after they are moved. */
214 static void
215 exchange (argv)
216 char **argv;
218 int bottom = first_nonopt;
219 int middle = last_nonopt;
220 int top = optind;
221 char *tem;
223 /* Exchange the shorter segment with the far end of the longer segment.
224 That puts the shorter segment into the right place.
225 It leaves the longer segment in the right place overall,
226 but it consists of two parts that need to be swapped next. */
228 while (top > middle && middle > bottom)
230 if (top - middle > middle - bottom)
232 /* Bottom segment is the short one. */
233 int len = middle - bottom;
234 register int i;
236 /* Swap it with the top part of the top segment. */
237 for (i = 0; i < len; i++)
239 tem = argv[bottom + i];
240 argv[bottom + i] = argv[top - (middle - bottom) + i];
241 argv[top - (middle - bottom) + i] = tem;
243 /* Exclude the moved bottom segment from further swapping. */
244 top -= len;
246 else
248 /* Top segment is the short one. */
249 int len = top - middle;
250 register int i;
252 /* Swap it with the bottom part of the bottom segment. */
253 for (i = 0; i < len; i++)
255 tem = argv[bottom + i];
256 argv[bottom + i] = argv[middle + i];
257 argv[middle + i] = tem;
259 /* Exclude the moved top segment from further swapping. */
260 bottom += len;
264 /* Update records for the slots the non-options now occupy. */
266 first_nonopt += (optind - last_nonopt);
267 last_nonopt = optind;
270 /* Initialize the internal data when the first call is made. */
272 static const char *
273 _getopt_initialize (optstring)
274 const char *optstring;
276 /* Start processing options with ARGV-element 1 (since ARGV-element 0
277 is the program name); the sequence of previously skipped
278 non-option ARGV-elements is empty. */
280 first_nonopt = last_nonopt = optind = 1;
282 nextchar = NULL;
284 posixly_correct = getenv ("POSIXLY_CORRECT");
286 /* Determine how to handle the ordering of options and nonoptions. */
288 if (optstring[0] == '-')
290 ordering = RETURN_IN_ORDER;
291 ++optstring;
293 else if (optstring[0] == '+')
295 ordering = REQUIRE_ORDER;
296 ++optstring;
298 else if (posixly_correct != NULL)
299 ordering = REQUIRE_ORDER;
300 else
301 ordering = PERMUTE;
303 return optstring;
306 /* Scan elements of ARGV (whose length is ARGC) for option characters
307 given in OPTSTRING.
309 If an element of ARGV starts with '-', and is not exactly "-" or "--",
310 then it is an option element. The characters of this element
311 (aside from the initial '-') are option characters. If `getopt'
312 is called repeatedly, it returns successively each of the option characters
313 from each of the option elements.
315 If `getopt' finds another option character, it returns that character,
316 updating `optind' and `nextchar' so that the next call to `getopt' can
317 resume the scan with the following option character or ARGV-element.
319 If there are no more option characters, `getopt' returns `EOF'.
320 Then `optind' is the index in ARGV of the first ARGV-element
321 that is not an option. (The ARGV-elements have been permuted
322 so that those that are not options now come last.)
324 OPTSTRING is a string containing the legitimate option characters.
325 If an option character is seen that is not listed in OPTSTRING,
326 return '?' after printing an error message. If you set `opterr' to
327 zero, the error message is suppressed but we still return '?'.
329 If a char in OPTSTRING is followed by a colon, that means it wants an arg,
330 so the following text in the same ARGV-element, or the text of the following
331 ARGV-element, is returned in `optarg'. Two colons mean an option that
332 wants an optional arg; if there is text in the current ARGV-element,
333 it is returned in `optarg', otherwise `optarg' is set to zero.
335 If OPTSTRING starts with `-' or `+', it requests different methods of
336 handling the non-option ARGV-elements.
337 See the comments about RETURN_IN_ORDER and REQUIRE_ORDER, above.
339 Long-named options begin with `--' instead of `-'.
340 Their names may be abbreviated as long as the abbreviation is unique
341 or is an exact match for some defined option. If they have an
342 argument, it follows the option name in the same ARGV-element, separated
343 from the option name by a `=', or else the in next ARGV-element.
344 When `getopt' finds a long-named option, it returns 0 if that option's
345 `flag' field is nonzero, the value of the option's `val' field
346 if the `flag' field is zero.
348 The elements of ARGV aren't really const, because we permute them.
349 But we pretend they're const in the prototype to be compatible
350 with other systems.
352 LONGOPTS is a vector of `struct option' terminated by an
353 element containing a name which is zero.
355 LONGIND returns the index in LONGOPT of the long-named option found.
356 It is only valid when a long-named option has been found by the most
357 recent call.
359 If LONG_ONLY is nonzero, '-' as well as '--' can introduce
360 long-named options. */
363 _getopt_internal (argc, argv, optstring, longopts, longind, long_only)
364 int argc;
365 char *const *argv;
366 const char *optstring;
367 const struct option *longopts;
368 int *longind;
369 int long_only;
371 optarg = NULL;
373 if (optind == 0)
374 optstring = _getopt_initialize (optstring);
376 if (nextchar == NULL || *nextchar == '\0')
378 /* Advance to the next ARGV-element. */
380 if (ordering == PERMUTE)
382 /* If we have just processed some options following some non-options,
383 exchange them so that the options come first. */
385 if (first_nonopt != last_nonopt && last_nonopt != optind)
386 exchange ((char **) argv);
387 else if (last_nonopt != optind)
388 first_nonopt = optind;
390 /* Skip any additional non-options
391 and extend the range of non-options previously skipped. */
393 while (optind < argc
394 && (argv[optind][0] != '-' || argv[optind][1] == '\0'))
395 optind++;
396 last_nonopt = optind;
399 /* The special ARGV-element `--' means premature end of options.
400 Skip it like a null option,
401 then exchange with previous non-options as if it were an option,
402 then skip everything else like a non-option. */
404 if (optind != argc && !strcmp (argv[optind], "--"))
406 optind++;
408 if (first_nonopt != last_nonopt && last_nonopt != optind)
409 exchange ((char **) argv);
410 else if (first_nonopt == last_nonopt)
411 first_nonopt = optind;
412 last_nonopt = argc;
414 optind = argc;
417 /* If we have done all the ARGV-elements, stop the scan
418 and back over any non-options that we skipped and permuted. */
420 if (optind == argc)
422 /* Set the next-arg-index to point at the non-options
423 that we previously skipped, so the caller will digest them. */
424 if (first_nonopt != last_nonopt)
425 optind = first_nonopt;
426 return EOF;
429 /* If we have come to a non-option and did not permute it,
430 either stop the scan or describe it to the caller and pass it by. */
432 if ((argv[optind][0] != '-' || argv[optind][1] == '\0'))
434 if (ordering == REQUIRE_ORDER)
435 return EOF;
436 optarg = argv[optind++];
437 return 1;
440 /* We have found another option-ARGV-element.
441 Skip the initial punctuation. */
443 nextchar = (argv[optind] + 1
444 + (longopts != NULL && argv[optind][1] == '-'));
447 /* Decode the current option-ARGV-element. */
449 /* Check whether the ARGV-element is a long option.
451 If long_only and the ARGV-element has the form "-f", where f is
452 a valid short option, don't consider it an abbreviated form of
453 a long option that starts with f. Otherwise there would be no
454 way to give the -f short option.
456 On the other hand, if there's a long option "fubar" and
457 the ARGV-element is "-fu", do consider that an abbreviation of
458 the long option, just like "--fu", and not "-f" with arg "u".
460 This distinction seems to be the most useful approach. */
462 if (longopts != NULL
463 && (argv[optind][1] == '-'
464 || (long_only && (argv[optind][2] || !my_index (optstring, argv[optind][1])))))
466 char *nameend;
467 const struct option *p;
468 const struct option *pfound = NULL;
469 int exact = 0;
470 int ambig = 0;
471 int indfound;
472 int option_index;
474 for (nameend = nextchar; *nameend && *nameend != '='; nameend++)
475 /* Do nothing. */ ;
477 /* Test all long options for either exact match
478 or abbreviated matches. */
479 for (p = longopts, option_index = 0; p->name; p++, option_index++)
480 if (!strncmp (p->name, nextchar, nameend - nextchar))
482 if (nameend - nextchar == (int) strlen (p->name))
484 /* Exact match found. */
485 pfound = p;
486 indfound = option_index;
487 exact = 1;
488 break;
490 else if (pfound == NULL)
492 /* First nonexact match found. */
493 pfound = p;
494 indfound = option_index;
496 else
497 /* Second or later nonexact match found. */
498 ambig = 1;
501 if (ambig && !exact)
503 if (opterr)
504 fprintf (stderr, "%s: option `%s' is ambiguous\n",
505 argv[0], argv[optind]);
506 nextchar += strlen (nextchar);
507 optind++;
508 return '?';
511 if (pfound != NULL)
513 option_index = indfound;
514 optind++;
515 if (*nameend)
517 /* Don't test has_arg with >, because some C compilers don't
518 allow it to be used on enums. */
519 if (pfound->has_arg)
520 optarg = nameend + 1;
521 else
523 if (opterr)
525 if (argv[optind - 1][1] == '-')
526 /* --option */
527 fprintf (stderr,
528 "%s: option `--%s' doesn't allow an argument\n",
529 argv[0], pfound->name);
530 else
531 /* +option or -option */
532 fprintf (stderr,
533 "%s: option `%c%s' doesn't allow an argument\n",
534 argv[0], argv[optind - 1][0], pfound->name);
536 nextchar += strlen (nextchar);
537 return '?';
540 else if (pfound->has_arg == 1)
542 if (optind < argc)
543 optarg = argv[optind++];
544 else
546 if (opterr)
547 fprintf (stderr, "%s: option `%s' requires an argument\n",
548 argv[0], argv[optind - 1]);
549 nextchar += strlen (nextchar);
550 return optstring[0] == ':' ? ':' : '?';
553 nextchar += strlen (nextchar);
554 if (longind != NULL)
555 *longind = option_index;
556 if (pfound->flag)
558 *(pfound->flag) = pfound->val;
559 return 0;
561 return pfound->val;
564 /* Can't find it as a long option. If this is not getopt_long_only,
565 or the option starts with '--' or is not a valid short
566 option, then it's an error.
567 Otherwise interpret it as a short option. */
568 if (!long_only || argv[optind][1] == '-'
569 || my_index (optstring, *nextchar) == NULL)
571 if (opterr)
573 if (argv[optind][1] == '-')
574 /* --option */
575 fprintf (stderr, "%s: unrecognized option `--%s'\n",
576 argv[0], nextchar);
577 else
578 /* +option or -option */
579 fprintf (stderr, "%s: unrecognized option `%c%s'\n",
580 argv[0], argv[optind][0], nextchar);
582 nextchar = (char *) "";
583 optind++;
584 return '?';
588 /* Look at and handle the next short option-character. */
591 char c = *nextchar++;
592 char *temp = my_index (optstring, c);
594 /* Increment `optind' when we start to process its last character. */
595 if (*nextchar == '\0')
596 ++optind;
598 if (temp == NULL || c == ':')
600 if (opterr)
602 if (posixly_correct)
603 /* 1003.2 specifies the format of this message. */
604 fprintf (stderr, "%s: illegal option -- %c\n", argv[0], c);
605 else
606 fprintf (stderr, "%s: invalid option -- %c\n", argv[0], c);
608 optopt = c;
609 return '?';
611 if (temp[1] == ':')
613 if (temp[2] == ':')
615 /* This is an option that accepts an argument optionally. */
616 if (*nextchar != '\0')
618 optarg = nextchar;
619 optind++;
621 else
622 optarg = NULL;
623 nextchar = NULL;
625 else
627 /* This is an option that requires an argument. */
628 if (*nextchar != '\0')
630 optarg = nextchar;
631 /* If we end this ARGV-element by taking the rest as an arg,
632 we must advance to the next element now. */
633 optind++;
635 else if (optind == argc)
637 if (opterr)
639 /* 1003.2 specifies the format of this message. */
640 fprintf (stderr, "%s: option requires an argument -- %c\n",
641 argv[0], c);
643 optopt = c;
644 if (optstring[0] == ':')
645 c = ':';
646 else
647 c = '?';
649 else
650 /* We already incremented `optind' once;
651 increment it again when taking next ARGV-elt as argument. */
652 optarg = argv[optind++];
653 nextchar = NULL;
656 return c;
661 getopt (argc, argv, optstring)
662 int argc;
663 char *const *argv;
664 const char *optstring;
666 return _getopt_internal (argc, argv, optstring,
667 (const struct option *) 0,
668 (int *) 0,
672 #endif /* _LIBC or not __GNU_LIBRARY__. */
674 #ifdef TEST
676 /* Compile with -DTEST to make an executable for use in testing
677 the above definition of `getopt'. */
680 main (argc, argv)
681 int argc;
682 char **argv;
684 int c;
685 int digit_optind = 0;
687 while (1)
689 int this_option_optind = optind ? optind : 1;
691 c = getopt (argc, argv, "abc:d:0123456789");
692 if (c == EOF)
693 break;
695 switch (c)
697 case '0':
698 case '1':
699 case '2':
700 case '3':
701 case '4':
702 case '5':
703 case '6':
704 case '7':
705 case '8':
706 case '9':
707 if (digit_optind != 0 && digit_optind != this_option_optind)
708 printf ("digits occur in two different argv-elements.\n");
709 digit_optind = this_option_optind;
710 printf ("option %c\n", c);
711 break;
713 case 'a':
714 printf ("option a\n");
715 break;
717 case 'b':
718 printf ("option b\n");
719 break;
721 case 'c':
722 printf ("option c with value `%s'\n", optarg);
723 break;
725 case '?':
726 break;
728 default:
729 printf ("?? getopt returned character code 0%o ??\n", c);
733 if (optind < argc)
735 printf ("non-option ARGV-elements: ");
736 while (optind < argc)
737 printf ("%s ", argv[optind++]);
738 printf ("\n");
741 exit (0);
744 #endif /* TEST */