getopt.h 5.9 KB

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