---

---

---

001: /* Declarations for getopt.
002:    Copyright (C) 1989-1994,1996-1999,2001,2003,2004,2009,2010
003:    Free Software Foundation, Inc.
004:    This file is part of the GNU C Library.
005: 
006:    The GNU C Library is free software; you can redistribute it and/or
007:    modify it under the terms of the GNU Lesser General Public
008:    License as published by the Free Software Foundation; either
009:    version 2.1 of the License, or (at your option) any later version.
010: 
011:    The GNU C Library is distributed in the hope that it will be useful,
012:    but WITHOUT ANY WARRANTY; without even the implied warranty of
013:    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014:    Lesser General Public License for more details.
015: 
016:    You should have received a copy of the GNU Lesser General Public
017:    License along with the GNU C Library; if not, write to the Free
018:    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
019:    02111-1307 USA.  */
020: 
021: #ifndef _GETOPT_H
022: 
023: #ifndef __need_getopt
024: # define _GETOPT_H 1
025: #endif
026: 
027: /* If __GNU_LIBRARY__ is not already defined, either we are being used
028:    standalone, or this is the first header included in the source file.
029:    If we are being used with glibc, we need to include <features.h>, but
030:    that does not exist if we are standalone.  So: if __GNU_LIBRARY__ is
031:    not defined, include <ctype.h>, which will pull in <features.h> for us
032:    if it's from glibc.  (Why ctype.h?  It's guaranteed to exist and it
033:    doesn't flood the namespace with stuff the way some other headers do.)  */
034: #if !defined __GNU_LIBRARY__
035: # include <ctype.h>
036: #endif
037: 
038: #ifndef __THROW
039: # ifndef __GNUC_PREREQ
040: #  define __GNUC_PREREQ(maj, min) (0)
041: # endif
042: # if defined __cplusplus && __GNUC_PREREQ (2,8)
043: #  define __THROW       throw ()
044: # else
045: #  define __THROW
046: # endif
047: #endif
048: 
049: #ifdef  __cplusplus
050: extern "C" {
051: #endif
052: 
053: /* For communication from `getopt' to the caller.
054:    When `getopt' finds an option that takes an argument,
055:    the argument value is returned here.
056:    Also, when `ordering' is RETURN_IN_ORDER,
057:    each non-option ARGV-element is returned here.  */
058: 
059: extern char *optarg;
060: 
061: /* Index in ARGV of the next element to be scanned.
062:    This is used for communication to and from the caller
063:    and for communication between successive calls to `getopt'.
064: 
065:    On entry to `getopt', zero means this is the first call; initialize.
066: 
067:    When `getopt' returns -1, this is the index of the first of the
068:    non-option elements that the caller should itself scan.
069: 
070:    Otherwise, `optind' communicates from one call to the next
071:    how much of ARGV has been scanned so far.  */
072: 
073: extern int optind;
074: 
075: /* Callers store zero here to inhibit the error message `getopt' prints
076:    for unrecognized options.  */
077: 
078: extern int opterr;
079: 
080: /* Set to an option character which was unrecognized.  */
081: 
082: extern int optopt;
083: 
084: #ifndef __need_getopt
085: /* Describe the long-named options requested by the application.
086:    The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
087:    of `struct option' terminated by an element containing a name which is
088:    zero.
089: 
090:    The field `has_arg' is:
091:    no_argument          (or 0) if the option does not take an argument,
092:    required_argument    (or 1) if the option requires an argument,
093:    optional_argument    (or 2) if the option takes an optional argument.
094: 
095:    If the field `flag' is not NULL, it points to a variable that is set
096:    to the value given in the field `val' when the option is found, but
097:    left unchanged if the option is not found.
098: 
099:    To have a long-named option do something other than set an `int' to
100:    a compiled-in constant, such as set a value from `optarg', set the
101:    option's `flag' field to zero and its `val' field to a nonzero
102:    value (the equivalent single-letter option character, if there is
103:    one).  For long options that have a zero `flag' field, `getopt'
104:    returns the contents of the `val' field.  */
105: 
106: struct option
107: {
108:   const char *name;
109:   /* has_arg can't be an enum because some compilers complain about
110:      type mismatches in all the code that assumes it is an int.  */
111:   int has_arg;
112:   int *flag;
113:   int val;
114: };
115: 
116: /* Names for the values of the `has_arg' field of `struct option'.  */
117: 
118: # define no_argument            0
119: # define required_argument      1
120: # define optional_argument      2
121: #endif  /* need getopt */
122: 
123: 
124: /* Get definitions and prototypes for functions to process the
125:    arguments in ARGV (ARGC of them, minus the program name) for
126:    options given in OPTS.
127: 
128:    Return the option character from OPTS just read.  Return -1 when
129:    there are no more options.  For unrecognized options, or options
130:    missing arguments, `optopt' is set to the option letter, and '?' is
131:    returned.
132: 
133:    The OPTS string is a list of characters which are recognized option
134:    letters, optionally followed by colons, specifying that that letter
135:    takes an argument, to be placed in `optarg'.
136: 
137:    If a letter in OPTS is followed by two colons, its argument is
138:    optional.  This behavior is specific to the GNU `getopt'.
139: 
140:    The argument `--' causes premature termination of argument
141:    scanning, explicitly telling `getopt' that there are no more
142:    options.
143: 
144:    If OPTS begins with `--', then non-option arguments are treated as
145:    arguments to the option '\0'.  This behavior is specific to the GNU
146:    `getopt'.  */
147: 
148: #ifdef __GNU_LIBRARY__
149: /* Many other libraries have conflicting prototypes for getopt, with
150:    differences in the consts, in stdlib.h.  To avoid compilation
151:    errors, only prototype getopt for the GNU C library.  */
152: extern int getopt (int ___argc, char *const *___argv, const char *__shortopts)
153:        __THROW;
154: 
155: # if defined __need_getopt && defined __USE_POSIX2 \
156:   && !defined __USE_POSIX_IMPLICITLY && !defined __USE_GNU
157: /* The GNU getopt has more functionality than the standard version.  The
158:    additional functionality can be disable at runtime.  This redirection
159:    helps to also do this at runtime.  */
160: #  ifdef __REDIRECT
161:   extern int __REDIRECT_NTH (getopt, (int ___argc, char *const *___argv,
162:                                       const char *__shortopts),
163:                              __posix_getopt);
164: #  else
165: extern int __posix_getopt (int ___argc, char *const *___argv,
166:                            const char *__shortopts) __THROW;
167: #   define getopt __posix_getopt
168: #  endif
169: # endif
170: #else /* not __GNU_LIBRARY__ */
171: extern int getopt ();
172: #endif /* __GNU_LIBRARY__ */
173: 
174: #ifndef __need_getopt
175: extern int getopt_long (int ___argc, char *const *___argv,
176:                         const char *__shortopts,
177:                         const struct option *__longopts, int *__longind)
178:        __THROW;
179: extern int getopt_long_only (int ___argc, char *const *___argv,
180:                              const char *__shortopts,
181:                              const struct option *__longopts, int *__longind)
182:        __THROW;
183: 
184: #endif
185: 
186: #ifdef  __cplusplus
187: }
188: #endif
189: 
190: /* Make sure we later can get all the definitions and declarations.  */
191: #undef __need_getopt
192: 
193: #endif /* getopt.h */
194: 

---

---

---