Variable inheritance hints
[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_CLASS     0x00f0
49 #define VLC_VAR_FLAGS     0xff00
50
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
54  * @{
55  */
56 #define VLC_VAR_HASCHOICE 0x0100
57 #define VLC_VAR_HASMIN    0x0200
58 #define VLC_VAR_HASMAX    0x0400
59 #define VLC_VAR_HASSTEP   0x0800
60
61 #define VLC_VAR_ISCOMMAND 0x2000
62
63 /** Creation flag */
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
67 /**@}*/
68
69 /**
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.
74  * @{
75  */
76
77 /**
78  * Set the minimum value of this variable
79  * \param p_val The new minimum value
80  * \param p_val2 Unused
81  */
82 #define VLC_VAR_SETMIN              0x0010
83 /**
84  * Set the maximum value of this variable
85  * \param p_val The new maximum value
86  * \param p_val2 Unused
87  */
88 #define VLC_VAR_SETMAX              0x0011
89 #define VLC_VAR_SETSTEP             0x0012
90
91 /**
92  * Set the value of this variable without triggering any callbacks
93  * \param p_val The new value
94  * \param p_val2 Unused
95  */
96 #define VLC_VAR_SETVALUE            0x0013
97
98 #define VLC_VAR_SETTEXT             0x0014
99 #define VLC_VAR_GETTEXT             0x0015
100
101 #define VLC_VAR_GETMIN              0x0016
102 #define VLC_VAR_GETMAX              0x0017
103 #define VLC_VAR_GETSTEP             0x0018
104
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_FREELIST            0x0027
113 #define VLC_VAR_CHOICESCOUNT        0x0028
114
115 #define VLC_VAR_INHERITVALUE        0x0030
116
117 #define VLC_VAR_SETISCOMMAND        0x0040
118 /**@}*/
119
120 /*****************************************************************************
121  * Prototypes
122  *****************************************************************************/
123 VLC_EXPORT( int, __var_Create, ( vlc_object_t *, const char *, int ) );
124 VLC_EXPORT( int, __var_Destroy, ( vlc_object_t *, const char * ) );
125
126 VLC_EXPORT( int, __var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
127
128 VLC_EXPORT( int, __var_Type, ( vlc_object_t *, const char * ) LIBVLC_USED );
129 VLC_EXPORT( int, __var_Set, ( vlc_object_t *, const char *, vlc_value_t ) );
130 VLC_EXPORT( int, __var_Get, ( vlc_object_t *, const char *, vlc_value_t * ) );
131 VLC_EXPORT( int, var_SetChecked, ( vlc_object_t *, const char *, int, vlc_value_t ) );
132 VLC_EXPORT( int, var_GetChecked, ( vlc_object_t *, const char *, int, vlc_value_t * ) );
133
134 #define var_Command(a,b,c,d,e) __var_Command( VLC_OBJECT( a ), b, c, d, e )
135 VLC_EXPORT( int, __var_Command, ( vlc_object_t *, const char *, const char *, const char *, char ** ) );
136
137 /**
138  * __var_Create() with automatic casting.
139  */
140 #define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
141 /**
142  * __var_Destroy() with automatic casting
143  */
144 #define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
145
146 /**
147  * __var_Change() with automatic casting
148  */
149 #define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
150
151 /**
152  * __var_Type() with automatic casting
153  */
154 #define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
155 /**
156  * __var_Set() with automatic casting
157  */
158 #define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
159 /**
160  * __var_Get() with automatic casting
161  */
162 #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
163
164 /*****************************************************************************
165  * Variable callbacks
166  *****************************************************************************
167  * int MyCallback( vlc_object_t *p_this,
168  *                 char const *psz_variable,
169  *                 vlc_value_t oldvalue,
170  *                 vlc_value_t newvalue,
171  *                 void *p_data);
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 * ) );
176
177 /**
178  * __var_AddCallback() with automatic casting
179  */
180 #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
181
182 /**
183  * __var_DelCallback() with automatic casting
184  */
185 #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
186
187 /**
188  * __var_TriggerCallback() with automatic casting
189  */
190 #define var_TriggerCallback(a,b) __var_TriggerCallback( VLC_OBJECT(a), b )
191
192 /*****************************************************************************
193  * helpers functions
194  *****************************************************************************/
195
196 /**
197  * Set the value of an integer variable
198  *
199  * \param p_obj The object that holds the variable
200  * \param psz_name The name of the variable
201  * \param i The new integer value of this variable
202  */
203 static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
204 {
205     vlc_value_t val;
206     val.i_int = i;
207     return var_SetChecked( p_obj, psz_name, VLC_VAR_INTEGER, val );
208 }
209 #define var_SetInteger(a,b,c)   __var_SetInteger( VLC_OBJECT(a),b,c)
210 /**
211  * Set the value of an boolean variable
212  *
213  * \param p_obj The object that holds the variable
214  * \param psz_name The name of the variable
215  * \param b The new boolean value of this variable
216  */
217 static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool b )
218 {
219     vlc_value_t val;
220     val.b_bool = b;
221     return var_SetChecked( p_obj, psz_name, VLC_VAR_BOOL, val );
222 }
223
224 /**
225  * Set the value of a time variable
226  *
227  * \param p_obj The object that holds the variable
228  * \param psz_name The name of the variable
229  * \param i The new time value of this variable
230  */
231 static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
232 {
233     vlc_value_t val;
234     val.i_time = i;
235     return var_SetChecked( p_obj, psz_name, VLC_VAR_TIME, val );
236 }
237
238 /**
239  * Set the value of a float variable
240  *
241  * \param p_obj The object that holds the variable
242  * \param psz_name The name of the variable
243  * \param f The new float value of this variable
244  */
245 static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
246 {
247     vlc_value_t val;
248     val.f_float = f;
249     return var_SetChecked( p_obj, psz_name, VLC_VAR_FLOAT, val );
250 }
251
252 /**
253  * Set the value of a string variable
254  *
255  * \param p_obj The object that holds the variable
256  * \param psz_name The name of the variable
257  * \param psz_string The new string value of this variable
258  */
259 static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
260 {
261     vlc_value_t val;
262     val.psz_string = (char *)psz_string;
263     return var_SetChecked( p_obj, psz_name, VLC_VAR_STRING, val );
264 }
265
266 /**
267  * Trigger the callbacks on a void variable
268  *
269  * \param p_obj The object that holds the variable
270  * \param psz_name The name of the variable
271  */
272 static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
273 {
274     vlc_value_t val;
275     val.b_bool = true;
276     return var_SetChecked( p_obj, psz_name, VLC_VAR_VOID, val );
277 }
278 #define var_SetVoid(a,b)        __var_SetVoid( VLC_OBJECT(a),b)
279
280 /**
281  * __var_SetBool() with automatic casting
282  */
283 #define var_SetBool(a,b,c)   __var_SetBool( VLC_OBJECT(a),b,c)
284
285 /**
286  * __var_SetTime() with automatic casting
287  */
288 #define var_SetTime(a,b,c)      __var_SetTime( VLC_OBJECT(a),b,c)
289 /**
290  * __var_SetFloat() with automatic casting
291  */
292 #define var_SetFloat(a,b,c)     __var_SetFloat( VLC_OBJECT(a),b,c)
293 /**
294  * __var_SetString() with automatic casting
295  */
296 #define var_SetString(a,b,c)     __var_SetString( VLC_OBJECT(a),b,c)
297
298 /**
299  * Get an integer value
300 *
301  * \param p_obj The object that holds the variable
302  * \param psz_name The name of the variable
303  */
304 LIBVLC_USED
305 static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
306 {
307     vlc_value_t val;
308     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_INTEGER, &val ) )
309         return val.i_int;
310     else
311         return 0;
312 }
313
314 /**
315  * Get a boolean value
316  *
317  * \param p_obj The object that holds the variable
318  * \param psz_name The name of the variable
319  */
320 LIBVLC_USED
321 static inline bool __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
322 {
323     vlc_value_t val; val.b_bool = false;
324
325     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_BOOL, &val ) )
326         return val.b_bool;
327     else
328         return false;
329 }
330
331 /**
332  * Get a time value
333  *
334  * \param p_obj The object that holds the variable
335  * \param psz_name The name of the variable
336  */
337 LIBVLC_USED
338 static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
339 {
340     vlc_value_t val; val.i_time = 0L;
341     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_TIME, &val ) )
342         return val.i_time;
343     else
344         return 0;
345 }
346
347 /**
348  * Get a float value
349  *
350  * \param p_obj The object that holds the variable
351  * \param psz_name The name of the variable
352  */
353 LIBVLC_USED
354 static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
355 {
356     vlc_value_t val; val.f_float = 0.0;
357     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_FLOAT, &val ) )
358         return val.f_float;
359     else
360         return 0.0;
361 }
362
363 /**
364  * Get a string value
365  *
366  * \param p_obj The object that holds the variable
367  * \param psz_name The name of the variable
368  */
369 LIBVLC_USED
370 static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
371 {
372     vlc_value_t val; val.psz_string = NULL;
373     if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
374         return NULL;
375     else
376         return val.psz_string;
377 }
378
379 LIBVLC_USED
380 static inline char *__var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
381 {
382     vlc_value_t val;
383     if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
384         return NULL;
385     if( *val.psz_string )
386         return val.psz_string;
387     free( val.psz_string );
388     return NULL;
389 }
390
391
392 /**
393  * __var_GetInteger() with automatic casting
394  */
395 #define var_GetInteger(a,b)   __var_GetInteger( VLC_OBJECT(a),b)
396 /**
397  * __var_GetBool() with automatic casting
398  */
399 #define var_GetBool(a,b)   __var_GetBool( VLC_OBJECT(a),b)
400 /**
401  * __var_GetTime() with automatic casting
402  */
403 #define var_GetTime(a,b)   __var_GetTime( VLC_OBJECT(a),b)
404 /**
405  * __var_GetFloat() with automatic casting
406  */
407 #define var_GetFloat(a,b)   __var_GetFloat( VLC_OBJECT(a),b)
408 /**
409  * __var_GetString() with automatic casting
410  */
411 #define var_GetString(a,b)   __var_GetString( VLC_OBJECT(a),b)
412 #define var_GetNonEmptyString(a,b)   __var_GetNonEmptyString( VLC_OBJECT(a),b)
413
414
415
416 /**
417  * Increment an integer variable
418  * \param p_obj the object that holds the variable
419  * \param psz_name the name of the variable
420  */
421 static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
422 {
423     int i_val = __var_GetInteger( p_obj, psz_name );
424     __var_SetInteger( p_obj, psz_name, ++i_val );
425 }
426 #define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
427
428 /**
429  * Decrement an integer variable
430  * \param p_obj the object that holds the variable
431  * \param psz_name the name of the variable
432  */
433 static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
434 {
435     int i_val = __var_GetInteger( p_obj, psz_name );
436     __var_SetInteger( p_obj, psz_name, --i_val );
437 }
438 #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
439
440 /**
441  * Create a integer variable with inherit and get its value.
442  *
443  * \param p_obj The object that holds the variable
444  * \param psz_name The name of the variable
445  */
446 LIBVLC_USED
447 static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
448 {
449     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
450     return __var_GetInteger( p_obj, psz_name );
451 }
452
453 /**
454  * Create a boolean variable with inherit and get its value.
455  *
456  * \param p_obj The object that holds the variable
457  * \param psz_name The name of the variable
458  */
459 LIBVLC_USED
460 static inline bool __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
461 {
462     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
463     return __var_GetBool( p_obj, psz_name );
464 }
465
466 /**
467  * Create a time variable with inherit and get its value.
468  *
469  * \param p_obj The object that holds the variable
470  * \param psz_name The name of the variable
471  */
472 LIBVLC_USED
473 static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
474 {
475     __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
476     return __var_GetTime( p_obj, psz_name );
477 }
478
479 /**
480  * Create a float variable with inherit and get its value.
481  *
482  * \param p_obj The object that holds the variable
483  * \param psz_name The name of the variable
484  */
485 LIBVLC_USED
486 static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
487 {
488     __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
489     return __var_GetFloat( p_obj, psz_name );
490 }
491
492 /**
493  * Create a string variable with inherit and get its value.
494  *
495  * \param p_obj The object that holds the variable
496  * \param psz_name The name of the variable
497  */
498 LIBVLC_USED
499 static inline char *__var_CreateGetString( vlc_object_t *p_obj,
500                                            const char *psz_name )
501 {
502     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
503     return __var_GetString( p_obj, psz_name );
504 }
505
506 LIBVLC_USED
507 static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
508                                                    const char *psz_name )
509 {
510     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
511     return __var_GetNonEmptyString( p_obj, psz_name );
512 }
513
514 /**
515  * __var_CreateGetInteger() with automatic casting
516  */
517 #define var_CreateGetInteger(a,b)   __var_CreateGetInteger( VLC_OBJECT(a),b)
518 /**
519  * __var_CreateGetBool() with automatic casting
520  */
521 #define var_CreateGetBool(a,b)   __var_CreateGetBool( VLC_OBJECT(a),b)
522 /**
523  * __var_CreateGetTime() with automatic casting
524  */
525 #define var_CreateGetTime(a,b)   __var_CreateGetTime( VLC_OBJECT(a),b)
526 /**
527  * __var_CreateGetFloat() with automatic casting
528  */
529 #define var_CreateGetFloat(a,b)   __var_CreateGetFloat( VLC_OBJECT(a),b)
530 /**
531  * __var_CreateGetString() with automatic casting
532  */
533 #define var_CreateGetString(a,b)   __var_CreateGetString( VLC_OBJECT(a),b)
534 #define var_CreateGetNonEmptyString(a,b)   __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
535
536 /**
537  * Create a integer command variable with inherit and get its value.
538  *
539  * \param p_obj The object that holds the variable
540  * \param psz_name The name of the variable
541  */
542 LIBVLC_USED
543 static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
544 {
545     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
546                                    | VLC_VAR_ISCOMMAND );
547     return __var_GetInteger( p_obj, psz_name );
548 }
549
550 /**
551  * Create a boolean 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 bool __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
558 {
559     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
560                                    | VLC_VAR_ISCOMMAND );
561     return __var_GetBool( p_obj, psz_name );
562 }
563
564 /**
565  * Create a time 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 int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
572 {
573     __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
574                                    | VLC_VAR_ISCOMMAND );
575     return __var_GetTime( p_obj, psz_name );
576 }
577
578 /**
579  * Create a float 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 float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
586 {
587     __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
588                                    | VLC_VAR_ISCOMMAND );
589     return __var_GetFloat( p_obj, psz_name );
590 }
591
592 /**
593  * Create a string 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 char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
600                                            const char *psz_name )
601 {
602     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
603                                    | VLC_VAR_ISCOMMAND );
604     return __var_GetString( p_obj, psz_name );
605 }
606
607 LIBVLC_USED
608 static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
609                                                    const char *psz_name )
610 {
611     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
612                                    | VLC_VAR_ISCOMMAND );
613     return __var_GetNonEmptyString( p_obj, psz_name );
614 }
615
616 /**
617  * __var_CreateGetInteger() with automatic casting
618  */
619 #define var_CreateGetIntegerCommand(a,b)   __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
620 /**
621  * __var_CreateGetBoolCommand() with automatic casting
622  */
623 #define var_CreateGetBoolCommand(a,b)   __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
624 /**
625  * __var_CreateGetTimeCommand() with automatic casting
626  */
627 #define var_CreateGetTimeCommand(a,b)   __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
628 /**
629  * __var_CreateGetFloat() with automatic casting
630  */
631 #define var_CreateGetFloatCommand(a,b)   __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
632 /**
633  * __var_CreateGetStringCommand() with automatic casting
634  */
635 #define var_CreateGetStringCommand(a,b)   __var_CreateGetStringCommand( VLC_OBJECT(a),b)
636 #define var_CreateGetNonEmptyStringCommand(a,b)   __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
637 /**
638  * @}
639  */
640 #endif /*  _VLC_VARIABLES_H */