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