getopt.h

00001 /*
00002 We include a standard implementation of getopt.c,
00003 so as to support platforms where it is not available.
00004 Amazingly, this version appears to result in SIGBUS
00005 errors when used on Darwin.  In that case, we just
00006 make use of the local implementation.
00007 */
00008 
00009 #if defined(CCTOOLS_OPSYS_DARWIN)
00010 #include </usr/include/getopt.h>
00011 #else
00012 
00013 /* Declarations for getopt.
00014    Copyright (C) 1989-1994,1996-1999,2001,2003,2004
00015    Free Software Foundation, Inc.
00016    This file is part of the GNU C Library.
00017 
00018    The GNU C Library is free software; you can redistribute it and/or
00019    modify it under the terms of the GNU Lesser General Public
00020    License as published by the Free Software Foundation; either
00021    version 2.1 of the License, or (at your option) any later version.
00022 
00023    The GNU C Library is distributed in the hope that it will be useful,
00024    but WITHOUT ANY WARRANTY; without even the implied warranty of
00025    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00026    Lesser General Public License for more details.
00027 
00028    You should have received a copy of the GNU Lesser General Public
00029    License along with the GNU C Library; if not, write to the Free
00030    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
00031    02111-1307 USA.  */
00032 
00033 #ifndef _GETOPT_H
00034 #define _GETOPT_H 1
00035 
00036 /* If __GNU_LIBRARY__ is not already defined, either we are being used
00037    standalone, or this is the first header included in the source file.
00038    If we are being used with glibc, we need to include <features.h>, but
00039    that does not exist if we are standalone.  So: if __GNU_LIBRARY__ is
00040    not defined, include <ctype.h>, which will pull in <features.h> for us
00041    if it's from glibc.  (Why ctype.h?  It's guaranteed to exist and it
00042    doesn't flood the namespace with stuff the way some other headers do.)  */
00043 #if !defined __GNU_LIBRARY__
00044 # include <ctype.h>
00045 #endif
00046 
00047 #ifndef __THROW
00048 # ifndef __GNUC_PREREQ
00049 #  define __GNUC_PREREQ(maj, min) (0)
00050 # endif
00051 # if defined __cplusplus && __GNUC_PREREQ (2,8)
00052 #  define __THROW       throw ()
00053 # else
00054 #  define __THROW
00055 # endif
00056 #endif
00057 
00058 #ifdef  __cplusplus
00059 extern "C" {
00060 #endif
00061 
00062 /* For communication from `getopt' to the caller.
00063    When `getopt' finds an option that takes an argument,
00064    the argument value is returned here.
00065    Also, when `ordering' is RETURN_IN_ORDER,
00066    each non-option ARGV-element is returned here.  */
00067 
00068 extern char *optarg;
00069 
00070 /* Index in ARGV of the next element to be scanned.
00071    This is used for communication to and from the caller
00072    and for communication between successive calls to `getopt'.
00073 
00074    On entry to `getopt', zero means this is the first call; initialize.
00075 
00076    When `getopt' returns -1, this is the index of the first of the
00077    non-option elements that the caller should itself scan.
00078 
00079    Otherwise, `optind' communicates from one call to the next
00080    how much of ARGV has been scanned so far.  */
00081 
00082 extern int optind;
00083 
00084 /* Callers store zero here to inhibit the error message `getopt' prints
00085    for unrecognized options.  */
00086 
00087 extern int opterr;
00088 
00089 /* Set to an option character which was unrecognized.  */
00090 
00091 extern int optopt;
00092 
00093 /* Describe the long-named options requested by the application.
00094    The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
00095    of `struct option' terminated by an element containing a name which is
00096    zero.
00097 
00098    The field `has_arg' is:
00099    no_argument          (or 0) if the option does not take an argument,
00100    required_argument    (or 1) if the option requires an argument,
00101    optional_argument    (or 2) if the option takes an optional argument.
00102 
00103    If the field `flag' is not NULL, it points to a variable that is set
00104    to the value given in the field `val' when the option is found, but
00105    left unchanged if the option is not found.
00106 
00107    To have a long-named option do something other than set an `int' to
00108    a compiled-in constant, such as set a value from `optarg', set the
00109    option's `flag' field to zero and its `val' field to a nonzero
00110    value (the equivalent single-letter option character, if there is
00111    one).  For long options that have a zero `flag' field, `getopt'
00112    returns the contents of the `val' field.  */
00113 
00114 struct option
00115 {
00116   const char *name;
00117   /* has_arg can't be an enum because some compilers complain about
00118      type mismatches in all the code that assumes it is an int.  */
00119   int has_arg;
00120   int *flag;
00121   int val;
00122 };
00123 
00124 /* Names for the values of the `has_arg' field of `struct option'.  */
00125 
00126 # define no_argument            0
00127 # define required_argument      1
00128 # define optional_argument      2
00129 
00130 /* Get definitions and prototypes for functions to process the
00131    arguments in ARGV (ARGC of them, minus the program name) for
00132    options given in OPTS.
00133 
00134    Return the option character from OPTS just read.  Return -1 when
00135    there are no more options.  For unrecognized options, or options
00136    missing arguments, `optopt' is set to the option letter, and '?' is
00137    returned.
00138 
00139    The OPTS string is a list of characters which are recognized option
00140    letters, optionally followed by colons, specifying that that letter
00141    takes an argument, to be placed in `optarg'.
00142 
00143    If a letter in OPTS is followed by two colons, its argument is
00144    optional.  This behavior is specific to the GNU `getopt'.
00145 
00146    The argument `--' causes premature termination of argument
00147    scanning, explicitly telling `getopt' that there are no more
00148    options.
00149 
00150    If OPTS begins with `--', then non-option arguments are treated as
00151    arguments to the option '\0'.  This behavior is specific to the GNU
00152    `getopt'.  */
00153 
00154 #if defined (__STDC__) && __STDC__
00155 #ifdef __GNU_LIBRARY__
00156 /* Many other libraries have conflicting prototypes for getopt, with
00157    differences in the consts, in stdlib.h.  To avoid compilation
00158    errors, only prototype getopt for the GNU C library.  */
00159 extern int getopt (int ___argc, char *const *___argv, const char *__shortopts)
00160        __THROW;
00161 #else /* not __GNU_LIBRARY__ */
00162 extern int getopt ();
00163 #endif /* __GNU_LIBRARY__ */
00164 extern int getopt_long (int ___argc, char *const *___argv,
00165                         const char *__shortopts,
00166                         const struct option *__longopts, int *__longind)
00167        __THROW;
00168 extern int getopt_long_only (int ___argc, char *const *___argv,
00169                              const char *__shortopts,
00170                              const struct option *__longopts, int *__longind)
00171        __THROW;
00172 #else /* not __STDC__ */
00173 extern int getopt ();
00174 extern int getopt_long ();
00175 extern int getopt_long_only ();
00176 #endif /* __STDC__ */
00177 
00178 #ifdef  __cplusplus
00179 }
00180 #endif
00181 
00182 #endif /* getopt.h */
00183 
00184 #endif /* ! CCTOOLS_OPSYS_DARWIN */
00185 

Generated on 14 Jul 2016 for cctools by  doxygen 1.6.1