Back to index

tetex-bin  3.0
getopt.h
Go to the documentation of this file.
00001 /* Declarations for getopt.
00002    Copyright (C) 1989,90,91,92,93,94,96,97, 2000 Free Software Foundation, Inc.
00003 
00004    This file is part of the GNU C Library.  Its master source is NOT part of
00005    the C library, however.  The master source lives in /gd/gnu/lib.
00006 
00007    The GNU C Library is free software; you can redistribute it and/or
00008    modify it under the terms of the GNU Library General Public License as
00009    published by the Free Software Foundation; either version 2 of the
00010    License, or (at your option) any later version.
00011 
00012    The GNU C Library is distributed in the hope that it will be useful,
00013    but WITHOUT ANY WARRANTY; without even the implied warranty of
00014    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00015    Library General Public License for more details.
00016 
00017    You should have received a copy of the GNU Library General Public
00018    License along with the GNU C Library; see the file COPYING.LIB.  If not,
00019    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00020    Boston, MA 02111-1307, USA.  */
00021 
00022 #ifndef _GETOPT_H
00023 #define _GETOPT_H 1
00024 
00025 #if defined(WIN32)
00026 #ifndef __STDC__
00027 #define __STDC__ 1
00028 #endif
00029 #endif
00030 
00031 #if defined (KPSE_DLL) && (defined (WIN32) || defined (__CYGWIN__))
00032 #ifdef MAKE_KPSE_DLL
00033 #define KPSEDLL __declspec(dllexport)
00034 #else /* ! MAKE_KPSE_DLL */
00035 #define KPSEDLL __declspec(dllimport)
00036 #endif
00037 #else /* ! (KPSE_DLL && (WIN32 || __CYGWIN__)) */
00038 #define KPSEDLL
00039 #endif
00040 
00041 #ifdef __cplusplus
00042 extern "C" {
00043 #endif
00044 
00045 /* For communication from `getopt' to the caller.
00046    When `getopt' finds an option that takes an argument,
00047    the argument value is returned here.
00048    Also, when `ordering' is RETURN_IN_ORDER,
00049    each non-option ARGV-element is returned here.  */
00050 
00051 extern KPSEDLL char *optarg;
00052 
00053 /* Index in ARGV of the next element to be scanned.
00054    This is used for communication to and from the caller
00055    and for communication between successive calls to `getopt'.
00056 
00057    On entry to `getopt', zero means this is the first call; initialize.
00058 
00059    When `getopt' returns -1, this is the index of the first of the
00060    non-option elements that the caller should itself scan.
00061 
00062    Otherwise, `optind' communicates from one call to the next
00063    how much of ARGV has been scanned so far.  */
00064 
00065 extern KPSEDLL int optind;
00066 
00067 /* Callers store zero here to inhibit the error message `getopt' prints
00068    for unrecognized options.  */
00069 
00070 extern KPSEDLL int opterr;
00071 
00072 /* Set to an option character which was unrecognized.  */
00073 
00074 extern KPSEDLL int optopt;
00075 
00076 /* Describe the long-named options requested by the application.
00077    The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
00078    of `struct option' terminated by an element containing a name which is
00079    zero.
00080 
00081    The field `has_arg' is:
00082    no_argument              (or 0) if the option does not take an argument,
00083    required_argument (or 1) if the option requires an argument,
00084    optional_argument        (or 2) if the option takes an optional argument.
00085 
00086    If the field `flag' is not NULL, it points to a variable that is set
00087    to the value given in the field `val' when the option is found, but
00088    left unchanged if the option is not found.
00089 
00090    To have a long-named option do something other than set an `int' to
00091    a compiled-in constant, such as set a value from `optarg', set the
00092    option's `flag' field to zero and its `val' field to a nonzero
00093    value (the equivalent single-letter option character, if there is
00094    one).  For long options that have a zero `flag' field, `getopt'
00095    returns the contents of the `val' field.  */
00096 
00097 struct option
00098 {
00099 #if defined (__STDC__) && __STDC__
00100   const char *name;
00101 #else
00102   char *name;
00103 #endif
00104   /* has_arg can't be an enum because some compilers complain about
00105      type mismatches in all the code that assumes it is an int.  */
00106   int has_arg;
00107   int *flag;
00108   int val;
00109 };
00110 
00111 /* Names for the values of the `has_arg' field of `struct option'.  */
00112 
00113 #define       no_argument          0
00114 #define required_argument   1
00115 #define optional_argument   2
00116 
00117 #if defined (__STDC__) && __STDC__
00118 #ifdef __GNU_LIBRARY__
00119 /* Many other libraries have conflicting prototypes for getopt, with
00120    differences in the consts, in stdlib.h.  To avoid compilation
00121    errors, only prototype getopt for the GNU C library.  */
00122 extern KPSEDLL int getopt (int argc, char *const *argv, const char *shortopts);
00123 #else /* not __GNU_LIBRARY__ */
00124 extern KPSEDLL int getopt ();
00125 #endif /* __GNU_LIBRARY__ */
00126 extern KPSEDLL int getopt_long (int argc, char *const *argv, const char *shortopts,
00127                       const struct option *longopts, int *longind);
00128 extern KPSEDLL int getopt_long_only (int argc, char *const *argv,
00129                           const char *shortopts,
00130                            const struct option *longopts, int *longind);
00131 
00132 /* Internal only.  Users should not call this directly.  */
00133 extern int _getopt_internal (int argc, char *const *argv,
00134                           const char *shortopts,
00135                            const struct option *longopts, int *longind,
00136                           int long_only);
00137 #else /* not __STDC__ */
00138 extern KPSEDLL int getopt ();
00139 extern KPSEDLL int getopt_long ();
00140 extern KPSEDLL int getopt_long_only ();
00141 
00142 extern int _getopt_internal ();
00143 #endif /* __STDC__ */
00144 
00145 #ifdef __cplusplus
00146 }
00147 #endif
00148 
00149 #endif /* _GETOPT_H */