git.sesse.net Git - vlc/blob - include/vlc_variables.h

   1 /*****************************************************************************
   2  * vlc_variables.h: variables handling
   3  *****************************************************************************
   4  * Copyright (C) 2002-2004 VLC authors and VideoLAN
   5  * $Id$
   6  *
   7  * Authors: Samuel Hocevar <sam@zoy.org>
   8  *          Gildas Bazin <gbazin@netcourrier.com>
   9  *
  10  * This program is free software; you can redistribute it and/or modify it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18  * GNU Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #ifndef VLC_VARIABLES_H
  26 #define VLC_VARIABLES_H 1
  27
  28 /**
  29  * \file
  30  * This file defines functions and structures for dynamic variables in vlc
  31  */
  32
  33 /**
  34  * \defgroup variables Variables
  35  *
  36  * Functions for using the object variables in vlc.
  37  *
  38  * Vlc have a very powerful "object variable" infrastructure useful
  39  * for many things.
  40  *
  41  * @{
  42  */
  43
  44 #define VLC_VAR_TYPE      0x00ff
  45 #define VLC_VAR_CLASS     0x00f0
  46 #define VLC_VAR_FLAGS     0xff00
  47
  48 /**
  49  * \defgroup var_type Variable types
  50  * These are the different types a vlc variable can have.
  51  * @{
  52  */
  53 #define VLC_VAR_VOID      0x0010
  54 #define VLC_VAR_BOOL      0x0020
  55 #define VLC_VAR_INTEGER   0x0030
  56 #define VLC_VAR_HOTKEY    0x0031
  57 #define VLC_VAR_STRING    0x0040
  58 #define VLC_VAR_VARIABLE  0x0044
  59 #define VLC_VAR_FLOAT     0x0050
  60 #define VLC_VAR_TIME      0x0060
  61 #define VLC_VAR_ADDRESS   0x0070
  62 #define VLC_VAR_COORDS    0x00A0
  63 /**@}*/
  64
  65 /** \defgroup var_flags Additive flags
  66  * These flags are added to the type field of the variable. Most as a result of
  67  * a var_Change() call, but some may be added at creation time
  68  * @{
  69  */
  70 #define VLC_VAR_HASCHOICE 0x0100
  71 #define VLC_VAR_HASMIN    0x0200
  72 #define VLC_VAR_HASMAX    0x0400
  73 #define VLC_VAR_HASSTEP   0x0800
  74
  75 #define VLC_VAR_ISCOMMAND 0x2000
  76
  77 /** Creation flag */
  78 /* If the variable is not found on the current module
  79    search all parents and finally module config until found */
  80 #define VLC_VAR_DOINHERIT 0x8000
  81 /**@}*/
  82
  83 /**
  84  * \defgroup var_action Variable actions
  85  * These are the different actions that can be used with var_Change().
  86  * The parameters given are the meaning of the two last parameters of
  87  * var_Change() when this action is being used.
  88  * @{
  89  */
  90
  91 /**
  92  * Set the minimum value of this variable
  93  * \param p_val The new minimum value
  94  * \param p_val2 Unused
  95  */
  96 #define VLC_VAR_SETMIN              0x0010
  97 /**
  98  * Set the maximum value of this variable
  99  * \param p_val The new maximum value
 100  * \param p_val2 Unused
 101  */
 102 #define VLC_VAR_SETMAX              0x0011
 103 #define VLC_VAR_SETSTEP             0x0012
 104
 105 /**
 106  * Set the value of this variable without triggering any callbacks
 107  * \param p_val The new value
 108  * \param p_val2 Unused
 109  */
 110 #define VLC_VAR_SETVALUE            0x0013
 111
 112 #define VLC_VAR_SETTEXT             0x0014
 113 #define VLC_VAR_GETTEXT             0x0015
 114
 115 #define VLC_VAR_GETMIN              0x0016
 116 #define VLC_VAR_GETMAX              0x0017
 117 #define VLC_VAR_GETSTEP             0x0018
 118
 119 #define VLC_VAR_ADDCHOICE           0x0020
 120 #define VLC_VAR_DELCHOICE           0x0021
 121 #define VLC_VAR_CLEARCHOICES        0x0022
 122 #define VLC_VAR_SETDEFAULT          0x0023
 123 #define VLC_VAR_GETCHOICES          0x0024
 124 #define VLC_VAR_GETLIST             0x0025
 125 #define VLC_VAR_CHOICESCOUNT        0x0026
 126
 127 #define VLC_VAR_SETISCOMMAND        0x0040
 128 /**@}*/
 129
 130 /** \defgroup var_GetAndSet Variable actions
 131  * These are the different actions that can be used with var_GetAndSet()
 132  * @{
 133  */
 134 enum {
 135     VLC_VAR_BOOL_TOGGLE, /**< Invert a boolean value (param ignored) */
 136     VLC_VAR_INTEGER_ADD, /**< Add parameter to an integer value */
 137     VLC_VAR_INTEGER_OR,  /**< Binary OR over an integer bits field */
 138     VLC_VAR_INTEGER_NAND,/**< Binary NAND over an integer bits field */
 139 };
 140 /**@}*/
 141
 142 /*****************************************************************************
 143  * Prototypes
 144  *****************************************************************************/
 145 VLC_API int var_Create( vlc_object_t *, const char *, int );
 146 #define var_Create(a,b,c) var_Create( VLC_OBJECT(a), b, c )
 147
 148 VLC_API int var_Destroy( vlc_object_t *, const char * );
 149 #define var_Destroy(a,b) var_Destroy( VLC_OBJECT(a), b )
 150
 151 VLC_API int var_Change( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * );
 152 #define var_Change(a,b,c,d,e) var_Change( VLC_OBJECT(a), b, c, d, e )
 153
 154 VLC_API int var_Type( vlc_object_t *, const char * ) VLC_USED;
 155 #define var_Type(a,b) var_Type( VLC_OBJECT(a), b )
 156
 157 VLC_API int var_Set( vlc_object_t *, const char *, vlc_value_t );
 158 #define var_Set(a,b,c) var_Set( VLC_OBJECT(a), b, c )
 159
 160 VLC_API int var_Get( vlc_object_t *, const char *, vlc_value_t * );
 161 #define var_Get(a,b,c) var_Get( VLC_OBJECT(a), b, c )
 162
 163 VLC_API int var_SetChecked( vlc_object_t *, const char *, int, vlc_value_t );
 164 #define var_SetChecked(o,n,t,v) var_SetChecked(VLC_OBJECT(o),n,t,v)
 165 VLC_API int var_GetChecked( vlc_object_t *, const char *, int, vlc_value_t * );
 166 #define var_GetChecked(o,n,t,v) var_GetChecked(VLC_OBJECT(o),n,t,v)
 167 VLC_API int var_GetAndSet( vlc_object_t *, const char *, int, vlc_value_t * );
 168
 169 VLC_API int var_Inherit( vlc_object_t *, const char *, int, vlc_value_t * );
 170
 171 VLC_API void var_FreeList( vlc_value_t *, vlc_value_t * );
 172
 173
 174 /*****************************************************************************
 175  * Variable callbacks
 176  *****************************************************************************
 177  * int MyCallback( vlc_object_t *p_this,
 178  *                 char const *psz_variable,
 179  *                 vlc_value_t oldvalue,
 180  *                 vlc_value_t newvalue,
 181  *                 void *p_data);
 182  *****************************************************************************/
 183 VLC_API int var_AddCallback( vlc_object_t *, const char *, vlc_callback_t, void * );
 184 VLC_API int var_DelCallback( vlc_object_t *, const char *, vlc_callback_t, void * );
 185 VLC_API int var_TriggerCallback( vlc_object_t *, const char * );
 186
 187 #define var_AddCallback(a,b,c,d) var_AddCallback( VLC_OBJECT(a), b, c, d )
 188 #define var_DelCallback(a,b,c,d) var_DelCallback( VLC_OBJECT(a), b, c, d )
 189 #define var_TriggerCallback(a,b) var_TriggerCallback( VLC_OBJECT(a), b )
 190
 191 /*****************************************************************************
 192  * helpers functions
 193  *****************************************************************************/
 194
 195 /**
 196  * Set the value of an integer variable
 197  *
 198  * \param p_obj The object that holds the variable
 199  * \param psz_name The name of the variable
 200  * \param i The new integer value of this variable
 201  */
 202 static inline int var_SetInteger( vlc_object_t *p_obj, const char *psz_name,
 203                                   int64_t i )
 204 {
 205     vlc_value_t val;
 206     val.i_int = i;
 207     return var_SetChecked( p_obj, psz_name, VLC_VAR_INTEGER, val );
 208 }
 209
 210 /**
 211  * Set the value of an boolean variable
 212  *
 213  * \param p_obj The object that holds the variable
 214  * \param psz_name The name of the variable
 215  * \param b The new boolean value of this variable
 216  */
 217 static inline int var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool b )
 218 {
 219     vlc_value_t val;
 220     val.b_bool = b;
 221     return var_SetChecked( p_obj, psz_name, VLC_VAR_BOOL, val );
 222 }
 223
 224 /**
 225  * Set the value of a time variable
 226  *
 227  * \param p_obj The object that holds the variable
 228  * \param psz_name The name of the variable
 229  * \param i The new time value of this variable
 230  */
 231 static inline int var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
 232 {
 233     vlc_value_t val;
 234     val.i_time = i;
 235     return var_SetChecked( p_obj, psz_name, VLC_VAR_TIME, val );
 236 }
 237
 238 static inline int var_SetCoords( vlc_object_t *obj, const char *name,
 239                                  int32_t x, int32_t y )
 240 {
 241     vlc_value_t val;
 242     val.coords.x = x;
 243     val.coords.y = y;
 244     return var_SetChecked (obj, name, VLC_VAR_COORDS, val);
 245 }
 246 #define var_SetCoords(o,n,x,y) var_SetCoords(VLC_OBJECT(o),n,x,y)
 247
 248 /**
 249  * Set the value of a float variable
 250  *
 251  * \param p_obj The object that holds the variable
 252  * \param psz_name The name of the variable
 253  * \param f The new float value of this variable
 254  */
 255 static inline int var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
 256 {
 257     vlc_value_t val;
 258     val.f_float = f;
 259     return var_SetChecked( p_obj, psz_name, VLC_VAR_FLOAT, val );
 260 }
 261
 262 /**
 263  * Set the value of a string variable
 264  *
 265  * \param p_obj The object that holds the variable
 266  * \param psz_name The name of the variable
 267  * \param psz_string The new string value of this variable
 268  */
 269 static inline int var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
 270 {
 271     vlc_value_t val;
 272     val.psz_string = (char *)psz_string;
 273     return var_SetChecked( p_obj, psz_name, VLC_VAR_STRING, val );
 274 }
 275
 276 /**
 277  * Set the value of a pointer variable
 278  *
 279  * \param p_obj The object that holds the variable
 280  * \param psz_name The name of the variable
 281  * \param ptr The new pointer value of this variable
 282  */
 283 static inline
 284 int var_SetAddress( vlc_object_t *p_obj, const char *psz_name, void *ptr )
 285 {
 286     vlc_value_t val;
 287     val.p_address = ptr;
 288     return var_SetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, val );
 289 }
 290
 291 #define var_SetInteger(a,b,c)   var_SetInteger( VLC_OBJECT(a),b,c)
 292 #define var_SetBool(a,b,c)      var_SetBool( VLC_OBJECT(a),b,c)
 293 #define var_SetTime(a,b,c)      var_SetTime( VLC_OBJECT(a),b,c)
 294 #define var_SetFloat(a,b,c)     var_SetFloat( VLC_OBJECT(a),b,c)
 295 #define var_SetString(a,b,c)    var_SetString( VLC_OBJECT(a),b,c)
 296 #define var_SetAddress(o, n, p) var_SetAddress(VLC_OBJECT(o), n, p)
 297
 298
 299 /**
 300  * Get an integer value
 301 *
 302  * \param p_obj The object that holds the variable
 303  * \param psz_name The name of the variable
 304  */
 305 VLC_USED
 306 static inline int64_t var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
 307 {
 308     vlc_value_t val;
 309     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_INTEGER, &val ) )
 310         return val.i_int;
 311     else
 312         return 0;
 313 }
 314
 315 /**
 316  * Get a boolean value
 317  *
 318  * \param p_obj The object that holds the variable
 319  * \param psz_name The name of the variable
 320  */
 321 VLC_USED
 322 static inline bool var_GetBool( vlc_object_t *p_obj, const char *psz_name )
 323 {
 324     vlc_value_t val; val.b_bool = false;
 325
 326     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_BOOL, &val ) )
 327         return val.b_bool;
 328     else
 329         return false;
 330 }
 331
 332 /**
 333  * Get a time value
 334  *
 335  * \param p_obj The object that holds the variable
 336  * \param psz_name The name of the variable
 337  */
 338 VLC_USED
 339 static inline int64_t var_GetTime( vlc_object_t *p_obj, const char *psz_name )
 340 {
 341     vlc_value_t val; val.i_time = 0L;
 342     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_TIME, &val ) )
 343         return val.i_time;
 344     else
 345         return 0;
 346 }
 347
 348 static inline void var_GetCoords( vlc_object_t *obj, const char *name,
 349                                   int32_t *px, int32_t *py )
 350 {
 351     vlc_value_t val;
 352
 353     if (likely(!var_GetChecked (obj, name, VLC_VAR_COORDS, &val)))
 354     {
 355         *px = val.coords.x;
 356         *py = val.coords.y;
 357     }
 358     else
 359         *px = *py = 0;
 360 }
 361 #define var_GetCoords(o,n,x,y) var_GetCoords(VLC_OBJECT(o),n,x,y)
 362
 363 /**
 364  * Get a float value
 365  *
 366  * \param p_obj The object that holds the variable
 367  * \param psz_name The name of the variable
 368  */
 369 VLC_USED
 370 static inline float var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
 371 {
 372     vlc_value_t val; val.f_float = 0.0;
 373     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_FLOAT, &val ) )
 374         return val.f_float;
 375     else
 376         return 0.0;
 377 }
 378
 379 /**
 380  * Get a string value
 381  *
 382  * \param p_obj The object that holds the variable
 383  * \param psz_name The name of the variable
 384  */
 385 VLC_USED VLC_MALLOC
 386 static inline char *var_GetString( vlc_object_t *p_obj, const char *psz_name )
 387 {
 388     vlc_value_t val; val.psz_string = NULL;
 389     if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
 390         return NULL;
 391     else
 392         return val.psz_string;
 393 }
 394
 395 VLC_USED VLC_MALLOC
 396 static inline char *var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
 397 {
 398     vlc_value_t val;
 399     if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
 400         return NULL;
 401     if( val.psz_string && *val.psz_string )
 402         return val.psz_string;
 403     free( val.psz_string );
 404     return NULL;
 405 }
 406
 407 VLC_USED
 408 static inline void *var_GetAddress( vlc_object_t *p_obj, const char *psz_name )
 409 {
 410     vlc_value_t val;
 411     if( var_GetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, &val ) )
 412         return NULL;
 413     else
 414         return val.p_address;
 415 }
 416
 417 /**
 418  * Increment an integer variable
 419  * \param p_obj the object that holds the variable
 420  * \param psz_name the name of the variable
 421  */
 422 static inline int64_t var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
 423 {
 424     vlc_value_t val;
 425     val.i_int = 1;
 426     var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_ADD, &val );
 427     return val.i_int;
 428 }
 429 #define var_IncInteger(a,b) var_IncInteger( VLC_OBJECT(a), b )
 430
 431 /**
 432  * Decrement an integer variable
 433  * \param p_obj the object that holds the variable
 434  * \param psz_name the name of the variable
 435  */
 436 static inline int64_t var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
 437 {
 438     vlc_value_t val;
 439     val.i_int = -1;
 440     var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_ADD, &val );
 441     return val.i_int;
 442 }
 443 #define var_DecInteger(a,b) var_DecInteger( VLC_OBJECT(a), b )
 444
 445 static inline uint64_t var_OrInteger( vlc_object_t *obj, const char *name,
 446                                       unsigned v )
 447 {
 448     vlc_value_t val;
 449     val.i_int = v;
 450     var_GetAndSet( obj, name, VLC_VAR_INTEGER_OR, &val );
 451     return val.i_int;
 452 }
 453 #define var_OrInteger(a,b,c) var_OrInteger(VLC_OBJECT(a),b,c)
 454
 455 static inline uint64_t var_NAndInteger( vlc_object_t *obj, const char *name,
 456                                         unsigned v )
 457 {
 458     vlc_value_t val;
 459     val.i_int = v;
 460     var_GetAndSet( obj, name, VLC_VAR_INTEGER_NAND, &val );
 461     return val.i_int;
 462 }
 463 #define var_NAndInteger(a,b,c) var_NAndInteger(VLC_OBJECT(a),b,c)
 464
 465 /**
 466  * Create a integer variable with inherit and get its value.
 467  *
 468  * \param p_obj The object that holds the variable
 469  * \param psz_name The name of the variable
 470  */
 471 VLC_USED
 472 static inline int64_t var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
 473 {
 474     var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 475     return var_GetInteger( p_obj, psz_name );
 476 }
 477
 478 /**
 479  * Create a boolean variable with inherit and get its value.
 480  *
 481  * \param p_obj The object that holds the variable
 482  * \param psz_name The name of the variable
 483  */
 484 VLC_USED
 485 static inline bool var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
 486 {
 487     var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
 488     return var_GetBool( p_obj, psz_name );
 489 }
 490
 491 /**
 492  * Create a time variable with inherit and get its value.
 493  *
 494  * \param p_obj The object that holds the variable
 495  * \param psz_name The name of the variable
 496  */
 497 VLC_USED
 498 static inline int64_t var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
 499 {
 500     var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
 501     return var_GetTime( p_obj, psz_name );
 502 }
 503
 504 /**
 505  * Create a float variable with inherit and get its value.
 506  *
 507  * \param p_obj The object that holds the variable
 508  * \param psz_name The name of the variable
 509  */
 510 VLC_USED
 511 static inline float var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
 512 {
 513     var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
 514     return var_GetFloat( p_obj, psz_name );
 515 }
 516
 517 /**
 518  * Create a string variable with inherit and get its value.
 519  *
 520  * \param p_obj The object that holds the variable
 521  * \param psz_name The name of the variable
 522  */
 523 VLC_USED VLC_MALLOC
 524 static inline char *var_CreateGetString( vlc_object_t *p_obj,
 525                                            const char *psz_name )
 526 {
 527     var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 528     return var_GetString( p_obj, psz_name );
 529 }
 530
 531 VLC_USED VLC_MALLOC
 532 static inline char *var_CreateGetNonEmptyString( vlc_object_t *p_obj,
 533                                                    const char *psz_name )
 534 {
 535     var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 536     return var_GetNonEmptyString( p_obj, psz_name );
 537 }
 538
 539 /**
 540  * Create an address variable with inherit and get its value.
 541  *
 542  * \param p_obj The object that holds the variable
 543  * \param psz_name The name of the variable
 544  */
 545 VLC_USED
 546 static inline void *var_CreateGetAddress( vlc_object_t *p_obj,
 547                                            const char *psz_name )
 548 {
 549     var_Create( p_obj, psz_name, VLC_VAR_ADDRESS | VLC_VAR_DOINHERIT );
 550     return var_GetAddress( p_obj, psz_name );
 551 }
 552
 553 #define var_CreateGetInteger(a,b)   var_CreateGetInteger( VLC_OBJECT(a),b)
 554 #define var_CreateGetBool(a,b)   var_CreateGetBool( VLC_OBJECT(a),b)
 555 #define var_CreateGetTime(a,b)   var_CreateGetTime( VLC_OBJECT(a),b)
 556 #define var_CreateGetFloat(a,b)   var_CreateGetFloat( VLC_OBJECT(a),b)
 557 #define var_CreateGetString(a,b)   var_CreateGetString( VLC_OBJECT(a),b)
 558 #define var_CreateGetNonEmptyString(a,b)   var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
 559 #define var_CreateGetAddress(a,b)  var_CreateGetAddress( VLC_OBJECT(a),b)
 560
 561 /**
 562  * Create a integer command variable with inherit and get its value.
 563  *
 564  * \param p_obj The object that holds the variable
 565  * \param psz_name The name of the variable
 566  */
 567 VLC_USED
 568 static inline int64_t var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
 569 {
 570     var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
 571                                    | VLC_VAR_ISCOMMAND );
 572     return var_GetInteger( p_obj, psz_name );
 573 }
 574
 575 /**
 576  * Create a boolean command variable with inherit and get its value.
 577  *
 578  * \param p_obj The object that holds the variable
 579  * \param psz_name The name of the variable
 580  */
 581 VLC_USED
 582 static inline bool var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
 583 {
 584     var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
 585                                    | VLC_VAR_ISCOMMAND );
 586     return var_GetBool( p_obj, psz_name );
 587 }
 588
 589 /**
 590  * Create a time command variable with inherit and get its value.
 591  *
 592  * \param p_obj The object that holds the variable
 593  * \param psz_name The name of the variable
 594  */
 595 VLC_USED
 596 static inline int64_t var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
 597 {
 598     var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
 599                                    | VLC_VAR_ISCOMMAND );
 600     return var_GetTime( p_obj, psz_name );
 601 }
 602
 603 /**
 604  * Create a float command variable with inherit and get its value.
 605  *
 606  * \param p_obj The object that holds the variable
 607  * \param psz_name The name of the variable
 608  */
 609 VLC_USED
 610 static inline float var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
 611 {
 612     var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
 613                                    | VLC_VAR_ISCOMMAND );
 614     return var_GetFloat( p_obj, psz_name );
 615 }
 616
 617 /**
 618  * Create a string command variable with inherit and get its value.
 619  *
 620  * \param p_obj The object that holds the variable
 621  * \param psz_name The name of the variable
 622  */
 623 VLC_USED VLC_MALLOC
 624 static inline char *var_CreateGetStringCommand( vlc_object_t *p_obj,
 625                                            const char *psz_name )
 626 {
 627     var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
 628                                    | VLC_VAR_ISCOMMAND );
 629     return var_GetString( p_obj, psz_name );
 630 }
 631
 632 VLC_USED VLC_MALLOC
 633 static inline char *var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
 634                                                    const char *psz_name )
 635 {
 636     var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
 637                                    | VLC_VAR_ISCOMMAND );
 638     return var_GetNonEmptyString( p_obj, psz_name );
 639 }
 640
 641 #define var_CreateGetIntegerCommand(a,b)   var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
 642 #define var_CreateGetBoolCommand(a,b)   var_CreateGetBoolCommand( VLC_OBJECT(a),b)
 643 #define var_CreateGetTimeCommand(a,b)   var_CreateGetTimeCommand( VLC_OBJECT(a),b)
 644 #define var_CreateGetFloatCommand(a,b)   var_CreateGetFloatCommand( VLC_OBJECT(a),b)
 645 #define var_CreateGetStringCommand(a,b)   var_CreateGetStringCommand( VLC_OBJECT(a),b)
 646 #define var_CreateGetNonEmptyStringCommand(a,b)   var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
 647
 648 VLC_USED
 649 static inline int var_CountChoices( vlc_object_t *p_obj, const char *psz_name )
 650 {
 651     vlc_value_t count;
 652     if( var_Change( p_obj, psz_name, VLC_VAR_CHOICESCOUNT, &count, NULL ) )
 653         return 0;
 654     return count.i_int;
 655 }
 656 #define var_CountChoices(a,b) var_CountChoices( VLC_OBJECT(a),b)
 657
 658
 659 static inline bool var_ToggleBool( vlc_object_t *p_obj, const char *psz_name )
 660 {
 661     vlc_value_t val;
 662     var_GetAndSet( p_obj, psz_name, VLC_VAR_BOOL_TOGGLE, &val );
 663     return val.b_bool;
 664 }
 665 #define var_ToggleBool(a,b) var_ToggleBool( VLC_OBJECT(a),b )
 666
 667
 668 VLC_USED
 669 static inline bool var_InheritBool( vlc_object_t *obj, const char *name )
 670 {
 671     vlc_value_t val;
 672
 673     if( var_Inherit( obj, name, VLC_VAR_BOOL, &val ) )
 674         val.b_bool = false;
 675     return val.b_bool;
 676 }
 677 #define var_InheritBool(o, n) var_InheritBool(VLC_OBJECT(o), n)
 678
 679 VLC_USED
 680 static inline int64_t var_InheritInteger( vlc_object_t *obj, const char *name )
 681 {
 682     vlc_value_t val;
 683
 684     if( var_Inherit( obj, name, VLC_VAR_INTEGER, &val ) )
 685         val.i_int = 0;
 686     return val.i_int;
 687 }
 688 #define var_InheritInteger(o, n) var_InheritInteger(VLC_OBJECT(o), n)
 689
 690 VLC_USED
 691 static inline float var_InheritFloat( vlc_object_t *obj, const char *name )
 692 {
 693     vlc_value_t val;
 694
 695     if( var_Inherit( obj, name, VLC_VAR_FLOAT, &val ) )
 696         val.f_float = 0.;
 697     return val.f_float;
 698 }
 699 #define var_InheritFloat(o, n) var_InheritFloat(VLC_OBJECT(o), n)
 700
 701 VLC_USED VLC_MALLOC
 702 static inline char *var_InheritString( vlc_object_t *obj, const char *name )
 703 {
 704     vlc_value_t val;
 705
 706     if( var_Inherit( obj, name, VLC_VAR_STRING, &val ) )
 707         val.psz_string = NULL;
 708     else if( val.psz_string && !*val.psz_string )
 709     {
 710         free( val.psz_string );
 711         val.psz_string = NULL;
 712     }
 713     return val.psz_string;
 714 }
 715 #define var_InheritString(o, n) var_InheritString(VLC_OBJECT(o), n)
 716
 717 VLC_USED
 718 static inline mtime_t var_InheritTime( vlc_object_t *obj, const char *name )
 719 {
 720     vlc_value_t val;
 721
 722     if( var_Inherit( obj, name, VLC_VAR_TIME, &val ) )
 723         val.i_time = 0;
 724     return val.i_time;
 725 }
 726 #define var_InheritTime(o, n) var_InheritTime(VLC_OBJECT(o), n)
 727
 728 VLC_USED
 729 static inline void *var_InheritAddress( vlc_object_t *obj, const char *name )
 730 {
 731     vlc_value_t val;
 732
 733     if( var_Inherit( obj, name, VLC_VAR_ADDRESS, &val ) )
 734         val.p_address = NULL;
 735     return val.p_address;
 736 }
 737 #define var_InheritAddress(o, n) var_InheritAddress(VLC_OBJECT(o), n)
 738
 739 VLC_API int var_InheritURational( vlc_object_t *, unsigned *num, unsigned *den, const char *var );
 740 #define var_InheritURational(a,b,c,d) var_InheritURational(VLC_OBJECT(a), b, c, d)
 741
 742 #define var_GetInteger(a,b)   var_GetInteger( VLC_OBJECT(a),b)
 743 #define var_GetBool(a,b)   var_GetBool( VLC_OBJECT(a),b)
 744 #define var_GetTime(a,b)   var_GetTime( VLC_OBJECT(a),b)
 745 #define var_GetFloat(a,b)   var_GetFloat( VLC_OBJECT(a),b)
 746 #define var_GetString(a,b)   var_GetString( VLC_OBJECT(a),b)
 747 #define var_GetNonEmptyString(a,b)   var_GetNonEmptyString( VLC_OBJECT(a),b)
 748 #define var_GetAddress(a,b)  var_GetAddress( VLC_OBJECT(a),b)
 749
 750 VLC_API int var_LocationParse(vlc_object_t *, const char *mrl, const char *prefix);
 751 #define var_LocationParse(o, m, p) var_LocationParse(VLC_OBJECT(o), m, p)
 752
 753 /**
 754  * @}
 755  */
 756 #endif /*  _VLC_VARIABLES_H */