CanFestival: examples/TestMasterMicroMod/getopt.h Source File

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