ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/gvpe/lib/getopt.h
Revision: 1.4
Committed: Tue Apr 26 00:55:55 2005 UTC (19 years, 1 month ago) by pcg
Content type: text/plain
Branch: MAIN
CVS Tags: rel-2_01, rel-3_0, rel-2_2, rel-2_0, rel-2_21, rel-2_22, rel-2_25
Changes since 1.3: +1 -1 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 pcg 1.1 /* Declarations for getopt.
2     Copyright (C) 1989,90,91,92,93,94,96,97 Free Software Foundation, Inc.
3    
4     NOTE: The canonical source of this file is maintained with the GNU C Library.
5     Bugs can be reported to bug-glibc@prep.ai.mit.edu.
6    
7 pcg 1.3 This file is part of GVPE.
8    
9     GVPE is free software; you can redistribute it and/or modify it
10 pcg 1.1 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.
13    
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.
18    
19     You should have received a copy of the GNU General Public License
20 pcg 1.3 along with gvpe; if not, write to the Free Software
21 pcg 1.4 Foundation, Inc. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 pcg 1.1 */
23    
24     #ifndef _GETOPT_H
25     #define _GETOPT_H 1
26    
27     #ifdef __cplusplus
28     extern "C" {
29     #endif
30    
31     /* For communication from `getopt' to the caller.
32     When `getopt' finds an option that takes an argument,
33     the argument value is returned here.
34     Also, when `ordering' is RETURN_IN_ORDER,
35     each non-option ARGV-element is returned here. */
36    
37     extern char *optarg;
38    
39     /* Index in ARGV of the next element to be scanned.
40     This is used for communication to and from the caller
41     and for communication between successive calls to `getopt'.
42    
43     On entry to `getopt', zero means this is the first call; initialize.
44    
45     When `getopt' returns -1, this is the index of the first of the
46     non-option elements that the caller should itself scan.
47    
48     Otherwise, `optind' communicates from one call to the next
49     how much of ARGV has been scanned so far. */
50    
51     extern int optind;
52    
53     /* Callers store zero here to inhibit the error message `getopt' prints
54     for unrecognized options. */
55    
56     extern int opterr;
57    
58     /* Set to an option character which was unrecognized. */
59    
60     extern int optopt;
61    
62     /* Describe the long-named options requested by the application.
63     The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
64     of `struct option' terminated by an element containing a name which is
65     zero.
66    
67     The field `has_arg' is:
68     no_argument (or 0) if the option does not take an argument,
69     required_argument (or 1) if the option requires an argument,
70     optional_argument (or 2) if the option takes an optional argument.
71    
72     If the field `flag' is not NULL, it points to a variable that is set
73     to the value given in the field `val' when the option is found, but
74     left unchanged if the option is not found.
75    
76     To have a long-named option do something other than set an `int' to
77     a compiled-in constant, such as set a value from `optarg', set the
78     option's `flag' field to zero and its `val' field to a nonzero
79     value (the equivalent single-letter option character, if there is
80     one). For long options that have a zero `flag' field, `getopt'
81     returns the contents of the `val' field. */
82    
83     struct option
84     {
85     #if defined (__STDC__) && __STDC__
86     const char *name;
87     #else
88     char *name;
89     #endif
90     /* has_arg can't be an enum because some compilers complain about
91     type mismatches in all the code that assumes it is an int. */
92     int has_arg;
93     int *flag;
94     int val;
95     };
96    
97     /* Names for the values of the `has_arg' field of `struct option'. */
98    
99     #define no_argument 0
100     #define required_argument 1
101     #define optional_argument 2
102    
103     #if defined (__STDC__) && __STDC__
104     #ifdef __GNU_LIBRARY__
105     /* Many other libraries have conflicting prototypes for getopt, with
106     differences in the consts, in stdlib.h. To avoid compilation
107     errors, only prototype getopt for the GNU C library. */
108     extern int getopt (int argc, char *const *argv, const char *shortopts);
109     #else /* not __GNU_LIBRARY__ */
110     #endif /* __GNU_LIBRARY__ */
111     extern int getopt_long (int argc, char *const *argv, const char *shortopts,
112     const struct option *longopts, int *longind);
113     extern int getopt_long_only (int argc, char *const *argv,
114     const char *shortopts,
115     const struct option *longopts, int *longind);
116    
117     /* Internal only. Users should not call this directly. */
118     extern int _getopt_internal (int argc, char *const *argv,
119     const char *shortopts,
120     const struct option *longopts, int *longind,
121     int long_only);
122     #else /* not __STDC__ */
123     extern int getopt_long ();
124     extern int getopt_long_only ();
125    
126     extern int _getopt_internal ();
127     #endif /* __STDC__ */
128    
129     #ifdef __cplusplus
130     }
131     #endif
132    
133     #endif /* _GETOPT_H */