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