Ensure variables defined in $(call ...) have global scope
[make.git] / getopt.h
blobdff9998dec1229cd1c619fe2200de6c4ebc2378f
1 /* Declarations for getopt.
2 Copyright (C) 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
3 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free
4 Software Foundation, Inc.
6 NOTE: The canonical source of this file is maintained with the GNU C Library.
7 Bugs can be reported to bug-glibc@gnu.org.
9 GNU Make is free software; you can redistribute it and/or modify it under the
10 terms of the GNU General Public License as published by the Free Software
11 Foundation; either version 3 of the License, or (at your option) any later
12 version.
14 GNU Make is distributed in the hope that it will be useful, but WITHOUT ANY
15 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
16 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License along with
19 this program. If not, see <http://www.gnu.org/licenses/>. */
21 #ifndef _GETOPT_H
22 #define _GETOPT_H 1
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
28 /* For communication from `getopt' to the caller.
29 When `getopt' finds an option that takes an argument,
30 the argument value is returned here.
31 Also, when `ordering' is RETURN_IN_ORDER,
32 each non-option ARGV-element is returned here. */
34 extern char *optarg;
36 /* Index in ARGV of the next element to be scanned.
37 This is used for communication to and from the caller
38 and for communication between successive calls to `getopt'.
40 On entry to `getopt', zero means this is the first call; initialize.
42 When `getopt' returns -1, this is the index of the first of the
43 non-option elements that the caller should itself scan.
45 Otherwise, `optind' communicates from one call to the next
46 how much of ARGV has been scanned so far. */
48 extern int optind;
50 /* Callers store zero here to inhibit the error message `getopt' prints
51 for unrecognized options. */
53 extern int opterr;
55 /* Set to an option character which was unrecognized. */
57 extern int optopt;
59 /* Describe the long-named options requested by the application.
60 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
61 of `struct option' terminated by an element containing a name which is
62 zero.
64 The field `has_arg' is:
65 no_argument (or 0) if the option does not take an argument,
66 required_argument (or 1) if the option requires an argument,
67 optional_argument (or 2) if the option takes an optional argument.
69 If the field `flag' is not NULL, it points to a variable that is set
70 to the value given in the field `val' when the option is found, but
71 left unchanged if the option is not found.
73 To have a long-named option do something other than set an `int' to
74 a compiled-in constant, such as set a value from `optarg', set the
75 option's `flag' field to zero and its `val' field to a nonzero
76 value (the equivalent single-letter option character, if there is
77 one). For long options that have a zero `flag' field, `getopt'
78 returns the contents of the `val' field. */
80 struct option
82 #if defined (__STDC__) && __STDC__
83 const char *name;
84 #else
85 char *name;
86 #endif
87 /* has_arg can't be an enum because some compilers complain about
88 type mismatches in all the code that assumes it is an int. */
89 int has_arg;
90 int *flag;
91 int val;
94 /* Names for the values of the `has_arg' field of `struct option'. */
96 #define no_argument 0
97 #define required_argument 1
98 #define optional_argument 2
100 #if defined (__STDC__) && __STDC__
101 #ifdef __GNU_LIBRARY__
102 /* Many other libraries have conflicting prototypes for getopt, with
103 differences in the consts, in stdlib.h. To avoid compilation
104 errors, only prototype getopt for the GNU C library. */
105 extern int getopt (int argc, char *const *argv, const char *shortopts);
106 #else /* not __GNU_LIBRARY__ */
107 extern int getopt ();
108 #endif /* __GNU_LIBRARY__ */
109 extern int getopt_long (int argc, char *const *argv, const char *shortopts,
110 const struct option *longopts, int *longind);
111 extern int getopt_long_only (int argc, char *const *argv,
112 const char *shortopts,
113 const struct option *longopts, int *longind);
115 /* Internal only. Users should not call this directly. */
116 extern int _getopt_internal (int argc, char *const *argv,
117 const char *shortopts,
118 const struct option *longopts, int *longind,
119 int long_only);
120 #else /* not __STDC__ */
121 extern int getopt ();
122 extern int getopt_long ();
123 extern int getopt_long_only ();
125 extern int _getopt_internal ();
126 #endif /* __STDC__ */
128 #ifdef __cplusplus
130 #endif
132 #endif /* getopt.h */