Back to index

nagios-plugins  1.4.16
getopt.in.h
Go to the documentation of this file.
00001 /* Declarations for getopt.
00002    Copyright (C) 1989-1994, 1996-1999, 2001, 2003-2007, 2009-2010 Free Software
00003    Foundation, Inc.
00004    This file is part of the GNU C Library.
00005 
00006    This program is free software: you can redistribute it and/or modify
00007    it under the terms of the GNU General Public License as published by
00008    the Free Software Foundation; either version 3 of the License, or
00009    (at your option) any later version.
00010 
00011    This program is distributed in the hope that it will be useful,
00012    but WITHOUT ANY WARRANTY; without even the implied warranty of
00013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014    GNU General Public License for more details.
00015 
00016    You should have received a copy of the GNU General Public License
00017    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
00018 
00019 #ifndef _GL_GETOPT_H
00020 
00021 #if __GNUC__ >= 3
00022 @PRAGMA_SYSTEM_HEADER@
00023 #endif
00024 
00025 /* The include_next requires a split double-inclusion guard.  We must
00026    also inform the replacement unistd.h to not recursively use
00027    <getopt.h>; our definitions will be present soon enough.  */
00028 #if @HAVE_GETOPT_H@
00029 # define _GL_SYSTEM_GETOPT
00030 # @INCLUDE_NEXT@ @NEXT_GETOPT_H@
00031 # undef _GL_SYSTEM_GETOPT
00032 #endif
00033 
00034 #ifndef _GL_GETOPT_H
00035 
00036 #ifndef __need_getopt
00037 # define _GL_GETOPT_H 1
00038 #endif
00039 
00040 /* Standalone applications should #define __GETOPT_PREFIX to an
00041    identifier that prefixes the external functions and variables
00042    defined in this header.  When this happens, include the
00043    headers that might declare getopt so that they will not cause
00044    confusion if included after this file (if the system had <getopt.h>,
00045    we have already included it).  Then systematically rename
00046    identifiers so that they do not collide with the system functions
00047    and variables.  Renaming avoids problems with some compilers and
00048    linkers.  */
00049 #if defined __GETOPT_PREFIX && !defined __need_getopt
00050 # if !@HAVE_GETOPT_H@
00051 #  include <stdlib.h>
00052 #  include <stdio.h>
00053 #  include <unistd.h>
00054 # endif
00055 # undef __need_getopt
00056 # undef getopt
00057 # undef getopt_long
00058 # undef getopt_long_only
00059 # undef optarg
00060 # undef opterr
00061 # undef optind
00062 # undef optopt
00063 # undef option
00064 # define __GETOPT_CONCAT(x, y) x ## y
00065 # define __GETOPT_XCONCAT(x, y) __GETOPT_CONCAT (x, y)
00066 # define __GETOPT_ID(y) __GETOPT_XCONCAT (__GETOPT_PREFIX, y)
00067 # define getopt __GETOPT_ID (getopt)
00068 # define getopt_long __GETOPT_ID (getopt_long)
00069 # define getopt_long_only __GETOPT_ID (getopt_long_only)
00070 # define optarg __GETOPT_ID (optarg)
00071 # define opterr __GETOPT_ID (opterr)
00072 # define optind __GETOPT_ID (optind)
00073 # define optopt __GETOPT_ID (optopt)
00074 # define option __GETOPT_ID (option)
00075 # define _getopt_internal __GETOPT_ID (getopt_internal)
00076 #endif
00077 
00078 /* Standalone applications get correct prototypes for getopt_long and
00079    getopt_long_only; they declare "char **argv".  libc uses prototypes
00080    with "char *const *argv" that are incorrect because getopt_long and
00081    getopt_long_only can permute argv; this is required for backward
00082    compatibility (e.g., for LSB 2.0.1).
00083 
00084    This used to be `#if defined __GETOPT_PREFIX && !defined __need_getopt',
00085    but it caused redefinition warnings if both unistd.h and getopt.h were
00086    included, since unistd.h includes getopt.h having previously defined
00087    __need_getopt.
00088 
00089    The only place where __getopt_argv_const is used is in definitions
00090    of getopt_long and getopt_long_only below, but these are visible
00091    only if __need_getopt is not defined, so it is quite safe to rewrite
00092    the conditional as follows:
00093 */
00094 #if !defined __need_getopt
00095 # if defined __GETOPT_PREFIX
00096 #  define __getopt_argv_const /* empty */
00097 # else
00098 #  define __getopt_argv_const const
00099 # endif
00100 #endif
00101 
00102 /* If __GNU_LIBRARY__ is not already defined, either we are being used
00103    standalone, or this is the first header included in the source file.
00104    If we are being used with glibc, we need to include <features.h>, but
00105    that does not exist if we are standalone.  So: if __GNU_LIBRARY__ is
00106    not defined, include <ctype.h>, which will pull in <features.h> for us
00107    if it's from glibc.  (Why ctype.h?  It's guaranteed to exist and it
00108    doesn't flood the namespace with stuff the way some other headers do.)  */
00109 #if !defined __GNU_LIBRARY__
00110 # include <ctype.h>
00111 #endif
00112 
00113 #ifndef __THROW
00114 # ifndef __GNUC_PREREQ
00115 #  define __GNUC_PREREQ(maj, min) (0)
00116 # endif
00117 # if defined __cplusplus && __GNUC_PREREQ (2,8)
00118 #  define __THROW       throw ()
00119 # else
00120 #  define __THROW
00121 # endif
00122 #endif
00123 
00124 /* The definition of _GL_ARG_NONNULL is copied here.  */
00125 
00126 #ifdef __cplusplus
00127 extern "C" {
00128 #endif
00129 
00130 /* For communication from `getopt' to the caller.
00131    When `getopt' finds an option that takes an argument,
00132    the argument value is returned here.
00133    Also, when `ordering' is RETURN_IN_ORDER,
00134    each non-option ARGV-element is returned here.  */
00135 
00136 extern char *optarg;
00137 
00138 /* Index in ARGV of the next element to be scanned.
00139    This is used for communication to and from the caller
00140    and for communication between successive calls to `getopt'.
00141 
00142    On entry to `getopt', zero means this is the first call; initialize.
00143 
00144    When `getopt' returns -1, this is the index of the first of the
00145    non-option elements that the caller should itself scan.
00146 
00147    Otherwise, `optind' communicates from one call to the next
00148    how much of ARGV has been scanned so far.  */
00149 
00150 extern int optind;
00151 
00152 /* Callers store zero here to inhibit the error message `getopt' prints
00153    for unrecognized options.  */
00154 
00155 extern int opterr;
00156 
00157 /* Set to an option character which was unrecognized.  */
00158 
00159 extern int optopt;
00160 
00161 #ifndef __need_getopt
00162 /* Describe the long-named options requested by the application.
00163    The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
00164    of `struct option' terminated by an element containing a name which is
00165    zero.
00166 
00167    The field `has_arg' is:
00168    no_argument          (or 0) if the option does not take an argument,
00169    required_argument    (or 1) if the option requires an argument,
00170    optional_argument    (or 2) if the option takes an optional argument.
00171 
00172    If the field `flag' is not NULL, it points to a variable that is set
00173    to the value given in the field `val' when the option is found, but
00174    left unchanged if the option is not found.
00175 
00176    To have a long-named option do something other than set an `int' to
00177    a compiled-in constant, such as set a value from `optarg', set the
00178    option's `flag' field to zero and its `val' field to a nonzero
00179    value (the equivalent single-letter option character, if there is
00180    one).  For long options that have a zero `flag' field, `getopt'
00181    returns the contents of the `val' field.  */
00182 
00183 struct option
00184 {
00185   const char *name;
00186   /* has_arg can't be an enum because some compilers complain about
00187      type mismatches in all the code that assumes it is an int.  */
00188   int has_arg;
00189   int *flag;
00190   int val;
00191 };
00192 
00193 /* Names for the values of the `has_arg' field of `struct option'.  */
00194 
00195 # define no_argument            0
00196 # define required_argument      1
00197 # define optional_argument      2
00198 #endif  /* need getopt */
00199 
00200 
00201 /* Get definitions and prototypes for functions to process the
00202    arguments in ARGV (ARGC of them, minus the program name) for
00203    options given in OPTS.
00204 
00205    Return the option character from OPTS just read.  Return -1 when
00206    there are no more options.  For unrecognized options, or options
00207    missing arguments, `optopt' is set to the option letter, and '?' is
00208    returned.
00209 
00210    The OPTS string is a list of characters which are recognized option
00211    letters, optionally followed by colons, specifying that that letter
00212    takes an argument, to be placed in `optarg'.
00213 
00214    If a letter in OPTS is followed by two colons, its argument is
00215    optional.  This behavior is specific to the GNU `getopt'.
00216 
00217    The argument `--' causes premature termination of argument
00218    scanning, explicitly telling `getopt' that there are no more
00219    options.
00220 
00221    If OPTS begins with `-', then non-option arguments are treated as
00222    arguments to the option '\1'.  This behavior is specific to the GNU
00223    `getopt'.  If OPTS begins with `+', or POSIXLY_CORRECT is set in
00224    the environment, then do not permute arguments.  */
00225 
00226 extern int getopt (int ___argc, char *const *___argv, const char *__shortopts)
00227        __THROW _GL_ARG_NONNULL ((2, 3));
00228 
00229 #ifndef __need_getopt
00230 extern int getopt_long (int ___argc, char *__getopt_argv_const *___argv,
00231                         const char *__shortopts,
00232                         const struct option *__longopts, int *__longind)
00233        __THROW _GL_ARG_NONNULL ((2, 3));
00234 extern int getopt_long_only (int ___argc, char *__getopt_argv_const *___argv,
00235                              const char *__shortopts,
00236                              const struct option *__longopts, int *__longind)
00237        __THROW _GL_ARG_NONNULL ((2, 3));
00238 
00239 #endif
00240 
00241 #ifdef __cplusplus
00242 }
00243 #endif
00244 
00245 /* Make sure we later can get all the definitions and declarations.  */
00246 #undef __need_getopt
00247 
00248 #endif /* getopt.h */
00249 #endif /* getopt.h */