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 )
184 * __var_DelCallback() with automatic casting
186 #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
189 * __var_TriggerCallback() with automatic casting
191 #define var_TriggerCallback(a,b) __var_TriggerCallback( VLC_OBJECT(a), b )
193 /*****************************************************************************
195 *****************************************************************************/
198 * Set the value of an integer variable
200 * \param p_obj The object that holds the variable
201 * \param psz_name The name of the variable
202 * \param i The new integer value of this variable
204 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
208 return var_SetChecked( p_obj, psz_name, VLC_VAR_INTEGER, val );
210 #define var_SetInteger(a,b,c) __var_SetInteger( VLC_OBJECT(a),b,c)
212 * Set the value of an boolean variable
214 * \param p_obj The object that holds the variable
215 * \param psz_name The name of the variable
216 * \param b The new boolean value of this variable
218 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool b )
222 return var_SetChecked( p_obj, psz_name, VLC_VAR_BOOL, val );
226 * Set the value of a time variable
228 * \param p_obj The object that holds the variable
229 * \param psz_name The name of the variable
230 * \param i The new time value of this variable
232 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
236 return var_SetChecked( p_obj, psz_name, VLC_VAR_TIME, val );
240 * Set the value of a float variable
242 * \param p_obj The object that holds the variable
243 * \param psz_name The name of the variable
244 * \param f The new float value of this variable
246 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
250 return var_SetChecked( p_obj, psz_name, VLC_VAR_FLOAT, val );
254 * Set the value of a string variable
256 * \param p_obj The object that holds the variable
257 * \param psz_name The name of the variable
258 * \param psz_string The new string value of this variable
260 static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
263 val.psz_string = (char *)psz_string;
264 return var_SetChecked( p_obj, psz_name, VLC_VAR_STRING, val );
268 * Trigger the callbacks on a void variable
270 * \param p_obj The object that holds the variable
271 * \param psz_name The name of the variable
273 static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
277 return var_SetChecked( p_obj, psz_name, VLC_VAR_VOID, val );
279 #define var_SetVoid(a,b) __var_SetVoid( VLC_OBJECT(a),b)
282 * Set the value of a pointer variable
284 * \param p_obj The object that holds the variable
285 * \param psz_name The name of the variable
286 * \param ptr The new pointer value of this variable
289 int var_SetAddress( vlc_object_t *p_obj, const char *psz_name, void *ptr )
293 return var_SetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, val );
295 #define var_SetAddress(o, n, p) var_SetAddress(VLC_OBJECT(o), n, p)
299 * __var_SetBool() with automatic casting
301 #define var_SetBool(a,b,c) __var_SetBool( VLC_OBJECT(a),b,c)
304 * __var_SetTime() with automatic casting
306 #define var_SetTime(a,b,c) __var_SetTime( VLC_OBJECT(a),b,c)
308 * __var_SetFloat() with automatic casting
310 #define var_SetFloat(a,b,c) __var_SetFloat( VLC_OBJECT(a),b,c)
312 * __var_SetString() with automatic casting
314 #define var_SetString(a,b,c) __var_SetString( VLC_OBJECT(a),b,c)
317 * Get an integer value
319 * \param p_obj The object that holds the variable
320 * \param psz_name The name of the variable
323 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
326 if( !var_GetChecked( p_obj, psz_name, VLC_VAR_INTEGER, &val ) )
333 * Get a boolean value
335 * \param p_obj The object that holds the variable
336 * \param psz_name The name of the variable
339 static inline bool __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
341 vlc_value_t val; val.b_bool = false;
343 if( !var_GetChecked( p_obj, psz_name, VLC_VAR_BOOL, &val ) )
352 * \param p_obj The object that holds the variable
353 * \param psz_name The name of the variable
356 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
358 vlc_value_t val; val.i_time = 0L;
359 if( !var_GetChecked( p_obj, psz_name, VLC_VAR_TIME, &val ) )
368 * \param p_obj The object that holds the variable
369 * \param psz_name The name of the variable
372 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
374 vlc_value_t val; val.f_float = 0.0;
375 if( !var_GetChecked( p_obj, psz_name, VLC_VAR_FLOAT, &val ) )
384 * \param p_obj The object that holds the variable
385 * \param psz_name The name of the variable
388 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
390 vlc_value_t val; val.psz_string = NULL;
391 if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
394 return val.psz_string;
398 static inline char *__var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
401 if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
403 if( val.psz_string && *val.psz_string )
404 return val.psz_string;
405 free( val.psz_string );
411 * __var_GetInteger() with automatic casting
413 #define var_GetInteger(a,b) __var_GetInteger( VLC_OBJECT(a),b)
415 * __var_GetBool() with automatic casting
417 #define var_GetBool(a,b) __var_GetBool( VLC_OBJECT(a),b)
419 * __var_GetTime() with automatic casting
421 #define var_GetTime(a,b) __var_GetTime( VLC_OBJECT(a),b)
423 * __var_GetFloat() with automatic casting
425 #define var_GetFloat(a,b) __var_GetFloat( VLC_OBJECT(a),b)
427 * __var_GetString() with automatic casting
429 #define var_GetString(a,b) __var_GetString( VLC_OBJECT(a),b)
430 #define var_GetNonEmptyString(a,b) __var_GetNonEmptyString( VLC_OBJECT(a),b)
435 * Increment an integer variable
436 * \param p_obj the object that holds the variable
437 * \param psz_name the name of the variable
439 static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
441 int i_val = __var_GetInteger( p_obj, psz_name );
442 __var_SetInteger( p_obj, psz_name, ++i_val );
444 #define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
447 * Decrement an integer variable
448 * \param p_obj the object that holds the variable
449 * \param psz_name the name of the variable
451 static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
453 int i_val = __var_GetInteger( p_obj, psz_name );
454 __var_SetInteger( p_obj, psz_name, --i_val );
456 #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
459 * Create a integer variable with inherit and get its value.
461 * \param p_obj The object that holds the variable
462 * \param psz_name The name of the variable
465 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
467 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
468 return __var_GetInteger( p_obj, psz_name );
472 * Create a boolean variable with inherit and get its value.
474 * \param p_obj The object that holds the variable
475 * \param psz_name The name of the variable
478 static inline bool __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
480 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
481 return __var_GetBool( p_obj, psz_name );
485 * Create a time variable with inherit and get its value.
487 * \param p_obj The object that holds the variable
488 * \param psz_name The name of the variable
491 static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
493 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
494 return __var_GetTime( p_obj, psz_name );
498 * Create a float variable with inherit and get its value.
500 * \param p_obj The object that holds the variable
501 * \param psz_name The name of the variable
504 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
506 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
507 return __var_GetFloat( p_obj, psz_name );
511 * Create a string variable with inherit and get its value.
513 * \param p_obj The object that holds the variable
514 * \param psz_name The name of the variable
517 static inline char *__var_CreateGetString( vlc_object_t *p_obj,
518 const char *psz_name )
520 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
521 return __var_GetString( p_obj, psz_name );
525 static inline char *__var_CreateGetNonEmptyString( 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_GetNonEmptyString( p_obj, psz_name );
533 * __var_CreateGetInteger() with automatic casting
535 #define var_CreateGetInteger(a,b) __var_CreateGetInteger( VLC_OBJECT(a),b)
537 * __var_CreateGetBool() with automatic casting
539 #define var_CreateGetBool(a,b) __var_CreateGetBool( VLC_OBJECT(a),b)
541 * __var_CreateGetTime() with automatic casting
543 #define var_CreateGetTime(a,b) __var_CreateGetTime( VLC_OBJECT(a),b)
545 * __var_CreateGetFloat() with automatic casting
547 #define var_CreateGetFloat(a,b) __var_CreateGetFloat( VLC_OBJECT(a),b)
549 * __var_CreateGetString() with automatic casting
551 #define var_CreateGetString(a,b) __var_CreateGetString( VLC_OBJECT(a),b)
552 #define var_CreateGetNonEmptyString(a,b) __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
555 * Create a integer command variable with inherit and get its value.
557 * \param p_obj The object that holds the variable
558 * \param psz_name The name of the variable
561 static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
563 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
564 | VLC_VAR_ISCOMMAND );
565 return __var_GetInteger( p_obj, psz_name );
569 * Create a boolean command variable with inherit and get its value.
571 * \param p_obj The object that holds the variable
572 * \param psz_name The name of the variable
575 static inline bool __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
577 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
578 | VLC_VAR_ISCOMMAND );
579 return __var_GetBool( p_obj, psz_name );
583 * Create a time command variable with inherit and get its value.
585 * \param p_obj The object that holds the variable
586 * \param psz_name The name of the variable
589 static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
591 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
592 | VLC_VAR_ISCOMMAND );
593 return __var_GetTime( p_obj, psz_name );
597 * Create a float command variable with inherit and get its value.
599 * \param p_obj The object that holds the variable
600 * \param psz_name The name of the variable
603 static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
605 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
606 | VLC_VAR_ISCOMMAND );
607 return __var_GetFloat( p_obj, psz_name );
611 * Create a string command variable with inherit and get its value.
613 * \param p_obj The object that holds the variable
614 * \param psz_name The name of the variable
617 static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
618 const char *psz_name )
620 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
621 | VLC_VAR_ISCOMMAND );
622 return __var_GetString( p_obj, psz_name );
626 static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
627 const char *psz_name )
629 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
630 | VLC_VAR_ISCOMMAND );
631 return __var_GetNonEmptyString( p_obj, psz_name );
635 * __var_CreateGetInteger() with automatic casting
637 #define var_CreateGetIntegerCommand(a,b) __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
639 * __var_CreateGetBoolCommand() with automatic casting
641 #define var_CreateGetBoolCommand(a,b) __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
643 * __var_CreateGetTimeCommand() with automatic casting
645 #define var_CreateGetTimeCommand(a,b) __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
647 * __var_CreateGetFloat() with automatic casting
649 #define var_CreateGetFloatCommand(a,b) __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
651 * __var_CreateGetStringCommand() with automatic casting
653 #define var_CreateGetStringCommand(a,b) __var_CreateGetStringCommand( VLC_OBJECT(a),b)
654 #define var_CreateGetNonEmptyStringCommand(a,b) __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
656 static inline int __var_CountChoices( vlc_object_t *p_obj, const char *psz_name )
659 if( __var_Change( p_obj, psz_name, VLC_VAR_CHOICESCOUNT, &count, NULL ) )
664 * __var_CountChoices() with automatic casting
666 #define var_CountChoices(a,b) __var_CountChoices( VLC_OBJECT(a),b)
671 #endif /* _VLC_VARIABLES_H */