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