VLC  4.0.0-dev
vlc_getopt.h
Go to the documentation of this file.
1 /*****************************************************************************
2  * Declarations for getopt_long()
3  *****************************************************************************
4  * Copyright (C) 1987-1997 Free Software Foundation, Inc.
5  * Copyright (C) 2005-2010 VLC authors and VideoLAN
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * 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.
11  *
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 Lesser General Public License for more details.
16  *
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  *****************************************************************************/
21 
22 #ifndef VLC_GETOPT_H
23 #define VLC_GETOPT_H 1
24 
25 typedef struct vlc_getopt_s
26 {
27 /* For communication from `getopt' to the caller.
28  When `getopt' finds an option that takes an argument,
29  the argument value is returned here. */
30 
31  char *arg;
32 
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'.
36 
37  On entry to `getopt', zero means this is the first call; initialize.
38 
39  When `getopt' returns -1, this is the index of the first of the
40  non-option elements that the caller should itself scan.
41 
42  Otherwise, `optind' communicates from one call to the next
43  how much of ARGV has been scanned so far. */
44 
45  int ind;
46 
47 /* Set to an option character which was unrecognized. */
48 
49  int opt;
50 
51 /* The next char to be scanned in the option-element
52  in which the last option character we returned was found.
53  This allows us to pick up the scan where we left off.
54 
55  If this is zero, or a null string, it means resume the scan
56  by advancing to the next ARGV-element. */
57 
58  char *nextchar;
59 
60 /* Handle permutation of arguments. */
61 
62 /* Describe the part of ARGV that contains non-options that have
63  been skipped. `first_nonopt' is the index in ARGV of the first of them;
64  `last_nonopt' is the index after the last of them. */
65 
68 
70 
71 /* Describe the long-named options requested by the application.
72  The LONG_OPTIONS argument to getopt_long or getopt_long_only is a vector
73  of `struct option' terminated by an element containing a name which is
74  zero.
75 
76  The field `has_arg' is:
77  false if the option does not take an argument,
78  true if the option requires an argument.
79 
80  The field `is_obsolete` is a custom VLC addition, tracking whether or not
81  an option is obsolete (such options in VLC remain in existence for some
82  time, with a different error printed compared to that used for unknown
83  options). We store this here as a convenience; it is read by the
84  'suggestion matching' feature, which needs to ignore such options.
85 
86  If the field `flag' is not NULL, it points to a variable that is set
87  to the value given in the field `val' when the option is found, but
88  left unchanged if the option is not found.
89 
90  To have a long-named option do something other than set an `int' to
91  a compiled-in constant, such as set a value from `optarg', set the
92  option's `flag' field to zero and its `val' field to a nonzero
93  value (the equivalent single-letter option character, if there is
94  one). For long options that have a zero `flag' field, `getopt'
95  returns the contents of the `val' field. */
96 
97 struct vlc_option
98 {
99  const char *name;
100  bool has_arg;
102  int *flag;
103  int val;
104 };
105 
106 extern int vlc_getopt_long(int argc, char *const *argv, const char *shortopts,
107  const struct vlc_option *longopts, int *longind,
108  vlc_getopt_t *restrict state);
109 
110 #endif /* VLC_GETOPT_H */
static thread_local struct @78 state
Definition: vlc_getopt.h:26
int last_nonopt
Definition: vlc_getopt.h:67
char * nextchar
Definition: vlc_getopt.h:58
int opt
Definition: vlc_getopt.h:49
int ind
Definition: vlc_getopt.h:45
char * arg
Definition: vlc_getopt.h:31
int first_nonopt
Definition: vlc_getopt.h:66
Definition: vlc_getopt.h:98
int val
Definition: vlc_getopt.h:103
const char * name
Definition: vlc_getopt.h:99
bool is_obsolete
Definition: vlc_getopt.h:101
bool has_arg
Definition: vlc_getopt.h:100
int * flag
Definition: vlc_getopt.h:102
struct vlc_getopt_s vlc_getopt_t
int vlc_getopt_long(int argc, char *const *argv, const char *shortopts, const struct vlc_option *longopts, int *longind, vlc_getopt_t *restrict state)