pintos-os.org Git - pspp/blob - 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 # ifndef __CONCAT
  48 #  define __CONCAT(x, y) x ## y
  49 # endif
  50 # define getopt __CONCAT (__GETOPT_PREFIX, getopt)
  51 # define getopt_long __CONCAT (__GETOPT_PREFIX, getopt_long)
  52 # define getopt_long_only __CONCAT (__GETOPT_PREFIX, getopt_long_only)
  53 # define optarg __CONCAT (__GETOPT_PREFIX, optarg)
  54 # define opterr __CONCAT (__GETOPT_PREFIX, opterr)
  55 # define optind __CONCAT (__GETOPT_PREFIX, optind)
  56 # define optopt __CONCAT (__GETOPT_PREFIX, optopt)
  57 #endif
  58
  59 /* Standalone applications get correct prototypes for getopt_long and
  60    getopt_long_only; they declare "char **argv".  libc uses prototypes
  61    with "char *const *argv" that are incorrect because getopt_long and
  62    getopt_long_only can permute argv; this is required for backward
  63    compatibility (e.g., for LSB 2.0.1).  */
  64 #if defined __GETOPT_PREFIX && !defined __need_getopt
  65 # define __getopt_argv_const /* empty */
  66 #else
  67 # define __getopt_argv_const const
  68 #endif
  69
  70 /* If __GNU_LIBRARY__ is not already defined, either we are being used
  71    standalone, or this is the first header included in the source file.
  72    If we are being used with glibc, we need to include <features.h>, but
  73    that does not exist if we are standalone.  So: if __GNU_LIBRARY__ is
  74    not defined, include <ctype.h>, which will pull in <features.h> for us
  75    if it's from glibc.  (Why ctype.h?  It's guaranteed to exist and it
  76    doesn't flood the namespace with stuff the way some other headers do.)  */
  77 #if !defined __GNU_LIBRARY__
  78 # include <ctype.h>
  79 #endif
  80
  81 #ifndef __THROW
  82 # ifndef __GNUC_PREREQ
  83 #  define __GNUC_PREREQ(maj, min) (0)
  84 # endif
  85 # if defined __cplusplus && __GNUC_PREREQ (2,8)
  86 #  define __THROW       throw ()
  87 # else
  88 #  define __THROW
  89 # endif
  90 #endif
  91
  92 #ifdef  __cplusplus
  93 extern "C" {
  94 #endif
  95
  96 /* For communication from `getopt' to the caller.
  97    When `getopt' finds an option that takes an argument,
  98    the argument value is returned here.
  99    Also, when `ordering' is RETURN_IN_ORDER,
 100    each non-option ARGV-element is returned here.  */
 101
 102 extern char *optarg;
 103
 104 /* Index in ARGV of the next element to be scanned.
 105    This is used for communication to and from the caller
 106    and for communication between successive calls to `getopt'.
 107
 108    On entry to `getopt', zero means this is the first call; initialize.
 109
 110    When `getopt' returns -1, this is the index of the first of the
 111    non-option elements that the caller should itself scan.
 112
 113    Otherwise, `optind' communicates from one call to the next
 114    how much of ARGV has been scanned so far.  */
 115
 116 extern int optind;
 117
 118 /* Callers store zero here to inhibit the error message `getopt' prints
 119    for unrecognized options.  */
 120
 121 extern int opterr;
 122
 123 /* Set to an option character which was unrecognized.  */
 124
 125 extern int optopt;
 126
 127 #ifndef __need_getopt
 128 /* Describe the long-named options requested by the application.
 129    The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
 130    of `struct option' terminated by an element containing a name which is
 131    zero.
 132
 133    The field `has_arg' is:
 134    no_argument          (or 0) if the option does not take an argument,
 135    required_argument    (or 1) if the option requires an argument,
 136    optional_argument    (or 2) if the option takes an optional argument.
 137
 138    If the field `flag' is not NULL, it points to a variable that is set
 139    to the value given in the field `val' when the option is found, but
 140    left unchanged if the option is not found.
 141
 142    To have a long-named option do something other than set an `int' to
 143    a compiled-in constant, such as set a value from `optarg', set the
 144    option's `flag' field to zero and its `val' field to a nonzero
 145    value (the equivalent single-letter option character, if there is
 146    one).  For long options that have a zero `flag' field, `getopt'
 147    returns the contents of the `val' field.  */
 148
 149 struct option
 150 {
 151   const char *name;
 152   /* has_arg can't be an enum because some compilers complain about
 153      type mismatches in all the code that assumes it is an int.  */
 154   int has_arg;
 155   int *flag;
 156   int val;
 157 };
 158
 159 /* Names for the values of the `has_arg' field of `struct option'.  */
 160
 161 # define no_argument            0
 162 # define required_argument      1
 163 # define optional_argument      2
 164 #endif  /* need getopt */
 165
 166
 167 /* Get definitions and prototypes for functions to process the
 168    arguments in ARGV (ARGC of them, minus the program name) for
 169    options given in OPTS.
 170
 171    Return the option character from OPTS just read.  Return -1 when
 172    there are no more options.  For unrecognized options, or options
 173    missing arguments, `optopt' is set to the option letter, and '?' is
 174    returned.
 175
 176    The OPTS string is a list of characters which are recognized option
 177    letters, optionally followed by colons, specifying that that letter
 178    takes an argument, to be placed in `optarg'.
 179
 180    If a letter in OPTS is followed by two colons, its argument is
 181    optional.  This behavior is specific to the GNU `getopt'.
 182
 183    The argument `--' causes premature termination of argument
 184    scanning, explicitly telling `getopt' that there are no more
 185    options.
 186
 187    If OPTS begins with `--', then non-option arguments are treated as
 188    arguments to the option '\0'.  This behavior is specific to the GNU
 189    `getopt'.  */
 190
 191 extern int getopt (int ___argc, char *const *___argv, const char *__shortopts)
 192        __THROW;
 193
 194 #ifndef __need_getopt
 195 extern int getopt_long (int ___argc, char *__getopt_argv_const *___argv,
 196                         const char *__shortopts,
 197                         const struct option *__longopts, int *__longind)
 198        __THROW;
 199 extern int getopt_long_only (int ___argc, char *__getopt_argv_const *___argv,
 200                              const char *__shortopts,
 201                              const struct option *__longopts, int *__longind)
 202        __THROW;
 203
 204 #endif
 205
 206 #ifdef  __cplusplus
 207 }
 208 #endif
 209
 210 /* Make sure we later can get all the definitions and declarations.  */
 211 #undef __need_getopt
 212
 213 #endif /* getopt.h */