annotate lib/getopt_int.h @ 18029:e4a13d95b503

mgetgroups: port to strict OS X * doc/glibc-functions/getgrouplist.texi (getgrouplist): Document the getgrouplist problem. * lib/mgetgroups.c (getgrouplist_gids) [HAVE_GETGROUPLIST]: New macro. (mgetgroups): Use it. * m4/mgetgroups.m4 (gl_MGETGROUPS): Check for OS X signature for getgrouplist.
author Paul Eggert <eggert@cs.ucla.edu>
date Sun, 28 Jun 2015 23:43:35 -0700
parents ab58d4870664
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
1 /* Internal declarations for getopt.
17848
ab58d4870664 version-etc: new year
Paul Eggert <eggert@cs.ucla.edu>
parents: 17587
diff changeset
2 Copyright (C) 1989-1994, 1996-1999, 2001, 2003-2004, 2009-2015 Free Software
12559
c2cbabec01dd update nearly all FSF copyright year lists to include 2010
Jim Meyering <meyering@redhat.com>
parents: 12475
diff changeset
3 Foundation, Inc.
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
4 This file is part of the GNU C Library.
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
5
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 5848
diff changeset
6 This program is free software: you can redistribute it and/or modify
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
7 it under the terms of the GNU General Public License as published by
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 5848
diff changeset
8 the Free Software Foundation; either version 3 of the License, or
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 5848
diff changeset
9 (at your option) any later version.
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
10
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
11 This program is distributed in the hope that it will be useful,
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
14 GNU General Public License for more details.
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
15
9309
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 5848
diff changeset
16 You should have received a copy of the GNU General Public License
bbbbbf4cd1c5 Change copyright notice from GPLv2+ to GPLv3+.
Bruno Haible <bruno@clisp.org>
parents: 5848
diff changeset
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
18
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
19 #ifndef _GETOPT_INT_H
12421
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 12118
diff changeset
20 #define _GETOPT_INT_H 1
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
21
12118
ef31ab094483 getopt: avoid clash with FreeBSD _getopt_internal
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
22 #include <getopt.h>
ef31ab094483 getopt: avoid clash with FreeBSD _getopt_internal
Eric Blake <ebb9@byu.net>
parents: 9309
diff changeset
23
5453
d29dafc60cf3 Merge from coreutils to support a more-standard getopt.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5431
diff changeset
24 extern int _getopt_internal (int ___argc, char **___argv,
12421
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 12118
diff changeset
25 const char *__shortopts,
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 12118
diff changeset
26 const struct option *__longopts, int *__longind,
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 12118
diff changeset
27 int __long_only, int __posixly_correct);
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
28
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
29
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
30 /* Reentrant versions which can handle parsing multiple argument
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
31 vectors at the same time. */
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
32
13237
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
33 /* Describe how to deal with options that follow non-option ARGV-elements.
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
34
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
35 If the caller did not specify anything,
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
36 the default is REQUIRE_ORDER if the environment variable
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
37 POSIXLY_CORRECT is defined, PERMUTE otherwise.
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
38
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
39 REQUIRE_ORDER means don't recognize them as options;
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
40 stop option processing when the first non-option is seen.
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
41 This is what Unix does.
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
42 This mode of operation is selected by either setting the environment
16235
18a38c9615f0 In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
43 variable POSIXLY_CORRECT, or using '+' as the first character
13237
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
44 of the list of option characters, or by calling getopt.
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
45
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
46 PERMUTE is the default. We permute the contents of ARGV as we
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
47 scan, so that eventually all the non-options are at the end.
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
48 This allows options to be given in any order, even with programs
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
49 that were not written to expect this.
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
50
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
51 RETURN_IN_ORDER is an option available to programs that were
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
52 written to expect options and other ARGV-elements in any order
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
53 and that care about the ordering of the two. We describe each
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
54 non-option ARGV-element as if it were the argument of an option
16235
18a38c9615f0 In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
55 with character code 1. Using '-' as the first character of the
13237
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
56 list of option characters selects this mode of operation.
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
57
16235
18a38c9615f0 In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
58 The special argument '--' forces an end of option-scanning regardless
18a38c9615f0 In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
59 of the value of 'ordering'. In the case of RETURN_IN_ORDER, only
18a38c9615f0 In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
60 '--' can cause 'getopt' to return -1 with 'optind' != ARGC. */
13237
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
61
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
62 enum __ord
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
63 {
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
64 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
65 };
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
66
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
67 /* Data type for reentrant functions. */
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
68 struct _getopt_data
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
69 {
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
70 /* These have exactly the same meaning as the corresponding global
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
71 variables, except that they are used for the reentrant
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
72 versions of getopt. */
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
73 int optind;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
74 int opterr;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
75 int optopt;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
76 char *optarg;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
77
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
78 /* Internal members. */
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
79
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
80 /* True if the internal members have been initialized. */
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
81 int __initialized;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
82
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
83 /* The next char to be scanned in the option-element
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
84 in which the last option character we returned was found.
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
85 This allows us to pick up the scan where we left off.
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
86
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
87 If this is zero, or a null string, it means resume the scan
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
88 by advancing to the next ARGV-element. */
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
89 char *__nextchar;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
90
13237
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
91 /* See __ord above. */
15f9d5da394d getopt: allow compilation with C++
Eric Blake <eblake@redhat.com>
parents: 12559
diff changeset
92 enum __ord __ordering;
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
93
5453
d29dafc60cf3 Merge from coreutils to support a more-standard getopt.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5431
diff changeset
94 /* If the POSIXLY_CORRECT environment variable is set
d29dafc60cf3 Merge from coreutils to support a more-standard getopt.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5431
diff changeset
95 or getopt was called. */
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
96 int __posixly_correct;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
97
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
98
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
99 /* Handle permutation of arguments. */
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
100
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
101 /* Describe the part of ARGV that contains non-options that have
16235
18a38c9615f0 In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
102 been skipped. 'first_nonopt' is the index in ARGV of the first
18a38c9615f0 In commentary, do not use ` to quote.
Paul Eggert <eggert@cs.ucla.edu>
parents: 16201
diff changeset
103 of them; 'last_nonopt' is the index after the last of them. */
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
104
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
105 int __first_nonopt;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
106 int __last_nonopt;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
107
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
108 #if defined _LIBC && defined USE_NONOPTION_FLAGS
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
109 int __nonoption_flags_max_len;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
110 int __nonoption_flags_len;
14384
588ed4cdea87 Fix misindentation of preprocessor directives.
Bruno Haible <bruno@clisp.org>
parents: 14079
diff changeset
111 #endif
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
112 };
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
113
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
114 /* The initializer is necessary to set OPTIND and OPTERR to their
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
115 default values and to clear the initialization flag. */
12421
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 12118
diff changeset
116 #define _GETOPT_DATA_INITIALIZER { 1, 1 }
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
117
5453
d29dafc60cf3 Merge from coreutils to support a more-standard getopt.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5431
diff changeset
118 extern int _getopt_internal_r (int ___argc, char **___argv,
12421
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 12118
diff changeset
119 const char *__shortopts,
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 12118
diff changeset
120 const struct option *__longopts, int *__longind,
12475
93deb54acc5b getopt: synchronize from glibc
Eric Blake <ebb9@byu.net>
parents: 12421
diff changeset
121 int __long_only, struct _getopt_data *__data,
93deb54acc5b getopt: synchronize from glibc
Eric Blake <ebb9@byu.net>
parents: 12421
diff changeset
122 int __posixly_correct);
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
123
5453
d29dafc60cf3 Merge from coreutils to support a more-standard getopt.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5431
diff changeset
124 extern int _getopt_long_r (int ___argc, char **___argv,
12421
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 12118
diff changeset
125 const char *__shortopts,
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 12118
diff changeset
126 const struct option *__longopts, int *__longind,
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 12118
diff changeset
127 struct _getopt_data *__data);
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
128
5453
d29dafc60cf3 Merge from coreutils to support a more-standard getopt.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5431
diff changeset
129 extern int _getopt_long_only_r (int ___argc, char **___argv,
12421
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 12118
diff changeset
130 const char *__shortopts,
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 12118
diff changeset
131 const struct option *__longopts,
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 12118
diff changeset
132 int *__longind,
e8d2c6fc33ad Use spaces for indentation, not tabs.
Bruno Haible <bruno@clisp.org>
parents: 12118
diff changeset
133 struct _getopt_data *__data);
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
134
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
135 #endif /* getopt_int.h */