ARTS 2.5.9 (git: 825fa5f2)
arts_getopt.h
Go to the documentation of this file.
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@gnu.org.
6
7 This program is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 2, or (at your option) any
10 later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
20 USA. */
21
22#ifndef _GETOPT_H
23#define _GETOPT_H 1
24
25#ifdef __cplusplus
26extern "C" {
27#endif
28
29/* For communication from `getopt' to the caller.
30 When `getopt' finds an option that takes an argument,
31 the argument value is returned here.
32 Also, when `ordering' is RETURN_IN_ORDER,
33 each non-option ARGV-element is returned here. */
34
35extern char *optarg;
36
37/* Index in ARGV of the next element to be scanned.
38 This is used for communication to and from the caller
39 and for communication between successive calls to `getopt'.
40
41 On entry to `getopt', zero means this is the first call; initialize.
42
43 When `getopt' returns -1, this is the index of the first of the
44 non-option elements that the caller should itself scan.
45
46 Otherwise, `optind' communicates from one call to the next
47 how much of ARGV has been scanned so far. */
48
49extern int optind;
50
51/* Callers store zero here to inhibit the error message `getopt' prints
52 for unrecognized options. */
53
54extern int opterr;
55
56/* Set to an option character which was unrecognized. */
57
58extern int optopt;
59
60/* Describe the long-named options requested by the application.
61 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
62 of `struct option' terminated by an element containing a name which is
63 zero.
64
65 The field `has_arg' is:
66 no_argument (or 0) if the option does not take an argument,
67 required_argument (or 1) if the option requires an argument,
68 optional_argument (or 2) if the option takes an optional argument.
69
70 If the field `flag' is not NULL, it points to a variable that is set
71 to the value given in the field `val' when the option is found, but
72 left unchanged if the option is not found.
73
74 To have a long-named option do something other than set an `int' to
75 a compiled-in constant, such as set a value from `optarg', set the
76 option's `flag' field to zero and its `val' field to a nonzero
77 value (the equivalent single-letter option character, if there is
78 one). For long options that have a zero `flag' field, `getopt'
79 returns the contents of the `val' field. */
80
81struct 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. */
90 int *flag;
91 int val;
92};
93
94/* Names for the values of the `has_arg' field of `struct option'. */
95
96#define no_argument 0
97#define required_argument 1
98#define optional_argument 2
99
100#if defined(__STDC__) && __STDC__
101#if defined(__GNU_LIBRARY__) || defined(HPUX) || defined(SUNOS) || \
102 defined(__DARWIN_UNIX03)
103
104/* Many other libraries have conflicting prototypes for getopt, with
105 differences in the consts, in stdlib.h. To avoid compilation
106 errors, only prototype getopt for the GNU C library. */
107extern int getopt(int argc, char *const *argv, const char *shortopts);
108#endif /* __GNU_LIBRARY__ */
109extern int getopt_long(int argc,
110 char *const *argv,
111 const char *shortopts,
112 const struct option *longopts,
113 int *longind);
114extern int getopt_long_only(int argc,
115 char *const *argv,
116 const char *shortopts,
117 const struct option *longopts,
118 int *longind);
119
120/* Internal only. Users should not call this directly. */
121extern int _getopt_internal(int argc,
122 char *const *argv,
123 const char *shortopts,
124 const struct option *longopts,
125 int *longind,
126 int long_only);
127#else /* not __STDC__ */
128extern int getopt();
129extern int getopt_long();
130extern int getopt_long_only();
131
132extern int _getopt_internal();
133#endif /* __STDC__ */
134
135#ifdef __cplusplus
136}
137#endif
138
139#endif /* getopt.h */
int optopt
int _getopt_internal()
int getopt()
int getopt_long()
int getopt_long_only()
int optind
char * optarg
int opterr
int val
Definition: arts_getopt.h:91
int has_arg
Definition: arts_getopt.h:89
char * name
Definition: arts_getopt.h:85
int * flag
Definition: arts_getopt.h:90