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_GETLIST 0x0025
111 #define VLC_VAR_CHOICESCOUNT 0x0026
113 #define VLC_VAR_INHERITVALUE 0x0030
115 #define VLC_VAR_SETISCOMMAND 0x0040
118 /*****************************************************************************
120 *****************************************************************************/
121 VLC_EXPORT( int, __var_Create, ( vlc_object_t *, const char *, int ) );
122 VLC_EXPORT( int, __var_Destroy, ( vlc_object_t *, const char * ) );
124 VLC_EXPORT( int, __var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
126 VLC_EXPORT( int, __var_Type, ( vlc_object_t *, const char * ) LIBVLC_USED );
127 VLC_EXPORT( int, __var_Set, ( vlc_object_t *, const char *, vlc_value_t ) );
128 VLC_EXPORT( int, __var_Get, ( vlc_object_t *, const char *, vlc_value_t * ) );
129 VLC_EXPORT( int, var_SetChecked, ( vlc_object_t *, const char *, int, vlc_value_t ) );
130 VLC_EXPORT( int, var_GetChecked, ( vlc_object_t *, const char *, int, vlc_value_t * ) );
132 #define var_Command(a,b,c,d,e) __var_Command( VLC_OBJECT( a ), b, c, d, e )
133 VLC_EXPORT( int, __var_Command, ( vlc_object_t *, const char *, const char *, const char *, char ** ) );
135 VLC_EXPORT( void, var_FreeList, ( vlc_value_t *, vlc_value_t * ) );
138 * __var_Create() with automatic casting.
140 #define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
142 * __var_Destroy() with automatic casting
144 #define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
147 * __var_Change() with automatic casting
149 #define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
152 * __var_Type() with automatic casting
154 #define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
156 * __var_Set() with automatic casting
158 #define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
160 * __var_Get() with automatic casting
162 #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
164 /*****************************************************************************
166 *****************************************************************************
167 * int MyCallback( vlc_object_t *p_this,
168 * char const *psz_variable,
169 * vlc_value_t oldvalue,
170 * vlc_value_t newvalue,
172 *****************************************************************************/
173 VLC_EXPORT( int, __var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
174 VLC_EXPORT( int, __var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
175 VLC_EXPORT( int, __var_TriggerCallback, ( vlc_object_t *, const char * ) );
178 * __var_AddCallback() with automatic casting
180 #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 )
186 * __var_TriggerCallback() with automatic casting
188 #define var_TriggerCallback(a,b) __var_TriggerCallback( VLC_OBJECT(a), b )
190 /*****************************************************************************
192 *****************************************************************************/
195 * Set the value of an integer variable
197 * \param p_obj The object that holds the variable
198 * \param psz_name The name of the variable
199 * \param i The new integer value of this variable
201 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
205 return var_SetChecked( p_obj, psz_name, VLC_VAR_INTEGER, val );
209 * Set the value of an boolean variable
211 * \param p_obj The object that holds the variable
212 * \param psz_name The name of the variable
213 * \param b The new boolean value of this variable
215 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool b )
219 return var_SetChecked( p_obj, psz_name, VLC_VAR_BOOL, val );
223 * Set the value of a time variable
225 * \param p_obj The object that holds the variable
226 * \param psz_name The name of the variable
227 * \param i The new time value of this variable
229 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
233 return var_SetChecked( p_obj, psz_name, VLC_VAR_TIME, val );
237 * Set the value of a float variable
239 * \param p_obj The object that holds the variable
240 * \param psz_name The name of the variable
241 * \param f The new float value of this variable
243 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
247 return var_SetChecked( p_obj, psz_name, VLC_VAR_FLOAT, val );
251 * Set the value of a string variable
253 * \param p_obj The object that holds the variable
254 * \param psz_name The name of the variable
255 * \param psz_string The new string value of this variable
257 static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
260 val.psz_string = (char *)psz_string;
261 return var_SetChecked( p_obj, psz_name, VLC_VAR_STRING, val );
265 * Set the value of a pointer variable
267 * \param p_obj The object that holds the variable
268 * \param psz_name The name of the variable
269 * \param ptr The new pointer value of this variable
272 int __var_SetAddress( vlc_object_t *p_obj, const char *psz_name, void *ptr )
276 return var_SetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, val );
280 * __var_SetInteger() with automatic casting
282 #define var_SetInteger(a,b,c) __var_SetInteger( VLC_OBJECT(a),b,c)
284 * __var_SetBool() with automatic casting
286 #define var_SetBool(a,b,c) __var_SetBool( VLC_OBJECT(a),b,c)
288 * __var_SetTime() with automatic casting
290 #define var_SetTime(a,b,c) __var_SetTime( VLC_OBJECT(a),b,c)
292 * __var_SetFloat() with automatic casting
294 #define var_SetFloat(a,b,c) __var_SetFloat( VLC_OBJECT(a),b,c)
296 * __var_SetString() with automatic casting
298 #define var_SetString(a,b,c) __var_SetString( VLC_OBJECT(a),b,c)
300 * __var_SetAddress() with automatic casting
302 #define var_SetAddress(o, n, p) __var_SetAddress(VLC_OBJECT(o), n, p)
306 * Get an integer value
308 * \param p_obj The object that holds the variable
309 * \param psz_name The name of the variable
312 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
315 if( !var_GetChecked( p_obj, psz_name, VLC_VAR_INTEGER, &val ) )
322 * Get a boolean value
324 * \param p_obj The object that holds the variable
325 * \param psz_name The name of the variable
328 static inline bool __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
330 vlc_value_t val; val.b_bool = false;
332 if( !var_GetChecked( p_obj, psz_name, VLC_VAR_BOOL, &val ) )
341 * \param p_obj The object that holds the variable
342 * \param psz_name The name of the variable
345 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
347 vlc_value_t val; val.i_time = 0L;
348 if( !var_GetChecked( p_obj, psz_name, VLC_VAR_TIME, &val ) )
357 * \param p_obj The object that holds the variable
358 * \param psz_name The name of the variable
361 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
363 vlc_value_t val; val.f_float = 0.0;
364 if( !var_GetChecked( p_obj, psz_name, VLC_VAR_FLOAT, &val ) )
373 * \param p_obj The object that holds the variable
374 * \param psz_name The name of the variable
377 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
379 vlc_value_t val; val.psz_string = NULL;
380 if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
383 return val.psz_string;
387 static inline char *__var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
390 if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
392 if( val.psz_string && *val.psz_string )
393 return val.psz_string;
394 free( val.psz_string );
400 * __var_GetInteger() with automatic casting
402 #define var_GetInteger(a,b) __var_GetInteger( VLC_OBJECT(a),b)
404 * __var_GetBool() with automatic casting
406 #define var_GetBool(a,b) __var_GetBool( VLC_OBJECT(a),b)
408 * __var_GetTime() with automatic casting
410 #define var_GetTime(a,b) __var_GetTime( VLC_OBJECT(a),b)
412 * __var_GetFloat() with automatic casting
414 #define var_GetFloat(a,b) __var_GetFloat( VLC_OBJECT(a),b)
416 * __var_GetString() with automatic casting
418 #define var_GetString(a,b) __var_GetString( VLC_OBJECT(a),b)
419 #define var_GetNonEmptyString(a,b) __var_GetNonEmptyString( VLC_OBJECT(a),b)
424 * Increment an integer variable
425 * \param p_obj the object that holds the variable
426 * \param psz_name the name of the variable
428 static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
430 int i_val = __var_GetInteger( p_obj, psz_name );
431 __var_SetInteger( p_obj, psz_name, ++i_val );
433 #define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
436 * Decrement an integer variable
437 * \param p_obj the object that holds the variable
438 * \param psz_name the name of the variable
440 static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
442 int i_val = __var_GetInteger( p_obj, psz_name );
443 __var_SetInteger( p_obj, psz_name, --i_val );
445 #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
448 * Create a integer variable with inherit and get its value.
450 * \param p_obj The object that holds the variable
451 * \param psz_name The name of the variable
454 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
456 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
457 return __var_GetInteger( p_obj, psz_name );
461 * Create a boolean variable with inherit and get its value.
463 * \param p_obj The object that holds the variable
464 * \param psz_name The name of the variable
467 static inline bool __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
469 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
470 return __var_GetBool( p_obj, psz_name );
474 * Create a time variable with inherit and get its value.
476 * \param p_obj The object that holds the variable
477 * \param psz_name The name of the variable
480 static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
482 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
483 return __var_GetTime( p_obj, psz_name );
487 * Create a float variable with inherit and get its value.
489 * \param p_obj The object that holds the variable
490 * \param psz_name The name of the variable
493 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
495 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
496 return __var_GetFloat( p_obj, psz_name );
500 * Create a string variable with inherit and get its value.
502 * \param p_obj The object that holds the variable
503 * \param psz_name The name of the variable
506 static inline char *__var_CreateGetString( vlc_object_t *p_obj,
507 const char *psz_name )
509 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
510 return __var_GetString( p_obj, psz_name );
514 static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
515 const char *psz_name )
517 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
518 return __var_GetNonEmptyString( p_obj, psz_name );
522 * __var_CreateGetInteger() with automatic casting
524 #define var_CreateGetInteger(a,b) __var_CreateGetInteger( VLC_OBJECT(a),b)
526 * __var_CreateGetBool() with automatic casting
528 #define var_CreateGetBool(a,b) __var_CreateGetBool( VLC_OBJECT(a),b)
530 * __var_CreateGetTime() with automatic casting
532 #define var_CreateGetTime(a,b) __var_CreateGetTime( VLC_OBJECT(a),b)
534 * __var_CreateGetFloat() with automatic casting
536 #define var_CreateGetFloat(a,b) __var_CreateGetFloat( VLC_OBJECT(a),b)
538 * __var_CreateGetString() with automatic casting
540 #define var_CreateGetString(a,b) __var_CreateGetString( VLC_OBJECT(a),b)
541 #define var_CreateGetNonEmptyString(a,b) __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
544 * Create a integer command variable with inherit and get its value.
546 * \param p_obj The object that holds the variable
547 * \param psz_name The name of the variable
550 static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
552 __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
553 | VLC_VAR_ISCOMMAND );
554 return __var_GetInteger( p_obj, psz_name );
558 * Create a boolean command variable with inherit and get its value.
560 * \param p_obj The object that holds the variable
561 * \param psz_name The name of the variable
564 static inline bool __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
566 __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
567 | VLC_VAR_ISCOMMAND );
568 return __var_GetBool( p_obj, psz_name );
572 * Create a time command variable with inherit and get its value.
574 * \param p_obj The object that holds the variable
575 * \param psz_name The name of the variable
578 static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
580 __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
581 | VLC_VAR_ISCOMMAND );
582 return __var_GetTime( p_obj, psz_name );
586 * Create a float command variable with inherit and get its value.
588 * \param p_obj The object that holds the variable
589 * \param psz_name The name of the variable
592 static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
594 __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
595 | VLC_VAR_ISCOMMAND );
596 return __var_GetFloat( p_obj, psz_name );
600 * Create a string command variable with inherit and get its value.
602 * \param p_obj The object that holds the variable
603 * \param psz_name The name of the variable
606 static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
607 const char *psz_name )
609 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
610 | VLC_VAR_ISCOMMAND );
611 return __var_GetString( p_obj, psz_name );
615 static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
616 const char *psz_name )
618 __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
619 | VLC_VAR_ISCOMMAND );
620 return __var_GetNonEmptyString( p_obj, psz_name );
624 * __var_CreateGetInteger() with automatic casting
626 #define var_CreateGetIntegerCommand(a,b) __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
628 * __var_CreateGetBoolCommand() with automatic casting
630 #define var_CreateGetBoolCommand(a,b) __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
632 * __var_CreateGetTimeCommand() with automatic casting
634 #define var_CreateGetTimeCommand(a,b) __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
636 * __var_CreateGetFloat() with automatic casting
638 #define var_CreateGetFloatCommand(a,b) __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
640 * __var_CreateGetStringCommand() with automatic casting
642 #define var_CreateGetStringCommand(a,b) __var_CreateGetStringCommand( VLC_OBJECT(a),b)
643 #define var_CreateGetNonEmptyStringCommand(a,b) __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
645 static inline int __var_CountChoices( vlc_object_t *p_obj, const char *psz_name )
648 if( __var_Change( p_obj, psz_name, VLC_VAR_CHOICESCOUNT, &count, NULL ) )
653 * __var_CountChoices() with automatic casting
655 #define var_CountChoices(a,b) __var_CountChoices( VLC_OBJECT(a),b)
660 #endif /* _VLC_VARIABLES_H */