getopt.h 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266
  1. /* DO NOT EDIT! GENERATED AUTOMATICALLY! */
  2. /* Declarations for getopt.
  3. Copyright (C) 1989-1994, 1996-1999, 2001, 2003-2007, 2009-2013 Free Software
  4. Foundation, Inc.
  5. This file is part of the GNU C Library.
  6. This program is free software: you can redistribute it and/or modify
  7. it under the terms of the GNU General Public License as published by
  8. the Free Software Foundation; either version 3 of the License, or
  9. (at your option) any later version.
  10. This program is distributed in the hope that it will be useful,
  11. but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. GNU General Public License for more details.
  14. You should have received a copy of the GNU General Public License
  15. along with this program. If not, see <http://www.gnu.org/licenses/>. */
  16. #ifndef _GL_M4_GETOPT_H
  17. #if __GNUC__ >= 3
  18. #endif
  19. /* The include_next requires a split double-inclusion guard. We must
  20. also inform the replacement unistd.h to not recursively use
  21. <getopt.h>; our definitions will be present soon enough. */
  22. #if 0
  23. # define _GL_SYSTEM_GETOPT
  24. # include <getopt.h>
  25. # undef _GL_SYSTEM_GETOPT
  26. #endif
  27. #ifndef _GL_M4_GETOPT_H
  28. #ifndef __need_getopt
  29. # define _GL_M4_GETOPT_H 1
  30. #endif
  31. /* Standalone applications should #define __GETOPT_PREFIX to an
  32. identifier that prefixes the external functions and variables
  33. defined in this header. When this happens, include the
  34. headers that might declare getopt so that they will not cause
  35. confusion if included after this file (if the system had <getopt.h>,
  36. we have already included it). Then systematically rename
  37. identifiers so that they do not collide with the system functions
  38. and variables. Renaming avoids problems with some compilers and
  39. linkers. */
  40. #if defined __GETOPT_PREFIX && !defined __need_getopt
  41. # if !0
  42. # define __need_system_stdlib_h
  43. # include <stdlib.h>
  44. # undef __need_system_stdlib_h
  45. # include <stdio.h>
  46. # include <unistd.h>
  47. # endif
  48. # undef __need_getopt
  49. # undef getopt
  50. # undef getopt_long
  51. # undef getopt_long_only
  52. # undef optarg
  53. # undef opterr
  54. # undef optind
  55. # undef optopt
  56. # undef option
  57. # define __GETOPT_CONCAT(x, y) x ## y
  58. # define __GETOPT_XCONCAT(x, y) __GETOPT_CONCAT (x, y)
  59. # define __GETOPT_ID(y) __GETOPT_XCONCAT (__GETOPT_PREFIX, y)
  60. # define getopt __GETOPT_ID (getopt)
  61. # define getopt_long __GETOPT_ID (getopt_long)
  62. # define getopt_long_only __GETOPT_ID (getopt_long_only)
  63. # define optarg __GETOPT_ID (optarg)
  64. # define opterr __GETOPT_ID (opterr)
  65. # define optind __GETOPT_ID (optind)
  66. # define optopt __GETOPT_ID (optopt)
  67. # define option __GETOPT_ID (option)
  68. # define _getopt_internal __GETOPT_ID (getopt_internal)
  69. #endif
  70. /* Standalone applications get correct prototypes for getopt_long and
  71. getopt_long_only; they declare "char **argv". libc uses prototypes
  72. with "char *const *argv" that are incorrect because getopt_long and
  73. getopt_long_only can permute argv; this is required for backward
  74. compatibility (e.g., for LSB 2.0.1).
  75. This used to be '#if defined __GETOPT_PREFIX && !defined __need_getopt',
  76. but it caused redefinition warnings if both unistd.h and getopt.h were
  77. included, since unistd.h includes getopt.h having previously defined
  78. __need_getopt.
  79. The only place where __getopt_argv_const is used is in definitions
  80. of getopt_long and getopt_long_only below, but these are visible
  81. only if __need_getopt is not defined, so it is quite safe to rewrite
  82. the conditional as follows:
  83. */
  84. #if !defined __need_getopt
  85. # if defined __GETOPT_PREFIX
  86. # define __getopt_argv_const /* empty */
  87. # else
  88. # define __getopt_argv_const const
  89. # endif
  90. #endif
  91. /* If __GNU_LIBRARY__ is not already defined, either we are being used
  92. standalone, or this is the first header included in the source file.
  93. If we are being used with glibc, we need to include <features.h>, but
  94. that does not exist if we are standalone. So: if __GNU_LIBRARY__ is
  95. not defined, include <ctype.h>, which will pull in <features.h> for us
  96. if it's from glibc. (Why ctype.h? It's guaranteed to exist and it
  97. doesn't flood the namespace with stuff the way some other headers do.) */
  98. #if !defined __GNU_LIBRARY__
  99. # include <ctype.h>
  100. #endif
  101. #ifndef __THROW
  102. # ifndef __GNUC_PREREQ
  103. # define __GNUC_PREREQ(maj, min) (0)
  104. # endif
  105. # if defined __cplusplus && __GNUC_PREREQ (2,8)
  106. # define __THROW noexcept
  107. # else
  108. # define __THROW
  109. # endif
  110. #endif
  111. /* The definition of _GL_ARG_NONNULL is copied here. */
  112. /* _GL_ARG_NONNULL((n,...,m)) tells the compiler and static analyzer tools
  113. that the values passed as arguments n, ..., m must be non-NULL pointers.
  114. n = 1 stands for the first argument, n = 2 for the second argument etc. */
  115. #ifndef _GL_ARG_NONNULL
  116. # if (__GNUC__ == 3 && __GNUC_MINOR__ >= 3) || __GNUC__ > 3
  117. # define _GL_ARG_NONNULL(params) __attribute__ ((__nonnull__ params))
  118. # else
  119. # define _GL_ARG_NONNULL(params)
  120. # endif
  121. #endif
  122. #ifdef __cplusplus
  123. extern "C" {
  124. #endif
  125. /* For communication from 'getopt' to the caller.
  126. When 'getopt' finds an option that takes an argument,
  127. the argument value is returned here.
  128. Also, when 'ordering' is RETURN_IN_ORDER,
  129. each non-option ARGV-element is returned here. */
  130. extern char *optarg;
  131. /* Index in ARGV of the next element to be scanned.
  132. This is used for communication to and from the caller
  133. and for communication between successive calls to 'getopt'.
  134. On entry to 'getopt', zero means this is the first call; initialize.
  135. When 'getopt' returns -1, this is the index of the first of the
  136. non-option elements that the caller should itself scan.
  137. Otherwise, 'optind' communicates from one call to the next
  138. how much of ARGV has been scanned so far. */
  139. extern int optind;
  140. /* Callers store zero here to inhibit the error message 'getopt' prints
  141. for unrecognized options. */
  142. extern int opterr;
  143. /* Set to an option character which was unrecognized. */
  144. extern int optopt;
  145. #ifndef __need_getopt
  146. /* Describe the long-named options requested by the application.
  147. The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
  148. of 'struct option' terminated by an element containing a name which is
  149. zero.
  150. The field 'has_arg' is:
  151. no_argument (or 0) if the option does not take an argument,
  152. required_argument (or 1) if the option requires an argument,
  153. optional_argument (or 2) if the option takes an optional argument.
  154. If the field 'flag' is not NULL, it points to a variable that is set
  155. to the value given in the field 'val' when the option is found, but
  156. left unchanged if the option is not found.
  157. To have a long-named option do something other than set an 'int' to
  158. a compiled-in constant, such as set a value from 'optarg', set the
  159. option's 'flag' field to zero and its 'val' field to a nonzero
  160. value (the equivalent single-letter option character, if there is
  161. one). For long options that have a zero 'flag' field, 'getopt'
  162. returns the contents of the 'val' field. */
  163. # if !GNULIB_defined_struct_option
  164. struct option
  165. {
  166. const char *name;
  167. /* has_arg can't be an enum because some compilers complain about
  168. type mismatches in all the code that assumes it is an int. */
  169. int has_arg;
  170. int *flag;
  171. int val;
  172. };
  173. # define GNULIB_defined_struct_option 1
  174. # endif
  175. /* Names for the values of the 'has_arg' field of 'struct option'. */
  176. # define no_argument 0
  177. # define required_argument 1
  178. # define optional_argument 2
  179. #endif /* need getopt */
  180. /* Get definitions and prototypes for functions to process the
  181. arguments in ARGV (ARGC of them, minus the program name) for
  182. options given in OPTS.
  183. Return the option character from OPTS just read. Return -1 when
  184. there are no more options. For unrecognized options, or options
  185. missing arguments, 'optopt' is set to the option letter, and '?' is
  186. returned.
  187. The OPTS string is a list of characters which are recognized option
  188. letters, optionally followed by colons, specifying that that letter
  189. takes an argument, to be placed in 'optarg'.
  190. If a letter in OPTS is followed by two colons, its argument is
  191. optional. This behavior is specific to the GNU 'getopt'.
  192. The argument '--' causes premature termination of argument
  193. scanning, explicitly telling 'getopt' that there are no more
  194. options.
  195. If OPTS begins with '-', then non-option arguments are treated as
  196. arguments to the option '\1'. This behavior is specific to the GNU
  197. 'getopt'. If OPTS begins with '+', or POSIXLY_CORRECT is set in
  198. the environment, then do not permute arguments. */
  199. extern int getopt (int ___argc, char *const *___argv, const char *__shortopts)
  200. __THROW _GL_ARG_NONNULL ((2, 3));
  201. #ifndef __need_getopt
  202. extern int getopt_long (int ___argc, char *__getopt_argv_const *___argv,
  203. const char *__shortopts,
  204. const struct option *__longopts, int *__longind)
  205. __THROW _GL_ARG_NONNULL ((2, 3));
  206. extern int getopt_long_only (int ___argc, char *__getopt_argv_const *___argv,
  207. const char *__shortopts,
  208. const struct option *__longopts, int *__longind)
  209. __THROW _GL_ARG_NONNULL ((2, 3));
  210. #endif
  211. #ifdef __cplusplus
  212. }
  213. #endif
  214. /* Make sure we later can get all the definitions and declarations. */
  215. #undef __need_getopt
  216. #endif /* _GL_M4_GETOPT_H */
  217. #endif /* _GL_M4_GETOPT_H */