getopt.h 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191
  1. /* Declarations for getopt.
  2. Copyright (C) 1989-2016 Free Software Foundation, Inc.
  3. This file is part of the GNU C Library.
  4. The GNU C Library is free software; you can redistribute it and/or
  5. modify it under the terms of the GNU Lesser General Public
  6. License as published by the Free Software Foundation; either
  7. version 2.1 of the License, or (at your option) any later version.
  8. The GNU C Library is distributed in the hope that it will be useful,
  9. but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11. Lesser General Public License for more details.
  12. You should have received a copy of the GNU Lesser General Public
  13. License along with the GNU C Library; if not, see
  14. <http://www.gnu.org/licenses/>. */
  15. #ifndef _GETOPT_H
  16. #ifndef __need_getopt
  17. # define _GETOPT_H 1
  18. #endif
  19. /* If __GNU_LIBRARY__ is not already defined, either we are being used
  20. standalone, or this is the first header included in the source file.
  21. If we are being used with glibc, we need to include <features.h>, but
  22. that does not exist if we are standalone. So: if __GNU_LIBRARY__ is
  23. not defined, include <ctype.h>, which will pull in <features.h> for us
  24. if it's from glibc. (Why ctype.h? It's guaranteed to exist and it
  25. doesn't flood the namespace with stuff the way some other headers do.) */
  26. #if !defined __GNU_LIBRARY__
  27. # include <ctype.h>
  28. #endif
  29. #ifndef __THROW
  30. # ifndef __GNUC_PREREQ
  31. # define __GNUC_PREREQ(maj, min) (0)
  32. # endif
  33. # if defined __cplusplus && __GNUC_PREREQ (2,8)
  34. # define __THROW throw ()
  35. # else
  36. # define __THROW
  37. # endif
  38. #endif
  39. #ifdef __cplusplus
  40. extern "C" {
  41. #endif
  42. /* For communication from `getopt' to the caller.
  43. When `getopt' finds an option that takes an argument,
  44. the argument value is returned here.
  45. Also, when `ordering' is RETURN_IN_ORDER,
  46. each non-option ARGV-element is returned here. */
  47. extern char *optarg;
  48. /* Index in ARGV of the next element to be scanned.
  49. This is used for communication to and from the caller
  50. and for communication between successive calls to `getopt'.
  51. On entry to `getopt', zero means this is the first call; initialize.
  52. When `getopt' returns -1, this is the index of the first of the
  53. non-option elements that the caller should itself scan.
  54. Otherwise, `optind' communicates from one call to the next
  55. how much of ARGV has been scanned so far. */
  56. extern int optind;
  57. /* Callers store zero here to inhibit the error message `getopt' prints
  58. for unrecognized options. */
  59. extern int opterr;
  60. /* Set to an option character which was unrecognized. */
  61. extern int optopt;
  62. #ifndef __need_getopt
  63. /* Describe the long-named options requested by the application.
  64. The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
  65. of `struct option' terminated by an element containing a name which is
  66. zero.
  67. The field `has_arg' is:
  68. no_argument (or 0) if the option does not take an argument,
  69. required_argument (or 1) if the option requires an argument,
  70. optional_argument (or 2) if the option takes an optional argument.
  71. If the field `flag' is not NULL, it points to a variable that is set
  72. to the value given in the field `val' when the option is found, but
  73. left unchanged if the option is not found.
  74. To have a long-named option do something other than set an `int' to
  75. a compiled-in constant, such as set a value from `optarg', set the
  76. option's `flag' field to zero and its `val' field to a nonzero
  77. value (the equivalent single-letter option character, if there is
  78. one). For long options that have a zero `flag' field, `getopt'
  79. returns the contents of the `val' field. */
  80. struct option
  81. {
  82. const char *name;
  83. /* has_arg can't be an enum because some compilers complain about
  84. type mismatches in all the code that assumes it is an int. */
  85. int has_arg;
  86. int *flag;
  87. int val;
  88. };
  89. /* Names for the values of the `has_arg' field of `struct option'. */
  90. # define no_argument 0
  91. # define required_argument 1
  92. # define optional_argument 2
  93. #endif /* need getopt */
  94. /* Get definitions and prototypes for functions to process the
  95. arguments in ARGV (ARGC of them, minus the program name) for
  96. options given in OPTS.
  97. Return the option character from OPTS just read. Return -1 when
  98. there are no more options. For unrecognized options, or options
  99. missing arguments, `optopt' is set to the option letter, and '?' is
  100. returned.
  101. The OPTS string is a list of characters which are recognized option
  102. letters, optionally followed by colons, specifying that that letter
  103. takes an argument, to be placed in `optarg'.
  104. If a letter in OPTS is followed by two colons, its argument is
  105. optional. This behavior is specific to the GNU `getopt'.
  106. The argument `--' causes premature termination of argument
  107. scanning, explicitly telling `getopt' that there are no more
  108. options.
  109. If OPTS begins with `--', then non-option arguments are treated as
  110. arguments to the option '\0'. This behavior is specific to the GNU
  111. `getopt'. */
  112. #ifdef __GNU_LIBRARY__
  113. /* Many other libraries have conflicting prototypes for getopt, with
  114. differences in the consts, in stdlib.h. To avoid compilation
  115. errors, only prototype getopt for the GNU C library. */
  116. extern int getopt (int ___argc, char *const *___argv, const char *__shortopts)
  117. __THROW;
  118. # if defined __need_getopt && defined __USE_POSIX2 \
  119. && !defined __USE_POSIX_IMPLICITLY && !defined __USE_GNU
  120. /* The GNU getopt has more functionality than the standard version. The
  121. additional functionality can be disable at runtime. This redirection
  122. helps to also do this at runtime. */
  123. # ifdef __REDIRECT
  124. extern int __REDIRECT_NTH (getopt, (int ___argc, char *const *___argv,
  125. const char *__shortopts),
  126. __posix_getopt);
  127. # else
  128. extern int __posix_getopt (int ___argc, char *const *___argv,
  129. const char *__shortopts) __THROW;
  130. # define getopt __posix_getopt
  131. # endif
  132. # endif
  133. #else /* not __GNU_LIBRARY__ */
  134. extern int getopt ();
  135. #endif /* __GNU_LIBRARY__ */
  136. #ifndef __need_getopt
  137. extern int getopt_long (int ___argc, char *const *___argv,
  138. const char *__shortopts,
  139. const struct option *__longopts, int *__longind)
  140. __THROW;
  141. extern int getopt_long_only (int ___argc, char *const *___argv,
  142. const char *__shortopts,
  143. const struct option *__longopts, int *__longind)
  144. __THROW;
  145. #endif
  146. #ifdef __cplusplus
  147. }
  148. #endif
  149. /* Make sure we later can get all the definitions and declarations. */
  150. #undef __need_getopt
  151. #endif /* getopt.h */