m_option.h

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