Mercurial > mplayer.hg
annotate m_option.h @ 32067:548499b3f354
Move codecname extern variable declaration to gui.h, which is better suited.
author | diego |
---|---|
date | Sat, 11 Sep 2010 12:17:11 +0000 |
parents | e8b0797970b6 |
children | 92b92a78ca2a |
rev | line source |
---|---|
30429
c1a3f1bbba26
Add license header to all top-level files missing them.
diego
parents:
29263
diff
changeset
|
1 /* |
c1a3f1bbba26
Add license header to all top-level files missing them.
diego
parents:
29263
diff
changeset
|
2 * This file is part of MPlayer. |
c1a3f1bbba26
Add license header to all top-level files missing them.
diego
parents:
29263
diff
changeset
|
3 * |
c1a3f1bbba26
Add license header to all top-level files missing them.
diego
parents:
29263
diff
changeset
|
4 * MPlayer is free software; you can redistribute it and/or modify |
c1a3f1bbba26
Add license header to all top-level files missing them.
diego
parents:
29263
diff
changeset
|
5 * it under the terms of the GNU General Public License as published by |
c1a3f1bbba26
Add license header to all top-level files missing them.
diego
parents:
29263
diff
changeset
|
6 * the Free Software Foundation; either version 2 of the License, or |
c1a3f1bbba26
Add license header to all top-level files missing them.
diego
parents:
29263
diff
changeset
|
7 * (at your option) any later version. |
c1a3f1bbba26
Add license header to all top-level files missing them.
diego
parents:
29263
diff
changeset
|
8 * |
c1a3f1bbba26
Add license header to all top-level files missing them.
diego
parents:
29263
diff
changeset
|
9 * MPlayer is distributed in the hope that it will be useful, |
c1a3f1bbba26
Add license header to all top-level files missing them.
diego
parents:
29263
diff
changeset
|
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
c1a3f1bbba26
Add license header to all top-level files missing them.
diego
parents:
29263
diff
changeset
|
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
c1a3f1bbba26
Add license header to all top-level files missing them.
diego
parents:
29263
diff
changeset
|
12 * GNU General Public License for more details. |
c1a3f1bbba26
Add license header to all top-level files missing them.
diego
parents:
29263
diff
changeset
|
13 * |
c1a3f1bbba26
Add license header to all top-level files missing them.
diego
parents:
29263
diff
changeset
|
14 * You should have received a copy of the GNU General Public License along |
c1a3f1bbba26
Add license header to all top-level files missing them.
diego
parents:
29263
diff
changeset
|
15 * with MPlayer; if not, write to the Free Software Foundation, Inc., |
c1a3f1bbba26
Add license header to all top-level files missing them.
diego
parents:
29263
diff
changeset
|
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
c1a3f1bbba26
Add license header to all top-level files missing them.
diego
parents:
29263
diff
changeset
|
17 */ |
c1a3f1bbba26
Add license header to all top-level files missing them.
diego
parents:
29263
diff
changeset
|
18 |
26029 | 19 #ifndef MPLAYER_M_OPTION_H |
20 #define MPLAYER_M_OPTION_H | |
8164 | 21 |
26131
83c95bd31aab
Add necessary #includes to pass 'make checkheaders'.
diego
parents:
26029
diff
changeset
|
22 #include <string.h> |
83c95bd31aab
Add necessary #includes to pass 'make checkheaders'.
diego
parents:
26029
diff
changeset
|
23 |
18258 | 24 /// \defgroup Options |
18283 | 25 /// m_option allows to parse, print and copy data of various types. |
18258 | 26 /// It is the base of the \ref OptionsStruct, \ref Config and |
27 /// \ref Properties APIs. | |
28 ///@{ | |
29 | |
30 /// \file m_option.h | |
31 | |
32 /// \ingroup OptionTypes | |
8164 | 33 typedef struct m_option_type m_option_type_t; |
34 typedef struct m_option m_option_t; | |
9793 | 35 struct m_struct_st; |
8164 | 36 |
18258 | 37 /// \defgroup OptionTypes Options types |
38 /// \ingroup Options | |
39 ///@{ | |
40 | |
8164 | 41 ///////////////////////////// Options types declarations //////////////////////////// |
42 | |
43 // Simple types | |
24966
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
44 extern const m_option_type_t m_option_type_flag; |
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
45 extern const m_option_type_t m_option_type_int; |
28759
af274aef6b81
Add a 64 bit integer type to the suboption parser.
reimar
parents:
26408
diff
changeset
|
46 extern const m_option_type_t m_option_type_int64; |
24966
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
47 extern const m_option_type_t m_option_type_float; |
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
48 extern const m_option_type_t m_option_type_double; |
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
49 extern const m_option_type_t m_option_type_string; |
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
50 extern const m_option_type_t m_option_type_string_list; |
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
51 extern const m_option_type_t m_option_type_position; |
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
52 extern const m_option_type_t m_option_type_time; |
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
53 extern const m_option_type_t m_option_type_time_size; |
8164 | 54 |
24966
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
55 extern const m_option_type_t m_option_type_print; |
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
56 extern const m_option_type_t m_option_type_print_indirect; |
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
57 extern const m_option_type_t m_option_type_print_func; |
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
58 extern const m_option_type_t m_option_type_subconfig; |
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
59 extern const m_option_type_t m_option_type_imgfmt; |
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
60 extern const m_option_type_t m_option_type_afmt; |
8164 | 61 |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
62 // Func-based types |
24966
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
63 extern const m_option_type_t m_option_type_func_full; |
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
64 extern const m_option_type_t m_option_type_func_param; |
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
65 extern const m_option_type_t m_option_type_func; |
8164 | 66 |
18258 | 67 /// Callback used to reset func options. |
24966
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
68 typedef void (*m_opt_default_func_t)(const m_option_t *, const char*); |
18258 | 69 |
70 /// Callback used by m_option_type_func_full options. | |
30695
a26f6577d338
Make more option-parsing related function arguments const.
reimar
parents:
30429
diff
changeset
|
71 typedef int (*m_opt_func_full_t)(const m_option_t *, const char *, const char *); |
18258 | 72 |
73 /// Callback used by m_option_type_func_param options. | |
24966
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
74 typedef int (*m_opt_func_param_t)(const m_option_t *, const char *); |
18258 | 75 |
76 /// Callback used by m_option_type_func options. | |
24966
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
77 typedef int (*m_opt_func_t)(const m_option_t *); |
18258 | 78 |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
79 // Backwards compatibility |
8164 | 80 typedef m_opt_default_func_t cfg_default_func_t; |
81 typedef m_opt_func_full_t cfg_func_arg_param_t; | |
82 typedef m_opt_func_param_t cfg_func_param_t; | |
83 typedef m_opt_func_t cfg_func_t; | |
84 | |
19973
02a18c52a42a
after a long time, finally i could add -endpos option to mplayer executable.
ptt
parents:
19053
diff
changeset
|
85 #define END_AT_NONE 0 |
02a18c52a42a
after a long time, finally i could add -endpos option to mplayer executable.
ptt
parents:
19053
diff
changeset
|
86 #define END_AT_TIME 1 |
02a18c52a42a
after a long time, finally i could add -endpos option to mplayer executable.
ptt
parents:
19053
diff
changeset
|
87 #define END_AT_SIZE 2 |
02a18c52a42a
after a long time, finally i could add -endpos option to mplayer executable.
ptt
parents:
19053
diff
changeset
|
88 typedef struct { |
02a18c52a42a
after a long time, finally i could add -endpos option to mplayer executable.
ptt
parents:
19053
diff
changeset
|
89 double pos; |
02a18c52a42a
after a long time, finally i could add -endpos option to mplayer executable.
ptt
parents:
19053
diff
changeset
|
90 int type; |
02a18c52a42a
after a long time, finally i could add -endpos option to mplayer executable.
ptt
parents:
19053
diff
changeset
|
91 } m_time_size_t; |
02a18c52a42a
after a long time, finally i could add -endpos option to mplayer executable.
ptt
parents:
19053
diff
changeset
|
92 |
18258 | 93 /// Extra definition needed for \ref m_option_type_obj_settings_list options. |
9593
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
94 typedef struct { |
18258 | 95 /// Pointer to an array of pointer to some object type description struct. |
9593
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
96 void** list; |
18258 | 97 /// Offset of the object type name (char*) in the description struct. |
9593
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
98 void* name_off; |
18258 | 99 /// Offset of the object type info string (char*) in the description struct. |
9593
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
100 void* info_off; |
18258 | 101 /// \brief Offset of the object type parameter description (\ref m_struct_st) |
102 /// in the description struct. | |
9593
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
103 void* desc_off; |
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
104 } m_obj_list_t; |
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
105 |
18258 | 106 /// The data type used by \ref m_option_type_obj_settings_list. |
107 typedef struct m_obj_settings { | |
108 /// Type of the object. | |
9593
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
109 char* name; |
18258 | 110 /// NULL terminated array of parameter/value pairs. |
9593
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
111 char** attribs; |
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
112 } m_obj_settings_t; |
18258 | 113 |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
114 /// A parser to set up a list of objects. |
18283 | 115 /** It creates a NULL terminated array \ref m_obj_settings. The option priv |
18258 | 116 * field (\ref m_option::priv) must point to a \ref m_obj_list_t describing |
117 * the available object types. | |
118 */ | |
24966
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
119 extern const m_option_type_t m_option_type_obj_settings_list; |
9593
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
120 |
18258 | 121 /// Extra definition needed for \ref m_option_type_obj_presets options. |
9593
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
122 typedef struct { |
18258 | 123 /// Description of the struct holding the presets. |
9791
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
124 struct m_struct_st* in_desc; |
18258 | 125 /// Description of the struct that should be set by the presets. |
9791
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
126 struct m_struct_st* out_desc; |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
127 /// Pointer to an array of structs defining the various presets. |
18258 | 128 void* presets; |
129 /// Offset of the preset's name inside the in_struct. | |
130 void* name_off; | |
9593
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
131 } m_obj_presets_t; |
18258 | 132 |
133 /// Set several fields in a struct at once. | |
18283 | 134 /** For this two struct descriptions are used. One for the struct holding the |
18258 | 135 * preset and one for the struct beeing set. Every field present in both |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
136 * structs will be copied from the preset struct to the destination one. |
18258 | 137 * The option priv field (\ref m_option::priv) must point to a correctly |
138 * filled \ref m_obj_presets_t. | |
139 */ | |
24966
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
140 extern const m_option_type_t m_option_type_obj_presets; |
9593
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
141 |
18258 | 142 /// Parse an URL into a struct. |
143 /** The option priv field (\ref m_option::priv) must point to a | |
144 * \ref m_struct_st describing which fields of the URL must be used. | |
145 */ | |
24966
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
146 extern const m_option_type_t m_option_type_custom_url; |
9791
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
147 |
18258 | 148 /// Extra definition needed for \ref m_option_type_obj_params options. |
9791
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
149 typedef struct { |
18283 | 150 /// Field descriptions. |
24966
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
151 const struct m_struct_st* desc; |
18258 | 152 /// Field separator to use. |
153 char separator; | |
9791
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
154 } m_obj_params_t; |
18258 | 155 |
156 /// Parse a set of parameters. | |
157 /** Parameters are separated by the given separator and each one | |
18283 | 158 * successively sets a field from the struct. The option priv field |
18258 | 159 * (\ref m_option::priv) must point to a \ref m_obj_params_t. |
160 */ | |
24966
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
161 extern const m_option_type_t m_option_type_obj_params; |
9791
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
162 |
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
163 typedef struct { |
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
164 int start; |
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
165 int end; |
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
166 } m_span_t; |
18258 | 167 /// Ready made settings to parse a \ref m_span_t with a start-end syntax. |
24966
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
168 extern const m_obj_params_t m_span_params_def; |
9791
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
169 |
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
170 |
10594
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
171 // FIXME: backward compatibility |
8164 | 172 #define CONF_TYPE_FLAG (&m_option_type_flag) |
173 #define CONF_TYPE_INT (&m_option_type_int) | |
28759
af274aef6b81
Add a 64 bit integer type to the suboption parser.
reimar
parents:
26408
diff
changeset
|
174 #define CONF_TYPE_INT64 (&m_option_type_int64) |
8164 | 175 #define CONF_TYPE_FLOAT (&m_option_type_float) |
11947 | 176 #define CONF_TYPE_DOUBLE (&m_option_type_double) |
10594
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
177 #define CONF_TYPE_STRING (&m_option_type_string) |
8164 | 178 #define CONF_TYPE_FUNC (&m_option_type_func) |
179 #define CONF_TYPE_FUNC_PARAM (&m_option_type_func_param) | |
180 #define CONF_TYPE_PRINT (&m_option_type_print) | |
8736 | 181 #define CONF_TYPE_PRINT_INDIRECT (&m_option_type_print_indirect) |
17470
21123e349463
New option type to print help text with a function.
albeu
parents:
17456
diff
changeset
|
182 #define CONF_TYPE_PRINT_FUNC (&m_option_type_print_func) |
8164 | 183 #define CONF_TYPE_FUNC_FULL (&m_option_type_func_full) |
184 #define CONF_TYPE_SUBCONFIG (&m_option_type_subconfig) | |
10594
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
185 #define CONF_TYPE_STRING_LIST (&m_option_type_string_list) |
8164 | 186 #define CONF_TYPE_POSITION (&m_option_type_position) |
10594
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
187 #define CONF_TYPE_IMGFMT (&m_option_type_imgfmt) |
14246 | 188 #define CONF_TYPE_AFMT (&m_option_type_afmt) |
8164 | 189 #define CONF_TYPE_SPAN (&m_option_type_span) |
9593
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
190 #define CONF_TYPE_OBJ_SETTINGS_LIST (&m_option_type_obj_settings_list) |
10594
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
191 #define CONF_TYPE_OBJ_PRESETS (&m_option_type_obj_presets) |
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
192 #define CONF_TYPE_CUSTOM_URL (&m_option_type_custom_url) |
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
193 #define CONF_TYPE_OBJ_PARAMS (&m_option_type_obj_params) |
22312 | 194 #define CONF_TYPE_TIME (&m_option_type_time) |
19973
02a18c52a42a
after a long time, finally i could add -endpos option to mplayer executable.
ptt
parents:
19053
diff
changeset
|
195 #define CONF_TYPE_TIME_SIZE (&m_option_type_time_size) |
8164 | 196 |
197 ///////////////////////////////////////////////////////////////////////////////////////////// | |
198 | |
18258 | 199 /// Option type description |
8164 | 200 struct m_option_type { |
30695
a26f6577d338
Make more option-parsing related function arguments const.
reimar
parents:
30429
diff
changeset
|
201 const char* name; |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
202 /// Syntax description, etc |
30695
a26f6577d338
Make more option-parsing related function arguments const.
reimar
parents:
30429
diff
changeset
|
203 const char* comments; |
18258 | 204 /// Size needed for the data. |
205 unsigned int size; | |
206 /// See \ref OptionTypeFlags. | |
8164 | 207 unsigned int flags; |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
28759
diff
changeset
|
208 |
18258 | 209 /// Parse the data from a string. |
210 /** It is the only required function, all others can be NULL. | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
28759
diff
changeset
|
211 * |
18258 | 212 * \param opt The option that is parsed. |
213 * \param name The full option name. | |
214 * \param param The parameter to parse. | |
18283 | 215 * \param dst Pointer to the memory where the data should be written. |
18258 | 216 * If NULL the parameter validity should still be checked. |
217 * \param src Source of the option, see \ref OptionParserModes. | |
18283 | 218 * \return On error a negative value is returned, on success the number of arguments |
18258 | 219 * consumed. For details see \ref OptionParserReturn. |
220 */ | |
30695
a26f6577d338
Make more option-parsing related function arguments const.
reimar
parents:
30429
diff
changeset
|
221 int (*parse)(const m_option_t* opt,const char *name, const char *param, void* dst, int src); |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
28759
diff
changeset
|
222 |
18258 | 223 /// Print back a value in string form. |
224 /** \param opt The option to print. | |
225 * \param val Pointer to the memory holding the data to be printed. | |
226 * \return An allocated string containing the text value or (void*)-1 | |
227 * on error. | |
228 */ | |
25229
4f611a555224
Option print functions may not and do not modify value
reimar
parents:
24966
diff
changeset
|
229 char* (*print)(const m_option_t* opt, const void* val); |
8164 | 230 |
18258 | 231 /** \name |
232 * These functions are called to save/set/restore the status of the | |
18283 | 233 * variables. The difference between the 3 only matters for types like |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
234 * \ref m_option_type_func where 'setting' needs to do more than just |
18258 | 235 * copying some data. |
236 */ | |
237 //@{ | |
238 | |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
239 /// Update a save slot (dst) from the current value in the program (src). |
18258 | 240 /** \param opt The option to copy. |
241 * \param dst Pointer to the destination memory. | |
242 * \param src Pointer to the source memory. | |
243 */ | |
30695
a26f6577d338
Make more option-parsing related function arguments const.
reimar
parents:
30429
diff
changeset
|
244 void (*save)(const m_option_t* opt,void* dst, const void* src); |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
28759
diff
changeset
|
245 |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
246 /// Set the value in the program (dst) from a save slot. |
18258 | 247 /** \param opt The option to copy. |
248 * \param dst Pointer to the destination memory. | |
249 * \param src Pointer to the source memory. | |
250 */ | |
30695
a26f6577d338
Make more option-parsing related function arguments const.
reimar
parents:
30429
diff
changeset
|
251 void (*set)(const m_option_t* opt,void* dst, const void* src); |
18258 | 252 |
253 /// Copy the data between two save slots. If NULL and size is > 0 a memcpy will be used. | |
254 /** \param opt The option to copy. | |
255 * \param dst Pointer to the destination memory. | |
256 * \param src Pointer to the source memory. | |
257 */ | |
30695
a26f6577d338
Make more option-parsing related function arguments const.
reimar
parents:
30429
diff
changeset
|
258 void (*copy)(const m_option_t* opt,void* dst, const void* src); |
18258 | 259 //@} |
260 | |
261 /// Free the data allocated for a save slot. | |
262 /** This is only needed for dynamic types like strings. | |
263 * \param dst Pointer to the data, usually a pointer that should be freed and | |
264 * set to NULL. | |
265 */ | |
8164 | 266 void (*free)(void* dst); |
267 }; | |
268 | |
18258 | 269 ///@} |
270 | |
271 /// Option description | |
272 /** \ingroup Options | |
273 */ | |
8164 | 274 struct m_option { |
18258 | 275 /// Option name. |
24966
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
276 const char *name; |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
28759
diff
changeset
|
277 |
18258 | 278 /// Reserved for higher level APIs, it shouldn't be used by parsers. |
279 /** The suboption parser and func types do use it. They should instead | |
18283 | 280 * use the priv field but this was inherited from older versions of the |
18258 | 281 * config code. |
282 */ | |
30954 | 283 void *p; |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
28759
diff
changeset
|
284 |
18258 | 285 /// Option type. |
24966
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
286 const m_option_type_t* type; |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
28759
diff
changeset
|
287 |
18258 | 288 /// See \ref OptionFlags. |
8164 | 289 unsigned int flags; |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
28759
diff
changeset
|
290 |
18283 | 291 /// \brief Mostly useful for numeric types, the \ref M_OPT_MIN flags must |
18258 | 292 /// also be set. |
293 double min; | |
294 | |
18283 | 295 /// \brief Mostly useful for numeric types, the \ref M_OPT_MAX flags must |
18258 | 296 /// also be set. |
297 double max; | |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
28759
diff
changeset
|
298 |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
299 /// Type dependent data (for all kinds of extended settings). |
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
300 /** This used to be a function pointer to hold a 'reverse to defaults' func. |
18258 | 301 * Now it can be used to pass any type of extra args needed by the parser. |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
302 * Passing a 'default func' is still valid for all func based option types. |
18258 | 303 */ |
304 void* priv; | |
8164 | 305 }; |
306 | |
307 | |
18258 | 308 /// \defgroup OptionFlags Option flags |
309 ///@{ | |
8164 | 310 |
18283 | 311 /// The option has a minimum set in \ref m_option::min. |
8164 | 312 #define M_OPT_MIN (1<<0) |
18258 | 313 |
18283 | 314 /// The option has a maximum set in \ref m_option::max. |
8164 | 315 #define M_OPT_MAX (1<<1) |
18258 | 316 |
18283 | 317 /// The option has a minimum and maximum in \ref m_option::min and \ref m_option::max. |
8164 | 318 #define M_OPT_RANGE (M_OPT_MIN|M_OPT_MAX) |
18258 | 319 |
320 /// The option is forbidden in config files. | |
8164 | 321 #define M_OPT_NOCFG (1<<2) |
18258 | 322 |
18283 | 323 /// The option is forbidden on the command line. |
8164 | 324 #define M_OPT_NOCMD (1<<3) |
18258 | 325 |
326 /// The option is global in the \ref Config. | |
327 /** It won't be saved on push and the command line parser will set it when | |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
328 * it's parsed (i.e. it won't be set later) |
18258 | 329 * e.g options : -v, -quiet |
330 */ | |
8164 | 331 #define M_OPT_GLOBAL (1<<4) |
18258 | 332 |
333 /// The \ref Config won't save this option on push. | |
18283 | 334 /** It won't be saved on push but the command line parser will add it with |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
335 * its entry (i.e. it may be set later) |
18258 | 336 * e.g options : -include |
337 */ | |
8164 | 338 #define M_OPT_NOSAVE (1<<5) |
18258 | 339 |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
340 /// \brief The \ref Config will emulate the old behavior by pushing the |
18258 | 341 /// option only if it was set by the user. |
8164 | 342 #define M_OPT_OLD (1<<6) |
343 | |
26408
7a36d5941fd8
Replace the trivial command line preparser with a more robust version
albeu
parents:
26131
diff
changeset
|
344 /// The option should be set during command line pre-parsing |
7a36d5941fd8
Replace the trivial command line preparser with a more robust version
albeu
parents:
26131
diff
changeset
|
345 #define M_OPT_PRE_PARSE (1<<7) |
7a36d5941fd8
Replace the trivial command line preparser with a more robust version
albeu
parents:
26131
diff
changeset
|
346 |
18258 | 347 /// \defgroup OldOptionFlags Backward compatibility |
348 /// | |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
349 /// These are kept for compatibility with older code. |
18258 | 350 /// @{ |
10594
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
351 #define CONF_MIN M_OPT_MIN |
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
352 #define CONF_MAX M_OPT_MAX |
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
353 #define CONF_RANGE M_OPT_RANGE |
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
354 #define CONF_NOCFG M_OPT_NOCFG |
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
355 #define CONF_NOCMD M_OPT_NOCMD |
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
356 #define CONF_GLOBAL M_OPT_GLOBAL |
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
357 #define CONF_NOSAVE M_OPT_NOSAVE |
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
358 #define CONF_OLD M_OPT_OLD |
26408
7a36d5941fd8
Replace the trivial command line preparser with a more robust version
albeu
parents:
26131
diff
changeset
|
359 #define CONF_PRE_PARSE M_OPT_PRE_PARSE |
18258 | 360 ///@} |
8164 | 361 |
18258 | 362 ///@} |
8164 | 363 |
18258 | 364 /// \defgroup OptionTypeFlags Option type flags |
365 /// \ingroup OptionTypes | |
366 /// | |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
367 /// These flags are used to describe special parser capabilities or behavior. |
18258 | 368 /// |
369 ///@{ | |
370 | |
371 /// Suboption parser flag. | |
372 /** When this flag is set, m_option::p should point to another m_option | |
373 * array. Only the parse function will be called. If dst is set, it should | |
374 * create/update an array of char* containg opt/val pairs. The options in | |
375 * the child array will then be set automatically by the \ref Config. | |
18283 | 376 * Also note that suboptions may be directly accessed by using |
18258 | 377 * -option:subopt blah. |
378 */ | |
8164 | 379 #define M_OPT_TYPE_HAS_CHILD (1<<0) |
18258 | 380 |
381 /// Wildcard matching flag. | |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
382 /** If set the option type has a use for option names ending with a * |
18283 | 383 * (used for -aa*), this only affects the option name matching. |
18258 | 384 */ |
8164 | 385 #define M_OPT_TYPE_ALLOW_WILDCARD (1<<1) |
18258 | 386 |
387 /// Dynamic data type. | |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
388 /** This flag indicates that the data is dynamically allocated (m_option::p |
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
389 * points to a pointer). It enables a little hack in the \ref Config wich |
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
390 * replaces the initial value of such variables with a dynamic copy in case |
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
391 * the initial value is statically allocated (pretty common with strings). |
18258 | 392 */ |
8164 | 393 #define M_OPT_TYPE_DYNAMIC (1<<2) |
18258 | 394 |
395 /// Indirect option type. | |
396 /** If this is set the parse function doesn't directly return | |
397 * the wanted thing. Options use this if for some reasons they have to wait | |
398 * until the set call to be able to correctly set the target var. | |
399 * So for those types new values must first be parsed, then set to the target | |
400 * var. If this flag isn't set then new values can be parsed directly to the | |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
401 * target var. It's used by the callback-based options as the callback call |
18258 | 402 * may append later on. |
403 */ | |
8164 | 404 #define M_OPT_TYPE_INDIRECT (1<<3) |
405 | |
18258 | 406 ///@} |
8164 | 407 |
408 ///////////////////////////// Parser flags //////////////////////////////////////// | |
409 | |
18258 | 410 /// \defgroup OptionParserModes Option parser modes |
411 /// \ingroup Options | |
412 /// | |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
413 /// Some parsers behave differently depending on the mode passed in the src |
18258 | 414 /// parameter of m_option_type::parse. For example the flag type doesn't take |
415 /// an argument when parsing from the command line. | |
416 ///@{ | |
417 | |
418 /// Set when parsing from a config file. | |
8164 | 419 #define M_CONFIG_FILE 0 |
18258 | 420 /// Set when parsing command line arguments. |
8164 | 421 #define M_COMMAND_LINE 1 |
26408
7a36d5941fd8
Replace the trivial command line preparser with a more robust version
albeu
parents:
26131
diff
changeset
|
422 /// Set when pre-parsing the command line |
7a36d5941fd8
Replace the trivial command line preparser with a more robust version
albeu
parents:
26131
diff
changeset
|
423 #define M_COMMAND_LINE_PRE_PARSE 2 |
8164 | 424 |
18258 | 425 ///@} |
426 | |
427 /// \defgroup OptionParserReturn Option parser return code | |
428 /// \ingroup Options | |
429 /// | |
18283 | 430 /// On success parsers return the number of arguments consumed: 0 or 1. |
18258 | 431 /// |
18283 | 432 /// To indicate that MPlayer should exit without playing anything, |
18258 | 433 /// parsers return M_OPT_EXIT minus the number of parameters they |
434 /// consumed: \ref M_OPT_EXIT or \ref M_OPT_EXIT-1. | |
435 /// | |
18283 | 436 /// On error one of the following (negative) error codes is returned: |
18258 | 437 ///@{ |
438 | |
18283 | 439 /// For use by higher level APIs when the option name is invalid. |
10595
522afd56703c
100l to albeu for his english grammar, and 10l to me becouse I noticed that lately (my backward compatibilty macro uses M_OPT_UNKNOWN)
alex
parents:
10594
diff
changeset
|
440 #define M_OPT_UNKNOWN -1 |
18258 | 441 |
442 /// Returned when a parameter is needed but wasn't provided. | |
8164 | 443 #define M_OPT_MISSING_PARAM -2 |
18258 | 444 |
445 /// Returned when the given parameter couldn't be parsed. | |
8164 | 446 #define M_OPT_INVALID -3 |
18258 | 447 |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
28759
diff
changeset
|
448 /// \brief Returned if the value is "out of range". The exact meaning may |
18258 | 449 /// vary from type to type. |
8164 | 450 #define M_OPT_OUT_OF_RANGE -4 |
18258 | 451 |
452 /// Returned if the parser failed for any other reason than a bad parameter. | |
10594
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
453 #define M_OPT_PARSER_ERR -5 |
18258 | 454 |
455 /// Returned when MPlayer should exit. Used by various help stuff. | |
456 /** M_OPT_EXIT must be the lowest number on this list. | |
457 */ | |
9791
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
458 #define M_OPT_EXIT -6 |
8164 | 459 |
18258 | 460 /// \defgroup OldOptionParserReturn Backward compatibility |
461 /// | |
18283 | 462 /// These are kept for compatibility with older code. |
18258 | 463 /// |
464 ///@{ | |
10594
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
465 #define ERR_NOT_AN_OPTION M_OPT_UNKNOWN |
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
466 #define ERR_MISSING_PARAM M_OPT_MISSING_PARAM |
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
467 #define ERR_OUT_OF_RANGE M_OPT_OUT_OF_RANGE |
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
468 #define ERR_FUNC_ERR M_OPT_PARSER_ERR |
18258 | 469 ///@} |
10594
57bdcdb061d7
Removed the historic cfgparser and switched full to the new config parser (altought some macros still remain for compatibility). As a side effect 90% of the warning messages are gone from the core. Things should be cleaner now and less confusing for newbies.
alex
parents:
10590
diff
changeset
|
470 |
18258 | 471 ///@} |
472 | |
473 /// Find the option matching the given name in the list. | |
474 /** \ingroup Options | |
18283 | 475 * This function takes the possible wildcards into account (see |
18258 | 476 * \ref M_OPT_TYPE_ALLOW_WILDCARD). |
29263
0f1b5b68af32
whitespace cosmetics: Remove all trailing whitespace.
diego
parents:
28759
diff
changeset
|
477 * |
18258 | 478 * \param list Pointer to an array of \ref m_option. |
479 * \param name Name of the option. | |
480 * \return The matching option or NULL. | |
481 */ | |
24966
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
482 const m_option_t* m_option_list_find(const m_option_t* list,const char* name); |
8164 | 483 |
18258 | 484 /// Helper to parse options, see \ref m_option_type::parse. |
8164 | 485 inline static int |
30695
a26f6577d338
Make more option-parsing related function arguments const.
reimar
parents:
30429
diff
changeset
|
486 m_option_parse(const m_option_t* opt,const char *name, const char *param, void* dst, int src) { |
8164 | 487 return opt->type->parse(opt,name,param,dst,src); |
488 } | |
489 | |
18258 | 490 /// Helper to print options, see \ref m_option_type::print. |
8164 | 491 inline static char* |
25229
4f611a555224
Option print functions may not and do not modify value
reimar
parents:
24966
diff
changeset
|
492 m_option_print(const m_option_t* opt, const void* val_ptr) { |
8164 | 493 if(opt->type->print) |
494 return opt->type->print(opt,val_ptr); | |
495 else | |
8168 | 496 return (char*)-1; |
8164 | 497 } |
498 | |
18258 | 499 /// Helper around \ref m_option_type::save. |
8164 | 500 inline static void |
30695
a26f6577d338
Make more option-parsing related function arguments const.
reimar
parents:
30429
diff
changeset
|
501 m_option_save(const m_option_t* opt,void* dst, const void* src) { |
8164 | 502 if(opt->type->save) |
503 opt->type->save(opt,dst,src); | |
504 } | |
505 | |
18258 | 506 /// Helper around \ref m_option_type::set. |
8164 | 507 inline static void |
30695
a26f6577d338
Make more option-parsing related function arguments const.
reimar
parents:
30429
diff
changeset
|
508 m_option_set(const m_option_t* opt,void* dst, const void* src) { |
8164 | 509 if(opt->type->set) |
510 opt->type->set(opt,dst,src); | |
511 } | |
512 | |
18258 | 513 /// Helper around \ref m_option_type::copy. |
8164 | 514 inline static void |
30695
a26f6577d338
Make more option-parsing related function arguments const.
reimar
parents:
30429
diff
changeset
|
515 m_option_copy(const m_option_t* opt,void* dst, const void* src) { |
8164 | 516 if(opt->type->copy) |
17456
b8ce59172e6a
100L m_option_copy should use the copy callback and not the set one.
albeu
parents:
16345
diff
changeset
|
517 opt->type->copy(opt,dst,src); |
8164 | 518 else if(opt->type->size > 0) |
519 memcpy(dst,src,opt->type->size); | |
520 } | |
521 | |
18258 | 522 /// Helper around \ref m_option_type::free. |
8164 | 523 inline static void |
24966
cc170348a763
correct const usage in the option handling code so that tables can be
rfelker
parents:
23689
diff
changeset
|
524 m_option_free(const m_option_t* opt,void* dst) { |
8164 | 525 if(opt->type->free) |
526 opt->type->free(dst); | |
527 } | |
528 | |
18258 | 529 /*@}*/ |
530 | |
26029 | 531 #endif /* MPLAYER_M_OPTION_H */ |