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