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