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