Mercurial > hg > octave-kai > gnulib-hg

annotate lib/getopt_int.h @ 5453:d29dafc60cf3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge from coreutils to support a more-standard getopt.
author Paul Eggert <eggert@cs.ucla.edu>
date Wed, 17 Nov 2004 01:13:54 +0000
parents 1c7efeb240c3
children a48fb0e98c8c
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.
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
2 Copyright (C) 1989-1994,1996-1999,2001,2003,2004
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
3 Free Software Foundation, Inc.
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
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
6 This program is free software; you can redistribute it and/or modify
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
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
8 the Free Software Foundation; either version 2, or (at your option)
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
9 any later version.
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
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
16 You should have received a copy of the GNU General Public License along
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
17 with this program; if not, write to the Free Software Foundation,
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
18 Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
19
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
20 #ifndef _GETOPT_INT_H
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
21 #define _GETOPT_INT_H 1
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
22
5453
d29dafc60cf3 Merge from coreutils to support a more-standard getopt.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5431
diff changeset
23 extern int _getopt_internal (int ___argc, char **___argv,
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
24 const char *__shortopts,
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
25 const struct option *__longopts, int *__longind,
5453
d29dafc60cf3 Merge from coreutils to support a more-standard getopt.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5431
diff changeset
26 int __long_only, int __posixly_correct);
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
27
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 /* 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
30 vectors at the same time. */
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
31
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
32 /* Data type for reentrant functions. */
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
33 struct _getopt_data
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
34 {
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
35 /* 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
36 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
37 versions of getopt. */
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
38 int optind;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
39 int opterr;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
40 int optopt;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
41 char *optarg;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
42
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
43 /* Internal members. */
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
44
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
45 /* 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
46 int __initialized;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
47
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
48 /* 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
49 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
50 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
51
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
52 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
53 by advancing to the next ARGV-element. */
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
54 char *__nextchar;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
55
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
56 /* Describe how to deal with options that follow non-option ARGV-elements.
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
57
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
58 If the caller did not specify anything,
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
59 the default is REQUIRE_ORDER if the environment variable
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
60 POSIXLY_CORRECT is defined, PERMUTE otherwise.
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
61
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
62 REQUIRE_ORDER means don't recognize them as options;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
63 stop option processing when the first non-option is seen.
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
64 This is what Unix does.
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
65 This mode of operation is selected by either setting the environment
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
66 variable POSIXLY_CORRECT, or using `+' as the first character
5453
d29dafc60cf3 Merge from coreutils to support a more-standard getopt.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5431
diff changeset
67 of the list of option characters, or by calling getopt.
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
68
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
69 PERMUTE is the default. We permute the contents of ARGV as we
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
70 scan, so that eventually all the non-options are at the end.
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
71 This allows options to be given in any order, even with programs
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
72 that were not written to expect this.
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
73
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
74 RETURN_IN_ORDER is an option available to programs that were
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
75 written to expect options and other ARGV-elements in any order
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
76 and that care about the ordering of the two. We describe each
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
77 non-option ARGV-element as if it were the argument of an option
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
78 with character code 1. Using `-' as the first character of the
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
79 list of option characters selects this mode of operation.
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
80
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
81 The special argument `--' forces an end of option-scanning regardless
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
82 of the value of `ordering'. In the case of RETURN_IN_ORDER, only
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
83 `--' can cause `getopt' to return -1 with `optind' != ARGC. */
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
84
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
85 enum
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 REQUIRE_ORDER, PERMUTE, RETURN_IN_ORDER
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
88 } __ordering;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
89
5453
d29dafc60cf3 Merge from coreutils to support a more-standard getopt.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5431
diff changeset
90 /* 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
91 or getopt was called. */
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
92 int __posixly_correct;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
93
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
94
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
95 /* Handle permutation of arguments. */
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
96
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
97 /* Describe the part of ARGV that contains non-options that have
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
98 been skipped. `first_nonopt' is the index in ARGV of the first
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
99 of them; `last_nonopt' is the index after the last of them. */
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 int __first_nonopt;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
102 int __last_nonopt;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
103
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
104 #if defined _LIBC && defined USE_NONOPTION_FLAGS
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
105 int __nonoption_flags_max_len;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
106 int __nonoption_flags_len;
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
107 # endif
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
108 };
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
109
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
110 /* 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
111 default values and to clear the initialization flag. */
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
112 #define _GETOPT_DATA_INITIALIZER { 1, 1 }
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
113
5453
d29dafc60cf3 Merge from coreutils to support a more-standard getopt.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5431
diff changeset
114 extern int _getopt_internal_r (int ___argc, char **___argv,
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
115 const char *__shortopts,
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
116 const struct option *__longopts, int *__longind,
5453
d29dafc60cf3 Merge from coreutils to support a more-standard getopt.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5431
diff changeset
117 int __long_only, int __posixly_correct,
d29dafc60cf3 Merge from coreutils to support a more-standard getopt.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5431
diff changeset
118 struct _getopt_data *__data);
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
119
5453
d29dafc60cf3 Merge from coreutils to support a more-standard getopt.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5431
diff changeset
120 extern int _getopt_long_r (int ___argc, char **___argv,
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
121 const char *__shortopts,
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
122 const struct option *__longopts, int *__longind,
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
123 struct _getopt_data *__data);
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
124
5453
d29dafc60cf3 Merge from coreutils to support a more-standard getopt.
Paul Eggert <eggert@cs.ucla.edu>
parents: 5431
diff changeset
125 extern int _getopt_long_only_r (int ___argc, char **___argv,
4970
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
126 const char *__shortopts,
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
127 const struct option *__longopts,
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
128 int *__longind,
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
129 struct _getopt_data *__data);
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
130
595e9138157c Sync getopt and argp from libc CVS.
Paul Eggert <eggert@cs.ucla.edu>
parents:
diff changeset
131 #endif /* getopt_int.h */