source: sans/utils/Teabag/VC/Teabag/getopt.h

Last change on this file was 837, checked in by ajj, 11 years ago

Checkin of Teabag code for TISANE.

File size: 6.5 KB
Line 
1/* getopt.h */
2/* Declarations for getopt.
3   Copyright (C) 1989-1994, 1996-1999, 2001 Free Software
4   Foundation, Inc. This file is part of the GNU C Library.
5
6   The GNU C Library is free software; you can redistribute
7   it and/or modify it under the terms of the GNU Lesser
8   General Public License as published by the Free Software
9   Foundation; either version 2.1 of the License, or
10   (at your option) any later version.
11
12   The GNU C Library is distributed in the hope that it will
13   be useful, but WITHOUT ANY WARRANTY; without even the
14   implied warranty of MERCHANTABILITY or FITNESS FOR A
15   PARTICULAR PURPOSE.  See the GNU Lesser General Public
16   License for more details.
17
18   You should have received a copy of the GNU Lesser General
19   Public License along with the GNU C Library; if not, write
20   to the Free Software Foundation, Inc., 59 Temple Place,
21   Suite 330, Boston, MA 02111-1307 USA.  */
22
23 
24 
25
26#ifndef _GETOPT_H
27
28#ifndef __need_getopt
29# define _GETOPT_H 1
30#endif
31
32/* If __GNU_LIBRARY__ is not already defined, either we are being used
33   standalone, or this is the first header included in the source file.
34   If we are being used with glibc, we need to include <features.h>, but
35   that does not exist if we are standalone.  So: if __GNU_LIBRARY__ is
36   not defined, include <ctype.h>, which will pull in <features.h> for us
37   if it's from glibc.  (Why ctype.h?  It's guaranteed to exist and it
38   doesn't flood the namespace with stuff the way some other headers do.)  */
39#if !defined __GNU_LIBRARY__
40# include <ctype.h>
41#endif
42
43#ifdef  __cplusplus
44extern "C" {
45#endif
46
47/* For communication from `getopt' to the caller.
48   When `getopt' finds an option that takes an argument,
49   the argument value is returned here.
50   Also, when `ordering' is RETURN_IN_ORDER,
51   each non-option ARGV-element is returned here.  */
52
53extern char *optarg;
54
55/* Index in ARGV of the next element to be scanned.
56   This is used for communication to and from the caller
57   and for communication between successive calls to `getopt'.
58
59   On entry to `getopt', zero means this is the first call; initialize.
60
61   When `getopt' returns -1, this is the index of the first of the
62   non-option elements that the caller should itself scan.
63
64   Otherwise, `optind' communicates from one call to the next
65   how much of ARGV has been scanned so far.  */
66
67extern int optind;
68
69/* Callers store zero here to inhibit the error message `getopt' prints
70   for unrecognized options.  */
71
72extern int opterr;
73
74/* Set to an option character which was unrecognized.  */
75
76extern int optopt;
77
78#ifndef __need_getopt
79/* Describe the long-named options requested by the application.
80   The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
81   of `struct option' terminated by an element containing a name which is
82   zero.
83
84   The field `has_arg' is:
85   no_argument          (or 0) if the option does not take an argument,
86   required_argument    (or 1) if the option requires an argument,
87   optional_argument    (or 2) if the option takes an optional argument.
88
89   If the field `flag' is not NULL, it points to a variable that is set
90   to the value given in the field `val' when the option is found, but
91   left unchanged if the option is not found.
92
93   To have a long-named option do something other than set an `int' to
94   a compiled-in constant, such as set a value from `optarg', set the
95   option's `flag' field to zero and its `val' field to a nonzero
96   value (the equivalent single-letter option character, if there is
97   one).  For long options that have a zero `flag' field, `getopt'
98   returns the contents of the `val' field.  */
99
100struct option
101{
102# if (defined __STDC__ && __STDC__) || defined __cplusplus
103  const char *name;
104# else
105  char *name;
106# endif
107  /* has_arg can't be an enum because some compilers complain about
108     type mismatches in all the code that assumes it is an int.  */
109  int has_arg;
110  int *flag;
111  int val;
112};
113
114/* Names for the values of the `has_arg' field of `struct option'.  */
115
116# define no_argument            0
117# define required_argument      1
118# define optional_argument      2
119#endif  /* need getopt */
120
121
122/* Get definitions and prototypes for functions to process the
123   arguments in ARGV (ARGC of them, minus the program name) for
124   options given in OPTS.
125
126   Return the option character from OPTS just read.  Return -1 when
127   there are no more options.  For unrecognized options, or options
128   missing arguments, `optopt' is set to the option letter, and '?' is
129   returned.
130
131   The OPTS string is a list of characters which are recognized option
132   letters, optionally followed by colons, specifying that that letter
133   takes an argument, to be placed in `optarg'.
134
135   If a letter in OPTS is followed by two colons, its argument is
136   optional.  This behavior is specific to the GNU `getopt'.
137
138   The argument `--' causes premature termination of argument
139   scanning, explicitly telling `getopt' that there are no more
140   options.
141
142   If OPTS begins with `--', then non-option arguments are treated as
143   arguments to the option '\0'.  This behavior is specific to the GNU
144   `getopt'.  */
145
146#if (defined __STDC__ && __STDC__) || defined __cplusplus
147# ifdef __GNU_LIBRARY__
148/* Many other libraries have conflicting prototypes for getopt, with
149   differences in the consts, in stdlib.h.  To avoid compilation
150   errors, only prototype getopt for the GNU C library.  */
151extern int getopt (int ___argc, char *const *___argv, const char *__shortopts);
152# else /* not __GNU_LIBRARY__ */
153extern int getopt ();
154# endif /* __GNU_LIBRARY__ */
155
156# ifndef __need_getopt
157extern int getopt_long (int ___argc, char *const *___argv,
158                        const char *__shortopts,
159                        const struct option *__longopts, int *__longind);
160extern int getopt_long_only (int ___argc, char *const *___argv,
161                             const char *__shortopts,
162                             const struct option *__longopts, int *__longind);
163
164/* Internal only.  Users should not call this directly.  */
165extern int _getopt_internal (int ___argc, char *const *___argv,
166                             const char *__shortopts,
167                             const struct option *__longopts, int *__longind,
168                             int __long_only);
169# endif
170#else /* not __STDC__ */
171extern int getopt ();
172# ifndef __need_getopt
173extern int getopt_long ();
174extern int getopt_long_only ();
175
176extern int _getopt_internal ();
177# endif
178#endif /* __STDC__ */
179
180#ifdef  __cplusplus
181}
182#endif
183
184/* Make sure we later can get all the definitions and declarations.  */
185#undef __need_getopt
186
187#endif /* getopt.h */
Note: See TracBrowser for help on using the repository browser.