Mercurial > mplayer.hg
annotate m_option.h @ 19972:6e103c537e6d
sync'd up to rev.18570
author | ptt |
---|---|
date | Mon, 25 Sep 2006 16:16:19 +0000 |
parents | 75327b24e06f |
children | 02a18c52a42a |
rev | line source |
---|---|
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
|
1 #ifndef _M_OPTION_H |
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
|
2 #define _M_OPTION_H |
8164 | 3 |
18258 | 4 /// \defgroup Options |
18283 | 5 /// m_option allows to parse, print and copy data of various types. |
18258 | 6 /// It is the base of the \ref OptionsStruct, \ref Config and |
7 /// \ref Properties APIs. | |
8 ///@{ | |
9 | |
10 /// \file m_option.h | |
11 | |
12 /// \ingroup OptionTypes | |
8164 | 13 typedef struct m_option_type m_option_type_t; |
14 typedef struct m_option m_option_t; | |
9793 | 15 struct m_struct_st; |
8164 | 16 |
18258 | 17 /// \defgroup OptionTypes Options types |
18 /// \ingroup Options | |
19 ///@{ | |
20 | |
8164 | 21 ///////////////////////////// Options types declarations //////////////////////////// |
22 | |
23 // Simple types | |
24 extern m_option_type_t m_option_type_flag; | |
25 extern m_option_type_t m_option_type_int; | |
26 extern m_option_type_t m_option_type_float; | |
11947 | 27 extern m_option_type_t m_option_type_double; |
8164 | 28 extern m_option_type_t m_option_type_string; |
29 extern m_option_type_t m_option_type_string_list; | |
30 extern m_option_type_t m_option_type_position; | |
31 | |
32 extern m_option_type_t m_option_type_print; | |
8736 | 33 extern m_option_type_t m_option_type_print_indirect; |
17470
21123e349463
New option type to print help text with a function.
albeu
parents:
17456
diff
changeset
|
34 extern m_option_type_t m_option_type_print_func; |
8164 | 35 extern m_option_type_t m_option_type_subconfig; |
36 extern m_option_type_t m_option_type_imgfmt; | |
14246 | 37 extern m_option_type_t m_option_type_afmt; |
8164 | 38 |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
39 // Func-based types |
8164 | 40 extern m_option_type_t m_option_type_func_full; |
41 extern m_option_type_t m_option_type_func_param; | |
42 extern m_option_type_t m_option_type_func; | |
43 | |
18258 | 44 /// Callback used to reset func options. |
8164 | 45 typedef void (*m_opt_default_func_t)(m_option_t *, char*); |
18258 | 46 |
47 /// Callback used by m_option_type_func_full options. | |
8164 | 48 typedef int (*m_opt_func_full_t)(m_option_t *, char *, char *); |
18258 | 49 |
50 /// Callback used by m_option_type_func_param options. | |
8164 | 51 typedef int (*m_opt_func_param_t)(m_option_t *, char *); |
18258 | 52 |
53 /// Callback used by m_option_type_func options. | |
8164 | 54 typedef int (*m_opt_func_t)(m_option_t *); |
18258 | 55 |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
56 // Backwards compatibility |
8164 | 57 typedef m_opt_default_func_t cfg_default_func_t; |
58 typedef m_opt_func_full_t cfg_func_arg_param_t; | |
59 typedef m_opt_func_param_t cfg_func_param_t; | |
60 typedef m_opt_func_t cfg_func_t; | |
61 | |
18258 | 62 /// 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
|
63 typedef struct { |
18258 | 64 /// 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
|
65 void** list; |
18258 | 66 /// 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
|
67 void* name_off; |
18258 | 68 /// 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
|
69 void* info_off; |
18258 | 70 /// \brief Offset of the object type parameter description (\ref m_struct_st) |
71 /// 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
|
72 void* desc_off; |
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
73 } m_obj_list_t; |
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
74 |
18258 | 75 /// The data type used by \ref m_option_type_obj_settings_list. |
76 typedef struct m_obj_settings { | |
77 /// 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
|
78 char* name; |
18258 | 79 /// 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
|
80 char** attribs; |
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
81 } m_obj_settings_t; |
18258 | 82 |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
83 /// A parser to set up a list of objects. |
18283 | 84 /** It creates a NULL terminated array \ref m_obj_settings. The option priv |
18258 | 85 * field (\ref m_option::priv) must point to a \ref m_obj_list_t describing |
86 * the available object types. | |
87 */ | |
9593
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
88 extern m_option_type_t m_option_type_obj_settings_list; |
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
89 |
18258 | 90 /// 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
|
91 typedef struct { |
18258 | 92 /// 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
|
93 struct m_struct_st* in_desc; |
18258 | 94 /// 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
|
95 struct m_struct_st* out_desc; |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
96 /// Pointer to an array of structs defining the various presets. |
18258 | 97 void* presets; |
98 /// Offset of the preset's name inside the in_struct. | |
99 void* name_off; | |
9593
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
100 } m_obj_presets_t; |
18258 | 101 |
102 /// Set several fields in a struct at once. | |
18283 | 103 /** For this two struct descriptions are used. One for the struct holding the |
18258 | 104 * 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
|
105 * structs will be copied from the preset struct to the destination one. |
18258 | 106 * The option priv field (\ref m_option::priv) must point to a correctly |
107 * filled \ref m_obj_presets_t. | |
108 */ | |
9593
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
109 extern m_option_type_t m_option_type_obj_presets; |
e9a2af584986
Add the new -vf option wich is the same as vop in reverse order.
albeu
parents:
8736
diff
changeset
|
110 |
18258 | 111 /// Parse an URL into a struct. |
112 /** The option priv field (\ref m_option::priv) must point to a | |
113 * \ref m_struct_st describing which fields of the URL must be used. | |
114 */ | |
9791
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
115 extern m_option_type_t m_option_type_custom_url; |
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
116 |
18258 | 117 /// 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
|
118 typedef struct { |
18283 | 119 /// Field descriptions. |
18258 | 120 struct m_struct_st* desc; |
121 /// Field separator to use. | |
122 char separator; | |
9791
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
123 } m_obj_params_t; |
18258 | 124 |
125 /// Parse a set of parameters. | |
126 /** Parameters are separated by the given separator and each one | |
18283 | 127 * successively sets a field from the struct. The option priv field |
18258 | 128 * (\ref m_option::priv) must point to a \ref m_obj_params_t. |
129 */ | |
9791
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
130 extern m_option_type_t m_option_type_obj_params; |
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
131 |
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
132 typedef struct { |
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
133 int start; |
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
134 int end; |
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
135 } m_span_t; |
18258 | 136 /// Ready made settings to parse a \ref m_span_t with a start-end syntax. |
9791
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
137 extern m_obj_params_t m_span_params_def; |
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
138 |
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
139 |
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
|
140 // FIXME: backward compatibility |
8164 | 141 #define CONF_TYPE_FLAG (&m_option_type_flag) |
142 #define CONF_TYPE_INT (&m_option_type_int) | |
143 #define CONF_TYPE_FLOAT (&m_option_type_float) | |
11947 | 144 #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
|
145 #define CONF_TYPE_STRING (&m_option_type_string) |
8164 | 146 #define CONF_TYPE_FUNC (&m_option_type_func) |
147 #define CONF_TYPE_FUNC_PARAM (&m_option_type_func_param) | |
148 #define CONF_TYPE_PRINT (&m_option_type_print) | |
8736 | 149 #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
|
150 #define CONF_TYPE_PRINT_FUNC (&m_option_type_print_func) |
8164 | 151 #define CONF_TYPE_FUNC_FULL (&m_option_type_func_full) |
152 #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
|
153 #define CONF_TYPE_STRING_LIST (&m_option_type_string_list) |
8164 | 154 #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
|
155 #define CONF_TYPE_IMGFMT (&m_option_type_imgfmt) |
14246 | 156 #define CONF_TYPE_AFMT (&m_option_type_afmt) |
8164 | 157 #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
|
158 #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
|
159 #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
|
160 #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
|
161 #define CONF_TYPE_OBJ_PARAMS (&m_option_type_obj_params) |
8164 | 162 |
163 ///////////////////////////////////////////////////////////////////////////////////////////// | |
164 | |
18258 | 165 /// Option type description |
8164 | 166 struct m_option_type { |
167 char* name; | |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
168 /// Syntax description, etc |
18258 | 169 char* comments; |
170 /// Size needed for the data. | |
171 unsigned int size; | |
172 /// See \ref OptionTypeFlags. | |
8164 | 173 unsigned int flags; |
18258 | 174 |
175 /// Parse the data from a string. | |
176 /** It is the only required function, all others can be NULL. | |
177 * | |
178 * \param opt The option that is parsed. | |
179 * \param name The full option name. | |
180 * \param param The parameter to parse. | |
18283 | 181 * \param dst Pointer to the memory where the data should be written. |
18258 | 182 * If NULL the parameter validity should still be checked. |
183 * \param src Source of the option, see \ref OptionParserModes. | |
18283 | 184 * \return On error a negative value is returned, on success the number of arguments |
18258 | 185 * consumed. For details see \ref OptionParserReturn. |
186 */ | |
8164 | 187 int (*parse)(m_option_t* opt,char *name, char *param, void* dst, int src); |
18258 | 188 |
189 /// Print back a value in string form. | |
190 /** \param opt The option to print. | |
191 * \param val Pointer to the memory holding the data to be printed. | |
192 * \return An allocated string containing the text value or (void*)-1 | |
193 * on error. | |
194 */ | |
8164 | 195 char* (*print)(m_option_t* opt, void* val); |
196 | |
18258 | 197 /** \name |
198 * These functions are called to save/set/restore the status of the | |
18283 | 199 * 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
|
200 * \ref m_option_type_func where 'setting' needs to do more than just |
18258 | 201 * copying some data. |
202 */ | |
203 //@{ | |
204 | |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
205 /// Update a save slot (dst) from the current value in the program (src). |
18258 | 206 /** \param opt The option to copy. |
207 * \param dst Pointer to the destination memory. | |
208 * \param src Pointer to the source memory. | |
209 */ | |
8164 | 210 void (*save)(m_option_t* opt,void* dst, void* src); |
18258 | 211 |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
212 /// Set the value in the program (dst) from a save slot. |
18258 | 213 /** \param opt The option to copy. |
214 * \param dst Pointer to the destination memory. | |
215 * \param src Pointer to the source memory. | |
216 */ | |
8164 | 217 void (*set)(m_option_t* opt,void* dst, void* src); |
18258 | 218 |
219 /// Copy the data between two save slots. If NULL and size is > 0 a memcpy will be used. | |
220 /** \param opt The option to copy. | |
221 * \param dst Pointer to the destination memory. | |
222 * \param src Pointer to the source memory. | |
223 */ | |
8164 | 224 void (*copy)(m_option_t* opt,void* dst, void* src); |
18258 | 225 //@} |
226 | |
227 /// Free the data allocated for a save slot. | |
228 /** This is only needed for dynamic types like strings. | |
229 * \param dst Pointer to the data, usually a pointer that should be freed and | |
230 * set to NULL. | |
231 */ | |
8164 | 232 void (*free)(void* dst); |
233 }; | |
234 | |
18258 | 235 ///@} |
236 | |
237 /// Option description | |
238 /** \ingroup Options | |
239 */ | |
8164 | 240 struct m_option { |
18258 | 241 /// Option name. |
8164 | 242 char *name; |
18258 | 243 |
244 /// Reserved for higher level APIs, it shouldn't be used by parsers. | |
245 /** The suboption parser and func types do use it. They should instead | |
18283 | 246 * use the priv field but this was inherited from older versions of the |
18258 | 247 * config code. |
248 */ | |
249 void *p; | |
250 | |
251 /// Option type. | |
8164 | 252 m_option_type_t* type; |
18258 | 253 |
254 /// See \ref OptionFlags. | |
8164 | 255 unsigned int flags; |
18258 | 256 |
18283 | 257 /// \brief Mostly useful for numeric types, the \ref M_OPT_MIN flags must |
18258 | 258 /// also be set. |
259 double min; | |
260 | |
18283 | 261 /// \brief Mostly useful for numeric types, the \ref M_OPT_MAX flags must |
18258 | 262 /// also be set. |
263 double max; | |
264 | |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
265 /// 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
|
266 /** This used to be a function pointer to hold a 'reverse to defaults' func. |
18258 | 267 * 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
|
268 * Passing a 'default func' is still valid for all func based option types. |
18258 | 269 */ |
270 void* priv; | |
8164 | 271 }; |
272 | |
273 | |
18258 | 274 /// \defgroup OptionFlags Option flags |
275 ///@{ | |
8164 | 276 |
18283 | 277 /// The option has a minimum set in \ref m_option::min. |
8164 | 278 #define M_OPT_MIN (1<<0) |
18258 | 279 |
18283 | 280 /// The option has a maximum set in \ref m_option::max. |
8164 | 281 #define M_OPT_MAX (1<<1) |
18258 | 282 |
18283 | 283 /// The option has a minimum and maximum in \ref m_option::min and \ref m_option::max. |
8164 | 284 #define M_OPT_RANGE (M_OPT_MIN|M_OPT_MAX) |
18258 | 285 |
286 /// The option is forbidden in config files. | |
8164 | 287 #define M_OPT_NOCFG (1<<2) |
18258 | 288 |
18283 | 289 /// The option is forbidden on the command line. |
8164 | 290 #define M_OPT_NOCMD (1<<3) |
18258 | 291 |
292 /// The option is global in the \ref Config. | |
293 /** 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
|
294 * it's parsed (i.e. it won't be set later) |
18258 | 295 * e.g options : -v, -quiet |
296 */ | |
8164 | 297 #define M_OPT_GLOBAL (1<<4) |
18258 | 298 |
299 /// The \ref Config won't save this option on push. | |
18283 | 300 /** 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
|
301 * its entry (i.e. it may be set later) |
18258 | 302 * e.g options : -include |
303 */ | |
8164 | 304 #define M_OPT_NOSAVE (1<<5) |
18258 | 305 |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
306 /// \brief The \ref Config will emulate the old behavior by pushing the |
18258 | 307 /// option only if it was set by the user. |
8164 | 308 #define M_OPT_OLD (1<<6) |
309 | |
18258 | 310 /// \defgroup OldOptionFlags Backward compatibility |
311 /// | |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
312 /// These are kept for compatibility with older code. |
18258 | 313 /// @{ |
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
|
314 #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
|
315 #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
|
316 #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
|
317 #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
|
318 #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
|
319 #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
|
320 #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
|
321 #define CONF_OLD M_OPT_OLD |
18258 | 322 ///@} |
8164 | 323 |
18258 | 324 ///@} |
8164 | 325 |
18258 | 326 /// \defgroup OptionTypeFlags Option type flags |
327 /// \ingroup OptionTypes | |
328 /// | |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
329 /// These flags are used to describe special parser capabilities or behavior. |
18258 | 330 /// |
331 ///@{ | |
332 | |
333 /// Suboption parser flag. | |
334 /** When this flag is set, m_option::p should point to another m_option | |
335 * array. Only the parse function will be called. If dst is set, it should | |
336 * create/update an array of char* containg opt/val pairs. The options in | |
337 * the child array will then be set automatically by the \ref Config. | |
18283 | 338 * Also note that suboptions may be directly accessed by using |
18258 | 339 * -option:subopt blah. |
340 */ | |
8164 | 341 #define M_OPT_TYPE_HAS_CHILD (1<<0) |
18258 | 342 |
343 /// Wildcard matching flag. | |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
344 /** If set the option type has a use for option names ending with a * |
18283 | 345 * (used for -aa*), this only affects the option name matching. |
18258 | 346 */ |
8164 | 347 #define M_OPT_TYPE_ALLOW_WILDCARD (1<<1) |
18258 | 348 |
349 /// Dynamic data type. | |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
350 /** 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
|
351 * 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
|
352 * 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
|
353 * the initial value is statically allocated (pretty common with strings). |
18258 | 354 */ |
8164 | 355 #define M_OPT_TYPE_DYNAMIC (1<<2) |
18258 | 356 |
357 /// Indirect option type. | |
358 /** If this is set the parse function doesn't directly return | |
359 * the wanted thing. Options use this if for some reasons they have to wait | |
360 * until the set call to be able to correctly set the target var. | |
361 * So for those types new values must first be parsed, then set to the target | |
362 * 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
|
363 * target var. It's used by the callback-based options as the callback call |
18258 | 364 * may append later on. |
365 */ | |
8164 | 366 #define M_OPT_TYPE_INDIRECT (1<<3) |
367 | |
18258 | 368 ///@} |
8164 | 369 |
370 ///////////////////////////// Parser flags //////////////////////////////////////// | |
371 | |
18258 | 372 /// \defgroup OptionParserModes Option parser modes |
373 /// \ingroup Options | |
374 /// | |
18316
b3be7df634b0
spelling/grammar/wording fixes in doxygen and non-doxygen comments
diego
parents:
18283
diff
changeset
|
375 /// Some parsers behave differently depending on the mode passed in the src |
18258 | 376 /// parameter of m_option_type::parse. For example the flag type doesn't take |
377 /// an argument when parsing from the command line. | |
378 ///@{ | |
379 | |
380 /// Set when parsing from a config file. | |
8164 | 381 #define M_CONFIG_FILE 0 |
18258 | 382 /// Set when parsing command line arguments. |
8164 | 383 #define M_COMMAND_LINE 1 |
384 | |
18258 | 385 ///@} |
386 | |
387 /// \defgroup OptionParserReturn Option parser return code | |
388 /// \ingroup Options | |
389 /// | |
18283 | 390 /// On success parsers return the number of arguments consumed: 0 or 1. |
18258 | 391 /// |
18283 | 392 /// To indicate that MPlayer should exit without playing anything, |
18258 | 393 /// parsers return M_OPT_EXIT minus the number of parameters they |
394 /// consumed: \ref M_OPT_EXIT or \ref M_OPT_EXIT-1. | |
395 /// | |
18283 | 396 /// On error one of the following (negative) error codes is returned: |
18258 | 397 ///@{ |
398 | |
18283 | 399 /// 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
|
400 #define M_OPT_UNKNOWN -1 |
18258 | 401 |
402 /// Returned when a parameter is needed but wasn't provided. | |
8164 | 403 #define M_OPT_MISSING_PARAM -2 |
18258 | 404 |
405 /// Returned when the given parameter couldn't be parsed. | |
8164 | 406 #define M_OPT_INVALID -3 |
18258 | 407 |
408 /// \brief Returned if the value is "out of range". The exact meaning may | |
409 /// vary from type to type. | |
8164 | 410 #define M_OPT_OUT_OF_RANGE -4 |
18258 | 411 |
412 /// 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
|
413 #define M_OPT_PARSER_ERR -5 |
18258 | 414 |
415 /// Returned when MPlayer should exit. Used by various help stuff. | |
416 /** M_OPT_EXIT must be the lowest number on this list. | |
417 */ | |
9791
c5b63e88253d
Fix some 10L typo in header (m_struct_s instead of m_struct_st).
albeu
parents:
9593
diff
changeset
|
418 #define M_OPT_EXIT -6 |
8164 | 419 |
18258 | 420 /// \defgroup OldOptionParserReturn Backward compatibility |
421 /// | |
18283 | 422 /// These are kept for compatibility with older code. |
18258 | 423 /// |
424 ///@{ | |
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
|
425 #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
|
426 #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
|
427 #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
|
428 #define ERR_FUNC_ERR M_OPT_PARSER_ERR |
18258 | 429 ///@} |
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
|
430 |
18258 | 431 ///@} |
432 | |
433 /// Find the option matching the given name in the list. | |
434 /** \ingroup Options | |
18283 | 435 * This function takes the possible wildcards into account (see |
18258 | 436 * \ref M_OPT_TYPE_ALLOW_WILDCARD). |
437 * | |
438 * \param list Pointer to an array of \ref m_option. | |
439 * \param name Name of the option. | |
440 * \return The matching option or NULL. | |
441 */ | |
19053
75327b24e06f
marks several string parameters as const, as they are not modified inside the function, Patch by Stefan Huehner, stefan AT huehner-org
reynaldo
parents:
18316
diff
changeset
|
442 m_option_t* m_option_list_find(m_option_t* list,const char* name); |
8164 | 443 |
18258 | 444 /// Helper to parse options, see \ref m_option_type::parse. |
8164 | 445 inline static int |
446 m_option_parse(m_option_t* opt,char *name, char *param, void* dst, int src) { | |
447 return opt->type->parse(opt,name,param,dst,src); | |
448 } | |
449 | |
18258 | 450 /// Helper to print options, see \ref m_option_type::print. |
8164 | 451 inline static char* |
452 m_option_print(m_option_t* opt, void* val_ptr) { | |
453 if(opt->type->print) | |
454 return opt->type->print(opt,val_ptr); | |
455 else | |
8168 | 456 return (char*)-1; |
8164 | 457 } |
458 | |
18258 | 459 /// Helper around \ref m_option_type::save. |
8164 | 460 inline static void |
461 m_option_save(m_option_t* opt,void* dst, void* src) { | |
462 if(opt->type->save) | |
463 opt->type->save(opt,dst,src); | |
464 } | |
465 | |
18258 | 466 /// Helper around \ref m_option_type::set. |
8164 | 467 inline static void |
468 m_option_set(m_option_t* opt,void* dst, void* src) { | |
469 if(opt->type->set) | |
470 opt->type->set(opt,dst,src); | |
471 } | |
472 | |
18258 | 473 /// Helper around \ref m_option_type::copy. |
8164 | 474 inline static void |
475 m_option_copy(m_option_t* opt,void* dst, void* src) { | |
476 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
|
477 opt->type->copy(opt,dst,src); |
8164 | 478 else if(opt->type->size > 0) |
479 memcpy(dst,src,opt->type->size); | |
480 } | |
481 | |
18258 | 482 /// Helper around \ref m_option_type::free. |
8164 | 483 inline static void |
484 m_option_free(m_option_t* opt,void* dst) { | |
485 if(opt->type->free) | |
486 opt->type->free(dst); | |
487 } | |
488 | |
18258 | 489 /*@}*/ |
490 | |
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
|
491 #endif /* _M_OPTION_H */ |