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
30 * This file defines functions and structures for dynamic variables in vlc
34 * \defgroup variables Variables
36 * Functions for using the object variables in vlc.
38 * Vlc have a very powerful "object variable" infrastructure useful
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
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
56 #define VLC_VAR_HASCHOICE 0x0100
57 #define VLC_VAR_HASMIN 0x0200
58 #define VLC_VAR_HASMAX 0x0400
59 #define VLC_VAR_HASSTEP 0x0800
61 #define VLC_VAR_ISCOMMAND 0x2000
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
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_CHOICESCOUNT 0x0027
114 #define VLC_VAR_INHERITVALUE 0x0030
116 #define VLC_VAR_SETISCOMMAND 0x0040
119 /*****************************************************************************
121 *****************************************************************************/
122 VLC_EXPORT( int, __var_Create, ( vlc_object_t *, const char *, int ) );
123 VLC_EXPORT( int, __var_Destroy, ( vlc_object_t *, const char * ) );
125 VLC_EXPORT( int, __var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
127 VLC_EXPORT( int, __var_Type, ( vlc_object_t *, const char * ) LIBVLC_USED );
128 VLC_EXPORT( int, __var_Set, ( vlc_object_t *, const char *, vlc_value_t ) );
129 VLC_EXPORT( int, __var_Get, ( vlc_object_t *, const char *, vlc_value_t * ) );
130 VLC_EXPORT( int, var_SetChecked, ( vlc_object_t *, const char *, int, vlc_value_t ) );
131 VLC_EXPORT( int, var_GetChecked, ( vlc_object_t *, const char *, int, 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 ** ) );
136 VLC_EXPORT( void, var_FreeList, ( vlc_value_t *, vlc_value_t * ) );
139 * __var_Create() with automatic casting.
141 #define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
143 * __var_Destroy() with automatic casting
145 #define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
148 * __var_Change() with automatic casting
150 #define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
153 * __var_Type() with automatic casting
155 #define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
157 * __var_Set() with automatic casting
159 #define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
161 * __var_Get() with automatic casting
163 #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
165 /*****************************************************************************
167 *****************************************************************************
168 * int MyCallback( vlc_object_t *p_this,
169 * char const *psz_variable,
170 * vlc_value_t oldvalue,
171 * vlc_value_t newvalue,
173 *****************************************************************************/
174 VLC_EXPORT( int, __var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
175 VLC_EXPORT( int, __var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
176 VLC_EXPORT( int, __var_TriggerCallback, ( vlc_object_t *, const char * ) );
179 * __var_AddCallback() with automatic casting
181 #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
183 * __var_DelCallback() with automatic casting
185 #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 * Set the value of an integer variable
198 * \param p_obj The object that holds the variable
199 * \param psz_name The name of the variable
200 * \param i The new integer value of this variable
202 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
206 return var_SetChecked( p_obj, psz_name, VLC_VAR_INTEGER, val );
210 * Set the value of an boolean variable
212 * \param p_obj The object that holds the variable
213 * \param psz_name The name of the variable
214 * \param b The new boolean value of this variable
216 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool b )
220 return var_SetChecked( p_obj, psz_name, VLC_VAR_BOOL, val );
224 * Set the value of a time variable
226 * \param p_obj The object that holds the variable
227 * \param psz_name The name of the variable
228 * \param i The new time value of this variable
230 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
234 return var_SetChecked( p_obj, psz_name, VLC_VAR_TIME, val );
238 * Set the value of a float variable
240 * \param p_obj The object that holds the variable
241 * \param psz_name The name of the variable
242 * \param f The new float value of this variable
244 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
248 return var_SetChecked( p_obj, psz_name, VLC_VAR_FLOAT, val );
252 * Set the value of a string variable
254 * \param p_obj The object that holds the variable
255 * \param psz_name The name of the variable
256 * \param psz_string The new string value of this variable
258 static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
261 val.psz_string = (char *)psz_string;
262 return var_SetChecked( p_obj, psz_name, VLC_VAR_STRING, val );
266 * Trigger the callbacks on a void variable
268 * \param p_obj The object that holds the variable
269 * \param psz_name The name of the variable
271 static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
275 return var_SetChecked( p_obj, psz_name, VLC_VAR_VOID, val );
279 * Set the value of a pointer variable
281 * \param p_obj The object that holds the variable
282 * \param psz_name The name of the variable
283 * \param ptr The new pointer value of this variable
286 int __var_SetAddress( vlc_object_t *p_obj, const char *psz_name, void *ptr )
290 return var_SetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, val );
294 * __var_SetInteger() with automatic casting
296 #define var_SetInteger(a,b,c) __var_SetInteger( VLC_OBJECT(a),b,c)
298 * __var_SetBool() with automatic casting
300 #define var_SetBool(a,b,c) __var_SetBool( VLC_OBJECT(a),b,c)
302 * __var_SetTime() with automatic casting
304 #define var_SetTime(a,b,c) __var_SetTime( VLC_OBJECT(a),b,c)
306 * __var_SetFloat() with automatic casting
308 #define var_SetFloat(a,b,c) __var_SetFloat( VLC_OBJECT(a),b,c)
310 * __var_SetString() with automatic casting
312 #define var_SetString(a,b,c) __var_SetString( VLC_OBJECT(a),b,c)
314 * __var_SetVoid() with automatic casting
316 #define var_SetVoid(a,b) __var_SetVoid( VLC_OBJECT(a),b)
318 * __var_SetAddress() with automatic casting
320 #define var_SetAddress(o, n, p) __var_SetAddress(VLC_OBJECT(o), n, p)
324 * Get an integer value
326 * \param p_obj The object that holds the variable
327 * \param psz_name The name of the variable
330 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
333 if( !var_GetChecked( p_obj, psz_name, VLC_VAR_INTEGER, &val ) )
340 * Get a boolean value
342 * \param p_obj The object that holds the variable
343 * \param psz_name The name of the variable
346 static inline bool __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
348 vlc_value_t val; val.b_bool = false;
350 if( !var_GetChecked( p_obj, psz_name, VLC_VAR_BOOL, &val ) )
359 * \param p_obj The object that holds the variable
360 * \param psz_name The name of the variable
363 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
365 vlc_value_t val; val.i_time = 0L;
366 if( !var_GetChecked( p_obj, psz_name, VLC_VAR_TIME, &val ) )
375 * \param p_obj The object that holds the variable
376 * \param psz_name The name of the variable
379 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
381 vlc_value_t val; val.f_float = 0.0;
382 if( !var_GetChecked( p_obj, psz_name, VLC_VAR_FLOAT, &val ) )
391 * \param p_obj The object that holds the variable
392 * \param psz_name The name of the variable
395 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
397 vlc_value_t val; val.psz_string = NULL;
398 if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
401 return val.psz_string;
405 static inline char *__var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
408 if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
410 if( val.psz_string && *val.psz_string )
411 return val.psz_string;
412 free( val.psz_string );
418 * __var_GetInteger() with automatic casting
420 #define var_GetInteger(a,b) __var_GetInteger( VLC_OBJECT(a),b)
422 * __var_GetBool() with automatic casting
424 #define var_GetBool(a,b) __var_GetBool( VLC_OBJECT(a),b)
426 * __var_GetTime() with automatic casting
428 #define var_GetTime(a,b) __var_GetTime( VLC_OBJECT(a),b)
430 * __var_GetFloat() with automatic casting
432 #define var_GetFloat(a,b) __var_GetFloat( VLC_OBJECT(a),b)
434 * __var_GetString() with automatic casting
436 #define var_GetString(a,b) __var_GetString( VLC_OBJECT(a),b)
437 #define var_GetNonEmptyString(a,b) __var_GetNonEmptyString( VLC_OBJECT(a),b)
442 * Increment an integer variable
443 * \param p_obj the object that holds the variable
444 * \param psz_name the name of the variable
446 static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
448 int i_val = __var_GetInteger( p_obj, psz_name );
449 __var_SetInteger( p_obj, psz_name, ++i_val );
451 #define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
454 * Decrement an integer variable
455 * \param p_obj the object that holds the variable
456 * \param psz_name the name of the variable
458 static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
460 int i_val = __var_GetInteger( p_obj, psz_name );
461 __var_SetInteger( p_obj, psz_name, --i_val );
463 #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
466 * Create a integer variable with inherit and get its value.
468 * \param p_obj The object that holds the variable
469 * \param psz_name The name of the variable
472 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
474 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
475 return __var_GetInteger( p_obj, psz_name );
479 * Create a boolean variable with inherit and get its value.
481 * \param p_obj The object that holds the variable
482 * \param psz_name The name of the variable
485 static inline bool __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
487 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
488 return __var_GetBool( p_obj, psz_name );
492 * Create a time variable with inherit and get its value.
494 * \param p_obj The object that holds the variable
495 * \param psz_name The name of the variable
498 static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
500 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
501 return __var_GetTime( p_obj, psz_name );
505 * Create a float variable with inherit and get its value.
507 * \param p_obj The object that holds the variable
508 * \param psz_name The name of the variable
511 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
513 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
514 return __var_GetFloat( p_obj, psz_name );
518 * Create a string variable with inherit and get its value.
520 * \param p_obj The object that holds the variable
521 * \param psz_name The name of the variable
524 static inline char *__var_CreateGetString( vlc_object_t *p_obj,
525 const char *psz_name )
527 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
528 return __var_GetString( p_obj, psz_name );
532 static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
533 const char *psz_name )
535 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
536 return __var_GetNonEmptyString( p_obj, psz_name );
540 * __var_CreateGetInteger() with automatic casting
542 #define var_CreateGetInteger(a,b) __var_CreateGetInteger( VLC_OBJECT(a),b)
544 * __var_CreateGetBool() with automatic casting
546 #define var_CreateGetBool(a,b) __var_CreateGetBool( VLC_OBJECT(a),b)
548 * __var_CreateGetTime() with automatic casting
550 #define var_CreateGetTime(a,b) __var_CreateGetTime( VLC_OBJECT(a),b)
552 * __var_CreateGetFloat() with automatic casting
554 #define var_CreateGetFloat(a,b) __var_CreateGetFloat( VLC_OBJECT(a),b)
556 * __var_CreateGetString() with automatic casting
558 #define var_CreateGetString(a,b) __var_CreateGetString( VLC_OBJECT(a),b)
559 #define var_CreateGetNonEmptyString(a,b) __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
562 * Create a integer command variable with inherit and get its value.
564 * \param p_obj The object that holds the variable
565 * \param psz_name The name of the variable
568 static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
570 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
571 | VLC_VAR_ISCOMMAND );
572 return __var_GetInteger( p_obj, psz_name );
576 * Create a boolean command variable with inherit and get its value.
578 * \param p_obj The object that holds the variable
579 * \param psz_name The name of the variable
582 static inline bool __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
584 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
585 | VLC_VAR_ISCOMMAND );
586 return __var_GetBool( p_obj, psz_name );
590 * Create a time command variable with inherit and get its value.
592 * \param p_obj The object that holds the variable
593 * \param psz_name The name of the variable
596 static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
598 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
599 | VLC_VAR_ISCOMMAND );
600 return __var_GetTime( p_obj, psz_name );
604 * Create a float command variable with inherit and get its value.
606 * \param p_obj The object that holds the variable
607 * \param psz_name The name of the variable
610 static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
612 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
613 | VLC_VAR_ISCOMMAND );
614 return __var_GetFloat( p_obj, psz_name );
618 * Create a string command variable with inherit and get its value.
620 * \param p_obj The object that holds the variable
621 * \param psz_name The name of the variable
624 static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
625 const char *psz_name )
627 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
628 | VLC_VAR_ISCOMMAND );
629 return __var_GetString( p_obj, psz_name );
633 static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
634 const char *psz_name )
636 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
637 | VLC_VAR_ISCOMMAND );
638 return __var_GetNonEmptyString( p_obj, psz_name );
642 * __var_CreateGetInteger() with automatic casting
644 #define var_CreateGetIntegerCommand(a,b) __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
646 * __var_CreateGetBoolCommand() with automatic casting
648 #define var_CreateGetBoolCommand(a,b) __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
650 * __var_CreateGetTimeCommand() with automatic casting
652 #define var_CreateGetTimeCommand(a,b) __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
654 * __var_CreateGetFloat() with automatic casting
656 #define var_CreateGetFloatCommand(a,b) __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
658 * __var_CreateGetStringCommand() with automatic casting
660 #define var_CreateGetStringCommand(a,b) __var_CreateGetStringCommand( VLC_OBJECT(a),b)
661 #define var_CreateGetNonEmptyStringCommand(a,b) __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
663 static inline int __var_CountChoices( vlc_object_t *p_obj, const char *psz_name )
666 if( __var_Change( p_obj, psz_name, VLC_VAR_CHOICESCOUNT, &count, NULL ) )
671 * __var_CountChoices() with automatic casting
673 #define var_CountChoices(a,b) __var_CountChoices( VLC_OBJECT(a),b)
678 #endif /* _VLC_VARIABLES_H */