Mercurial > emacs
annotate lib-src/getopt_int.h @ 84392:a796776e3ec3
*** empty log message ***
author | Carsten Dominik <dominik@science.uva.nl> |
---|---|
date | Sat, 08 Sep 2007 04:40:00 +0000 |
parents | 1f2482de3237 |
children | ef719132ddfa |
rev | line source |
---|---|
64639
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
1 /* Internal declarations for getopt. |
64769
6358e3c6075c
Update years in copyright notice; nfc.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents:
64642
diff
changeset
|
2 Copyright (C) 1989, 1990, 1991, 1992, 1993, 1994, 1996, 1997, 1998, 1999, |
75348 | 3 2001, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc. |
64639
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
4 This file is part of the GNU C Library. |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
5 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
6 This program is free software; you can redistribute it and/or modify |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
7 it under the terms of the GNU General Public License as published by |
78257
1f2482de3237
Switch license to GPLv3 or later.
Glenn Morris <rgm@gnu.org>
parents:
75348
diff
changeset
|
8 the Free Software Foundation; either version 3, or (at your option) |
64639
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
9 any later version. |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
10 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
11 This program is distributed in the hope that it will be useful, |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
12 but WITHOUT ANY WARRANTY; without even the implied warranty of |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
14 GNU General Public License for more details. |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
15 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
16 You should have received a copy of the GNU General Public License along |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
17 with this program; if not, write to the Free Software Foundation, |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
18 Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
19 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
20 #ifndef _GETOPT_INT_H |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
21 #define _GETOPT_INT_H 1 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
22 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
23 extern int _getopt_internal (int ___argc, char **___argv, |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
24 const char *__shortopts, |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
25 const struct option *__longopts, int *__longind, |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
26 int __long_only, int __posixly_correct); |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
27 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
28 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
29 /* Reentrant versions which can handle parsing multiple argument |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
30 vectors at the same time. */ |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
31 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
32 /* Data type for reentrant functions. */ |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
33 struct _getopt_data |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
34 { |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
35 /* These have exactly the same meaning as the corresponding global |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
36 variables, except that they are used for the reentrant |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
37 versions of getopt. */ |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
38 int optind; |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
39 int opterr; |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
40 int optopt; |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
41 char *optarg; |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
42 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
43 /* Internal members. */ |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
44 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
45 /* True if the internal members have been initialized. */ |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
46 int __initialized; |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
47 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
48 /* The next char to be scanned in the option-element |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
49 in which the last option character we returned was found. |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
50 This allows us to pick up the scan where we left off. |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
51 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
52 If this is zero, or a null string, it means resume the scan |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
53 by advancing to the next ARGV-element. */ |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
54 char *__nextchar; |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
55 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
56 /* Describe how to deal with options that follow non-option ARGV-elements. |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
57 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
58 If the caller did not specify anything, |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
59 the default is REQUIRE_ORDER if the environment variable |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
60 POSIXLY_CORRECT is defined, PERMUTE otherwise. |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
61 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
62 REQUIRE_ORDER means don't recognize them as options; |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
63 stop option processing when the first non-option is seen. |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
64 This is what Unix does. |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
65 This mode of operation is selected by either setting the environment |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
66 variable POSIXLY_CORRECT, or using `+' as the first character |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
67 of the list of option characters, or by calling getopt. |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
68 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
69 PERMUTE is the default. We permute the contents of ARGV as we |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
70 scan, so that eventually all the non-options are at the end. |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
71 This allows options to be given in any order, even with programs |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
72 that were not written to expect this. |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
73 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
74 RETURN_IN_ORDER is an option available to programs that were |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
75 written to expect options and other ARGV-elements in any order |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
76 and that care about the ordering of the two. We describe each |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
77 non-option ARGV-element as if it were the argument of an option |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
78 with character code 1. Using `-' as the first character of the |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
79 list of option characters selects this mode of operation. |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
80 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
81 The special argument `--' forces an end of option-scanning regardless |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
82 of the value of `ordering'. In the case of RETURN_IN_ORDER, only |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
83 `--' can cause `getopt' to return -1 with `optind' != ARGC. */ |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
84 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
85 enum |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
86 { |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
87 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
88 } __ordering; |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
89 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
90 /* If the POSIXLY_CORRECT environment variable is set |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
91 or getopt was called. */ |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
92 int __posixly_correct; |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
93 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
94 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
95 /* Handle permutation of arguments. */ |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
96 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
97 /* Describe the part of ARGV that contains non-options that have |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
98 been skipped. `first_nonopt' is the index in ARGV of the first |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
99 of them; `last_nonopt' is the index after the last of them. */ |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
100 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
101 int __first_nonopt; |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
102 int __last_nonopt; |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
103 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
104 #if defined _LIBC && defined USE_NONOPTION_FLAGS |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
105 int __nonoption_flags_max_len; |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
106 int __nonoption_flags_len; |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
107 # endif |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
108 }; |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
109 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
110 /* The initializer is necessary to set OPTIND and OPTERR to their |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
111 default values and to clear the initialization flag. */ |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
112 #define _GETOPT_DATA_INITIALIZER { 1, 1 } |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
113 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
114 extern int _getopt_internal_r (int ___argc, char **___argv, |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
115 const char *__shortopts, |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
116 const struct option *__longopts, int *__longind, |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
117 int __long_only, int __posixly_correct, |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
118 struct _getopt_data *__data); |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
119 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
120 extern int _getopt_long_r (int ___argc, char **___argv, |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
121 const char *__shortopts, |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
122 const struct option *__longopts, int *__longind, |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
123 struct _getopt_data *__data); |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
124 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
125 extern int _getopt_long_only_r (int ___argc, char **___argv, |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
126 const char *__shortopts, |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
127 const struct option *__longopts, |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
128 int *__longind, |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
129 struct _getopt_data *__data); |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
130 |
385af3e03206
Merge gnulib getopt implementation into Emacs.
Paul Eggert <eggert@twinsun.com>
parents:
diff
changeset
|
131 #endif /* getopt_int.h */ |
64642 | 132 |
133 /* arch-tag: 8bfc548f-23d6-46aa-b5b5-2739b0edaf79 | |
134 (do not change this comment) */ |