var_*: use LIBVLC_USED
[vlc.git] / include / vlc_variables.h
1 /*****************************************************************************
2  * variables.h: variables handling
3  *****************************************************************************
4  * Copyright (C) 2002-2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *          Gildas Bazin <gbazin@netcourrier.com>
9  *
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.
14  *
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.
19  *
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  *****************************************************************************/
24
25 #ifndef VLC_VARIABLES_H
26 #define VLC_VARIABLES_H 1
27
28 /**
29  * \file
30  * This file defines functions and structures for dynamic variables in vlc
31  */
32
33 /**
34  * \defgroup variables Variables
35  *
36  * Functions for using the object variables in vlc.
37  *
38  * Vlc have a very powerful "object variable" infrastructure useful
39  * for many things.
40  *
41  * @{
42  */
43
44 /*****************************************************************************
45  * Variable types - probably very incomplete
46  *****************************************************************************/
47 #define VLC_VAR_TYPE      0x00ff
48 #define VLC_VAR_FLAGS     0xff00
49
50 /** \defgroup var_flags Additive flags
51  * These flags are added to the type field of the variable. Most as a result of
52  * a __var_Change() call, but some may be added at creation time
53  * @{
54  */
55 #define VLC_VAR_HASCHOICE 0x0100
56 #define VLC_VAR_HASMIN    0x0200
57 #define VLC_VAR_HASMAX    0x0400
58 #define VLC_VAR_HASSTEP   0x0800
59
60 #define VLC_VAR_ISCOMMAND 0x2000
61
62 /** Creation flag */
63 #define VLC_VAR_DOINHERIT 0x8000
64 /**@}*/
65
66 /**
67  * \defgroup var_action Variable actions
68  * These are the different actions that can be used with __var_Change().
69  * The parameters given are the meaning of the two last parameters of
70  * __var_Change() when this action is being used.
71  * @{
72  */
73
74 /**
75  * Set the minimum value of this variable
76  * \param p_val The new minimum value
77  * \param p_val2 Unused
78  */
79 #define VLC_VAR_SETMIN              0x0010
80 /**
81  * Set the maximum value of this variable
82  * \param p_val The new maximum value
83  * \param p_val2 Unused
84  */
85 #define VLC_VAR_SETMAX              0x0011
86 #define VLC_VAR_SETSTEP             0x0012
87
88 /**
89  * Set the value of this variable without triggering any callbacks
90  * \param p_val The new value
91  * \param p_val2 Unused
92  */
93 #define VLC_VAR_SETVALUE            0x0013
94
95 #define VLC_VAR_SETTEXT             0x0014
96 #define VLC_VAR_GETTEXT             0x0015
97
98 #define VLC_VAR_GETMIN              0x0016
99 #define VLC_VAR_GETMAX              0x0017
100 #define VLC_VAR_GETSTEP             0x0018
101
102 #define VLC_VAR_ADDCHOICE           0x0020
103 #define VLC_VAR_DELCHOICE           0x0021
104 #define VLC_VAR_CLEARCHOICES        0x0022
105 #define VLC_VAR_SETDEFAULT          0x0023
106 #define VLC_VAR_GETCHOICES          0x0024
107 #define VLC_VAR_FREECHOICES         0x0025
108 #define VLC_VAR_GETLIST             0x0026
109 #define VLC_VAR_FREELIST            0x0027
110 #define VLC_VAR_CHOICESCOUNT        0x0028
111
112 #define VLC_VAR_INHERITVALUE        0x0030
113 #define VLC_VAR_TRIGGER_CALLBACKS   0x0035
114
115 #define VLC_VAR_SETISCOMMAND        0x0040
116 /**@}*/
117
118 /*****************************************************************************
119  * Prototypes
120  *****************************************************************************/
121 VLC_EXPORT( int, __var_Create, ( vlc_object_t *, const char *, int ) );
122 VLC_EXPORT( int, __var_Destroy, ( vlc_object_t *, const char * ) );
123
124 VLC_EXPORT( int, __var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
125
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
130 #define var_Command(a,b,c,d,e) __var_Command( VLC_OBJECT( a ), b, c, d, e )
131 VLC_EXPORT( int, __var_Command, ( vlc_object_t *, const char *, const char *, const char *, char ** ) );
132
133 VLC_EXPORT( vlc_mutex_t *, var_AcquireMutex, ( const char * ) LIBVLC_USED );
134 #ifdef __GNUC__
135 static
136 __attribute__((unused))
137 __attribute__((noinline))
138 __attribute__((error("variable mutex name leaks memory at run-time")))
139 const char *nonconst_mutex_name( const char *str )
140 {
141     return str;
142 }
143
144 # define check_named_mutex( m ) \
145     (__builtin_constant_p(m) ? m : nonconst_mutex_name(m))
146 #else
147 # define check_named_mutex( m ) (m)
148 #endif
149
150 #define var_AcquireMutex( n ) var_AcquireMutex(check_named_mutex(n))
151
152 /**
153  * __var_Create() with automatic casting.
154  */
155 #define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
156 /**
157  * __var_Destroy() with automatic casting
158  */
159 #define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
160
161 /**
162  * __var_Change() with automatic casting
163  */
164 #define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
165
166 /**
167  * __var_Type() with automatic casting
168  */
169 #define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
170 /**
171  * __var_Set() with automatic casting
172  */
173 #define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
174 /**
175  * __var_Get() with automatic casting
176  */
177 #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
178
179 /*****************************************************************************
180  * Variable callbacks
181  *****************************************************************************
182  * int MyCallback( vlc_object_t *p_this,
183  *                 char const *psz_variable,
184  *                 vlc_value_t oldvalue,
185  *                 vlc_value_t newvalue,
186  *                 void *p_data);
187  *****************************************************************************/
188 VLC_EXPORT( int, __var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
189 VLC_EXPORT( int, __var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
190 VLC_EXPORT( int, __var_TriggerCallback, ( vlc_object_t *, const char * ) );
191
192 /**
193  * __var_AddCallback() with automatic casting
194  */
195 #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
196
197 /**
198  * __var_DelCallback() with automatic casting
199  */
200 #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
201
202 /**
203  * __var_TriggerCallback() with automatic casting
204  */
205 #define var_TriggerCallback(a,b) __var_TriggerCallback( VLC_OBJECT(a), b )
206
207 /*****************************************************************************
208  * helpers functions
209  *****************************************************************************/
210
211 /**
212  * Set the value of an integer variable
213  *
214  * \param p_obj The object that holds the variable
215  * \param psz_name The name of the variable
216  * \param i The new integer value of this variable
217  */
218 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
219 {
220     vlc_value_t val;
221     val.i_int = i;
222     return __var_Set( p_obj, psz_name, val );
223 }
224 #define var_SetInteger(a,b,c)   __var_SetInteger( VLC_OBJECT(a),b,c)
225 /**
226  * Set the value of an boolean variable
227  *
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
231  */
232 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool b )
233 {
234     vlc_value_t val;
235     val.b_bool = b;
236     return __var_Set( p_obj, psz_name, val );
237 }
238
239 /**
240  * Set the value of a time variable
241  *
242  * \param p_obj The object that holds the variable
243  * \param psz_name The name of the variable
244  * \param i The new time value of this variable
245  */
246 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
247 {
248     vlc_value_t val;
249     val.i_time = i;
250     return __var_Set( p_obj, psz_name, val );
251 }
252
253 /**
254  * Set the value of a float variable
255  *
256  * \param p_obj The object that holds the variable
257  * \param psz_name The name of the variable
258  * \param f The new float value of this variable
259  */
260 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
261 {
262     vlc_value_t val;
263     val.f_float = f;
264     return __var_Set( p_obj, psz_name, val );
265 }
266
267 /**
268  * Set the value of a string variable
269  *
270  * \param p_obj The object that holds the variable
271  * \param psz_name The name of the variable
272  * \param psz_string The new string value of this variable
273  */
274 static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
275 {
276     vlc_value_t val;
277     val.psz_string = (char *)psz_string;
278     return __var_Set( p_obj, psz_name, val );
279 }
280
281 /**
282  * Trigger the callbacks on a void variable
283  *
284  * \param p_obj The object that holds the variable
285  * \param psz_name The name of the variable
286  */
287 static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
288 {
289     vlc_value_t val;
290     val.b_bool = true;
291     return __var_Set( p_obj, psz_name, val );
292 }
293 #define var_SetVoid(a,b)        __var_SetVoid( VLC_OBJECT(a),b)
294
295 /**
296  * __var_SetBool() with automatic casting
297  */
298 #define var_SetBool(a,b,c)   __var_SetBool( VLC_OBJECT(a),b,c)
299
300 /**
301  * __var_SetTime() with automatic casting
302  */
303 #define var_SetTime(a,b,c)      __var_SetTime( VLC_OBJECT(a),b,c)
304 /**
305  * __var_SetFloat() with automatic casting
306  */
307 #define var_SetFloat(a,b,c)     __var_SetFloat( VLC_OBJECT(a),b,c)
308 /**
309  * __var_SetString() with automatic casting
310  */
311 #define var_SetString(a,b,c)     __var_SetString( VLC_OBJECT(a),b,c)
312
313 /**
314  * Get an integer value
315 *
316  * \param p_obj The object that holds the variable
317  * \param psz_name The name of the variable
318  */
319 LIBVLC_USED
320 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
321 {
322     vlc_value_t val;val.i_int = 0;
323     if( !__var_Get( p_obj, psz_name, &val ) )
324         return val.i_int;
325     else
326         return 0;
327 }
328
329 /**
330  * Get a boolean value
331  *
332  * \param p_obj The object that holds the variable
333  * \param psz_name The name of the variable
334  */
335 LIBVLC_USED
336 static inline int __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
337 {
338     vlc_value_t val; val.b_bool = false;
339     if( !__var_Get( p_obj, psz_name, &val ) )
340         return val.b_bool;
341     else
342         return false;
343 }
344
345 /**
346  * Get a time value
347  *
348  * \param p_obj The object that holds the variable
349  * \param psz_name The name of the variable
350  */
351 LIBVLC_USED
352 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
353 {
354     vlc_value_t val; val.i_time = 0L;
355     if( !__var_Get( p_obj, psz_name, &val ) )
356         return val.i_time;
357     else
358         return 0;
359 }
360
361 /**
362  * Get a float value
363  *
364  * \param p_obj The object that holds the variable
365  * \param psz_name The name of the variable
366  */
367 LIBVLC_USED
368 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
369 {
370     vlc_value_t val; val.f_float = 0.0;
371     if( !__var_Get( p_obj, psz_name, &val ) )
372         return val.f_float;
373     else
374         return 0.0;
375 }
376
377 /**
378  * Get a string value
379  *
380  * \param p_obj The object that holds the variable
381  * \param psz_name The name of the variable
382  */
383 LIBVLC_USED
384 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
385 {
386     vlc_value_t val; val.psz_string = NULL;
387     if( __var_Get( p_obj, psz_name, &val ) )
388         return NULL;
389     else
390         return val.psz_string;
391 }
392
393 LIBVLC_USED
394 static inline char *__var_GetNonEmptyString( vlc_object_t *obj, const char *name )
395 {
396     vlc_value_t val;
397     if( __var_Get( obj, name, &val ) )
398         return NULL;
399     if( *val.psz_string )
400         return val.psz_string;
401     free( val.psz_string );
402     return NULL;
403 }
404
405
406 /**
407  * __var_GetInteger() with automatic casting
408  */
409 #define var_GetInteger(a,b)   __var_GetInteger( VLC_OBJECT(a),b)
410 /**
411  * __var_GetBool() with automatic casting
412  */
413 #define var_GetBool(a,b)   __var_GetBool( VLC_OBJECT(a),b)
414 /**
415  * __var_GetTime() with automatic casting
416  */
417 #define var_GetTime(a,b)   __var_GetTime( VLC_OBJECT(a),b)
418 /**
419  * __var_GetFloat() with automatic casting
420  */
421 #define var_GetFloat(a,b)   __var_GetFloat( VLC_OBJECT(a),b)
422 /**
423  * __var_GetString() with automatic casting
424  */
425 #define var_GetString(a,b)   __var_GetString( VLC_OBJECT(a),b)
426 #define var_GetNonEmptyString(a,b)   __var_GetNonEmptyString( VLC_OBJECT(a),b)
427
428
429
430 /**
431  * Increment an integer variable
432  * \param p_obj the object that holds the variable
433  * \param psz_name the name of the variable
434  */
435 static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
436 {
437     int i_val = __var_GetInteger( p_obj, psz_name );
438     __var_SetInteger( p_obj, psz_name, ++i_val );
439 }
440 #define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
441
442 /**
443  * Decrement an integer variable
444  * \param p_obj the object that holds the variable
445  * \param psz_name the name of the variable
446  */
447 static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
448 {
449     int i_val = __var_GetInteger( p_obj, psz_name );
450     __var_SetInteger( p_obj, psz_name, --i_val );
451 }
452 #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
453
454 /**
455  * Create a integer variable with inherit and get its value.
456  *
457  * \param p_obj The object that holds the variable
458  * \param psz_name The name of the variable
459  */
460 LIBVLC_USED
461 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
462 {
463     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
464     return __var_GetInteger( p_obj, psz_name );
465 }
466
467 /**
468  * Create a boolean variable with inherit and get its value.
469  *
470  * \param p_obj The object that holds the variable
471  * \param psz_name The name of the variable
472  */
473 LIBVLC_USED
474 static inline int __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
475 {
476     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
477     return __var_GetBool( p_obj, psz_name );
478 }
479
480 /**
481  * Create a time variable with inherit and get its value.
482  *
483  * \param p_obj The object that holds the variable
484  * \param psz_name The name of the variable
485  */
486 LIBVLC_USED
487 static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
488 {
489     __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
490     return __var_GetTime( p_obj, psz_name );
491 }
492
493 /**
494  * Create a float variable with inherit and get its value.
495  *
496  * \param p_obj The object that holds the variable
497  * \param psz_name The name of the variable
498  */
499 LIBVLC_USED
500 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
501 {
502     __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
503     return __var_GetFloat( p_obj, psz_name );
504 }
505
506 /**
507  * Create a string variable with inherit and get its value.
508  *
509  * \param p_obj The object that holds the variable
510  * \param psz_name The name of the variable
511  */
512 LIBVLC_USED
513 static inline char *__var_CreateGetString( vlc_object_t *p_obj,
514                                            const char *psz_name )
515 {
516     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
517     return __var_GetString( p_obj, psz_name );
518 }
519
520 LIBVLC_USED
521 static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
522                                                    const char *psz_name )
523 {
524     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
525     return __var_GetNonEmptyString( p_obj, psz_name );
526 }
527
528 /**
529  * __var_CreateGetInteger() with automatic casting
530  */
531 #define var_CreateGetInteger(a,b)   __var_CreateGetInteger( VLC_OBJECT(a),b)
532 /**
533  * __var_CreateGetBool() with automatic casting
534  */
535 #define var_CreateGetBool(a,b)   __var_CreateGetBool( VLC_OBJECT(a),b)
536 /**
537  * __var_CreateGetTime() with automatic casting
538  */
539 #define var_CreateGetTime(a,b)   __var_CreateGetTime( VLC_OBJECT(a),b)
540 /**
541  * __var_CreateGetFloat() with automatic casting
542  */
543 #define var_CreateGetFloat(a,b)   __var_CreateGetFloat( VLC_OBJECT(a),b)
544 /**
545  * __var_CreateGetString() with automatic casting
546  */
547 #define var_CreateGetString(a,b)   __var_CreateGetString( VLC_OBJECT(a),b)
548 #define var_CreateGetNonEmptyString(a,b)   __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
549
550 /**
551  * Create a integer command variable with inherit and get its value.
552  *
553  * \param p_obj The object that holds the variable
554  * \param psz_name The name of the variable
555  */
556 LIBVLC_USED
557 static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
558 {
559     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
560                                    | VLC_VAR_ISCOMMAND );
561     return __var_GetInteger( p_obj, psz_name );
562 }
563
564 /**
565  * Create a boolean command variable with inherit and get its value.
566  *
567  * \param p_obj The object that holds the variable
568  * \param psz_name The name of the variable
569  */
570 LIBVLC_USED
571 static inline int __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
572 {
573     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
574                                    | VLC_VAR_ISCOMMAND );
575     return __var_GetBool( p_obj, psz_name );
576 }
577
578 /**
579  * Create a time command variable with inherit and get its value.
580  *
581  * \param p_obj The object that holds the variable
582  * \param psz_name The name of the variable
583  */
584 LIBVLC_USED
585 static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
586 {
587     __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
588                                    | VLC_VAR_ISCOMMAND );
589     return __var_GetTime( p_obj, psz_name );
590 }
591
592 /**
593  * Create a float command variable with inherit and get its value.
594  *
595  * \param p_obj The object that holds the variable
596  * \param psz_name The name of the variable
597  */
598 LIBVLC_USED
599 static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
600 {
601     __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
602                                    | VLC_VAR_ISCOMMAND );
603     return __var_GetFloat( p_obj, psz_name );
604 }
605
606 /**
607  * Create a string command variable with inherit and get its value.
608  *
609  * \param p_obj The object that holds the variable
610  * \param psz_name The name of the variable
611  */
612 LIBVLC_USED
613 static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
614                                            const char *psz_name )
615 {
616     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
617                                    | VLC_VAR_ISCOMMAND );
618     return __var_GetString( p_obj, psz_name );
619 }
620
621 LIBVLC_USED
622 static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
623                                                    const char *psz_name )
624 {
625     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
626                                    | VLC_VAR_ISCOMMAND );
627     return __var_GetNonEmptyString( p_obj, psz_name );
628 }
629
630 /**
631  * __var_CreateGetInteger() with automatic casting
632  */
633 #define var_CreateGetIntegerCommand(a,b)   __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
634 /**
635  * __var_CreateGetBoolCommand() with automatic casting
636  */
637 #define var_CreateGetBoolCommand(a,b)   __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
638 /**
639  * __var_CreateGetTimeCommand() with automatic casting
640  */
641 #define var_CreateGetTimeCommand(a,b)   __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
642 /**
643  * __var_CreateGetFloat() with automatic casting
644  */
645 #define var_CreateGetFloatCommand(a,b)   __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
646 /**
647  * __var_CreateGetStringCommand() with automatic casting
648  */
649 #define var_CreateGetStringCommand(a,b)   __var_CreateGetStringCommand( VLC_OBJECT(a),b)
650 #define var_CreateGetNonEmptyStringCommand(a,b)   __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
651 /**
652  * @}
653  */
654 #endif /*  _VLC_VARIABLES_H */