/* Declarations for getopt.
|
/* Declarations for getopt.
|
Copyright 1989, 1990, 1991, 1992, 1993, 1994, 1996, 1997, 1998, 2000,
|
Copyright 1989, 1990, 1991, 1992, 1993, 1994, 1996, 1997, 1998, 2000,
|
2002 Free Software Foundation, Inc.
|
2002 Free Software Foundation, Inc.
|
|
|
NOTE: The canonical source of this file is maintained with the GNU C Library.
|
NOTE: The canonical source of this file is maintained with the GNU C Library.
|
Bugs can be reported to bug-glibc@gnu.org.
|
Bugs can be reported to bug-glibc@gnu.org.
|
|
|
This program is free software; you can redistribute it and/or modify it
|
This program is free software; you can redistribute it and/or modify it
|
under the terms of the GNU General Public License as published by the
|
under the terms of the GNU General Public License as published by the
|
Free Software Foundation; either version 2, or (at your option) any
|
Free Software Foundation; either version 2, or (at your option) any
|
later version.
|
later version.
|
|
|
This program is distributed in the hope that it will be useful,
|
This program is distributed in the hope that it will be useful,
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
GNU General Public License for more details.
|
GNU General Public License for more details.
|
|
|
You should have received a copy of the GNU General Public License
|
You should have received a copy of the GNU General Public License
|
along with this program; if not, write to the Free Software
|
along with this program; if not, write to the Free Software
|
Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301,
|
Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301,
|
USA. */
|
USA. */
|
|
|
#ifndef _GETOPT_H
|
#ifndef _GETOPT_H
|
#define _GETOPT_H 1
|
#define _GETOPT_H 1
|
|
|
#ifdef __cplusplus
|
#ifdef __cplusplus
|
extern "C" {
|
extern "C" {
|
#endif
|
#endif
|
|
|
/* For communication from `getopt' to the caller.
|
/* For communication from `getopt' to the caller.
|
When `getopt' finds an option that takes an argument,
|
When `getopt' finds an option that takes an argument,
|
the argument value is returned here.
|
the argument value is returned here.
|
Also, when `ordering' is RETURN_IN_ORDER,
|
Also, when `ordering' is RETURN_IN_ORDER,
|
each non-option ARGV-element is returned here. */
|
each non-option ARGV-element is returned here. */
|
|
|
extern char *optarg;
|
extern char *optarg;
|
|
|
/* Index in ARGV of the next element to be scanned.
|
/* Index in ARGV of the next element to be scanned.
|
This is used for communication to and from the caller
|
This is used for communication to and from the caller
|
and for communication between successive calls to `getopt'.
|
and for communication between successive calls to `getopt'.
|
|
|
On entry to `getopt', zero means this is the first call; initialize.
|
On entry to `getopt', zero means this is the first call; initialize.
|
|
|
When `getopt' returns -1, this is the index of the first of the
|
When `getopt' returns -1, this is the index of the first of the
|
non-option elements that the caller should itself scan.
|
non-option elements that the caller should itself scan.
|
|
|
Otherwise, `optind' communicates from one call to the next
|
Otherwise, `optind' communicates from one call to the next
|
how much of ARGV has been scanned so far. */
|
how much of ARGV has been scanned so far. */
|
|
|
extern int optind;
|
extern int optind;
|
|
|
/* Callers store zero here to inhibit the error message `getopt' prints
|
/* Callers store zero here to inhibit the error message `getopt' prints
|
for unrecognized options. */
|
for unrecognized options. */
|
|
|
extern int opterr;
|
extern int opterr;
|
|
|
/* Set to an option character which was unrecognized. */
|
/* Set to an option character which was unrecognized. */
|
|
|
extern int optopt;
|
extern int optopt;
|
|
|
/* Describe the long-named options requested by the application.
|
/* Describe the long-named options requested by the application.
|
The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
|
The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
|
of `struct option' terminated by an element containing a name which is
|
of `struct option' terminated by an element containing a name which is
|
zero.
|
zero.
|
|
|
The field `has_arg' is:
|
The field `has_arg' is:
|
no_argument (or 0) if the option does not take an argument,
|
no_argument (or 0) if the option does not take an argument,
|
required_argument (or 1) if the option requires an argument,
|
required_argument (or 1) if the option requires an argument,
|
optional_argument (or 2) if the option takes an optional argument.
|
optional_argument (or 2) if the option takes an optional argument.
|
|
|
If the field `flag' is not NULL, it points to a variable that is set
|
If the field `flag' is not NULL, it points to a variable that is set
|
to the value given in the field `val' when the option is found, but
|
to the value given in the field `val' when the option is found, but
|
left unchanged if the option is not found.
|
left unchanged if the option is not found.
|
|
|
To have a long-named option do something other than set an `int' to
|
To have a long-named option do something other than set an `int' to
|
a compiled-in constant, such as set a value from `optarg', set the
|
a compiled-in constant, such as set a value from `optarg', set the
|
option's `flag' field to zero and its `val' field to a nonzero
|
option's `flag' field to zero and its `val' field to a nonzero
|
value (the equivalent single-letter option character, if there is
|
value (the equivalent single-letter option character, if there is
|
one). For long options that have a zero `flag' field, `getopt'
|
one). For long options that have a zero `flag' field, `getopt'
|
returns the contents of the `val' field. */
|
returns the contents of the `val' field. */
|
|
|
struct option
|
struct option
|
{
|
{
|
#if defined (__STDC__) && __STDC__
|
#if defined (__STDC__) && __STDC__
|
const char *name;
|
const char *name;
|
#else
|
#else
|
char *name;
|
char *name;
|
#endif
|
#endif
|
/* has_arg can't be an enum because some compilers complain about
|
/* has_arg can't be an enum because some compilers complain about
|
type mismatches in all the code that assumes it is an int. */
|
type mismatches in all the code that assumes it is an int. */
|
int has_arg;
|
int has_arg;
|
int *flag;
|
int *flag;
|
int val;
|
int val;
|
};
|
};
|
|
|
/* Names for the values of the `has_arg' field of `struct option'. */
|
/* Names for the values of the `has_arg' field of `struct option'. */
|
|
|
#define no_argument 0
|
#define no_argument 0
|
#define required_argument 1
|
#define required_argument 1
|
#define optional_argument 2
|
#define optional_argument 2
|
|
|
#if defined (__STDC__) && __STDC__
|
#if defined (__STDC__) && __STDC__
|
/* HAVE_DECL_* is a three-state macro: undefined, 0 or 1. If it is
|
/* HAVE_DECL_* is a three-state macro: undefined, 0 or 1. If it is
|
undefined, we haven't run the autoconf check so provide the
|
undefined, we haven't run the autoconf check so provide the
|
declaration without arguments. If it is 0, we checked and failed
|
declaration without arguments. If it is 0, we checked and failed
|
to find the declaration so provide a fully prototyped one. If it
|
to find the declaration so provide a fully prototyped one. If it
|
is 1, we found it so don't provide any declaration at all. */
|
is 1, we found it so don't provide any declaration at all. */
|
#if !HAVE_DECL_GETOPT
|
#if !HAVE_DECL_GETOPT
|
#if defined (__GNU_LIBRARY__) || defined (HAVE_DECL_GETOPT)
|
#if defined (__GNU_LIBRARY__) || defined (HAVE_DECL_GETOPT)
|
/* Many other libraries have conflicting prototypes for getopt, with
|
/* Many other libraries have conflicting prototypes for getopt, with
|
differences in the consts, in unistd.h. To avoid compilation
|
differences in the consts, in unistd.h. To avoid compilation
|
errors, only prototype getopt for the GNU C library. */
|
errors, only prototype getopt for the GNU C library. */
|
extern int getopt (int argc, char *const *argv, const char *shortopts);
|
extern int getopt (int argc, char *const *argv, const char *shortopts);
|
#else
|
#else
|
#ifndef __cplusplus
|
#ifndef __cplusplus
|
extern int getopt ();
|
extern int getopt ();
|
#endif /* __cplusplus */
|
#endif /* __cplusplus */
|
#endif
|
#endif
|
#endif /* !HAVE_DECL_GETOPT */
|
#endif /* !HAVE_DECL_GETOPT */
|
|
|
extern int getopt_long (int argc, char *const *argv, const char *shortopts,
|
extern int getopt_long (int argc, char *const *argv, const char *shortopts,
|
const struct option *longopts, int *longind);
|
const struct option *longopts, int *longind);
|
extern int getopt_long_only (int argc, char *const *argv,
|
extern int getopt_long_only (int argc, char *const *argv,
|
const char *shortopts,
|
const char *shortopts,
|
const struct option *longopts, int *longind);
|
const struct option *longopts, int *longind);
|
|
|
/* Internal only. Users should not call this directly. */
|
/* Internal only. Users should not call this directly. */
|
extern int _getopt_internal (int argc, char *const *argv,
|
extern int _getopt_internal (int argc, char *const *argv,
|
const char *shortopts,
|
const char *shortopts,
|
const struct option *longopts, int *longind,
|
const struct option *longopts, int *longind,
|
int long_only);
|
int long_only);
|
#else /* not __STDC__ */
|
#else /* not __STDC__ */
|
extern int getopt ();
|
extern int getopt ();
|
extern int getopt_long ();
|
extern int getopt_long ();
|
extern int getopt_long_only ();
|
extern int getopt_long_only ();
|
|
|
extern int _getopt_internal ();
|
extern int _getopt_internal ();
|
#endif /* __STDC__ */
|
#endif /* __STDC__ */
|
|
|
#ifdef __cplusplus
|
#ifdef __cplusplus
|
}
|
}
|
#endif
|
#endif
|
|
|
#endif /* getopt.h */
|
#endif /* getopt.h */
|
|
|
