Blame gnulib/lib/getopt-ext.h

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