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 /**
 121  * Toggle the value of this boolean
 122  * \param val Unused
 123  */
 124 #define VLC_VAR_TOGGLE_BOOL         0x0010
 125 /**
 126  * Increment or decrement an integer of a given value
 127  * \param val the value
 128  */
 129 #define VLC_VAR_INTEGER_INCDEC      0x0020
 130 /**@}*/
 131
 132 /*****************************************************************************
 133  * Prototypes
 134  *****************************************************************************/
 135 VLC_EXPORT( int, __var_Create, ( vlc_object_t *, const char *, int ) );
 136 VLC_EXPORT( int, __var_Destroy, ( vlc_object_t *, const char * ) );
 137
 138 VLC_EXPORT( int, __var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
 139
 140 VLC_EXPORT( int, __var_Type, ( vlc_object_t *, const char * ) LIBVLC_USED );
 141 VLC_EXPORT( int, __var_Set, ( vlc_object_t *, const char *, vlc_value_t ) );
 142 VLC_EXPORT( int, __var_Get, ( vlc_object_t *, const char *, vlc_value_t * ) );
 143 VLC_EXPORT( int, var_SetChecked, ( vlc_object_t *, const char *, int, vlc_value_t ) );
 144 VLC_EXPORT( int, var_GetChecked, ( vlc_object_t *, const char *, int, vlc_value_t * ) );
 145 VLC_EXPORT( int, __var_GetAndSet, ( vlc_object_t *, const char *, int, vlc_value_t ) );
 146 VLC_EXPORT( int, var_Inherit, ( vlc_object_t *, const char *, int, vlc_value_t * ) );
 147
 148 #define var_Command(a,b,c,d,e) __var_Command( VLC_OBJECT( a ), b, c, d, e )
 149 VLC_EXPORT( int, __var_Command, ( vlc_object_t *, const char *, const char *, const char *, char ** ) );
 150
 151 VLC_EXPORT( void, var_FreeList, ( vlc_value_t *, vlc_value_t * ) );
 152
 153 /**
 154  * __var_Create() with automatic casting.
 155  */
 156 #define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
 157 /**
 158  * __var_Destroy() with automatic casting
 159  */
 160 #define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
 161
 162 /**
 163  * __var_Change() with automatic casting
 164  */
 165 #define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
 166
 167 /**
 168  * __var_Type() with automatic casting
 169  */
 170 #define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
 171 /**
 172  * __var_Set() with automatic casting
 173  */
 174 #define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
 175 /**
 176  * __var_Get() with automatic casting
 177  */
 178 #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
 179 /**
 180  * __var_GetAndSet() with automatic casting
 181  */
 182 #define var_GetAndSet(a,b,c,d) __var_GetAndSet(VLC_OBJECT(a), b, c, d)
 183
 184 /*****************************************************************************
 185  * Variable callbacks
 186  *****************************************************************************
 187  * int MyCallback( vlc_object_t *p_this,
 188  *                 char const *psz_variable,
 189  *                 vlc_value_t oldvalue,
 190  *                 vlc_value_t newvalue,
 191  *                 void *p_data);
 192  *****************************************************************************/
 193 VLC_EXPORT( int, __var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
 194 VLC_EXPORT( int, __var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
 195 VLC_EXPORT( int, __var_TriggerCallback, ( vlc_object_t *, const char * ) );
 196
 197 /**
 198  * __var_AddCallback() with automatic casting
 199  */
 200 #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
 201 /**
 202  * __var_DelCallback() with automatic casting
 203  */
 204 #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
 205 /**
 206  * __var_TriggerCallback() with automatic casting
 207  */
 208 #define var_TriggerCallback(a,b) __var_TriggerCallback( VLC_OBJECT(a), b )
 209
 210 /*****************************************************************************
 211  * helpers functions
 212  *****************************************************************************/
 213
 214 /**
 215  * Set the value of an integer variable
 216  *
 217  * \param p_obj The object that holds the variable
 218  * \param psz_name The name of the variable
 219  * \param i The new integer value of this variable
 220  */
 221 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
 222 {
 223     vlc_value_t val;
 224     val.i_int = i;
 225     return var_SetChecked( p_obj, psz_name, VLC_VAR_INTEGER, val );
 226 }
 227
 228 /**
 229  * Set the value of an boolean variable
 230  *
 231  * \param p_obj The object that holds the variable
 232  * \param psz_name The name of the variable
 233  * \param b The new boolean value of this variable
 234  */
 235 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool b )
 236 {
 237     vlc_value_t val;
 238     val.b_bool = b;
 239     return var_SetChecked( p_obj, psz_name, VLC_VAR_BOOL, val );
 240 }
 241
 242 /**
 243  * Set the value of a time variable
 244  *
 245  * \param p_obj The object that holds the variable
 246  * \param psz_name The name of the variable
 247  * \param i The new time value of this variable
 248  */
 249 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
 250 {
 251     vlc_value_t val;
 252     val.i_time = i;
 253     return var_SetChecked( p_obj, psz_name, VLC_VAR_TIME, val );
 254 }
 255
 256 /**
 257  * Set the value of a float variable
 258  *
 259  * \param p_obj The object that holds the variable
 260  * \param psz_name The name of the variable
 261  * \param f The new float value of this variable
 262  */
 263 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
 264 {
 265     vlc_value_t val;
 266     val.f_float = f;
 267     return var_SetChecked( p_obj, psz_name, VLC_VAR_FLOAT, val );
 268 }
 269
 270 /**
 271  * Set the value of a string variable
 272  *
 273  * \param p_obj The object that holds the variable
 274  * \param psz_name The name of the variable
 275  * \param psz_string The new string value of this variable
 276  */
 277 static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
 278 {
 279     vlc_value_t val;
 280     val.psz_string = (char *)psz_string;
 281     return var_SetChecked( p_obj, psz_name, VLC_VAR_STRING, val );
 282 }
 283
 284 /**
 285  * Set the value of a pointer variable
 286  *
 287  * \param p_obj The object that holds the variable
 288  * \param psz_name The name of the variable
 289  * \param ptr The new pointer value of this variable
 290  */
 291 static inline
 292 int __var_SetAddress( vlc_object_t *p_obj, const char *psz_name, void *ptr )
 293 {
 294     vlc_value_t val;
 295     val.p_address = ptr;
 296     return var_SetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, val );
 297 }
 298
 299 /**
 300  * __var_SetInteger() with automatic casting
 301  */
 302 #define var_SetInteger(a,b,c)   __var_SetInteger( VLC_OBJECT(a),b,c)
 303 /**
 304  * __var_SetBool() with automatic casting
 305  */
 306 #define var_SetBool(a,b,c)      __var_SetBool( VLC_OBJECT(a),b,c)
 307 /**
 308  * __var_SetTime() with automatic casting
 309  */
 310 #define var_SetTime(a,b,c)      __var_SetTime( VLC_OBJECT(a),b,c)
 311 /**
 312  * __var_SetFloat() with automatic casting
 313  */
 314 #define var_SetFloat(a,b,c)     __var_SetFloat( VLC_OBJECT(a),b,c)
 315 /**
 316  * __var_SetString() with automatic casting
 317  */
 318 #define var_SetString(a,b,c)    __var_SetString( VLC_OBJECT(a),b,c)
 319 /**
 320  * __var_SetAddress() with automatic casting
 321  */
 322 #define var_SetAddress(o, n, p) __var_SetAddress(VLC_OBJECT(o), n, p)
 323
 324
 325 /**
 326  * Get an integer value
 327 *
 328  * \param p_obj The object that holds the variable
 329  * \param psz_name The name of the variable
 330  */
 331 LIBVLC_USED
 332 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
 333 {
 334     vlc_value_t val;
 335     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_INTEGER, &val ) )
 336         return val.i_int;
 337     else
 338         return 0;
 339 }
 340
 341 /**
 342  * Get a boolean value
 343  *
 344  * \param p_obj The object that holds the variable
 345  * \param psz_name The name of the variable
 346  */
 347 LIBVLC_USED
 348 static inline bool __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
 349 {
 350     vlc_value_t val; val.b_bool = false;
 351
 352     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_BOOL, &val ) )
 353         return val.b_bool;
 354     else
 355         return false;
 356 }
 357
 358 /**
 359  * Get a time value
 360  *
 361  * \param p_obj The object that holds the variable
 362  * \param psz_name The name of the variable
 363  */
 364 LIBVLC_USED
 365 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
 366 {
 367     vlc_value_t val; val.i_time = 0L;
 368     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_TIME, &val ) )
 369         return val.i_time;
 370     else
 371         return 0;
 372 }
 373
 374 /**
 375  * Get a float value
 376  *
 377  * \param p_obj The object that holds the variable
 378  * \param psz_name The name of the variable
 379  */
 380 LIBVLC_USED
 381 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
 382 {
 383     vlc_value_t val; val.f_float = 0.0;
 384     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_FLOAT, &val ) )
 385         return val.f_float;
 386     else
 387         return 0.0;
 388 }
 389
 390 /**
 391  * Get a string value
 392  *
 393  * \param p_obj The object that holds the variable
 394  * \param psz_name The name of the variable
 395  */
 396 LIBVLC_USED
 397 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
 398 {
 399     vlc_value_t val; val.psz_string = NULL;
 400     if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
 401         return NULL;
 402     else
 403         return val.psz_string;
 404 }
 405
 406 LIBVLC_USED
 407 static inline char *__var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
 408 {
 409     vlc_value_t val;
 410     if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
 411         return NULL;
 412     if( val.psz_string && *val.psz_string )
 413         return val.psz_string;
 414     free( val.psz_string );
 415     return NULL;
 416 }
 417
 418 LIBVLC_USED
 419 static inline void *__var_GetAddress( vlc_object_t *p_obj, const char *psz_name )
 420 {
 421     vlc_value_t val;
 422     if( var_GetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, &val ) )
 423         return NULL;
 424     else
 425         return val.p_address;
 426 }
 427
 428 /**
 429  * __var_GetInteger() with automatic casting
 430  */
 431 #define var_GetInteger(a,b)   __var_GetInteger( VLC_OBJECT(a),b)
 432 /**
 433  * __var_GetBool() with automatic casting
 434  */
 435 #define var_GetBool(a,b)   __var_GetBool( VLC_OBJECT(a),b)
 436 /**
 437  * __var_GetTime() with automatic casting
 438  */
 439 #define var_GetTime(a,b)   __var_GetTime( VLC_OBJECT(a),b)
 440 /**
 441  * __var_GetFloat() with automatic casting
 442  */
 443 #define var_GetFloat(a,b)   __var_GetFloat( VLC_OBJECT(a),b)
 444 /**
 445  * __var_GetString() with automatic casting
 446  */
 447 #define var_GetString(a,b)   __var_GetString( VLC_OBJECT(a),b)
 448 #define var_GetNonEmptyString(a,b)   __var_GetNonEmptyString( VLC_OBJECT(a),b)
 449 /**
 450  * __var_GetAddress() with automatic casting
 451  */
 452 #define var_GetAddress(a,b)  __var_GetAddress( VLC_OBJECT(a),b)
 453
 454
 455
 456 /**
 457  * Increment an integer variable
 458  * \param p_obj the object that holds the variable
 459  * \param psz_name the name of the variable
 460  */
 461 static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
 462 {
 463     vlc_value_t val;
 464     val.i_int = 1;
 465     __var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_INCDEC, val );
 466 }
 467 #define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
 468
 469 /**
 470  * Decrement an integer variable
 471  * \param p_obj the object that holds the variable
 472  * \param psz_name the name of the variable
 473  */
 474 static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
 475 {
 476     vlc_value_t val;
 477     val.i_int = -1;
 478     __var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_INCDEC, val );
 479 }
 480 #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
 481
 482 /**
 483  * Create a integer variable with inherit and get its value.
 484  *
 485  * \param p_obj The object that holds the variable
 486  * \param psz_name The name of the variable
 487  */
 488 LIBVLC_USED
 489 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
 490 {
 491     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
 492     return __var_GetInteger( p_obj, psz_name );
 493 }
 494
 495 /**
 496  * Create a boolean variable with inherit and get its value.
 497  *
 498  * \param p_obj The object that holds the variable
 499  * \param psz_name The name of the variable
 500  */
 501 LIBVLC_USED
 502 static inline bool __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
 503 {
 504     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
 505     return __var_GetBool( p_obj, psz_name );
 506 }
 507
 508 /**
 509  * Create a time variable with inherit and get its value.
 510  *
 511  * \param p_obj The object that holds the variable
 512  * \param psz_name The name of the variable
 513  */
 514 LIBVLC_USED
 515 static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
 516 {
 517     __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
 518     return __var_GetTime( p_obj, psz_name );
 519 }
 520
 521 /**
 522  * Create a float variable with inherit and get its value.
 523  *
 524  * \param p_obj The object that holds the variable
 525  * \param psz_name The name of the variable
 526  */
 527 LIBVLC_USED
 528 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
 529 {
 530     __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
 531     return __var_GetFloat( p_obj, psz_name );
 532 }
 533
 534 /**
 535  * Create a string variable with inherit and get its value.
 536  *
 537  * \param p_obj The object that holds the variable
 538  * \param psz_name The name of the variable
 539  */
 540 LIBVLC_USED
 541 static inline char *__var_CreateGetString( vlc_object_t *p_obj,
 542                                            const char *psz_name )
 543 {
 544     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 545     return __var_GetString( p_obj, psz_name );
 546 }
 547
 548 LIBVLC_USED
 549 static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
 550                                                    const char *psz_name )
 551 {
 552     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
 553     return __var_GetNonEmptyString( p_obj, psz_name );
 554 }
 555
 556 /**
 557  * Create an address variable with inherit and get its value.
 558  *
 559  * \param p_obj The object that holds the variable
 560  * \param psz_name The name of the variable
 561  */
 562 LIBVLC_USED
 563 static inline void *__var_CreateGetAddress( vlc_object_t *p_obj,
 564                                            const char *psz_name )
 565 {
 566     __var_Create( p_obj, psz_name, VLC_VAR_ADDRESS | VLC_VAR_DOINHERIT );
 567     return __var_GetAddress( p_obj, psz_name );
 568 }
 569
 570 /**
 571  * __var_CreateGetInteger() with automatic casting
 572  */
 573 #define var_CreateGetInteger(a,b)   __var_CreateGetInteger( VLC_OBJECT(a),b)
 574 /**
 575  * __var_CreateGetBool() with automatic casting
 576  */
 577 #define var_CreateGetBool(a,b)   __var_CreateGetBool( VLC_OBJECT(a),b)
 578 /**
 579  * __var_CreateGetTime() with automatic casting
 580  */
 581 #define var_CreateGetTime(a,b)   __var_CreateGetTime( VLC_OBJECT(a),b)
 582 /**
 583  * __var_CreateGetFloat() with automatic casting
 584  */
 585 #define var_CreateGetFloat(a,b)   __var_CreateGetFloat( VLC_OBJECT(a),b)
 586 /**
 587  * __var_CreateGetString() with automatic casting
 588  */
 589 #define var_CreateGetString(a,b)   __var_CreateGetString( VLC_OBJECT(a),b)
 590 #define var_CreateGetNonEmptyString(a,b)   __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
 591 /**
 592  * __var_CreateGetString() with automatic casting
 593  */
 594 #define var_CreateGetAddress(a,b)  __var_CreateGetAddress( VLC_OBJECT(a),b)
 595
 596 /**
 597  * Create a integer command variable with inherit and get its value.
 598  *
 599  * \param p_obj The object that holds the variable
 600  * \param psz_name The name of the variable
 601  */
 602 LIBVLC_USED
 603 static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
 604 {
 605     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
 606                                    | VLC_VAR_ISCOMMAND );
 607     return __var_GetInteger( p_obj, psz_name );
 608 }
 609
 610 /**
 611  * Create a boolean command variable with inherit and get its value.
 612  *
 613  * \param p_obj The object that holds the variable
 614  * \param psz_name The name of the variable
 615  */
 616 LIBVLC_USED
 617 static inline bool __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
 618 {
 619     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
 620                                    | VLC_VAR_ISCOMMAND );
 621     return __var_GetBool( p_obj, psz_name );
 622 }
 623
 624 /**
 625  * Create a time command variable with inherit and get its value.
 626  *
 627  * \param p_obj The object that holds the variable
 628  * \param psz_name The name of the variable
 629  */
 630 LIBVLC_USED
 631 static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
 632 {
 633     __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
 634                                    | VLC_VAR_ISCOMMAND );
 635     return __var_GetTime( p_obj, psz_name );
 636 }
 637
 638 /**
 639  * Create a float command variable with inherit and get its value.
 640  *
 641  * \param p_obj The object that holds the variable
 642  * \param psz_name The name of the variable
 643  */
 644 LIBVLC_USED
 645 static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
 646 {
 647     __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
 648                                    | VLC_VAR_ISCOMMAND );
 649     return __var_GetFloat( p_obj, psz_name );
 650 }
 651
 652 /**
 653  * Create a string command variable with inherit and get its value.
 654  *
 655  * \param p_obj The object that holds the variable
 656  * \param psz_name The name of the variable
 657  */
 658 LIBVLC_USED
 659 static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
 660                                            const char *psz_name )
 661 {
 662     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
 663                                    | VLC_VAR_ISCOMMAND );
 664     return __var_GetString( p_obj, psz_name );
 665 }
 666
 667 LIBVLC_USED
 668 static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
 669                                                    const char *psz_name )
 670 {
 671     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
 672                                    | VLC_VAR_ISCOMMAND );
 673     return __var_GetNonEmptyString( p_obj, psz_name );
 674 }
 675
 676 /**
 677  * __var_CreateGetInteger() with automatic casting
 678  */
 679 #define var_CreateGetIntegerCommand(a,b)   __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
 680 /**
 681  * __var_CreateGetBoolCommand() with automatic casting
 682  */
 683 #define var_CreateGetBoolCommand(a,b)   __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
 684 /**
 685  * __var_CreateGetTimeCommand() with automatic casting
 686  */
 687 #define var_CreateGetTimeCommand(a,b)   __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
 688 /**
 689  * __var_CreateGetFloat() with automatic casting
 690  */
 691 #define var_CreateGetFloatCommand(a,b)   __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
 692 /**
 693  * __var_CreateGetStringCommand() with automatic casting
 694  */
 695 #define var_CreateGetStringCommand(a,b)   __var_CreateGetStringCommand( VLC_OBJECT(a),b)
 696 #define var_CreateGetNonEmptyStringCommand(a,b)   __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
 697
 698 LIBVLC_USED
 699 static inline int __var_CountChoices( vlc_object_t *p_obj, const char *psz_name )
 700 {
 701     vlc_value_t count;
 702     if( __var_Change( p_obj, psz_name, VLC_VAR_CHOICESCOUNT, &count, NULL ) )
 703         return 0;
 704     return count.i_int;
 705 }
 706 /**
 707  * __var_CountChoices() with automatic casting
 708  */
 709 #define var_CountChoices(a,b) __var_CountChoices( VLC_OBJECT(a),b)
 710
 711
 712 static inline int __var_ToggleBool( vlc_object_t *p_obj, const char *psz_name )
 713 {
 714     vlc_value_t val;
 715     return __var_GetAndSet( p_obj, psz_name, VLC_VAR_TOGGLE_BOOL, val );
 716 }
 717 /**
 718  * __var_ToggleBool() with automatic casting
 719  */
 720 #define var_ToggleBool(a,b) __var_ToggleBool( VLC_OBJECT(a),b )
 721
 722 LIBVLC_USED
 723 static inline int var_InheritInteger( vlc_object_t *obj, const char *name )
 724 {
 725     vlc_value_t val;
 726
 727     if( var_Inherit( obj, name, VLC_VAR_INTEGER, &val ) )
 728         val.i_int = 0;
 729     return val.i_int;
 730 }
 731 #define var_InheritInteger(o, n) var_InheritInteger(VLC_OBJECT(o), n)
 732
 733 LIBVLC_USED
 734 static inline float var_InheritFloat( vlc_object_t *obj, const char *name )
 735 {
 736     vlc_value_t val;
 737
 738     if( var_Inherit( obj, name, VLC_VAR_FLOAT, &val ) )
 739         val.f_float = 0.;
 740     return val.f_float;
 741 }
 742 #define var_InheritFloat(o, n) var_InheritFloat(VLC_OBJECT(o), n)
 743
 744 LIBVLC_USED LIBVLC_MALLOC
 745 static inline char *var_InheritString( vlc_object_t *obj, const char *name )
 746 {
 747     vlc_value_t val;
 748
 749     if( var_Inherit( obj, name, VLC_VAR_STRING, &val ) )
 750         val.psz_string = NULL;
 751     else if( val.psz_string && !*val.psz_string )
 752     {
 753         free( val.psz_string );
 754         val.psz_string = NULL;
 755     }
 756     return val.psz_string;
 757 }
 758 #define var_InheritString(o, n) var_InheritString(VLC_OBJECT(o), n)
 759
 760 static inline mtime_t var_InheritTime( vlc_object_t *obj, const char *name )
 761 {
 762     vlc_value_t val;
 763
 764     if( var_Inherit( obj, name, VLC_VAR_TIME, &val ) )
 765         val.i_time = 0;
 766     return val.i_time;
 767 }
 768 #define var_InheritTime(o, n) var_InheritTime(VLC_OBJECT(o), n)
 769
 770 /**
 771  * @}
 772  */
 773 #endif /*  _VLC_VARIABLES_H */