"Fossies" - the Fresh Open Source Software Archive

Member "bc-1.06.95/h/getopt.h" (27 May 2005, 6113 Bytes) of package /linux/misc/old/bc-1.06.95.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) C and C++ source code syntax highlighting (style: standard) with prefixed line numbers and code folding option. Alternatively you can here view or download the uninterpreted source code file. For more information about "getopt.h" see the Fossies "Dox" file reference documentation.

    1 /* Declarations for getopt.
    2 
    3    Copyright (C) 1989, 1990, 1991, 1992, 1993, 1994, 1996, 1997, 1998,
    4    1999, 2001, 2003 Free Software Foundation, Inc.
    5 
    6    This file is part of the GNU C Library.
    7 
    8    This program is free software; you can redistribute it and/or modify
    9    it under the terms of the GNU General Public License as published by
   10    the Free Software Foundation; either version 2, or (at your option)
   11    any later version.
   12 
   13    This program is distributed in the hope that it will be useful,
   14    but WITHOUT ANY WARRANTY; without even the implied warranty of
   15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   16    GNU General Public License for more details.
   17 
   18    You should have received a copy of the GNU General Public License along
   19    with this program; if not, write to the Free Software Foundation,
   20    Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301  USA.  */
   21 
   22 #ifndef _GETOPT_H
   23 
   24 #ifndef __need_getopt
   25 # define _GETOPT_H 1
   26 #endif
   27 
   28 /* If __GNU_LIBRARY__ is not already defined, either we are being used
   29    standalone, or this is the first header included in the source file.
   30    If we are being used with glibc, we need to include <features.h>, but
   31    that does not exist if we are standalone.  So: if __GNU_LIBRARY__ is
   32    not defined, include <ctype.h>, which will pull in <features.h> for us
   33    if it's from glibc.  (Why ctype.h?  It's guaranteed to exist and it
   34    doesn't flood the namespace with stuff the way some other headers do.)  */
   35 #if !defined __GNU_LIBRARY__
   36 # include <ctype.h>
   37 #endif
   38 
   39 #ifdef  __cplusplus
   40 extern "C" {
   41 #endif
   42 
   43 /* For communication from `getopt' to the caller.
   44    When `getopt' finds an option that takes an argument,
   45    the argument value is returned here.
   46    Also, when `ordering' is RETURN_IN_ORDER,
   47    each non-option ARGV-element is returned here.  */
   48 
   49 extern char *optarg;
   50 
   51 /* Index in ARGV of the next element to be scanned.
   52    This is used for communication to and from the caller
   53    and for communication between successive calls to `getopt'.
   54 
   55    On entry to `getopt', zero means this is the first call; initialize.
   56 
   57    When `getopt' returns -1, this is the index of the first of the
   58    non-option elements that the caller should itself scan.
   59 
   60    Otherwise, `optind' communicates from one call to the next
   61    how much of ARGV has been scanned so far.  */
   62 
   63 extern int optind;
   64 
   65 /* Callers store zero here to inhibit the error message `getopt' prints
   66    for unrecognized options.  */
   67 
   68 extern int opterr;
   69 
   70 /* Set to an option character which was unrecognized.  */
   71 
   72 extern int optopt;
   73 
   74 #ifndef __need_getopt
   75 /* Describe the long-named options requested by the application.
   76    The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
   77    of `struct option' terminated by an element containing a name which is
   78    zero.
   79 
   80    The field `has_arg' is:
   81    no_argument      (or 0) if the option does not take an argument,
   82    required_argument    (or 1) if the option requires an argument,
   83    optional_argument    (or 2) if the option takes an optional argument.
   84 
   85    If the field `flag' is not NULL, it points to a variable that is set
   86    to the value given in the field `val' when the option is found, but
   87    left unchanged if the option is not found.
   88 
   89    To have a long-named option do something other than set an `int' to
   90    a compiled-in constant, such as set a value from `optarg', set the
   91    option's `flag' field to zero and its `val' field to a nonzero
   92    value (the equivalent single-letter option character, if there is
   93    one).  For long options that have a zero `flag' field, `getopt'
   94    returns the contents of the `val' field.  */
   95 
   96 struct option
   97 {
   98   const char *name;
   99   /* has_arg can't be an enum because some compilers complain about
  100      type mismatches in all the code that assumes it is an int.  */
  101   int has_arg;
  102   int *flag;
  103   int val;
  104 };
  105 
  106 /* Names for the values of the `has_arg' field of `struct option'.  */
  107 
  108 # define no_argument        0
  109 # define required_argument  1
  110 # define optional_argument  2
  111 #endif  /* need getopt */
  112 
  113 
  114 /* Get definitions and prototypes for functions to process the
  115    arguments in ARGV (ARGC of them, minus the program name) for
  116    options given in OPTS.
  117 
  118    Return the option character from OPTS just read.  Return -1 when
  119    there are no more options.  For unrecognized options, or options
  120    missing arguments, `optopt' is set to the option letter, and '?' is
  121    returned.
  122 
  123    The OPTS string is a list of characters which are recognized option
  124    letters, optionally followed by colons, specifying that that letter
  125    takes an argument, to be placed in `optarg'.
  126 
  127    If a letter in OPTS is followed by two colons, its argument is
  128    optional.  This behavior is specific to the GNU `getopt'.
  129 
  130    The argument `--' causes premature termination of argument
  131    scanning, explicitly telling `getopt' that there are no more
  132    options.
  133 
  134    If OPTS begins with `--', then non-option arguments are treated as
  135    arguments to the option '\0'.  This behavior is specific to the GNU
  136    `getopt'.  */
  137 
  138 #ifdef __GNU_LIBRARY__
  139 /* Many other libraries have conflicting prototypes for getopt, with
  140    differences in the consts, in stdlib.h.  To avoid compilation
  141    errors, only prototype getopt for the GNU C library.  */
  142 extern int getopt (int ___argc, char *const *___argv, const char *__shortopts);
  143 #else /* not __GNU_LIBRARY__ */
  144 extern int getopt ();
  145 #endif /* __GNU_LIBRARY__ */
  146 
  147 #ifndef __need_getopt
  148 extern int getopt_long (int ___argc, char *const *___argv,
  149             const char *__shortopts,
  150                 const struct option *__longopts, int *__longind);
  151 extern int getopt_long_only (int ___argc, char *const *___argv,
  152                  const char *__shortopts,
  153                      const struct option *__longopts, int *__longind);
  154 
  155 /* Internal only.  Users should not call this directly.  */
  156 extern int _getopt_internal (int ___argc, char *const *___argv,
  157                  const char *__shortopts,
  158                      const struct option *__longopts, int *__longind,
  159                  int __long_only);
  160 #endif
  161 
  162 #ifdef  __cplusplus
  163 }
  164 #endif
  165 
  166 /* Make sure we later can get all the definitions and declarations.  */
  167 #undef __need_getopt
  168 
  169 #endif /* getopt.h */