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_SETISCOMMAND 0x0040
116 /** \defgroup var_GetAndSet Variable actions
117 * These are the different actions that can be used with var_GetAndSet()
121 * Toggle the value of this boolean
124 #define VLC_VAR_TOGGLE_BOOL 0x0010
126 * Increment or decrement an integer of a given value
127 * \param val the value
129 #define VLC_VAR_INTEGER_INCDEC 0x0020
132 /*****************************************************************************
134 *****************************************************************************/
135 VLC_EXPORT( int, var_Create, ( vlc_object_t *, const char *, int ) );
136 #define var_Create(a,b,c) var_Create( VLC_OBJECT(a), b, c )
138 VLC_EXPORT( int, var_Destroy, ( vlc_object_t *, const char * ) );
139 #define var_Destroy(a,b) var_Destroy( VLC_OBJECT(a), b )
141 VLC_EXPORT( int, var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
142 #define var_Change(a,b,c,d,e) var_Change( VLC_OBJECT(a), b, c, d, e )
144 VLC_EXPORT( int, var_Type, ( vlc_object_t *, const char * ) LIBVLC_USED );
145 #define var_Type(a,b) var_Type( VLC_OBJECT(a), b )
147 VLC_EXPORT( int, var_Set, ( vlc_object_t *, const char *, vlc_value_t ) );
148 #define var_Set(a,b,c) var_Set( VLC_OBJECT(a), b, c )
150 VLC_EXPORT( int, var_Get, ( vlc_object_t *, const char *, vlc_value_t * ) );
151 #define var_Get(a,b,c) var_Get( VLC_OBJECT(a), b, c )
153 VLC_EXPORT( int, var_SetChecked, ( vlc_object_t *, const char *, int, vlc_value_t ) );
154 VLC_EXPORT( int, var_GetChecked, ( vlc_object_t *, const char *, int, vlc_value_t * ) );
155 VLC_EXPORT( int, var_GetAndSet, ( vlc_object_t *, const char *, int, vlc_value_t ) );
156 #define var_GetAndSet(a,b,c,d) var_GetAndSet(VLC_OBJECT(a), b, c, d)
158 VLC_EXPORT( int, var_Inherit, ( vlc_object_t *, const char *, int, vlc_value_t * ) );
160 VLC_EXPORT( int, var_Command, ( vlc_object_t *, const char *, const char *, const char *, char ** ) );
161 #define var_Command(a,b,c,d,e) var_Command( VLC_OBJECT( a ), b, c, d, e )
163 VLC_EXPORT( void, var_FreeList, ( vlc_value_t *, vlc_value_t * ) );
166 /*****************************************************************************
168 *****************************************************************************
169 * int MyCallback( vlc_object_t *p_this,
170 * char const *psz_variable,
171 * vlc_value_t oldvalue,
172 * vlc_value_t newvalue,
174 *****************************************************************************/
175 VLC_EXPORT( int, var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
176 VLC_EXPORT( int, var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
177 VLC_EXPORT( int, var_TriggerCallback, ( vlc_object_t *, const char * ) );
179 #define var_AddCallback(a,b,c,d) var_AddCallback( VLC_OBJECT(a), b, c, d )
180 #define var_DelCallback(a,b,c,d) var_DelCallback( VLC_OBJECT(a), b, c, d )
181 #define var_TriggerCallback(a,b) var_TriggerCallback( VLC_OBJECT(a), b )
183 /*****************************************************************************
185 *****************************************************************************/
188 * Set the value of an integer variable
190 * \param p_obj The object that holds the variable
191 * \param psz_name The name of the variable
192 * \param i The new integer value of this variable
194 static inline int var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
198 return var_SetChecked( p_obj, psz_name, VLC_VAR_INTEGER, val );
202 * Set the value of an boolean variable
204 * \param p_obj The object that holds the variable
205 * \param psz_name The name of the variable
206 * \param b The new boolean value of this variable
208 static inline int var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool b )
212 return var_SetChecked( p_obj, psz_name, VLC_VAR_BOOL, val );
216 * Set the value of a time variable
218 * \param p_obj The object that holds the variable
219 * \param psz_name The name of the variable
220 * \param i The new time value of this variable
222 static inline int var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
226 return var_SetChecked( p_obj, psz_name, VLC_VAR_TIME, val );
230 * Set the value of a float variable
232 * \param p_obj The object that holds the variable
233 * \param psz_name The name of the variable
234 * \param f The new float value of this variable
236 static inline int var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
240 return var_SetChecked( p_obj, psz_name, VLC_VAR_FLOAT, val );
244 * Set the value of a string variable
246 * \param p_obj The object that holds the variable
247 * \param psz_name The name of the variable
248 * \param psz_string The new string value of this variable
250 static inline int var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
253 val.psz_string = (char *)psz_string;
254 return var_SetChecked( p_obj, psz_name, VLC_VAR_STRING, val );
258 * Set the value of a pointer variable
260 * \param p_obj The object that holds the variable
261 * \param psz_name The name of the variable
262 * \param ptr The new pointer value of this variable
265 int var_SetAddress( vlc_object_t *p_obj, const char *psz_name, void *ptr )
269 return var_SetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, val );
272 #define var_SetInteger(a,b,c) var_SetInteger( VLC_OBJECT(a),b,c)
273 #define var_SetBool(a,b,c) var_SetBool( VLC_OBJECT(a),b,c)
274 #define var_SetTime(a,b,c) var_SetTime( VLC_OBJECT(a),b,c)
275 #define var_SetFloat(a,b,c) var_SetFloat( VLC_OBJECT(a),b,c)
276 #define var_SetString(a,b,c) var_SetString( VLC_OBJECT(a),b,c)
277 #define var_SetAddress(o, n, p) var_SetAddress(VLC_OBJECT(o), n, p)
281 * Get an integer value
283 * \param p_obj The object that holds the variable
284 * \param psz_name The name of the variable
287 static inline int var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
290 if( !var_GetChecked( p_obj, psz_name, VLC_VAR_INTEGER, &val ) )
297 * Get a boolean value
299 * \param p_obj The object that holds the variable
300 * \param psz_name The name of the variable
303 static inline bool var_GetBool( vlc_object_t *p_obj, const char *psz_name )
305 vlc_value_t val; val.b_bool = false;
307 if( !var_GetChecked( p_obj, psz_name, VLC_VAR_BOOL, &val ) )
316 * \param p_obj The object that holds the variable
317 * \param psz_name The name of the variable
320 static inline int64_t var_GetTime( vlc_object_t *p_obj, const char *psz_name )
322 vlc_value_t val; val.i_time = 0L;
323 if( !var_GetChecked( p_obj, psz_name, VLC_VAR_TIME, &val ) )
332 * \param p_obj The object that holds the variable
333 * \param psz_name The name of the variable
336 static inline float var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
338 vlc_value_t val; val.f_float = 0.0;
339 if( !var_GetChecked( p_obj, psz_name, VLC_VAR_FLOAT, &val ) )
348 * \param p_obj The object that holds the variable
349 * \param psz_name The name of the variable
352 static inline char *var_GetString( vlc_object_t *p_obj, const char *psz_name )
354 vlc_value_t val; val.psz_string = NULL;
355 if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
358 return val.psz_string;
362 static inline char *var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
365 if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
367 if( val.psz_string && *val.psz_string )
368 return val.psz_string;
369 free( val.psz_string );
374 static inline void *var_GetAddress( vlc_object_t *p_obj, const char *psz_name )
377 if( var_GetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, &val ) )
380 return val.p_address;
384 * Increment an integer variable
385 * \param p_obj the object that holds the variable
386 * \param psz_name the name of the variable
388 static inline void var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
392 var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_INCDEC, val );
394 #define var_IncInteger(a,b) var_IncInteger( VLC_OBJECT(a), b )
397 * Decrement an integer variable
398 * \param p_obj the object that holds the variable
399 * \param psz_name the name of the variable
401 static inline void var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
405 var_GetAndSet( p_obj, psz_name, VLC_VAR_INTEGER_INCDEC, val );
407 #define var_DecInteger(a,b) var_DecInteger( VLC_OBJECT(a), b )
410 * Create a integer variable with inherit and get its value.
412 * \param p_obj The object that holds the variable
413 * \param psz_name The name of the variable
416 static inline int var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
418 var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
419 return var_GetInteger( p_obj, psz_name );
423 * Create a boolean variable with inherit and get its value.
425 * \param p_obj The object that holds the variable
426 * \param psz_name The name of the variable
429 static inline bool var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
431 var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
432 return var_GetBool( p_obj, psz_name );
436 * Create a time variable with inherit and get its value.
438 * \param p_obj The object that holds the variable
439 * \param psz_name The name of the variable
442 static inline int64_t var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
444 var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
445 return var_GetTime( p_obj, psz_name );
449 * Create a float variable with inherit and get its value.
451 * \param p_obj The object that holds the variable
452 * \param psz_name The name of the variable
455 static inline float var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
457 var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
458 return var_GetFloat( p_obj, psz_name );
462 * Create a string variable with inherit and get its value.
464 * \param p_obj The object that holds the variable
465 * \param psz_name The name of the variable
468 static inline char *var_CreateGetString( vlc_object_t *p_obj,
469 const char *psz_name )
471 var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
472 return var_GetString( p_obj, psz_name );
476 static inline char *var_CreateGetNonEmptyString( vlc_object_t *p_obj,
477 const char *psz_name )
479 var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
480 return var_GetNonEmptyString( p_obj, psz_name );
484 * Create an address variable with inherit and get its value.
486 * \param p_obj The object that holds the variable
487 * \param psz_name The name of the variable
490 static inline void *var_CreateGetAddress( vlc_object_t *p_obj,
491 const char *psz_name )
493 var_Create( p_obj, psz_name, VLC_VAR_ADDRESS | VLC_VAR_DOINHERIT );
494 return var_GetAddress( p_obj, psz_name );
497 #define var_CreateGetInteger(a,b) var_CreateGetInteger( VLC_OBJECT(a),b)
498 #define var_CreateGetBool(a,b) var_CreateGetBool( VLC_OBJECT(a),b)
499 #define var_CreateGetTime(a,b) var_CreateGetTime( VLC_OBJECT(a),b)
500 #define var_CreateGetFloat(a,b) var_CreateGetFloat( VLC_OBJECT(a),b)
501 #define var_CreateGetString(a,b) var_CreateGetString( VLC_OBJECT(a),b)
502 #define var_CreateGetNonEmptyString(a,b) var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
503 #define var_CreateGetAddress(a,b) var_CreateGetAddress( VLC_OBJECT(a),b)
506 * Create a integer command 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 int var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
514 var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
515 | VLC_VAR_ISCOMMAND );
516 return var_GetInteger( p_obj, psz_name );
520 * Create a boolean command variable with inherit and get its value.
522 * \param p_obj The object that holds the variable
523 * \param psz_name The name of the variable
526 static inline bool var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
528 var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
529 | VLC_VAR_ISCOMMAND );
530 return var_GetBool( p_obj, psz_name );
534 * Create a time command variable with inherit and get its value.
536 * \param p_obj The object that holds the variable
537 * \param psz_name The name of the variable
540 static inline int64_t var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
542 var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
543 | VLC_VAR_ISCOMMAND );
544 return var_GetTime( p_obj, psz_name );
548 * Create a float command variable with inherit and get its value.
550 * \param p_obj The object that holds the variable
551 * \param psz_name The name of the variable
554 static inline float var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
556 var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
557 | VLC_VAR_ISCOMMAND );
558 return var_GetFloat( p_obj, psz_name );
562 * Create a string 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 char *var_CreateGetStringCommand( vlc_object_t *p_obj,
569 const char *psz_name )
571 var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
572 | VLC_VAR_ISCOMMAND );
573 return var_GetString( p_obj, psz_name );
577 static inline char *var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
578 const char *psz_name )
580 var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
581 | VLC_VAR_ISCOMMAND );
582 return var_GetNonEmptyString( p_obj, psz_name );
585 #define var_CreateGetIntegerCommand(a,b) var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
586 #define var_CreateGetBoolCommand(a,b) var_CreateGetBoolCommand( VLC_OBJECT(a),b)
587 #define var_CreateGetTimeCommand(a,b) var_CreateGetTimeCommand( VLC_OBJECT(a),b)
588 #define var_CreateGetFloatCommand(a,b) var_CreateGetFloatCommand( VLC_OBJECT(a),b)
589 #define var_CreateGetStringCommand(a,b) var_CreateGetStringCommand( VLC_OBJECT(a),b)
590 #define var_CreateGetNonEmptyStringCommand(a,b) var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
593 static inline int var_CountChoices( vlc_object_t *p_obj, const char *psz_name )
596 if( var_Change( p_obj, psz_name, VLC_VAR_CHOICESCOUNT, &count, NULL ) )
600 #define var_CountChoices(a,b) var_CountChoices( VLC_OBJECT(a),b)
603 static inline int var_ToggleBool( vlc_object_t *p_obj, const char *psz_name )
606 return var_GetAndSet( p_obj, psz_name, VLC_VAR_TOGGLE_BOOL, val );
608 #define var_ToggleBool(a,b) var_ToggleBool( VLC_OBJECT(a),b )
612 static inline bool var_InheritBool( vlc_object_t *obj, const char *name )
616 if( var_Inherit( obj, name, VLC_VAR_BOOL, &val ) )
620 #define var_InheritBool(o, n) var_InheritBool(VLC_OBJECT(o), n)
623 static inline int var_InheritInteger( vlc_object_t *obj, const char *name )
627 if( var_Inherit( obj, name, VLC_VAR_INTEGER, &val ) )
631 #define var_InheritInteger(o, n) var_InheritInteger(VLC_OBJECT(o), n)
634 static inline float var_InheritFloat( vlc_object_t *obj, const char *name )
638 if( var_Inherit( obj, name, VLC_VAR_FLOAT, &val ) )
642 #define var_InheritFloat(o, n) var_InheritFloat(VLC_OBJECT(o), n)
644 LIBVLC_USED LIBVLC_MALLOC
645 static inline char *var_InheritString( vlc_object_t *obj, const char *name )
649 if( var_Inherit( obj, name, VLC_VAR_STRING, &val ) )
650 val.psz_string = NULL;
651 else if( val.psz_string && !*val.psz_string )
653 free( val.psz_string );
654 val.psz_string = NULL;
656 return val.psz_string;
658 #define var_InheritString(o, n) var_InheritString(VLC_OBJECT(o), n)
660 static inline mtime_t var_InheritTime( vlc_object_t *obj, const char *name )
664 if( var_Inherit( obj, name, VLC_VAR_TIME, &val ) )
668 #define var_InheritTime(o, n) var_InheritTime(VLC_OBJECT(o), n)
670 #define var_GetInteger(a,b) var_GetInteger( VLC_OBJECT(a),b)
671 #define var_GetBool(a,b) var_GetBool( VLC_OBJECT(a),b)
672 #define var_GetTime(a,b) var_GetTime( VLC_OBJECT(a),b)
673 #define var_GetFloat(a,b) var_GetFloat( VLC_OBJECT(a),b)
674 #define var_GetString(a,b) var_GetString( VLC_OBJECT(a),b)
675 #define var_GetNonEmptyString(a,b) var_GetNonEmptyString( VLC_OBJECT(a),b)
676 #define var_GetAddress(a,b) var_GetAddress( VLC_OBJECT(a),b)
681 #endif /* _VLC_VARIABLES_H */