var_AcquireMutex: enforce constant mutex name
[vlc.git] / src / misc / variables.c
1 /*****************************************************************************
2  * variables.c: routines for object variables handling
3  *****************************************************************************
4  * Copyright (C) 2002-2006 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #ifdef HAVE_CONFIG_H
28 # include "config.h"
29 #endif
30
31 #include <vlc_common.h>
32 #include "variables.h"
33
34 #include "libvlc.h"
35
36 #include "vlc_interface.h"
37
38 /*****************************************************************************
39  * Private types
40  *****************************************************************************/
41 struct callback_entry_t
42 {
43     vlc_callback_t pf_callback;
44     void *         p_data;
45 };
46
47 /*****************************************************************************
48  * Local comparison functions, returns 0 if v == w, < 0 if v < w, > 0 if v > w
49  *****************************************************************************/
50 static int CmpBool( vlc_value_t v, vlc_value_t w ) { return v.b_bool ? w.b_bool ? 0 : 1 : w.b_bool ? -1 : 0; }
51 static int CmpInt( vlc_value_t v, vlc_value_t w ) { return v.i_int == w.i_int ? 0 : v.i_int > w.i_int ? 1 : -1; }
52 static int CmpTime( vlc_value_t v, vlc_value_t w )
53 {
54     return v.i_time == w.i_time ? 0 : v.i_time > w.i_time ? 1 : -1;
55 }
56 static int CmpString( vlc_value_t v, vlc_value_t w )
57 {
58     if( !v.psz_string )
59         return !w.psz_string ? 0 : -1;
60     else
61         return !w.psz_string ? 1 : strcmp( v.psz_string, w.psz_string );
62 }
63 static int CmpFloat( vlc_value_t v, vlc_value_t w ) { return v.f_float == w.f_float ? 0 : v.f_float > w.f_float ? 1 : -1; }
64 static int CmpAddress( vlc_value_t v, vlc_value_t w ) { return v.p_address == w.p_address ? 0 : v.p_address > w.p_address ? 1 : -1; }
65
66 /*****************************************************************************
67  * Local duplication functions, and local deallocation functions
68  *****************************************************************************/
69 static void DupDummy( vlc_value_t *p_val ) { (void)p_val; /* unused */ }
70 static void DupString( vlc_value_t *p_val ) { if( p_val->psz_string ) p_val->psz_string = strdup( p_val->psz_string ); }
71
72 static void DupList( vlc_value_t *p_val )
73 {
74     int i;
75     vlc_list_t *p_list = malloc( sizeof(vlc_list_t) );
76
77     p_list->i_count = p_val->p_list->i_count;
78     if( p_val->p_list->i_count )
79     {
80         p_list->p_values = malloc( p_list->i_count * sizeof(vlc_value_t) );
81         p_list->pi_types = malloc( p_list->i_count * sizeof(int) );
82     }
83     else
84     {
85         p_list->p_values = NULL;
86         p_list->pi_types = NULL;
87     }
88
89     for( i = 0; i < p_list->i_count; i++ )
90     {
91         p_list->p_values[i] = p_val->p_list->p_values[i];
92         p_list->pi_types[i] = p_val->p_list->pi_types[i];
93         switch( p_val->p_list->pi_types[i] & VLC_VAR_TYPE )
94         {
95         case VLC_VAR_STRING:
96
97             DupString( &p_list->p_values[i] );
98             break;
99         default:
100             break;
101         }
102     }
103
104     p_val->p_list = p_list;
105 }
106
107 static void FreeDummy( vlc_value_t *p_val ) { (void)p_val; /* unused */ }
108 static void FreeString( vlc_value_t *p_val ) { free( p_val->psz_string ); }
109 static void FreeMutex( vlc_value_t *p_val ) { vlc_mutex_destroy( (vlc_mutex_t*)p_val->p_address ); free( p_val->p_address ); }
110
111 static void FreeList( vlc_value_t *p_val )
112 {
113     int i;
114     for( i = 0; i < p_val->p_list->i_count; i++ )
115     {
116         switch( p_val->p_list->pi_types[i] & VLC_VAR_TYPE )
117         {
118         case VLC_VAR_STRING:
119             FreeString( &p_val->p_list->p_values[i] );
120             break;
121         case VLC_VAR_MUTEX:
122             FreeMutex( &p_val->p_list->p_values[i] );
123             break;
124         default:
125             break;
126         }
127     }
128
129     if( p_val->p_list->i_count )
130     {
131         free( p_val->p_list->p_values );
132         free( p_val->p_list->pi_types );
133     }
134     free( p_val->p_list );
135 }
136
137 /*****************************************************************************
138  * Local prototypes
139  *****************************************************************************/
140 static int      GetUnused   ( vlc_object_t *, const char * );
141 static uint32_t HashString  ( const char * );
142 static int      Insert      ( variable_t *, int, const char * );
143 static int      InsertInner ( variable_t *, int, uint32_t );
144 static int      Lookup      ( variable_t *, int, const char * );
145 static int      LookupInner ( variable_t *, int, uint32_t );
146
147 static void     CheckValue  ( variable_t *, vlc_value_t * );
148
149 static int      InheritValue( vlc_object_t *, const char *, vlc_value_t *,
150                               int );
151
152 /**
153  * Initialize a vlc variable
154  *
155  * We hash the given string and insert it into the sorted list. The insertion
156  * may require slow memory copies, but think about what we gain in the log(n)
157  * lookup phase when setting/getting the variable value!
158  *
159  * \param p_this The object in which to create the variable
160  * \param psz_name The name of the variable
161  * \param i_type The variables type. Must be one of \ref var_type combined with
162  *               zero or more \ref var_flags
163  */
164 int __var_Create( vlc_object_t *p_this, const char *psz_name, int i_type )
165 {
166     int i_new;
167     variable_t *p_var;
168     static vlc_list_t dummy_null_list = {0, NULL, NULL};
169     vlc_object_internals_t *p_priv = vlc_internals( p_this );
170
171     vlc_mutex_lock( &p_priv->var_lock );
172
173     /* FIXME: if the variable already exists, we don't duplicate it. But we
174      * duplicate the lookups. It's not that serious, but if anyone finds some
175      * time to rework Insert() so that only one lookup has to be done, feel
176      * free to do so. */
177     i_new = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
178
179     if( i_new >= 0 )
180     {
181         /* If the types differ, variable creation failed. */
182         if( (i_type & ~(VLC_VAR_DOINHERIT|VLC_VAR_ISCOMMAND)) != p_priv->p_vars[i_new].i_type )
183         {
184             vlc_mutex_unlock( &p_priv->var_lock );
185             return VLC_EBADVAR;
186         }
187
188         p_priv->p_vars[i_new].i_usage++;
189         if( i_type & VLC_VAR_ISCOMMAND )
190             p_priv->p_vars[i_new].i_type |= VLC_VAR_ISCOMMAND;
191         vlc_mutex_unlock( &p_priv->var_lock );
192         return VLC_SUCCESS;
193     }
194
195     i_new = Insert( p_priv->p_vars, p_priv->i_vars, psz_name );
196
197     if( (p_priv->i_vars & 15) == 15 )
198     {
199         p_priv->p_vars = realloc( p_priv->p_vars,
200                                   (p_priv->i_vars+17) * sizeof(variable_t) );
201     }
202
203     memmove( p_priv->p_vars + i_new + 1,
204              p_priv->p_vars + i_new,
205              (p_priv->i_vars - i_new) * sizeof(variable_t) );
206
207     p_priv->i_vars++;
208
209     p_var = &p_priv->p_vars[i_new];
210     memset( p_var, 0, sizeof(*p_var) );
211
212     p_var->i_hash = HashString( psz_name );
213     p_var->psz_name = strdup( psz_name );
214     p_var->psz_text = NULL;
215
216     p_var->i_type = i_type & ~VLC_VAR_DOINHERIT;
217     memset( &p_var->val, 0, sizeof(vlc_value_t) );
218
219     p_var->pf_dup = DupDummy;
220     p_var->pf_free = FreeDummy;
221
222     p_var->i_usage = 1;
223
224     p_var->i_default = -1;
225     p_var->choices.i_count = 0;
226     p_var->choices.p_values = NULL;
227     p_var->choices_text.i_count = 0;
228     p_var->choices_text.p_values = NULL;
229
230     p_var->b_incallback = false;
231     p_var->i_entries = 0;
232     p_var->p_entries = NULL;
233
234     /* Always initialize the variable, even if it is a list variable; this
235      * will lead to errors if the variable is not initialized, but it will
236      * not cause crashes in the variable handling. */
237     switch( i_type & VLC_VAR_TYPE )
238     {
239         case VLC_VAR_BOOL:
240             p_var->pf_cmp = CmpBool;
241             p_var->val.b_bool = false;
242             break;
243         case VLC_VAR_INTEGER:
244         case VLC_VAR_HOTKEY:
245             p_var->pf_cmp = CmpInt;
246             p_var->val.i_int = 0;
247             break;
248         case VLC_VAR_STRING:
249         case VLC_VAR_MODULE:
250         case VLC_VAR_FILE:
251         case VLC_VAR_DIRECTORY:
252         case VLC_VAR_VARIABLE:
253             p_var->pf_cmp = CmpString;
254             p_var->pf_dup = DupString;
255             p_var->pf_free = FreeString;
256             p_var->val.psz_string = NULL;
257             break;
258         case VLC_VAR_FLOAT:
259             p_var->pf_cmp = CmpFloat;
260             p_var->val.f_float = 0.0;
261             break;
262         case VLC_VAR_TIME:
263             p_var->pf_cmp = CmpTime;
264             p_var->val.i_time = 0;
265             break;
266         case VLC_VAR_ADDRESS:
267             p_var->pf_cmp = CmpAddress;
268             p_var->val.p_address = NULL;
269             break;
270         case VLC_VAR_MUTEX:
271             p_var->pf_cmp = CmpAddress;
272             p_var->pf_free = FreeMutex;
273             p_var->val.p_address = malloc( sizeof(vlc_mutex_t) );
274             vlc_mutex_init( (vlc_mutex_t*)p_var->val.p_address );
275             break;
276         case VLC_VAR_LIST:
277             p_var->pf_cmp = CmpAddress;
278             p_var->pf_dup = DupList;
279             p_var->pf_free = FreeList;
280             p_var->val.p_list = &dummy_null_list;
281             break;
282     }
283
284     /* Duplicate the default data we stored. */
285     p_var->pf_dup( &p_var->val );
286
287     if( i_type & VLC_VAR_DOINHERIT )
288     {
289         vlc_value_t val;
290
291         if( InheritValue( p_this, psz_name, &val, p_var->i_type )
292             == VLC_SUCCESS )
293         {
294             /* Free data if needed */
295             p_var->pf_free( &p_var->val );
296             /* Set the variable */
297             p_var->val = val;
298
299             if( i_type & VLC_VAR_HASCHOICE )
300             {
301                 /* We must add the inherited value to our choice list */
302                 p_var->i_default = 0;
303
304                 INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count,
305                              0, val );
306                 INSERT_ELEM( p_var->choices_text.p_values,
307                              p_var->choices_text.i_count, 0, val );
308                 p_var->pf_dup( &p_var->choices.p_values[0] );
309                 p_var->choices_text.p_values[0].psz_string = NULL;
310             }
311         }
312     }
313
314     vlc_mutex_unlock( &p_priv->var_lock );
315
316     return VLC_SUCCESS;
317 }
318
319 /**
320  * Destroy a vlc variable
321  *
322  * Look for the variable and destroy it if it is found. As in var_Create we
323  * do a call to memmove() but we have performance counterparts elsewhere.
324  *
325  * \param p_this The object that holds the variable
326  * \param psz_name The name of the variable
327  */
328 int __var_Destroy( vlc_object_t *p_this, const char *psz_name )
329 {
330     int i_var, i;
331     variable_t *p_var;
332     vlc_object_internals_t *p_priv = vlc_internals( p_this );
333
334     vlc_mutex_lock( &p_priv->var_lock );
335
336     i_var = GetUnused( p_this, psz_name );
337     if( i_var < 0 )
338     {
339         vlc_mutex_unlock( &p_priv->var_lock );
340         return i_var;
341     }
342
343     p_var = &p_priv->p_vars[i_var];
344
345     if( p_var->i_usage > 1 )
346     {
347         p_var->i_usage--;
348         vlc_mutex_unlock( &p_priv->var_lock );
349         return VLC_SUCCESS;
350     }
351
352     /* Free value if needed */
353     p_var->pf_free( &p_var->val );
354
355     /* Free choice list if needed */
356     if( p_var->choices.i_count )
357     {
358         for( i = 0 ; i < p_var->choices.i_count ; i++ )
359         {
360             p_var->pf_free( &p_var->choices.p_values[i] );
361             free( p_var->choices_text.p_values[i].psz_string );
362         }
363         free( p_var->choices.p_values );
364         free( p_var->choices_text.p_values );
365     }
366
367     /* Free callbacks if needed */
368     if( p_var->p_entries )
369     {
370         free( p_var->p_entries );
371     }
372
373     free( p_var->psz_name );
374     free( p_var->psz_text );
375
376     memmove( p_priv->p_vars + i_var,
377              p_priv->p_vars + i_var + 1,
378              (p_priv->i_vars - i_var - 1) * sizeof(variable_t) );
379
380     if( (p_priv->i_vars & 15) == 0 )
381     {
382         p_priv->p_vars = realloc( p_priv->p_vars,
383                           (p_priv->i_vars) * sizeof( variable_t ) );
384     }
385
386     p_priv->i_vars--;
387
388     vlc_mutex_unlock( &p_priv->var_lock );
389
390     return VLC_SUCCESS;
391 }
392
393 /**
394  * Perform an action on a variable
395  *
396  * \param p_this The object that holds the variable
397  * \param psz_name The name of the variable
398  * \param i_action The action to perform. Must be one of \ref var_action
399  * \param p_val First action parameter
400  * \param p_val2 Second action parameter
401  */
402 int __var_Change( vlc_object_t *p_this, const char *psz_name,
403                   int i_action, vlc_value_t *p_val, vlc_value_t *p_val2 )
404 {
405     int i_var, i;
406     variable_t *p_var;
407     vlc_value_t oldval;
408     vlc_object_internals_t *p_priv = vlc_internals( p_this );
409
410     vlc_mutex_lock( &p_priv->var_lock );
411
412     i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
413
414     if( i_var < 0 )
415     {
416         vlc_mutex_unlock( &p_priv->var_lock );
417         return VLC_ENOVAR;
418     }
419
420     p_var = &p_priv->p_vars[i_var];
421
422     switch( i_action )
423     {
424         case VLC_VAR_SETMIN:
425             if( p_var->i_type & VLC_VAR_HASMIN )
426             {
427                 p_var->pf_free( &p_var->min );
428             }
429             p_var->i_type |= VLC_VAR_HASMIN;
430             p_var->min = *p_val;
431             p_var->pf_dup( &p_var->min );
432             CheckValue( p_var, &p_var->val );
433             break;
434         case VLC_VAR_GETMIN:
435             if( p_var->i_type & VLC_VAR_HASMIN )
436             {
437                 *p_val = p_var->min;
438             }
439             break;
440         case VLC_VAR_SETMAX:
441             if( p_var->i_type & VLC_VAR_HASMAX )
442             {
443                 p_var->pf_free( &p_var->max );
444             }
445             p_var->i_type |= VLC_VAR_HASMAX;
446             p_var->max = *p_val;
447             p_var->pf_dup( &p_var->max );
448             CheckValue( p_var, &p_var->val );
449             break;
450         case VLC_VAR_GETMAX:
451             if( p_var->i_type & VLC_VAR_HASMAX )
452             {
453                 *p_val = p_var->max;
454             }
455             break;
456         case VLC_VAR_SETSTEP:
457             if( p_var->i_type & VLC_VAR_HASSTEP )
458             {
459                 p_var->pf_free( &p_var->step );
460             }
461             p_var->i_type |= VLC_VAR_HASSTEP;
462             p_var->step = *p_val;
463             p_var->pf_dup( &p_var->step );
464             CheckValue( p_var, &p_var->val );
465             break;
466         case VLC_VAR_GETSTEP:
467             if( p_var->i_type & VLC_VAR_HASSTEP )
468             {
469                 *p_val = p_var->step;
470             }
471             break;
472         case VLC_VAR_ADDCHOICE:
473             i = p_var->choices.i_count;
474
475             INSERT_ELEM( p_var->choices.p_values, p_var->choices.i_count,
476                          i, *p_val );
477             INSERT_ELEM( p_var->choices_text.p_values,
478                          p_var->choices_text.i_count, i, *p_val );
479             p_var->pf_dup( &p_var->choices.p_values[i] );
480             p_var->choices_text.p_values[i].psz_string =
481                 ( p_val2 && p_val2->psz_string ) ?
482                 strdup( p_val2->psz_string ) : NULL;
483
484             CheckValue( p_var, &p_var->val );
485             break;
486         case VLC_VAR_DELCHOICE:
487             for( i = 0 ; i < p_var->choices.i_count ; i++ )
488             {
489                 if( p_var->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
490                 {
491                     break;
492                 }
493             }
494
495             if( i == p_var->choices.i_count )
496             {
497                 /* Not found */
498                 vlc_mutex_unlock( &p_priv->var_lock );
499                 return VLC_EGENERIC;
500             }
501
502             if( p_var->i_default > i )
503             {
504                 p_var->i_default--;
505             }
506             else if( p_var->i_default == i )
507             {
508                 p_var->i_default = -1;
509             }
510
511             p_var->pf_free( &p_var->choices.p_values[i] );
512             free( p_var->choices_text.p_values[i].psz_string );
513             REMOVE_ELEM( p_var->choices.p_values, p_var->choices.i_count, i );
514             REMOVE_ELEM( p_var->choices_text.p_values,
515                          p_var->choices_text.i_count, i );
516
517             CheckValue( p_var, &p_var->val );
518             break;
519         case VLC_VAR_CHOICESCOUNT:
520             p_val->i_int = p_var->choices.i_count;
521             break;
522         case VLC_VAR_CLEARCHOICES:
523             for( i = 0 ; i < p_var->choices.i_count ; i++ )
524             {
525                 p_var->pf_free( &p_var->choices.p_values[i] );
526             }
527             for( i = 0 ; i < p_var->choices_text.i_count ; i++ )
528                 free( p_var->choices_text.p_values[i].psz_string );
529
530             if( p_var->choices.i_count ) free( p_var->choices.p_values );
531             if( p_var->choices_text.i_count ) free( p_var->choices_text.p_values );
532
533             p_var->choices.i_count = 0;
534             p_var->choices.p_values = NULL;
535             p_var->choices_text.i_count = 0;
536             p_var->choices_text.p_values = NULL;
537             p_var->i_default = -1;
538             break;
539         case VLC_VAR_SETDEFAULT:
540             /* FIXME: the list is sorted, dude. Use something cleverer. */
541             for( i = 0 ; i < p_var->choices.i_count ; i++ )
542             {
543                 if( p_var->pf_cmp( p_var->choices.p_values[i], *p_val ) == 0 )
544                 {
545                     break;
546                 }
547             }
548
549             if( i == p_var->choices.i_count )
550             {
551                 /* Not found */
552                 break;
553             }
554
555             p_var->i_default = i;
556             CheckValue( p_var, &p_var->val );
557             break;
558         case VLC_VAR_SETVALUE:
559             /* Duplicate data if needed */
560             p_var->pf_dup( p_val );
561             /* Backup needed stuff */
562             oldval = p_var->val;
563             /* Check boundaries and list */
564             CheckValue( p_var, p_val );
565             /* Set the variable */
566             p_var->val = *p_val;
567             /* Free data if needed */
568             p_var->pf_free( &oldval );
569             break;
570         case VLC_VAR_GETCHOICES:
571         case VLC_VAR_GETLIST:
572             p_val->p_list = malloc( sizeof(vlc_list_t) );
573             if( p_val2 ) p_val2->p_list = malloc( sizeof(vlc_list_t) );
574             if( p_var->choices.i_count )
575             {
576                 p_val->p_list->p_values = malloc( p_var->choices.i_count
577                                                   * sizeof(vlc_value_t) );
578                 p_val->p_list->pi_types = malloc( p_var->choices.i_count
579                                                   * sizeof(int) );
580                 if( p_val2 )
581                 {
582                     p_val2->p_list->p_values =
583                         malloc( p_var->choices.i_count * sizeof(vlc_value_t) );
584                     p_val2->p_list->pi_types =
585                         malloc( p_var->choices.i_count * sizeof(int) );
586                 }
587             }
588             p_val->p_list->i_count = p_var->choices.i_count;
589             if( p_val2 ) p_val2->p_list->i_count = p_var->choices.i_count;
590             for( i = 0 ; i < p_var->choices.i_count ; i++ )
591             {
592                 p_val->p_list->p_values[i] = p_var->choices.p_values[i];
593                 p_val->p_list->pi_types[i] = p_var->i_type;
594                 p_var->pf_dup( &p_val->p_list->p_values[i] );
595                 if( p_val2 )
596                 {
597                     p_val2->p_list->p_values[i].psz_string =
598                         p_var->choices_text.p_values[i].psz_string ?
599                     strdup(p_var->choices_text.p_values[i].psz_string) : NULL;
600                     p_val2->p_list->pi_types[i] = VLC_VAR_STRING;
601                 }
602             }
603             break;
604         case VLC_VAR_FREELIST:
605             FreeList( p_val );
606             if( p_val2 && p_val2->p_list )
607             {
608                 for( i = 0; i < p_val2->p_list->i_count; i++ )
609                     free( p_val2->p_list->p_values[i].psz_string );
610                 if( p_val2->p_list->i_count )
611                 {
612                     free( p_val2->p_list->p_values );
613                     free( p_val2->p_list->pi_types );
614                 }
615                 free( p_val2->p_list );
616             }
617             break;
618         case VLC_VAR_SETTEXT:
619             free( p_var->psz_text );
620             if( p_val && p_val->psz_string )
621                 p_var->psz_text = strdup( p_val->psz_string );
622             break;
623         case VLC_VAR_GETTEXT:
624             p_val->psz_string = NULL;
625             if( p_var->psz_text )
626             {
627                 p_val->psz_string = strdup( p_var->psz_text );
628             }
629             break;
630         case VLC_VAR_INHERITVALUE:
631             {
632                 vlc_value_t val;
633
634                 if( InheritValue( p_this,
635                                   p_val2 ? p_val2->psz_string :  psz_name,
636                                   &val, p_var->i_type )
637                     == VLC_SUCCESS )
638                 {
639                     /* Duplicate already done */
640
641                     /* Backup needed stuff */
642                     oldval = p_var->val;
643                     /* Check boundaries and list */
644                     CheckValue( p_var, &val );
645                     /* Set the variable */
646                     p_var->val = val;
647                     /* Free data if needed */
648                     p_var->pf_free( &oldval );
649                 }
650
651                 if( p_val )
652                 {
653                     *p_val = p_var->val;
654                     p_var->pf_dup( p_val );
655                 }
656             }
657             break;
658         case VLC_VAR_TRIGGER_CALLBACKS:
659             {
660                 /* Deal with callbacks. Tell we're in a callback, release the lock,
661                  * call stored functions, retake the lock. */
662                 if( p_var->i_entries )
663                 {
664                     int i_var;
665                     int i_entries = p_var->i_entries;
666                     callback_entry_t *p_entries = p_var->p_entries;
667
668                     p_var->b_incallback = true;
669                     vlc_mutex_unlock( &p_priv->var_lock );
670
671                     /* The real calls */
672                     for( ; i_entries-- ; )
673                     {
674                         p_entries[i_entries].pf_callback( p_this, psz_name, p_var->val, p_var->val,
675                                                           p_entries[i_entries].p_data );
676                     }
677
678                     vlc_mutex_lock( &p_priv->var_lock );
679
680                     i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
681                     if( i_var < 0 )
682                     {
683                         msg_Err( p_this, "variable %s has disappeared", psz_name );
684                         vlc_mutex_unlock( &p_priv->var_lock );
685                         return VLC_ENOVAR;
686                     }
687
688                     p_var = &p_priv->p_vars[i_var];
689                     p_var->b_incallback = false;
690                 }
691             }
692             break;
693
694         case VLC_VAR_SETISCOMMAND:
695             p_var->i_type |= VLC_VAR_ISCOMMAND;
696             break;
697
698         default:
699             break;
700     }
701
702     vlc_mutex_unlock( &p_priv->var_lock );
703
704     return VLC_SUCCESS;
705 }
706
707 /**
708  * Request a variable's type
709  *
710  * \return The variable type if it exists, or 0 if the
711  * variable could not be found.
712  * \see \ref var_type
713  */
714 int __var_Type( vlc_object_t *p_this, const char *psz_name )
715 {
716     int i_var, i_type;
717     vlc_object_internals_t *p_priv = vlc_internals( p_this );
718
719     vlc_mutex_lock( &p_priv->var_lock );
720
721     i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
722
723     if( i_var < 0 )
724     {
725         vlc_mutex_unlock( &p_priv->var_lock );
726         return 0;
727     }
728
729     i_type = p_priv->p_vars[i_var].i_type;
730
731     vlc_mutex_unlock( &p_priv->var_lock );
732
733     return i_type;
734 }
735
736 /**
737  * Set a variable's value
738  *
739  * \param p_this The object that hold the variable
740  * \param psz_name The name of the variable
741  * \param val the value to set
742  */
743 int __var_Set( vlc_object_t *p_this, const char *psz_name, vlc_value_t val )
744 {
745     int i_var;
746     variable_t *p_var;
747     vlc_value_t oldval;
748     vlc_object_internals_t *p_priv = vlc_internals( p_this );
749
750     vlc_mutex_lock( &p_priv->var_lock );
751
752     i_var = GetUnused( p_this, psz_name );
753     if( i_var < 0 )
754     {
755         vlc_mutex_unlock( &p_priv->var_lock );
756         return i_var;
757     }
758
759     p_var = &p_priv->p_vars[i_var];
760
761     /* Duplicate data if needed */
762     p_var->pf_dup( &val );
763
764     /* Backup needed stuff */
765     oldval = p_var->val;
766
767     /* Check boundaries and list */
768     CheckValue( p_var, &val );
769
770     /* Set the variable */
771     p_var->val = val;
772
773     /* Deal with callbacks. Tell we're in a callback, release the lock,
774      * call stored functions, retake the lock. */
775     if( p_var->i_entries )
776     {
777         int i_var;
778         int i_entries = p_var->i_entries;
779         callback_entry_t *p_entries = p_var->p_entries;
780
781         p_var->b_incallback = true;
782         vlc_mutex_unlock( &p_priv->var_lock );
783
784         /* The real calls */
785         for( ; i_entries-- ; )
786         {
787             p_entries[i_entries].pf_callback( p_this, psz_name, oldval, val,
788                                               p_entries[i_entries].p_data );
789         }
790
791         vlc_mutex_lock( &p_priv->var_lock );
792
793         i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
794         if( i_var < 0 )
795         {
796             msg_Err( p_this, "variable %s has disappeared", psz_name );
797             vlc_mutex_unlock( &p_priv->var_lock );
798             return VLC_ENOVAR;
799         }
800
801         p_var = &p_priv->p_vars[i_var];
802         p_var->b_incallback = false;
803     }
804
805     /* Free data if needed */
806     p_var->pf_free( &oldval );
807
808     vlc_mutex_unlock( &p_priv->var_lock );
809
810     return VLC_SUCCESS;
811 }
812
813 /**
814  * Get a variable's value
815  *
816  * \param p_this The object that holds the variable
817  * \param psz_name The name of the variable
818  * \param p_val Pointer to a vlc_value_t that will hold the variable's value
819  *              after the function is finished
820  */
821 int __var_Get( vlc_object_t *p_this, const char *psz_name, vlc_value_t *p_val )
822 {
823     int i_var;
824     variable_t *p_var;
825     vlc_object_internals_t *p_priv = vlc_internals( p_this );
826
827     vlc_mutex_lock( &p_priv->var_lock );
828
829     i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
830
831     if( i_var < 0 )
832     {
833         vlc_mutex_unlock( &p_priv->var_lock );
834         return VLC_ENOVAR;
835     }
836
837     p_var = &p_priv->p_vars[i_var];
838
839     /* Really get the variable */
840     *p_val = p_var->val;
841
842     /* Duplicate value if needed */
843     p_var->pf_dup( p_val );
844
845     vlc_mutex_unlock( &p_priv->var_lock );
846
847     return VLC_SUCCESS;
848 }
849
850
851 #undef var_AcquireMutex
852 /**
853  * Finds a process-wide mutex, creates it if needed, and locks it.
854  * Unlock with vlc_mutex_unlock().
855  */
856 vlc_mutex_t *var_AcquireMutex( const char *name )
857 {
858     libvlc_global_data_t *p_global = vlc_global();
859     vlc_value_t val;
860
861     if( var_Create( p_global, name, VLC_VAR_MUTEX ) )
862         return NULL;
863
864     var_Get( p_global, name, &val );
865     vlc_mutex_lock( val.p_address );
866     return val.p_address;
867 }
868
869
870 /**
871  * Register a callback in a variable
872  *
873  * We store a function pointer that will be called upon variable
874  * modification.
875  *
876  * \param p_this The object that holds the variable
877  * \param psz_name The name of the variable
878  * \param pf_callback The function pointer
879  * \param p_data A generic pointer that will be passed as the last
880  *               argument to the callback function.
881  *
882  * \warning The callback function is run in the thread that calls var_Set on
883  *          the variable. Use proper locking. This thread may not have much
884  *          time to spare, so keep callback functions short.
885  */
886 int __var_AddCallback( vlc_object_t *p_this, const char *psz_name,
887                        vlc_callback_t pf_callback, void *p_data )
888 {
889     int i_var;
890     variable_t *p_var;
891     callback_entry_t entry;
892     vlc_object_internals_t *p_priv = vlc_internals( p_this );
893
894     entry.pf_callback = pf_callback;
895     entry.p_data = p_data;
896
897     vlc_mutex_lock( &p_priv->var_lock );
898
899     i_var = GetUnused( p_this, psz_name );
900     if( i_var < 0 )
901     {
902         vlc_mutex_unlock( &p_priv->var_lock );
903         return i_var;
904     }
905
906     p_var = &p_priv->p_vars[i_var];
907
908     INSERT_ELEM( p_var->p_entries,
909                  p_var->i_entries,
910                  p_var->i_entries,
911                  entry );
912
913     vlc_mutex_unlock( &p_priv->var_lock );
914
915     return VLC_SUCCESS;
916 }
917
918 /**
919  * Remove a callback from a variable
920  *
921  * pf_callback and p_data have to be given again, because different objects
922  * might have registered the same callback function.
923  */
924 int __var_DelCallback( vlc_object_t *p_this, const char *psz_name,
925                        vlc_callback_t pf_callback, void *p_data )
926 {
927     int i_entry, i_var;
928     variable_t *p_var;
929     vlc_object_internals_t *p_priv = vlc_internals( p_this );
930
931     vlc_mutex_lock( &p_priv->var_lock );
932
933     i_var = GetUnused( p_this, psz_name );
934     if( i_var < 0 )
935     {
936         vlc_mutex_unlock( &p_priv->var_lock );
937         return i_var;
938     }
939
940     p_var = &p_priv->p_vars[i_var];
941
942     for( i_entry = p_var->i_entries ; i_entry-- ; )
943     {
944         if( p_var->p_entries[i_entry].pf_callback == pf_callback
945             && p_var->p_entries[i_entry].p_data == p_data )
946         {
947             break;
948         }
949     }
950
951     if( i_entry < 0 )
952     {
953         vlc_mutex_unlock( &p_priv->var_lock );
954         return VLC_EGENERIC;
955     }
956
957     REMOVE_ELEM( p_var->p_entries, p_var->i_entries, i_entry );
958
959     vlc_mutex_unlock( &p_priv->var_lock );
960
961     return VLC_SUCCESS;
962 }
963
964 /**
965  * Trigger callback on a variable
966  *
967  * \param p_this The object that hold the variable
968  * \param psz_name The name of the variable
969  */
970 int __var_TriggerCallback( vlc_object_t *p_this, const char *psz_name )
971 {
972     int i_var;
973     variable_t *p_var;
974     vlc_value_t oldval;
975     vlc_object_internals_t *p_priv = vlc_internals( p_this );
976
977     vlc_mutex_lock( &p_priv->var_lock );
978
979     i_var = GetUnused( p_this, psz_name );
980     if( i_var < 0 )
981     {
982         vlc_mutex_unlock( &p_priv->var_lock );
983         return i_var;
984     }
985
986     p_var = &p_priv->p_vars[i_var];
987
988     /* Backup needed stuff */
989     oldval = p_var->val;
990
991     /* Deal with callbacks. Tell we're in a callback, release the lock,
992      * call stored functions, retake the lock. */
993     if( p_var->i_entries )
994     {
995         int i_var;
996         int i_entries = p_var->i_entries;
997         callback_entry_t *p_entries = p_var->p_entries;
998
999         p_var->b_incallback = true;
1000         vlc_mutex_unlock( &p_priv->var_lock );
1001
1002         /* The real calls */
1003         for( ; i_entries-- ; )
1004         {
1005             p_entries[i_entries].pf_callback( p_this, psz_name, oldval, oldval,
1006                                               p_entries[i_entries].p_data );
1007         }
1008
1009         vlc_mutex_lock( &p_priv->var_lock );
1010
1011         i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
1012         if( i_var < 0 )
1013         {
1014             msg_Err( p_this, "variable %s has disappeared", psz_name );
1015             vlc_mutex_unlock( &p_priv->var_lock );
1016             return VLC_ENOVAR;
1017         }
1018
1019         p_var = &p_priv->p_vars[i_var];
1020         p_var->b_incallback = false;
1021     }
1022
1023     vlc_mutex_unlock( &p_priv->var_lock );
1024     return VLC_SUCCESS;
1025 }
1026
1027 /** Parse a stringified option
1028  * This function parse a string option and create the associated object
1029  * variable
1030  * The option must be of the form "[no[-]]foo[=bar]" where foo is the
1031  * option name and bar is the value of the option.
1032  * \param p_obj the object in which the variable must be created
1033  * \param psz_option the option to parse
1034  * \param trusted whether the option is set by a trusted input or not
1035  * \return nothing
1036  */
1037 void var_OptionParse( vlc_object_t *p_obj, const char *psz_option,
1038                       bool trusted )
1039 {
1040     char *psz_name, *psz_value;
1041     int  i_type;
1042     bool b_isno = false;
1043     vlc_value_t val;
1044
1045     val.psz_string = NULL;
1046
1047     /* It's too much of a hassle to remove the ':' when we parse
1048      * the cmd line :) */
1049     if( psz_option[0] == ':' )
1050         psz_option++;
1051
1052     if( !psz_option[0] )
1053         return;
1054
1055     psz_name = strdup( psz_option );
1056     if( psz_name == NULL )
1057         return;
1058
1059     psz_value = strchr( psz_name, '=' );
1060     if( psz_value != NULL )
1061         *psz_value++ = '\0';
1062
1063     /* FIXME: :programs should be handled generically */
1064     if( !strcmp( psz_name, "programs" ) )
1065         i_type = VLC_VAR_LIST;
1066     else
1067         i_type = config_GetType( p_obj, psz_name );
1068
1069     if( !i_type && !psz_value )
1070     {
1071         /* check for "no-foo" or "nofoo" */
1072         if( !strncmp( psz_name, "no-", 3 ) )
1073         {
1074             memmove( psz_name, psz_name + 3, strlen(psz_name) + 1 - 3 );
1075         }
1076         else if( !strncmp( psz_name, "no", 2 ) )
1077         {
1078             memmove( psz_name, psz_name + 2, strlen(psz_name) + 1 - 2 );
1079         }
1080         else goto cleanup;           /* Option doesn't exist */
1081
1082         b_isno = true;
1083         i_type = config_GetType( p_obj, psz_name );
1084     }
1085     if( !i_type ) goto cleanup; /* Option doesn't exist */
1086
1087     if( ( i_type != VLC_VAR_BOOL ) &&
1088         ( !psz_value || !*psz_value ) ) goto cleanup; /* Invalid value */
1089
1090     /* check if option is unsafe */
1091     if( !trusted )
1092     {
1093         module_config_t *p_config = config_FindConfig( p_obj, psz_name );
1094         if( !p_config->b_safe )
1095         {
1096             msg_Err( p_obj, "unsafe option \"%s\" has been ignored for "
1097                             "security reasons", psz_name );
1098             return;
1099         }
1100     }
1101
1102     /* Create the variable in the input object.
1103      * Children of the input object will be able to retreive this value
1104      * thanks to the inheritance property of the object variables. */
1105     var_Create( p_obj, psz_name, i_type );
1106
1107     switch( i_type )
1108     {
1109     case VLC_VAR_BOOL:
1110         val.b_bool = !b_isno;
1111         break;
1112
1113     case VLC_VAR_INTEGER:
1114         val.i_int = strtol( psz_value, NULL, 0 );
1115         break;
1116
1117     case VLC_VAR_FLOAT:
1118         val.f_float = atof( psz_value );
1119         break;
1120
1121     case VLC_VAR_STRING:
1122     case VLC_VAR_MODULE:
1123     case VLC_VAR_FILE:
1124     case VLC_VAR_DIRECTORY:
1125         val.psz_string = psz_value;
1126         break;
1127
1128     case VLC_VAR_LIST:
1129     {
1130         char *psz_orig, *psz_var;
1131         vlc_list_t *p_list = malloc(sizeof(vlc_list_t));
1132         val.p_list = p_list;
1133         p_list->i_count = 0;
1134
1135         psz_var = psz_orig = strdup(psz_value);
1136         while( psz_var && *psz_var )
1137         {
1138             char *psz_item = psz_var;
1139             vlc_value_t val2;
1140             while( *psz_var && *psz_var != ',' ) psz_var++;
1141             if( *psz_var == ',' )
1142             {
1143                 *psz_var = '\0';
1144                 psz_var++;
1145             }
1146             val2.i_int = strtol( psz_item, NULL, 0 );
1147             INSERT_ELEM( p_list->p_values, p_list->i_count,
1148                          p_list->i_count, val2 );
1149             /* p_list->i_count is incremented twice by INSERT_ELEM */
1150             p_list->i_count--;
1151             INSERT_ELEM( p_list->pi_types, p_list->i_count,
1152                          p_list->i_count, VLC_VAR_INTEGER );
1153         }
1154         free( psz_orig );
1155         break;
1156     }
1157
1158     default:
1159         goto cleanup;
1160     }
1161
1162     var_Set( p_obj, psz_name, val );
1163
1164 cleanup:
1165     free( psz_name );
1166 }
1167
1168
1169 /* Following functions are local */
1170
1171 /*****************************************************************************
1172  * GetUnused: find an unused variable from its name
1173  *****************************************************************************
1174  * We do i_tries tries before giving up, just in case the variable is being
1175  * modified and called from a callback.
1176  *****************************************************************************/
1177 static int GetUnused( vlc_object_t *p_this, const char *psz_name )
1178 {
1179     int i_var, i_tries = 0;
1180     vlc_object_internals_t *p_priv = vlc_internals( p_this );
1181
1182     while( true )
1183     {
1184         i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
1185         if( i_var < 0 )
1186         {
1187             return VLC_ENOVAR;
1188         }
1189
1190         if( ! p_priv->p_vars[i_var].b_incallback )
1191         {
1192             return i_var;
1193         }
1194
1195         if( i_tries++ > 100 )
1196         {
1197             msg_Err( p_this, "caught in a callback deadlock? ('%s')", psz_name );
1198             return VLC_ETIMEOUT;
1199         }
1200
1201         vlc_mutex_unlock( &p_priv->var_lock );
1202         msleep( THREAD_SLEEP );
1203         vlc_mutex_lock( &p_priv->var_lock );
1204     }
1205 }
1206
1207 /*****************************************************************************
1208  * HashString: our cool hash function
1209  *****************************************************************************
1210  * This function is not intended to be crypto-secure, we only want it to be
1211  * fast and not suck too much. This one is pretty fast and did 0 collisions
1212  * in wenglish's dictionary.
1213  *****************************************************************************/
1214 static uint32_t HashString( const char *psz_string )
1215 {
1216     uint32_t i_hash = 0;
1217
1218     while( *psz_string )
1219     {
1220         i_hash += *psz_string++;
1221         i_hash += i_hash << 10;
1222         i_hash ^= i_hash >> 8;
1223     }
1224
1225     return i_hash;
1226 }
1227
1228 /*****************************************************************************
1229  * Insert: find an empty slot to insert a new variable
1230  *****************************************************************************
1231  * We use a recursive inner function indexed on the hash. This function does
1232  * nothing in the rare cases where a collision may occur, see Lookup()
1233  * to see how we handle them.
1234  * XXX: does this really need to be written recursively?
1235  *****************************************************************************/
1236 static int Insert( variable_t *p_vars, int i_count, const char *psz_name )
1237 {
1238     if( i_count == 0 )
1239     {
1240         return 0;
1241     }
1242
1243     return InsertInner( p_vars, i_count, HashString( psz_name ) );
1244 }
1245
1246 static int InsertInner( variable_t *p_vars, int i_count, uint32_t i_hash )
1247 {
1248     int i_middle;
1249
1250     if( i_hash <= p_vars[0].i_hash )
1251     {
1252         return 0;
1253     }
1254
1255     if( i_hash >= p_vars[i_count - 1].i_hash )
1256     {
1257         return i_count;
1258     }
1259
1260     i_middle = i_count / 2;
1261
1262     /* We know that 0 < i_middle */
1263     if( i_hash < p_vars[i_middle].i_hash )
1264     {
1265         return InsertInner( p_vars, i_middle, i_hash );
1266     }
1267
1268     /* We know that i_middle + 1 < i_count */
1269     if( i_hash > p_vars[i_middle + 1].i_hash )
1270     {
1271         return i_middle + 1 + InsertInner( p_vars + i_middle + 1,
1272                                            i_count - i_middle - 1,
1273                                            i_hash );
1274     }
1275
1276     return i_middle + 1;
1277 }
1278
1279 /*****************************************************************************
1280  * Lookup: find an existing variable given its name
1281  *****************************************************************************
1282  * We use a recursive inner function indexed on the hash. Care is taken of
1283  * possible hash collisions.
1284  * XXX: does this really need to be written recursively?
1285  *****************************************************************************/
1286 static int Lookup( variable_t *p_vars, int i_count, const char *psz_name )
1287 {
1288     uint32_t i_hash;
1289     int i, i_pos;
1290
1291     if( i_count == 0 )
1292     {
1293         return -1;
1294     }
1295
1296     i_hash = HashString( psz_name );
1297
1298     i_pos = LookupInner( p_vars, i_count, i_hash );
1299
1300     /* Hash not found */
1301     if( i_hash != p_vars[i_pos].i_hash )
1302     {
1303         return -1;
1304     }
1305
1306     /* Hash found, entry found */
1307     if( !strcmp( psz_name, p_vars[i_pos].psz_name ) )
1308     {
1309         return i_pos;
1310     }
1311
1312     /* Hash collision! This should be very rare, but we cannot guarantee
1313      * it will never happen. Just do an exhaustive search amongst all
1314      * entries with the same hash. */
1315     for( i = i_pos - 1 ; i > 0 && i_hash == p_vars[i].i_hash ; i-- )
1316     {
1317         if( !strcmp( psz_name, p_vars[i].psz_name ) )
1318         {
1319             return i;
1320         }
1321     }
1322
1323     for( i = i_pos + 1 ; i < i_count && i_hash == p_vars[i].i_hash ; i++ )
1324     {
1325         if( !strcmp( psz_name, p_vars[i].psz_name ) )
1326         {
1327             return i;
1328         }
1329     }
1330
1331     /* Hash found, but entry not found */
1332     return -1;
1333 }
1334
1335 static int LookupInner( variable_t *p_vars, int i_count, uint32_t i_hash )
1336 {
1337     int i_middle;
1338
1339     if( i_hash <= p_vars[0].i_hash )
1340     {
1341         return 0;
1342     }
1343
1344     if( i_hash >= p_vars[i_count-1].i_hash )
1345     {
1346         return i_count - 1;
1347     }
1348
1349     i_middle = i_count / 2;
1350
1351     /* We know that 0 < i_middle */
1352     if( i_hash < p_vars[i_middle].i_hash )
1353     {
1354         return LookupInner( p_vars, i_middle, i_hash );
1355     }
1356
1357     /* We know that i_middle + 1 < i_count */
1358     if( i_hash > p_vars[i_middle].i_hash )
1359     {
1360         return i_middle + LookupInner( p_vars + i_middle,
1361                                        i_count - i_middle,
1362                                        i_hash );
1363     }
1364
1365     return i_middle;
1366 }
1367
1368 /*****************************************************************************
1369  * CheckValue: check that a value is valid wrt. a variable
1370  *****************************************************************************
1371  * This function checks p_val's value against p_var's limitations such as
1372  * minimal and maximal value, step, in-list position, and modifies p_val if
1373  * necessary.
1374  ****************************************************************************/
1375 static void CheckValue ( variable_t *p_var, vlc_value_t *p_val )
1376 {
1377     /* Check that our variable is in the list */
1378     if( p_var->i_type & VLC_VAR_HASCHOICE && p_var->choices.i_count )
1379     {
1380         int i;
1381
1382         /* FIXME: the list is sorted, dude. Use something cleverer. */
1383         for( i = p_var->choices.i_count ; i-- ; )
1384         {
1385             if( p_var->pf_cmp( *p_val, p_var->choices.p_values[i] ) == 0 )
1386             {
1387                 break;
1388             }
1389         }
1390
1391         /* If not found, change it to anything vaguely valid */
1392         if( i < 0 )
1393         {
1394             /* Free the old variable, get the new one, dup it */
1395             p_var->pf_free( p_val );
1396             *p_val = p_var->choices.p_values[p_var->i_default >= 0
1397                                           ? p_var->i_default : 0 ];
1398             p_var->pf_dup( p_val );
1399         }
1400     }
1401
1402     /* Check that our variable is within the bounds */
1403     switch( p_var->i_type & VLC_VAR_TYPE )
1404     {
1405         case VLC_VAR_INTEGER:
1406             if( p_var->i_type & VLC_VAR_HASSTEP && p_var->step.i_int
1407                  && (p_val->i_int % p_var->step.i_int) )
1408             {
1409                 p_val->i_int = (p_val->i_int + (p_var->step.i_int / 2))
1410                                / p_var->step.i_int * p_var->step.i_int;
1411             }
1412             if( p_var->i_type & VLC_VAR_HASMIN
1413                  && p_val->i_int < p_var->min.i_int )
1414             {
1415                 p_val->i_int = p_var->min.i_int;
1416             }
1417             if( p_var->i_type & VLC_VAR_HASMAX
1418                  && p_val->i_int > p_var->max.i_int )
1419             {
1420                 p_val->i_int = p_var->max.i_int;
1421             }
1422             break;
1423         case VLC_VAR_FLOAT:
1424             if( p_var->i_type & VLC_VAR_HASSTEP && p_var->step.f_float )
1425             {
1426                 float f_round = p_var->step.f_float * (float)(int)( 0.5 +
1427                                         p_val->f_float / p_var->step.f_float );
1428                 if( p_val->f_float != f_round )
1429                 {
1430                     p_val->f_float = f_round;
1431                 }
1432             }
1433             if( p_var->i_type & VLC_VAR_HASMIN
1434                  && p_val->f_float < p_var->min.f_float )
1435             {
1436                 p_val->f_float = p_var->min.f_float;
1437             }
1438             if( p_var->i_type & VLC_VAR_HASMAX
1439                  && p_val->f_float > p_var->max.f_float )
1440             {
1441                 p_val->f_float = p_var->max.f_float;
1442             }
1443             break;
1444         case VLC_VAR_TIME:
1445             /* FIXME: TODO */
1446             break;
1447     }
1448 }
1449
1450 /*****************************************************************************
1451  * InheritValue: try to inherit the value of this variable from the same one
1452  *               in our closest parent.
1453  *****************************************************************************/
1454 static int InheritValue( vlc_object_t *p_this, const char *psz_name,
1455                          vlc_value_t *p_val, int i_type )
1456 {
1457     int i_var;
1458     variable_t *p_var;
1459
1460     /* No need to take the structure lock,
1461      * we are only looking for our parents */
1462
1463     if( !p_this->p_parent )
1464     {
1465         switch( i_type & VLC_VAR_TYPE )
1466         {
1467         case VLC_VAR_FILE:
1468         case VLC_VAR_DIRECTORY:
1469         case VLC_VAR_STRING:
1470         case VLC_VAR_MODULE:
1471             p_val->psz_string = config_GetPsz( p_this, psz_name );
1472             if( !p_val->psz_string ) p_val->psz_string = strdup("");
1473             break;
1474         case VLC_VAR_FLOAT:
1475             p_val->f_float = config_GetFloat( p_this, psz_name );
1476             break;
1477         case VLC_VAR_INTEGER:
1478         case VLC_VAR_HOTKEY:
1479             p_val->i_int = config_GetInt( p_this, psz_name );
1480             break;
1481         case VLC_VAR_BOOL:
1482             p_val->b_bool = config_GetInt( p_this, psz_name );
1483             break;
1484         case VLC_VAR_LIST:
1485         {
1486             char *psz_orig, *psz_var;
1487             vlc_list_t *p_list = malloc(sizeof(vlc_list_t));
1488             p_val->p_list = p_list;
1489             p_list->i_count = 0;
1490
1491             psz_var = psz_orig = config_GetPsz( p_this, psz_name );
1492             while( psz_var && *psz_var )
1493             {
1494                 char *psz_item = psz_var;
1495                 vlc_value_t val;
1496                 while( *psz_var && *psz_var != ',' ) psz_var++;
1497                 if( *psz_var == ',' )
1498                 {
1499                     *psz_var = '\0';
1500                     psz_var++;
1501                 }
1502                 val.i_int = strtol( psz_item, NULL, 0 );
1503                 INSERT_ELEM( p_list->p_values, p_list->i_count,
1504                              p_list->i_count, val );
1505                 /* p_list->i_count is incremented twice by INSERT_ELEM */
1506                 p_list->i_count--;
1507                 INSERT_ELEM( p_list->pi_types, p_list->i_count,
1508                              p_list->i_count, VLC_VAR_INTEGER );
1509             }
1510             free( psz_orig );
1511             break;
1512         }
1513         default:
1514             return VLC_ENOOBJ;
1515             break;
1516         }
1517
1518         return VLC_SUCCESS;
1519     }
1520
1521     vlc_object_internals_t *p_priv = vlc_internals( p_this->p_parent );
1522
1523     /* Look for the variable */
1524     vlc_mutex_lock( &p_priv->var_lock );
1525
1526     i_var = Lookup( p_priv->p_vars, p_priv->i_vars, psz_name );
1527
1528     if( i_var >= 0 )
1529     {
1530         /* We found it! */
1531         p_var = &p_priv->p_vars[i_var];
1532
1533         /* Really get the variable */
1534         *p_val = p_var->val;
1535
1536         /* Duplicate value if needed */
1537         p_var->pf_dup( p_val );
1538
1539         vlc_mutex_unlock( &p_priv->var_lock );
1540         return VLC_SUCCESS;
1541     }
1542
1543     vlc_mutex_unlock( &p_priv->var_lock );
1544
1545     /* We're still not there */
1546
1547     return InheritValue( p_this->p_parent, psz_name, p_val, i_type );
1548 }
1549
1550 /**********************************************************************
1551  * Execute a var command on an object identified by its name
1552  **********************************************************************/
1553 int __var_Command( vlc_object_t *p_this, const char *psz_name,
1554                    const char *psz_cmd, const char *psz_arg, char **psz_msg )
1555 {
1556     vlc_object_t *p_obj = vlc_object_find_name( p_this->p_libvlc,
1557                                                 psz_name, FIND_CHILD );
1558     int i_type, i_ret;
1559
1560     if( !p_obj )
1561     {
1562         if( psz_msg )
1563             *psz_msg = strdup( "Unknown destination object." );
1564         return VLC_ENOOBJ;
1565     }
1566
1567     i_type = var_Type( p_obj, psz_cmd );
1568     if( !( i_type&VLC_VAR_ISCOMMAND ) )
1569     {
1570         vlc_object_release( p_obj );
1571         if( psz_msg )
1572             *psz_msg = strdup( "Variable doesn't exist or isn't a command." );
1573         return VLC_EGENERIC;
1574     }
1575
1576     i_type &= 0xf0;
1577     switch( i_type )
1578     {
1579         case VLC_VAR_INTEGER:
1580             i_ret = var_SetInteger( p_obj, psz_cmd, atoi( psz_arg ) );
1581             break;
1582         case VLC_VAR_FLOAT:
1583             i_ret = var_SetFloat( p_obj, psz_cmd, atof( psz_arg ) );
1584             break;
1585         case VLC_VAR_STRING:
1586             i_ret = var_SetString( p_obj, psz_cmd, psz_arg );
1587             break;
1588         case VLC_VAR_BOOL:
1589             i_ret = var_SetBool( p_obj, psz_cmd, atoi( psz_arg ) );
1590             break;
1591         default:
1592             i_ret = VLC_EGENERIC;
1593             break;
1594     }
1595
1596     vlc_object_release( p_obj );
1597
1598     if( psz_msg )
1599     {
1600         *psz_msg = (char*)malloc( 80 );
1601         sprintf( *psz_msg, "%s on object %s returned %i (%s)",
1602                  psz_cmd, psz_name, i_ret, vlc_error( i_ret ) );
1603     }
1604
1605     return i_ret;
1606 }