getopt.h 6.7 KB

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