1 /*****************************************************************************
2 * Declarations for getopt_long()
3 *****************************************************************************
4 * Copyright (C) 1987-1997 Free Software Foundation, Inc.
5 * Copyright (C) 2005-2010 the VideoLAN team
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU Lesser General Public License as published by
9 * the Free Software Foundation; either version 2.1 of the License, or
10 * (at your option) any later version.
12 * This program 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
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public License
18 * along with this program; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
20 *****************************************************************************/
23 #define VLC_GETOPT_H 1
25 /* For communication from `getopt' to the caller.
26 When `getopt' finds an option that takes an argument,
27 the argument value is returned here.
28 Also, when `ordering' is RETURN_IN_ORDER,
29 each non-option ARGV-element is returned here. */
33 /* Index in ARGV of the next element to be scanned.
34 This is used for communication to and from the caller
35 and for communication between successive calls to `getopt'.
37 On entry to `getopt', zero means this is the first call; initialize.
39 When `getopt' returns -1, this is the index of the first of the
40 non-option elements that the caller should itself scan.
42 Otherwise, `optind' communicates from one call to the next
43 how much of ARGV has been scanned so far. */
47 /* Set to an option character which was unrecognized. */
51 /* Describe the long-named options requested by the application.
52 The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
53 of `struct option' terminated by an element containing a name which is
56 The field `has_arg' is:
57 no_argument (or 0) if the option does not take an argument,
58 required_argument (or 1) if the option requires an argument,
59 optional_argument (or 2) if the option takes an optional argument.
61 If the field `flag' is not NULL, it points to a variable that is set
62 to the value given in the field `val' when the option is found, but
63 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. */
75 /* has_arg can't be an enum because some compilers complain about
76 type mismatches in all the code that assumes it is an int. */
82 /* Names for the values of the `has_arg' field of `struct option'. */
85 #define required_argument 1
86 #define optional_argument 2
88 extern int vlc_getopt_long(int argc, char *const *argv, const char *shortopts,
89 const struct option *longopts, int *longind);
91 #endif /* VLC_GETOPT_H */