getopt.h 6.1 KB

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