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