Main Page | Modules | Class Hierarchy | Class List | Directories | File List | Class Members | File Members | Related Pages

getopt.h

00001 /* Declarations for getopt.
00002    Copyright (C) 1989,90,91,92,93,94,96,97 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 #ifdef  __cplusplus
00026 extern "C"
00027 {
00028 #endif
00029 
00030 /* For communication from `getopt' to the caller.
00031    When `getopt' finds an option that takes an argument,
00032    the argument value is returned here.
00033    Also, when `ordering' is RETURN_IN_ORDER,
00034    each non-option ARGV-element is returned here.  */
00035 
00036         extern char *optarg;
00037 
00038 /* Index in ARGV of the next element to be scanned.
00039    This is used for communication to and from the caller
00040    and for communication between successive calls to `getopt'.
00041 
00042    On entry to `getopt', zero means this is the first call; initialize.
00043 
00044    When `getopt' returns -1, this is the index of the first of the
00045    non-option elements that the caller should itself scan.
00046 
00047    Otherwise, `optind' communicates from one call to the next
00048    how much of ARGV has been scanned so far.  */
00049 
00050         extern int optind;
00051 
00052 /* Callers store zero here to inhibit the error message `getopt' prints
00053    for unrecognized options.  */
00054 
00055         extern int opterr;
00056 
00057 /* Set to an option character which was unrecognized.  */
00058 
00059         extern int optopt;
00060 
00061 /* Describe the long-named options requested by the application.
00062    The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
00063    of `struct option' terminated by an element containing a name which is
00064    zero.
00065 
00066    The field `has_arg' is:
00067    no_argument          (or 0) if the option does not take an argument,
00068    required_argument    (or 1) if the option requires an argument,
00069    optional_argument    (or 2) if the option takes an optional argument.
00070 
00071    If the field `flag' is not NULL, it points to a variable that is set
00072    to the value given in the field `val' when the option is found, but
00073    left unchanged if the option is not found.
00074 
00075    To have a long-named option do something other than set an `int' to
00076    a compiled-in constant, such as set a value from `optarg', set the
00077    option's `flag' field to zero and its `val' field to a nonzero
00078    value (the equivalent single-letter option character, if there is
00079    one).  For long options that have a zero `flag' field, `getopt'
00080    returns the contents of the `val' field.  */
00081 
00082         struct option
00083         {
00084 #if defined (__STDC__) && __STDC__
00085                 const char *name;
00086 #else
00087                 char *name;
00088 #endif
00089                 /* has_arg can't be an enum because some compilers complain about
00090                    type mismatches in all the code that assumes it is an int.  */
00091                 int has_arg;
00092                 int *flag;
00093                 int val;
00094         };
00095 
00096 /* Names for the values of the `has_arg' field of `struct option'.  */
00097 
00098 #define no_argument             0
00099 #define required_argument       1
00100 #define optional_argument       2
00101 
00102 #if defined (__STDC__) && __STDC__
00103 #ifdef __GNU_LIBRARY__
00104 /* Many other libraries have conflicting prototypes for getopt, with
00105    differences in the consts, in stdlib.h.  To avoid compilation
00106    errors, only prototype getopt for the GNU C library.  */
00107         extern int getopt(int argc, char *const *argv, const char *shortopts);
00108 #else                           /* not __GNU_LIBRARY__ */
00109         extern int getopt();
00110 #endif                          /* __GNU_LIBRARY__ */
00111         extern int getopt_long(int argc, char *const *argv, const char *shortopts,
00112                                const struct option *longopts, int *longind);
00113         extern int getopt_long_only(int argc, char *const *argv,
00114                                     const char *shortopts,
00115                                const struct option *longopts, int *longind);
00116 
00117 /* Internal only.  Users should not call this directly.  */
00118         extern int _getopt_internal(int argc, char *const *argv,
00119                                     const char *shortopts,
00120                                 const struct option *longopts, int *longind,
00121                                     int long_only);
00122 #else                           /* not __STDC__ */
00123         extern int getopt();
00124         extern int getopt_long();
00125         extern int getopt_long_only();
00126 
00127         extern int _getopt_internal();
00128 #endif                          /* __STDC__ */
00129 
00130 #ifdef  __cplusplus
00131 }
00132 #endif
00133 
00134 #endif                          /* _GETOPT_H */

Generated on Tue Dec 20 10:14:59 2005 for vlc-0.8.4a by  doxygen 1.4.2