Blame lib/getopt-ext.h

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