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