Blame getopt.h

Packit 3f21c4
/* Declarations for getopt.
Packit 3f21c4
   Copyright (C) 1989-1994, 1996-1999, 2001 Free Software Foundation, Inc.
Packit 3f21c4
   This file is part of the GNU C Library.
Packit 3f21c4
Packit 3f21c4
   The GNU C Library is free software; you can redistribute it and/or
Packit 3f21c4
   modify it under the terms of the GNU Lesser General Public
Packit 3f21c4
   License as published by the Free Software Foundation; either
Packit 3f21c4
   version 2.1 of the License, or (at your option) any later version.
Packit 3f21c4
Packit 3f21c4
   The GNU C Library is distributed in the hope that it will be useful,
Packit 3f21c4
   but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 3f21c4
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit 3f21c4
   Lesser General Public License for more details.
Packit 3f21c4
Packit 3f21c4
   You should have received a copy of the GNU Lesser General Public
Packit 3f21c4
   License along with the GNU C Library; if not, write to the Free
Packit 3f21c4
   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
Packit 3f21c4
   02111-1307 USA.  */
Packit 3f21c4
Packit 3f21c4
#ifndef _GETOPT_H
Packit 3f21c4
Packit 3f21c4
#ifndef __need_getopt
Packit 3f21c4
# define _GETOPT_H 1
Packit 3f21c4
#endif
Packit 3f21c4
Packit 3f21c4
/* If __GNU_LIBRARY__ is not already defined, either we are being used
Packit 3f21c4
   standalone, or this is the first header included in the source file.
Packit 3f21c4
   If we are being used with glibc, we need to include <features.h>, but
Packit 3f21c4
   that does not exist if we are standalone.  So: if __GNU_LIBRARY__ is
Packit 3f21c4
   not defined, include <ctype.h>, which will pull in <features.h> for us
Packit 3f21c4
   if it's from glibc.  (Why ctype.h?  It's guaranteed to exist and it
Packit 3f21c4
   doesn't flood the namespace with stuff the way some other headers do.)  */
Packit 3f21c4
#if !defined __GNU_LIBRARY__
Packit 3f21c4
# include <ctype.h>
Packit 3f21c4
#endif
Packit 3f21c4
Packit 3f21c4
#ifdef	__cplusplus
Packit 3f21c4
extern "C"
Packit 3f21c4
{
Packit 3f21c4
#endif
Packit 3f21c4
Packit 3f21c4
/* For communication from `getopt' to the caller.
Packit 3f21c4
   When `getopt' finds an option that takes an argument,
Packit 3f21c4
   the argument value is returned here.
Packit 3f21c4
   Also, when `ordering' is RETURN_IN_ORDER,
Packit 3f21c4
   each non-option ARGV-element is returned here.  */
Packit 3f21c4
Packit 3f21c4
extern char *optarg;
Packit 3f21c4
Packit 3f21c4
/* Index in ARGV of the next element to be scanned.
Packit 3f21c4
   This is used for communication to and from the caller
Packit 3f21c4
   and for communication between successive calls to `getopt'.
Packit 3f21c4
Packit 3f21c4
   On entry to `getopt', zero means this is the first call; initialize.
Packit 3f21c4
Packit 3f21c4
   When `getopt' returns -1, this is the index of the first of the
Packit 3f21c4
   non-option elements that the caller should itself scan.
Packit 3f21c4
Packit 3f21c4
   Otherwise, `optind' communicates from one call to the next
Packit 3f21c4
   how much of ARGV has been scanned so far.  */
Packit 3f21c4
Packit 3f21c4
extern int optind;
Packit 3f21c4
Packit 3f21c4
/* Callers store zero here to inhibit the error message `getopt' prints
Packit 3f21c4
   for unrecognized options.  */
Packit 3f21c4
Packit 3f21c4
extern int opterr;
Packit 3f21c4
Packit 3f21c4
/* Set to an option character which was unrecognized.  */
Packit 3f21c4
Packit 3f21c4
extern int optopt;
Packit 3f21c4
Packit 3f21c4
#ifndef __need_getopt
Packit 3f21c4
/* Describe the long-named options requested by the application.
Packit 3f21c4
   The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
Packit 3f21c4
   of `struct option' terminated by an element containing a name which is
Packit 3f21c4
   zero.
Packit 3f21c4
Packit 3f21c4
   The field `has_arg' is:
Packit 3f21c4
   no_argument		(or 0) if the option does not take an argument,
Packit 3f21c4
   required_argument	(or 1) if the option requires an argument,
Packit 3f21c4
   optional_argument 	(or 2) if the option takes an optional argument.
Packit 3f21c4
Packit 3f21c4
   If the field `flag' is not NULL, it points to a variable that is set
Packit 3f21c4
   to the value given in the field `val' when the option is found, but
Packit 3f21c4
   left unchanged if the option is not found.
Packit 3f21c4
Packit 3f21c4
   To have a long-named option do something other than set an `int' to
Packit 3f21c4
   a compiled-in constant, such as set a value from `optarg', set the
Packit 3f21c4
   option's `flag' field to zero and its `val' field to a nonzero
Packit 3f21c4
   value (the equivalent single-letter option character, if there is
Packit 3f21c4
   one).  For long options that have a zero `flag' field, `getopt'
Packit 3f21c4
   returns the contents of the `val' field.  */
Packit 3f21c4
Packit 3f21c4
struct option {
Packit 3f21c4
# if (defined __STDC__ && __STDC__) || defined __cplusplus
Packit 3f21c4
    const char *name;
Packit 3f21c4
# else
Packit 3f21c4
    char *name;
Packit 3f21c4
# endif
Packit 3f21c4
    /* has_arg can't be an enum because some compilers complain about
Packit 3f21c4
       type mismatches in all the code that assumes it is an int.  */
Packit 3f21c4
    int has_arg;
Packit 3f21c4
    int *flag;
Packit 3f21c4
    int val;
Packit 3f21c4
};
Packit 3f21c4
Packit 3f21c4
/* Names for the values of the `has_arg' field of `struct option'.  */
Packit 3f21c4
Packit 3f21c4
# define no_argument		0
Packit 3f21c4
# define required_argument	1
Packit 3f21c4
# define optional_argument	2
Packit 3f21c4
#endif                          /* need getopt */
Packit 3f21c4
Packit 3f21c4
/* Get definitions and prototypes for functions to process the
Packit 3f21c4
   arguments in ARGV (ARGC of them, minus the program name) for
Packit 3f21c4
   options given in OPTS.
Packit 3f21c4
Packit 3f21c4
   Return the option character from OPTS just read.  Return -1 when
Packit 3f21c4
   there are no more options.  For unrecognized options, or options
Packit 3f21c4
   missing arguments, `optopt' is set to the option letter, and '?' is
Packit 3f21c4
   returned.
Packit 3f21c4
Packit 3f21c4
   The OPTS string is a list of characters which are recognized option
Packit 3f21c4
   letters, optionally followed by colons, specifying that that letter
Packit 3f21c4
   takes an argument, to be placed in `optarg'.
Packit 3f21c4
Packit 3f21c4
   If a letter in OPTS is followed by two colons, its argument is
Packit 3f21c4
   optional.  This behavior is specific to the GNU `getopt'.
Packit 3f21c4
Packit 3f21c4
   The argument `--' causes premature termination of argument
Packit 3f21c4
   scanning, explicitly telling `getopt' that there are no more
Packit 3f21c4
   options.
Packit 3f21c4
Packit 3f21c4
   If OPTS begins with `--', then non-option arguments are treated as
Packit 3f21c4
   arguments to the option '\0'.  This behavior is specific to the GNU
Packit 3f21c4
   `getopt'.  */
Packit 3f21c4
Packit 3f21c4
#if (defined __STDC__ && __STDC__) || defined __cplusplus
Packit 3f21c4
# ifdef __GNU_LIBRARY__
Packit 3f21c4
/* Many other libraries have conflicting prototypes for getopt, with
Packit 3f21c4
   differences in the consts, in stdlib.h.  To avoid compilation
Packit 3f21c4
   errors, only prototype getopt for the GNU C library.  */
Packit 3f21c4
extern int getopt(int __argc, char *const *__argv, const char *__shortopts);
Packit 3f21c4
# else                          /* not __GNU_LIBRARY__ */
Packit 3f21c4
extern int getopt();
Packit 3f21c4
# endif                         /* __GNU_LIBRARY__ */
Packit 3f21c4
Packit 3f21c4
# ifndef __need_getopt
Packit 3f21c4
extern int getopt_long(int __argc, char *const *__argv, const char *__shortopts, const struct option *__longopts, int *__longind);
Packit 3f21c4
extern int getopt_long_only(int __argc, char *const *__argv, const char *__shortopts, const struct option *__longopts, int *__longind);
Packit 3f21c4
Packit 3f21c4
/* Internal only.  Users should not call this directly.  */
Packit 3f21c4
extern int _getopt_internal(int __argc, char *const *__argv, const char *__shortopts, const struct option *__longopts, int *__longind, int __long_only);
Packit 3f21c4
# endif
Packit 3f21c4
#else                           /* not __STDC__ */
Packit 3f21c4
extern int getopt();
Packit 3f21c4
# ifndef __need_getopt
Packit 3f21c4
extern int getopt_long();
Packit 3f21c4
extern int getopt_long_only();
Packit 3f21c4
Packit 3f21c4
extern int _getopt_internal();
Packit 3f21c4
# endif
Packit 3f21c4
#endif                          /* __STDC__ */
Packit 3f21c4
Packit 3f21c4
#ifdef	__cplusplus
Packit 3f21c4
}
Packit 3f21c4
#endif
Packit 3f21c4
Packit 3f21c4
/* Make sure we later can get all the definitions and declarations.  */
Packit 3f21c4
#undef __need_getopt
Packit 3f21c4
Packit 3f21c4
#endif                          /* getopt.h */