Blame examples/getopt/getopt.h

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