1 /*****************************************************************************
2 * variables.h: variables handling
3 *****************************************************************************
4 * Copyright (C) 2002-2004 the VideoLAN team
7 * Authors: Samuel Hocevar <sam@zoy.org>
8 * Gildas Bazin <gbazin@netcourrier.com>
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.
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.
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 *****************************************************************************/
25 #ifndef VLC_VARIABLES_H
26 #define VLC_VARIABLES_H 1
32 * This file defines functions and structures for dynamic variables in vlc
36 * \defgroup variables Variables
38 * Functions for using the object variables in vlc.
40 * Vlc have a very powerful "object variable" infrastructure useful
46 /*****************************************************************************
47 * Variable types - probably very incomplete
48 *****************************************************************************/
49 #define VLC_VAR_TYPE 0x00ff
50 #define VLC_VAR_CLASS 0x00f0
51 #define VLC_VAR_FLAGS 0xff00
53 /** \defgroup var_flags Additive flags
54 * These flags are added to the type field of the variable. Most as a result of
55 * a __var_Change() call, but some may be added at creation time
58 #define VLC_VAR_HASCHOICE 0x0100
59 #define VLC_VAR_HASMIN 0x0200
60 #define VLC_VAR_HASMAX 0x0400
61 #define VLC_VAR_HASSTEP 0x0800
63 #define VLC_VAR_ISCOMMAND 0x2000
66 #define VLC_VAR_DOINHERIT 0x8000
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.
78 * Set the minimum value of this variable
79 * \param p_val The new minimum value
80 * \param p_val2 Unused
82 #define VLC_VAR_SETMIN 0x0010
84 * Set the maximum value of this variable
85 * \param p_val The new maximum value
86 * \param p_val2 Unused
88 #define VLC_VAR_SETMAX 0x0011
89 #define VLC_VAR_SETSTEP 0x0012
92 * Set the value of this variable without triggering any callbacks
93 * \param p_val The new value
94 * \param p_val2 Unused
96 #define VLC_VAR_SETVALUE 0x0013
98 #define VLC_VAR_SETTEXT 0x0014
99 #define VLC_VAR_GETTEXT 0x0015
101 #define VLC_VAR_GETMIN 0x0016
102 #define VLC_VAR_GETMAX 0x0017
103 #define VLC_VAR_GETSTEP 0x0018
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_FREECHOICES 0x0025
111 #define VLC_VAR_GETLIST 0x0026
112 #define VLC_VAR_FREELIST 0x0027
113 #define VLC_VAR_CHOICESCOUNT 0x0028
115 #define VLC_VAR_INHERITVALUE 0x0030
116 #define VLC_VAR_TRIGGER_CALLBACKS 0x0035
118 #define VLC_VAR_SETISCOMMAND 0x0040
121 /*****************************************************************************
123 *****************************************************************************/
124 VLC_EXPORT( int, __var_Create, ( vlc_object_t *, const char *, int ) );
125 VLC_EXPORT( int, __var_Destroy, ( vlc_object_t *, const char * ) );
127 VLC_EXPORT( int, __var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
129 VLC_EXPORT( int, __var_Type, ( vlc_object_t *, const char * ) LIBVLC_USED );
130 VLC_EXPORT( int, __var_Set, ( vlc_object_t *, const char *, vlc_value_t ) );
131 VLC_EXPORT( int, __var_Get, ( vlc_object_t *, const char *, vlc_value_t * ) );
133 #define var_Command(a,b,c,d,e) __var_Command( VLC_OBJECT( a ), b, c, d, e )
134 VLC_EXPORT( int, __var_Command, ( vlc_object_t *, const char *, const char *, const char *, char ** ) );
137 * __var_Create() with automatic casting.
139 #define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
141 * __var_Destroy() with automatic casting
143 #define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
146 * __var_Change() with automatic casting
148 #define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
151 * __var_Type() with automatic casting
153 #define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
155 * __var_Set() with automatic casting
157 #define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
159 * __var_Get() with automatic casting
161 #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
163 /*****************************************************************************
165 *****************************************************************************
166 * int MyCallback( vlc_object_t *p_this,
167 * char const *psz_variable,
168 * vlc_value_t oldvalue,
169 * vlc_value_t newvalue,
171 *****************************************************************************/
172 VLC_EXPORT( int, __var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
173 VLC_EXPORT( int, __var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
174 VLC_EXPORT( int, __var_TriggerCallback, ( vlc_object_t *, const char * ) );
177 * __var_AddCallback() with automatic casting
179 #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
182 * __var_DelCallback() with automatic casting
184 #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
187 * __var_TriggerCallback() with automatic casting
189 #define var_TriggerCallback(a,b) __var_TriggerCallback( VLC_OBJECT(a), b )
191 /*****************************************************************************
193 *****************************************************************************/
196 * This function assert the variable is of the expected type or it
199 static inline void __var_AssertType( vlc_object_t *p_obj, const char *psz_name,
203 const int i_type = __var_Type( p_obj, psz_name ) & VLC_VAR_CLASS;
204 assert( i_type == 0 || i_type == (i_expected&VLC_VAR_CLASS) );
206 (void)p_obj; (void)psz_name; (void)i_expected;
211 * Set the value of an integer variable
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
217 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
221 __var_AssertType( p_obj, psz_name, VLC_VAR_INTEGER );
222 return __var_Set( p_obj, psz_name, val );
224 #define var_SetInteger(a,b,c) __var_SetInteger( VLC_OBJECT(a),b,c)
226 * Set the value of an boolean variable
228 * \param p_obj The object that holds the variable
229 * \param psz_name The name of the variable
230 * \param b The new boolean value of this variable
232 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool b )
236 __var_AssertType( p_obj, psz_name, VLC_VAR_BOOL );
237 return __var_Set( p_obj, psz_name, val );
241 * Set the value of a time variable
243 * \param p_obj The object that holds the variable
244 * \param psz_name The name of the variable
245 * \param i The new time value of this variable
247 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
251 __var_AssertType( p_obj, psz_name, VLC_VAR_TIME );
252 return __var_Set( p_obj, psz_name, val );
256 * Set the value of a float variable
258 * \param p_obj The object that holds the variable
259 * \param psz_name The name of the variable
260 * \param f The new float value of this variable
262 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
266 __var_AssertType( p_obj, psz_name, VLC_VAR_FLOAT );
267 return __var_Set( p_obj, psz_name, val );
271 * Set the value of a string variable
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
277 static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
280 val.psz_string = (char *)psz_string;
281 __var_AssertType( p_obj, psz_name, VLC_VAR_STRING );
282 return __var_Set( p_obj, psz_name, val );
286 * Trigger the callbacks on a void variable
288 * \param p_obj The object that holds the variable
289 * \param psz_name The name of the variable
291 static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
295 __var_AssertType( p_obj, psz_name, VLC_VAR_VOID );
296 return __var_Set( p_obj, psz_name, val );
298 #define var_SetVoid(a,b) __var_SetVoid( VLC_OBJECT(a),b)
301 * __var_SetBool() with automatic casting
303 #define var_SetBool(a,b,c) __var_SetBool( VLC_OBJECT(a),b,c)
306 * __var_SetTime() with automatic casting
308 #define var_SetTime(a,b,c) __var_SetTime( VLC_OBJECT(a),b,c)
310 * __var_SetFloat() with automatic casting
312 #define var_SetFloat(a,b,c) __var_SetFloat( VLC_OBJECT(a),b,c)
314 * __var_SetString() with automatic casting
316 #define var_SetString(a,b,c) __var_SetString( VLC_OBJECT(a),b,c)
319 * Get an integer value
321 * \param p_obj The object that holds the variable
322 * \param psz_name The name of the variable
325 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
327 vlc_value_t val;val.i_int = 0;
328 __var_AssertType( p_obj, psz_name, VLC_VAR_INTEGER );
329 if( !__var_Get( p_obj, psz_name, &val ) )
336 * Get a boolean value
338 * \param p_obj The object that holds the variable
339 * \param psz_name The name of the variable
342 static inline int __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
344 vlc_value_t val; val.b_bool = false;
346 __var_AssertType( p_obj, psz_name, VLC_VAR_BOOL );
347 if( !__var_Get( p_obj, psz_name, &val ) )
356 * \param p_obj The object that holds the variable
357 * \param psz_name The name of the variable
360 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
362 vlc_value_t val; val.i_time = 0L;
363 __var_AssertType( p_obj, psz_name, VLC_VAR_TIME );
364 if( !__var_Get( p_obj, psz_name, &val ) )
373 * \param p_obj The object that holds the variable
374 * \param psz_name The name of the variable
377 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
379 vlc_value_t val; val.f_float = 0.0;
380 __var_AssertType( p_obj, psz_name, VLC_VAR_FLOAT );
381 if( !__var_Get( p_obj, psz_name, &val ) )
390 * \param p_obj The object that holds the variable
391 * \param psz_name The name of the variable
394 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
396 vlc_value_t val; val.psz_string = NULL;
397 __var_AssertType( p_obj, psz_name, VLC_VAR_STRING );
398 if( __var_Get( p_obj, psz_name, &val ) )
401 return val.psz_string;
405 static inline char *__var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
408 __var_AssertType( p_obj, psz_name, VLC_VAR_STRING );
409 if( __var_Get( p_obj, psz_name, &val ) )
411 if( *val.psz_string )
412 return val.psz_string;
413 free( val.psz_string );
419 * __var_GetInteger() with automatic casting
421 #define var_GetInteger(a,b) __var_GetInteger( VLC_OBJECT(a),b)
423 * __var_GetBool() with automatic casting
425 #define var_GetBool(a,b) __var_GetBool( VLC_OBJECT(a),b)
427 * __var_GetTime() with automatic casting
429 #define var_GetTime(a,b) __var_GetTime( VLC_OBJECT(a),b)
431 * __var_GetFloat() with automatic casting
433 #define var_GetFloat(a,b) __var_GetFloat( VLC_OBJECT(a),b)
435 * __var_GetString() with automatic casting
437 #define var_GetString(a,b) __var_GetString( VLC_OBJECT(a),b)
438 #define var_GetNonEmptyString(a,b) __var_GetNonEmptyString( VLC_OBJECT(a),b)
443 * Increment an integer variable
444 * \param p_obj the object that holds the variable
445 * \param psz_name the name of the variable
447 static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
449 int i_val = __var_GetInteger( p_obj, psz_name );
450 __var_SetInteger( p_obj, psz_name, ++i_val );
452 #define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
455 * Decrement an integer variable
456 * \param p_obj the object that holds the variable
457 * \param psz_name the name of the variable
459 static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
461 int i_val = __var_GetInteger( p_obj, psz_name );
462 __var_SetInteger( p_obj, psz_name, --i_val );
464 #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
467 * Create a integer variable with inherit and get its value.
469 * \param p_obj The object that holds the variable
470 * \param psz_name The name of the variable
473 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
475 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
476 return __var_GetInteger( p_obj, psz_name );
480 * Create a boolean variable with inherit and get its value.
482 * \param p_obj The object that holds the variable
483 * \param psz_name The name of the variable
486 static inline int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
488 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
489 return __var_GetBool( p_obj, psz_name );
493 * Create a time variable with inherit and get its value.
495 * \param p_obj The object that holds the variable
496 * \param psz_name The name of the variable
499 static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
501 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
502 return __var_GetTime( p_obj, psz_name );
506 * Create a float variable with inherit and get its value.
508 * \param p_obj The object that holds the variable
509 * \param psz_name The name of the variable
512 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
514 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
515 return __var_GetFloat( p_obj, psz_name );
519 * Create a string variable with inherit and get its value.
521 * \param p_obj The object that holds the variable
522 * \param psz_name The name of the variable
525 static inline char *__var_CreateGetString( vlc_object_t *p_obj,
526 const char *psz_name )
528 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
529 return __var_GetString( p_obj, psz_name );
533 static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
534 const char *psz_name )
536 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
537 return __var_GetNonEmptyString( p_obj, psz_name );
541 * __var_CreateGetInteger() with automatic casting
543 #define var_CreateGetInteger(a,b) __var_CreateGetInteger( VLC_OBJECT(a),b)
545 * __var_CreateGetBool() with automatic casting
547 #define var_CreateGetBool(a,b) __var_CreateGetBool( VLC_OBJECT(a),b)
549 * __var_CreateGetTime() with automatic casting
551 #define var_CreateGetTime(a,b) __var_CreateGetTime( VLC_OBJECT(a),b)
553 * __var_CreateGetFloat() with automatic casting
555 #define var_CreateGetFloat(a,b) __var_CreateGetFloat( VLC_OBJECT(a),b)
557 * __var_CreateGetString() with automatic casting
559 #define var_CreateGetString(a,b) __var_CreateGetString( VLC_OBJECT(a),b)
560 #define var_CreateGetNonEmptyString(a,b) __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
563 * Create a integer command variable with inherit and get its value.
565 * \param p_obj The object that holds the variable
566 * \param psz_name The name of the variable
569 static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
571 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
572 | VLC_VAR_ISCOMMAND );
573 return __var_GetInteger( p_obj, psz_name );
577 * Create a boolean command variable with inherit and get its value.
579 * \param p_obj The object that holds the variable
580 * \param psz_name The name of the variable
583 static inline int __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
585 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
586 | VLC_VAR_ISCOMMAND );
587 return __var_GetBool( p_obj, psz_name );
591 * Create a time command variable with inherit and get its value.
593 * \param p_obj The object that holds the variable
594 * \param psz_name The name of the variable
597 static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
599 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
600 | VLC_VAR_ISCOMMAND );
601 return __var_GetTime( p_obj, psz_name );
605 * Create a float command variable with inherit and get its value.
607 * \param p_obj The object that holds the variable
608 * \param psz_name The name of the variable
611 static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
613 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
614 | VLC_VAR_ISCOMMAND );
615 return __var_GetFloat( p_obj, psz_name );
619 * Create a string command variable with inherit and get its value.
621 * \param p_obj The object that holds the variable
622 * \param psz_name The name of the variable
625 static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
626 const char *psz_name )
628 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
629 | VLC_VAR_ISCOMMAND );
630 return __var_GetString( p_obj, psz_name );
634 static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
635 const char *psz_name )
637 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
638 | VLC_VAR_ISCOMMAND );
639 return __var_GetNonEmptyString( p_obj, psz_name );
643 * __var_CreateGetInteger() with automatic casting
645 #define var_CreateGetIntegerCommand(a,b) __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
647 * __var_CreateGetBoolCommand() with automatic casting
649 #define var_CreateGetBoolCommand(a,b) __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
651 * __var_CreateGetTimeCommand() with automatic casting
653 #define var_CreateGetTimeCommand(a,b) __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
655 * __var_CreateGetFloat() with automatic casting
657 #define var_CreateGetFloatCommand(a,b) __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
659 * __var_CreateGetStringCommand() with automatic casting
661 #define var_CreateGetStringCommand(a,b) __var_CreateGetStringCommand( VLC_OBJECT(a),b)
662 #define var_CreateGetNonEmptyStringCommand(a,b) __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
666 #endif /* _VLC_VARIABLES_H */