video.c: don't display pre-rolled pictures
[vlc.git] / src / extras / getopt.h
1 /* Declarations for getopt.
2    Copyright (C) 1989,90,91,92,93,94,96,97 Free Software Foundation, Inc.
3
4    This file is part of the GNU C Library.  Its master source is NOT part of
5    the C library, however.  The master source lives in /gd/gnu/lib.
6
7    The GNU C Library is free software; you can redistribute it and/or
8    modify it under the terms of the GNU Library General Public License as
9    published by the Free Software Foundation; either version 2 of the
10    License, or (at your option) any later version.
11
12    The GNU C Library is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15    Library General Public License for more details.
16
17    You should have received a copy of the GNU Library General Public
18    License along with the GNU C Library; see the file COPYING.LIB.  If not,
19    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20    Boston, MA 02111-1307, USA.  */
21
22 #ifndef _GETOPT_H
23 #define _GETOPT_H 1
24
25 #ifdef  __cplusplus
26 extern "C"
27 {
28 #endif
29
30 /* For communication from `getopt' to the caller.
31    When `getopt' finds an option that takes an argument,
32    the argument value is returned here.
33    Also, when `ordering' is RETURN_IN_ORDER,
34    each non-option ARGV-element is returned here.  */
35
36         extern char *optarg;
37
38 /* Index in ARGV of the next element to be scanned.
39    This is used for communication to and from the caller
40    and for communication between successive calls to `getopt'.
41
42    On entry to `getopt', zero means this is the first call; initialize.
43
44    When `getopt' returns -1, this is the index of the first of the
45    non-option elements that the caller should itself scan.
46
47    Otherwise, `optind' communicates from one call to the next
48    how much of ARGV has been scanned so far.  */
49
50         extern int optind;
51
52 /* Callers store zero here to inhibit the error message `getopt' prints
53    for unrecognized options.  */
54
55         extern int opterr;
56
57 /* Set to an option character which was unrecognized.  */
58
59         extern int optopt;
60
61 /* Describe the long-named options requested by the application.
62    The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
63    of `struct option' terminated by an element containing a name which is
64    zero.
65
66    The field `has_arg' is:
67    no_argument          (or 0) if the option does not take an argument,
68    required_argument    (or 1) if the option requires an argument,
69    optional_argument    (or 2) if the option takes an optional argument.
70
71    If the field `flag' is not NULL, it points to a variable that is set
72    to the value given in the field `val' when the option is found, but
73    left unchanged if the option is not found.
74
75    To have a long-named option do something other than set an `int' to
76    a compiled-in constant, such as set a value from `optarg', set the
77    option's `flag' field to zero and its `val' field to a nonzero
78    value (the equivalent single-letter option character, if there is
79    one).  For long options that have a zero `flag' field, `getopt'
80    returns the contents of the `val' field.  */
81
82         struct option
83         {
84 #if defined (__STDC__) && __STDC__
85                 const char *name;
86 #else
87                 char *name;
88 #endif
89                 /* has_arg can't be an enum because some compilers complain about
90                    type mismatches in all the code that assumes it is an int.  */
91                 int has_arg;
92                 int *flag;
93                 int val;
94         };
95
96 /* Names for the values of the `has_arg' field of `struct option'.  */
97
98 #define no_argument             0
99 #define required_argument       1
100 #define optional_argument       2
101
102 #if defined (__STDC__) && __STDC__
103 #ifdef __GNU_LIBRARY__
104 /* Many other libraries have conflicting prototypes for getopt, with
105    differences in the consts, in stdlib.h.  To avoid compilation
106    errors, only prototype getopt for the GNU C library.  */
107         extern int getopt(int argc, char *const *argv, const char *shortopts);
108 #else                           /* not __GNU_LIBRARY__ */
109         extern int getopt();
110 #endif                          /* __GNU_LIBRARY__ */
111         extern int getopt_long(int argc, char *const *argv, const char *shortopts,
112                                const struct option *longopts, int *longind);
113         extern int getopt_long_only(int argc, char *const *argv,
114                                     const char *shortopts,
115                                const struct option *longopts, int *longind);
116
117 /* Internal only.  Users should not call this directly.  */
118         extern int _getopt_internal(int argc, char *const *argv,
119                                     const char *shortopts,
120                                 const struct option *longopts, int *longind,
121                                     int long_only);
122 #else                           /* not __STDC__ */
123         extern int getopt();
124         extern int getopt_long();
125         extern int getopt_long_only();
126
127         extern int _getopt_internal();
128 #endif                          /* __STDC__ */
129
130 #ifdef  __cplusplus
131 }
132 #endif
133
134 #endif                          /* _GETOPT_H */