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