Merge svn changes up to r30484
[mplayer/kovensky.git] / m_option.h
blobd66f670d2abf42e7d5b4b87cca7ef576726d00cf
1 /*
2 * This file is part of MPlayer.
4 * MPlayer is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * MPlayer is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with MPlayer; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 #ifndef MPLAYER_M_OPTION_H
20 #define MPLAYER_M_OPTION_H
22 #include <string.h>
23 #include <stddef.h>
25 /// \defgroup Options
26 /// m_option allows to parse, print and copy data of various types.
27 /// It is the base of the \ref OptionsStruct, \ref Config and
28 /// \ref Properties APIs.
29 ///@{
31 /// \file m_option.h
33 /// \ingroup OptionTypes
34 typedef struct m_option_type m_option_type_t;
35 typedef struct m_option m_option_t;
36 struct m_struct_st;
38 /// \defgroup OptionTypes Options types
39 /// \ingroup Options
40 ///@{
42 ///////////////////////////// Options types declarations ////////////////////////////
44 // Simple types
45 extern const m_option_type_t m_option_type_flag;
46 extern const m_option_type_t m_option_type_int;
47 extern const m_option_type_t m_option_type_int64;
48 extern const m_option_type_t m_option_type_float;
49 extern const m_option_type_t m_option_type_double;
50 extern const m_option_type_t m_option_type_string;
51 extern const m_option_type_t m_option_type_string_list;
52 extern const m_option_type_t m_option_type_position;
53 extern const m_option_type_t m_option_type_time;
54 extern const m_option_type_t m_option_type_time_size;
56 extern const m_option_type_t m_option_type_print;
57 extern const m_option_type_t m_option_type_print_indirect;
58 extern const m_option_type_t m_option_type_print_func;
59 extern const m_option_type_t m_option_type_subconfig;
60 extern const m_option_type_t m_option_type_imgfmt;
61 extern const m_option_type_t m_option_type_afmt;
63 // Func-based types
64 extern const m_option_type_t m_option_type_func_full;
65 extern const m_option_type_t m_option_type_func_param;
66 extern const m_option_type_t m_option_type_func;
68 /// Callback used to reset func options.
69 typedef void (*m_opt_default_func_t)(const m_option_t *, const char*);
71 /// Callback used by m_option_type_func_full options.
72 typedef int (*m_opt_func_full_t)(const m_option_t *, const char *, char *);
74 /// Callback used by m_option_type_func_param options.
75 typedef int (*m_opt_func_param_t)(const m_option_t *, const char *);
77 /// Callback used by m_option_type_func options.
78 typedef int (*m_opt_func_t)(const m_option_t *);
80 // Backwards compatibility
81 typedef m_opt_default_func_t cfg_default_func_t;
82 typedef m_opt_func_full_t cfg_func_arg_param_t;
83 typedef m_opt_func_param_t cfg_func_param_t;
84 typedef m_opt_func_t cfg_func_t;
86 #define END_AT_NONE 0
87 #define END_AT_TIME 1
88 #define END_AT_SIZE 2
89 typedef struct {
90 double pos;
91 int type;
92 } m_time_size_t;
94 /// Extra definition needed for \ref m_option_type_obj_settings_list options.
95 typedef struct {
96 /// Pointer to an array of pointer to some object type description struct.
97 void** list;
98 /// Offset of the object type name (char*) in the description struct.
99 void* name_off;
100 /// Offset of the object type info string (char*) in the description struct.
101 void* info_off;
102 /// \brief Offset of the object type parameter description (\ref m_struct_st)
103 /// in the description struct.
104 void* desc_off;
105 } m_obj_list_t;
107 /// The data type used by \ref m_option_type_obj_settings_list.
108 typedef struct m_obj_settings {
109 /// Type of the object.
110 char* name;
111 /// NULL terminated array of parameter/value pairs.
112 char** attribs;
113 } m_obj_settings_t;
115 /// A parser to set up a list of objects.
116 /** It creates a NULL terminated array \ref m_obj_settings. The option priv
117 * field (\ref m_option::priv) must point to a \ref m_obj_list_t describing
118 * the available object types.
120 extern const m_option_type_t m_option_type_obj_settings_list;
122 /// Extra definition needed for \ref m_option_type_obj_presets options.
123 typedef struct {
124 /// Description of the struct holding the presets.
125 struct m_struct_st* in_desc;
126 /// Description of the struct that should be set by the presets.
127 struct m_struct_st* out_desc;
128 /// Pointer to an array of structs defining the various presets.
129 void* presets;
130 /// Offset of the preset's name inside the in_struct.
131 void* name_off;
132 } m_obj_presets_t;
134 /// Set several fields in a struct at once.
135 /** For this two struct descriptions are used. One for the struct holding the
136 * preset and one for the struct beeing set. Every field present in both
137 * structs will be copied from the preset struct to the destination one.
138 * The option priv field (\ref m_option::priv) must point to a correctly
139 * filled \ref m_obj_presets_t.
141 extern const m_option_type_t m_option_type_obj_presets;
143 /// Parse an URL into a struct.
144 /** The option priv field (\ref m_option::priv) must point to a
145 * \ref m_struct_st describing which fields of the URL must be used.
147 extern const m_option_type_t m_option_type_custom_url;
149 /// Extra definition needed for \ref m_option_type_obj_params options.
150 typedef struct {
151 /// Field descriptions.
152 const struct m_struct_st* desc;
153 /// Field separator to use.
154 char separator;
155 } m_obj_params_t;
157 /// Parse a set of parameters.
158 /** Parameters are separated by the given separator and each one
159 * successively sets a field from the struct. The option priv field
160 * (\ref m_option::priv) must point to a \ref m_obj_params_t.
162 extern const m_option_type_t m_option_type_obj_params;
164 typedef struct {
165 int start;
166 int end;
167 } m_span_t;
168 /// Ready made settings to parse a \ref m_span_t with a start-end syntax.
169 extern const m_obj_params_t m_span_params_def;
172 // FIXME: backward compatibility
173 #define CONF_TYPE_FLAG (&m_option_type_flag)
174 #define CONF_TYPE_INT (&m_option_type_int)
175 #define CONF_TYPE_INT64 (&m_option_type_int64)
176 #define CONF_TYPE_FLOAT (&m_option_type_float)
177 #define CONF_TYPE_DOUBLE (&m_option_type_double)
178 #define CONF_TYPE_STRING (&m_option_type_string)
179 #define CONF_TYPE_FUNC (&m_option_type_func)
180 #define CONF_TYPE_FUNC_PARAM (&m_option_type_func_param)
181 #define CONF_TYPE_PRINT (&m_option_type_print)
182 #define CONF_TYPE_PRINT_INDIRECT (&m_option_type_print_indirect)
183 #define CONF_TYPE_PRINT_FUNC (&m_option_type_print_func)
184 #define CONF_TYPE_FUNC_FULL (&m_option_type_func_full)
185 #define CONF_TYPE_SUBCONFIG (&m_option_type_subconfig)
186 #define CONF_TYPE_STRING_LIST (&m_option_type_string_list)
187 #define CONF_TYPE_POSITION (&m_option_type_position)
188 #define CONF_TYPE_IMGFMT (&m_option_type_imgfmt)
189 #define CONF_TYPE_AFMT (&m_option_type_afmt)
190 #define CONF_TYPE_SPAN (&m_option_type_span)
191 #define CONF_TYPE_OBJ_SETTINGS_LIST (&m_option_type_obj_settings_list)
192 #define CONF_TYPE_OBJ_PRESETS (&m_option_type_obj_presets)
193 #define CONF_TYPE_CUSTOM_URL (&m_option_type_custom_url)
194 #define CONF_TYPE_OBJ_PARAMS (&m_option_type_obj_params)
195 #define CONF_TYPE_TIME (&m_option_type_time)
196 #define CONF_TYPE_TIME_SIZE (&m_option_type_time_size)
198 /////////////////////////////////////////////////////////////////////////////////////////////
200 /// Option type description
201 struct m_option_type {
202 char* name;
203 /// Syntax description, etc
204 char* comments;
205 /// Size needed for the data.
206 unsigned int size;
207 /// See \ref OptionTypeFlags.
208 unsigned int flags;
210 /// Parse the data from a string.
211 /** It is the only required function, all others can be NULL.
213 * \param opt The option that is parsed.
214 * \param name The full option name.
215 * \param param The parameter to parse.
216 * \param dst Pointer to the memory where the data should be written.
217 * If NULL the parameter validity should still be checked.
218 * \param src Source of the option, see \ref OptionParserModes.
219 * \return On error a negative value is returned, on success the number of arguments
220 * consumed. For details see \ref OptionParserReturn.
222 int (*parse)(const m_option_t* opt,const char *name, char *param, void* dst, int src);
224 /// Print back a value in string form.
225 /** \param opt The option to print.
226 * \param val Pointer to the memory holding the data to be printed.
227 * \return An allocated string containing the text value or (void*)-1
228 * on error.
230 char* (*print)(const m_option_t* opt, const void* val);
232 /** \name
233 * These functions are called to save/set/restore the status of the
234 * variables. The difference between the 3 only matters for types like
235 * \ref m_option_type_func where 'setting' needs to do more than just
236 * copying some data.
238 //@{
240 /// Update a save slot (dst) from the current value in the program (src).
241 /** \param opt The option to copy.
242 * \param dst Pointer to the destination memory.
243 * \param src Pointer to the source memory.
245 void (*save)(const m_option_t* opt,void* dst, void* src);
247 /// Set the value in the program (dst) from a save slot.
248 /** \param opt The option to copy.
249 * \param dst Pointer to the destination memory.
250 * \param src Pointer to the source memory.
252 void (*set)(const m_option_t* opt,void* dst, void* src);
254 /// Copy the data between two save slots. If NULL and size is > 0 a memcpy will be used.
255 /** \param opt The option to copy.
256 * \param dst Pointer to the destination memory.
257 * \param src Pointer to the source memory.
259 void (*copy)(const m_option_t* opt,void* dst, void* src);
260 //@}
262 /// Free the data allocated for a save slot.
263 /** This is only needed for dynamic types like strings.
264 * \param dst Pointer to the data, usually a pointer that should be freed and
265 * set to NULL.
267 void (*free)(void* dst);
270 ///@}
272 /// Option description
273 /** \ingroup Options
275 struct m_option {
276 /// Option name.
277 const char *name;
279 /// Reserved for higher level APIs, it shouldn't be used by parsers.
280 /** The suboption parser and func types do use it. They should instead
281 * use the priv field but this was inherited from older versions of the
282 * config code.
284 void *p;
286 /// Option type.
287 const m_option_type_t* type;
289 /// See \ref OptionFlags.
290 unsigned int flags;
292 /// \brief Mostly useful for numeric types, the \ref M_OPT_MIN flags must
293 /// also be set.
294 double min;
296 /// \brief Mostly useful for numeric types, the \ref M_OPT_MAX flags must
297 /// also be set.
298 double max;
300 /// Type dependent data (for all kinds of extended settings).
301 /** This used to be a function pointer to hold a 'reverse to defaults' func.
302 * Now it can be used to pass any type of extra args needed by the parser.
303 * Passing a 'default func' is still valid for all func based option types.
305 void* priv;
307 int new;
309 int offset;
313 /// \defgroup OptionFlags Option flags
314 ///@{
316 /// The option has a minimum set in \ref m_option::min.
317 #define M_OPT_MIN (1<<0)
319 /// The option has a maximum set in \ref m_option::max.
320 #define M_OPT_MAX (1<<1)
322 /// The option has a minimum and maximum in \ref m_option::min and \ref m_option::max.
323 #define M_OPT_RANGE (M_OPT_MIN|M_OPT_MAX)
325 /// The option is forbidden in config files.
326 #define M_OPT_NOCFG (1<<2)
328 /// The option is forbidden on the command line.
329 #define M_OPT_NOCMD (1<<3)
331 /// The option is global in the \ref Config.
332 /** It won't be saved on push and the command line parser will set it when
333 * it's parsed (i.e. it won't be set later)
334 * e.g options : -v, -quiet
336 #define M_OPT_GLOBAL (1<<4)
338 /// The \ref Config won't save this option on push.
339 /** It won't be saved on push but the command line parser will add it with
340 * its entry (i.e. it may be set later)
341 * e.g options : -include
343 #define M_OPT_NOSAVE (1<<5)
345 /// \brief The \ref Config will emulate the old behavior by pushing the
346 /// option only if it was set by the user.
347 #define M_OPT_OLD (1<<6)
349 /// The option should be set during command line pre-parsing
350 #define M_OPT_PRE_PARSE (1<<7)
352 /// \defgroup OldOptionFlags Backward compatibility
354 /// These are kept for compatibility with older code.
355 /// @{
356 #define CONF_MIN M_OPT_MIN
357 #define CONF_MAX M_OPT_MAX
358 #define CONF_RANGE M_OPT_RANGE
359 #define CONF_NOCFG M_OPT_NOCFG
360 #define CONF_NOCMD M_OPT_NOCMD
361 #define CONF_GLOBAL M_OPT_GLOBAL
362 #define CONF_NOSAVE M_OPT_NOSAVE
363 #define CONF_OLD M_OPT_OLD
364 #define CONF_PRE_PARSE M_OPT_PRE_PARSE
365 ///@}
367 ///@}
369 /// \defgroup OptionTypeFlags Option type flags
370 /// \ingroup OptionTypes
372 /// These flags are used to describe special parser capabilities or behavior.
374 ///@{
376 /// Suboption parser flag.
377 /** When this flag is set, m_option::p should point to another m_option
378 * array. Only the parse function will be called. If dst is set, it should
379 * create/update an array of char* containg opt/val pairs. The options in
380 * the child array will then be set automatically by the \ref Config.
381 * Also note that suboptions may be directly accessed by using
382 * -option:subopt blah.
384 #define M_OPT_TYPE_HAS_CHILD (1<<0)
386 /// Wildcard matching flag.
387 /** If set the option type has a use for option names ending with a *
388 * (used for -aa*), this only affects the option name matching.
390 #define M_OPT_TYPE_ALLOW_WILDCARD (1<<1)
392 /// Dynamic data type.
393 /** This flag indicates that the data is dynamically allocated (m_option::p
394 * points to a pointer). It enables a little hack in the \ref Config wich
395 * replaces the initial value of such variables with a dynamic copy in case
396 * the initial value is statically allocated (pretty common with strings).
398 #define M_OPT_TYPE_DYNAMIC (1<<2)
400 /// Indirect option type.
401 /** If this is set the parse function doesn't directly return
402 * the wanted thing. Options use this if for some reasons they have to wait
403 * until the set call to be able to correctly set the target var.
404 * So for those types new values must first be parsed, then set to the target
405 * var. If this flag isn't set then new values can be parsed directly to the
406 * target var. It's used by the callback-based options as the callback call
407 * may append later on.
409 #define M_OPT_TYPE_INDIRECT (1<<3)
411 ///@}
413 ///////////////////////////// Parser flags ////////////////////////////////////////
415 /// \defgroup OptionParserModes Option parser modes
416 /// \ingroup Options
418 /// Some parsers behave differently depending on the mode passed in the src
419 /// parameter of m_option_type::parse. For example the flag type doesn't take
420 /// an argument when parsing from the command line.
421 ///@{
423 /// Set when parsing from a config file.
424 #define M_CONFIG_FILE 0
425 /// Set when parsing command line arguments.
426 #define M_COMMAND_LINE 1
427 /// Set when pre-parsing the command line
428 #define M_COMMAND_LINE_PRE_PARSE 2
430 ///@}
432 /// \defgroup OptionParserReturn Option parser return code
433 /// \ingroup Options
435 /// On success parsers return the number of arguments consumed: 0 or 1.
437 /// To indicate that MPlayer should exit without playing anything,
438 /// parsers return M_OPT_EXIT minus the number of parameters they
439 /// consumed: \ref M_OPT_EXIT or \ref M_OPT_EXIT-1.
441 /// On error one of the following (negative) error codes is returned:
442 ///@{
444 /// For use by higher level APIs when the option name is invalid.
445 #define M_OPT_UNKNOWN -1
447 /// Returned when a parameter is needed but wasn't provided.
448 #define M_OPT_MISSING_PARAM -2
450 /// Returned when the given parameter couldn't be parsed.
451 #define M_OPT_INVALID -3
453 /// \brief Returned if the value is "out of range". The exact meaning may
454 /// vary from type to type.
455 #define M_OPT_OUT_OF_RANGE -4
457 /// Returned if the parser failed for any other reason than a bad parameter.
458 #define M_OPT_PARSER_ERR -5
460 /// Returned when MPlayer should exit. Used by various help stuff.
461 /** M_OPT_EXIT must be the lowest number on this list.
463 #define M_OPT_EXIT -6
465 /// \defgroup OldOptionParserReturn Backward compatibility
467 /// These are kept for compatibility with older code.
469 ///@{
470 #define ERR_NOT_AN_OPTION M_OPT_UNKNOWN
471 #define ERR_MISSING_PARAM M_OPT_MISSING_PARAM
472 #define ERR_OUT_OF_RANGE M_OPT_OUT_OF_RANGE
473 #define ERR_FUNC_ERR M_OPT_PARSER_ERR
474 ///@}
476 ///@}
478 /// Find the option matching the given name in the list.
479 /** \ingroup Options
480 * This function takes the possible wildcards into account (see
481 * \ref M_OPT_TYPE_ALLOW_WILDCARD).
483 * \param list Pointer to an array of \ref m_option.
484 * \param name Name of the option.
485 * \return The matching option or NULL.
487 const m_option_t* m_option_list_find(const m_option_t* list,const char* name);
489 /// Helper to parse options, see \ref m_option_type::parse.
490 inline static int
491 m_option_parse(const m_option_t* opt,const char *name, char *param, void* dst, int src) {
492 return opt->type->parse(opt,name,param,dst,src);
495 /// Helper to print options, see \ref m_option_type::print.
496 inline static char*
497 m_option_print(const m_option_t* opt, const void* val_ptr) {
498 if(opt->type->print)
499 return opt->type->print(opt,val_ptr);
500 else
501 return (char*)-1;
504 /// Helper around \ref m_option_type::copy.
505 inline static void
506 m_option_copy(const m_option_t* opt,void* dst, void* src) {
507 if(opt->type->copy)
508 opt->type->copy(opt,dst,src);
509 else if(opt->type->size > 0)
510 memcpy(dst,src,opt->type->size);
513 /// Helper around \ref m_option_type::free.
514 inline static void
515 m_option_free(const m_option_t* opt,void* dst) {
516 if(opt->type->free)
517 opt->type->free(dst);
520 /*@}*/
522 #define OPT_FLAG_ON(optname, varname, flags) {optname, NULL, &m_option_type_flag, flags, 0, 1, NULL, 1, offsetof(struct MPOpts, varname)}
523 #define OPT_FLAG_OFF(optname, varname, flags) {optname, NULL, &m_option_type_flag, flags, 1, 0, NULL, 1, offsetof(struct MPOpts, varname)}
524 #define OPT_FLAG_CONSTANTS(optname, varname, flags, offvalue, value) {optname, NULL, &m_option_type_flag, flags, offvalue, value, NULL, 1, offsetof(struct MPOpts, varname)}
525 #define OPT_STRINGLIST(optname, varname, flags) {optname, NULL, &m_option_type_string_list, flags, 0, 0, NULL, 1, offsetof(struct MPOpts, varname)}
526 #define OPT_INT(optname, varname, flags) {optname, NULL, &m_option_type_int, flags, 0, 0, NULL, 1, offsetof(struct MPOpts, varname)}
527 #define OPT_INTRANGE(optname, varname, flags, min, max) {optname, NULL, &m_option_type_int, (flags)|CONF_RANGE, min, max, NULL, 1, offsetof(struct MPOpts, varname)}
528 #define OPT_FLOATRANGE(optname, varname, flags, min, max) {optname, NULL, &m_option_type_float, (flags)|CONF_RANGE, min, max, NULL, 1, offsetof(struct MPOpts, varname)}
529 #define OPT_STRING(optname, varname, flags) {optname, NULL, &m_option_type_string, flags, 0, 0, NULL, 1, offsetof(struct MPOpts, varname)}
530 #define OPT_SETTINGSLIST(optname, varname, flags, objlist) {optname, NULL, &m_option_type_obj_settings_list, flags, 0, 0, objlist, 1, offsetof(struct MPOpts, varname)}
532 #endif /* MPLAYER_M_OPTION_H */