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