Blame lib/getopt-ext.h

Packit 33f14e
/* Declarations for getopt (GNU extensions).
Packit 33f14e
   Copyright (C) 1989-2017 Free Software Foundation, Inc.
Packit 33f14e
   This file is part of the GNU C Library and is also part of gnulib.
Packit 33f14e
   Patches to this file should be submitted to both projects.
Packit 33f14e
Packit 33f14e
   The GNU C Library is free software; you can redistribute it and/or
Packit 33f14e
   modify it under the terms of the GNU General Public
Packit 33f14e
   License as published by the Free Software Foundation; either
Packit 33f14e
   version 3 of the License, or (at your option) any later version.
Packit 33f14e
Packit 33f14e
   The GNU C Library is distributed in the hope that it will be useful,
Packit 33f14e
   but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 33f14e
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit 33f14e
   General Public License for more details.
Packit 33f14e
Packit 33f14e
   You should have received a copy of the GNU General Public
Packit 33f14e
   License along with the GNU C Library; if not, see
Packit 33f14e
   <http://www.gnu.org/licenses/>.  */
Packit 33f14e
Packit 33f14e
#ifndef _GETOPT_EXT_H
Packit 33f14e
#define _GETOPT_EXT_H 1
Packit 33f14e
Packit 33f14e
/* This header should not be used directly; include getopt.h instead.
Packit 33f14e
   Unlike most bits headers, it does not have a protective #error,
Packit 33f14e
   because the guard macro for getopt.h in gnulib is not fixed.  */
Packit 33f14e
Packit 33f14e
__BEGIN_DECLS
Packit 33f14e
Packit 33f14e
/* Describe the long-named options requested by the application.
Packit 33f14e
   The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
Packit 33f14e
   of 'struct option' terminated by an element containing a name which is
Packit 33f14e
   zero.
Packit 33f14e
Packit 33f14e
   The field 'has_arg' is:
Packit 33f14e
   no_argument		(or 0) if the option does not take an argument,
Packit 33f14e
   required_argument	(or 1) if the option requires an argument,
Packit 33f14e
   optional_argument 	(or 2) if the option takes an optional argument.
Packit 33f14e
Packit 33f14e
   If the field 'flag' is not NULL, it points to a variable that is set
Packit 33f14e
   to the value given in the field 'val' when the option is found, but
Packit 33f14e
   left unchanged if the option is not found.
Packit 33f14e
Packit 33f14e
   To have a long-named option do something other than set an 'int' to
Packit 33f14e
   a compiled-in constant, such as set a value from 'optarg', set the
Packit 33f14e
   option's 'flag' field to zero and its 'val' field to a nonzero
Packit 33f14e
   value (the equivalent single-letter option character, if there is
Packit 33f14e
   one).  For long options that have a zero 'flag' field, 'getopt'
Packit 33f14e
   returns the contents of the 'val' field.  */
Packit 33f14e
Packit 33f14e
struct option
Packit 33f14e
{
Packit 33f14e
  const char *name;
Packit 33f14e
  /* has_arg can't be an enum because some compilers complain about
Packit 33f14e
     type mismatches in all the code that assumes it is an int.  */
Packit 33f14e
  int has_arg;
Packit 33f14e
  int *flag;
Packit 33f14e
  int val;
Packit 33f14e
};
Packit 33f14e
Packit 33f14e
/* Names for the values of the 'has_arg' field of 'struct option'.  */
Packit 33f14e
Packit 33f14e
#define no_argument		0
Packit 33f14e
#define required_argument	1
Packit 33f14e
#define optional_argument	2
Packit 33f14e
Packit 33f14e
extern int getopt_long (int ___argc, char *__getopt_argv_const *___argv,
Packit 33f14e
			const char *__shortopts,
Packit 33f14e
		        const struct option *__longopts, int *__longind)
Packit 33f14e
       __THROW _GL_ARG_NONNULL ((2, 3));
Packit 33f14e
extern int getopt_long_only (int ___argc, char *__getopt_argv_const *___argv,
Packit 33f14e
			     const char *__shortopts,
Packit 33f14e
		             const struct option *__longopts, int *__longind)
Packit 33f14e
       __THROW _GL_ARG_NONNULL ((2, 3));
Packit 33f14e
Packit 33f14e
__END_DECLS
Packit 33f14e
Packit 33f14e
#endif /* _GETOPT_EXT_H */