lib/getopt_.h

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