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

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